Add API docs for builtin clients #4232
Open
+110
−0
Conversation
This file contains 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
lspinheiro
reviewed
Nov 16, 2024
| .. code-block:: bash | ||
| pip install 'autogen-ext[openai,azure]==0.4.0.dev6' |
There was a problem hiding this comment.
We may want to omit the version in the docstring to avoid getting it outdated too soon.
lspinheiro
reviewed
Nov 16, 2024
| model (str): The deployment ID for the Azure model. **Required for Azure models.** | ||
| api_version (str): The API version to use. **Required for Azure models.** | ||
| azure_ad_token (str): The Azure AD token to use. Provide either this or `azure_ad_token_provider`. | ||
| azure_ad_token_provider (AsyncAzureAdTokenProvider): The Azure AD token provider to use. Provide either this or `azure_ad_token`. |
There was a problem hiding this comment.
I think it is either azure_ad_token, azure_ad_token_provider or api_key
lspinheiro
reviewed
Nov 16, 2024
| azure_ad_token (str): The Azure AD token to use. Provide either this or `azure_ad_token_provider`. | ||
| azure_ad_token_provider (AsyncAzureAdTokenProvider): The Azure AD token provider to use. Provide either this or `azure_ad_token`. | ||
| model_capabilities (ModelCapabilities): The capabilities of the model. **Required for Azure models.** | ||
| api_key (optional, str): The API key to use, use this if you are using key based authentication. |
There was a problem hiding this comment.
Should also support an environment variable AZURE_OPENAI_API_KEY
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.
Resolves #4174