{
  "name": "es",
  "display_name": "Elasticsearch Service",
  "description": "介绍如何使用API对Elasticsearch Service进行操作，包括ES集群实例管理等。",
  "domain": "database",
  "api_version": "2025-01-01",
  "endpoint": "es.tencentcloudapi.com",
  "actions": [
    {
      "name": "ChatCompletions",
      "description": "本服务支持一系列高性能的大语言模型，包括DeepSeek以及腾讯自主研发的混元大模型，结合混合搜索等先进搜索技术，快速高效实现RAG，有效解决幻觉和知识更新问题。 本接口有模型维度调用上限控制，单个模型qps限制5，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "Messages",
          "type": "array",
          "required": true,
          "description": "会话内容，按对话时间从旧到新在数组中排列，长度受模型窗口大小限制。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Role",
              "type": "string",
              "required": false,
              "description": "角色，可选值包括 system、user、assistant、 tool。",
              "example": "user"
            },
            {
              "name": "Content",
              "type": "string",
              "required": false,
              "description": "具体文本内容",
              "example": "请问如何访问腾讯云官网？"
            },
            {
              "name": "ToolCallId",
              "type": "string",
              "required": false,
              "description": "当role为tool时传入，标识具体的函数调用",
              "example": "call_cq16e7k2c3m1v"
            },
            {
              "name": "ToolCalls",
              "type": "array",
              "required": false,
              "description": "模型生成的工具调用",
              "example": "无",
              "item_type": "object",
              "children": [
                {
                  "name": "Id",
                  "type": "string",
                  "required": false,
                  "description": "工具调用id",
                  "example": "call_cpv320k2c3m8fgcs8ja0"
                },
                {
                  "name": "Type",
                  "type": "string",
                  "required": false,
                  "description": "工具调用类型，当前只支持function",
                  "example": "function"
                },
                {
                  "name": "Function",
                  "type": "object",
                  "required": false,
                  "description": "具体的function调用",
                  "example": "无",
                  "children": [
                    {
                      "name": "Name",
                      "type": "string",
                      "required": false,
                      "description": "function名称",
                      "example": "get_current_weather"
                    },
                    {
                      "name": "Arguments",
                      "type": "string",
                      "required": false,
                      "description": "function参数，一般为json字符串",
                      "example": "{\"location\":[\"北京\",\"深圳\"],\"unit\":\"celsius\"}"
                    }
                  ]
                },
                {
                  "name": "Index",
                  "type": "integer",
                  "required": false,
                  "description": "索引值",
                  "example": "0"
                }
              ]
            }
          ]
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "模型名称，可选模型列表：hunyuan-turbo，hunyuan-large，hunyuan-large-longcontext，hunyuan-standard，hunyuan-standard-256K，deepseek-r1，deepseek-v3，deepseek-r1-distill-qwen-32b。",
          "example": "hunyuan-turbo"
        },
        {
          "name": "Stream",
          "type": "boolean",
          "required": false,
          "description": "是否以流式接口的形式返回数据，默认true。",
          "example": "true"
        },
        {
          "name": "TopP",
          "type": "float",
          "required": false,
          "description": "取值区间为[0.0, 1.0], 非必要不建议使用, 不合理的取值会影响效果 。",
          "example": "0.1"
        },
        {
          "name": "Temperature",
          "type": "float",
          "required": false,
          "description": "取值区间为[0.0, 2.0], 非必要不建议使用, 不合理的取值会影响效果 。",
          "example": "1.1"
        },
        {
          "name": "OnlineSearch",
          "type": "boolean",
          "required": false,
          "description": "是否开启联网搜索。默认为 false。",
          "example": "false"
        },
        {
          "name": "OnlineSearchOptions",
          "type": "object",
          "required": false,
          "description": "当 OnlineSearch 为 true 时，指定的搜索引擎，默认为 bing。",
          "example": "无",
          "children": [
            {
              "name": "Engine",
              "type": "string",
              "required": false,
              "description": "搜索引擎。支持 bing 和 sogou。",
              "example": "bing"
            }
          ]
        },
        {
          "name": "Tools",
          "type": "array",
          "required": false,
          "description": "可调用的工具列表，当前支持模型：hunyuan-turbo, deepseek-v3。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Type",
              "type": "string",
              "required": true,
              "description": "工具类型，当前只支持function",
              "example": "function"
            },
            {
              "name": "Function",
              "type": "object",
              "required": true,
              "description": "具体要调用的function",
              "example": "无",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "function名称，只能包含a-z，A-Z，0-9，_或-",
                  "example": "get_current_weather"
                },
                {
                  "name": "Parameters",
                  "type": "string",
                  "required": true,
                  "description": "function参数，一般为json字符串",
                  "example": "{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"}},\"required\":[\"location\",\"unit\"]}"
                },
                {
                  "name": "Description",
                  "type": "string",
                  "required": false,
                  "description": "function的简单描述",
                  "example": "获取当前地点的天气"
                }
              ]
            }
          ]
        },
        {
          "name": "ToolChoice",
          "type": "string",
          "required": false,
          "description": "工具使用选项，可选值包括 none、auto、custom。说明：1. 仅对 hunyuan-turbo、deepseek-v3 模型生效。2. none：不调用工具；auto：模型自行选择生成回复或调用工具；custom：强制模型调用指定的工具。3. 未设置时，默认值为auto",
          "example": "auto"
        },
        {
          "name": "CustomTool",
          "type": "object",
          "required": false,
          "description": "强制模型调用指定的工具，当参数ToolChoice为custom时，此参数为必填",
          "example": "无",
          "children": [
            {
              "name": "Type",
              "type": "string",
              "required": true,
              "description": "工具类型，当前只支持function",
              "example": "function"
            },
            {
              "name": "Function",
              "type": "object",
              "required": true,
              "description": "具体要调用的function",
              "example": "无",
              "children": [
                {
                  "name": "Name",
                  "type": "string",
                  "required": true,
                  "description": "function名称，只能包含a-z，A-Z，0-9，_或-",
                  "example": "get_current_weather"
                },
                {
                  "name": "Parameters",
                  "type": "string",
                  "required": true,
                  "description": "function参数，一般为json字符串",
                  "example": "{\"type\":\"object\",\"properties\":{\"location\":{\"type\":\"string\",\"description\":\"The city and state, e.g. San Francisco, CA\"}},\"required\":[\"location\",\"unit\"]}"
                },
                {
                  "name": "Description",
                  "type": "string",
                  "required": false,
                  "description": "function的简单描述",
                  "example": "获取当前地点的天气"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "Messages",
        "ModelName"
      ]
    },
    {
      "name": "ChunkDocument",
      "description": "文本切片是将长文本分割为短片段的技术，用于适配模型输入、提升处理效率或信息检索，平衡片段长度与语义连贯性，适用于NLP、数据分析等场景。 本接口为分隔符规则切片接口，有单账号调用上限控制，如您有提高并发限制的需求请 [联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "Document",
          "type": "object",
          "required": true,
          "description": "切片文件信息。",
          "example": "无",
          "children": [
            {
              "name": "FileType",
              "type": "string",
              "required": false,
              "description": "文件类型，支持 MD，TXT 格式。",
              "example": "TXT"
            },
            {
              "name": "FileContent",
              "type": "string",
              "required": false,
              "description": "文本原文，使用字符串格式输入。",
              "example": "hello,world"
            }
          ]
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "模型名称，可选模型列表：doc-chunk。",
          "example": "doc-chunk"
        },
        {
          "name": "Config",
          "type": "object",
          "required": false,
          "description": "文件切片配置。",
          "example": "无",
          "children": [
            {
              "name": "MaxChunkSize",
              "type": "integer",
              "required": false,
              "description": "按照分隔符切片后，对分片长度会进行校验，当超过最大分片长度时，则用下一级分隔符分割，如无下一级分隔符，则保留原长度；默认值：1000",
              "example": "4800"
            },
            {
              "name": "Delimiters",
              "type": "array",
              "required": false,
              "description": "分隔符列表，优先靠前的分隔符；文件类型为TXT时，默认值：[\"\\n\\n\", \"\\n\", \"。\", \"！\", \"？\", \"，\", \"\"]",
              "example": "[\"\\n\\n\", \"\\n\", \"。\", \"！\", \"？\", \"，\", \" \"]",
              "item_type": "string"
            },
            {
              "name": "ChunkOverlap",
              "type": "integer",
              "required": false,
              "description": "相邻切片重合字符数，需要小于分片长度，若形成完全冗余的切片，则会自动过滤；默认值：0.2*MaxChunkSize",
              "example": "1000"
            }
          ]
        }
      ],
      "required": [
        "Document",
        "ModelName"
      ]
    },
    {
      "name": "ChunkDocumentAsync",
      "description": "文本切片是将长文本分割为短片段的技术，用于适配模型输入、提升处理效率或信息检索，平衡片段长度与语义连贯性，适用于NLP、数据分析等场景。 本接口为异步接口，有模型维度调用上限控制，单个模型qps限制5，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "Document",
          "type": "object",
          "required": true,
          "description": "文件信息。",
          "example": "无",
          "children": [
            {
              "name": "FileType",
              "type": "string",
              "required": true,
              "description": "支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、 XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、 IM、PCX、PPM、TIFF、XBM、HEIF、JP2 文档解析支持的文件大小： -PDF、DOC、DOCX、PPT、PPTX支持100M -MD、TXT、XLS、XLSX、CSV支特10M -其他支持20M 文本切片支持的文件大小： -PDF最大300M -D0CX、D0C、PPT、PPTX最大200M -TXT、MD最大10M -其他最大20M",
              "example": "DOC"
            },
            {
              "name": "FileUrl",
              "type": "string",
              "required": false,
              "description": "文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，使用腾讯云COS 文件地址。",
              "example": "https://example.com/example.pdf"
            },
            {
              "name": "FileContent",
              "type": "string",
              "required": false,
              "description": "文件的 base64 值，携带 MineType前缀信息。编码后的后的文件不超过 10M。 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。 支持的图片像素：单边介于20-10000px之间。",
              "example": "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="
            },
            {
              "name": "FileName",
              "type": "string",
              "required": false,
              "description": "文件名称，当使用 base64上传的时候使用。",
              "example": "example.txt"
            },
            {
              "name": "FileStartPageNumber",
              "type": "integer",
              "required": false,
              "description": "文档的起始页码",
              "example": "1"
            },
            {
              "name": "FileEndPageNumber",
              "type": "integer",
              "required": false,
              "description": "文档的结束页码",
              "example": "1"
            }
          ]
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "模型名称，可选模型列表：doc-tree-chunk。",
          "example": "doc-tree-chunk"
        },
        {
          "name": "Config",
          "type": "object",
          "required": false,
          "description": "文件切片配置。",
          "example": "无",
          "children": [
            {
              "name": "MaxChunkSize",
              "type": "integer",
              "required": false,
              "description": "最大分片长度",
              "example": "4800"
            }
          ]
        }
      ],
      "required": [
        "Document",
        "ModelName"
      ]
    },
    {
      "name": "GetDocumentChunkResult",
      "description": "获取文档切片结果",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务 ID",
          "example": "3041d1dc-1072-4025-a3c2-f8baea25801b"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "GetDocumentParseResult",
      "description": "本接口用于获取文档解析异步处理结果。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务 Id",
          "example": "10343124"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "GetMultiModalEmbedding",
      "description": "Embedding是一种将高维数据映射到低维空间的技术，通常用于将非结构化数据，如文本、图像或音频转化为向量表示，使其更容易输入机器模型进行处理，并且向量之间的距离可以反映对象之间的相似性。 本接口有模型维度调用上限控制，单个模型qps限制10，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "ModelName",
          "type": "string",
          "required": false,
          "description": "模型名称，支持WeCLIPv2-Base和WeCLIPv2-Large",
          "example": "WeCLIPv2-Base"
        },
        {
          "name": "Texts",
          "type": "array",
          "required": false,
          "description": "需进行向量化的文本集，一次输入限10条，单条文本长度限72",
          "example": "[\"红色帽子\",\"白色围巾\"]",
          "item_type": "string"
        },
        {
          "name": "ImageData",
          "type": "array",
          "required": false,
          "description": "输入图片，base64编码格式，一次输入限制8个，单张图片限制1M",
          "example": "[\"data:image/jpeg;base64,/AAA/BBB/CCC\"]",
          "item_type": "string"
        },
        {
          "name": "ImageUrl",
          "type": "array",
          "required": false,
          "description": "输入图片url，一次输入限8个，推荐cos地址，速度更快",
          "example": "[\"http://aaa.bb.com/cc\"]",
          "item_type": "string"
        }
      ],
      "required": []
    },
    {
      "name": "GetTextEmbedding",
      "description": "Embedding是一种将高维数据映射到低维空间的技术，通常用于将非结构化数据，如文本、图像或音频转化为向量表示，使其更容易输入机器模型进行处理，并且向量之间的距离可以反映对象之间的相似性。 本接口有模型维度调用上限控制，单个模型qps限制20，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "模型名称，可选模型列表：bge-base-zh-v1.5,Conan-embedding-v1,bge-m3,KaLM-embedding-multilingual-mini-v1,Qwen3-Embedding-0.6B。",
          "example": "bge-base-zh-v1.5"
        },
        {
          "name": "Texts",
          "type": "array",
          "required": true,
          "description": "需进行向量化的文本集。",
          "example": "[\"今天天气怎样\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "ModelName",
        "Texts"
      ]
    },
    {
      "name": "ParseDocument",
      "description": "本服务可将各类格式文档精准转换为标准格式，满足企业知识库建设、技术文档迁移、内容平台结构化存储等需求。 本接口有模型维度调用上限控制，单个模型qps限制5，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "Document",
          "type": "object",
          "required": true,
          "description": "文件信息",
          "example": "无",
          "children": [
            {
              "name": "FileType",
              "type": "string",
              "required": true,
              "description": "支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、 XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、 IM、PCX、PPM、TIFF、XBM、HEIF、JP2 文档解析支持的文件大小： -PDF、DOC、DOCX、PPT、PPTX支持100M -MD、TXT、XLS、XLSX、CSV支特10M -其他支持20M 文本切片支持的文件大小： -PDF最大300M -D0CX、D0C、PPT、PPTX最大200M -TXT、MD最大10M -其他最大20M",
              "example": "PDF"
            },
            {
              "name": "FileUrl",
              "type": "string",
              "required": false,
              "description": "文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，使用腾讯云COS 文件地址。",
              "example": "https://example.com/example.pdf"
            },
            {
              "name": "FileContent",
              "type": "string",
              "required": false,
              "description": "文件的 base64 值，携带 MineType前缀信息。编码后的后的文件不超过 10M。 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。 支持的图片像素：单边介于20-10000px之间。 文件的 FileUrl、FileContent必须提供一个，如果都提供只使用 FileUrl。",
              "example": "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="
            },
            {
              "name": "DocumentParseConfig",
              "type": "object",
              "required": false,
              "description": "文档解析配置",
              "example": "无",
              "children": [
                {
                  "name": "ImageResponseType",
                  "type": "integer",
                  "required": false,
                  "description": "0:图片以链接形式返回 1:返回图片中提取的文本内容",
                  "example": "1"
                }
              ]
            },
            {
              "name": "FileStartPageNumber",
              "type": "integer",
              "required": false,
              "description": "文档的起始页码",
              "example": "1"
            },
            {
              "name": "FileEndPageNumber",
              "type": "integer",
              "required": false,
              "description": "文档的结束页码",
              "example": "1"
            }
          ]
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "模型名称，doc-llm。",
          "example": "doc-llm"
        }
      ],
      "required": [
        "Document",
        "ModelName"
      ]
    },
    {
      "name": "ParseDocumentAsync",
      "description": "本服务可将各类格式文档精准转换为标准格式，满足企业知识库建设、技术文档迁移、内容平台结构化存储等需求。 本接口为异步接口，有模型维度调用上限控制，单个模型qps限制5，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "Document",
          "type": "object",
          "required": true,
          "description": "文件信息。",
          "example": "无",
          "children": [
            {
              "name": "FileType",
              "type": "string",
              "required": true,
              "description": "支持的文件类型：PDF、DOC、DOCX、PPT、PPTX、MD、TXT、XLS、 XLSX、CSV、PNG、JPG、JPEG、BMP、GIF、WEBP、HEIC、EPS、ICNS、 IM、PCX、PPM、TIFF、XBM、HEIF、JP2 文档解析支持的文件大小： -PDF、DOC、DOCX、PPT、PPTX支持100M -MD、TXT、XLS、XLSX、CSV支特10M -其他支持20M 文本切片支持的文件大小： -PDF最大300M -D0CX、D0C、PPT、PPTX最大200M -TXT、MD最大10M -其他最大20M",
              "example": "DOC"
            },
            {
              "name": "FileUrl",
              "type": "string",
              "required": false,
              "description": "文件存储于腾讯云的 URL 可保障更高的下载速度和稳定性，使用腾讯云COS 文件地址。",
              "example": "https://example.com/example.pdf"
            },
            {
              "name": "FileContent",
              "type": "string",
              "required": false,
              "description": "文件的 base64 值，携带 MineType前缀信息。编码后的后的文件不超过 10M。 支持的文件大小：所下载文件经Base64编码后不超过 8M。文件下载时间不超过3秒。 支持的图片像素：单边介于20-10000px之间。",
              "example": "data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="
            },
            {
              "name": "FileName",
              "type": "string",
              "required": false,
              "description": "文件名称，当使用 base64上传的时候使用。",
              "example": "example.txt"
            },
            {
              "name": "FileStartPageNumber",
              "type": "integer",
              "required": false,
              "description": "文档的起始页码",
              "example": "1"
            },
            {
              "name": "FileEndPageNumber",
              "type": "integer",
              "required": false,
              "description": "文档的结束页码",
              "example": "1"
            }
          ]
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "模型名称，可选模型列表：doc-llm。",
          "example": "doc-llm"
        }
      ],
      "required": [
        "Document",
        "ModelName"
      ]
    },
    {
      "name": "RunRerank",
      "description": "重排是指在 RAG 过程中，通过评估文档与查询之间的相关性，将最相关的文档放在前面，确保语言模型在生成回答时优先考虑排名靠前的上下文，提高生成结果的准确性和可信度，也可以通过这种方式进行过滤，减少大模型成本。 本接口有单账号调用上限控制，如您有提高并发限制的需求请[联系我们](https://cloud.tencent.com/act/event/Online_service) 。",
      "status": "online",
      "parameters": [
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "模型名称，可选模型列表：bge-reranker-large，bge-reranker-v2-m3。",
          "example": "bge-reranker-large"
        },
        {
          "name": "Query",
          "type": "string",
          "required": true,
          "description": "查询文本。",
          "example": "今天天气怎样"
        },
        {
          "name": "Documents",
          "type": "array",
          "required": true,
          "description": "待排序的候选doc列表。",
          "example": "[\"今天是晴天\"]",
          "item_type": "string"
        },
        {
          "name": "TopN",
          "type": "integer",
          "required": false,
          "description": "排序返回的top文档数量, 如果没有指定则返回全部候选doc，如果指定的top_n值大于输入的候选doc数量，返回全部doc。",
          "example": "5"
        },
        {
          "name": "ReturnDocuments",
          "type": "boolean",
          "required": false,
          "description": "返回的排序结果列表里面是否返回每一条document原文，默认值False。",
          "example": "true"
        }
      ],
      "required": [
        "ModelName",
        "Query",
        "Documents"
      ]
    }
  ]
}