📝 docs: improve askAI plugin documentation #630
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,8 +14,10 @@ automations: | |
| - action: add-comment@v1 | ||
| args: | ||
| comment: | | ||
| ## gitStream askAI: recommended documentation for this PR 📑 | ||
| {{ source | askAI("experienced technical writer focused on documentation", | ||
| "Review the PR code diff. | ||
|
There was a problem hiding this comment. I'm concerned about putting the prompt info into the CM file, rather than incorporating it into the plugin code because this has a risk of becoming messy if we build out additional use cases this way. Is it possible to incorporate the prompt into the plugin? I'm imagining it as a JSON file that's pulled into the code for easy updates. There was a problem hiding this comment. @BenLloydPearson One way we could do this is using the gitStream Using variables in this approach makes it so each AI automation uses the same base configuration, and you simply adjust behavior by swapping in and out prompts. I think a small folder of combinable prompts is the good way to approach this for longevity while keeping it flat and intuitive, but open to more brainstorming here. Alternatively, we could change the plugin's There was a problem hiding this comment. I love this solution. I think your naming convention for the txt files should work, but just be wary that we'll want to make sure we follow something that's consistent, descriptive, and sorts properly alphabetically (i.e. the prompt and role should appear next to each other when viewed inside the directory.) I believe your convention should check all these boxes, and we can adjust in the future if we find too many edge cases. There was a problem hiding this comment. Using the ReadFile filter looks great imo! It will require a bit more work from users tho, but once we'll open PRs to install automations this will be super easy and neat |
||
| - Generate documentation for any newly added features or significant changes. | ||
| - Focus on describing functionality, parameters, and expected behavior. | ||
| - Format the output in clear, concise bullet points or paragraphs.", env.OPEN_AI_TOKEN) }} | ||
| _This response was generated by the gitStream askAI plugin._ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,39 @@ | ||
| --- | ||
| title: Integrate gitStream with AI | ||
| description: Use gitStream to integrate with AI for different use cases. | ||
| category: [quality, genai, copilot, tests, efficiency] | ||
| --- | ||
| # Integrate gitStream with AI | ||
|
|
||
| <!-- --8<-- [start:examples]--> | ||
| !!! warning "Required gitStream Plugins" | ||
| This example requires you to install the [`askAI`](/filter-function-plugins/#askai) plugin, which will provide context to the configured model provider and may incur API costs. | ||
azigler marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [Learn more about gitStream plugins](/plugins/). | ||
|
|
||
| ## Ask AI to Summarize a PR | ||
|
|
||
| --8<-- "docs/automations/integrations/askAI/summarize-pr/README.md:example" | ||
|
|
||
| ## Ask AI to Review a PR | ||
|
|
||
| --8<-- "docs/automations/integrations/askAI/code-review/README.md:example" | ||
|
|
||
| ## Ask AI for Improvements to a PR | ||
|
|
||
| --8<-- "docs/automations/integrations/askAI/improve/README.md:example" | ||
|
|
||
| ## Ask AI for Documentation for a PR | ||
|
|
||
| --8<-- "docs/automations/integrations/askAI/document/README.md:example" | ||
|
|
||
| ## Ask AI for Tests for a PR | ||
|
|
||
| --8<-- "docs/automations/integrations/askAI/add-tests/README.md:example" | ||
| <!-- --8<-- [end:examples]--> | ||
|
|
||
| ## Additional Resources | ||
|
|
||
| --8<-- "docs/snippets/general.md" | ||
|
|
||
| --8<-- "docs/snippets/automation-footer.md" | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,26 @@ | ||
| <a name="module_generateDescription"></a> | ||
|
|
||
| ## askAI | ||
|
|
||
| !!! warning "Data privacy" | ||
| The [`askAI`](/filter-function-plugins/#askai) plugin will provide context to the configured model provider and may incur API costs. | ||
|
|
||
| [Learn more about gitStream plugins](/plugins/). | ||
|
|
||
| A gitStream plugin to facilitate AI workflows with OpenAI's `gpt-4o-2024-08-06` model. | ||
|
|
||
| **Returns**: <code>Object</code> - Returns the AI-generated response based on the provided context and prompt. | ||
| **License**: MIT | ||
|
|
||
| | Param | Type | Description | | ||
| | ------- | -------- | ------------------------------------------------------------------------------------------------------------------ | | ||
| | context | `Object` | The context to be sent to the AI model with the prompt. | | ||
| | role | `string` | The system role or persona for the AI to adopt while generating the response. | | ||
| | prompt | `string` | The specific request or question you want the AI to respond to, after the context has been provided. | | ||
| | token | `string` | Your OpenAI API token. | | ||
|
|
||
| **Example** | ||
|
|
||
| ```yaml | ||
| {{ source | askAI("Experienced developer", "Summarize the changes in this PR in bullet points.", env.OPEN_AI_TOKEN) }} | ||
| ``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.