Skip to content

Commit 2eb604f

Browse files
bibryamMyMirelHub
authored andcommitted
Reverting back from snake case to camel case
Signed-off-by: Bilgin Ibryam <[email protected]>
1 parent 4a83a61 commit 2eb604f

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

daprdocs/content/en/reference/api/conversation_api.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,33 @@ POST http://localhost:<daprPort>/v1.0-alpha2/conversation/<llm-name>/converse
3232

3333
| Field | Description |
3434
| --------- | ----------- |
35-
| `context_id` | The ID of an existing chat (like in ChatGPT). Optional |
35+
| `contextId` | The ID of an existing chat (like in ChatGPT). Optional |
3636
| `inputs` | Inputs for the conversation. Multiple inputs at one time are supported. Required |
3737
| `parameters` | Parameters for all custom fields. Optional |
3838
| `metadata` | Metadata passed to conversation components. Optional |
39-
| `scrub_pii` | A boolean value to enable obfuscation of sensitive information returning from the LLM. Optional |
39+
| `scrubPii` | A boolean value to enable obfuscation of sensitive information returning from the LLM. Optional |
4040
| `temperature` | A float value to control the temperature of the model. Used to optimize for consistency (0) or creativity (1). Optional |
4141
| `tools` | Tools register the tools available to be used by the LLM during the conversation. Optional |
42-
| `tool_choice` | Controls which (if any) tool is called by the model. Values: `auto`, `required`, or specific tool name. Defaults to `auto` if tools are present. Optional |
42+
| `toolChoice` | Controls which (if any) tool is called by the model. Values: `auto`, `required`, or specific tool name. Defaults to `auto` if tools are present. Optional |
4343

4444
#### Input body
4545

4646
| Field | Description |
4747
| --------- | ----------- |
4848
| `messages` | Array of conversation messages. Required |
49-
| `scrub_pii` | A boolean value to enable obfuscation of sensitive information present in the content field. Optional |
49+
| `scrubPii` | A boolean value to enable obfuscation of sensitive information present in the content field. Optional |
5050

5151
#### Message types
5252

5353
The API supports different message types:
5454

5555
| Type | Description |
5656
| ---- | ----------- |
57-
| `of_developer` | Developer role messages with optional name and content |
58-
| `of_system` | System role messages with optional name and content |
59-
| `of_user` | User role messages with optional name and content |
60-
| `of_assistant` | Assistant role messages with optional name, content, and tool calls |
61-
| `of_tool` | Tool role messages with tool ID, name, and content |
57+
| `ofDeveloper` | Developer role messages with optional name and content |
58+
| `ofSystem` | System role messages with optional name and content |
59+
| `ofUser` | User role messages with optional name and content |
60+
| `ofAssistant` | Assistant role messages with optional name, content, and tool calls |
61+
| `ofTool` | Tool role messages with tool ID, name, and content |
6262

6363

6464
#### Tool calling
@@ -74,7 +74,7 @@ Tools can be defined using the `tools` field with function definitions:
7474

7575
#### Tool choice options
7676

77-
The `tool_choice` is an optional parameter that controls how the model can use available tools:
77+
The `toolChoice` is an optional parameter that controls how the model can use available tools:
7878

7979
- **`auto`**: The model can pick between generating a message or calling one or more tools (default when tools are present)
8080
- **`required`**: Requires one or more functions to be called
@@ -122,7 +122,7 @@ curl -X POST http://localhost:3500/v1.0-alpha2/conversation/openai/converse \
122122
{
123123
"messages": [
124124
{
125-
"of_user": {
125+
"ofUser": {
126126
"content": [
127127
{
128128
"text": "What is Dapr?"
@@ -148,7 +148,7 @@ curl -X POST http://localhost:3500/v1.0-alpha2/conversation/openai/converse \
148148
{
149149
"messages": [
150150
{
151-
"of_user": {
151+
"ofUser": {
152152
"content": [
153153
{
154154
"text": "What is the weather like in San Francisco in celsius?"
@@ -157,7 +157,7 @@ curl -X POST http://localhost:3500/v1.0-alpha2/conversation/openai/converse \
157157
}
158158
}
159159
],
160-
"scrub_pii": false
160+
"scrubPii": false
161161
}
162162
],
163163
"parameters": {
@@ -174,7 +174,7 @@ curl -X POST http://localhost:3500/v1.0-alpha2/conversation/openai/converse \
174174
"api_key": "test-key",
175175
"version": "1.0"
176176
},
177-
"scrub_pii": false,
177+
"scrubPii": false,
178178
"temperature": 0.7,
179179
"tools": [
180180
{
@@ -199,7 +199,7 @@ curl -X POST http://localhost:3500/v1.0-alpha2/conversation/openai/converse \
199199
}
200200
}
201201
],
202-
"tool_choice": "auto"
202+
"toolChoice": "auto"
203203
}'
204204
```
205205

0 commit comments

Comments
 (0)