Azure OpenAI in Microsoft Foundry Models REST API reference

이 글은 Azure OpenAI용 추론 REST API 엔드포인트에 대한 자세한 내용을 제공합니다.

API specs

Azure OpenAI 모델과 자원을 관리하고 상호작용하는 것은 세 가지 주요 API 표면으로 나뉩니다:

• Control plane
• 데이터 평면 - 저작
• 데이터 평면 - 추론

각 API 서피스/명세는 서로 다른 Azure OpenAI 기능 집합을 캡슐화합니다. 각 API는 고유한 미리보기와 안정적/일반 제공(GA) 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

Request Header

Request Body

Content-Type: application/json

Responses

상태 코드: 200

Description: OK

상태 코드: 기본 상태

설명: 서비스 불가

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

Request Header

Request Body

Content-Type: application/json

Responses

사용 특성

prompt_tokens

total_tokens

상태 코드: 200

Description: OK

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

Request Header

Request Body

Content-Type: application/json

Responses

상태 코드: 200

Description: OK

상태 코드: 기본 상태

설명: 서비스 불가

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 검색 데이터와 시스템 할당 관리 신원을 기반으로 완료 파일을 생성합니다.

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 벡터 데이터, 이전 어시스턴트 메시지, 사용자 지정 관리 신원을 기반으로 완료 파일을 생성합니다.

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

Request Header

Request Body

Content-Type: multipart/form-data

Responses

상태 코드: 200

Description: OK

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

Request Header

Request Body

Content-Type: multipart/form-data

Responses

상태 코드: 200

Description: OK

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

Request Header

Request Body

Content-Type: application/json

Responses

상태 코드: 200

Description: Ok

상태 코드: 기본 상태

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

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

errorBase

error

innerError

내부 오류가 추가된 세부사항입니다.

innerErrorCode

내부 오류 객체에 대한 오류 코드.

설명: 내부 오류 객체의 오류 코드.

Type: string

Default:

열거 이름: InnerErrorCode

Enum Values:

dalleErrorResponse

dalleError

dalleInnerError

내부 오류가 추가된 세부사항입니다.

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

인용을 위한 특성

URL

license

contentFilterResultsBase

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

contentFilterPromptResults

콘텐츠 필터링 카테고리(증오, 성적, 폭력, self_harm), 감지 여부, 심각도 수준(very_low, 낮음, 중간, 고수준, 해로운 콘텐츠의 강도와 위험 수준을 결정함), 필터링 여부에 관한 정보입니다. 탈옥 내용과 욕설에 관한 정보, 감지되었는지, 필터링되었는지 여부. 그리고 고객 차단 목록이 필터링되었는지 여부와 그 ID에 관한 정보도 알려줍니다.

contentFilterChoiceResults

콘텐츠 필터링 카테고리(증오, 성적, 폭력, self_harm), 감지 여부, 심각도 수준(very_low, 낮음, 중간, 고수준, 해로운 콘텐츠의 강도와 위험 수준을 결정함), 필터링 여부에 관한 정보입니다. 제3자 텍스트와 욕설에 관한 정보, 감지되었는지, 필터링되었는지 여부. 그리고 고객 차단 목록이 필터링되었는지 여부와 그 ID에 관한 정보도 알려줍니다.

promptFilterResult

요청 내 단일 프롬프트에 대한 콘텐츠 필터링 결과가 나옵니다.

promptFilterResults

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

이 컴포넌트에 대한 속성이 정의되어 있지 않습니다.

dalleContentFilterResults

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

dalleFilterResults

콘텐츠 필터링 카테고리(증오, 성적, 폭력, self_harm), 감지 여부, 심각도 수준(very_low, 낮음, 중간, 고수준, 해로운 콘텐츠의 강도와 위험 수준을 결정함), 필터링 여부에 관한 정보입니다. 탈옥 내용과 욕설에 관한 정보, 감지되었는지, 필터링되었는지 여부. 그리고 고객 차단 목록이 필터링되었는지 여부와 그 ID에 관한 정보도 알려줍니다.

chatCompletionsRequestCommon

createCompletionRequest

createCompletionResponse

API의 완료 응답을 나타냅니다. 참고: 스트림된 응답 객체와 비스트리밍된 응답 객체는 모두 동일한 형태를 공유합니다(채팅 엔드포인트와 다릅니다).

createChatCompletionRequest

chatCompletionFunctions

chatCompletionFunctionCallOption

특정 함수 {"name": "my_function"} 를 지정하면 모델이 그 함수를 호출하도록 강제합니다.

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

chatCompletionRequestUserMessage

chatCompletionRequestAssistantMessage

function_call 속성

arguments

name

chatCompletionRequestToolMessage

chatCompletionRequestFunctionMessage

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartImage

image_url 속성

url

detail

chatCompletionRequestMessageContentPartRefusal

azureChatExtensionConfiguration

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

azureChatExtensionType

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

Description: 단일 Azure OpenAI 채팅 확장 프로그램의 구성 데이터를 표현한 것입니다. 이 기능은 Azure OpenAI 채팅 확장 기능을 사용해 응답 동작을 보완하는 채팅 완료 요청에 사용됩니다. 이 구성의 사용은 Azure OpenAI와만 호환됩니다.

Type: string

Default:

Enum name: AzureChatExtensionType

Enum Values:

azureSearchChatExtensionConfiguration

Azure Search를 Azure OpenAI 채팅 확장으로 사용할 때 설정할 수 있는 옵션의 구체적인 표현입니다.

azureSearchChatExtensionParameters

Azure OpenAI 채팅 확장기로 사용할 때 사용하는 Azure 검색의 매개변수.

azureSearchIndexFieldMappingOptions

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

azureSearchQueryType

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

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

Type: string

Default:

Enum name: AzureSearchQueryType

Enum Values:

azureCosmosDBChatExtensionConfiguration

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

azureCosmosDBChatExtensionParameters

Azure OpenAI On Your Data 설정 시 사용할 매개변수 Azure Cosmos DB for MongoDB vCore를 사용할 때 채팅 확장 기능.

azureCosmosDBFieldMappingOptions

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

onYourDataAuthenticationOptions

Azure OpenAI의 데이터 인증 옵션.

onYourDataAuthenticationType

Azure OpenAI On Your Data에서 지원하는 인증 유형들.

설명: 귀하의 데이터에 대해 Azure OpenAI가 지원하는 인증 유형.

Type: string

Default:

Enum 이름: OnYourDataAuthenticationType

Enum Values:

onYourDataApiKeyAuthenticationOptions

API 키를 사용할 때 당신의 데이터에 대해 확인한 Azure OpenAI 인증 옵션.

onYourDataConnectionStringAuthenticationOptions

azure OpenAI On Your Data 인증 옵션, 연결 문자열을 사용할 때의 정보.

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

시스템 할당 관리 신원을 사용할 때 당신의 데이터에 대한 Azure OpenAI 인증 옵션.

onYourDataUserAssignedManagedIdentityAuthenticationOptions

사용자 지정 관리 신원을 사용할 때 사용하는 Azure OpenAI On Your Data의 인증 옵션들.

onYourDataVectorizationSource

벡터 검색을 이용한 Azure OpenAI On Your Data의 벡터화 소스 추상적 표현입니다.

onYourDataVectorizationSourceType

Azure OpenAI On Your Data가 베터를 검색할 수 있도록 벡터화 설정을 위해 사용할 수 있는 사용 가능한 소스를 나타냅니다.

Description: OpenAI On Your Data가 데이터를 벡터화하는 데 사용할 수 있는 Azure 사용 가능한 소스를 나타냅니다.
vector search.

Type: string

Default:

Enum 이름: OnYourDataVectorizationSourceType

Enum Values:

onYourDataDeploymentNameVectorizationSource

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

onYourDataEndpointVectorizationSource

벡터 검색을 적용할 때 Azure OpenAI On Your Data에서 사용하는 벡터화 소스의 세부 정보로, 이는 공개된 Azure OpenAI 엔드포인트의 임베딩 호출을 기반으로 합니다.

azureChatExtensionsMessageContext

Azure OpenAI 채팅 확장 기능이 해당 채팅 완료 응답 생성에 참여할 때 제공되는 추가 맥락 정보를 나타냅니다. 이 컨텍스트 정보는 Azure OpenAI 요청을 매칭 확장 기능을 사용하도록 설정할 때만 채워집니다.

citation

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

chatCompletionMessageToolCall

함수의 성질

name

arguments

toolCallType

툴 호출의 유형, 이 경우 function.

설명: 툴 호출의 유형, 이 경우 function.

Type: string

Default:

Enum 이름: ToolCallType

Enum Values:

chatCompletionRequestMessageTool

chatCompletionRequestMessageFunction

createChatCompletionResponse

모델은 제공된 입력을 기반으로 하여 채팅 완료 응답을 반환합니다.

createChatCompletionStreamResponse

제공된 입력을 바탕으로 모델이 반환하는 채팅 완료 응답의 스트림 청크를 나타냅니다.

chatCompletionStreamResponseDelta

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

function_call 속성

arguments

name

chatCompletionMessageToolCallChunk

함수의 성질

name

arguments

chatCompletionStreamOptions

스트리밍 응답 옵션. 이 설정을 할 때 stream: true만 설정합니다.

chatCompletionChoiceLogProbs

선택에 대한 확률 정보를 기록하세요.

chatCompletionTokenLogprob

chatCompletionResponseMessage

모델이 생성하는 채팅 완료 메시지입니다.

chatCompletionResponseMessageRole

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

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

Type: string

Default:

Enum Values:

• assistant

chatCompletionToolChoiceOption

모델이 호출하는 도구가 어떤 것인지(있다면) 제어합니다. none 즉, 모델은 어떤 도구를 호출하지 않고 메시지를 생성합니다. auto 즉, 모델은 메시지를 생성하거나 하나 이상의 도구를 호출할 수 있습니다. required 즉, 모델이 하나 이상의 도구를 호출해야 한다는 뜻입니다. 특정 도구를 지정 {"type": "function", "function": {"name": "my_function"}} 하면 모델이 그 도구를 호출하도록 강제합니다. none 도구가 없을 때 기본값입니다. auto 도구가 있으면 기본값입니다.

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

chatCompletionNamedToolChoice

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

함수의 성질

name

ParallelToolCalls

도구 사용 중 병렬 함수 호출을 활성화할지 여부.

이 컴포넌트에 대한 속성이 정의되어 있지 않습니다.

chatCompletionMessageToolCalls

모델이 생성하는 도구 호출, 예를 들어 함수 호출.

이 컴포넌트에 대한 속성이 정의되어 있지 않습니다.

chatCompletionFunctionCall

폐기되고 .로 tool_calls대체됨. 모델이 생성한 함수의 이름과 인자.

completionUsage

완료 요청의 사용 통계.

completion_tokens_details 속성

reasoning_tokens

chatCompletionTool

FunctionParameters

함수들이 받아들이는 매개변수는 JSON 스키마 객체로 설명됩니다. 예제는 가이드와 JSON 스키마 참고 자료를 참고하세요.

생략 parameters 은 빈 매개변수 리스트를 가진 함수를 정의합니다.

이 컴포넌트에 대한 속성이 정의되어 있지 않습니다.

FunctionObject

ResponseFormatText

ResponseFormatJsonObject

ResponseFormatJsonSchemaSchema

응답 형식의 스키마는 JSON 스키마 객체로 설명됩니다.

이 컴포넌트에 대한 속성이 정의되어 있지 않습니다.

ResponseFormatJsonSchema

json_schema 속성

description

name

schema

strict

chatCompletionChoiceCommon

createTranslationRequest

Translation request.

audioResponse

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

audioVerboseResponse

response_format verbose_json 번역 또는 전사 응답

audioResponseFormat

출력 형식을 정의합니다.

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

Type: string

Default:

Enum Values:

• json
• text
• srt
• verbose_json
• vtt

createTranscriptionRequest

Transcription request.

audioSegment

전사 또는 번역 부분.

imageQuality

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

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

Type: string

Default: standard

열구 이름: 품질

Enum Values:

imagesResponseFormat

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

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

Type: string

Default: url

열거 이름: ImagesResponseFormat

Enum Values:

imageSize

생성된 이미지의 크기.

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

Type: string

Default: 1024x1024

열구 이름: 크기

Enum Values:

imageStyle

생성된 이미지의 스타일.

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

Type: string

Default: vivid

열거 이름: 스타일

Enum Values:

imageGenerationsRequest

generateImagesResponse

imageResult

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

Completions extensions

완성 확장은 최신 GA 버전의 Azure OpenAI 데이터 플레인 추론 명세에 포함되어 있지 않습니다.

Chatmessage

채팅 메시지 객체는 최신 GA 버전의 Azure OpenAI 데이터 플레인 추론 명세에 포함되어 있지 않습니다.

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

현재 Azure OpenAI 데이터 평면 추론 명세의 최신 Azure OpenAI GA 버전에는 포함되어 있지 않습니다. 이 기능에 대해서는 최신 preview 버전을 참조하십시오.

Next steps

모델에 대해 배우 고, REST API를 활용한 미세 조정도 알아보세요. OpenAI를 구동하는 기본 모델에 대해 더 알아보세요.