Get Chat Completions - Get Chat Completions

Hizmet:: AI Foundry

API Sürümü:: 2024-05-01-preview

Sağlanan sohbet iletileri için sohbet tamamlamalarını alır. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur. yöntemi, verilen uç noktadaki /chat/completions yoluna bir REST API çağrısı yapar.

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
resource	path	True	string	Azure AI Services kaynak adı, örneğin "my-resource"
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
extra-parameters		ExtraParameters	REST API tarafından tanımlanmamış ek parametreler JSON istek yüküne geçirilirse ne olacağını denetler. Bu, http isteği üst bilgisini `extra-parameters`ayarlar.

İstek Gövdesi

Name	Gerekli	Tür	Description
messages	True	ChatRequestMessage[]: ChatRequestAssistantMessage[] ChatRequestSystemMessage[] ChatRequestToolMessage[] ChatRequestUserMessage[]	Bu sohbet tamamlama isteğiyle ilişkili bağlam iletilerinin koleksiyonu. Tipik kullanım, Sistem rolü için yardımcının davranışına yönelik yönergeler sağlayan bir sohbet iletisi ve ardından Kullanıcı ve Yardımcı rolleri arasında değişen iletiler ile başlar.
frequency_penalty		number (float) minimum: -2 maximum: 2	Oluşturulan belirteçlerin, oluşturulan metindeki kümülatif sıklıklarına göre görünme olasılığını etkileyen bir değer. Pozitif değerler, sıklıkları arttıkça belirteçlerin görünme olasılığını azaltır ve modelin aynı deyimleri tekrarlama olasılığını azaltır. Desteklenen aralık: [-2, 2].
max_tokens		integer (int32) minimum: 0	Oluşturulacak en fazla belirteç sayısı.
modalities		ChatCompletionsModality[]	Modelin sohbet tamamlama yanıtı için kullanmasına izin verilen modaliteler. Varsayılan modalite `text`. Desteklenmeyen bir modalite bileşiminin 422 hatasıyla sonuçlandığını belirtir.
model		string	Uç noktada birden fazla model varsa kullanılacak belirli yapay zeka modelinin kimliği.
presence_penalty		number (float) minimum: -2 maximum: 2	Oluşturulan belirteçlerin, oluşturulan metindeki mevcut durumlarına göre görünme olasılığını etkileyen bir değer. Pozitif değerler, belirteçlerin mevcut olduklarında görünme olasılığını düşürür ve modelin yeni konuların çıkış yapma olasılığını artırır. Desteklenen aralık: [-2, 2].
response_format		ChatCompletionsResponseFormat: ChatCompletionsResponseFormatJsonObject ChatCompletionsResponseFormatJsonSchema ChatCompletionsResponseFormatText	Modelin çıkış yapması gereken biçimi belirten bir nesne. `{ "type": "json_schema", "json_schema": {...} }` ayarı, modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. `{ "type": "json_object" }` ayarı, modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan JSON modunu etkinleştirir. Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, `finish_reason="length"`, neslin `max_tokens` aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını gösteren ileti içeriğinin kısmen kesilebileceğini unutmayın.
seed		integer (int64)	Belirtilirse sistem, aynı tohuma ve parametrelere sahip yinelenen isteklerin aynı sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir.
stop		string[]	Tamamlamaların oluşturulmasını sonlandıracak metin dizileri koleksiyonu.
stream		boolean	Bu istek için sohbet tamamlamalarının akışla aktarılıp aktarılmayacağını belirten bir değer.
temperature		number (float) minimum: 0 maximum: 1	Oluşturulan tamamlamaların görünür yaratıcılığını kontrol eden kullanılacak örnekleme sıcaklığı. Daha yüksek değerler çıkışı daha rastgele hale getirirken, düşük değerler sonuçları daha odaklanmış ve belirleyici hale getirir. Bu iki ayarın etkileşimini tahmin etmek zor olduğundan, aynı tamamlama isteği için sıcaklık ve top_p değiştirilmesi önerilmez. Desteklenen aralık: [0, 1].
tool_choice			Belirtilirse model, sohbet tamamlama yanıtı için sağlanan araçlardan hangilerini kullanabileceğini yapılandıracaktır.
tools		ChatCompletionsToolDefinition[]	Modelin çağırmak isteyebileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Model bir işlev çağrısı isteğiyle yanıt verebilir ve bu işlev için JSON biçiminde giriş bağımsız değişkenlerini sağlayabilir.
top_p		number (float) minimum: 0 maximum: 1	Çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye bir alternatif. Bu değer, modelin sağlanan olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate almasına neden olur. Örneğin, 0,15 değeri yalnızca olasılık kütlesinin ilk 15% oluşan belirteçlerin dikkate alınmasına neden olur. Bu iki ayarın etkileşimini tahmin etmek zor olduğundan, aynı tamamlama isteği için sıcaklık ve top_p değiştirilmesi önerilmez. Desteklenen aralık: [0, 1].

Yanıtlar

Name	Tür	Description
200 OK	ChatCompletions	İstek başarılı oldu.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Name

Tür

Description

200 OK

ChatCompletions

İstek başarılı oldu.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Beklenmeyen bir hata yanıtı.

Üst Bilgiler

x-ms-error-code: string

Güvenlik

api-key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name	Description
https://cognitiveservices.azure.com/.default

Örnekler

Audio modality chat completion

maximum set chat completion

minimum set chat completion

Audio modality chat completion

Örnek isteği

HTTP

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text",
    "audio"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    },
    {
      "role": "assistant",
      "content": null,
      "audio": {
        "id": "abcdef1234"
      }
    },
    {
      "role": "user",
      "content": [
        {
          "type": "input_audio",
          "input_audio": {
            "data": "<base64 encoded audio data>",
            "format": "wav"
          }
        }
      ]
    }
  ],
  "frequency_penalty": 0,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "seed": 21,
  "model": "my-model-name"
}

Örnek yanıt

Durum kodu:: 200

{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1696522361,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16,
    "completion_tokens_details": {
      "audio_tokens": 5,
      "total_tokens": 5
    },
    "prompt_tokens_details": {
      "audio_tokens": 10,
      "cached_tokens": 0
    }
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": null,
        "audio": {
          "id": "abcdef1234",
          "format": "wav",
          "data": "<base64 encoded audio data>",
          "expires_at": 1896522361,
          "transcript": "This is a sample transcript"
        }
      }
    }
  ]
}

maximum set chat completion

Örnek isteği

HTTP

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview


{
  "modalities": [
    "text"
  ],
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant"
    },
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    },
    {
      "role": "assistant",
      "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594."
    },
    {
      "role": "user",
      "content": "Ist it proved?"
    }
  ],
  "frequency_penalty": 0,
  "stream": true,
  "presence_penalty": 0,
  "temperature": 0,
  "top_p": 0,
  "max_tokens": 255,
  "response_format": {
    "type": "text"
  },
  "stop": [
    "<|endoftext|>"
  ],
  "tools": [
    {
      "type": "function",
      "function": {
        "name": "my-function-name",
        "description": "A function useful to know if a theroem is proved or not"
      }
    }
  ],
  "seed": 21,
  "model": "my-model-name"
}

Örnek yanıt

Durum kodu:: 200

{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 18,
  "model": "my-model-name",
  "usage": {
    "completion_tokens": 19,
    "prompt_tokens": 28,
    "total_tokens": 16
  },
  "choices": [
    {
      "index": 7,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": null,
        "tool_calls": [
          {
            "id": "yrobmilsrugmbwukmzo",
            "type": "function",
            "function": {
              "name": "my-function-name",
              "arguments": "{ \"arg1\": \"value1\", \"arg2\": \"value2\" }"
            }
          }
        ]
      }
    }
  ]
}

minimum set chat completion

Örnek isteği

HTTP

POST https://{resource}.services.ai.azure.com/models/chat/completions?api-version=2024-05-01-preview

{
  "messages": [
    {
      "role": "user",
      "content": "Explain Riemann's conjecture"
    }
  ]
}

Örnek yanıt

Durum kodu:: 200

{
  "id": "kgousajxgzyhugvqekuswuqbk",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "my-model-name",
  "usage": {
    "prompt_tokens": 205,
    "completion_tokens": 5,
    "total_tokens": 210
  },
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "The Riemann Conjecture is a deep mathematical conjecture around prime numbers and how they can be predicted. It was first published in Riemann's groundbreaking 1859 paper. The conjecture states that the Riemann zeta function has its zeros only at the negative even integers and complex numbers with real part 1/21. Many consider it to be the most important unsolved problem in pure mathematics. The Riemann hypothesis is a way to predict the probability that numbers in a certain range are prime that was also devised by German mathematician Bernhard Riemann in 18594"
      }
    }
  ]
}

Tanımlar

Name	Description
AudioContentFormat	Ses için olası ses biçimlerinin gösterimi.
Azure.Core.Foundations.Error	Hata nesnesi.
Azure.Core.Foundations.ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
Azure.Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.
ChatChoice	Genel sohbet tamamlama isteğinin bir parçası olarak tek bir istem tamamlamanın gösterimi. Genel olarak, `n` seçenekler sağlanan komut istemi başına varsayılan değer olan 1 ile oluşturulur. Belirteç sınırları ve diğer ayarlar, oluşturulan seçenek sayısını sınırlayabilir.
ChatCompletions	Sohbet tamamlama isteğinden gelen yanıt verilerinin gösterimi. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.
ChatCompletionsAudio	Model tarafından oluşturulan sesin gösterimi.
ChatCompletionsModality	Modelin sohbet tamamlama yanıtı için kullanmasına izin verilen modaliteler.
ChatCompletionsOptions	Sohbet tamamlama isteği için yapılandırma bilgileri. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.
ChatCompletionsResponseFormatJsonObject	Yanıtları geçerli JSON nesneleri yaymaya kısıtlayan Sohbet Tamamlamaları için bir yanıt biçimi. JSON modunu etkinleştirmek için bazı yapay zeka modellerinin modele bir sistem veya kullanıcı iletisi aracılığıyla JSON üretmesi için talimat vermenizi de gerektirebileceğini unutmayın.
ChatCompletionsResponseFormatJsonSchema	Çağıran tarafından belirtilen bir JSON şemasıyla yanıtları geçerli JSON nesneleri yaymaya kısıtlayan Sohbet Tamamlamaları için bir yanıt biçimi.
ChatCompletionsResponseFormatJsonSchemaDefinition	Yanıtta gerekli JSON şemasının tanımı ve ilişkili meta veriler.
ChatCompletionsResponseFormatText	Metin yanıtları yayan Sohbet Tamamlamaları için bir yanıt biçimi. Bu, varsayılan yanıt biçimidir.
ChatCompletionsToolCall	Yapay zeka modeli tarafından istenen bir işlev aracı çağrısı.
ChatCompletionsToolDefinition	bir işlevi çağırabilen sohbet tamamlama aracının tanımı.
ChatRequestAssistantMessage	Yardımcıdan gelen yanıtı veya eylemi temsil eden bir istek sohbeti iletisi.
ChatRequestAudioReference	Model tarafından oluşturulan bir ses yanıtına başvuru.
ChatRequestSystemMessage	Modelin sohbet tamamlama yanıtı oluşturma şeklini etkileyen sistem yönergelerini içeren bir istek sohbeti iletisi.
ChatRequestToolMessage	Yapılandırılmış bir araçtan istenen çıkışı temsil eden bir istek sohbeti iletisi.
ChatRequestUserMessage	Yardımcıya kullanıcı girişini temsil eden bir istek sohbeti iletisi.
ChatResponseMessage	Bir yanıtta alınan sohbet iletisinin gösterimi.
ChatRole	Sohbet tamamlama etkileşimi içindeki bir iletinin hedeflenen amacının açıklaması.
CompletionsFinishReason	Tamamlanma yanıtının nasıl sonuçlandığının gösterimi.
CompletionsUsage	Tamamlanma isteği için işlenen belirteç sayılarının gösterimi. Sayımlar istemler, seçimler, seçim alternatifleri, best_of nesiller ve diğer tüketiciler arasındaki tüm belirteçleri dikkate alır.
CompletionsUsageDetails	Tamamlanmada kullanılan belirteçlerin dökümü.
ExtraParameters	REST API tarafından tanımlanmamış ek parametreler JSON istek yüküne geçirilirse ne olacağını denetler.
FunctionCall	Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.
FunctionDefinition	Sohbet tamamlamalarının eşleşen kullanıcı girişine yanıt olarak çağırabileceği arayan tarafından belirtilen işlevin tanımı.
PromptUsageDetails	İstem/sohbet geçmişinde kullanılan belirteçlerin dökümü.

AudioContentFormat

Listeleme

Ses için olası ses biçimlerinin gösterimi.

Değer	Description
wav	SESI WAV biçiminde belirtir.
mp3	Sesi MP3 biçiminde belirtir.

Azure.Core.Foundations.Error

Object

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Object

Hata ayrıntılarını içeren bir yanıt.

Name	Tür	Description
error	Azure.Core.Foundations.Error	Hata nesnesi.

Azure.Core.Foundations.InnerError

Object

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Azure REST API yönergelerine göre - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.

ChatChoice

Object

Genel sohbet tamamlama isteğinin bir parçası olarak tek bir istem tamamlamanın gösterimi. Genel olarak, n seçenekler sağlanan komut istemi başına varsayılan değer olan 1 ile oluşturulur. Belirteç sınırları ve diğer ayarlar, oluşturulan seçenek sayısını sınırlayabilir.

Name	Tür	Description
finish_reason	CompletionsFinishReason	Bu sohbet tamamlama seçiminin oluşturulmasının nedeni.
index	integer (int32)	Bu sohbet tamamlama seçeneğiyle ilişkili sıralı dizin.
message	ChatResponseMessage	Belirli bir sohbet tamamlama istemi için sohbet iletisi.

ChatCompletions

Object

Sohbet tamamlama isteğinden gelen yanıt verilerinin gösterimi. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.

Name	Tür	Description
choices	ChatChoice[]	Bu tamamlama yanıtıyla ilişkili tamamlama seçimlerinin koleksiyonu. Genel olarak, `n` seçenekler sağlanan komut istemi başına varsayılan değer olan 1 ile oluşturulur. Belirteç sınırları ve diğer ayarlar, oluşturulan seçenek sayısını sınırlayabilir.
created	integer (unixtime)	1 Ocak 1970 tarihinde 00:00 Unix döneminin başlangıcından bu yana saniye olarak temsil edilen bu tamamlama yanıtı için oluşturma etkinliğiyle ilişkili ilk zaman damgası.
id	string	Bu sohbet tamamlama yanıtıyla ilişkilendirilmiş benzersiz bir tanımlayıcı.
model	string	Sohbetin tamamlanması için kullanılan model.
object	enum: chat.completion	Her zaman `chat.completion`yanıt nesnesi türü.
usage	CompletionsUsage	Bu tamamlama işleminin bir parçası olarak işlenen ve oluşturulan belirteçler için kullanım bilgileri.

ChatCompletionsAudio

Object

Model tarafından oluşturulan sesin gösterimi.

Name	Tür	Description
data	string	Base64 kodlanmış ses verileri
expires_at	integer (unixtime)	Ses parçasının süresinin dolacağı unix zaman damgası (saniye olarak) ve çok aşamalı konuşmalarda artık kimliği tarafından başvurulamaz.
format	AudioContentFormat	Ses içeriğinin biçimi. Biçim sağlanmazsa, giriş ses isteğinde kullanılan biçimle eşleşecektir.
id	string	Ses yanıtı için benzersiz tanımlayıcı. Bu değer, tam ses nesnesini geçirmek yerine sohbet geçmişi iletilerinde kullanılabilir.
transcript	string	Ses dosyasının dökümü.

ChatCompletionsModality

Listeleme

Modelin sohbet tamamlama yanıtı için kullanmasına izin verilen modaliteler.

Değer	Description
text	Modelin yalnızca metin oluşturmasına izin verilir.
audio	Modelin ses oluşturmasına izin verilir.

ChatCompletionsOptions

Object

Sohbet tamamlama isteği için yapılandırma bilgileri. Tamamlamalar çok çeşitli görevleri destekler ve sağlanan istem verilerinden devam eden veya "tamamlayan" metinler oluşturur.

Name	Tür	Default value	Description
frequency_penalty	number (float) minimum: -2 maximum: 2	0	Oluşturulan belirteçlerin, oluşturulan metindeki kümülatif sıklıklarına göre görünme olasılığını etkileyen bir değer. Pozitif değerler, sıklıkları arttıkça belirteçlerin görünme olasılığını azaltır ve modelin aynı deyimleri tekrarlama olasılığını azaltır. Desteklenen aralık: [-2, 2].
max_tokens	integer (int32) minimum: 0		Oluşturulacak en fazla belirteç sayısı.
messages	ChatRequestMessage[]: ChatRequestAssistantMessage[] ChatRequestSystemMessage[] ChatRequestToolMessage[] ChatRequestUserMessage[]		Bu sohbet tamamlama isteğiyle ilişkili bağlam iletilerinin koleksiyonu. Tipik kullanım, Sistem rolü için yardımcının davranışına yönelik yönergeler sağlayan bir sohbet iletisi ve ardından Kullanıcı ve Yardımcı rolleri arasında değişen iletiler ile başlar.
modalities	ChatCompletionsModality[]		Modelin sohbet tamamlama yanıtı için kullanmasına izin verilen modaliteler. Varsayılan modalite `text`. Desteklenmeyen bir modalite bileşiminin 422 hatasıyla sonuçlandığını belirtir.
model	string		Uç noktada birden fazla model varsa kullanılacak belirli yapay zeka modelinin kimliği.
presence_penalty	number (float) minimum: -2 maximum: 2	0	Oluşturulan belirteçlerin, oluşturulan metindeki mevcut durumlarına göre görünme olasılığını etkileyen bir değer. Pozitif değerler, belirteçlerin mevcut olduklarında görünme olasılığını düşürür ve modelin yeni konuların çıkış yapma olasılığını artırır. Desteklenen aralık: [-2, 2].
response_format	ChatCompletionsResponseFormat: ChatCompletionsResponseFormatJsonObject ChatCompletionsResponseFormatJsonSchema ChatCompletionsResponseFormatText		Modelin çıkış yapması gereken biçimi belirten bir nesne. `{ "type": "json_schema", "json_schema": {...} }` ayarı, modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. `{ "type": "json_object" }` ayarı, modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan JSON modunu etkinleştirir. Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, `finish_reason="length"`, neslin `max_tokens` aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını gösteren ileti içeriğinin kısmen kesilebileceğini unutmayın.
seed	integer (int64)		Belirtilirse sistem, aynı tohuma ve parametrelere sahip yinelenen isteklerin aynı sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir.
stop	string[]		Tamamlamaların oluşturulmasını sonlandıracak metin dizileri koleksiyonu.
stream	boolean		Bu istek için sohbet tamamlamalarının akışla aktarılıp aktarılmayacağını belirten bir değer.
temperature	number (float) minimum: 0 maximum: 1	0.7	Oluşturulan tamamlamaların görünür yaratıcılığını kontrol eden kullanılacak örnekleme sıcaklığı. Daha yüksek değerler çıkışı daha rastgele hale getirirken, düşük değerler sonuçları daha odaklanmış ve belirleyici hale getirir. Bu iki ayarın etkileşimini tahmin etmek zor olduğundan, aynı tamamlama isteği için sıcaklık ve top_p değiştirilmesi önerilmez. Desteklenen aralık: [0, 1].
tool_choice			Belirtilirse model, sohbet tamamlama yanıtı için sağlanan araçlardan hangilerini kullanabileceğini yapılandıracaktır.
tools	ChatCompletionsToolDefinition[]		Modelin çağırmak isteyebileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Model bir işlev çağrısı isteğiyle yanıt verebilir ve bu işlev için JSON biçiminde giriş bağımsız değişkenlerini sağlayabilir.
top_p	number (float) minimum: 0 maximum: 1	1	Çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye bir alternatif. Bu değer, modelin sağlanan olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate almasına neden olur. Örneğin, 0,15 değeri yalnızca olasılık kütlesinin ilk 15% oluşan belirteçlerin dikkate alınmasına neden olur. Bu iki ayarın etkileşimini tahmin etmek zor olduğundan, aynı tamamlama isteği için sıcaklık ve top_p değiştirilmesi önerilmez. Desteklenen aralık: [0, 1].

ChatCompletionsResponseFormatJsonObject

Object

Yanıtları geçerli JSON nesneleri yaymaya kısıtlayan Sohbet Tamamlamaları için bir yanıt biçimi. JSON modunu etkinleştirmek için bazı yapay zeka modellerinin modele bir sistem veya kullanıcı iletisi aracılığıyla JSON üretmesi için talimat vermenizi de gerektirebileceğini unutmayın.

Name	Tür	Description
type	string: json_object	Sohbet tamamlamaları için kullanılacak yanıt biçimi türü.

ChatCompletionsResponseFormatJsonSchema

Object

Çağıran tarafından belirtilen bir JSON şemasıyla yanıtları geçerli JSON nesneleri yaymaya kısıtlayan Sohbet Tamamlamaları için bir yanıt biçimi.

Name	Tür	Description
json_schema	ChatCompletionsResponseFormatJsonSchemaDefinition	Yanıtta gerekli JSON şemasının tanımı ve ilişkili meta veriler.
type	string: json_schema	Sohbet tamamlamaları için kullanılacak yanıt biçimi türü.

ChatCompletionsResponseFormatJsonSchemaDefinition

Object

Yanıtta gerekli JSON şemasının tanımı ve ilişkili meta veriler.

Name	Tür	Default value	Description
description	string		Bu biçimde yanıtların nasıl oluşturulacağı konusunda yapay zeka modeli tarafından kullanılan yanıt biçiminin açıklaması.
name	string		Yanıt biçiminin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.
schema			JSON şemasının tanımı
strict	boolean	False	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman `schema` alanında tanımlanan tam şemayı izler. `strict` `true`olduğunda yalnızca bir JSON Şeması alt kümesi desteklenir.

ChatCompletionsResponseFormatText

Object

Metin yanıtları yayan Sohbet Tamamlamaları için bir yanıt biçimi. Bu, varsayılan yanıt biçimidir.

Name	Tür	Description
type	string: text	Sohbet tamamlamaları için kullanılacak yanıt biçimi türü.

ChatCompletionsToolCall

Object

Yapay zeka modeli tarafından istenen bir işlev aracı çağrısı.

Name	Tür	Description
function	FunctionCall	Yapay zeka modeli tarafından istenen işlev çağrısının ayrıntıları.
id	string	Araç çağrısının kimliği.
type	enum: function	Araç çağrısının türü. Şu anda yalnızca `function` desteklenir.

ChatCompletionsToolDefinition

Object

bir işlevi çağırabilen sohbet tamamlama aracının tanımı.

Name	Tür	Description
function	FunctionDefinition	İşlev aracının işlev tanımı ayrıntıları.
type	enum: function	Aracın türü. Şu anda yalnızca `function` desteklenir.

ChatRequestAssistantMessage

Object

Yardımcıdan gelen yanıtı veya eylemi temsil eden bir istek sohbeti iletisi.

Name	Tür	Description
audio	ChatRequestAudioReference	Çok aşamalı konuşmada önceki bir yanıt tarafından oluşturulan ses.
content	string	İletinin içeriği.
role	string: assistant	Bu iletiyle ilişkili sohbet rolü.
tool_calls	ChatCompletionsToolCall[]	Araç, çözümlenmesi gereken çağrıları ve sohbet tamamlama isteğinin yapılandırıldığı şekilde çözümlenmesi için çıkışlarının sonraki giriş iletilerine eklenmesini sağlar.

ChatRequestAudioReference

Object

Model tarafından oluşturulan bir ses yanıtına başvuru.

Name	Tür	Description
id	string	Ses yanıtı için benzersiz tanımlayıcı. Bu değer, önceki bir ses tamamlamanın kimliğine karşılık gelir.

ChatRequestSystemMessage

Object

Modelin sohbet tamamlama yanıtı oluşturma şeklini etkileyen sistem yönergelerini içeren bir istek sohbeti iletisi.

Name	Tür	Description
content	string	Sistem iletisinin içeriği.
role	string: system	Bu iletiyle ilişkili sohbet rolü.

ChatRequestToolMessage

Object

Yapılandırılmış bir araçtan istenen çıkışı temsil eden bir istek sohbeti iletisi.

Name	Tür	Description
content	string	İletinin içeriği.
role	string: tool	Bu iletiyle ilişkili sohbet rolü.
tool_call_id	string	Sağlanan içerik tarafından çözümlenen araç çağrısının kimliği.

ChatRequestUserMessage

Object

Yardımcıya kullanıcı girişini temsil eden bir istek sohbeti iletisi.

Name	Tür	Description
content		Seçilen modele göre değişen kullanılabilir giriş türlerine sahip kullanıcı iletisinin içeriği.
role	string: user	Bu iletiyle ilişkili sohbet rolü.

ChatResponseMessage

Object

Bir yanıtta alınan sohbet iletisinin gösterimi.

Name	Tür	Description
audio	ChatCompletionsAudio	Model ses oluşturmak üzere yapılandırılmışsa, model tarafından iletilere yanıt olarak oluşturulan ses.
content	string	İletinin içeriği.
role	ChatRole	İletiyle ilişkili sohbet rolü.
tool_calls	ChatCompletionsToolCall[]	Araç, çözümlenmesi gereken çağrıları ve sohbet tamamlama isteğinin yapılandırıldığı şekilde çözümlenmesi için çıkışlarının sonraki giriş iletilerine eklenmesini sağlar.

ChatRole

Listeleme

Sohbet tamamlama etkileşimi içindeki bir iletinin hedeflenen amacının açıklaması.

Değer	Description
system	Yardımcının davranışını belirten veya ayarlayan rol.
developer	Modele kullanıcı iletilerinden önce önceliklendirilmiş yönergeler sağlayan rol.
user	Sohbet tamamlamaları için giriş sağlayan rol.
assistant	Sistem tarafından yönergeli, kullanıcı tarafından istemli girişe yanıt sağlayan rol.
tool	Sohbet tamamlama işlemi içindeki uzantı aracı etkinliğini temsil eden rol.

CompletionsFinishReason

Listeleme

Tamamlanma yanıtının nasıl sonuçlandığının gösterimi.

Değer	Description
stop	Tamamlamalar normal şekilde sona erdi ve belirteç oluşturma sonuna ulaştı.
length	Tamamlamalar, oluşturma tamamlanmadan önce kullanılabilir belirteç sınırlarını tüketti.
content_filter	Tamamlamalar, içerik denetleme ilkeleri başına hassas olabilecek bir yanıt oluşturdu.
tool_calls	Tamamlama, modelin çıkış için sağlanan bir aracı çağırmasıyla sona erdi.

CompletionsUsage

Object

Tamamlanma isteği için işlenen belirteç sayılarının gösterimi. Sayımlar istemler, seçimler, seçim alternatifleri, best_of nesiller ve diğer tüketiciler arasındaki tüm belirteçleri dikkate alır.

Name	Tür	Description
completion_tokens	integer (int32)	Tüm tamamlama emisyonlarında oluşturulan belirteç sayısı.
completion_tokens_details	CompletionsUsageDetails	Tamamlanmada kullanılan belirteçlerin dökümü.
prompt_tokens	integer (int32)	Sağlanan istemlerdeki belirteç sayısı, tamamlanma isteği için kullanılır.
prompt_tokens_details	PromptUsageDetails	İstem/sohbet geçmişinde kullanılan belirteçlerin dökümü.
total_tokens	integer (int32)	Tamamlanma isteği ve yanıtı için işlenen toplam belirteç sayısı.

CompletionsUsageDetails

Object

Tamamlanmada kullanılan belirteçlerin dökümü.

Name	Tür	Description
audio_tokens	integer (int32)	Ses girişine karşılık gelen belirteçlerin sayısı.
total_tokens	integer (int32)	Tamamlanma isteği ve yanıtı için işlenen toplam belirteç sayısı.

ExtraParameters

Listeleme

REST API tarafından tanımlanmamış ek parametreler JSON istek yüküne geçirilirse ne olacağını denetler.

Değer	Description
error	hizmet, istek yükünde ek parametreler algılarsa hata döndürür. Bu, hizmet varsayılanıdır.
drop	Hizmet, istek yükündeki ek parametreleri yoksayar (bırakır). Yalnızca bilinen parametreleri arka uç yapay zeka modeline geçirir.
pass-through	Hizmet, arka uç yapay zeka modeline ek parametreler geçirir.

FunctionCall

Object

Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.

Name	Tür	Description
arguments	string	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.
name	string	Çağrılacak işlevin adı.

FunctionDefinition

Object

Sohbet tamamlamalarının eşleşen kullanıcı girişine yanıt olarak çağırabileceği arayan tarafından belirtilen işlevin tanımı.

Name	Tür	Description
description	string	İşlevin ne yaptığının açıklaması. Model, işlevi seçip parametrelerini yorumlarken bu açıklamayı kullanır.
name	string	Çağrılacak işlevin adı.
parameters		İşlevin kabullediği ve JSON Şeması nesnesi olarak tanımlanan parametreler.

PromptUsageDetails

Object

İstem/sohbet geçmişinde kullanılan belirteçlerin dökümü.

Name	Tür	Description
audio_tokens	integer (int32)	Ses girişine karşılık gelen belirteçlerin sayısı.
cached_tokens	integer (int32)	Önbelleğe alınan toplam belirteç sayısı.

Aracılığıyla paylaş

Get Chat Completions - Get Chat Completions

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

api-key

OAuth2Auth

Kapsamlar

Örnekler

Audio modality chat completion

Örnek isteği

Örnek yanıt

maximum set chat completion

Örnek isteği

Örnek yanıt

minimum set chat completion

Örnek isteği

Örnek yanıt

Tanımlar

AudioContentFormat

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

ChatChoice

ChatCompletions

ChatCompletionsAudio

ChatCompletionsModality

ChatCompletionsOptions

ChatCompletionsResponseFormatJsonObject

ChatCompletionsResponseFormatJsonSchema

ChatCompletionsResponseFormatJsonSchemaDefinition

ChatCompletionsResponseFormatText

ChatCompletionsToolCall

ChatCompletionsToolDefinition

ChatRequestAssistantMessage

ChatRequestAudioReference

ChatRequestSystemMessage

ChatRequestToolMessage

ChatRequestUserMessage

ChatResponseMessage

ChatRole

CompletionsFinishReason

CompletionsUsage

CompletionsUsageDetails

ExtraParameters

FunctionCall

FunctionDefinition

PromptUsageDetails