UniAPI API Doc

向量接口

POST

/v1/embeddings

Embeddings

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

input

必需

要嵌入的输入文本，编码为字符串或标记数组。要在单个请求中嵌入多个输入，请传递字符串数组或标记数组。输入不得超过模型的最大输入标记数（text-embedding-ada-002为8192个标记），不能为空字符串，且任何数组的维度不得超过2048。计数标记的示例Python代码。某些模型还可能对输入总标记数施加限制。

One of

string

array

将被转换为嵌入的字符串。

默认值:

示例值:

The quick brown fox jumped over the lazy dogThis is a test.

model

必需

要使用的型号的ID。您可以使用列表模型 API查看所有可用的模型

Any of

string

示例值:

text-embedding-3-small

encoding_format

enum<string>

可选

返回嵌入的格式。可以是 float 或 base64。

枚举值:

floatbase64

默认值:

float

示例值:

float

dimensions

integer

可选

生成的输出嵌入应具有的维度数。仅支持 text-embedding-3 及更高版本的模型。

>= 1

user

string

可选

表示您的终端用户的唯一标识符，有助于 OpenAI 监控和检测滥用行为。了解更多。

示例值:

user-1234

示例

{
    "input": "",
    "model": "string",
    "encoding_format": "float",
    "dimensions": 1,
    "user": "user-1234"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.uniapi.io/v1/embeddings' \
--header 'Content-Type: application/json' \
--data-raw '{
    "input": "",
    "model": "string",
    "encoding_format": "float",
    "dimensions": 1,
    "user": "user-1234"
}'

返回响应

🟢200成功

application/json

Body

data

array[object (Embedding) {3}]

必需

由模型生成的嵌入列表。

index

integer

必需

嵌入在嵌入列表中的索引。

embedding

array[number]

必需

嵌入向量，是一个浮点数列表。向量的长度取决于模型

object

enum<string>

必需

对象类型，始终为“embedding”。

枚举值:

embedding

model

string

必需

用于生成嵌入的模型名称。

object

enum<string>

必需

对象类型，始终为 "list"。

枚举值:

list

usage

object

请求的使用信息。

必需

prompt_tokens

integer

必需

提示中使用的标记数量。

total_tokens

integer

必需

请求使用的令牌总数。

示例

{
    "data": [
        {
            "index": 0,
            "embedding": [
                0
            ],
            "object": "embedding"
        }
    ],
    "model": "string",
    "object": "list",
    "usage": {
        "prompt_tokens": 0,
        "total_tokens": 0
    }
}

修改于 2025-05-18 07:36:21

自动补全

图像编辑