OpenAI兼容文本向量化_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

本文介绍OpenAI兼容文本向量化服务的API参数配置。

URL

{host}/compatible-mode/v1/embeddings

host：调用服务的地址，支持通过公网和VPC两种方式调用API服务，可参见获取服务接入地址。

AI apikey截图.png

请求参数

参数

类型

必填

描述

示例值

model

String

是

指定的服务ID。

系统服务ID：（以ops-开头）

支持的服务ID请参见支持的服务列表。

ops-text-embedding-001

input

Array/String

是

支持多条文本输入，每次请求最多32 条；每条的长度大小取决于选择的模型。不支持空的字符串。

["科学技术是第一生产力"，"opensearch产品文档"]

响应参数

参数	类型	描述	示例值
data	List	返回数据信息。	-
data.embedding	Array[float]	embedding的处理结果，返回向量化的数组。	[ 0.003143, 0.009750, (1536 floats total ops-text-embedding-001), -0.017395 ]
data.index	Int	序号，对应请求input中的下标，从0开始。	0
data.object	String	固定值embedding。	embedding
object	String	回包类型，固定值list。	list
model	String	请求中指定的服务ID。	ops-text-embedding-001
usage	Object	本次模型调用的Token数量统计。	-
usage.prompt_tokens	Int	用户请求大模型输入的内容转换后的Token数量。	5
usage.total_tokens	Int	总Token用量，usage.prompt_tokens与usage.completion_tokens的总和。	5

CURL示例

curl http://xxxx-shanghai.opensearch.aliyuncs.com/compatible-mode/v1/chat/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer 您的API-Key" \
  -d '{
    "model": "ops-text-embedding-001",
    "input": "搜索开发平台"
  }'

响应示例

{
  "id":"9085118afe14bee71d59c4a609fcf7c0",
  "object":"list",
  "data":
    [
        {
          "object":"embedding",
          "embedding":
              [
                  0.0021381378173828125,
                  0.12109375,
                  .......,
                  -0.0389404296875
               ],
             "index":0
            }
       ],
     "model":"ops-text-embedding-001",
     "usage":
         {
            "prompt_tokens":5,
            "total_tokens":5
          }
   }

状态码说明

请参见AI搜索开放平台状态码说明。