|
@@ -682,16 +682,13 @@ Chat applications support session persistence, allowing previous chat history to
|
|
|
Should be uniquely defined by the developer within the application.
|
|
|
</Property>
|
|
|
<Property name='last_id' type='string' key='last_id'>
|
|
|
- The ID of the last record on the current page, default is null.
|
|
|
+ (Optional) The ID of the last record on the current page, default is null.
|
|
|
</Property>
|
|
|
<Property name='limit' type='int' key='limit'>
|
|
|
- How many records to return in one request, default is the most recent 20 entries.
|
|
|
- </Property>
|
|
|
- <Property name='pinned' type='bool' key='pinned'>
|
|
|
- Return only pinned conversations as `true`, only non-pinned as `false`
|
|
|
+ (Optional) How many records to return in one request, default is the most recent 20 entries. Maximum 100, minimum 1.
|
|
|
</Property>
|
|
|
<Property name='sort_by' type='string' key='sort_by'>
|
|
|
- Sorting Field (Optional), Default: -updated_at (sorted in descending order by update time)
|
|
|
+ (Optional) Sorting Field, Default: -updated_at (sorted in descending order by update time)
|
|
|
- Available Values: created_at, -created_at, updated_at, -updated_at
|
|
|
- The symbol before the field represents the order or reverse, "-" represents reverse order.
|
|
|
</Property>
|
|
@@ -702,8 +699,10 @@ Chat applications support session persistence, allowing previous chat history to
|
|
|
- `id` (string) Conversation ID
|
|
|
- `name` (string) Conversation name, by default, is a snippet of the first question asked by the user in the conversation.
|
|
|
- `inputs` (array[object]) User input parameters.
|
|
|
+ - `status` (string) Conversation status
|
|
|
- `introduction` (string) Introduction
|
|
|
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
|
|
|
+ - `updated_at` (timestamp) Update timestamp, e.g., 1705395332
|
|
|
- `has_more` (bool)
|
|
|
- `limit` (int) Number of entries returned, if input exceeds system limit, system limit number is returned
|
|
|
|
|
@@ -733,7 +732,8 @@ Chat applications support session persistence, allowing previous chat history to
|
|
|
"myName": "Lucy"
|
|
|
},
|
|
|
"status": "normal",
|
|
|
- "created_at": 1679667915
|
|
|
+ "created_at": 1679667915,
|
|
|
+ "updated_at": 1679667915
|
|
|
},
|
|
|
{
|
|
|
"id": "hSIhXBhNe8X1d8Et"
|
|
@@ -815,10 +815,10 @@ Chat applications support session persistence, allowing previous chat history to
|
|
|
|
|
|
<Properties>
|
|
|
<Property name='name' type='string' key='name'>
|
|
|
- The name of the conversation. This parameter can be omitted if `auto_generate` is set to `true`.
|
|
|
+ (Optional) The name of the conversation. This parameter can be omitted if `auto_generate` is set to `true`.
|
|
|
</Property>
|
|
|
<Property name='auto_generate' type='bool' key='auto_generate'>
|
|
|
- Automatically generate the title, default is `false`
|
|
|
+ (Optional) Automatically generate the title, default is `false`
|
|
|
</Property>
|
|
|
<Property name='user' type='string' key='user'>
|
|
|
The user identifier, defined by the developer, must ensure uniqueness within the application.
|
|
@@ -828,13 +828,15 @@ Chat applications support session persistence, allowing previous chat history to
|
|
|
### Response
|
|
|
- `id` (string) Conversation ID
|
|
|
- `name` (string) Conversation name
|
|
|
- - `inputs` array[object] User input parameters.
|
|
|
+ - `inputs` array[object] User input parameters
|
|
|
+ - `status` (string) Conversation status
|
|
|
- `introduction` (string) Introduction
|
|
|
- `created_at` (timestamp) Creation timestamp, e.g., 1705395332
|
|
|
+ - `updated_at` (timestamp) Update timestamp, e.g., 1705395332
|
|
|
</Col>
|
|
|
<Col sticky>
|
|
|
|
|
|
- <CodeGroup title="Request" tag="POST" label="/conversations/:conversation_id/name" targetCode={`curl -X POST '${props.appDetail.api_base_url}/conversations/:conversation_id/name' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \n "name": "", \n "user": "abc-123"\n}'`}>
|
|
|
+ <CodeGroup title="Request" tag="POST" label="/conversations/:conversation_id/name" targetCode={`curl -X POST '${props.appDetail.api_base_url}/conversations/:conversation_id/name' \\\n--header 'Authorization: Bearer {api_key}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{ \n "name": "", \n "auto_generate": true, \n "user": "abc-123"\n}'`}>
|
|
|
|
|
|
```bash {{ title: 'cURL' }}
|
|
|
curl -X POST '${props.appDetail.api_base_url}/conversations/{conversation_id}/name' \
|
|
@@ -842,6 +844,7 @@ Chat applications support session persistence, allowing previous chat history to
|
|
|
--header 'Authorization: Bearer {api_key}' \
|
|
|
--data-raw '{
|
|
|
"name": "",
|
|
|
+ "auto_generate": true,
|
|
|
"user": "abc-123"
|
|
|
}'
|
|
|
```
|
|
@@ -854,8 +857,10 @@ Chat applications support session persistence, allowing previous chat history to
|
|
|
"id": "cd78daf6-f9e4-4463-9ff2-54257230a0ce",
|
|
|
"name": "Chat vs AI",
|
|
|
"inputs": {},
|
|
|
+ "status": "normal",
|
|
|
"introduction": "",
|
|
|
- "created_at": 1705569238
|
|
|
+ "created_at": 1705569238,
|
|
|
+ "updated_at": 1705569238
|
|
|
}
|
|
|
```
|
|
|
</CodeGroup>
|