Domain name for API request: mps.intl.tencentcloudapi.com.
Model embedding API
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: EmbeddingData. |
| Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Model | Yes | String | Embedding model; currently only supports text_embedding_v1 Enumeration values:
|
| Files.N | Yes | Array of EmbeddingData | Embedding input |
| Prompt | No | String | Prompt for embedding input |
| Parameter Name | Type | Description |
|---|---|---|
| Data | Array of EmbeddingResultItem | Embedding result |
| Usage | TokensUsage | Token usage of the embedding |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
For text embedding
POST / HTTP/1.1
Host: mps.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EmbeddingData
<Common request parameters>
{
"Model": "text_embedding_v1",
"Files": [
{
"Type": "text",
"Data": "The weather is nice today"
}
],
"Prompt": "Instruct: Retrieve semantically similar text.\\nQuery:"
}{
"Response": {
"Data": [
{
"Result": [
-0.0055236816
]
}
],
"Usage": {
"InputTokens": 15,
"TotalTokens": 15
},
"RequestId": "f4de2dd4-bac4-47d8-a983-8ee3ffb92f26"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter.ModelNotSupported | Invalid parameters. The model is not supported. |
| InvalidParameter.Value | JSON parsing failure; Uin / SubAccountUin / Message missing |
文档反馈