Azure AI Foundry 모델 REST API 참조의 Azure OpenAI

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

API 사양

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

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

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

인증

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/chat/completions?api-version=2024-06-01

데이터 평면 유추

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

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

완료

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

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

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

응답

상태 코드: 200

설명: 정상

상태 코드: 기본값

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

예시

예시

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

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

포함

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

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

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

응답

usage의 속성

프롬프트 토큰

총_토큰

상태 코드: 200

설명: 정상

예시

예시

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

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

채팅 완료

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

채팅 메시지에 대한 완성을 만듭니다.

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

응답

상태 코드: 200

설명: 정상

상태 코드: 기본값

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

예시

예시

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

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

예시

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

예시

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

예시

제공된 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 매개 변수

요청 헤더

요청 본문

콘텐츠 형식: multipart/form-data

응답

상태 코드: 200

설명: 정상

예시

예시

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

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

예시

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

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 매개 변수

요청 헤더

요청 본문

콘텐츠 형식: multipart/form-data

응답

상태 코드: 200

설명: 정상

예시

예시

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

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

예시

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

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

이미지 생성

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

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

URI 매개 변수

요청 헤더

요청 본문

Content-Type: application/json

응답

상태 코드: 200

설명: 정상

상태 코드: 기본값

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

예시

예시

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

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

구성 요소

errorResponse

오류베이스

오류

내부 오류

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

내부 오류 코드

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

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

형식: string

기본값:

열거형 이름: InnerErrorCode

열거형 값:

dalleErrorResponse

dalleError

dalleInnerError

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

contentFilterResultBase

contentFilterSeverityResult

콘텐츠 필터 감지 결과

콘텐츠 필터가 인용 결과와 함께 감지됨

citation의 속성

URL

라이센스

contentFilterResultsBase

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

contentFilterPromptResults

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

콘텐츠 필터 선택 결과

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

promptFilterResult

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

promptFilterResults

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

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

달레 콘텐츠 필터 결과

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

dalleFilterResults

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

chatCompletionsRequestCommon

완료요청생성

완성 응답 생성

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

채팅 완료 요청 생성

채팅완료기능

chatCompletionFunctionCallOption

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

채팅 완료 요청 메시지

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

채팅 완료 요청 시스템 메시지

채팅완료요청사용자메시지

chatCompletionRequestAssistantMessage

function_call에 대한 속성

논쟁들

이름

chatCompletionRequestToolMessage

채팅완성요청기능메시지

채팅 완성 요청 시스템 메시지 콘텐츠 부분

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

채팅완료요청사용자메시지내용부분

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

채팅 완료 요청 어시스턴트 메시지 콘텐츠 부분

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartImage

image_url의 속성

url

세부사항

chatCompletionRequestMessageContentPartRefusal

Azure 채팅 확장 구성

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

azureChatExtensionType

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

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

형식: string

기본값:

열거형 이름: AzureChatExtensionType

열거형 값:

azureSearchChatExtensionConfiguration

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

Azure 검색 채팅 확장 매개변수

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

Azure 검색 인덱스 필드 매핑 옵션

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

Azure 검색 쿼리 유형

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

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

형식: string

기본값:

열거형 이름: azureSearchQueryType

열거형 값:

Azure Cosmos DB 채팅 확장 구성

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

애저코스모스DB챗익스텐션파라미터

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

azureCosmosDB필드매핑옵션

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

onYourDataAuthenticationOptions

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

onYourDataAuthenticationType

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

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

형식: string

기본값:

열거형 이름: OnYourDataAuthenticationType

열거형 값:

onYourDataApiKeyAuthenticationOptions

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

onYourDataConnectionStringAuthenticationOptions

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

onYourDataVectorizationSource

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

onYourDataVectorizationSourceType

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

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

형식: string

기본값:

열거형 이름: OnYourDataVectorizationSourceType

열거형 값:

onYourDataDeploymentNameVectorizationSource

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

onYourDataEndpointVectorizationSource

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

Azure 채팅 확장 메시지 컨텍스트

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

인용

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

chatCompletionMessageToolCall

function의 속성

이름

논쟁들

툴 호출 유형

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

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

형식: string

기본값:

열거형 이름: ToolCallType

열거형 값:

채팅완료요청메시지도구

채팅완료요청메시지함수

createChatCompletionResponse

제공된 입력을 기준으로 모델이 반환한 채팅 완성 응답을 나타냅니다.

createChatCompletionStreamResponse

제공된 입력을 기준으로 모델이 반환한 채팅 완성 응답의 스트리밍된 청크를 나타냅니다.

chatCompletionStreamResponseDelta

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

function_call에 대한 속성

논쟁들

이름

chatCompletionMessageToolCallChunk

function의 속성

이름

논쟁들

chatCompletionStreamOptions

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

chatCompletionChoiceLogProbs

선택 항목에 대한 로그 확률 정보입니다.

chatCompletionTokenLogprob

채팅 완료 응답 메시지

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

chatCompletionResponseMessageRole

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

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

형식: string

기본값:

열거형 값:

• assistant

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

function의 속성

이름

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

completionUsage

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

completion_tokens_details 속성

추론 토큰

chatCompletionTool

함수 매개변수

함수가 허용하는 매개 변수로, JSON 스키마 개체로 설명됩니다. 예를 보려면 가이드를 참조하고, 형식에 대한 설명서는 JSON 스키마 참조를 참조하세요.

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

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

FunctionObject

응답형식텍스트

ResponseFormatJsonObject (응답 형식 JSON 객체)

ResponseFormatJsonSchemaSchema

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

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

응답 형식 JSON 스키마

json_schema에 대한 속성

설명

이름

schema(스키마)

엄격한

chatCompletionChoiceCommon

번역요청생성

번역 요청입니다.

audioResponse

response_format이 json일 때 번역 또는 전사 응답입니다.

audioVerboseResponse

response_format이 verbose_json일 때 번역 또는 전사 응답입니다.

오디오응답형식

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

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

형식: string

기본값:

열거형 값:

• json :
• 문자 메시지
• srt
• verbose_json
• vtt

createTranscriptionRequest

전사 요청입니다.

audioSegment

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

이미지 품질

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

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

형식: string

기본값: standard

열거형 이름: Quality

열거형 값:

이미지응답형식

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

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

형식: string

기본값: url

열거형 이름: ImagesResponseFormat

열거형 값:

이미지 크기

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

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

형식: string

기본값: 1024x1024

열거형 이름: Size

열거형 값:

imageStyle

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

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

형식: string

기본값: vivid

열거형 이름: Style

열거형 값:

이미지 생성 요청

generateImagesResponse

이미지 결과

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

완료 확장

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

채팅 메시지

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

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

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

다음 단계

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