임베딩

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

Classic/VPC 환경에서 이용 가능합니다.

텍스트를 숫자로 표현하는 벡터화 작업을 수행합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/testapp/v1/api-tools/embedding/{modelName}/{appId}

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드	필수 여부	설명
`X-NCP-CLOVASTUDIO-API-KEY`	Required	테스트 앱이나 서비스 앱 생성 시 발급받은 API Key
`X-NCP-APIGW-API-KEY`	Required	테스트 앱이나 서비스 앱 생성 시 발급받은 API Gateway Key
`X-NCP-CLOVASTUDIO-REQUEST-ID`	Optional	요청 ID
`Content-Type`	Required	요청 데이터의 형식 `application/json`

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`modelName`	Enum	Required	임베딩 수행 모델 `clir-emb-dolphin` \| `clir-sts-dolphin` `clir-emb-dolphin`: 모든 도메인에 적용 가능한 높은 범용성을 가진 모델 `clir-sts-dolphin`: 문장의 의미를 정밀하게 측정하는 데 특화된 모델
`appId`	String	Required	테스트 앱 또는 서비스 앱의 아이디

요청 바디

바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`text`	String	Required	임베딩 수행 텍스트(토큰) 1~500

요청 예시

요청 예시는 다음과 같습니다.

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": "오늘 날씨 알려줘"
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`embedding`	Array	-	임베딩 수행 결과 1,024개의 Float 목록으로 구성
`inputTokens`	Integer	-	임베딩 수행 텍스트의 토큰 수

응답 예시

응답 예시는 다음과 같습니다.

성공

호출이 성공한 경우의 응답 예시는 다음과 같습니다.

{
    "status": {
      "code": "20000",
        "message": "OK"
      },
    "result": {
      "embedding": [ -0.3861295, -0.7903874, ... , 0.2994273, -0.7736456, -0.24933687 ]
      "inputTokens": 4
    }
  }

실패

호출이 실패한 경우의 응답 예시는 다음과 같습니다.

이 문서가 도움이 되었습니까?

What's Next

임베딩 v2

요청
응답