推理 API

Embeddings

查看 Markdown

创建嵌入

/v1/embeddings

创建与输入文本对应的 embedding 向量表示。此端点用于向 embedding 模型发起请求。

请求体

响应体

dataarray<object>

embedding 对象列表。

modelstring

创建 embedding 所用的模型 ID。

objectstring

`data` 字段的对象类型,始终为 `"list"`。

Exampletext

text

"{\n            \"input\": [\"This is an example content to embed...\"],\n            \"model\": \"v1\",\n            \"encoding_format\": \"float\"\n        }"
Exampletext

text

{
  "object": "list",
  "model": "v1",
  "data": [
    {
      "index": 0,
      "embedding": [
        0.01567895,
        0.063257694,
        0.045925662
      ],
      "object": "embedding"
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "total_tokens": 1
  }
}

列出 embedding 模型

/v1/embedding-models

列出用于身份验证的 API 密钥可访问的所有 embedding 模型及其完整信息。相比 /v1/models,额外信息包括模态、指纹和别名。

响应体

modelsarray<object>

可用 embedding 模型数组。

Exampletext

text

No parameters.
Exampletext

text

{
  "models": [
    {
      "id": "v1",
      "fingerprint": "fp_df37966059",
      "created": 1725148800,
      "object": "model",
      "owned_by": "xai",
      "version": "0.1.0",
      "input_modalities": [
        "text"
      ],
      "prompt_text_token_price": 100,
      "prompt_image_token_price": 0,
      "aliases": []
    }
  ]
}

获取 embedding 模型

/v1/embedding-models/{model_id}

根据 model_id 获取 embedding 模型的完整信息。

路径参数

model_idstring

要获取的模型 ID。

响应体

aliasesarray<string>

模型的别名 ID,用户可在请求的 model 字段中使用。

createdinteger

模型创建时间,使用 Unix 时间戳。

fingerprintstring

托管该模型的 xAI 系统配置指纹。

input_modalitiesarray<string>

模型支持的输入模态。

objectstring

对象类型,应为 model。

output_modalitiesarray<string>

模型支持的输出模态。

owned_bystring

模型所有者。

prompt_image_token_priceinteger

prompt 图像 token 的价格,单位为美分/百万 token。

prompt_text_token_priceinteger

prompt 文本 token 的价格,单位为美分/百万 token。

versionstring

模型版本。

Exampletext

text

No parameters.
Exampletext

text

{
  "id": "v1",
  "created": 1725148800,
  "object": "model",
  "owned_by": "xai",
  "version": "0.1.0",
  "input_modalities": [
    "text"
  ],
  "prompt_text_token_price": 10,
  "prompt_image_token_price": 0,
  "aliases": []
}