Embedding
- Print
- PDF
Embedding
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
Perform vectorization tasks to represent text as numbers.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| POST | /v1/api-tools/embedding/{modelName} |
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
Authorization | Required | API key for authentication <e.g.,> Bearer nv-************ |
X-NCP-CLOVASTUDIO-REQUEST-ID | Optional | Request ID |
Content-Type | Required | Request data format
|
Request path parameters
You can use the following path parameters with your request:
| Field | Type | Required | Description |
|---|---|---|---|
modelName | Enum | Required | Model for performing embedding
|
Request body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
text | String | Required | Text (tokens) to perform embedding
|
Request example
The request example is as follows:
curl --location --request POST 'https://clovastudio.stream.ntruss.com/testapp/v1/api-tools/embedding/{modelName}' \
--header 'Authorization: Bearer {API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
"text": "How's the weather today?"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
embedding | Array | - | Embedding performance results
|
inputTokens | Integer | - | Number of tokens in the text performing embedding |
Response example
The response example is as follows:
Succeeded
The following is a sample response upon a successful call.
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"embedding": [ -0.3861295, -0.7903874, ... , 0.2994273, -0.7736456, -0.24933687 ]
"inputTokens": 4
}
}
Failure
The following is a sample response upon a failed call.
Was this article helpful?