MENU
      임베딩
        • PDF

        임베딩

        • PDF

        기사 요약

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

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

        요청

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

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

        요청 헤더

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

        필드필수 여부설명
        AuthorizationRequired인증을 위한 API 키 <예시> Bearer nv-************
        X-NCP-CLOVASTUDIO-REQUEST-IDOptional요청 ID
        Content-TypeRequired요청 데이터의 형식
        • application/json

        요청 경로 파라미터

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

        필드타입필수 여부설명
        modelNameEnumRequired임베딩 수행 모델
        • clir-emb-dolphin | clir-sts-dolphin
          • clir-emb-dolphin: 모든 도메인에 적용 가능한 높은 범용성을 가진 모델 (기본값)
          • clir-sts-dolphin: 문장의 의미를 정밀하게 측정하는 데 특화된 모델

        요청 바디

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

        필드타입필수 여부설명
        textStringRequired임베딩 수행 텍스트(토큰)
        • 1~500

        요청 예시

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

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

        응답

        응답 형식을 설명합니다.

        응답 바디

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

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

        응답 예시

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

        성공

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

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

        실패

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


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

        What's Next
        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.