feat: conversation api toolcalling support documentation #4769
+172
−31
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: Samantha Coyle <[email protected]>
msfussell
reviewed
Aug 19, 2025
| | `metadata` | [Metadata](#metadata) passed to conversation components. Optional | | ||
| | `scrub_pii` | A boolean value to enable obfuscation of sensitive information returning from the LLM. Optional | |
There was a problem hiding this comment.
This has changed and anyway should not have an underscore.
| @@ -30,34 +30,117 @@ POST http://localhost:<daprPort>/v1.0-alpha1/conversation/<llm-name>/converse | |||
|
|
|||
| | Field | Description | | |||
| | --------- | ----------- | | |||
| | `name` | The name of the conversation component. Required | | |||
| | `context_id` | The ID of an existing chat (like in ChatGPT). Optional | | |||
| | `role` | The role for the LLM to assume. Possible values: 'user', 'tool', 'assistant' | | ||
| | `scrubPII` | A boolean value to enable obfuscation of sensitive information present in the content field. Set this value if PII for this specific content needs to be scrubbed exclusively. Optional | | ||
| | `messages` | Array of conversation messages. Required | | ||
| | `scrub_pii` | A boolean value to enable obfuscation of sensitive information present in the content field. Optional | |
|
|
||
| ``` | ||
| POST http://localhost:<daprPort>/v1.0-alpha1/conversation/<llm-name>/converse | ||
| POST http://localhost:<daprPort>/v1.0-alpha2/conversation/<llm-name>/converse |
There was a problem hiding this comment.
Update the Alpha API table here to move to alpha2 anc update the proto link
https://docs.dapr.io/operations/support/alpha-beta-apis/#alpha-apis
| @@ -10,14 +10,14 @@ weight: 1400 | |||
| The conversation API is currently in [alpha]({{% ref "certification-lifecycle.md#certification-levels" %}}). | |||
| {{% /alert %}} | |||
|
|
|||
| Dapr provides an API to interact with Large Language Models (LLMs) and enables critical performance and security functionality with features like prompt caching and PII data obfuscation. | |||
| Dapr provides an API to interact with Large Language Models (LLMs) and enables critical performance and security functionality with features like prompt caching, PII data obfuscation, and tool calling capabilities. | |||
There was a problem hiding this comment.
Suggested change
| Dapr provides an API to interact with Large Language Models (LLMs) and enables critical performance and security functionality with features like prompt caching, PII data obfuscation, and tool calling capabilities. | |
| Dapr provides an API to interact with Large Language Models (LLMs) and enables critical performance and security functionality with features like prompt caching, PII data obfuscation, and tool calling capabilities. | |
| The tool calling follows OpenAI's interface standards, making it easy to integrate with existing AI development workflows and tools. |
There was a problem hiding this comment.
OpenAI's interface standards -> OpenAI’s function calling format
bibryam
reviewed
Aug 21, 2025
| - Provide dynamic, context-aware responses | ||
| - Create multi-step workflows and automation | ||
|
|
||
| Tool calling follows OpenAI's interface standards, making it easy to integrate with existing AI development workflows and tools. |
There was a problem hiding this comment.
"interface standards" is not a common terminology. Let's use "OpenAI's function calling format" and provide a link
| @@ -10,14 +10,14 @@ weight: 1400 | |||
| The conversation API is currently in [alpha]({{% ref "certification-lifecycle.md#certification-levels" %}}). | |||
| {{% /alert %}} | |||
|
|
|||
| Dapr provides an API to interact with Large Language Models (LLMs) and enables critical performance and security functionality with features like prompt caching and PII data obfuscation. | |||
| Dapr provides an API to interact with Large Language Models (LLMs) and enables critical performance and security functionality with features like prompt caching, PII data obfuscation, and tool calling capabilities. | |||
There was a problem hiding this comment.
OpenAI's interface standards -> OpenAI’s function calling format
|
|
||
| The `tool_choice` parameter controls how the model uses available tools: | ||
|
|
||
| - **`""`**: The model will not call any tool and instead generates a message (default when no tools are present) |
There was a problem hiding this comment.
This part is confusing: (default when no tools are present)
When no tools are present, would it behave like "auto" , or it will behave like ""
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
Add tool calling support in teh conversation api docs. I did not update the "How to converse" page as I need the rest of the SDKs updated to reference to bring in python & js code snippets and the other languages sdks updated with tool call support. So the corresponding updates here will be in a separate PR after SDKs are updated: https://docs.dapr.io/developing-applications/building-blocks/conversation/howto-conversation-layer/
Issue reference
#4687