fix(conversation): update api docs + drive more clarity#5216
Merged
Conversation
Signed-off-by: Samantha Coyle <sam@diagrid.io>
7 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Conversation API reference to better clarify the intended usage of parameters vs metadata in the Alpha2 conversation endpoint, and improves guidance around tool choice behavior.
Changes:
- Refines the request-body field descriptions for
parameters(typed overrides) andmetadata(OpenAI-like tagging metadata). - Adds
toolChoice: noneto the documented tool choice options and updates metadata examples to reflect tagging use-cases. - Adjusts the URL query metadata example away from configuration/auth-style usage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Mark Fussell <markfussell@gmail.com>
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.
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
This is to correct conversation api docs to better drive end user clarify on what the fields mean/do.
Issue reference
n/a