Microsoft Foundry Models REST API 참조에서 OpenAI Azure

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

API specs

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

  • Control plane
  • 데이터 평면 - 작성
  • 데이터 평면 - 유추

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

Important

이제 새 미리 보기 유추 API가 있습니다. API 수명 주기 가이드에서 자세히 알아보세요.

API 최신 미리 보기 릴리스 최신 GA 릴리스 Specifications Description
Control plane 2025-07-01-preview 2025-06-01 Spec files 컨트롤 플레인 API는 리소스 만들기, 모델 배포 및 기타 상위 수준 리소스 관리 작업과 같은 작업에 사용됩니다. 또한 컨트롤 플레인은 Azure Resource Manager, Bicep, Terraform 및 Azure CLI 같은 기능으로 수행할 수 있는 작업을 제어합니다.
Data plane v1 preview v1 Spec files 데이터 평면 API는 유추 및 제작 작업을 제어합니다.

Authentication

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

  • API 키 인증: 이러한 유형의 인증의 경우 모든 API 요청에는 HTTP 헤더에 api-key API 키가 포함되어야 합니다. 빠른 시작에서는 이러한 유형의 인증을 사용하여 호출하는 방법에 대한 지침을 제공합니다.

  • Microsoft Entra ID 인증: Microsoft Entra 토큰을 사용하여 API 호출을 인증할 수 있습니다. 인증 토큰은 요청에 헤더로 Authorization 포함됩니다. 제공된 토큰 앞에는 다음이 있어야 합니다 Bearer. 예를 들면 다음과 같습니다 Bearer YOUR_AUTH_TOKEN. Microsoft Entra ID 대한 방법 가이드를 참조하세요.

REST API 버전 관리

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

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

데이터 평면 유추

이 문서의 나머지 부분에는 Azure OpenAI 데이터 평면 유추 사양 2024-10-21 GA 릴리스가 설명되어 있습니다.

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

Completions

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

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com) "aoairesource"를 Azure OpenAI 리소스 이름)으로 대체합니다. https://{your-resource-name}.openai.azure.com
deployment-id path Yes string 배포된 모델의 배포 ID입니다.
api-version query Yes string API version

Request Header

Name Required Type Description
api-key True string 여기에서 Azure OpenAI API 키 제공

Request Body

Content-Type: application/json

Name Type Description Required Default
prompt 문자열 또는 배열 문자열, 문자열 배열, 토큰 배열 또는 토큰 배열 배열로 인코딩된 완료를 생성할 프롬프트입니다.

<|endoftext|>는 학습 중에 모델이 보는 문서 구분 기호이므로 프롬프트를 지정하지 않으면 모델이 새 문서의 시작 부분에서처럼 생성됩니다.
 Yes
best_of integer best_of 완성 서버 쪽을 생성하고 "최적"(토큰당 로그 확률이 가장 높은 항목)을 반환합니다. 결과를 스트리밍할 수 없습니다.

와 함께 nbest_of 사용할 경우 후보 완료 횟수를 제어하고 n 반환할 수 있는 수를 지정합니다. best_ofn

참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 사용할 수 있습니다. 신중하게 사용하고 적절한 설정 max_tokens 이 있는지 확인합니다 stop.
 No 1
echo boolean 완료 외에 프롬프트를 다시 에코합니다.
 No False
frequency_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트의 기존 빈도에 따라 새 토큰에 불이익을 주므로 모델이 동일한 줄 축자를 반복할 가능성이 줄어듭니다.
 No 0
logit_bias object 완료 시 지정된 토큰이 나타날 가능성을 수정합니다.

토큰(GPT 토큰 변환기에서 해당 토큰 ID로 지정됨)을 -100 100까지 연결된 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로 바이어스는 샘플링 전에 모델에서 생성된 로그에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1 1 사이의 값은 선택 가능성을 줄이거나 늘려야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 단독으로 선택해야 합니다.

예를 들어 |endoftext|{"50256": -100} 토큰이 <생성되지 않도록 전달할 > 수 있습니다.
 No None
logprobs integer 가장 가능성이 높은 출력 토큰과 선택한 토큰에 logprobs 로그 확률을 포함합니다. 예를 들어 5인 경우 logprobs API는 가장 가능성이 큰 5개의 토큰 목록을 반환합니다. API는 항상 샘플링된 토큰을 반환 logprob 하므로 응답에 최대 logprobs+1 요소가 있을 수 있습니다.

최대값 logprobs 은 5입니다.
 No None
max_tokens integer 완료 시 생성할 수 있는 최대 토큰 수입니다.

프롬프트의 토큰 수와 max_tokens 모델의 컨텍스트 길이를 초과할 수 없습니다.		 No 16
n integer 각 프롬프트에 대해 생성할 완료 수입니다.

참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 사용할 수 있습니다. 신중하게 사용하고 적절한 설정 max_tokens 이 있는지 확인합니다 stop.
 No 1
presence_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트에 표시되는지 여부에 따라 새 토큰에 불이익을 주므로 모델이 새 토픽에 대해 이야기할 가능성이 높아집니다.
 No 0
seed integer 지정된 경우 시스템은 동일한 매개 변수와 매개 변수가 있는 반복된 요청이 동일한 seed 결과를 반환하도록 결정적으로 샘플링하는 데 최선을 다할 것입니다.

결정성은 보장되지 않으며 응답 매개 변수를 system_fingerprint 참조하여 백 엔드의 변경 내용을 모니터링해야 합니다.
 No
stop 문자열 또는 배열 API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 반환된 텍스트에는 중지 시퀀스가 포함되지 않습니다.
 No
stream boolean 부분 진행률을 다시 스트리밍할지 여부입니다. 설정된 경우 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트 로 전송되고 스트림은 메시지에 의해 data: [DONE] 종료됩니다. No False
suffix string 삽입된 텍스트가 완료된 후에 오는 접미사입니다.

이 매개 변수는 .에 gpt-3.5-turbo-instruct대해서만 지원됩니다.
 No None
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같은 값이 높을수록 출력이 더 임의로 생성되고, 0.2와 같은 값이 낮으면 더 집중적이고 결정적입니다.

일반적으로 이를 변경하거나 top_p 둘 다 변경하지 않는 것이 좋습니다.
 No 1
top_p number 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용하여 샘플링하는 대안입니다. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다.

일반적으로 이를 변경하거나 temperature 둘 다 변경하지 않는 것이 좋습니다.
 No 1
user string 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.
 No

Responses

상태 코드: 200

Description: OK

Content-Type Type Description
application/json createCompletionResponse API의 완료 응답을 나타냅니다. 참고: 스트리밍된 응답 개체와 비스트림 응답 개체는 채팅 엔드포인트와 달리 동일한 셰이프를 공유합니다.

상태 코드: 기본값

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

Content-Type Type Description
application/json errorResponse

Examples

Example

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

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

{
 "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
    }
  }
}

Embeddings

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

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com) "aoairesource"를 Azure OpenAI 리소스 이름)으로 대체합니다. https://{your-resource-name}.openai.azure.com
deployment-id path Yes string
api-version query Yes string API version

Request Header

Name Required Type Description
api-key True string 여기에서 Azure OpenAI API 키 제공

Request Body

Content-Type: application/json

Name Type Description Required Default
input 문자열 또는 배열 토큰의 문자열 또는 배열로 인코딩된 포함할 입력 텍스트입니다. 단일 요청에 여러 입력을 포함하려면 문자열 배열 또는 토큰 배열 배열을 전달합니다. 입력은 모델의 최대 입력 토큰(8,192개 text-embedding-ada-002토큰)을 초과해서는 안 되며, 빈 문자열일 수 없으며 배열은 2,048차원 이하여야 합니다. Yes
user string 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. No
input_type string 사용할 포함 검색의 입력 형식 No
encoding_format string 포함을 반환할 형식입니다. 또는 floatbase64.일 수 있습니다. 기본값은 .입니다 float. No
dimensions integer 결과 출력 포함에 포함해야 하는 차원의 수입니다. 이후 모델에서 text-embedding-3 만 지원됩니다. No

Responses

Name Type Description Required Default
object string Yes
model string Yes
data array Yes
usage object Yes

사용 속성

prompt_tokens

Name Type Description Default
prompt_tokens integer

total_tokens

Name Type Description Default
total_tokens integer

상태 코드: 200

Description: OK

Content-Type Type Description
application/json object

Examples

Example

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

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

{
 "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,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Chat completions

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

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com) "aoairesource"를 Azure OpenAI 리소스 이름)으로 대체합니다. https://{your-resource-name}.openai.azure.com
deployment-id path Yes string 배포된 모델의 배포 ID입니다.
api-version query Yes string API version

Request Header

Name Required Type Description
api-key True string 여기에서 Azure OpenAI API 키 제공

Request Body

Content-Type: application/json

Name Type Description Required Default
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같은 값이 높을수록 출력이 더 임의로 생성되고, 0.2와 같은 값이 낮으면 더 집중적이고 결정적입니다.

일반적으로 이를 변경하거나 top_p 둘 다 변경하지 않는 것이 좋습니다.
 No 1
top_p number 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용하여 샘플링하는 대안입니다. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다.

일반적으로 이를 변경하거나 temperature 둘 다 변경하지 않는 것이 좋습니다.
 No 1
stream boolean 설정되면 ChatGPT처럼 부분 메시지 델타가 전송됩니다. 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트 로 전송되고 스트림은 메시지에 의해 data: [DONE] 종료됩니다. No False
stop 문자열 또는 배열 API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다.
 No
max_tokens integer 채팅 완료 시 생성할 수 있는 최대 토큰 수입니다.

입력 토큰 및 생성된 토큰의 총 길이는 모델의 컨텍스트 길이로 제한됩니다.		 No
max_completion_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 완료를 위해 생성할 수 있는 토큰 수에 대한 상한입니다. No
presence_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트에 표시되는지 여부에 따라 새 토큰에 불이익을 주므로 모델이 새 토픽에 대해 이야기할 가능성이 높아집니다.
 No 0
frequency_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트의 기존 빈도에 따라 새 토큰에 불이익을 주므로 모델이 동일한 줄 축자를 반복할 가능성이 줄어듭니다.
 No 0
logit_bias object 완료 시 지정된 토큰이 나타날 가능성을 수정합니다.

토큰(토큰 ID로 토큰 ID로 지정됨)을 -100에서 100까지 연결된 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로 바이어스는 샘플링 전에 모델에서 생성된 로그에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1 1 사이의 값은 선택 가능성을 줄이거나 늘려야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 단독으로 선택해야 합니다.
 No None
user string 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.
 No
messages array 지금까지 대화를 구성하는 메시지 목록입니다. Yes
data_sources array 이를 사용하는 Azure OpenAI 채팅 확장 프로그램에 대한 구성 항목입니다.
이 추가 사양은 Azure OpenAI와만 호환됩니다.		 No
logprobs boolean 출력 토큰의 로그 확률을 반환할지 여부입니다. true이면 다음에서 반환된 각 출력 토큰의 로그 확률을 contentmessage반환합니다. No False
top_logprobs integer 각 토큰 위치에서 반환할 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수이며, 각각 연결된 로그 확률이 있습니다. logprobs 은 이 매개 변수를 true 사용하는 경우 설정해야 합니다. No
n integer 각 입력 메시지에 대해 생성할 채팅 완료 선택 항목 수입니다. 모든 선택 항목에서 생성된 토큰 수에 따라 요금이 청구됩니다. n 비용을 최소화하기 위해 계속합니다1. No 1
parallel_tool_calls ParallelToolCalls 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. No True
response_format ResponseFormatText 또는 ResponseFormatJsonObject 또는 ResponseFormatJsonSchema 모델이 출력해야 하는 형식을 지정하는 개체입니다. GPT-4o, GPT-4o mini, GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다gpt-3.5-turbo-1106.

{ "type": "json_schema", "json_schema": {...} } 모델이 제공된 JSON 스키마와 일치하도록 보장하는 구조적 출력을 사용하도록 설정합니다.

{ "type": "json_object" } 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드를 사용하도록 설정합니다.

중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 JSON을 직접 생성하도록 모델에 지시 해야 합니다 . 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 초과되었거나 대화가 최대 컨텍스트 길이를 초과했음 finish_reason="length" 을 나타내는 경우 max_tokens메시지 콘텐츠가 부분적으로 차단될 수 있습니다.
 No
seed integer 이 기능은 베타 버전입니다.
지정된 경우 시스템은 동일한 매개 변수와 매개 변수가 있는 반복된 요청이 동일한 seed 결과를 반환하도록 결정적으로 샘플링하는 데 최선을 다할 것입니다.
결정성은 보장되지 않으며 응답 매개 변수를 system_fingerprint 참조하여 백 엔드의 변경 내용을 모니터링해야 합니다.
 No
tools array 모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 이를 사용하여 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공합니다. 최대 128개의 함수가 지원됩니다.
 No
tool_choice chatCompletionToolChoiceOption 모델에서 호출되는 도구(있는 경우)를 제어합니다. none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다. auto 는 모델이 메시지를 생성하거나 하나 이상의 도구를 호출하는 중에서 선택할 수 있습니다. required 는 모델이 하나 이상의 도구를 호출해야 하다는 것을 의미합니다. 특정 도구를 통해 {"type": "function", "function": {"name": "my_function"}} 지정하면 모델이 해당 도구를 호출하게 합니다. none 는 도구가 없는 경우 기본값입니다. auto 는 도구가 있는 경우 기본값입니다. No
function_call string 또는 chatCompletionFunctionCallOption 에 찬성하여 사용되지 않습니다 tool_choice.

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

none 는 함수가 없는 경우 기본값입니다. auto 는 함수가 있는 경우 기본값입니다.
 No
functions array 에 찬성하여 사용되지 않습니다 tools.

모델이 JSON 입력을 생성할 수 있는 함수 목록입니다.
 No

Responses

상태 코드: 200

Description: OK

Content-Type Type Description
application/json createChatCompletionResponse 또는 createChatCompletionStreamResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json errorResponse

Examples

Example

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

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

{
 "messages": [
  {
   "role": "system",
   "content": "you are 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
    }
  }
}

Example

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

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

{
 "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
    }
  }
}

Example

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

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

{
 "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 are 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
    }
  }
}

Example

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

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

{
 "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-10-21

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com) "aoairesource"를 Azure OpenAI 리소스 이름)으로 대체합니다. https://{your-resource-name}.openai.azure.com
deployment-id path Yes string 음성 텍스트 변환 모델의 배포 ID입니다.

지원되는 모델에 대한 자세한 내용은 [/azure/ai-foundry/openai/concepts/models#audio-models]를 참조하세요.
api-version query Yes string API version

Request Header

Name Required Type Description
api-key True string 여기에서 Azure OpenAI API 키 제공

Request Body

Content-Type: multipart/form-data

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

Responses

상태 코드: 200

Description: OK

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

Examples

Example

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

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

응답: 상태 코드: 200

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

Example

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

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

"---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}/audio/translations?api-version=2024-10-21

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com) "aoairesource"를 Azure OpenAI 리소스 이름)으로 대체합니다. https://{your-resource-name}.openai.azure.com
deployment-id path Yes string 배포된 위스퍼 모델의 배포 ID입니다.

지원되는 모델에 대한 자세한 내용은 [/azure/ai-foundry/openai/concepts/models#audio-models]를 참조하세요.
api-version query Yes string API version

Request Header

Name Required Type Description
api-key True string 여기에서 Azure OpenAI API 키 제공

Request Body

Content-Type: multipart/form-data

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

Responses

상태 코드: 200

Description: OK

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

Examples

Example

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

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

"---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"
  }
}

Example

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

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

"---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"
}

Image generation

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

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

URI Parameters

Name In Required Type Description
endpoint path Yes string
url		 지원되는 Azure OpenAI 엔드포인트(프로토콜 및 호스트 이름( 예: https://aoairesource.openai.azure.com) "aoairesource"를 Azure OpenAI 리소스 이름)으로 대체합니다. https://{your-resource-name}.openai.azure.com
deployment-id path Yes string 배포된 dall-e 모델의 배포 ID입니다.
api-version query Yes string API version

Request Header

Name Required Type Description
api-key True string 여기에서 Azure OpenAI API 키 제공

Request Body

Content-Type: application/json

Name Type Description Required Default
prompt string 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 4,000자입니다. Yes
n integer 생성할 이미지 수입니다. No 1
size imageSize 생성된 이미지의 크기입니다. No 1024x1024
response_format imagesResponseFormat 생성된 이미지가 반환되는 형식입니다. No url
user string 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. No
quality imageQuality 생성될 이미지의 품질입니다. No standard
style imageStyle 생성된 이미지의 스타일입니다. No vivid

Responses

상태 코드: 200

Description: Ok

Content-Type Type Description
application/json generateImagesResponse

상태 코드: 기본값

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

Content-Type Type Description
application/json dalleErrorResponse

Examples

Example

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

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

{
 "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
          }
        }
      }
    ]
  }
}

Components

errorResponse

Name Type Description Required Default
error error No

errorBase

Name Type Description Required Default
code string No
message string No

error

Name Type Description Required Default
param string No
type string No
inner_error innerError 추가 세부 정보가 포함된 내부 오류입니다. No

innerError

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

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

innerErrorCode

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

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

Type: string

Default:

열거형 이름: InnerErrorCode

Enum Values:

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

dalleErrorResponse

Name Type Description Required Default
error dalleError No

dalleError

Name Type Description Required Default
param string No
type string No
inner_error dalleInnerError 추가 세부 정보가 포함된 내부 오류입니다. No

dalleInnerError

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

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

contentFilterResultBase

Name Type Description Required Default
filtered boolean Yes

contentFilterSeverityResult

Name Type Description Required Default
filtered boolean Yes
severity string No

contentFilterDetectedResult

Name Type Description Required Default
filtered boolean Yes
detected boolean No

contentFilterDetectedWithCitationResult

Name Type Description Required Default
citation object No

인용 속성

URL

Name Type Description Default
URL string

license

Name Type Description Default
license string

contentFilterResultsBase

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

Name Type Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
profanity contentFilterDetectedResult No
error errorBase No

contentFilterPromptResults

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

Name Type Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
profanity contentFilterDetectedResult No
error errorBase No
jailbreak contentFilterDetectedResult No

contentFilterChoiceResults

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

Name Type Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
profanity contentFilterDetectedResult No
error errorBase No
protected_material_text contentFilterDetectedResult No
protected_material_code contentFilterDetectedWithCitationResult No

promptFilterResult

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

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

promptFilterResults

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

이 구성 요소에 대해 정의된 속성이 없습니다.

dalleContentFilterResults

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

Name Type Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No

dalleFilterResults

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

Name Type Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
profanity contentFilterDetectedResult No
jailbreak contentFilterDetectedResult No

chatCompletionsRequestCommon

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

createCompletionRequest

Name Type Description Required Default
prompt 문자열 또는 배열 문자열, 문자열 배열, 토큰 배열 또는 토큰 배열 배열로 인코딩된 완료를 생성할 프롬프트입니다.

<|endoftext|>는 학습 중에 모델이 보는 문서 구분 기호이므로 프롬프트를 지정하지 않으면 모델이 새 문서의 시작 부분에서처럼 생성됩니다.
 Yes
best_of integer best_of 완성 서버 쪽을 생성하고 "최적"(토큰당 로그 확률이 가장 높은 항목)을 반환합니다. 결과를 스트리밍할 수 없습니다.

와 함께 nbest_of 사용할 경우 후보 완료 횟수를 제어하고 n 반환할 수 있는 수를 지정합니다. best_ofn

참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 사용할 수 있습니다. 신중하게 사용하고 적절한 설정 max_tokens 이 있는지 확인합니다 stop.
 No 1
echo boolean 완료 외에 프롬프트를 다시 에코합니다.
 No False
frequency_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트의 기존 빈도에 따라 새 토큰에 불이익을 주므로 모델이 동일한 줄 축자를 반복할 가능성이 줄어듭니다.
 No 0
logit_bias object 완료 시 지정된 토큰이 나타날 가능성을 수정합니다.

토큰(GPT 토큰 변환기에서 해당 토큰 ID로 지정됨)을 -100 100까지 연결된 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로 바이어스는 샘플링 전에 모델에서 생성된 로그에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1 1 사이의 값은 선택 가능성을 줄이거나 늘려야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 단독으로 선택해야 합니다.

예를 들어 |endoftext|{"50256": -100} 토큰이 <생성되지 않도록 전달할 > 수 있습니다.
 No None
logprobs integer 가장 가능성이 높은 출력 토큰과 선택한 토큰에 logprobs 로그 확률을 포함합니다. 예를 들어 5인 경우 logprobs API는 가장 가능성이 큰 5개의 토큰 목록을 반환합니다. API는 항상 샘플링된 토큰을 반환 logprob 하므로 응답에 최대 logprobs+1 요소가 있을 수 있습니다.

최대값 logprobs 은 5입니다.
 No None
max_tokens integer 완료 시 생성할 수 있는 최대 토큰 수입니다.

프롬프트의 토큰 수와 max_tokens 모델의 컨텍스트 길이를 초과할 수 없습니다.		 No 16
n integer 각 프롬프트에 대해 생성할 완료 수입니다.

참고: 이 매개 변수는 많은 완료를 생성하므로 토큰 할당량을 빠르게 사용할 수 있습니다. 신중하게 사용하고 적절한 설정 max_tokens 이 있는지 확인합니다 stop.
 No 1
presence_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트에 표시되는지 여부에 따라 새 토큰에 불이익을 주므로 모델이 새 토픽에 대해 이야기할 가능성이 높아집니다.
 No 0
seed integer 지정된 경우 시스템은 동일한 매개 변수와 매개 변수가 있는 반복된 요청이 동일한 seed 결과를 반환하도록 결정적으로 샘플링하는 데 최선을 다할 것입니다.

결정성은 보장되지 않으며 응답 매개 변수를 system_fingerprint 참조하여 백 엔드의 변경 내용을 모니터링해야 합니다.
 No
stop 문자열 또는 배열 API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다. 반환된 텍스트에는 중지 시퀀스가 포함되지 않습니다.
 No
stream boolean 부분 진행률을 다시 스트리밍할지 여부입니다. 설정된 경우 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트 로 전송되고 스트림은 메시지에 의해 data: [DONE] 종료됩니다. No False
suffix string 삽입된 텍스트가 완료된 후에 오는 접미사입니다.

이 매개 변수는 .에 gpt-3.5-turbo-instruct대해서만 지원됩니다.
 No None
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같은 값이 높을수록 출력이 더 임의로 생성되고, 0.2와 같은 값이 낮으면 더 집중적이고 결정적입니다.

일반적으로 이를 변경하거나 top_p 둘 다 변경하지 않는 것이 좋습니다.
 No 1
top_p number 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용하여 샘플링하는 대안입니다. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다.

일반적으로 이를 변경하거나 temperature 둘 다 변경하지 않는 것이 좋습니다.
 No 1
user string 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.
 No

createCompletionResponse

API의 완료 응답을 나타냅니다. 참고: 스트리밍된 응답 개체와 비스트림 응답 개체는 채팅 엔드포인트와 달리 동일한 셰이프를 공유합니다.

Name Type Description Required Default
id string 완료를 위한 고유 식별자입니다. Yes
choices array 입력 프롬프트에 대해 생성된 모델의 완성 선택 목록입니다. Yes
created integer 완료가 만들어진 시점의 Unix 타임스탬프(초)입니다. Yes
model string 완료에 사용되는 모델입니다. Yes
prompt_filter_results promptFilterResults 요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다. No
system_fingerprint string 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다.

요청 매개 변수와 함께 seed 사용하여 결정성에 영향을 줄 수 있는 백 엔드 변경이 발생한 시기를 파악할 수 있습니다.
 No
object enum 항상 "text_completion"인 개체 형식입니다.
가능한 값: text_completion		 Yes
usage completionUsage 완료 요청에 대한 사용 통계입니다. No

createChatCompletionRequest

Name Type Description Required Default
temperature number 사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같은 값이 높을수록 출력이 더 임의로 생성되고, 0.2와 같은 값이 낮으면 더 집중적이고 결정적입니다.

일반적으로 이를 변경하거나 top_p 둘 다 변경하지 않는 것이 좋습니다.
 No 1
top_p number 모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용하여 샘플링하는 대안입니다. 따라서 0.1은 상위 10개% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다.

일반적으로 이를 변경하거나 temperature 둘 다 변경하지 않는 것이 좋습니다.
 No 1
stream boolean 설정되면 ChatGPT처럼 부분 메시지 델타가 전송됩니다. 토큰은 사용할 수 있게 되면 데이터 전용 서버 전송 이벤트 로 전송되고 스트림은 메시지에 의해 data: [DONE] 종료됩니다. No False
stop 문자열 또는 배열 API가 추가 토큰 생성을 중지하는 최대 4개의 시퀀스입니다.
 No
max_tokens integer 채팅 완료 시 생성할 수 있는 최대 토큰 수입니다.

입력 토큰 및 생성된 토큰의 총 길이는 모델의 컨텍스트 길이로 제한됩니다.		 No
max_completion_tokens integer 표시되는 출력 토큰 및 추론 토큰을 포함하여 완료를 위해 생성할 수 있는 토큰 수에 대한 상한입니다. No
presence_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트에 표시되는지 여부에 따라 새 토큰에 불이익을 주므로 모델이 새 토픽에 대해 이야기할 가능성이 높아집니다.
 No 0
frequency_penalty number -2.0에서 2.0 사이의 숫자입니다. 양수 값은 지금까지 텍스트의 기존 빈도에 따라 새 토큰에 불이익을 주므로 모델이 동일한 줄 축자를 반복할 가능성이 줄어듭니다.
 No 0
logit_bias object 완료 시 지정된 토큰이 나타날 가능성을 수정합니다.

토큰(토큰 ID로 토큰 ID로 지정됨)을 -100에서 100까지 연결된 바이어스 값에 매핑하는 JSON 개체를 허용합니다. 수학적으로 바이어스는 샘플링 전에 모델에서 생성된 로그에 추가됩니다. 정확한 효과는 모델마다 다르지만 -1 1 사이의 값은 선택 가능성을 줄이거나 늘려야 합니다. -100 또는 100과 같은 값은 관련 토큰을 금지하거나 단독으로 선택해야 합니다.
 No None
user string 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다.
 No
messages array 지금까지 대화를 구성하는 메시지 목록입니다. Yes
data_sources array 이를 사용하는 Azure OpenAI 채팅 확장 프로그램에 대한 구성 항목입니다.
이 추가 사양은 Azure OpenAI와만 호환됩니다.		 No
logprobs boolean 출력 토큰의 로그 확률을 반환할지 여부입니다. true이면 다음에서 반환된 각 출력 토큰의 로그 확률을 contentmessage반환합니다. No False
top_logprobs integer 각 토큰 위치에서 반환할 가능성이 가장 높은 토큰 수를 지정하는 0에서 20 사이의 정수이며, 각각 연결된 로그 확률이 있습니다. logprobs 은 이 매개 변수를 true 사용하는 경우 설정해야 합니다. No
n integer 각 입력 메시지에 대해 생성할 채팅 완료 선택 항목 수입니다. 모든 선택 항목에서 생성된 토큰 수에 따라 요금이 청구됩니다. n 비용을 최소화하기 위해 계속합니다1. No 1
parallel_tool_calls ParallelToolCalls 도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다. No True
response_format ResponseFormatText 또는 ResponseFormatJsonObject 또는 ResponseFormatJsonSchema 모델이 출력해야 하는 형식을 지정하는 개체입니다. GPT-4o, GPT-4o mini, GPT-4 Turbo 및 모든 GPT-3.5 Turbo 모델과 호환됩니다gpt-3.5-turbo-1106.

{ "type": "json_schema", "json_schema": {...} } 모델이 제공된 JSON 스키마와 일치하도록 보장하는 구조적 출력을 사용하도록 설정합니다.

{ "type": "json_object" } 모델이 생성하는 메시지가 유효한 JSON임을 보장하는 JSON 모드를 사용하도록 설정합니다.

중요: JSON 모드를 사용하는 경우 시스템 또는 사용자 메시지를 통해 JSON을 직접 생성하도록 모델에 지시 해야 합니다 . 이렇게 하지 않으면 생성이 토큰 제한에 도달할 때까지 모델은 공백의 끝없는 스트림을 생성하여 장기 실행되고 겉보기에 "중단" 요청이 발생할 수 있습니다. 또한 생성이 초과되었거나 대화가 최대 컨텍스트 길이를 초과했음 finish_reason="length" 을 나타내는 경우 max_tokens메시지 콘텐츠가 부분적으로 차단될 수 있습니다.
 No
seed integer 이 기능은 베타 버전입니다.
지정된 경우 시스템은 동일한 매개 변수와 매개 변수가 있는 반복된 요청이 동일한 seed 결과를 반환하도록 결정적으로 샘플링하는 데 최선을 다할 것입니다.
결정성은 보장되지 않으며 응답 매개 변수를 system_fingerprint 참조하여 백 엔드의 변경 내용을 모니터링해야 합니다.
 No
tools array 모델이 호출할 수 있는 도구 목록입니다. 현재 함수만 도구로 지원됩니다. 이를 사용하여 모델이 JSON 입력을 생성할 수 있는 함수 목록을 제공합니다. 최대 128개의 함수가 지원됩니다.
 No
tool_choice chatCompletionToolChoiceOption 모델에서 호출되는 도구(있는 경우)를 제어합니다. none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다. auto 는 모델이 메시지를 생성하거나 하나 이상의 도구를 호출하는 중에서 선택할 수 있습니다. required 는 모델이 하나 이상의 도구를 호출해야 하다는 것을 의미합니다. 특정 도구를 통해 {"type": "function", "function": {"name": "my_function"}} 지정하면 모델이 해당 도구를 호출하게 합니다. none 는 도구가 없는 경우 기본값입니다. auto 는 도구가 있는 경우 기본값입니다. No
function_call string 또는 chatCompletionFunctionCallOption 에 찬성하여 사용되지 않습니다 tool_choice.

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

none 는 함수가 없는 경우 기본값입니다. auto 는 함수가 있는 경우 기본값입니다.
 No
functions array 에 찬성하여 사용되지 않습니다 tools.

모델이 JSON 입력을 생성할 수 있는 함수 목록입니다.
 No

chatCompletionFunctions

Name Type Description Required Default
description string 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. No
name string 호출할 함수의 이름입니다. a-z, A-Z, 0-9이거나 최대 길이가 64인 밑줄과 대시를 포함해야 합니다. Yes
parameters FunctionParameters JSON 스키마 개체로 설명된 함수가 허용하는 매개 변수입니다. 예제에 대한 가이드와 형식에 대한 설명서는 JSON 스키마 참조를 참조하세요.

생략하면 parameters 빈 매개 변수 목록이 있는 함수가 정의됩니다.		 No

chatCompletionFunctionCallOption

특정 함수를 통해 {"name": "my_function"} 지정하면 모델이 해당 함수를 호출하게 합니다.

Name Type Description Required Default
name string 호출할 함수의 이름입니다. Yes

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

Name Type Description Required Default
content 문자열 또는 배열 시스템 메시지의 내용입니다. Yes
role enum 이 경우 system메시지 작성자의 역할입니다.
가능한 값: 시스템		 Yes
name string 참가자의 선택적 이름입니다. 동일한 역할의 참가자를 구분하는 모델 정보를 제공합니다. No

chatCompletionRequestUserMessage

Name Type Description Required Default
content 문자열 또는 배열 사용자 메시지의 내용입니다.
 Yes
role enum 이 경우 user메시지 작성자의 역할입니다.
가능한 값: 사용자		 Yes
name string 참가자의 선택적 이름입니다. 동일한 역할의 참가자를 구분하는 모델 정보를 제공합니다. No

chatCompletionRequestAssistantMessage

Name Type Description Required Default
content 문자열 또는 배열 도우미 메시지의 내용입니다. 지정하지 않는 한 tool_callsfunction_call 필수 요소입니다.
 No
refusal string 도우미의 거부 메시지입니다. No
role enum 이 경우 assistant메시지 작성자의 역할입니다.
가능한 값: 도우미		 Yes
name string 참가자의 선택적 이름입니다. 동일한 역할의 참가자를 구분하는 모델 정보를 제공합니다. No
tool_calls chatCompletionMessageToolCalls 이 도구는 함수 호출과 같이 모델에서 생성한 호출입니다. No
function_call object 사용되지 않으며 .으로 대체되었습니다 tool_calls. 모델에서 생성한 대로 호출해야 하는 함수의 이름 및 인수입니다. No

function_call 속성

arguments

Name Type Description Default
arguments string 모델에서 JSON 형식으로 생성한 대로 함수를 호출할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사합니다.

name

Name Type Description Default
name string 호출할 함수의 이름입니다.

chatCompletionRequestToolMessage

Name Type Description Required Default
role enum 이 경우 tool메시지 작성자의 역할입니다.
가능한 값: 도구		 Yes
content 문자열 또는 배열 도구 메시지의 내용입니다. Yes
tool_call_id string 이 메시지가 응답하는 도구 호출입니다. Yes

chatCompletionRequestFunctionMessage

Name Type Description Required Default
role enum 이 경우 function메시지 작성자의 역할입니다.
가능한 값: 함수		 Yes
content string 함수 메시지의 내용입니다. Yes
name string 호출할 함수의 이름입니다. Yes

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

Name Type Description Required Default
type enum 콘텐츠 파트의 형식입니다.
가능한 값: 텍스트		 Yes
text string 텍스트 콘텐츠입니다. Yes

chatCompletionRequestMessageContentPartImage

Name Type Description Required Default
type enum 콘텐츠 파트의 형식입니다.
가능한 값: image_url		 Yes
image_url object Yes

image_url 속성

url

Name Type Description Default
url string 이미지의 URL 또는 base64로 인코딩된 이미지 데이터입니다.

detail

Name Type Description Default
detail string 이미지의 세부 수준을 지정합니다. 비전 가이드에서 자세히 알아보세요. auto

chatCompletionRequestMessageContentPartRefusal

Name Type Description Required Default
type enum 콘텐츠 파트의 형식입니다.
가능한 값: 거부		 Yes
refusal string 모델에서 생성한 거부 메시지입니다. Yes

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

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

Type: string

Default:

열거형 이름: AzureChatExtensionType

Enum Values:

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

azureSearchChatExtensionConfiguration

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

Name Type Description Required Default
type azureChatExtensionType 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. 채팅에서 사용됩니다.
Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 완료 요청입니다.
이 구성의 사용은 Azure OpenAI와만 호환됩니다.		 Yes
parameters azureSearchChatExtensionParameters Azure OpenAI 채팅 확장으로 사용되는 경우 Azure Search에 대한 매개 변수입니다. No

azureSearchChatExtensionParameters

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

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

azureSearchIndexFieldMappingOptions

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

Name Type Description Required Default
title_field string 제목으로 사용할 인덱스 필드의 이름입니다. No
url_field string URL로 사용할 인덱스 필드의 이름입니다. No
filepath_field string 파일 경로로 사용할 인덱스 필드의 이름입니다. No
content_fields array 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. No
content_fields_separator string 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. No
vector_fields array 벡터 데이터를 나타내는 필드의 이름입니다. No

azureSearchQueryType

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

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

Type: string

Default:

열거형 이름: AzureSearchQueryType

Enum Values:

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

azureCosmosDBChatExtensionConfiguration

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

Name Type Description Required Default
type azureChatExtensionType 단일 Azure OpenAI 채팅 확장에 대한 구성 데이터의 표현입니다. 채팅에서 사용됩니다.
Azure OpenAI 채팅 확장을 사용하여 응답 동작을 보강해야 하는 완료 요청입니다.
이 구성의 사용은 Azure OpenAI와만 호환됩니다.		 Yes
parameters azureCosmosDBChatExtensionParameters Azure Cosmos DB 사용할 때 데이터 채팅 확장 프로그램에서 Azure OpenAI를 구성할 때 사용할 매개 변수
MongoDB vCore.		 No

azureCosmosDBChatExtensionParameters

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

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

azureCosmosDBFieldMappingOptions

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

Name Type Description Required Default
title_field string 제목으로 사용할 인덱스 필드의 이름입니다. No
url_field string URL로 사용할 인덱스 필드의 이름입니다. No
filepath_field string 파일 경로로 사용할 인덱스 필드의 이름입니다. No
content_fields array 콘텐츠로 처리해야 하는 인덱스 필드의 이름입니다. Yes
content_fields_separator string 콘텐츠 필드에서 사용해야 하는 구분 기호 패턴입니다. No
vector_fields array 벡터 데이터를 나타내는 필드의 이름입니다. Yes

onYourDataAuthenticationOptions

데이터에 OpenAI를 Azure 인증 옵션입니다.

Name Type Description Required Default
type onYourDataAuthenticationType Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. Yes

onYourDataAuthenticationType

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

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

Type: string

Default:

열거형 이름: OnYourDataAuthenticationType

Enum Values:

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

onYourDataApiKeyAuthenticationOptions

API 키를 사용할 때 데이터에 OpenAI를 Azure 인증 옵션입니다.

Name Type Description Required Default
type onYourDataAuthenticationType Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. Yes
key string 인증에 사용할 API 키입니다. No

onYourDataConnectionStringAuthenticationOptions

연결 문자열 사용할 때 데이터에 OpenAI를 Azure 인증 옵션입니다.

Name Type Description Required Default
type onYourDataAuthenticationType Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. Yes
connection_string string 인증에 사용할 연결 문자열. No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

시스템 할당 관리 ID를 사용할 때 데이터에 OpenAI를 Azure 인증 옵션입니다.

Name Type Description Required Default
type onYourDataAuthenticationType Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

사용자 할당 관리 ID를 사용할 때 데이터에 OpenAI를 Azure 인증 옵션입니다.

Name Type Description Required Default
type onYourDataAuthenticationType Azure OpenAI On Your Data에서 지원되는 인증 유형입니다. Yes
managed_identity_resource_id string 인증에 사용할 사용자 할당 관리 ID의 리소스 ID입니다. No

onYourDataVectorizationSource

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

Name Type Description Required Default
type onYourDataVectorizationSourceType OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 Azure 사용 가능한 원본을 나타냅니다.
vector search.		 Yes

onYourDataVectorizationSourceType

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

설명: OpenAI on Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 Azure 사용 가능한 원본을 나타냅니다.
vector search.

Type: string

Default:

열거형 이름: OnYourDataVectorizationSourceType

Enum Values:

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

onYourDataDeploymentNameVectorizationSource

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

Name Type Description Required Default
type onYourDataVectorizationSourceType OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 Azure 사용 가능한 원본을 나타냅니다.
vector search.		 Yes
deployment_name string 벡터화에 사용할 모델 배포의 이름을 지정합니다. 이 모델 배포는 OpenAI 리소스와 동일한 Azure 있어야 하지만 On Your Data는 공용이 아닌 내부 호출을 통해 이 모델 배포를 사용하므로 프라이빗 네트워크에서도 벡터 검색이 가능합니다. No

onYourDataEndpointVectorizationSource

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

Name Type Description Required Default
type onYourDataVectorizationSourceType OpenAI On Your Data에서 사용할 데이터의 벡터화를 구성하는 데 사용할 수 있는 Azure 사용 가능한 원본을 나타냅니다.
vector search.		 Yes
authentication onYourDataApiKeyAuthenticationOptions API 키를 사용할 때 데이터에 OpenAI를 Azure 인증 옵션입니다. No
endpoint string 벡터화에 사용할 엔드포인트를 지정합니다. 이 엔드포인트는 OpenAI 리소스와 동일한 Azure 있어야 하지만, 데이터에서 공용이 아닌 내부 호출을 통해 이 엔드포인트를 사용하므로 프라이빗 네트워크에서도 벡터 검색이 가능합니다. No

azureChatExtensionsMessageContext

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

Name Type Description Required Default
citations array 응답에서 도우미 메시지를 생성하는 데 사용되는 데이터 원본 검색 결과입니다. No
intent string 컨텍스트를 수행하기 위해 다음 턴으로 전달하는 데 사용되는 채팅 기록에서 검색된 의도입니다. No

citation

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

Name Type Description Required Default
content string 인용 내용입니다. Yes
title string 인용 제목입니다. No
url string 인용의 URL입니다. No
filepath string 인용의 파일 경로입니다. No
chunk_id string 인용의 청크 ID입니다. No

chatCompletionMessageToolCall

Name Type Description Required Default
id string 도구 호출의 ID입니다. Yes
type toolCallType 이 경우 function도구 호출의 형식입니다. Yes
function object 모델이 호출한 함수입니다. Yes

함수의 속성

name

Name Type Description Default
name string 호출할 함수의 이름입니다.

arguments

Name Type Description Default
arguments string 모델에서 JSON 형식으로 생성한 대로 함수를 호출할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사합니다.

toolCallType

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

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

Type: string

Default:

열거형 이름: ToolCallType

Enum Values:

Value Description
function 도구 호출 유형이 함수입니다.

chatCompletionRequestMessageTool

Name Type Description Required Default
tool_call_id string 이 메시지가 응답하는 도구 호출입니다. No
content string 메시지의 내용입니다. No

chatCompletionRequestMessageFunction

Name Type Description Required Default
role enum 이 경우 function메시지 작성자의 역할입니다.
가능한 값: 함수		 No
name string 메시지의 내용입니다. No
content string 메시지의 내용입니다. No

createChatCompletionResponse

제공된 입력에 따라 모델에서 반환된 채팅 완료 응답을 나타냅니다.

Name Type Description Required Default
id string 채팅 완료를 위한 고유 식별자입니다. Yes
prompt_filter_results promptFilterResults 요청에서 0개 이상의 프롬프트에 대한 콘텐츠 필터링 결과입니다. 스트리밍 요청에서 다른 프롬프트에 대한 결과는 서로 다른 시간 또는 다른 순서로 도착할 수 있습니다. No
choices array 채팅 완료 선택 목록입니다. 1보다 큰 경우 n 둘 이상일 수 있습니다. Yes
created integer 채팅이 완료된 시점의 Unix 타임스탬프(초)입니다. Yes
model string 채팅 완료에 사용되는 모델입니다. Yes
system_fingerprint string 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다.

요청 매개 변수와 함께 seed 사용하여 결정성에 영향을 줄 수 있는 백 엔드 변경이 발생한 시기를 파악할 수 있습니다.
 No
object enum 항상 chat.completion개체 형식입니다.
가능한 값: chat.completion		 Yes
usage completionUsage 완료 요청에 대한 사용 통계입니다. No

createChatCompletionStreamResponse

제공된 입력에 따라 모델에서 반환된 채팅 완료 응답의 스트리밍된 청크를 나타냅니다.

Name Type Description Required Default
id string 채팅 완료를 위한 고유 식별자입니다. 각 청크에는 동일한 ID가 있습니다. Yes
choices array 채팅 완료 선택 목록입니다. 1보다 큰 경우 n 둘 이상의 요소를 포함할 수 있습니다.
 Yes
created integer 채팅이 완료된 시점의 Unix 타임스탬프(초)입니다. 각 청크에는 동일한 타임스탬프가 있습니다. Yes
model string 완성을 생성할 모델입니다. Yes
system_fingerprint string 이 지문은 모델이 실행되는 백 엔드 구성을 나타냅니다.
요청 매개 변수와 함께 seed 사용하여 결정성에 영향을 줄 수 있는 백 엔드 변경이 발생한 시기를 파악할 수 있습니다.
 No
object enum 항상 chat.completion.chunk개체 형식입니다.
가능한 값: chat.completion.chunk		 Yes

chatCompletionStreamResponseDelta

스트리밍된 모델 응답에 의해 생성된 채팅 완료 델타입니다.

Name Type Description Required Default
content string 청크 메시지의 내용입니다. No
function_call object 사용되지 않으며 .으로 대체되었습니다 tool_calls. 모델에서 생성한 대로 호출해야 하는 함수의 이름 및 인수입니다. No
tool_calls array No
role enum 이 메시지 작성자의 역할입니다.
가능한 값: 시스템, 사용자, 도우미, 도구		 No
refusal string 모델에서 생성한 거부 메시지입니다. No

function_call 속성

arguments

Name Type Description Default
arguments string 모델에서 JSON 형식으로 생성한 대로 함수를 호출할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사합니다.

name

Name Type Description Default
name string 호출할 함수의 이름입니다.

chatCompletionMessageToolCallChunk

Name Type Description Required Default
index integer Yes
id string 도구 호출의 ID입니다. No
type enum 도구의 형식입니다. 현재는 function 지원됩니다.
가능한 값: 함수		 No
function object No

함수의 속성

name

Name Type Description Default
name string 호출할 함수의 이름입니다.

arguments

Name Type Description Default
arguments string 모델에서 JSON 형식으로 생성한 대로 함수를 호출할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사합니다.

chatCompletionStreamOptions

스트리밍 응답에 대한 옵션입니다. 설정할 stream: true때만 설정합니다.

Name Type Description Required Default
include_usage boolean 설정된 경우 메시지 전에 data: [DONE] 추가 청크가 스트리밍됩니다. usage 이 청크의 필드는 전체 요청에 대한 토큰 사용 통계를 표시하며 choices 필드는 항상 빈 배열입니다. 다른 모든 청크에도 필드가 usage 포함되지만 null 값이 포함됩니다.
 No

chatCompletionChoiceLogProbs

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

Name Type Description Required Default
content array 로그 확률 정보가 포함된 메시지 콘텐츠 토큰 목록입니다. Yes
refusal array 로그 확률 정보가 있는 메시지 거부 토큰 목록입니다. No

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

Name Type Description Required Default
role chatCompletionResponseMessageRole 응답 메시지 작성자의 역할입니다. Yes
refusal string 모델에서 생성한 거부 메시지입니다. Yes
content string 메시지의 내용입니다. Yes
tool_calls array 이 도구는 함수 호출과 같이 모델에서 생성한 호출입니다. No
function_call chatCompletionFunctionCall 사용되지 않으며 .으로 대체되었습니다 tool_calls. 모델에서 생성한 대로 호출해야 하는 함수의 이름 및 인수입니다. No
context azureChatExtensionsMessageContext Azure OpenAI 채팅 확장이 관련될 때 사용할 수 있는 추가 컨텍스트 정보의 표현입니다.
은 해당 채팅 완료 응답을 생성합니다. 이 컨텍스트 정보는 다음 경우에만 채워집니다.
일치하는 확장을 사용하도록 구성된 Azure OpenAI 요청을 사용합니다.		 No

chatCompletionResponseMessageRole

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

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

Type: string

Default:

Enum Values:

  • assistant

chatCompletionToolChoiceOption

모델에서 호출되는 도구(있는 경우)를 제어합니다. none 는 모델이 도구를 호출하지 않고 대신 메시지를 생성한다는 의미입니다. auto 는 모델이 메시지를 생성하거나 하나 이상의 도구를 호출하는 중에서 선택할 수 있습니다. required 는 모델이 하나 이상의 도구를 호출해야 하다는 것을 의미합니다. 특정 도구를 통해 {"type": "function", "function": {"name": "my_function"}} 지정하면 모델이 해당 도구를 호출하게 합니다. none 는 도구가 없는 경우 기본값입니다. auto 는 도구가 있는 경우 기본값입니다.

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

chatCompletionNamedToolChoice

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

Name Type Description Required Default
type enum 도구의 형식입니다. 현재는 function 지원됩니다.
가능한 값: 함수		 Yes
function object Yes

함수의 속성

name

Name Type Description Default
name string 호출할 함수의 이름입니다.

ParallelToolCalls

도구를 사용하는 동안 병렬 함수 호출을 사용하도록 설정할지 여부입니다.

이 구성 요소에 대해 정의된 속성이 없습니다.

chatCompletionMessageToolCalls

이 도구는 함수 호출과 같이 모델에서 생성한 호출입니다.

이 구성 요소에 대해 정의된 속성이 없습니다.

chatCompletionFunctionCall

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

Name Type Description Required Default
name string 호출할 함수의 이름입니다. Yes
arguments string 모델에서 JSON 형식으로 생성한 대로 함수를 호출할 인수입니다. 모델이 항상 유효한 JSON을 생성하지는 않으며 함수 스키마에 의해 정의되지 않은 매개 변수를 생성할 수 있습니다. 함수를 호출하기 전에 코드에서 인수의 유효성을 검사합니다. Yes

completionUsage

완료 요청에 대한 사용 통계입니다.

Name Type Description Required Default
prompt_tokens integer 프롬프트의 토큰 수입니다. Yes
completion_tokens integer 생성된 완료의 토큰 수입니다. Yes
total_tokens integer 요청에 사용된 총 토큰 수입니다(프롬프트 + 완료). Yes
completion_tokens_details object 완료 시 사용되는 토큰 분석입니다. No

completion_tokens_details 속성

reasoning_tokens

Name Type Description Default
reasoning_tokens integer 추론을 위해 모델에서 생성한 토큰입니다.

chatCompletionTool

Name Type Description Required Default
type enum 도구의 형식입니다. 현재는 function 지원됩니다.
가능한 값: 함수		 Yes
function FunctionObject Yes

FunctionParameters

JSON 스키마 개체로 설명된 함수가 허용하는 매개 변수입니다. 예제에 대한 가이드와 형식에 대한 설명서는 JSON 스키마 참조를 참조하세요.

생략하면 parameters 빈 매개 변수 목록이 있는 함수가 정의됩니다.

이 구성 요소에 대해 정의된 속성이 없습니다.

FunctionObject

Name Type Description Required Default
description string 함수를 호출하는 시기와 방법을 선택하기 위해 모델에서 사용하는 함수의 기능에 대한 설명입니다. No
name string 호출할 함수의 이름입니다. a-z, A-Z, 0-9이거나 최대 길이가 64인 밑줄과 대시를 포함해야 합니다. Yes
parameters FunctionParameters JSON 스키마 개체로 설명된 함수가 허용하는 매개 변수입니다. 예제에 대한 가이드와 형식에 대한 설명서는 JSON 스키마 참조를 참조하세요.

생략하면 parameters 빈 매개 변수 목록이 있는 함수가 정의됩니다.		 No
strict boolean 함수 호출을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다. true로 설정하면 모델은 필드에 정의된 정확한 스키마를 parameters 따릅니다. JSON 스키마의 하위 집합만 지원 strict 됩니다 true. No False

ResponseFormatText

Name Type Description Required Default
type enum 정의되는 응답 형식의 유형: text
가능한 값: 텍스트		 Yes

ResponseFormatJsonObject

Name Type Description Required Default
type enum 정의되는 응답 형식의 유형: json_object
가능한 값: json_object		 Yes

ResponseFormatJsonSchemaSchema

JSON 스키마 개체로 설명된 응답 형식에 대한 스키마입니다.

이 구성 요소에 대해 정의된 속성이 없습니다.

ResponseFormatJsonSchema

Name Type Description Required Default
type enum 정의되는 응답 형식의 유형: json_schema
가능한 값: json_schema		 Yes
json_schema object Yes

json_schema 속성

description

Name Type Description Default
description string 응답 형식의 용도에 대한 설명이며, 모델에서 형식으로 응답하는 방법을 결정하는 데 사용됩니다.

name

Name Type Description Default
name string 응답 형식의 이름입니다. a-z, A-Z, 0-9이거나 최대 길이가 64인 밑줄과 대시를 포함해야 합니다.

schema

Name Type Description Default
schema ResponseFormatJsonSchemaSchema JSON 스키마 개체로 설명된 응답 형식에 대한 스키마입니다.

strict

Name Type Description Default
strict boolean 출력을 생성할 때 엄격한 스키마 준수를 사용하도록 설정할지 여부입니다. true로 설정하면 모델은 항상 필드에 정의된 정확한 스키마를 schema 따릅니다. JSON 스키마의 하위 집합만 지원 strict 됩니다 true. False

chatCompletionChoiceCommon

Name Type Description Required Default
index integer No
finish_reason string No

createTranslationRequest

Translation request.

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

audioResponse

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

Name Type Description Required Default
text string 번역되거나 전사된 텍스트입니다. Yes

audioVerboseResponse

response_format verbose_json 때 번역 또는 전사 응답

Name Type Description Required Default
text string 번역되거나 전사된 텍스트입니다. Yes
task string 오디오 작업의 유형입니다. No
language string Language. No
duration number Duration. No
segments array No

audioResponseFormat

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

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

Type: string

Default:

Enum Values:

  • json
  • text
  • srt
  • verbose_json
  • vtt

createTranscriptionRequest

Transcription request.

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

audioSegment

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

Name Type Description Required Default
id integer Segment identifier. No
seek number 세그먼트의 오프셋입니다. No
start number 세그먼트 시작 오프셋입니다. No
end number 세그먼트 끝 오프셋입니다. No
text string Segment text. No
tokens array 텍스트의 토큰입니다. No
temperature number Temperature. No
avg_logprob number 평균 로그 확률입니다. No
compression_ratio number Compression ratio. No
no_speech_prob number 의 확률입니다 no speech. No

imageQuality

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

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

Type: string

Default: standard

열거형 이름: 품질

Enum Values:

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

imagesResponseFormat

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

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

Type: string

Default: url

열거형 이름: ImagesResponseFormat

Enum Values:

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

imageSize

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

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

Type: string

Default: 1024x1024

열거형 이름: 크기

Enum Values:

Value Description
1792x1024 생성된 이미지의 원하는 크기는 1792x1024 픽셀입니다.
1024x1792 생성된 이미지의 원하는 크기는 1024x1792픽셀입니다.
1024x1024 생성된 이미지의 원하는 크기는 1024x1024픽셀입니다.

imageStyle

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

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

Type: string

Default: vivid

열거형 이름: 스타일

Enum Values:

Value Description
vivid 생생하게는 매우 현실적이고 극적인 이미지를 만듭니다.
natural 자연은 더 자연스럽고 덜 사실적인 이미지를 만듭니다.

imageGenerationsRequest

Name Type Description Required Default
prompt string 원하는 이미지에 대한 텍스트 설명입니다. 최대 길이는 4,000자입니다. Yes
n integer 생성할 이미지 수입니다. No 1
size imageSize 생성된 이미지의 크기입니다. No 1024x1024
response_format imagesResponseFormat 생성된 이미지가 반환되는 형식입니다. No url
user string 남용을 모니터링하고 감지하는 데 도움이 될 수 있는 최종 사용자를 나타내는 고유 식별자입니다. No
quality imageQuality 생성될 이미지의 품질입니다. No standard
style imageStyle 생성된 이미지의 스타일입니다. No vivid

generateImagesResponse

Name Type Description Required Default
created integer 작업을 만들 때의 unix 타임스탬프입니다. Yes
data array 성공한 경우 작업의 결과 데이터입니다. Yes

imageResult

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

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

Completions extensions

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

Chatmessage

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

텍스트 음성 변환(미리 보기)

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

Next steps

모델에 대해 알아보 고 REST API를 사용하여 미세 조정합니다. OpenAI 어설픈 모델에 대해 자세히 알아보세요>.

  • Last updated on