› › ›

创建会话

编辑

创建会话

编辑

创建一个新的 Elastic AI 助手会话。

请求 URL

编辑

POST <kibana 主机>:<端口>/api/security_ai_assistant/current_user/conversations

请求正文

编辑

名称	类型	描述	必需
`title`	字符串	会话标题。如果您将其设置为“新聊天”，AI 将生成一个标题。	是
`category`	字符串	可以是“assistant”、“insights”或未定义。	否
`isDefault`	布尔值	定义会话是否为无法删除的系统会话。默认为 false。	否
`excludeFromLastConversationStorage`	布尔值	定义会话是否可以显示为最新的会话。	否
`apiConfig`	apiConfig 对象	会话配置。	否
`messages`	messages 对象	会话消息数组。	否
`replacements`	键、值（字符串、字符串）	带有匿名化的字段列表。	否

`apiConfig` 对象

编辑

名称	类型	描述	必需
`connectorId`	字符串	Kibana 连接器 ID。	是
`actionTypeId`	字符串	Kibana 连接器操作类型 ID。	是
`defaultSystemPromptId`	字符串	默认系统提示 ID。	是
`model`	字符串	特定的 LLM 名称。	否

`messages` 对象

编辑

名称	类型	描述	必需
`role`	字符串	消息角色。可以是“user”、“assistant”或“system”。	是
`content`	字符串	要发送到 LLM 的消息内容。	是
`isError`	布尔值	定义消息是错误消息而不是 LLM 响应。	否
`timestamp`	字符串	发送消息时的时间戳。	否

示例请求

编辑

示例 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"
}

« 完成聊天删除会话 »

创建会话

创建会话

请求 URL

请求正文

apiConfig 对象

messages 对象

示例请求

响应代码

响应有效负载

`apiConfig` 对象

`messages` 对象