Skip to content

Commit 99cafdd

Browse files
authored
Merge pull request #633 from linear-b/add-Authorization-and-Data-Sharing-note
add note
2 parents f2a1128 + a6d6740 commit 99cafdd

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

plugins/filters/askAI/reference.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
<a name="module_generateDescription"></a>
22

33
## askAI
4-
A gitStream plugin to interact with AI models. Currently works with `ChatGPR-4o-mini`
4+
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.
55

6+
!!! note "Authorization and Data Sharing"
7+
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.
8+
9+
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.
10+
611
![Example PR description](screenshots/askAI-describe-PR.png)
712

813
**Returns**: <code>Object</code> - Returns the AI-generated response based on the provided context and prompt.
@@ -17,9 +22,6 @@ A gitStream plugin to interact with AI models. Currently works with `ChatGPR-4o-
1722

1823

1924
**Example**
20-
!!! tip "Encoding output"
21-
The output of AI models may be lengthy, which might cause issues when setting the comment. We recommend using the [`encode`](./filter-functions.md#encode) filter function, as shown in the example, to ensure that the comment is passed fully.
22-
The [`add-comment`](./automation-actions.md#add-comment) action automatically decodes encoded strings.
2325

2426
```yaml
2527
{{ source | askAI("QA tester", "Based on the given context, search for new functions without tests and suggest the tests to add. If all functions are covered completely, return 'no tests to suggest.'", env.OPEN_AI_TOKEN) }}

0 commit comments

Comments
 (0)