Azure OpenAI 서비스 REST API 참조

아티클
07/17/2024

이 문서에서는 Azure OpenAI에 대한 유추 REST API 엔드포인트에 대한 세부 정보를 제공합니다.

API 사양

Azure OpenAI 모델 및 리소스 관리 및 상호 작용은 다음 세 가지 기본 API 표면으로 나뉩니다.

제어 평면
데이터 평면 - 작성
데이터 평면 - 유추

각 API 표면/사양은 다른 Azure OpenAI 기능 집합을 캡슐화합니다. 각 API에는 고유한 미리 보기 집합과 안정적인/일반 공급(GA) API 릴리스가 있습니다. 현재 미리 보기 릴리스는 월별 주기를 따르는 경향이 있습니다.

API	최신 미리 보기 릴리스	최신 GA 릴리스	사양	설명
제어 평면	`2024-04-01-preview`	`2023-05-01`	사양 파일	Azure OpenAI는 다른 모든 Azure AI 서비스와 공통 컨트롤 플레인을 공유합니다. 컨트롤 플레인 API는 Azure OpenAI 리소스 만들기, 모델 배포 및 기타 상위 수준 리소스 관리 작업과 같은 사용됩니다. 또한 컨트롤 플레인은 Azure Resource Manager, Bicep, Terraform 및 Azure CLI와 같은 기능으로 수행할 수 있는 작업을 제어합니다.
데이터 평면 - 작성	`2024-05-01-preview`	`2024-06-01`	사양 파일	데이터 평면 작성 API는 미세 조정, 파일 업로드, 수집 작업 및 특정 모델 수준 쿼리를 제어합니다.
데이터 평면 - 유추	`2024-05-01-preview`	`2024-06-01`	사양 파일	데이터 평면 유추 API는 완성, 채팅 완성, 포함, 음성/위스퍼, 데이터, Dall-e, 도우미 등과 같은 기능에 대한 유추 기능/엔드포인트를 제공합니다.

인증

Azure OpenAI는 두 가지 인증 방법을 제공합니다. API 키 또는 Microsoft Entra ID를 사용할 수 있습니다.

API 키 인증: 이 인증 형식의 경우 모든 API 요청은 api-key HTTP 헤더에 API 키를 포함해야 합니다. 빠른 시작은 이러한 형식의 인증으로 전화를 거는 방법에 대한 지침을 제공합니다.
Microsoft Entra ID 인증: Microsoft Entra 토큰을 사용하여 API 호출을 인증할 수 있습니다. 인증 토큰은 요청에 Authorization 헤더로 포함됩니다. 제공된 토큰은 Bearer가 앞에 와야 합니다(예: Bearer YOUR_AUTH_TOKEN). Microsoft Entra ID로 인증하는 방법 가이드를 읽을 수 있습니다.

REST API 버전 관리

서비스 API는 api-version 쿼리 매개 변수를 사용하여 버전이 지정됩니다. 모든 버전은 YYYY-MM-DD 날짜 구조를 따릅니다. 예시:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2024-06-01

데이터 평면 유추

이 문서의 나머지 부분에는 Azure OpenAI 데이터 평면 유추 사양의 최신 GA 릴리스를 설명합니다2024-06-01.

최신 미리 보기 API 릴리스에 대한 설명서를 찾고 있는 경우 최신 미리 보기 데이터 평면 유추 API를 참조하세요.

완성

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-06-01

제공된 프롬프트, 매개 변수 및 선택한 모델에 대한 완성을 만듭니다.

URI 매개 변수

이름	그런 다음	필수	Type	설명
endpoint	경로	예	string URL	지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: `https://aoairesource.openai.azure.com`. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com
deployment-id	경로	예	string	배포된 모델의 배포 ID
api-version	query	예	string	API 버전

요청 헤더

이름	필수	Type	설명
api-key	True	string	여기에서 Azure OpenAI API 키 제공

요청 본문

Content-Type: application/json

속성	형식	설명	필수 항목	기본값
prompt	문자열 또는 배열	문자열 또는 문자열 배열로 인코딩된 완성을 생성하라는 프롬프트입니다. <\|endoftext\|> 학습 중에 모델이 보는 문서 구분 기호이므로 프롬프트가 지정되지 않은 경우 모델은 새 문서의 시작 부분에서처럼 생성됩니다. 문자열 목록의 최대 허용 크기는 2048입니다.	아니요
max_tokens	정수	프롬프트의 토큰 수와 max_tokens는 모델의 컨텍스트 길이를 초과할 수 없습니다. 대부분의 모델에는 컨텍스트 길이가 2048인 토큰이 있습니다(4096을 지원하는 최신 모델 제외). 최소 0입니다.	아니요	16
온도	number	사용할 샘플링 온도입니다. 값이 높을수록 모델이 더 많은 위험을 감수하게 됩니다. 더 창의적인 애플리케이션은 0.9, 잘 정의된 답변이 있는 애플리케이션의 경우 0(최대 샘플링 인수)을 사용해 보세요. 일반적으로 이를 변경하거나 top_p를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다.	아니요	1
top_p	번호	모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다.	아니요	1
logit_bias	개체	기본값은 Null입니다. 완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(GPT 토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 json 개체를 허용합니다. 이 토크나이저 도구(GPT-2 및 GPT-3 모두에서 작동)를 사용하여 텍스트를 토큰 ID로 변환할 수 있습니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다. 예를 들어 {"50256": -100}을 전달하여 <\|endoftext\|> 토큰이 생성되지 않도록 할 수 있습니다.	아니요
user	string	최종 사용자를 나타내는 고유 식별자로, 남용을 모니터링하고 감지하는 데 도움이 됩니다.	아니요
n	정수	각 프롬프트에 대해 생성할 완료 수입니다. 최소 1개 및 최대 128개 허용 참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 소모할 수 있습니다. 신중하게 사용하고 max_tokens 및 중지에 대한 적절한 설정이 있는지 확인합니다.	아니요	1
stream	부울 값	부분 진행률을 다시 스트리밍할지 여부를 나타냅니다. 설정된 경우 토큰은 데이터 전용 서버 전송 이벤트로 전송되며 스트림은 data: [DONE] 메시지로 종료됩니다.	아니요	False
로그 문제	정수	가장 가능성이 높은 토큰과 선택한 토큰에 대한 로그 확률을 포함합니다. 예를 들어 logprobs가 10이면 API는 가장 가능성이 높은 토큰 10개의 목록을 반환합니다. API는 항상 샘플링된 토큰의 logprob를 반환하므로 응답에 최대 logprobs+1 요소가 있을 수 있습니다. 최소 0개 및 최대 5개 허용	아니요	None
접미사	string	삽입된 텍스트가 완료된 뒤에 오는 접미사입니다.	아니요
echo	부울 값	완료와 함께 프롬프트를 다시 에코합니다.	아니요	False
stop	문자열 또는 배열	API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 반환된 텍스트에는 중지 시퀀스가 포함되지 않습니다.	아니요
completion_config	string		아니요
presence_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다.	아니요	0
frequency_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다.	아니요	0
best_of	정수	best_of 완성 서버 쪽을 생성하고 "최적"(토큰당 로그 확률이 가장 높은 것으로 정의됨)을 반환합니다. 결과를 스트리밍할 수 없습니다. n과 함께 사용하면 best_of는 후보 완료 횟수를 제어하고 n은 반환할 횟수를 지정합니다. best_of는 n보다 커야 합니다. 참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 소모할 수 있습니다. 신중하게 사용하고 max_tokens 및 중지에 대한 적절한 설정이 있는지 확인합니다. 최대값은 128입니다.	아니요

응답

이름	형식	설명	필수 항목
id	string		예
개체	string		예
created	정수		예
model	string		예
prompt_filter_results	promptFilterResults	요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다.	아니요
선택	배열		예
사용량	개체		아니요

사용 속성

completion_tokens

속성	형식	설명	기본값
completion_tokens	number
prompt_tokens	number
total_tokens	number

상태 코드: 200

설명: 확인

Content-Type	Type	설명
application/json	개체

상태 코드: 기본값

설명: 서비스를 사용할 수 없음

Content-Type	Type	설명
application/json	errorResponse

예제

예시

제공된 프롬프트, 매개 변수 및 선택한 모델에 대한 완성을 만듭니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-06-01

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

응답: 상태 코드: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

포함

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-06-01

기계 학습 모델 및 알고리즘에서 쉽게 사용할 수 있는 지정된 입력의 벡터 표현을 가져옵니다.

URI 매개 변수

이름	그런 다음	필수	Type	설명
endpoint	경로	예	string URL	지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: `https://aoairesource.openai.azure.com`. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com
deployment-id	경로	예	string
api-version	query	예	string	API 버전

요청 헤더

이름	필수	Type	설명
api-key	True	string	여기에서 Azure OpenAI API 키 제공

요청 본문

Content-Type: application/json

속성	형식	설명	필수 항목
input	문자열 또는 배열	포함을 가져올 텍스트를 문자열로 인코딩하여 입력합니다. 단일 요청에서 여러 입력에 대한 포함을 얻으려면 문자열 배열을 전달합니다. 각 입력은 길이가 2048 토큰을 초과할 수 없습니다. 코드를 포함하지 않는 한 입력에서 줄 바꿈(\n)을 단일 공백으로 바꾸는 것이 좋습니다. 줄 바꿈이 있을 때 열등한 결과가 관찰되었기 때문입니다.	예
user	string	남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.	아니요
input_type	string	사용할 포함 검색의 입력 형식	아니요
encoding_format	string	포함을 반환할 형식입니다. `float` 또는 `base64` 중 하나일 수 있습니다. 기본값은 `float`입니다.	아니요
dimensions	정수	결과 출력 포함에 있어야 하는 차원의 수입니다. `text-embedding-3` 이상 모델에서만 지원됩니다.	아니요

응답

이름	형식	필수 항목
개체	string	예
model	string	예
데이터	배열	예
사용량	개체	예

사용 속성

prompt_tokens

속성	형식	설명	기본값
prompt_tokens	정수

total_tokens

속성	형식	설명	기본값
total_tokens	정수

상태 코드: 200

설명: 확인

Content-Type	Type	설명
application/json	개체

예제

예시

지정된 프롬프트에 대한 포함을 반환합니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-06-01

{
 "input": [
  "this is a test"
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

채팅 완료

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

채팅 메시지에 대한 완료를 만듭니다.

URI 매개 변수

이름	그런 다음	필수	Type	설명
endpoint	경로	예	string URL	지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: `https://aoairesource.openai.azure.com`. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com
deployment-id	경로	예	string	배포된 모델의 배포 ID
api-version	query	예	string	API 버전

요청 헤더

이름	필수	Type	설명
api-key	True	string	여기에서 Azure OpenAI API 키 제공

요청 본문

Content-Type: application/json

속성	형식	설명	필수 항목	기본값
온도	번호	사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 `top_p`을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다.	아니요	1
top_p	번호	모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 `temperature`을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다.	아니요	1
stream	부울 값	설정되면 ChatGPT의 경우처럼 부분 메시지 델타가 전송됩니다. 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트로 전송되고 스트림은 `data: [DONE]` 메시지로 종료됩니다.	아니요	False
stop	문자열 또는 배열	API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다.	아니요
max_tokens	정수	생성된 답변에 허용되는 최대 토큰 수입니다. 기본적으로 모델이 반환할 수 있는 토큰 수는 (4096 - 프롬프트 토큰)입니다.	아니요	4096
presence_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다.	아니요	0
frequency_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다.	아니요	0
logit_bias	개체	완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 json 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다.	아니요
user	string	Azure OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.	아니요
messages	배열	지금까지의 대화를 구성하는 메시지 목록입니다. Python 코드예제입니다.	아니요
data_sources	배열	이를 사용하는 Azure OpenAI 채팅 확장에 대한 구성 항목입니다. 이 추가 사양은 Azure OpenAI와만 호환됩니다.	아니요
n	정수	각 입력 메시지에 대해 생성할 채팅 완료 선택 항목 수입니다.	아니요	1
seed	정수	지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 `seed` 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다. 결정성은 보장되지 않으며 `system_fingerprint` 응답 매개 변수를 참조하여 백 엔드의 변경 내용을 모니터링해야 합니다.	아니요	0
로그 문제	부울 값	출력 토큰의 로그 확률을 반환할지 여부를 나타냅니다. true인 경우 `message`의 `content`에 반환된 각 출력 토큰의 로그 확률을 반환합니다. 이 옵션은 현재 `gpt-4-vision-preview` 모델에서는 사용할 수 없습니다.	아니요	False
top_logprobs	정수	각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 5 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 이 매개 변수를 사용하는 경우 `logprobs`를 `true`로 설정해야 합니다.	아니요
response_format	개체	모델이 출력해야 하는 형식을 지정하는 개체입니다. JSON 모드를 사용하도록 설정하는 데 사용됩니다.	아니요
tools	배열	모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공하려면 이를 사용합니다.	아니요
tool_choice	chatCompletionToolChoiceOption	모델에서 호출되는 함수(해당하는 경우)를 제어합니다. `none`은 모델이 함수를 호출하지 않고 대신 메시지를 생성함을 의미합니다. `auto`는 모델이 메시지 생성 또는 함수 호출 중에서 선택할 수 있음을 의미합니다. `{"type": "function", "function": {"name": "my_function"}}`을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.	아니요
functions	배열	`tools`을(를) 위해 사용되지 않습니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록입니다.	아니요
function_call	문자열 또는 개체	`tool_choice`을(를) 위해 사용되지 않습니다. 모델이 함수 호출에 응답하는 방식을 제어합니다. "없음"은 모델이 함수를 호출하지 않고 최종 사용자에게 응답함을 의미합니다. "자동"은 모델이 최종 사용자와 함수 호출 중에서 선택할 수 있음을 의미합니다. `{"name":\ "my_function"}`을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다. 기능이 없을 경우 "none"이 기본값입니다. 기능이 있는 경우 "auto"가 기본값입니다.	아니요

response_format 속성

Type

속성	형식	설명	기본값
type	chatCompletionResponseFormat	JSON 모드를 `json_object` 사용하도록 설정 이렇게 하면 모델이 생성하는 메시지가 유효한 JSON이 됩니다.	text

응답

상태 코드: 200

설명: 확인

Content-Type	Type	설명
application/json	createChatCompletionResponse

상태 코드: 기본값

설명: 서비스를 사용할 수 없음

Content-Type	Type	설명
application/json	errorResponse

예제

예시

제공된 프롬프트, 매개 변수 및 선택한 모델에 대한 완성을 만듭니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "system",
   "content": "you're a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

예시

Azure Search 데이터 및 시스템 할당 관리 ID를 기반으로 완성을 만듭니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

예시

Azure Search 벡터 데이터, 이전 도우미 메시지 및 사용자 할당 관리 ID를 기반으로 완성을 만듭니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "you're an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

예시

제공된 Azure Cosmos DB에 대한 완성을 만듭니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-06-01

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

응답: 상태 코드: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

전사

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-06-01

오디오를 입력 언어로 전사합니다.

URI 매개 변수

이름	그런 다음	필수	Type	설명
endpoint	경로	예	string URL	지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: `https://aoairesource.openai.azure.com`. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com
deployment-id	경로	예	string	위스퍼 모델의 배포 ID입니다.
api-version	query	예	string	API 버전

요청 헤더

이름	필수	Type	설명
api-key	True	string	여기에서 Azure OpenAI API 키 제공

요청 본문

콘텐츠 형식: multipart/form-data

속성	형식	설명	필수 항목	기본값
파일	string	기록할 오디오 파일 개체입니다.	예
prompt	string	모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 오디오 언어와 일치해야 합니다.	아니요
response_format	audioResponseFormat	출력의 형식을 정의합니다.	아니요
온도	number	샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다.	아니요	0
language	string	입력 오디오의 언어입니다. ISO-639-1 형식으로 입력 언어를 제공하면 정확도와 대기 시간이 향상됩니다.	아니요

응답

상태 코드: 200

설명: 확인

Content-Type	Type	설명
application/json	audioResponse 또는 audioVerboseResponse
text/plain	string	출력 형식으로 텍스트를 전사했습니다(response_format 텍스트, vtt 또는 srt 중 하나였던 경우).

예제

예시

제공된 음성 오디오 데이터에서 전사된 텍스트 및 관련 메타데이터를 가져옵니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-06-01

응답: 상태 코드: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

예시

제공된 음성 오디오 데이터에서 전사된 텍스트 및 관련 메타데이터를 가져옵니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-06-01

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

응답: 상태 코드: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Translations

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-06-01

입력 오디오를 영어 텍스트로 전사하고 번역합니다.

URI 매개 변수

이름	그런 다음	필수	Type	설명
endpoint	경로	예	string URL	지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: `https://aoairesource.openai.azure.com`. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com
deployment-id	경로	예	string	배포된 위스퍼 모델의 배포 ID입니다.
api-version	query	예	string	API 버전

요청 헤더

이름	필수	Type	설명
api-key	True	string	여기에서 Azure OpenAI API 키 제공

요청 본문

콘텐츠 형식: multipart/form-data

속성	형식	설명	필수 항목	기본값
파일	string	번역할 오디오 파일입니다.	예
prompt	string	모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 영어로 되어 있어야 합니다.	아니요
response_format	audioResponseFormat	출력의 형식을 정의합니다.	아니요
온도	number	샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다.	아니요	0

응답

상태 코드: 200

설명: 확인

Content-Type	Type	설명
application/json	audioResponse 또는 audioVerboseResponse
text/plain	string	출력 형식으로 텍스트를 전사했습니다(response_format 텍스트, vtt 또는 srt 중 하나였던 경우).

예제

예시

제공된 음성 오디오 데이터에서 영어 전사 텍스트 및 관련 메타데이터를 가져옵니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-06-01

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

응답: 상태 코드: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

예시

제공된 음성 오디오 데이터에서 영어 전사 텍스트 및 관련 메타데이터를 가져옵니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-06-01

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

응답: 상태 코드: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

이미지 세대

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-06-01

지정된 DALLE 모델 배포의 텍스트 캡션에서 이미지 일괄 처리를 생성합니다.

URI 매개 변수

이름	그런 다음	필수	Type	설명
endpoint	경로	예	string URL	지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름. 예: `https://aoairesource.openai.azure.com`. "aoairesource"를 Azure OpenAI 리소스 이름으로 바꾸기) https://{your-resource-name}.openai.azure.com
deployment-id	경로	예	string	배포된 `dall-e` 모델의 배포 ID입니다.
api-version	query	예	string	API 버전

요청 헤더

이름	필수	Type	설명
api-key	True	string	여기에서 Azure OpenAI API 키 제공

요청 본문

Content-Type: application/json

속성	형식	설명	필수 항목	기본값
prompt	string	원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 4,000자입니다.	예
n	정수	생성할 이미지 수입니다.	아니요	1
크기	imageSize	생성된 이미지의 크기입니다.	아니요	1024 x 1024
response_format	imagesResponseFormat	생성된 이미지가 반환되는 형식입니다.	아니요	URL
user	string	남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.	아니요
품질	imageQuality	생성될 이미지의 품질입니다.	아니요	표준
style	imageStyle	생성된 이미지의 스타일입니다.	아니요	생생한

응답

상태 코드: 200

설명: 확인

Content-Type	Type	설명
application/json	generateImagesResponse

상태 코드: 기본값

설명: 오류가 발생했습니다.

Content-Type	Type	설명
application/json	dalleErrorResponse

예제

예시

프롬프트가 지정된 이미지를 만듭니다.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-06-01

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

응답: 상태 코드: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

구성 요소

errorResponse

이름	형식	설명	필수 항목	기본값
error	error		아니요

errorBase

속성	형식	설명	필수 항목	기본값
코드	string		아니요
message	string		아니요

Error

속성	형식	설명	필수 항목
param	string		예
type	string		아니요
inner_error	innerError	세부 정보추가 세부 정보가 포함된 내부 오류입니다.	아니요

innerError

세부 정보추가 세부 정보가 포함된 내부 오류입니다.

속성	형식	설명	필수 항목	기본값
코드	innerErrorCode	내부 오류 개체에 대한 오류 코드입니다.	아니요
content_filter_results	contentFilterPromptResults	콘텐츠 필터링 범주(증오, 성적, 폭력, self_harm) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 very_low, 낮음, 중간, 높은 규모)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 검색된 경우 및 필터링되었는지 여부에 대한 정보입니다. 또한 필터링된 고객 차단 목록 및 해당 ID에 대한 정보입니다.	아니요

innerErrorCode

내부 오류 개체에 대한 오류 코드입니다.

설명: 내부 오류 개체에 대한 오류 코드입니다.

형식: string

기본값:

열거형 이름: InnerErrorCode

열거형 값:

값	설명
ResponsibleAIPolicyViolation	프롬프트가 더 많은 콘텐츠 필터 규칙 중 하나를 위반했습니다.

dalleErrorResponse

속성	형식	설명	필수 항목	기본값
error	dalleError		아니요

dalleError

속성	형식	설명	필수 항목
param	string		예
type	string		아니요
inner_error	dalleInnerError	세부 정보추가 세부 정보가 포함된 내부 오류입니다.	아니요

dalleInnerError

세부 정보추가 세부 정보가 포함된 내부 오류입니다.

속성	형식	설명	필수 항목
코드	innerErrorCode	내부 오류 개체에 대한 오류 코드입니다.	아니요
content_filter_results	dalleFilterResults	콘텐츠 필터링 범주(증오, 성적, 폭력, self_harm) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 very_low, 낮음, 중간, 높은 규모)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 검색된 경우 및 필터링되었는지 여부에 대한 정보입니다. 또한 필터링된 고객 차단 목록 및 해당 ID에 대한 정보입니다.	아니요
revised_prompt	string	프롬프트에 수정 버전이 있는 경우 이미지를 생성하는 데 사용된 프롬프트입니다.	아니요

contentFilterResultBase

속성	형식	설명	필수 항목	기본값
filtered	부울 값		예

contentFilterSeverityResult

속성	형식	설명	필수 항목	기본값
filtered	부울 값		예
severity	string		아니요

contentFilterDetectedResult

속성	형식	설명	필수 항목	기본값
filtered	부울 값		예
감지됨	부울 값		아니요

contentFilterDetectedWithCitationResult

속성	형식	설명	필수 항목	기본값
인용	개체		아니요

인용 속성

URL

속성	형식	설명	기본값
URL	string

라이선스

속성	형식	설명	기본값
license	string

contentFilterResultsBase

콘텐츠 필터링 결과에 대한 정보입니다.

속성	형식	필수 항목
성적인	contentFilterSeverityResult	아니요
폭력	contentFilterSeverityResult	아니요
증오	contentFilterSeverityResult	아니요
self_harm	contentFilterSeverityResult	아니요
모독	contentFilterDetectedResult	아니요
error	errorBase	아니요

contentFilterPromptResults

콘텐츠 필터링 범주(증오, 성적, 폭력, self_harm) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 very_low, 낮음, 중간, 높은 규모)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 검색된 경우 및 필터링되었는지 여부에 대한 정보입니다. 또한 필터링된 고객 차단 목록 및 해당 ID에 대한 정보입니다.

속성	형식	필수 항목
성적인	contentFilterSeverityResult	아니요
폭력	contentFilterSeverityResult	아니요
증오	contentFilterSeverityResult	아니요
self_harm	contentFilterSeverityResult	아니요
모독	contentFilterDetectedResult	아니요
error	errorBase	아니요
탈옥	contentFilterDetectedResult	아니요

contentFilterChoiceResults

콘텐츠 필터링 범주(증오, 성적, 폭력, self_harm) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 very_low, 낮음, 중간, 높은 규모)과 필터링되었는지 여부에 대한 정보입니다. 타사 텍스트 및 욕설, 검색된 경우 및 필터링되었는지 여부에 대한 정보입니다. 또한 필터링된 고객 차단 목록 및 해당 ID에 대한 정보입니다.

속성	형식	필수 항목
성적인	contentFilterSeverityResult	아니요
폭력	contentFilterSeverityResult	아니요
증오	contentFilterSeverityResult	아니요
self_harm	contentFilterSeverityResult	아니요
모독	contentFilterDetectedResult	아니요
error	errorBase	아니요
protected_material_text	contentFilterDetectedResult	아니요
protected_material_code	contentFilterDetectedWithCitationResult	아니요

promptFilterResult

요청의 단일 프롬프트에 대한 콘텐츠 필터링 결과입니다.

속성	형식	설명	필수 항목	기본값
prompt_index	정수		아니요
content_filter_results	contentFilterPromptResults	콘텐츠 필터링 범주(증오, 성적, 폭력, self_harm) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 very_low, 낮음, 중간, 높은 규모)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 검색된 경우 및 필터링되었는지 여부에 대한 정보입니다. 또한 필터링된 고객 차단 목록 및 해당 ID에 대한 정보입니다.	아니요

promptFilterResults

요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다.

dalleContentFilterResults

콘텐츠 필터링 결과에 대한 정보입니다.

속성	형식	필수 항목
성적인	contentFilterSeverityResult	아니요
폭력	contentFilterSeverityResult	아니요
증오	contentFilterSeverityResult	아니요
self_harm	contentFilterSeverityResult	아니요

dalleFilterResults

속성	형식	필수 항목
성적인	contentFilterSeverityResult	아니요
폭력	contentFilterSeverityResult	아니요
증오	contentFilterSeverityResult	아니요
self_harm	contentFilterSeverityResult	아니요
모독	contentFilterDetectedResult	아니요
탈옥	contentFilterDetectedResult	아니요

chatCompletionsRequestCommon

속성	형식	설명	필수 항목	기본값
온도	번호	사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 `top_p`을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다.	아니요	1
top_p	번호	모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 `temperature`을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다.	아니요	1
stream	부울 값	설정되면 ChatGPT의 경우처럼 부분 메시지 델타가 전송됩니다. 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트로 전송되고 스트림은 `data: [DONE]` 메시지로 종료됩니다.	아니요	False
stop	문자열 또는 배열	API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다.	아니요
max_tokens	정수	생성된 답변에 허용되는 최대 토큰 수입니다. 기본적으로 모델이 반환할 수 있는 토큰 수는 (4096 - 프롬프트 토큰)입니다.	아니요	4096
presence_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다.	아니요	0
frequency_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다.	아니요	0
logit_bias	개체	완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 json 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다.	아니요
user	string	Azure OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.	아니요

createChatCompletionRequest

속성	형식	설명	필수 항목	기본값
온도	번호	사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 일반적으로 이를 변경하거나 `top_p`을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다.	아니요	1
top_p	번호	모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 `temperature`을(를) 변경하는 것이 좋지만 둘 다 변경하지는 않는 것이 좋습니다.	아니요	1
stream	부울 값	설정되면 ChatGPT의 경우처럼 부분 메시지 델타가 전송됩니다. 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트로 전송되고 스트림은 `data: [DONE]` 메시지로 종료됩니다.	아니요	False
stop	문자열 또는 배열	API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다.	아니요
max_tokens	정수	생성된 답변에 허용되는 최대 토큰 수입니다. 기본적으로 모델이 반환할 수 있는 토큰 수는 (4096 - 프롬프트 토큰)입니다.	아니요	4096
presence_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트에 나타나는지 여부에 따라 새 토큰에 페널티를 부여하여 모델이 새 항목에 대해 이야기할 가능성을 높입니다.	아니요	0
frequency_penalty	number	-2.0~2.0 사이의 숫자 양수 값은 지금까지 텍스트의 기존 빈도를 기반으로 새 토큰에 불이익을 주어 모델이 동일한 줄을 그대로 반복할 가능성을 줄입니다.	아니요	0
logit_bias	개체	완료 시 지정된 토큰이 나타날 가능성을 수정합니다. 토큰(토크나이저에서 토큰 ID로 지정)을 -100에서 100 사이의 관련 바이어스 값에 매핑하는 json 개체를 허용합니다. 수학적으로, 바이어스는 샘플링 전에 모델에 의해 생성된 로짓에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1과 1 사이의 값은 선택 가능성을 줄이거나 높여야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 독점적으로 선택해야 합니다.	아니요
user	string	Azure OpenAI가 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.	아니요
messages	배열	지금까지의 대화를 구성하는 메시지 목록입니다. Python 코드예제입니다.	아니요
data_sources	배열	이를 사용하는 Azure OpenAI 채팅 확장에 대한 구성 항목입니다. 이 추가 사양은 Azure OpenAI와만 호환됩니다.	아니요
n	정수	각 입력 메시지에 대해 생성할 채팅 완료 선택 항목 수입니다.	아니요	1
seed	정수	지정된 경우 시스템은 결정론적으로 샘플링하기 위해 최선을 다하므로 동일한 `seed` 및 매개 변수를 사용하는 반복 요청이 동일한 결과를 반환해야 합니다. 결정성은 보장되지 않으며 `system_fingerprint` 응답 매개 변수를 참조하여 백 엔드의 변경 내용을 모니터링해야 합니다.	아니요	0
로그 문제	부울 값	출력 토큰의 로그 확률을 반환할지 여부를 나타냅니다. true인 경우 `message`의 `content`에 반환된 각 출력 토큰의 로그 확률을 반환합니다. 이 옵션은 현재 `gpt-4-vision-preview` 모델에서는 사용할 수 없습니다.	아니요	False
top_logprobs	정수	각 토큰 위치에서 반환될 가능성이 가장 높은 토큰 수를 지정하는 0에서 5 사이의 정수로, 각 토큰에는 관련 로그 가능성이 있습니다. 이 매개 변수를 사용하는 경우 `logprobs`를 `true`로 설정해야 합니다.	아니요
response_format	개체	모델이 출력해야 하는 형식을 지정하는 개체입니다. JSON 모드를 사용하도록 설정하는 데 사용됩니다.	아니요
tools	배열	모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공하려면 이를 사용합니다.	아니요
tool_choice	chatCompletionToolChoiceOption	모델에서 호출되는 함수(해당하는 경우)를 제어합니다. `none`은 모델이 함수를 호출하지 않고 대신 메시지를 생성함을 의미합니다. `auto`는 모델이 메시지 생성 또는 함수 호출 중에서 선택할 수 있음을 의미합니다. `{"type": "function", "function": {"name": "my_function"}}`을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.	아니요
functions	배열	`tools`을(를) 위해 사용되지 않습니다. 모델이 JSON 입력을 생성할 수 있는 함수 목록입니다.	아니요
function_call	문자열 또는 개체	`tool_choice`을(를) 위해 사용되지 않습니다. 모델이 함수 호출에 응답하는 방식을 제어합니다. "없음"은 모델이 함수를 호출하지 않고 최종 사용자에게 응답함을 의미합니다. "자동"은 모델이 최종 사용자와 함수 호출 중에서 선택할 수 있음을 의미합니다. `{"name":\ "my_function"}`을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다. 기능이 없을 경우 "none"이 기본값입니다. 기능이 있는 경우 "auto"가 기본값입니다.	아니요

response_format 속성

Type

속성	형식	설명	기본값
type	chatCompletionResponseFormat	JSON 모드를 `json_object` 사용하도록 설정 이렇게 하면 모델이 생성하는 메시지가 유효한 JSON이 됩니다.	text

chatCompletionResponseFormat

JSON 모드를 json_object 사용하도록 설정 이렇게 하면 모델이 생성하는 메시지가 유효한 JSON이 됩니다.

설명: JSON 모드를 json_object 사용하도록 설정 이렇게 하면 모델이 생성하는 메시지가 유효한 JSON이 됩니다.

형식: string

기본: 텍스트

열거형 이름: ChatCompletionResponseFormat

열거형 값:

값	설명
text	응답 형식은 일반 텍스트 문자열입니다.
json_object	응답 형식은 JSON 개체입니다.

chatCompletionFunction

속성	형식	설명	필수 항목
name	string	호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다.	예
설명	string	함수의 기능에 대한 설명입니다.	아니요
매개 변수	chatCompletionFunctionParameters	함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 형식에 대한 설명서는 JSON 스키마 참조를 확인하세요.	아니요

chatCompletionFunctionParameters

함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 형식에 대한 설명서는 JSON 스키마 참조를 확인하세요.

chatCompletionRequestMessage

속성	형식	설명	필수 항목	기본값
역할(role)	chatCompletionRequestMessageRole	메시지 작성자의 역할입니다.	예

chatCompletionRequestMessageRole

메시지 작성자의 역할입니다.

설명: 메시지 작성자의 역할입니다.

형식: string

기본값:

열거형 이름: ChatCompletionRequestMessageRole

열거형 값:

값	설명
시스템	메시지 작성자 역할은 시스템입니다.
user	메시지 작성자 역할은 사용자입니다.
도우미	메시지 작성자 역할은 도우미입니다.
tool	메시지 작성자 역할은 도구입니다.
function	사용되지 않음. 메시지 작성자 역할은 함수입니다.

chatCompletionRequestMessageSystem

속성	형식	설명	필수 항목	기본값
역할(role)	chatCompletionRequestMessageRole	메시지 작성자의 역할입니다.	예
content	string	메시지의 내용입니다.	아니요

chatCompletionRequestMessageUser

속성	형식	설명	필수 항목	기본값
역할(role)	chatCompletionRequestMessageRole	메시지 작성자의 역할입니다.	예
content	문자열 또는 배열		아니요

chatCompletionRequestMessageContentPart

속성	형식	설명	필수 항목	기본값
type	chatCompletionRequestMessageContentPartType	콘텐츠 부분의 형식입니다.	예

chatCompletionRequestMessageContentPartType

콘텐츠 부분의 형식입니다.

설명: 콘텐츠 파트의 형식입니다.

형식: string

기본값:

열거형 이름: ChatCompletionRequestMessageContentPartType

열거형 값:

값	설명
text	콘텐츠 파트 형식은 텍스트입니다.
image_url	콘텐츠 파트 형식이 image_url.

chatCompletionRequestMessageContentPartText

속성	형식	설명	필수 항목	기본값
type	chatCompletionRequestMessageContentPartType	콘텐츠 부분의 형식입니다.	예
text	string	텍스트 내용입니다.	아니요

chatCompletionRequestMessageContentPartImage

속성	형식	설명	필수 항목	기본값
type	chatCompletionRequestMessageContentPartType	콘텐츠 부분의 형식입니다.	예
url	string	이미지의 URL 또는 base64로 인코딩된 이미지 데이터입니다.	아니요
detail	imageDetailLevel	이미지의 세부 수준을 지정합니다.	아니요	auto

imageDetailLevel

이미지의 세부 수준을 지정합니다.

설명: 이미지의 세부 수준을 지정합니다.

형식: string

기본: auto

열거형 이름: ImageDetailLevel

열거형 값:

값	설명
auto	이미지 세부 수준은 자동입니다.
낮음	이미지 세부 수준이 낮습니다.
높음	이미지 세부 수준이 높습니다.

chatCompletionRequestMessageAssistant

속성	형식	설명	필수 항목
역할(role)	chatCompletionRequestMessageRole	메시지 작성자의 역할입니다.	예
content	string	메시지의 내용입니다.	아니요
tool_calls	배열	함수 호출과 같이 모델에서 생성된 도구 호출입니다.	아니요
context	azureChatExtensionsMessageContext	Azure OpenAI 채팅 확장이 관련될 때 사용할 수 있는 추가 컨텍스트 정보의 표현 은 해당 채팅 완료 응답을 생성합니다. 이 컨텍스트 정보는 다음 경우에만 채워집니다. 일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용합니다.	아니요

azureChatExtensionConfiguration

단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 채팅 완료 요청에 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.

속성	형식	설명	필수 항목	기본값
type	azureChatExtensionType	단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. 채팅에서 사용됩니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 완료 요청입니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.	예

azureChatExtensionType

설명: 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. 채팅에서 사용됩니다.
Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 완료 요청입니다.
이 구성의 사용은 Azure OpenAI와만 호환됩니다.

형식: string

기본값:

열거형 이름: AzureChatExtensionType

열거형 값:

값	설명
azure_search	Azure Search를 Azure OpenAI 채팅 확장으로 사용하는 것을 나타냅니다.
azure_cosmos_db	Azure Cosmos DB를 Azure OpenAI 채팅 확장으로 사용하는 것을 나타냅니다.

azureSearchChatExtensionConfiguration

Azure OpenAI 채팅 확장으로 사용할 때 Azure Search에 대한 구성 가능한 옵션의 특정 표현입니다.

속성	형식	설명	필수 항목	기본값
type	azureChatExtensionType	단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. 채팅에서 사용됩니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 완료 요청입니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.	예
매개 변수	azureSearchChatExtensionParameters	Azure OpenAI 채팅 확장으로 사용되는 경우 Azure Search에 대한 매개 변수입니다.	아니요

azureSearchChatExtensionParameters

Azure OpenAI 채팅 확장으로 사용되는 경우 Azure Search에 대한 매개 변수입니다.

속성	형식	설명	필수 항목
authentication	onYourDataApiKeyAuthenticationOptions 또는 onYourDataSystemAssignedManagedIdentityAuthenticationOptions 또는 onYourDataUserAssignedManagedIdentityAuthenticationOptions		예
top_n_documents	정수	구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다.	아니요
in_scope	부울 값	쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다.	아니요
엄격성	정수	검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다.	아니요
role_information	string	응답을 생성할 때 참조해야 하는 컨텍스트와 작동 방식에 대한 지침을 모델에 제공합니다. 도우미의 성격을 설명하고 응답 형식을 지정하는 방법을 알려줄 수 있습니다. 토큰 제한은 100개이며 전체 토큰 제한에 대해 계산됩니다.	아니요
endpoint	string	사용할 Azure Search 리소스의 절대 엔드포인트 경로입니다.	예
index_name	string	참조된 Azure Search 리소스에서 사용할 수 있는 인덱스의 이름입니다.	예
fields_mapping	azureSearchIndexFieldMappingOptions	구성된 Azure Search 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.	아니요
query_type	azureSearchQueryType	Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Azure Search 검색 쿼리의 유형입니다.	아니요
semantic_configuration	string	쿼리에 대한 추가 의미 체계 구성입니다.	아니요
필터	string	검색 필터입니다.	아니요
embedding_dependency	onYourDataEndpointVectorizationSource 또는 onYourDataDeploymentNameVectorizationSource		아니요

azureSearchIndexFieldMappingOptions

구성된 Azure Search 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.

속성	형식	설명	필수 항목
title_field	string	제목으로 사용할 인덱스 필드의 이름입니다.	아니요
url_field	string	URL로 사용할 인덱스 필드의 이름입니다.	아니요
filepath_field	string	파일 경로로 사용할 인덱스 필드의 이름입니다.	아니요
content_fields	배열	콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다.	아니요
content_fields_separator	string	콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다.	아니요
vector_fields	배열	벡터 데이터를 나타내는 필드의 이름입니다.	아니요

azureSearchQueryType

Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Azure Search 검색 쿼리의 유형입니다.

설명: Azure OpenAI 채팅 확장으로 사용할 때 실행해야 하는 Azure Search 검색 쿼리의 유형입니다.

형식: string

기본값:

Enum Name: azureSearchQueryType

열거형 값:

값	설명
간단한	기본 단순 쿼리 파서를 나타냅니다.
의미 체계	고급 의미 체계 모델링을 위한 의미 체계 쿼리 파서를 나타냅니다.
벡터	계산된 데이터에 대한 벡터 검색을 나타냅니다.
vector_simple_hybrid	벡터 데이터와 간단한 쿼리 전략의 조합을 나타냅니다.
vector_semantic_hybrid	의미 체계 검색 및 벡터 데이터 쿼리의 조합을 나타냅니다.

azureCosmosDBChatExtensionConfiguration

Azure OpenAI 채팅 확장으로 사용할 때 Azure Cosmos DB에 대한 구성 가능한 옵션의 특정 표현입니다.

속성	형식	설명	필수 항목	기본값
type	azureChatExtensionType	단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. 채팅에서 사용됩니다. Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 완료 요청입니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.	예
매개 변수	azureCosmosDBChatExtensionParameters	Azure Cosmos DB를 사용할 때 데이터 채팅 확장에서 Azure OpenAI를 구성할 때 사용할 매개 변수 MongoDB vCore.	아니요

azureCosmosDBChatExtensionParameters

Azure Cosmos DB for MongoDB vCore를 사용할 때 데이터 채팅 확장에서 Azure OpenAI를 구성할 때 사용할 매개 변수입니다.

속성	형식	설명	필수 항목
authentication	onYourDataConnectionStringAuthenticationOptions	연결 문자열을 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.	예
top_n_documents	정수	구성된 쿼리에 대해 기능할 구성된 상위 문서 수입니다.	아니요
in_scope	부울 값	쿼리를 인덱싱된 데이터 사용으로 제한해야 하는지 여부입니다.	아니요
엄격성	정수	검색 관련성 필터링의 구성된 엄격성입니다. 엄격성이 높을수록 정밀도가 높지만 대답의 재현율이 낮습니다.	아니요
role_information	string	응답을 생성할 때 참조해야 하는 컨텍스트와 작동 방식에 대한 지침을 모델에 제공합니다. 도우미의 성격을 설명하고 응답 형식을 지정하는 방법을 알려줄 수 있습니다. 토큰 제한은 100개이며 전체 토큰 제한에 대해 계산됩니다.	아니요
database_name	string	Azure Cosmos DB와 함께 사용할 MongoDB vCore 데이터베이스 이름입니다.	예
container_name	string	Azure Cosmos DB 리소스 컨테이너의 이름입니다.	예
index_name	string	Azure Cosmos DB와 함께 사용할 MongoDB vCore 인덱스 이름입니다.	예
fields_mapping	azureCosmosDBFieldMappingOptions	구성된 Azure Cosmos DB 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.	예
embedding_dependency	onYourDataEndpointVectorizationSource 또는 onYourDataDeploymentNameVectorizationSource		예

azureCosmosDBFieldMappingOptions

구성된 Azure Cosmos DB 리소스를 사용할 때 필드가 처리되는 방식을 제어하는 선택적 설정입니다.

속성	형식	설명	필수 항목
title_field	string	제목으로 사용할 인덱스 필드의 이름입니다.	아니요
url_field	string	URL로 사용할 인덱스 필드의 이름입니다.	아니요
filepath_field	string	파일 경로로 사용할 인덱스 필드의 이름입니다.	아니요
content_fields	배열	콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다.	예
content_fields_separator	string	콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다.	아니요
vector_fields	배열	벡터 데이터를 나타내는 필드의 이름입니다.	예

onYourDataAuthenticationOptions

Azure OpenAI On Your Data에 대한 인증 옵션입니다.

속성	형식	설명	필수 항목	기본값
type	onYourDataAuthenticationType	Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.	예

onYourDataAuthenticationType

Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.

설명: Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.

형식: string

기본값:

열거형 이름: OnYourDataAuthenticationType

열거형 값:

값	설명
api_key	API 키를 통한 인증.
connection_string	연결 문자열을 통한 인증.
system_assigned_managed_identity	시스템 할당 관리 ID를 통한 인증
user_assigned_managed_identity	사용자 할당 관리 ID를 통한 인증.

onYourDataApiKeyAuthenticationOptions

API 키를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.

속성	형식	설명	필수 항목	기본값
type	onYourDataAuthenticationType	Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.	예
key	string	인증에 사용할 API 키입니다.	아니요

onYourDataConnectionStringAuthenticationOptions

연결 문자열을 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.

속성	형식	설명	필수 항목	기본값
type	onYourDataAuthenticationType	Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.	예
connection_string	string	인증에 사용할 연결 문자열입니다.	아니요

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

시스템 할당 관리 ID를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.

속성	형식	설명	필수 항목	기본값
type	onYourDataAuthenticationType	Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.	예

onYourDataUserAssignedManagedIdentityAuthenticationOptions

사용자 할당 관리 ID를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.

속성	형식	설명	필수 항목	기본값
type	onYourDataAuthenticationType	Azure OpenAI On Your Data에서 지원되는 인증 유형입니다.	예
managed_identity_resource_id	string	인증 시 이용할 사용자가 할당한 관리 ID의 리소스 ID입니다.	아니요

onYourDataVectorizationSource

벡터 검색을 사용하여 Azure OpenAI On Your Data에 대한 벡터화 원본의 추상 표현입니다.

속성	형식	설명	필수 항목	기본값
type	onYourDataVectorizationSourceType	Azure OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. 벡터 검색	예

onYourDataVectorizationSourceType

Azure OpenAI On Your Data에서 벡터 검색에 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다.

설명: Azure OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다.
벡터 검색입니다.

형식: string

기본값:

열거형 이름: OnYourDataVectorizationSourceType

열거형 값:

값	설명
endpoint	Azure OpenAI 포함 모델에 대한 공용 서비스 호출에 의해 수행되는 벡터화를 나타냅니다.
deployment_name	사용할 Ada 모델 배포 이름을 나타냅니다. 이 모델 배포는 동일한 Azure OpenAI 리소스에 있어야 하지만 데이터에서 기능은 공개 호출이 아닌 내부 호출을 통해 이 모델 배포를 사용하므로 벡터를 사용할 수 있습니다. 개인 네트워크에서도 검색합니다.

onYourDataDeploymentNameVectorizationSource

벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하는 벡터화 원본의 세부 정보는 동일한 Azure OpenAI 리소스의 내부 포함 모델 배포 이름을 기반으로 합니다.

속성	형식	설명	필수 항목	기본값
type	onYourDataVectorizationSourceType	Azure OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. 벡터 검색	예
deployment_name	string	벡터화에 사용할 모델 배포의 이름을 지정합니다. 이 모델 배포는 동일한 Azure OpenAI 리소스에 있어야 하지만 On Your Data는 공용이 아닌 내부 호출을 통해 이 모델 배포를 사용하므로 프라이빗 네트워크에서도 벡터를 검색할 수 있습니다.	아니요

onYourDataEndpointVectorizationSource

Azure OpenAI에 대한 공용 포함 엔드포인트를 기반으로 하는 벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하는 벡터화 원본의 세부 정보입니다.

속성	형식	설명	필수 항목
type	onYourDataVectorizationSourceType	Azure OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 원본을 나타냅니다. 벡터 검색	예
authentication	onYourDataApiKeyAuthenticationOptions	API 키를 사용하는 경우 Azure OpenAI On Your Data에 대한 인증 옵션입니다.	아니요
endpoint	string	벡터화에 사용할 엔드포인트를 지정합니다. 이 엔드포인트는 동일한 Azure OpenAI 리소스에 있어야 하지만 On Your Data는 공용이 아닌 내부 호출을 통해 이 엔드포인트를 사용하므로 프라이빗 네트워크에서도 벡터 검색이 가능합니다.	아니요

azureChatExtensionsMessageContext

Azure OpenAI 채팅 확장 프로그램이 해당 채팅 완료 응답 생성에 관련될 때 사용할 수 있는 추가 컨텍스트 정보의 표현입니다. 이 컨텍스트 정보는 일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용하는 경우에만 채워집니다.

속성	형식	설명	필수 항목	기본값
인용	배열	응답에서 도우미 메시지를 생성하는 데 사용되는 데이터 원본 검색 결과입니다.	아니요
의도	string	컨텍스트를 수행하기 위해 다음 턴으로 전달하는 데 사용되는 채팅 기록에서 검색된 의도입니다.	아니요

인용

채팅 완료 응답 메시지에 대한 인용 정보입니다.

속성	형식	설명	필수 항목
content	string	인용의 내용입니다.	예
title	string	인용의 제목입니다.	아니요
url	string	인용의 URL입니다.	아니요
filepath	string	인용의 파일 경로입니다.	아니요
chunk_id	string	인용의 청크 ID입니다.	아니요

chatCompletionMessageToolCall

속성	형식	설명	필수 항목
id	string	도구 호출의 ID입니다.	예
type	toolCallType	이 경우 `function`도구 호출의 형식입니다.	예
function	개체	모델이 호출한 함수입니다.	예

함수의 속성

속성

속성	형식	설명	기본값
name	string	호출할 함수의 이름입니다.

인수

속성	형식	설명	기본값
arguments	string	JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 조작할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요.

toolCallType

이 경우 function도구 호출의 형식입니다.

설명: 이 경우 function도구 호출의 형식입니다.

형식: string

기본값:

열거형 이름: ToolCallType

열거형 값:

값	설명
function	도구 호출 유형이 함수입니다.

chatCompletionRequestMessageTool

속성	형식	설명	필수 항목
역할(role)	chatCompletionRequestMessageRole	메시지 작성자의 역할입니다.	예
tool_call_id	string	이 메시지가 응답하는 도구 호출입니다.	아니요
content	string	메시지의 내용입니다.	아니요

chatCompletionRequestMessageFunction

속성	형식	설명	필수 항목
역할(role)	enum	이 경우 `function`메시지 작성자의 역할입니다. 가능한 값: 함수	예
이름	string	메시지의 내용입니다.	아니요
content	string	메시지의 내용입니다.	아니요

createChatCompletionResponse

속성	형식	설명	필수 항목
id	string	채팅 완료를 위한 고유 식별자입니다.	예
개체	chatCompletionResponseObject	개체 유형입니다.	예
created	정수	채팅 완료가 만들어진 시점의 Unix 타임스탬프(초)입니다.	예
model	string	채팅 완료에 사용되는 모델입니다.	예
사용량	completionUsage	완료 요청의 사용 통계입니다.	아니요
system_fingerprint	string	결정론에 영향을 미칠 수 있는 백 엔드 변경이 이루어진 시기를 이해하기 위해 `seed` 요청 매개 변수와 함께 사용할 수 있습니다.	아니요
prompt_filter_results	promptFilterResults	요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다.	아니요
선택	배열		아니요

chatCompletionChoiceLogProbs

선택에 대한 확률 정보를 기록합니다.

속성	형식	설명	필수 항목	기본값
content	배열	로그 확률 정보가 포함된 메시지 콘텐츠 토큰 목록입니다.	예

chatCompletionTokenLogprob

속성	형식	설명	필수 항목
token	string	토큰입니다.	예
logprob	number	이 토큰의 로그 확률입니다.	예
bytes	배열	토큰의 UTF-8바이트 표현을 나타내는 정수 목록입니다. 문자가 여러 토큰으로 표현되고 해당 바이트 표현이 결합되어 올바른 텍스트 표현을 생성해야 하는 경우에 유용합니다. 토큰에 대한 바이트 표현이 없는 경우일 `null` 수 있습니다.	예
top_logprobs	배열	이 토큰 위치에 있는 가장 가능성이 높은 토큰 및 해당 로그 확률의 목록입니다. 드문 경우지만 반환된 요청 `top_logprobs` 수보다 적을 수 있습니다.	예

chatCompletionResponseMessage

모델에 의해 생성된 채팅 완료 메시지입니다.

속성	형식	설명	필수 항목
역할(role)	chatCompletionResponseMessageRole	응답 메시지 작성자의 역할입니다.	아니요
content	string	메시지의 내용입니다.	아니요
tool_calls	배열	함수 호출과 같이 모델에서 생성된 도구 호출입니다.	아니요
function_call	chatCompletionFunctionCall	사용되지 않으며 .으로 대체되었습니다 `tool_calls`. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다.	아니요
context	azureChatExtensionsMessageContext	Azure OpenAI 채팅 확장이 관련될 때 사용할 수 있는 추가 컨텍스트 정보의 표현 은 해당 채팅 완료 응답을 생성합니다. 이 컨텍스트 정보는 다음 경우에만 채워집니다. 일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용합니다.	아니요

chatCompletionResponseMessageRole

응답 메시지 작성자의 역할입니다.

설명: 응답 메시지 작성자의 역할입니다.

형식: string

기본값:

열거형 값:

도우미

chatCompletionToolChoiceOption

모델에서 호출되는 함수(해당하는 경우)를 제어합니다. none은 모델이 함수를 호출하지 않고 대신 메시지를 생성함을 의미합니다. auto는 모델이 메시지 생성 또는 함수 호출 중에서 선택할 수 있음을 의미합니다. {"type": "function", "function": {"name": "my_function"}}을 통해 특정 함수를 지정하면 모델이 해당 함수를 호출하게 됩니다.

이 구성 요소는 다음 중 하나일 수 있습니다.

chatCompletionNamedToolChoice

모델에서 사용해야 하는 도구를 지정합니다. 모델이 특정 함수를 호출하도록 강제하는 데 사용합니다.

속성	형식	설명	필수 항목	기본값
type	enum	도구의 형식입니다. 현재는 `function`만 지원됩니다. 가능한 값: 함수	아니요
function	개체		아니요

함수의 속성

속성

속성	형식	설명	기본값
name	string	호출할 함수의 이름입니다.

chatCompletionFunctionCall

사용되지 않으며 .으로 대체되었습니다 tool_calls. 모델에 의해 생성된 대로 호출되어야 하는 함수의 이름과 인수입니다.

속성	형식	설명	필수 항목	기본값
name	string	호출할 함수의 이름입니다.	예
arguments	string	JSON 형식의 모델에 의해 생성된 함수 호출에 사용할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 조작할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사하세요.	예

chatCompletionsResponseCommon

속성	형식	설명	필수 항목
id	string	채팅 완료를 위한 고유 식별자입니다.	예
개체	chatCompletionResponseObject	개체 유형입니다.	예
created	정수	채팅 완료가 만들어진 시점의 Unix 타임스탬프(초)입니다.	예
model	string	채팅 완료에 사용되는 모델입니다.	예
사용량	completionUsage	완료 요청의 사용 통계입니다.	아니요
system_fingerprint	string	결정론에 영향을 미칠 수 있는 백 엔드 변경이 이루어진 시기를 이해하기 위해 `seed` 요청 매개 변수와 함께 사용할 수 있습니다.	아니요

chatCompletionResponseObject

개체 유형입니다.

설명: 개체 형식입니다.

형식: string

기본값:

열거형 이름: ChatCompletionResponseObject

열거형 값:

값	설명
chat.completion	개체 유형이 채팅 완료입니다.

completionUsage

완료 요청의 사용 통계입니다.

속성	형식	설명	필수 항목
prompt_tokens	정수	프롬프트에 있는 토큰 수입니다.	예
completion_tokens	정수	생성된 완료의 토큰 수입니다.	예
total_tokens	정수	요청(프롬프트 + 완료)에 사용된 총 토큰 수입니다.	예

chatCompletionTool

속성	형식	설명	필수 항목	기본값
type	chatCompletionToolType	도구의 형식입니다. 현재는 `function`만 지원됩니다.	예
function	개체		예

함수의 속성

설명

이름	형식	설명	기본값
description	string	함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다.

속성

속성	형식	설명	기본값
name	string	호출할 함수의 이름입니다. a~z, A~Z, 0~9 또는 밑줄과 대시를 포함해야 하며 최대 길이는 64자여야 합니다.

매개 변수

이름	형식	설명	기본값
매개 변수	chatCompletionFunctionParameters	함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 형식에 대한 설명서는 JSON 스키마 참조를 확인하세요.

chatCompletionToolType

도구의 형식입니다. 현재는 function만 지원됩니다.

설명: 도구의 형식입니다. 현재는 function만 지원됩니다.

형식: string

기본값:

Enum Name: ChatCompletionToolType

열거형 값:

값	설명
function	도구 유형이 함수입니다.

chatCompletionChoiceCommon

속성	형식	설명	필수 항목	기본값
색인	정수		아니요
finish_reason	string		아니요

createTranslationRequest

번역 요청입니다.

속성	형식	설명	필수 항목	기본값
파일	string	번역할 오디오 파일입니다.	예
prompt	string	모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 영어로 되어 있어야 합니다.	아니요
response_format	audioResponseFormat	출력의 형식을 정의합니다.	아니요
온도	number	샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다.	아니요	0

audioResponse

response_format json일 때 번역 또는 전사 응답

속성	형식	설명	필수 항목	기본값
text	string	번역되거나 전사된 텍스트입니다.	예

audioVerboseResponse

response_format verbose_json 때 번역 또는 전사 응답

속성	형식	설명	필수 항목
text	string	번역되거나 전사된 텍스트입니다.	예
task	string	오디오 작업의 유형입니다.	아니요
language	string	언어.	아니요
duration	number	기간.	아니요
세그먼트	배열		아니요

audioResponseFormat

출력의 형식을 정의합니다.

설명: 출력의 형식을 정의합니다.

형식: string

기본값:

열거형 값:

json
text
srt
verbose_json
vtt

createTranscriptionRequest

전사 요청입니다.

속성	형식	설명	필수 항목	기본값
파일	string	기록할 오디오 파일 개체입니다.	예
prompt	string	모델 스타일을 안내하거나 이전 오디오 세그먼트를 계속 진행하기 위한 선택적 텍스트입니다. 프롬프트는 오디오 언어와 일치해야 합니다.	아니요
response_format	audioResponseFormat	출력의 형식을 정의합니다.	아니요
온도	number	샘플링 온도(0에서 1 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 값이 낮을수록 출력이 더욱 집중되고 결정적이게 됩니다. 0으로 설정하면 모델은 로그 확률을 사용하여 특정 임계값에 도달할 때까지 온도를 자동으로 높입니다.	아니요	0
language	string	입력 오디오의 언어입니다. ISO-639-1 형식으로 입력 언어를 제공하면 정확도와 대기 시간이 향상됩니다.	아니요

audioSegment

전사 또는 번역 세그먼트입니다.

속성	형식	설명	필수 항목
id	정수	세그먼트 식별자입니다.	아니요
Seek	number	세그먼트의 오프셋입니다.	아니요
start	number	세그먼트 시작 오프셋입니다.	아니요
end	number	세그먼트 끝 오프셋입니다.	아니요
text	string	텍스트를 구분합니다.	아니요
토큰	배열	텍스트의 토큰입니다.	아니요
온도	number	온도.	아니요
avg_logprob	number	평균 로그 확률입니다.	아니요
compression_ratio	number	압축 비율입니다.	아니요
no_speech_prob	number	'음성 없음'의 확률입니다.	아니요

imageQuality

생성될 이미지의 품질입니다.

설명: 생성될 이미지의 품질입니다.

형식: string

기본: 표준

열거형 이름: 품질

열거형 값:

값	설명
표준	표준 품질은 표준 품질로 이미지를 만듭니다.
hd	HD 품질은 이미지 전체에서 세부 정보 및 더 높은 일관성을 가진 이미지를 만듭니다.

imagesResponseFormat

생성된 이미지가 반환되는 형식입니다.

설명: 생성된 이미지가 반환되는 형식입니다.

형식: string

기본: url

열거형 이름: ImagesResponseFormat

열거형 값:

값	설명
URL	생성된 이미지를 다운로드하기 위한 임시 액세스를 제공하는 URL입니다.
b64_json	생성된 이미지는 base64로 인코딩된 문자열로 반환됩니다.

imageSize

생성된 이미지의 크기입니다.

설명: 생성된 이미지의 크기입니다.

형식: string

기본값: 1024x1024

열거형 이름: 크기

열거형 값:

값	설명
1792x1024	생성된 이미지의 원하는 크기는 1792x1024 픽셀입니다.
1024x1792	생성된 이미지의 원하는 크기는 1024x1792픽셀입니다.
1024 x 1024	생성된 이미지의 원하는 크기는 1024x1024픽셀입니다.

imageStyle

생성된 이미지의 스타일입니다.

설명: 생성된 이미지의 스타일입니다.

형식: string

기본값: 생생함

열거형 이름: 스타일

열거형 값:

값	설명
생생한	생생하게는 매우 현실적이고 극적인 이미지를 만듭니다.
자연의	자연은 더 자연스럽고 덜 사실적인 이미지를 만듭니다.

imageGenerationsRequest

속성	형식	설명	필수 항목	기본값
prompt	string	원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 4,000자입니다.	예
n	정수	생성할 이미지 수입니다.	아니요	1
크기	imageSize	생성된 이미지의 크기입니다.	아니요	1024 x 1024
response_format	imagesResponseFormat	생성된 이미지가 반환되는 형식입니다.	아니요	URL
user	string	남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.	아니요
품질	imageQuality	생성될 이미지의 품질입니다.	아니요	표준
style	imageStyle	생성된 이미지의 스타일입니다.	아니요	생생한

generateImagesResponse

속성	형식	설명	필수 항목	기본값
created	정수	작업을 만들 때의 unix 타임스탬프입니다.	예
데이터	배열	성공한 경우 작업의 결과 데이터입니다.	예

imageResult

성공하면 이미지 URL 또는 인코딩된 이미지이고, 그렇지 않으면 오류가 발생합니다.

속성	형식	설명	필수 항목
url	string	이미지 URL입니다.	아니요
b64_json	string	base64로 인코딩된 이미지	아니요
content_filter_results	dalleContentFilterResults	콘텐츠 필터링 결과에 대한 정보입니다.	아니요
revised_prompt	string	프롬프트에 수정 버전이 있는 경우 이미지를 생성하는 데 사용된 프롬프트입니다.	아니요
prompt_filter_results	dalleFilterResults	콘텐츠 필터링 범주(증오, 성적, 폭력, self_harm) 및 심각도 수준(유해한 콘텐츠의 강도 및 위험 수준을 결정하는 very_low, 낮음, 중간, 높은 규모)과 필터링되었는지 여부에 대한 정보입니다. 탈옥 콘텐츠 및 욕설, 검색된 경우 및 필터링되었는지 여부에 대한 정보입니다. 또한 필터링된 고객 차단 목록 및 해당 ID에 대한 정보입니다.	아니요

완료 확장

완성 확장은 Azure OpenAI 데이터 평면 유추 사양의 최신 GA 버전에 속하지 않습니다.

Chatmessage

채팅 메시지 개체는 Azure OpenAI 데이터 평면 유추 사양의 최신 GA 버전에 속하지 않습니다.

텍스트 음성 변환

현재 Azure OpenAI 데이터 평면 유추 사양의 최신 Azure OpenAI GA 버전에 속하지 않습니다. 이 기능에 대한 최신 미리 보기 버전을 참조하세요.

다음 단계

모델 및 REST API를 사용한 미세 조정에 대해 알아보세요. Azure OpenAI를 지원하는 기본 모델에 대해 자세히 알아봅니다.

다음을 통해 공유

Azure OpenAI 서비스 REST API 참조

API 사양

인증

REST API 버전 관리

데이터 평면 유추

완성

URI 매개 변수

요청 헤더

요청 본문

응답

사용 속성

completion_tokens

예제

예시

포함

URI 매개 변수

요청 헤더

요청 본문

응답

사용 속성

prompt_tokens

total_tokens

예제

예시

채팅 완료

URI 매개 변수

요청 헤더

요청 본문

response_format 속성

Type

응답

예제

예시

예시

예시

예시

전사

URI 매개 변수

요청 헤더

요청 본문

응답

예제

예시

예시

Translations

URI 매개 변수

요청 헤더

요청 본문

응답

예제

예시

예시

이미지 세대

URI 매개 변수

요청 헤더

요청 본문

응답

예제

예시

구성 요소

errorResponse

errorBase

Error

innerError

innerErrorCode

dalleErrorResponse

dalleError

dalleInnerError

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

인용 속성

URL

라이선스

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult