Azure OpenAI Embeddings

API 버전: v1

Server:{endpoint}/openai/v1 — Azure AI Foundry Models API

서버 변수:

Variable 기본값 Description
endpoint 프로토콜과 호스트명을 포함한 지원되는 Azure AI Foundry 모델 API 엔드포인트입니다.
다음은 그 예입니다.
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)".

Authentication

ApiKeyAuth (API Key)

헤더에 api-key API 키를 전달하세요.

ApiKeyAuth_ (API 키)

헤더에 authorization API 키를 전달하세요.

OAuth2Auth (OAuth 2.0)

흐름: 암시적

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

범위:

  • https://cognitiveservices.azure.com/.default

보안 요구 사항

엔드포인트는 다음 인증 방법 중 하나를 허용합니다:

  1. ApiKeyAuth
  2. ApiKeyAuth_
  3. OAuth2Auth (범위: https://cognitiveservices.azure.com/.default)

포함 만들기

POST {endpoint}/openai/v1/embeddings

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

URI 매개 변수

이름 In 필수 Type Description
endpoint server Yes string 프로토콜과 호스트명을 포함한 지원되는 Azure AI Foundry 모델 API 엔드포인트입니다.
다음은 그 예입니다.
https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/)".
API 버전 query No string
가능한 값: v1preview		 이 요청에 사용할 명시적 Azure AI Foundry Models API 버전입니다.
v1 그렇지 않으면 지정되지 않은 경우

요청 본문

Content-Type: application/json

이름 Type Description 필수 기본값
치수 integer 결과 출력 포함에 포함해야 하는 차원의 수입니다. 이후 모델에서 text-embedding-3 만 지원됩니다.
제약 조건: 최소: 1		 No
encoding_format enum 포함을 반환할 형식입니다. float 또는 base64 수 있습니다.
가능한 값: floatbase64		 No float
input 문자열 또는 문자열의 배열 또는 정수 배열 또는 배열 배열 토큰의 문자열 또는 배열로 인코딩된 포함할 입력 텍스트입니다. 단일 요청에 여러 입력을 포함하려면 문자열 배열 또는 토큰 배열 배열을 전달합니다. 입력은 모델의 최대 입력 토큰(모든 임베딩 모델에 대해 8192 토큰)을 초과해서는 안 되며, 빈 문자열일 수 없으며, 배열은 2048 차원 이하여야 합니다. 토큰 계산을 위한 Python 코드 예제입니다. 모든 포함 모델은 입력당 토큰 제한 외에도 단일 요청의 모든 입력에 대해 합계가 최대 300,000개인 토큰을 적용합니다. Yes
모델 string 사용할 모델의 ID입니다. List 모델을 사용해 사용 가능한 모든 모델을 볼 수 있으며, 모델 개요를 참고해 모델에 대한 설명을 확인할 수 있습니다. Yes
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

Responses

상태 코드: 200

설명: 요청이 성공했습니다.

콘텐츠-타입 Type 설명
application/json OpenAI.CreateEmbeddingResponse

응답 헤더:

헤더 Type Description
apim-request-id string 문제 해결을 위해 사용되는 요청 ID입니다.

상태 코드: 기본값

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

콘텐츠-타입 Type 설명
application/json object
이름 Type Description 필수 기본값
code 문자열 또는 null Yes
inner_error No
message string Yes
param 문자열 또는 null No
type string No

응답 헤더:

헤더 Type Description
apim-request-id string 문제 해결을 위해 사용되는 요청 ID입니다.

예제

Example

POST {endpoint}/openai/v1/embeddings?api-version=v1

Components

AzureAIFoundryModelsApiVersion

Property Value
Type string
값 v1
preview

OpenAI.CreateEmbeddingRequest

이름 Type Description 필수 기본값
치수 integer 결과 출력 포함에 포함해야 하는 차원의 수입니다. 이후 모델에서 text-embedding-3 만 지원됩니다.
제약 조건: 최소: 1		 No
encoding_format enum 포함을 반환할 형식입니다. float 또는 base64 수 있습니다.
가능한 값: floatbase64		 No float
input 문자열 또는 문자열의 배열 또는 정수 배열 또는 배열 배열 토큰의 문자열 또는 배열로 인코딩된 포함할 입력 텍스트입니다. 단일 요청에 여러 입력을 포함하려면 문자열 배열 또는 토큰 배열 배열을 전달합니다. 입력은 모델의 최대 입력 토큰(모든 임베딩 모델에 대해 8192 토큰)을 초과해서는 안 되며, 빈 문자열일 수 없으며, 배열은 2048 차원 이하여야 합니다. 토큰 계산을 위한 Python 코드 예제입니다. 모든 포함 모델은 입력당 토큰 제한 외에도 단일 요청의 모든 입력에 대해 합계가 최대 300,000개인 토큰을 적용합니다. Yes
모델 string 사용할 모델의 ID입니다. List 모델을 사용해 사용 가능한 모든 모델을 볼 수 있으며, 모델 개요를 참고해 모델에 대한 설명을 확인할 수 있습니다. Yes
user string 최종 사용자를 나타내는 고유 식별자입니다. 이 식별자는 OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있습니다. No

OpenAI.CreateEmbeddingResponse

이름 Type Description 필수 기본값
데이터 OpenAI.Embedding 배열 모델에서 생성된 포함 목록입니다. Yes
모델 string 포함을 생성하는 데 사용되는 모델의 이름입니다. Yes
object enum 항상 "list"인 개체 형식입니다.
가능한 값: list		 Yes
사용량 OpenAI.CreateEmbeddingResponseUsage Yes
└prompt_tokens integer Yes
└total_tokens integer Yes

OpenAI.CreateEmbeddingResponseUsage

이름 Type Description 필수 기본값
prompt_tokens integer Yes
total_tokens integer Yes

OpenAI.Embedding

임베딩 엔드포인트가 반환한 임베딩 벡터를 나타냅니다.

이름 Type Description 필수 기본값
embedding 숫자 배열 부동 소수 자릿수 목록인 포함 벡터입니다. 벡터의 길이는 임베딩 가이드에 명시된 모델에 따라 달라집니다. Yes
index integer 포함 목록에 포함된 인덱스입니다. Yes
object enum 항상 "포함"인 개체 형식입니다.
가능한 값: embedding		 Yes
  • Last updated on