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
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /testapp/v1/api-tools/embedding/{modelName}/{appId} |
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
X-NCP-CLOVASTUDIO-API-KEY | Required | API key issued when creating the test app or service app |
X-NCP-APIGW-API-KEY | Required | API Gateway key issued when creating the test app or service app |
X-NCP-CLOVASTUDIO-REQUEST-ID | Optional | Request ID |
Content-Type | Required | Request data format
|
Request path parameters
The following describes the request path parameters.
| Field | Type | Required | Description |
|---|---|---|---|
modelName | Enum | Required | Model for performing embedding
|
appId | String | Required | ID of the test app or service app |
Request body
The following describes the body.
| Field | Type | Required | Description |
|---|---|---|---|
text | String | Required | Text (tokens) to perform embedding
|
Request example
The following is a sample request.
curl --location --request POST 'https://clovastudio.apigw.ntruss.com/testapp/v1/api-tools/embedding/{modelName}/{appId}' \
--header 'X-NCP-CLOVASTUDIO-API-KEY: {CLOVA Studio API Key}' \
--header 'X-NCP-APIGW-API-KEY: {API Gateway API Key}' \
--header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
--header 'Content-Type: application/json' \
--data '{
"text": "How's the weather today?"
}'
Response
The following describes the response format.
Response body
The following describes the response body.
| Field | Type | Required | Description |
|---|---|---|---|
embedding | Array | - | Embedding performance results
|
inputTokens | Integer | - | Number of tokens in the text performing embedding |
Response example
The following is a sample example.
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?