다음을 통해 공유

Get Image Embeddings - Get Image Embeddings

  • 참조
서비스:
AI Foundry
API 버전:
2024-05-01-preview

지정된 이미지에 대한 포함 벡터를 반환합니다. 메서드는 지정된 엔드포인트에서 /images/embeddings 경로에 REST API를 호출합니다.

POST https:///images/embeddings?api-version=2024-05-01-preview

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
api-version
 query True

string

minLength: 1

이 작업에 사용할 API 버전입니다.

요청 헤더

Name 필수 형식 Description
extra-parameters

ExtraParameters

REST API에 의해 정의되지 않은 추가 매개 변수가 JSON 요청 페이로드에 전달되는 경우 발생하는 동작을 제어합니다. 그러면 HTTP 요청 헤더 extra-parameters설정됩니다.

요청 본문

Name 필수 형식 Description
input True

ImageEmbeddingInput[]

포함할 입력 이미지입니다. 단일 요청에 여러 입력을 포함하려면 배열을 전달합니다. 입력이 모델의 최대 입력 토큰을 초과해서는 안 됩니다.
dimensions

integer (int32)

선택적. 결과 출력 포함에 포함해야 하는 차원의 수입니다. null을 전달하면 모델이 기본값을 사용합니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다.
encoding_format

EmbeddingEncodingFormat

선택적. 결과 출력 포함에 포함해야 하는 차원의 수입니다. null을 전달하면 모델이 기본값을 사용합니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다.
input_type

EmbeddingInputType

선택적. 입력의 형식입니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다.
model

string

엔드포인트에서 둘 이상의 모델을 사용할 수 있는 경우 사용할 특정 AI 모델의 ID입니다.

응답

Name 형식 Description
200 OK

EmbeddingsResult

요청이 성공했습니다.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

예기치 않은 오류 응답입니다.

헤더

x-ms-error-code: string

보안

api-key

형식: apiKey
In(다음 안에): header

OAuth2Auth

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

범위

Name Description
https://ml.azure.com/.default

예제

maximum set image embeddings
minimum set image embeddings

maximum set image embeddings

샘플 요청

POST https:///images/embeddings?api-version=2024-05-01-preview


{
  "input": [
    {
      "image": "puqkvvlvgcjyzughesnkena",
      "text": "azrzyjsmnuefqpowpvfmyobeehqsni"
    }
  ],
  "dimensions": 1024,
  "encoding_format": "float",
  "input_type": "text",
  "model": "my-model-name"
}

샘플 응답

상태 코드:
200 
{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

minimum set image embeddings

샘플 요청

POST https:///images/embeddings?api-version=2024-05-01-preview

{
  "input": [
    {
      "image": "gvmojtfooxixxzayrditjlyymg"
    }
  ]
}

샘플 응답

상태 코드:
200 
{
  "id": "cknxthfa",
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

정의

Name Description
Azure.Core.Foundations.Error

오류 개체입니다.
Azure.Core.Foundations.ErrorResponse

오류 세부 정보가 포함된 응답입니다.
Azure.Core.Foundations.InnerError

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EmbeddingEncodingFormat

생성할 포함 형식을 지정합니다. uint8, int8, ubinary 및 binary같은 압축된 포함 형식은 데이터의 무결성을 희생하지 않고 스토리지 비용을 줄일 수 있습니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다. 모델 설명서를 읽고 모델에서 지원하는 값을 알아보세요.
EmbeddingInputType

검색을 포함하는 데 사용되는 입력 형식을 나타냅니다.
EmbeddingItem

단일 포함 관련 비교의 표현입니다.
EmbeddingsResult

포함 요청의 응답 데이터 표현입니다. 포함은 텍스트 문자열의 관련성을 측정하며 검색, 클러스터링, 권장 사항 및 기타 유사한 시나리오에 일반적으로 사용됩니다.
EmbeddingsUsage

이 요청 및 응답에 사용되는 토큰의 양을 측정합니다.
ExtraParameters

REST API에 의해 정의되지 않은 추가 매개 변수가 JSON 요청 페이로드에 전달되는 경우 발생하는 동작을 제어합니다.
ImageEmbeddingInput

선택적 텍스트가 있는 이미지를 나타냅니다.
ImageEmbeddingsOptions

이미지 포함 요청에 대한 구성 정보입니다.

Azure.Core.Foundations.Error

Object

오류 개체입니다.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합 중 하나입니다.
details

Azure.Core.Foundations.Error[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror

Azure.Core.Foundations.InnerError

오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message

string

사람이 읽을 수 있는 오류 표현입니다.
target

string

오류의 대상입니다.

Azure.Core.Foundations.ErrorResponse

Object

오류 세부 정보가 포함된 응답입니다.

Name 형식 Description
error

Azure.Core.Foundations.Error

오류 개체입니다.

Azure.Core.Foundations.InnerError

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name 형식 Description
code

string

서버에서 정의한 오류 코드 집합 중 하나입니다.
innererror

Azure.Core.Foundations.InnerError

내부 오류입니다.

EmbeddingEncodingFormat

열거형

생성할 포함 형식을 지정합니다. uint8, int8, ubinary 및 binary같은 압축된 포함 형식은 데이터의 무결성을 희생하지 않고 스토리지 비용을 줄일 수 있습니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다. 모델 설명서를 읽고 모델에서 지원하는 값을 알아보세요.

값 Description
base64

Base64 문자열로 인코딩된 embeddings의 이진 표현을 다시 가져옵니다. OpenAI Python 라이브러리는 일반적으로 수행되는 것처럼 중간 10진수 표현을 사용하는 대신 API에서 인코딩된 이진 데이터로 포함을 검색합니다.
binary

서명된 이진 포함 가져오기
float

전체 전체 전체 자릿수 포함 가져오기
int8

서명된 int8 embeddings 다시 가져오기
ubinary

서명되지 않은 이진 포함 다시 가져오기
uint8

서명되지 않은 int8 포함 다시 가져오기

EmbeddingInputType

열거형

검색을 포함하는 데 사용되는 입력 형식을 나타냅니다.

값 Description
document

입력이 벡터 데이터베이스에 저장된 문서를 나타냅니다.
query

입력이 벡터 데이터베이스에서 가장 관련성이 큰 문서를 찾기 위한 검색 쿼리를 나타냅니다.
text

입력이 일반 텍스트 입력임을 나타냅니다.

EmbeddingItem

Object

단일 포함 관련 비교의 표현입니다.

Name 형식 Description
embedding

number[] (float)

입력 프롬프트에 대한 포함 값 목록입니다. 제공된 입력의 벡터 기반 관련도 측정값을 나타냅니다. 또는 포함 벡터의 base64로 인코딩된 문자열입니다.
index

integer (int32)

EmbeddingItem이 해당하는 프롬프트의 인덱스입니다.
object enum:

embedding

이 포함 항목의 개체 형식입니다. 항상 embedding.

EmbeddingsResult

Object

포함 요청의 응답 데이터 표현입니다. 포함은 텍스트 문자열의 관련성을 측정하며 검색, 클러스터링, 권장 사항 및 기타 유사한 시나리오에 일반적으로 사용됩니다.

Name 형식 Description
data

EmbeddingItem[]

요청에 제출된 프롬프트에 대한 값을 포함합니다.
id

string

포함 결과에 대한 고유 식별자입니다.
model

string

이 결과를 생성하는 데 사용되는 모델 ID입니다.
object enum:

list

포함 결과의 개체 형식입니다. 항상 list.
usage

EmbeddingsUsage

embeddings API를 사용하는 토큰 입력에 대한 사용 횟수입니다.

EmbeddingsUsage

Object

이 요청 및 응답에 사용되는 토큰의 양을 측정합니다.

Name 형식 Description
prompt_tokens

integer (int32)

요청의 토큰 수입니다.
total_tokens

integer (int32)

이 요청/응답에서 거래된 총 토큰 수입니다. 요청의 토큰 수와 같아야 합니다.

ExtraParameters

열거형

REST API에 의해 정의되지 않은 추가 매개 변수가 JSON 요청 페이로드에 전달되는 경우 발생하는 동작을 제어합니다.

값 Description
drop

서비스는 요청 페이로드에서 추가 매개 변수를 무시(삭제)합니다. 알려진 매개 변수만 백 엔드 AI 모델에 전달합니다.
error

요청 페이로드에서 추가 매개 변수를 검색하면 서비스가 오류 발생합니다. 서비스 기본값입니다.
pass-through

서비스는 백 엔드 AI 모델에 추가 매개 변수를 전달합니다.

ImageEmbeddingInput

Object

선택적 텍스트가 있는 이미지를 나타냅니다.

Name 형식 Description
image

string

base64 문자열로 데이터 URL로 인코딩된 입력 이미지입니다. 예: data:image/{format};base64,{data}.
text

string

선택적. 모델에 공급할 텍스트 입력입니다(예: DINO, CLIP). 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다.

ImageEmbeddingsOptions

Object

이미지 포함 요청에 대한 구성 정보입니다.

Name 형식 Description
dimensions

integer (int32)

선택적. 결과 출력 포함에 포함해야 하는 차원의 수입니다. null을 전달하면 모델이 기본값을 사용합니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다.
encoding_format

EmbeddingEncodingFormat

선택적. 결과 출력 포함에 포함해야 하는 차원의 수입니다. null을 전달하면 모델이 기본값을 사용합니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다.
input

ImageEmbeddingInput[]

포함할 입력 이미지입니다. 단일 요청에 여러 입력을 포함하려면 배열을 전달합니다. 입력이 모델의 최대 입력 토큰을 초과해서는 안 됩니다.
input_type

EmbeddingInputType

선택적. 입력의 형식입니다. 모델이 값이나 매개 변수를 지원하지 않는 경우 422 오류를 반환합니다.
model

string

엔드포인트에서 둘 이상의 모델을 사용할 수 있는 경우 사용할 특정 AI 모델의 ID입니다.