enhance OpenAi conversation component documentation for Azure OpenAi #4750
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
Signed-off-by: fabistb <[email protected]>
Signed-off-by: fabistb <[email protected]>
msfussell
reviewed
Aug 6, 2025
| | `cacheTTL` | N | A time-to-live value for a prompt cache to expire. Uses Golang duration format. | `10m` | | ||
| | `apiType` | N | Specifies the API provider type. Required when using a provider that does not follow the default OpenAI API endpoint conventions. | `azure` | | ||
| | `apiVersion`| N | The API version to use. Required when the `apiType` is set to `azure`. | `2025-01-01-preview` | |
There was a problem hiding this comment.
@fabistb - Is 2025-01-01-preview the only current valid value or are there others? If so, is there a link to Azure documentation for this list that we can reference?
There was a problem hiding this comment.
There are some preview apis as listed here:
https://learn.microsoft.com/en-us/azure/ai-foundry/openai/api-version-lifecycle?tabs=key#preview-api-releases
The newest version is: 2025-04-01-preview
We could add the latest stable version as example value, but some of the newer models won't work then.
If that works for you I would however add link above to the related links section
…ecycle Signed-off-by: fabistb <[email protected]>
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.
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Enhance the documentation for the OpenAI conversation API component.
Functionality to also utilize Azure OpenAi is added.
This includes two new optional metadata properties:
Also adds some description how the different metadata properties must be configured that Azure OpenAi works.
Related PR:
dapr/components-contrib#3918
Issue reference
#4749