README.md
Azure OpenAI extensions module for Go
This module provides models and convenience functions to make it simpler to use Azure OpenAI features, such as Azure OpenAI On Your Data, with the OpenAI Go client (https://pkg.go.dev/github.com/openai/openai-go).
Source code | Package (pkg.go.dev) | REST API documentation | Product documentation
Getting started
Prerequisites
- Go, version 1.21 or higher - Install Go
- Azure subscription
- Azure OpenAI access
Install the packages
Install the azopenaiextensions and azidentity modules with go get:
go get github.com/Azure/azure-sdk-for-go/sdk/ai/azopenaiextensions
# optional
go get github.com/Azure/azure-sdk-for-go/sdk/azidentity
The azidentity module is used for Azure Active Directory authentication with Azure OpenAI.
Key concepts
See Key concepts in the product documentation for more details about general concepts.
Examples
Examples for scenarios specific to Azure can be found on pkg.go.dev or in the example*_test.go files in our GitHub repo for azopenaiextensions.
For examples on using the openai-go client, see the examples in the openai-go repository.
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.