创建对话
编辑创建对话
编辑创建一个新的 Elastic AI 助手对话。
请求 URL
编辑POST <kibana 主机>:<端口>/api/security_ai_assistant/current_user/conversations
请求正文
编辑名称 | 类型 | 描述 | 必填 |
---|---|---|---|
|
字符串 |
对话标题。如果设置为“新聊天”,AI 将生成标题。 |
是 |
|
字符串 |
可以是“assistant”、“insights”或未定义。 |
否 |
|
布尔值 |
定义对话是否为系统对话,系统对话无法删除。默认为 false。 |
否 |
|
布尔值 |
定义对话是否可以显示为最近的对话。 |
否 |
|
对话配置。 |
否 |
|
|
对话消息数组。 |
否 |
|
|
键,值(字符串,字符串) |
包含匿名化字段的列表。 |
否 |
apiConfig
对象
编辑名称 | 类型 | 描述 | 必填 |
---|---|---|---|
|
字符串 |
Kibana 连接器 ID。 |
是 |
|
字符串 |
Kibana 连接器动作类型 ID。 |
是 |
|
字符串 |
默认系统提示 ID。 |
是 |
|
字符串 |
特定的 LLM 名称。 |
否 |
messages
对象
编辑名称 | 类型 | 描述 | 必填 |
---|---|---|---|
|
字符串 |
消息角色。可以是“user”、“assistant”或“system”。 |
是 |
|
字符串 |
要发送到 LLM 的消息内容。 |
是 |
|
布尔值 |
定义消息是否是错误消息而不是 LLM 响应。 |
否 |
|
字符串 |
发送消息的时间戳。 |
否 |
示例请求
编辑示例 1
创建一个新的对话。
POST api/security_ai_assistant/current_user/conversations { "title": "The conversation title.", "category": "assistant", "messages": [ { "content": "test content", "role": "user", "isError": false, "timestamp": "2019-12-13T16:40:33.400Z", "traceData": { "traceId": "1234", "transactionId": "2" } } ], "apiConfig": { "actionTypeId": ".gen-ai", "connectorId": "86ab-471c-a00b-25b7e20c2d12", "defaultSystemPromptId": "Default", "model": "gpt-4o" }, "isDefault": false, "excludeFromLastConversationStorage": true, "replacements": { "field1": "914beb92-86ab-471c-a00b" } }
响应代码
编辑200
表示调用成功。
响应有效负载
编辑具有唯一 id
的 JSON 对话对象。
示例 1
对话响应有效负载
{ "id": "07805df2-6462-451a-b534-78da47873c42", "title": "The conversation title.", "category": "assistant", "timestamp": "2024-07-29T06:58:15.670Z", "updatedAt": "2024-07-29T06:58:15.670Z", "createdAt": "2024-07-29T06:58:15.670Z", "replacements": { "field1": "914beb92-86ab-471c-a00b" }, "users": [ { "name": "elastic" } ], "messages": [ { "content": "test content", "role": "user", "timestamp": "2019-12-13T16:40:33.400Z", "traceData": { "transactionId": "2", "traceId": "1234" } } ], "apiConfig": { "connectorId": "86ab-471c-a00b-25b7e20c2d12", "actionTypeId": ".gen-ai", "defaultSystemPromptId": "Default", "model": "gpt-4o" }, "isDefault": false, "excludeFromLastConversationStorage": true, "namespace": "default" }