You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/pages/docs/administration/octopus-ai-assistant/index.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
---
2
2
layout: src/layouts/Default.astro
3
3
pubDate: 2025-04-04
4
-
modDate: 2025-04-14
5
-
title: OctoAI
6
-
description: How to use OctoAI
4
+
modDate: 2025-06-30
5
+
title: Octopus AI Assistant
6
+
description: How to use Octopus AI Assistant
7
7
navOrder: 100
8
8
hideInThisSection: true
9
9
navSearch: false
@@ -12,58 +12,58 @@ navMenu: false
12
12
robots: noindex, follow
13
13
---
14
14
15
-
OctoAI is a Alpha feature currently under development to integrate AI functionality into the Octopus user interface. The goal of OctoAI is:
15
+
Octopus AI Assistant is a Alpha feature currently under development to integrate AI functionality into the Octopus user interface. The goal of Octopus AI Assistant is:
16
16
17
17
- To support new Octopus users as they get started with the platform
18
18
- To guide teams with large existing Octopus spaces with best practices and suggestions to optimize and scale their Octopus usage
19
19
20
20
:::div{.warning}
21
-
The OctoAI Alpha is a feature released to an audience who has opted-in to provide feedback. The feature is not finished or fully tested. It may not be supported through regular channels. It may change drastically or may never ship.
21
+
The Octopus AI Assistant Alpha is a feature released to an audience who has opted-in to provide feedback. The feature is not finished or fully tested. It may not be supported through regular channels. It may change drastically or may never ship.

25
25
26
-
## What can I do with OctoAI?
26
+
## What can I do with Octopus AI Assistant?
27
27
28
28
- Onboard new DevOps teams to Octopus with prompts like `What is an Octopus Runbook?`
29
29
- Generate Terraform configuration for the Octopus Terraform provider with prompts like `Generate a Terraform module that creates 3 environments called "Development", "Test", and "Production"`
30
30
- Optimize your Octopus space with prompts like `Check the space for unused projects` and `Find unused variables in the project.`
31
31
- Debug failed deployments with prompts like `Why did the deployment fail?`
32
32
33
-
## We want your feedback!
33
+
## We want your feedback
34
34
35
-
We are looking for feedback on the OctoAI feature, specifically:
35
+
We are looking for feedback on Octopus AI Assistant, specifically:
36
36
37
37
- What prompts do you want the service to respond to?
38
38
- What would you change about the service?
39
39
- Have the responses been helpful?
40
40
41
41
As part of the Alpha, we will invite you to a private channel in the [Octopus Community Slack](https://octopus.com/community) where you can provide feedback.
42
42
43
-
## Getting started with OctoAI
43
+
## Getting started with Octopus AI Assistant
44
44
45
-
OctoAI has the following prerequisites:
45
+
Octopus AI Assistant has the following prerequisites:
46
46
47
47
- An Octopus instance, either
48
48
- A cloud instance
49
-
- An on-premises Octopus instance with a hostname accessible from the OctoAI service (more on this requirement below)
49
+
- An on-premises Octopus instance with a hostname accessible from the Octopus AI Assistant service (more on this requirement below)
50
50
- Google Chrome
51
51
52
-
OctoAI is delivered via a Chrome extension which is available from the [Chrome Store](https://chromewebstore.google.com/detail/octoai/acpcjpmjmbdmfabgdpdkiaadnbkcgfon). Once the extension is installed, you will see a new icon in the top right corner of your Chrome browser. Click on the icon to open the OctoAI interface.
52
+
Octopus AI Assistant is delivered via a Chrome extension which is available from the [Chrome Store](https://oc.to/install-ai-assistant). Once the extension is installed, you will see a new icon in the top right corner of your Chrome browser. Click on the icon to open the Octopus AI Assistant interface.
53
53
54
-
## Using OctoAI with an on-premises Octopus instance
54
+
## Using Octopus AI Assistant with an on-premises Octopus instance
55
55
56
-
OctoAI is implemented as an Azure Function. The function must be able to call the Octopus API.
56
+
Octopus AI Assistant is implemented as an Azure Function. The function must be able to call the Octopus API.
57
57
58
58
On-premises Octopus instances must allow HTTP requests from the IP address `51.8.40.170`.
59
59
60
60
:::div{.warning}
61
-
It is not possible to integrate OctoAI with an on-premises Octopus instance that can not accept HTTP requests from this public IP address.
61
+
It is not possible to integrate Octopus AI Assistant with an on-premises Octopus instance that can not accept HTTP requests from this public IP address.
62
62
:::
63
63
64
64
## Adding custom prompts
65
65
66
-
OctoAI will present custom prompts defined in a Library Variable Set called `OctoAI Prompts`. The Library Variable set contains variables named:
66
+
Octopus AI Assistant will present custom prompts defined in a Library Variable Set called `Octopus AI Assistant Prompts`. The Library Variable set contains variables named:
67
67
68
68
-`PageName[#].Prompt` - The prompt displayed in the UI and passed to the LLM
69
69
-`PageName[#].SystemPrompt` - Additional prompt instructions passed to the LLM but not shown in the UI
@@ -131,7 +131,7 @@ For example:
131
131
132
132
## Writing custom prompts
133
133
134
-
To write a custom prompt, you need to define the prompt variable, which is in the format `PageName[#].Prompt`. The prompt variable represents what an Octopus user might write themselves when interacting with OctoAI.
134
+
To write a custom prompt, you need to define the prompt variable, which is in the format `PageName[#].Prompt`. The prompt variable represents what an Octopus user might write themselves when interacting with Octopus AI Assistant.
135
135
136
136
You can optionally define the system prompt variable, which is in the format `PageName[#].SystemPrompt`. The system prompt variable is used to provide additional context to the LLM, usually to capture unique business knowledge. The system prompt is not shown to the user.
137
137
@@ -146,15 +146,15 @@ On its own, this prompt variable relies on the knowledge built into the LLM to p
146
146
147
147
To improve the response, you can add a system prompt variable `Project.Deployment[0].SystemPrompt`:
148
148
149
-
> If the logs indicate that a Docker image is missing, You must only provide the suggestion that the user must visit https://help/missingdocker to get additional instructions to resolve missing docker containers. You will be penalized for offing generic suggestions to resolve a missing docker image. You will be penalized for offering script suggestions to resolve a missing docker image. You will be penalized for suggesting step retries to resolve a missing docker image.
149
+
> If the logs indicate that a Docker image is missing, You must only provide the suggestion that the user must visit <https://help/missingdocker> to get additional instructions to resolve missing docker containers. You will be penalized for offing generic suggestions to resolve a missing docker image. You will be penalized for offering script suggestions to resolve a missing docker image. You will be penalized for suggesting step retries to resolve a missing docker image.
150
150
151
151
The system prompt allows you to embed business knowledge to guide the LLM to provide a more accurate response. In this example we have instructed the LLM to determine if the deployment logs indicate that a Docker image is missing, and if so, to provide a custom link to internal documentation. We have also instructed the LLM to not provide generic suggestions, script suggestions, or step retries to resolve a missing docker image.
152
152
153
153
## FAQ
154
154
155
155
Q: What data is collected?
156
156
157
-
A: We collect prompts entered into OctoAI. All logs are sanitized to remove personally identifiable information. We do not log:
157
+
A: We collect prompts entered into Octopus AI Assistant. All logs are sanitized to remove personally identifiable information. We do not log:
158
158
159
159
- Prompt responses
160
160
- Sensitive values
@@ -164,26 +164,26 @@ Q: Is my data used to train AI models?
164
164
165
165
A: No, we do not train AI models on customer data. We use the Azure OpenAI platform, and [Azure does not use customer data to train models either](https://learn.microsoft.com/en-us/legal/cognitive-services/openai/data-privacy?tabs=azure-portal).
166
166
167
-
Q: How do I turn off OctoAI?
167
+
Q: How do I turn off Octopus AI Assistant?
168
168
169
-
A: Disabling or uninstalling the Chrome extension will disable OctoAI.
169
+
A: Disabling or uninstalling the Chrome extension will disable Octopus AI Assistant.
170
170
171
171
Q: How much does the service cost?
172
172
173
173
A: The service is free during the Alpha phase.
174
174
175
175
Q: How secure is the service?
176
176
177
-
A: OctoAI is implemented as an external service that accesses Octopus via the API. This means OctoAI does not have access to any sensitive values, as the API never exposes sensitive values. It also means access to the Octopus instance is limited by the existing permissions of the current user. Additionally, OctoAI shares the same backend as the Octopus Copilot Extension, which has been audited by an independent external security team. The report is available via the [trust center](https://trust.octopus.com/).
177
+
A: Octopus AI Assistant is implemented as an external service that accesses Octopus via the API. This means Octopus AI Assistant does not have access to any sensitive values, as the API never exposes sensitive values. It also means access to the Octopus instance is limited by the existing permissions of the current user. Additionally, Octopus AI Assistant shares the same backend as the Octopus Copilot Extension, which has been audited by an independent external security team. The report is available via the [trust center](https://trust.octopus.com/).
178
178
179
179
Q: Can I see the source code?
180
180
181
-
A: Yes. The OctoAI backend source code is available from [GitHub](https://github.com/OctopusSolutionsEngineering/OctopusCopilot).
181
+
A: Yes. The Octopus AI Assistant backend source code is available from [GitHub](https://github.com/OctopusSolutionsEngineering/OctopusCopilot).
182
182
183
183
Q: Do I need to sign up for an account?
184
184
185
-
A: No, OctoAI is self-contained and only requires access to an Octopus instance.
185
+
A: No, Octopus AI Assistant is self-contained and only requires access to an Octopus instance.
186
186
187
-
Q: Is OctoAI a supported service?
187
+
Q: Is Octopus AI Assistant a supported service?
188
188
189
-
A: No, the OctoAI Alpha is not subject to any existing SLAs or support agreements. It is an experimental feature that may not be supported through regular channels. It may change drastically or may never ship.
189
+
A: No, the Octopus AI Assistant Alpha is not subject to any existing SLAs or support agreements. It is an experimental feature that may not be supported through regular channels. It may change drastically or may never ship.
0 commit comments