Skip to content

fix(conversation): update api docs + drive more clarity#5216

Merged
marcduiker merged 2 commits into
dapr:v1.18from
sicoyle:fix/conversation-api-clarity
Jun 18, 2026
Merged

fix(conversation): update api docs + drive more clarity#5216
marcduiker merged 2 commits into
dapr:v1.18from
sicoyle:fix/conversation-api-clarity

Conversation

@sicoyle

@sicoyle sicoyle commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within tabpane
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have tabpane

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

Signed-off-by: Samantha Coyle <sam@diagrid.io>
Copilot AI review requested due to automatic review settings June 16, 2026 18:16
@sicoyle sicoyle requested review from a team as code owners June 16, 2026 18:16

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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) and metadata (OpenAI-like tagging metadata).
  • Adds toolChoice: none to 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.

Comment thread daprdocs/content/en/reference/api/conversation_api.md Outdated
Comment thread daprdocs/content/en/reference/api/conversation_api.md Outdated
Comment thread daprdocs/content/en/reference/api/conversation_api.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Mark Fussell <markfussell@gmail.com>

@msfussell msfussell left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. @marcduiker PTAL

@marcduiker marcduiker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@marcduiker marcduiker merged commit 89c33c9 into dapr:v1.18 Jun 18, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants