文本向量模型(Text Embeddings)API 接口

文本向量模型(Text Embeddings)API 接口

文本向量模型 API 提供将文本转换为向量的能力,支持中英文输入。通过该接口,开发者可以将文本内容转化为向量,以用于进行后续的语义分析、相似度计算、信息检索等任务。

接口地址

POST https://wcode.net/api/gpt/v1/embeddings

此 API 接口兼容 OpenAI 的接口规范,也就是可以直接使用 OpenAI 的 SDK 来调用各个模型。仅需替换以下两项配置:

  1. BASE_URL 替换为 https://wcode.net/api/gpt/v1
  2. API_KEY 替换为从 https://wcode.net/get-apikey 获取到的 API KEY

即可开始使用 OpenAI SDK 调用 通义千问系列豆包系列混元系列DeepSeek系列......等各个模型。

请求方法

POST

快速开始(请求示例)

(注:以下请求示例中的 API_KEY 需要替换后再发起请求。 获取 API_KEY 入口:https://wcode.net/get-apikey

curl --request POST 'https://wcode.net/api/gpt/v1/embeddings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY' \
--data '{
    "model": "qwen-text-embedding-v3",
    "input": "你好!"
}'

请求头(Request Headers)

Header 备注 示例 相关链接
Authorization Bearer API_KEY 格式:Bearer + 空格 + API_KEY Bearer sk-..... 获取 API_KEY 入口:https://wcode.net/get-apikey
Content-Type application/json 固定为 application/json

请求参数

🚀 model | ✅️必填 | string | 模型ID,可选 model 模型列表(部分):

模型ID 模型名称 每 1000 tokens 费用 更新日期
doubao-embedding-large Doubao-embedding-large 0.0009 2024-09-15
doubao-embedding Doubao-embedding 0.0007 2024-07-15
qwen-text-embedding-v3 通义千问通用文本向量-v3 0.0009 2024-07-12
qwen-text-embedding-v1 通义千问通用文本向量-v1 0.0009 2024-04-09
qwen-text-embedding-v2 通义千问通用文本向量-v2 0.0009 2024-04-09
hunyuan-embedding 腾讯文本向量模型 0.0009 2024-01-05

🚀 input | ✅️必填 | stringarray | 需要向量化的内容,支持中文、英文。示例值:你好!Hello World["苹果", "西瓜"]


🚀 encoding_format | 选填 | string | 默认值:float | 返回的格式,可选值:floatbase64


返回参数

不同模型返回参数可能存在差异,请以实际返回为准。

返回参数 数据类型 说明
object string 固定为 list
data array 模型输出的数据
usage object 请求所消耗的 tokens 数据
usage.prompt_tokens int 输入的 tokens 数量
usage.total_tokens int 请求所消耗的 tokens 的总数量

响应头(Response Headers)

Header 说明 示例 相关链接
X-Account-Balance API_KEY 余额(元) 123.0165 API_KEY 费用充值入口:https://wcode.net/apikey-recharge

Python 代码示例(Requests,qwen-text-embedding-v3)

import requests
import json

url = "https://wcode.net/api/gpt/v1/embeddings"

payload = json.dumps({
    "model": "qwen-text-embedding-v3",
    "input": "你好!"
})

headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer API_KEY'     # TODO: 这里的 API_KEY 需要替换,获取 API_KEY 入口:https://wcode.net/get-apikey
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Java 代码示例(OkHttp,qwen-text-embedding-v3)

OkHttpClient client = new OkHttpClient().newBuilder().build();

MediaType mediaType = MediaType.parse("application/json");

RequestBody body = RequestBody.create(mediaType, "{\"model\": \"qwen-text-embedding-v3\", \"input\": \"你好!\"}");

Request request = new Request.Builder()
  .url("https://wcode.net/api/gpt/v1/embeddings")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer API_KEY")     // TODO: 这里的 API_KEY 需要替换,获取 API_KEY 入口:https://wcode.net/get-apikey
  .build();

Response response = client.newCall(request).execute();

PHP 代码示例(Guzzle,qwen-text-embedding-v3)

<?php

$client = new Client();

$headers = [
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer API_KEY'     // TODO: 这里的 API_KEY 需要替换,获取 API_KEY 入口:https://wcode.net/get-apikey
];

$body = '{
    "model": "qwen-text-embedding-v3",
    "input": "你好!"
}';

$request = new Request('POST', 'https://wcode.net/api/gpt/v1/embeddings', $headers, $body);

$res = $client->sendAsync($request)->wait();

echo $res->getBody();

...其他编程语言可参考下方 curl http 请求示例进行调用

请求示例 1(input 类型为 string,qwen-text-embedding-v3)

curl --request POST 'https://wcode.net/api/gpt/v1/embeddings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY' \
--data '{
    "model": "qwen-text-embedding-v3",
    "input": "你好!"
}'

响应示例 1

{
    "object": "list",
    "data": [
        {
            "object": "embedding",
            "index": 0,
            "embedding": [
                -0.07683156430721283,
                0.03397340700030327,
                -0.09158729761838913,
                -0.06994295120239258,
                -0.02755446918308735,
                ...
            ]
        }
    ],
    "usage": {
        "prompt_tokens": 2,
        "total_tokens": 2
    }
}

请求示例 2(input 类型为 array,qwen-text-embedding-v3)

curl --request POST 'https://wcode.net/api/gpt/v1/embeddings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API_KEY' \
--data '{
    "model": "qwen-text-embedding-v3",
    "input": ["苹果", "西瓜"]
}'

响应示例 2

{
    "object": "list",
    "data": [
        {
            "object": "embedding",
            "index": 0,
            "embedding": [
                -0.07807832211256027,
                0.053077876567840576,
                -0.09807868301868439,
                -0.03788529708981514,
                -0.058193352073431015,
                ...
            ]
        },
        {
            "object": "embedding",
            "index": 1,
            "embedding": [
                -0.05409573018550873,
                0.0688803642988205,
                -0.029378259554505348,
                0.011470510624349117,
                -0.04068640619516373,
                ...
            ]
        }
    ],
    "usage": {
        "prompt_tokens": 3,
        "total_tokens": 3
    }
}

异常响应示例

{
    "status": "failed",
    "error_message": "Incorrect API_KEY provided",
    "error_code": 401,
    "data": null
}