docs(azure): add assistants api example #1675
Open
+60
−0
Conversation
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
- Add azure/assistants.ts demonstrating Assistants API usage with Azure OpenAI - Uses AzureOpenAI client with Azure AD authentication - Follows pattern from existing azure/chat.ts example - Addresses issue openai#701
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.
Description
Adds Azure OpenAI Assistants API example to complement the existing Azure chat completion example.
Changes
examples/azure/assistants.tsdemonstrating how to use the Assistants API with Azure OpenAIexamples/azure/chat.ts(Azure AD withAzureOpenAIclient)2024-10-01-previewconsistent with other Azure examplesContext
Addresses #701 where users requested Azure Assistants API integration/example. The maintainer (@rattrayalex) explicitly welcomed a PR adding this example.
Testing
Fixes #701
Note: I understand that this repository is auto-generated and my pull request may not be merged. However, per CONTRIBUTING.md, the
examples/directory is protected from generator overwrites, ensuring this example file will persist. This example provides immediate value for Azure OpenAI users working with Assistants API.