Skip to content

Commit ce4f161

Browse files
authored
Merge pull request #2756 from OctopusDeploy/enh-octoai-to-octopus-ai-assistant
fix: reflect new name in docs
2 parents 8a43f8d + d75d8e8 commit ce4f161

2 files changed

Lines changed: 27 additions & 27 deletions

File tree

public/docs/administration/octoai/octoai.png renamed to public/docs/administration/octopus-ai-assistant/octopus-ai-assistant.png

File renamed without changes.

src/pages/docs/administration/octoai/index.md renamed to src/pages/docs/administration/octopus-ai-assistant/index.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
layout: src/layouts/Default.astro
33
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
77
navOrder: 100
88
hideInThisSection: true
99
navSearch: false
@@ -12,58 +12,58 @@ navMenu: false
1212
robots: noindex, follow
1313
---
1414

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:
1616

1717
- To support new Octopus users as they get started with the platform
1818
- To guide teams with large existing Octopus spaces with best practices and suggestions to optimize and scale their Octopus usage
1919

2020
:::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.
2222
:::
2323

24-
![OctoAI Screenshot](/docs/administration/octoai/octoai.png)
24+
![Octopus AI Assistant Screenshot](/docs/administration/octopus-ai-assistant/octopus-ai-assistant.png)
2525

26-
## What can I do with OctoAI?
26+
## What can I do with Octopus AI Assistant?
2727

2828
- Onboard new DevOps teams to Octopus with prompts like `What is an Octopus Runbook?`
2929
- Generate Terraform configuration for the Octopus Terraform provider with prompts like `Generate a Terraform module that creates 3 environments called "Development", "Test", and "Production"`
3030
- Optimize your Octopus space with prompts like `Check the space for unused projects` and `Find unused variables in the project.`
3131
- Debug failed deployments with prompts like `Why did the deployment fail?`
3232

33-
## We want your feedback!
33+
## We want your feedback
3434

35-
We are looking for feedback on the OctoAI feature, specifically:
35+
We are looking for feedback on Octopus AI Assistant, specifically:
3636

3737
- What prompts do you want the service to respond to?
3838
- What would you change about the service?
3939
- Have the responses been helpful?
4040

4141
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.
4242

43-
## Getting started with OctoAI
43+
## Getting started with Octopus AI Assistant
4444

45-
OctoAI has the following prerequisites:
45+
Octopus AI Assistant has the following prerequisites:
4646

4747
- An Octopus instance, either
4848
- 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)
5050
- Google Chrome
5151

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.
5353

54-
## Using OctoAI with an on-premises Octopus instance
54+
## Using Octopus AI Assistant with an on-premises Octopus instance
5555

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.
5757

5858
On-premises Octopus instances must allow HTTP requests from the IP address `51.8.40.170`.
5959

6060
:::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.
6262
:::
6363

6464
## Adding custom prompts
6565

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:
6767

6868
- `PageName[#].Prompt` - The prompt displayed in the UI and passed to the LLM
6969
- `PageName[#].SystemPrompt` - Additional prompt instructions passed to the LLM but not shown in the UI
@@ -131,7 +131,7 @@ For example:
131131

132132
## Writing custom prompts
133133

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.
135135

136136
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.
137137

@@ -146,15 +146,15 @@ On its own, this prompt variable relies on the knowledge built into the LLM to p
146146

147147
To improve the response, you can add a system prompt variable `Project.Deployment[0].SystemPrompt`:
148148

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.
150150
151151
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.
152152

153153
## FAQ
154154

155155
Q: What data is collected?
156156

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:
158158

159159
- Prompt responses
160160
- Sensitive values
@@ -164,26 +164,26 @@ Q: Is my data used to train AI models?
164164

165165
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).
166166

167-
Q: How do I turn off OctoAI?
167+
Q: How do I turn off Octopus AI Assistant?
168168

169-
A: Disabling or uninstalling the Chrome extension will disable OctoAI.
169+
A: Disabling or uninstalling the Chrome extension will disable Octopus AI Assistant.
170170

171171
Q: How much does the service cost?
172172

173173
A: The service is free during the Alpha phase.
174174

175175
Q: How secure is the service?
176176

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/).
178178

179179
Q: Can I see the source code?
180180

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).
182182

183183
Q: Do I need to sign up for an account?
184184

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.
186186

187-
Q: Is OctoAI a supported service?
187+
Q: Is Octopus AI Assistant a supported service?
188188

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

Comments
 (0)