删除历史会话_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

本文为您介绍OpenSearch-LLM智能问答版删除历史会话API。

前提条件

获取身份鉴权API Key：调用OpenSearch-LLM智能问答版服务时，需要对调用者身份进行鉴权，具体请参见管理API Key。
获取服务调用地址：调用OpenSearch-LLM智能问答版服务时，需要提供服务的调用地址，具体请参见获取服务调用地址。

接口信息

请求方法	请求协议	请求数据格式
DELETE	HTTP	JSON

请求URL

{host}/v3/openapi/apps/{app_group_identity}/chat/{chat_id}

{host}：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务调用地址。
{app_group_identity}：应用名称，需要登录OpenSearch-LLM智能问答版控制台，在实例管理中查看对应实例的应用名称。

请求参数

Header参数

参数	类型	是否必填	描述	示例值
Content-Type	string	是	请求的数据格式，目前仅支持JSON格式，固定填写"application/json"。	application/json
Authorization	string	是	请求鉴权的API Key，Bearer开头。	Bearer OS-d1**2a

Body参数

参数	类型	是否必填	描述	示例值
chat_id	string	是	历史会话id。	1751****6901

请求体示例

curl -X DELETE "{host}/v3/openapi/apps/{app_group_identity}/chat/{chat_id}" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {API Key}"

说明

{chat_id}可以通过历史会话列表接口获取。

返回参数

参数	类型	描述
request_id	string	请求ID。
status	string	请求状态。
code	string	返回的错误码（若无报错则不返回）。
message	string	返回的错误信息（若无报错则不返回）。

响应体示例

{
    "request_id": "ch23*******************766a",
    "status": "OK",
    "errors": [
        {
            "code": "如果有错误，这里返回错误码",
            "message": "如果有错误，这里返回错误信息"
        }
    ]
}