Skip to content

Commit

Permalink
Merge pull request #634 from linear-b/Change-note-title-and-added-bold
Browse files Browse the repository at this point in the history
change note title and add bold
  • Loading branch information
PavelLinearB authored Jan 9, 2025
2 parents 99cafdd + d74647c commit 545f96b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions plugins/filters/askAI/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
## askAI
The AskAI plugin allows gitStream workflows to interact with external AI services, enabling advanced automation capabilities such as code analysis, test case generation, and PR summarization. This plugin requires a valid API token for the AI service, which must be securely provided as an environment variable.

!!! note "Authorization and Data Sharing"
The `AskAI` plugin integrates with an external AI model and requires the customer's API token for authorization. Ensure you provide a valid token through the `env.OPEN_AI_TOKEN` parameter or similar configuration.
!!! note "Security note"
The `AskAI` plugin integrates with an external AI model and requires your API token for authorization. Ensure you provide a valid token through the `env.OPEN_AI_TOKEN` parameter or similar configuration. This may also incur API costs.

When using the `AskAI` plugin, the provided **context** and **prompt** will be shared with the configured AI service. Ensure that no sensitive or proprietary information is included unless your organization's policies permit it.
When using the `AskAI` plugin, the provided **context** and **prompt** will be shared with the configured AI service. **Ensure that no sensitive or proprietary information is included unless your organization's policies permit it**.

![Example PR description](screenshots/askAI-describe-PR.png)

Expand Down

0 comments on commit 545f96b

Please sign in to comment.