docs: add HPC-AI chat generator docs#11048
Open
lioZ129 wants to merge 2 commits intodeepset-ai:mainfrom
Open
Conversation
lioZ129
requested review from
anakin87 and
Copilot
and removed request for
a team
|
@lioZ129 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Pull request overview
Adds documentation for the new HPCAIChatGenerator integration and wires it into the docs navigation so it’s discoverable alongside other generators.
Changes:
- Added a new docs page for
HPCAIChatGenerator, including env vars, supported models, and usage examples. - Added
HPCAIChatGeneratorto the generators index page. - Added
HPCAIChatGeneratorto the docs sidebar under Generators.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs-website/sidebars.js | Adds the new generator doc page to the Generators sidebar list. |
| docs-website/docs/pipeline-components/generators/hpcaichatgenerator.mdx | New documentation page describing setup and usage for HPCAIChatGenerator. |
| docs-website/docs/pipeline-components/generators.mdx | Adds HPCAIChatGenerator to the generators index table. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
4 tasks
Author
|
@sjrl could you please review these PRs? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
HPCAIChatGeneratordocs pageHPC_AI_API_KEY, optionalHPC_AI_BASE_URL, the default endpoint, and the two supported modelsNotes
How did you test it?
unit tests, integration tests, manual verification