From 52f4c15ee3d26a2a9c78d7ae267754711705228f Mon Sep 17 00:00:00 2001 From: Siri Varma Vegiraju Date: Mon, 14 Apr 2025 03:31:13 +0530 Subject: [PATCH] Update conversation_api.md (#4589) Signed-off-by: Siri Varma Vegiraju Co-authored-by: Whit Waldo Co-authored-by: Mark Fussell --- daprdocs/content/en/reference/api/conversation_api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/daprdocs/content/en/reference/api/conversation_api.md b/daprdocs/content/en/reference/api/conversation_api.md index 44fa52d28..415bd4faa 100644 --- a/daprdocs/content/en/reference/api/conversation_api.md +++ b/daprdocs/content/en/reference/api/conversation_api.md @@ -32,7 +32,7 @@ POST http://localhost:/v1.0-alpha1/conversation//converse | --------- | ----------- | | `inputs` | Inputs for the conversation. Multiple inputs at one time are supported. Required | | `cacheTTL` | A time-to-live value for a prompt cache to expire. Uses Golang duration format. Optional | -| `scrubPII` | A boolean value to enable obfuscation of sensitive information returning from the LLM. Optional | +| `scrubPII` | A boolean value to enable obfuscation of sensitive information returning from the LLM. Set this value if all PII (across contents) in the request needs to be scrubbed. Optional | | `temperature` | A float value to control the temperature of the model. Used to optimize for consistency and creativity. Optional | | `metadata` | [Metadata](#metadata) passed to conversation components. Optional | @@ -42,7 +42,7 @@ POST http://localhost:/v1.0-alpha1/conversation//converse | --------- | ----------- | | `content` | The message content to send to the LLM. Required | | `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. Optional | +| `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 | ### Request content example @@ -89,4 +89,4 @@ RESPONSE = { ## Next steps - [Conversation API overview]({{< ref conversation-overview.md >}}) -- [Supported conversation components]({{< ref supported-conversation >}}) \ No newline at end of file +- [Supported conversation components]({{< ref supported-conversation >}})