참조: 이미지 포함 | Azure AI Foundry

아티클
09/03/2024

Important

이 문서에 표시된 항목(미리 보기)은 현재 퍼블릭 미리 보기에서 확인할 수 있습니다. 이 미리 보기는 서비스 수준 계약 없이 제공되며, 프로덕션 워크로드에는 권장되지 않습니다. 특정 기능이 지원되지 않거나 기능이 제한될 수 있습니다. 자세한 내용은 Microsoft Azure Preview에 대한 추가 사용 약관을 참조하세요.

입력 이미지와 텍스트 쌍을 나타내는 포함 벡터를 만듭니다.

POST /images/embeddings?api-version=2024-04-01-preview

URI 매개 변수

이름	그런 다음	필수	Type	설명
api-version	query	True	string	"YYYY-MM-DD" 또는 "YYYY-MM-DD-preview" 형식의 API 버전입니다.

요청 헤더

이름	필수	Type	설명
추가 매개 변수		string	추가 매개 변수가 페이로드에 표시되는 경우 API의 동작입니다. `pass-through`을(를) 사용하면 API가 매개 변수를 기본 모델에 전달합니다. 기본 모델이 지원할 수 있다고 알고 있는 매개 변수를 전달하려면 이 값을 사용하세요. `ignore`을(를) 사용하면 API가 지원되지 않는 매개 변수를 삭제합니다. 서로 다른 모델에서 동일한 페이로드를 사용해야 하지만 지원되지 않는 경우 추가 매개 변수 중 하나가 모델에 오류를 발생시킬 수 있으면 이 값을 사용하세요. `error`을(를) 사용하면 API가 페이로드의 추가 매개 변수를 거부합니다. 이 API에 지정된 매개 변수만 표시될 수 있거나, 400 오류가 반환됩니다.
azureml-model-deployment		string	요청을 라우팅하려는 배포의 이름입니다. 다중 배포를 지원하는 엔드포인트에 지원됩니다.

요청 본문

이름	필수	Type	설명
input	True	EmbeddingInput[]	포함할 이미지를 입력합니다. 단일 요청에 여러 입력을 포함하려면 배열을 전달합니다. 입력은 모델의 최대 입력 토큰을 초과하면 안 됩니다.
dimensions		정수	결과 출력 포함에 있어야 하는 차원의 수입니다. null을 전달하면 모델이 기본값을 사용하게 됩니다. 모델이 값이나 매개 변수를 지원하지 않으면 422 오류를 반환합니다.
encoding_format		EmbeddingEncodingFormat	포함을 반환할 형식입니다. base64, float, int8, uint8, binary 또는 ubinary 중 하나입니다. 모델이 값이나 매개 변수를 지원하지 않으면 422 오류를 반환합니다.

응답

이름	형식	설명
200 OK	CreateEmbeddingResponse	OK
401 권한 없음	UnauthorizedError	액세스 토큰이 누락되었거나 유효하지 않음 헤더 x-ms-error-code: 문자열
404 찾을 수 없음	NotFoundError	모델에서 지원되지 않는 형식입니다. 사용 가능한 경로를 확인하려면 모델 설명서를 확인합니다. 헤더 x-ms-error-code: 문자열
422 처리할 수 없는 엔터티	UnprocessableContentError	요청에 처리할 수 없는 콘텐츠가 포함되어 있습니다. 표시된 페이로드가 이 사양에 따라 유효할 때 오류가 반환됩니다. 하지만 페이로드에 표시된 일부 지침이 기본 모델에서 지원되지 않습니다. `details` 섹션에서 문제가 되는 매개 변수를 파악하세요. 헤더 x-ms-error-code: 문자열
429 요청이 너무 많음	TooManyRequestsError	할당된 속도 제한에 도달했으며 요청을 처리해야 합니다. 헤더 x-ms-error-code: 문자열
기타 상태 코드	ContentFilterError	잘못된 요청 헤더 x-ms-error-code: 문자열

보안

권한 부여

Bearer: 접두사가 있는 토큰입니다. 예: Bearer abcde12345

형식: apiKey
In: 헤더

AADToken

Azure Active Directory OAuth2 인증

형식: oauth2
흐름: 애플리케이션
토큰 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

예제

입력 텍스트와 이미지를 나타내는 포함 벡터를 만듭니다.

샘플 요청

POST /images/embeddings?api-version=2024-04-01-preview

{
  "input": [
    {
      "text": "A nice picture of a cat",
      "image": "data:image/jpeg;base64,iVBORw0KG..."
    }
  ],
  "encoding_format": "float",
  "dimensions": 1024
}

샘플 응답

상태 코드: 200

{
  "data": [
    {
      "index": 0,
      "object": "embedding",
      "embedding": [
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0,
        0
      ]
    }
  ],
  "object": "list",
  "model": "DINO",
  "usage": {
    "prompt_tokens": 15,
    "total_tokens": 15
  }
}

정의

이름	설명
ContentFilterError	프롬프트가 구성된 대로 콘텐츠 필터를 트리거하면 API 호출이 실패합니다. 프롬프트를 수정하고 다시 시도합니다.
CreateEmbeddingResponse
CreateImageEmbeddingRequest
세부 정보
포함	생성된 이미지를 나타냅니다.
EmbeddingEncodingFormat	포함을 반환할 형식입니다. base64, float, int8, uint8, binary 또는 ubinary 중 하나입니다. 모델이 값이나 매개 변수를 지원하지 않으면 422 오류를 반환합니다.
EmbeddingObject	항상 "포함"되는 개체 형식입니다.
EmbeddingInput	선택적 텍스트가 포함된 이미지를 나타냅니다.
ListObject	항상 "목록"인 개체 형식입니다.
NotFoundError
TooManyRequestsError
UnauthorizedError
UnprocessableContentError	요청에 처리할 수 없는 콘텐츠가 포함되어 있습니다. 표시된 페이로드가 이 사양에 따라 유효할 때 오류가 반환됩니다. 하지만 페이로드에 표시된 일부 지침이 기본 모델에서 지원되지 않습니다. `details` 섹션에서 문제가 되는 매개 변수를 파악하세요.
사용법	요청에 대한 사용 정보입니다.

ContentFilterError

프롬프트가 구성된 대로 콘텐츠 필터를 트리거하면 API 호출이 실패합니다. 프롬프트를 수정하고 다시 시도합니다.

속성	형식	설명
코드	string	오류 코드입니다.
error	string	오류 설명입니다.
message	string	오류 메시지입니다.
param	string	콘텐츠 필터를 트리거한 매개 변수입니다.
status	정수	HTTP 상태 코드입니다.

CreateEmbeddingResponse

속성	형식	설명
데이터	Embedding[]	모델에 의해 생성된 포함 목록입니다.
model	string	포함을 생성하는 데 사용된 모델의 이름입니다.
개체	ListObject	항상 "목록"인 개체 형식입니다.
사용량	사용법	요청에 대한 사용 정보입니다.

CreateImageEmbeddingRequest

속성	Type	기본값	설명
dimensions	정수		결과 출력 포함에 있어야 하는 차원의 수입니다. null을 전달하면 모델이 기본값을 사용하게 됩니다. 모델이 값이나 매개 변수를 지원하지 않으면 422 오류를 반환합니다.
encoding_format	EmbeddingEncodingFormat	float	포함을 반환할 형식입니다. base64, float, int8, uint8, binary 또는 ubinary 중 하나입니다. 모델이 값이나 매개 변수를 지원하지 않으면 422 오류를 반환합니다.
input	EmbeddingInput[]		포함할 이미지를 입력합니다. 단일 요청에 여러 입력을 포함하려면 배열을 전달합니다. 입력은 모델의 최대 입력 토큰을 초과하면 안 됩니다.

세부 정보

속성	형식	설명
loc	string[]	문제를 일으키는 매개 변수
value	string	문제를 일으키는 매개 변수에 전달된 값입니다.

포함

생성된 이미지를 나타냅니다.

속성	형식	설명
embedding(포함)	number[]	부동 소수점 목록인 포함 벡터입니다. 벡터의 길이는 사용된 모델에 따라 다릅니다.
인덱스	정수	포함 목록의 포함 인덱스입니다.
개체	EmbeddingObject	항상 "포함"되는 개체 형식입니다.

EmbeddingEncodingFormat

포함을 반환할 형식입니다. base64, float, int8, uint8, binary 또는 ubinary 중 하나입니다. 모델이 값이나 매개 변수를 지원하지 않으면 422 오류를 반환합니다.

속성	형식	설명
base64	string
binary	string
float	string
int8	string
ubinary	string
uint8	string

EmbeddingObject

항상 "포함"되는 개체 형식입니다.

속성	형식	설명
embedding(포함)	string

EmbeddingInput

선택적 텍스트가 포함된 이미지를 나타냅니다.

속성	형식	설명
이미지	string	데이터 URL로서 `base64` 문자열로 인코딩된 입력 이미지. 예: `data:image/{format};base64,{data}`
text	string	선택 사항. 모델에 입력할 텍스트 입력(예: DINO, CLIP). 모델이 값이나 매개 변수를 지원하지 않으면 422 오류를 반환합니다.

ListObject

항상 "목록"인 개체 형식입니다.

속성	형식	Description
list	string

NotFoundError

속성	형식	설명
error	string	오류 설명입니다.
message	string	오류 메시지입니다.
status	정수	HTTP 상태 코드입니다.

TooManyRequestsError

속성	형식	설명
error	string	오류 설명입니다.
message	string	오류 메시지입니다.
status	정수	HTTP 상태 코드입니다.

UnauthorizedError

속성	형식	설명
error	string	오류 설명입니다.
message	string	오류 메시지입니다.
status	정수	HTTP 상태 코드입니다.

UnprocessableContentError

요청에 처리할 수 없는 콘텐츠가 포함되어 있습니다. 표시된 페이로드가 이 사양에 따라 유효할 때 오류가 반환됩니다. 하지만 페이로드에 표시된 일부 지침이 기본 모델에서 지원되지 않습니다. details 섹션을 사용하여 문제가 되는 매개 변수를 파악하세요.

속성	형식	설명
코드	string	오류 코드입니다.
detail	세부 정보
error	string	오류 설명입니다.
message	string	오류 메시지입니다.
status	정수	HTTP 상태 코드입니다.

사용

요청에 대한 사용 정보입니다.

속성	형식	설명
prompt_patches	정수	이미지 프롬프트에서 사용되는 이미지 패치 수입니다.
prompt_tokens	정수	프롬프트에서 사용되는 토큰 수입니다.
total_patches	정수	요청에 사용된 총 패치 수입니다.
total_tokens	정수	요청에 사용된 총 토큰 수입니다.

다음을 통해 공유