Azure OpenAI in Microsoft Foundry Models REST API reference (classic)

Şu anda görüntüleniyor:Dökümhane (klasik) portal sürümü - Yeni Foundry portalının sürümüne geçme

Note

Bu makaledeki bağlantılar, şu anda görüntülediğiniz Dökümhane (klasik) belgeleri yerine yeni Microsoft Foundry belgelerinde içerik açabilir.

Bu makale, Azure OpenAI için çıkarım REST API uç noktaları hakkında detaylar sunmaktadır.

API specs

Azure OpenAI modelleri ve kaynaklarıyla yönetmek ve etkileşim üç ana API yüzeyine bölünmüştür:

Control plane
Veri düzlemi - yazarlık
Veri düzlemi - çıkarım

Her API yüzeyi/spesifikasyonu, farklı bir Azure OpenAI yetenekleri setini kapsar. Her API'nin kendine özgü önizleme ve kararlı/genel erişilebilir (GA) API sürümleri vardır. Şu anda ön izleme sürümleri genellikle aylık bir ritm izlemektedir.

Important

Şimdi yeni bir önizleme çıkarımı API'si var. API yaşam döngüsü rehberimizde daha fazla bilgi edinin.

API	En son önizleme sürümü	Son GA sürümü	Specifications	Description
Control plane	`2025-07-01-preview`	`2025-06-01`	Spec files	Kontrol düzlemi API, kaynak oluşturma, model dağıtımı ve diğer üst düzey kaynak yönetimi görevleri gibi işlemler için kullanılır. Kontrol düzlemi ayrıca Azure Resource Manager, Bicep, Terraform ve Azure CLI gibi yeteneklerle neler yapılabileceğini de yönetir.
Data plane	`v1 preview`	`v1`	Spec files	Veri düzlemi API, çıkarım ve yazarlık işlemlerini kontrol eder.

Authentication

Azure OpenAI, kimlik doğrulama için iki yöntem sunar. API Anahtarları veya Microsoft Entra ID'si kullanabilirsiniz.

API Anahtarı Doğrulama: Bu tür kimlik doğrulama için, tüm API talepleri HTTP başlığında API Anahtarını api-key içermelidir. Quickstart, bu tür kimlik doğrulama ile aramaların nasıl yapılacağına dair rehberlik sağlar.
Microsoft Entra ID kimlik doğrulama: Bir Microsoft Entra token kullanarak API çağrısını kimlik doğrulaması yapabilirsiniz. Kimlik doğrulama tokenları, bir talebe başlık Authorization olarak dahil edilir. Sağlanan belirteç, örneğin , ile gelmelidirBearerBearer YOUR_AUTH_TOKEN. Microsoft Entra ID<doğrulama rehberimizi okuyabilirsiniz>.

REST API sürümleme

Servis API'leri sorgu parametresi kullanılarak api-version versiyonlandırılır. Tüm sürümler YYYY-MM-DD tarih yapısını takip eder. For example:

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

Veri düzlemi çıkarımı

Makalenin geri kalanı ise Azure OpenAI veri düzlemi çıkarım spesifikasyonunun GA sürümünü 2024-10-21 kapsar.

En son önizleme API sürümüyle ilgili dokümantasyon arıyorsanız, en son önizleme veri düzlemi çıkarım API'sine bakabilirsiniz

Completions

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

Verilen prompt, parametreler ve seçilen model için bir tamamlama oluşturur.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Dağıtılan modelin dağıtım kimliği.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Azure OpenAI API anahtarını buradan paylaşın

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
prompt	dizi veya dizi	Tamamlama üretme için yönlendirmeler, bir dize, dizi dizisi, token dizisi veya token dizileri dizisi olarak kodlanmıştır. <\|endoftext\|>, modelin eğitim sırasında gördüğü belge ayırıcısıdır, bu yüzden bir istek belirtilmezse, model yeni bir belgenin başından geliyormuş gibi üretir.	Yes
best_of	integer	Sunucu tarafında tamamlamaları üretir `best_of` ve "en iyisi" (her token başına en yüksek log olasılığına sahip olan) döndürür. Sonuçlar yayınlanamaz. ile kullanıldığında `n`, `best_of` aday tamamlama sayısını kontrol eder ve `n` kaç tane döndürüleceğini belirtir â€" `best_of` ile daha büyük `n`olmalıdır. Not: Bu parametre çok sayıda tamamlama yarattığı için token kotanızı hızla tüketebilir. Dikkatli kullanın ve makul ayarlarınız `max_tokens` olduğundan emin olun.`stop`	No	1
echo	boolean	Tamamlamanın yanı sıra promptu tekrar tekrar et.	No	False
frequency_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları metindeki mevcut sıklıklarına göre cezalandırır ve modelin aynı satırı kelimesi kelimesine tekrarlama olasılığını azaltır.	No	0
logit_bias	object	Belirtilen tokenların tamamlanma sırasında görünme olasılığını değiştirin. GPT tokenizer'da token ID'leriyle belirtilen tokenları -100'den 100'e kadar ilişkili bir önyargı değerine eşleyen bir JSON nesnesini kabul eder. Matematiksel olarak, önyargı, örnekleme öncesinde model tarafından üretilen logitlere eklenir. Kesin etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalı; -100 veya 100 gibi değerler, ilgili tokenın yasaklanmasına veya özel seçilmesine yol açmalıdır. Örneğin, \|endoftext\|> token'ının oluşturulmasını önlemek <için geçiş `{"50256": -100}` yapabilirsiniz.	No	None
logprobs	integer	En muhtemel çıkış tokenlarındaki log olasılıklarını `logprobs` ve seçilen tokenları ekleyin. Örneğin, `logprobs` 5 ise, API en olası beş tokenın listesini döndürür. API her zaman örneklenen token'ın değerini `logprob` döndürür, bu yüzden yanıtta en `logprobs+1` fazla öğe olabilir. Maksimum değer 5'tir `logprobs` .	No	None
max_tokens	integer	Tamamlanma sırasında üretilebilecek maksimum token sayısı. İsterinizin token sayısı `max_tokens` modelin bağlam uzunluğunu aşamaz.	No	16
n	integer	Her prompt için kaç tane tamamlama üretileceği. Not: Bu parametre çok sayıda tamamlama yarattığı için token kotanızı hızla tüketebilir. Dikkatli kullanın ve makul ayarlarınız `max_tokens` olduğundan emin olun.`stop`	No	1
presence_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları şu ana kadar metinde yer alıp görünmediklerine göre cezalandırıyor ve bu da modelin yeni konular hakkında konuşma olasılığını artırıyor.	No	0
seed	integer	Belirtilirse, sistemimiz deterministik örnekleme için en iyi çabayı gösterir; böylece aynı `seed` ve parametreli tekrarlanan talepler aynı sonucu vermelidir. Determinizm garanti değildir ve arka uçtaki değişiklikleri izlemek için yanıt `system_fingerprint` parametresine başvurmalısınız.	No
stop	dizi veya dizi	API'nin daha fazla token üretmeyi durduracağı dört diziye kadar. Geri dönen metin durma dizisini içermez.	No
stream	boolean	Kısmi ilerlemeyi geri akıp gönderip geri göndermeme. Ayarlanırsa, tokenlar kullanılabilir olduklarında sadece veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` mesajla sonlandırılır.	No	False
suffix	string	Eklenen metin tamamlandıktan sonra gelen ek. Bu parametre yalnızca için `gpt-3.5-turbo-instruct`desteklenir.	No	None
temperature	number	Hangi örnekleme sıcaklığını kullanacağım, 0 ile 2 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. Genellikle bunu değiştirmenizi ya da `top_p` ikisini birden değiştirmenizi öneririz.	No	1
top_p	number	Sıcaklıkla örnekleme alternatifi olan çekirdek örnekleme denir; model, top_p olasılık kütlesine sahip tokenların sonuçlarını dikkate alır. Yani 0.1, yalnızca en üst 10% olasılık kütlesini oluşturan jetonların dikkate alındığı anlamına gelir. Genellikle bunu değiştirmenizi ya da `temperature` ikisini birden değiştirmenizi öneririz.	No	1
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No

Responses

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	createCompletionResponse	API'den gelen bir tamamlanma yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli taşır (sohbet uç noktasının aksine).

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

Verilen prompt, parametreler ve seçilen model için bir tamamlama oluşturur.

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
}

Yanıtlar: Durum Kodu: 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

Makine öğrenimi modelleri ve algoritmaları tarafından kolayca tüketilebilecek verilen bir girdinin vektör temsili alın.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). 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 anahtarını buradan paylaşın

Request Body

Content-Type: application/json

Name	Type	Description	Required
input	dizi veya dizi	Metni gömmek için girin, bir dizi veya belirtetör dizisi olarak kodlanmıştır. Tek bir isteğe birden fazla girdi gömmek için, bir dizi dizi veya token dizileri ile geçin. Girdi, model için maksimum giriş tokenlarını (8.192 token için `text-embedding-ada-002`) aşmamalıdır, boş bir dizi olamaz ve herhangi bir dizi 2.048 boyut veya daha az olmalıdır.	Yes
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, bu da kötüye kullanımın izlenmesine ve algılanmasına yardımcı olabilir.	No
input_type	string	Kullanılacak gömme arama girdi türü	No
encoding_format	string	Gömülerin geri dönmesi için kullanılan format. Bunlardan biri `float` olabilir.`base64` Varsayılan olarak .`float`	No
dimensions	integer	Ortaya çıkan çıktı gömmelerinin sahip olması gereken boyut sayısı. Sadece dahilinde `text-embedding-3` ve sonraki modellerde destekleniyor.	No

Responses

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

Kullanım için özellikler

prompt_tokens

Name	Type	Description	Default
prompt_tokens	integer

total_tokens

Name	Type	Description	Default
total_tokens	integer

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	object

Examples

Example

Verilen bir prompt için gömülemeleri geri döndür.

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

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

Yanıtlar: Durum Kodu: 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

Sohbet mesajı için bir tamamlanma yaratır

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Dağıtılan modelin dağıtım kimliği.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Azure OpenAI API anahtarını buradan paylaşın

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
temperature	number	Hangi örnekleme sıcaklığını kullanacağım, 0 ile 2 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. Genellikle bunu değiştirmenizi ya da `top_p` ikisini birden değiştirmenizi öneririz.	No	1
top_p	number	Sıcaklıkla örnekleme alternatifi olan çekirdek örnekleme denir; model, top_p olasılık kütlesine sahip tokenların sonuçlarını dikkate alır. Yani 0.1, yalnızca en üst 10% olasılık kütlesini oluşturan jetonların dikkate alındığı anlamına gelir. Genellikle bunu değiştirmenizi ya da `temperature` ikisini birden değiştirmenizi öneririz.	No	1
stream	boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi mesaj deltaları gönderilir. Tokenlar, kullanılabilir olduklarında sadece veri sunucusu tarafından gönderilen olaylar olarak gönderilecek ve akış bir `data: [DONE]` mesajla sonlandırılacak.	No	False
stop	dizi veya dizi	API'nin daha fazla token üretmeyi durduracağı dört diziye kadar.	No
max_tokens	integer	Sohbet tamamlanmasında üretilebilecek maksimum token sayısı. Giriş tokenlarının ve üretilen tokenların toplam uzunluğu, modelin bağlam uzunluğuyla sınırlıdır.	No
max_completion_tokens	integer	Bir tamamlanma için oluşturulabilecek token sayısının üst sınırı; görünür çıktı tokenları ve mantık belirteonları dahil.	No
presence_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları şu ana kadar metinde yer alıp görünmediklerine göre cezalandırıyor ve bu da modelin yeni konular hakkında konuşma olasılığını artırıyor.	No	0
frequency_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları metindeki mevcut sıklıklarına göre cezalandırır ve modelin aynı satırı kelimesi kelimesine tekrarlama olasılığını azaltır.	No	0
logit_bias	object	Belirtilen tokenların tamamlanma sırasında görünme olasılığını değiştirin. Tokenları (tokenizer'da token ID'leriyle belirtilen) -100'den 100'e kadar ilişkili bir önyargı değerine eşleyen bir JSON nesnesini kabul eder. Matematiksel olarak, önyargı, örnekleme öncesinde model tarafından üretilen logitlere eklenir. Kesin etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalı; -100 veya 100 gibi değerler, ilgili tokenın yasaklanmasına veya özel seçilmesine yol açmalıdır.	No	None
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No
messages	array	Şimdiye kadar yapılan konuşmayı içeren mesajların bir listesi.	Yes
data_sources	array	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek spesifikasyon yalnızca Azure OpenAI ile uyumludur.	No
logprobs	boolean	Çıkış tokenlarının log olasılıklarını geri getirip getirmemek meselesi. Eğer doğruysa, her çıktı belirtekonunun 'da `contentmessage`döndürülen log olasılıklarını döndürür.	No	False
top_logprobs	integer	Her token pozisyonunda döndürülmesi en muhtemel token sayısını belirten 0 ile 20 arasında bir tam sayı ve her birinin ilişkili log olasılığı vardır. `logprobs` bu parametre kullanılırsa ayarlanmalıdır `true` .	No
n	integer	Her giriş mesajı için kaç tane sohbet tamamlama seçeneği oluşturulması gerektiği. Tüm seçeneklerde üretilen token sayısına göre ücretlendirileceğinizi unutmayın. Maliyetleri en aza indirmek için bunu `1` koruyun`n`.	No	1
parallel_tool_calls	ParallelToolCalls	Araç kullanımı sırasında paralel fonksiyon çağrısını etkinleştirip etkinleştirmediği.	No	True
response_format	ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema	Modelin çıkışı yapması gereken formatı belirten bir nesne. GPT-4o, GPT-4o mini, GPT-4 Turbo ve daha yeni tüm GPT-3.5 Turbo modelleri `gpt-3.5-turbo-1106`ile uyumludur. Ayarlanması `{ "type": "json_schema", "json_schema": {...} }` , modelin sağlanan JSON şemasına uyacağını garanti eden Yapılandırılmış Çıktıları etkinleştirir. JSON modunu `{ "type": "json_object" }` etkinleştirmek modelin oluşturduğu mesajın geçerli JSON olduğunu garanti eder. Önemli: JSON modunu kullanırken, modele sistem veya kullanıcı mesajı yoluyla JSON üretmesini de belirtmelisiniz. Bunun olmaması durumunda, model nesil token sınırına ulaşana kadar bitmek bilmeyen bir boşluk akışı oluşturabilir ve uzun süreli ve görünüşte "sıkışmış" bir talep ortaya çıkarabilir. Ayrıca, mesaj içeriğinin kısmen kesilebileceğini unutmayın, bu da `finish_reason="length"`üretimin `max_tokens` aşılmış veya konuşmanın maksimum bağlam uzunluğunu aştığını gösterir.	No
seed	integer	Bu özellik Beta'da. Belirtilirse, sistemimiz deterministik örnekleme için en iyi çabayı gösterir; böylece aynı `seed` ve parametreli tekrarlanan talepler aynı sonucu vermelidir. Determinizm garanti değildir ve arka uçtaki değişiklikleri izlemek için yanıt `system_fingerprint` parametresine başvurmalısınız.	No
tools	array	Modelin çağırabileceği araçlar listesi. Şu anda sadece fonksiyonlar bir araç olarak desteklenmektedir. Bunu, modelin JSON girdileri üretebileceği fonksiyonların bir listesini sağlamak için kullanın. Maksimum 128 fonksiyon desteklenmektedir.	No
tool_choice	chatCompletionToolChoiceOption	Modelin hangi (varsa) aracı denmesini sağlar. `none` bu, modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir mesaj oluşturacağı anlamına gelir. `auto` Modelin mesaj üretmek veya bir veya daha fazla aracı çağırmak arasında seçim yapabileceği anlamına gelir. `required` Modelin bir veya daha fazla aracı çağırması gerektiği anlamına gelir. Belirli bir aracı belirtmek, `{"type": "function", "function": {"name": "my_function"}}` modelin o aracı çağırmasını zorunlu kılar. `none` araç yokken varsayılan olarak kullanılır. `auto` araçlar varsa varsayılan olarak kullanılır.	No
function_call	string veya chatCompletionFunctionCallOption	Lehine kullanımdan `tool_choice`kaldırıldı. Hangi (varsa) fonksiyonun model tarafından çağrıldığını kontrol eder. `none` modelin bir fonksiyon çağırmayacağı ve bunun yerine bir mesaj oluşturacağı anlamına gelir. `auto` Modelin mesaj üretmek veya fonksiyon çağırmak arasında seçim yapabileceği anlamına gelir. Belirli bir fonksiyonu arayla `{"name": "my_function"}` belirtmek, modeli o fonksiyonu çağırmaya zorlar. `none` fonksiyon yokken varsayılan olarak kullanılır. `auto` eğer fonksiyonlar varsa varsayılan olarak kullanılır.	No
functions	array	Lehine kullanımdan `tools`kaldırıldı. Modelin JSON girdileri üretebileceği fonksiyonların listesi.	No

Responses

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	createChatCompletionResponse veya createChatCompletionStreamResponse

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

Verilen prompt, parametreler ve seçilen model için bir tamamlama oluşturur.

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

Yanıtlar: Durum Kodu: 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 Arama verileri ve sistem tarafından atanan yönetilen kimlik temelinde bir tamamlama oluşturur.

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

Yanıtlar: Durum Kodu: 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 vektör verilerine, önceki asistan mesajına ve kullanıcı tarafından atanan yönetilen kimlik temelinde bir tamamlama oluşturur.

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

Yanıtlar: Durum Kodu: 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

Sağlanan Azure Cosmos DB için bir tamamlama oluşturur.

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

Yanıtlar: Durum Kodu: 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
    }
  }
}

Transkripsiyonlar - Yarat

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

Sesi giriş diline aktarır.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Konuşmadan metne modelin dağıtım kimliği. Desteklenen modeller hakkında bilgi için [/azure/ai-foundry/openai/concepts/models#audio-models] adresine bakınız.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Azure OpenAI API anahtarını buradan paylaşın

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string	Ses dosyası nesnesini transkribe etmek için.	Yes
prompt	string	Modelin stilini yönlendirmek veya önceki bir ses segmentini sürdürmek için isteğe bağlı bir metin. İstem ses diline uymalı.	No
response_format	audioResponseFormat	Çıktının formatını tanımlar.	No
temperature	number	Örnekleme sıcaklığı, 0 ile 1 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. 0 olarak ayarlandığında, model belirli eşiklere ulaşana kadar sıcaklığı otomatik olarak artırmak için log olasılık kullanır.	No	0
language	string	Giriş sesinin dili. Giriş dilinin ISO-639-1 formatında sağlanması, doğruluk ve gecikmeyi artıracaktır.	No

Responses

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse veya audioVerboseResponse
text/plain	string	Çıktı formatında (response_format metin, vtt veya srt'den oluştuğunda) transkripsiyon edilen metin.

Examples

Example

Verilen konuşulmuş ses verilerinden transkribe metin ve ilgili meta verileri alır.

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

Yanıtlar: Durum Kodu: 200

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

Example

Verilen konuşulmuş ses verilerinden transkribe metin ve ilgili meta verileri alır.

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

Yanıtlar: Durum Kodu: 200

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

Çeviriler - Yarat

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

Giriş sesi İngilizce metne transkribe eder ve çevirir.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Dağıtılan fısıltı modelinin dağıtım kimliği. Desteklenen modeller hakkında bilgi için [/azure/ai-foundry/openai/concepts/models#audio-models] adresine bakınız.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Azure OpenAI API anahtarını buradan paylaşın

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string	Çevirilmesi gereken ses dosyası.	Yes
prompt	string	Modelin stilini yönlendirmek veya önceki bir ses segmentini sürdürmek için isteğe bağlı bir metin. Yönlendirme İngilizce olmalı.	No
response_format	audioResponseFormat	Çıktının formatını tanımlar.	No
temperature	number	Örnekleme sıcaklığı, 0 ile 1 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. 0 olarak ayarlandığında, model belirli eşiklere ulaşana kadar sıcaklığı otomatik olarak artırmak için log olasılık kullanır.	No	0

Responses

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse veya audioVerboseResponse
text/plain	string	Çıktı formatında (response_format metin, vtt veya srt'den oluştuğunda) transkripsiyon edilen metin.

Examples

Example

İngilizce transkribe metni ve ilgili meta verileri sağlanan konuşulan ses verilerinden alır.

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

Yanıtlar: Durum Kodu: 200

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

Example

İngilizce transkribe metni ve ilgili meta verileri sağlanan konuşulan ses verilerinden alır.

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

Yanıtlar: Durum Kodu: 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

Verilen bir dall-e model dağıtımında metin başlığından bir dizi görüntü üretir

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Dağıtılan dall-e modelinin dağıtım kimliği.
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Azure OpenAI API anahtarını buradan paylaşın

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
prompt	string	İstenen görsel(ler)in metin açıklaması. Maksimum uzunluk 4.000 karakterdir.	Yes
n	integer	Üretilecek görüntü sayısı.	No	1
size	imageSize	Oluşturulan görüntülerin boyutu.	No	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin geri dönüş biçimi.	No	url
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No
quality	imageQuality	Üretilecek görüntünün kalitesi.	No	standard
style	imageStyle	Oluşturulan görüntülerin stili.	No	vivid

Responses

Durum Kodu: 200

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

Durum Kodu: varsayılan

Açıklama: Bir hata meydana geldi.

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

Bir prompt verildiğinde görseller oluşturur.

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

Yanıtlar: Durum Kodu: 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
param	string		No
type	string		No
inner_error	innerError	İç hata ve ek detaylar.	No

innerError

İç hata ve ek detaylar.

Name	Type	Description	Required	Default
code	innerErrorCode	İç hata nesnesi için hata kodları.	No
content_filter_results	contentFilterPromptResults	İçerik filtreleme kategorisi hakkında bilgiler (nefret, cinsel, şiddet self_harm), tespit edilip edilmediği, şiddet seviyesi (zararlı içeriğin yoğunluğunu ve risk seviyesini belirleyen very_low, düşük, orta, yüksek ölçek) ve filtrelenip filtrelenmediği. Jailbreak içeriği ve küfürler hakkında bilgiler, tespit edilip edilmediği, filtrelenip filtrelenmediği hakkında bilgiler. Ve müşteri engelleme listesi hakkında, filtrelenip filtrelenmişler ve kimliği hakkında bilgiler.	No

innerErrorCode

İç hata nesnesi için hata kodları.

Açıklama: İç hata nesnesi için hata kodları.

Type: string

Default:

Enum Adı: InnerErrorCode

Enum Values:

Value	Description
ResponsibleAIPolicyViolation	Bu istem, içerik filtresi kurallarından birini ihlal ediyordu.

dalleErrorResponse

Name	Type	Description	Required	Default
error	dalleError		No

dalleError

Name	Type	Description	Required
param	string		No
type	string		No
inner_error	dalleInnerError	İç hata ve ek detaylar.	No

dalleInnerError

İç hata ve ek detaylar.

Name	Type	Description	Required
code	innerErrorCode	İç hata nesnesi için hata kodları.	No
content_filter_results	dalleFilterResults	İçerik filtreleme kategorisi hakkında bilgiler (nefret, cinsel, şiddet self_harm), tespit edilip edilmediği, şiddet seviyesi (zararlı içeriğin yoğunluğunu ve risk seviyesini belirleyen very_low, düşük, orta, yüksek ölçek) ve filtrelenip filtrelenmediği. Jailbreak içeriği ve küfürler hakkında bilgiler, tespit edilip edilmediği, filtrelenip filtrelenmediği hakkında bilgiler. Ve müşteri engelleme listesi hakkında, filtrelenip filtrelenmişler ve kimliği hakkında bilgiler.	No
revised_prompt	string	Eğer isteğinde herhangi bir değişiklik varsa, görüntü oluşturmak için kullanılan istem kullanıldı.	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

Atıf için özellikler

URL

Name	Type	Description	Default
URL	string

license

Name	Type	Description	Default
license	string

contentFilterResultsBase

İçerik filtreleme sonuçları hakkında bilgi.

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

contentFilterPromptResults

İçerik filtreleme kategorisi hakkında bilgiler (nefret, cinsel, şiddet self_harm), tespit edilip edilmediği, şiddet seviyesi (zararlı içeriğin yoğunluğunu ve risk seviyesini belirleyen very_low, düşük, orta, yüksek ölçek) ve filtrelenip filtrelenmediği. Jailbreak içeriği ve küfürler hakkında bilgiler, tespit edilip edilmediği, filtrelenip filtrelenmediği hakkında bilgiler. Ve müşteri engelleme listesi hakkında, filtrelenip filtrelenmişler ve kimliği hakkında bilgiler.

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

contentFilterChoiceResults

İçerik filtreleme kategorisi hakkında bilgiler (nefret, cinsel, şiddet self_harm), tespit edilip edilmediği, şiddet seviyesi (zararlı içeriğin yoğunluğunu ve risk seviyesini belirleyen very_low, düşük, orta, yüksek ölçek) ve filtrelenip filtrelenmediği. Üçüncü taraf metin ve küfürler hakkında bilgiler, tespit edilip edilmediği, filtrelenip filtrelenmediği bilgileri. Ve müşteri engelleme listesi hakkında, filtrelenip filtrelenmişler ve kimliği hakkında bilgiler.

Name	Type	Required
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

İstekte tek bir istek için içerik filtreleme sonuçları.

Name	Type	Description	Required	Default
prompt_index	integer		No
content_filter_results	contentFilterPromptResults	İçerik filtreleme kategorisi hakkında bilgiler (nefret, cinsel, şiddet self_harm), tespit edilip edilmediği, şiddet seviyesi (zararlı içeriğin yoğunluğunu ve risk seviyesini belirleyen very_low, düşük, orta, yüksek ölçek) ve filtrelenip filtrelenmediği. Jailbreak içeriği ve küfürler hakkında bilgiler, tespit edilip edilmediği, filtrelenip filtrelenmediği hakkında bilgiler. Ve müşteri engelleme listesi hakkında, filtrelenip filtrelenmişler ve kimliği hakkında bilgiler.	No

promptFilterResults

İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Bir yayın isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı sıralarda gelebilir.

Bu bileşen için tanımlanmış bir özellik yok.

dalleContentFilterResults

İçerik filtreleme sonuçları hakkında bilgi.

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

dalleFilterResults

Name	Type	Required
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	Hangi örnekleme sıcaklığını kullanacağım, 0 ile 2 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. Genellikle bunu değiştirmenizi ya da `top_p` ikisini birden değiştirmenizi öneririz.	No	1
top_p	number	Sıcaklıkla örnekleme alternatifi olan çekirdek örnekleme denir; model, top_p olasılık kütlesine sahip tokenların sonuçlarını dikkate alır. Yani 0.1, yalnızca en üst 10% olasılık kütlesini oluşturan jetonların dikkate alındığı anlamına gelir. Genellikle bunu değiştirmenizi ya da `temperature` ikisini birden değiştirmenizi öneririz.	No	1
stream	boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi mesaj deltaları gönderilir. Tokenlar, kullanılabilir olduklarında sadece veri sunucusu tarafından gönderilen olaylar olarak gönderilecek ve akış bir `data: [DONE]` mesajla sonlandırılacak.	No	False
stop	dizi veya dizi	API'nin daha fazla token üretmeyi durduracağı dört diziye kadar.	No
max_tokens	integer	Oluşturulan cevap için izin verilen maksimum jeton sayısı. Varsayılan olarak, modelin döndürebileceği token sayısı (4096 - prompt token'ları) olacaktır. Bu değer artık , lehine kullanımdan `max_completion_tokens`kaldırılmıştır ve o1 serisi modellerle uyumlu değildir.	No	4096
max_completion_tokens	integer	Bir tamamlanma için oluşturulabilecek token sayısının üst sınırı; görünür çıktı tokenları ve mantık belirteonları dahil.	No
presence_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları şu ana kadar metinde yer alıp görünmediklerine göre cezalandırıyor ve bu da modelin yeni konular hakkında konuşma olasılığını artırıyor.	No	0
frequency_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları metindeki mevcut sıklıklarına göre cezalandırır ve modelin aynı satırı kelimesi kelimesine tekrarlama olasılığını azaltır.	No	0
logit_bias	object	Belirtilen tokenların tamamlanma sırasında görünme olasılığını değiştirin. Tokenları (tokenizer'da token ID'leriyle belirtilen) -100'den 100'e kadar ilişkili bir yanlılık değerine eşleyen bir json nesnesini kabul eder. Matematiksel olarak, önyargı, örnekleme öncesinde model tarafından üretilen logitlere eklenir. Kesin etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalı; -100 veya 100 gibi değerler, ilgili tokenın yasaklanmasına veya özel seçilmesine yol açmalıdır.	No
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcıdır; bu da Azure OpenAI'nin kötüye kullanımı izlemesine ve tespit etmesine yardımcı olabilir.	No

createCompletionRequest

Name	Type	Description	Required	Default
prompt	dizi veya dizi	Tamamlama üretme için yönlendirmeler, bir dize, dizi dizisi, token dizisi veya token dizileri dizisi olarak kodlanmıştır. <\|endoftext\|>, modelin eğitim sırasında gördüğü belge ayırıcısıdır, bu yüzden bir istek belirtilmezse, model yeni bir belgenin başından geliyormuş gibi üretir.	Yes
best_of	integer	Sunucu tarafında tamamlamaları üretir `best_of` ve "en iyisi" (her token başına en yüksek log olasılığına sahip olan) döndürür. Sonuçlar yayınlanamaz. ile kullanıldığında `n`, `best_of` aday tamamlama sayısını kontrol eder ve `n` kaç tane döndürüleceğini belirtir â€" `best_of` ile daha büyük `n`olmalıdır. Not: Bu parametre çok sayıda tamamlama yarattığı için token kotanızı hızla tüketebilir. Dikkatli kullanın ve makul ayarlarınız `max_tokens` olduğundan emin olun.`stop`	No	1
echo	boolean	Tamamlamanın yanı sıra promptu tekrar tekrar et.	No	False
frequency_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları metindeki mevcut sıklıklarına göre cezalandırır ve modelin aynı satırı kelimesi kelimesine tekrarlama olasılığını azaltır.	No	0
logit_bias	object	Belirtilen tokenların tamamlanma sırasında görünme olasılığını değiştirin. GPT tokenizer'da token ID'leriyle belirtilen tokenları -100'den 100'e kadar ilişkili bir önyargı değerine eşleyen bir JSON nesnesini kabul eder. Matematiksel olarak, önyargı, örnekleme öncesinde model tarafından üretilen logitlere eklenir. Kesin etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalı; -100 veya 100 gibi değerler, ilgili tokenın yasaklanmasına veya özel seçilmesine yol açmalıdır. Örneğin, \|endoftext\|> token'ının oluşturulmasını önlemek <için geçiş `{"50256": -100}` yapabilirsiniz.	No	None
logprobs	integer	En muhtemel çıkış tokenlarındaki log olasılıklarını `logprobs` ve seçilen tokenları ekleyin. Örneğin, `logprobs` 5 ise, API en olası beş tokenın listesini döndürür. API her zaman örneklenen token'ın değerini `logprob` döndürür, bu yüzden yanıtta en `logprobs+1` fazla öğe olabilir. Maksimum değer 5'tir `logprobs` .	No	None
max_tokens	integer	Tamamlanma sırasında üretilebilecek maksimum token sayısı. İsterinizin token sayısı `max_tokens` modelin bağlam uzunluğunu aşamaz.	No	16
n	integer	Her prompt için kaç tane tamamlama üretileceği. Not: Bu parametre çok sayıda tamamlama yarattığı için token kotanızı hızla tüketebilir. Dikkatli kullanın ve makul ayarlarınız `max_tokens` olduğundan emin olun.`stop`	No	1
presence_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları şu ana kadar metinde yer alıp görünmediklerine göre cezalandırıyor ve bu da modelin yeni konular hakkında konuşma olasılığını artırıyor.	No	0
seed	integer	Belirtilirse, sistemimiz deterministik örnekleme için en iyi çabayı gösterir; böylece aynı `seed` ve parametreli tekrarlanan talepler aynı sonucu vermelidir. Determinizm garanti değildir ve arka uçtaki değişiklikleri izlemek için yanıt `system_fingerprint` parametresine başvurmalısınız.	No
stop	dizi veya dizi	API'nin daha fazla token üretmeyi durduracağı dört diziye kadar. Geri dönen metin durma dizisini içermez.	No
stream	boolean	Kısmi ilerlemeyi geri akıp gönderip geri göndermeme. Ayarlanırsa, tokenlar kullanılabilir olduklarında sadece veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` mesajla sonlandırılır.	No	False
suffix	string	Eklenen metin tamamlandıktan sonra gelen ek. Bu parametre yalnızca için `gpt-3.5-turbo-instruct`desteklenir.	No	None
temperature	number	Hangi örnekleme sıcaklığını kullanacağım, 0 ile 2 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. Genellikle bunu değiştirmenizi ya da `top_p` ikisini birden değiştirmenizi öneririz.	No	1
top_p	number	Sıcaklıkla örnekleme alternatifi olan çekirdek örnekleme denir; model, top_p olasılık kütlesine sahip tokenların sonuçlarını dikkate alır. Yani 0.1, yalnızca en üst 10% olasılık kütlesini oluşturan jetonların dikkate alındığı anlamına gelir. Genellikle bunu değiştirmenizi ya da `temperature` ikisini birden değiştirmenizi öneririz.	No	1
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No

createCompletionResponse

API'den gelen bir tamamlanma yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli taşır (sohbet uç noktasının aksine).

Name	Type	Description	Required
id	string	Tamamlanma için benzersiz bir tanımlayıcı.	Yes
choices	array	Modelin giriş isteği için oluşturduğu tamamlama seçenekleri listesi.	Yes
created	integer	Tamamlanmanın oluşturulduğu Unix zaman damgası (saniye cinsinden).	Yes
model	string	Tamamlanma için kullanılan model.	Yes
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Bir yayın isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı sıralarda gelebilir.	No
system_fingerprint	string	Bu parmak izi, modelin çalıştığı arka uç konfigürasyonunu temsil eder. Backend değişikliklerinin determinizmi etkileyebileceği zamanlarda yapıldığını anlamak için `seed` talep parametresiyle birlikte kullanılabilir.	No
object	enum	Her zaman "text_completion" olan nesne türü Olası değerler: text_completion	Yes
usage	completionUsage	Tamamlama talebi için kullanım istatistikleri.	No

createChatCompletionRequest

Name	Type	Description	Required	Default
temperature	number	Hangi örnekleme sıcaklığını kullanacağım, 0 ile 2 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. Genellikle bunu değiştirmenizi ya da `top_p` ikisini birden değiştirmenizi öneririz.	No	1
top_p	number	Sıcaklıkla örnekleme alternatifi olan çekirdek örnekleme denir; model, top_p olasılık kütlesine sahip tokenların sonuçlarını dikkate alır. Yani 0.1, yalnızca en üst 10% olasılık kütlesini oluşturan jetonların dikkate alındığı anlamına gelir. Genellikle bunu değiştirmenizi ya da `temperature` ikisini birden değiştirmenizi öneririz.	No	1
stream	boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi mesaj deltaları gönderilir. Tokenlar, kullanılabilir olduklarında sadece veri sunucusu tarafından gönderilen olaylar olarak gönderilecek ve akış bir `data: [DONE]` mesajla sonlandırılacak.	No	False
stop	dizi veya dizi	API'nin daha fazla token üretmeyi durduracağı dört diziye kadar.	No
max_tokens	integer	Sohbet tamamlanmasında üretilebilecek maksimum token sayısı. Giriş tokenlarının ve üretilen tokenların toplam uzunluğu, modelin bağlam uzunluğuyla sınırlıdır.	No
max_completion_tokens	integer	Bir tamamlanma için oluşturulabilecek token sayısının üst sınırı; görünür çıktı tokenları ve mantık belirteonları dahil.	No
presence_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları şu ana kadar metinde yer alıp görünmediklerine göre cezalandırıyor ve bu da modelin yeni konular hakkında konuşma olasılığını artırıyor.	No	0
frequency_penalty	number	Sayı -2.0 ile 2.0 arasında. Pozitif değerler, yeni tokenları metindeki mevcut sıklıklarına göre cezalandırır ve modelin aynı satırı kelimesi kelimesine tekrarlama olasılığını azaltır.	No	0
logit_bias	object	Belirtilen tokenların tamamlanma sırasında görünme olasılığını değiştirin. Tokenları (tokenizer'da token ID'leriyle belirtilen) -100'den 100'e kadar ilişkili bir önyargı değerine eşleyen bir JSON nesnesini kabul eder. Matematiksel olarak, önyargı, örnekleme öncesinde model tarafından üretilen logitlere eklenir. Kesin etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalı; -100 veya 100 gibi değerler, ilgili tokenın yasaklanmasına veya özel seçilmesine yol açmalıdır.	No	None
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No
messages	array	Şimdiye kadar yapılan konuşmayı içeren mesajların bir listesi.	Yes
data_sources	array	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek spesifikasyon yalnızca Azure OpenAI ile uyumludur.	No
logprobs	boolean	Çıkış tokenlarının log olasılıklarını geri getirip getirmemek meselesi. Eğer doğruysa, her çıktı belirtekonunun 'da `contentmessage`döndürülen log olasılıklarını döndürür.	No	False
top_logprobs	integer	Her token pozisyonunda döndürülmesi en muhtemel token sayısını belirten 0 ile 20 arasında bir tam sayı ve her birinin ilişkili log olasılığı vardır. `logprobs` bu parametre kullanılırsa ayarlanmalıdır `true` .	No
n	integer	Her giriş mesajı için kaç tane sohbet tamamlama seçeneği oluşturulması gerektiği. Tüm seçeneklerde üretilen token sayısına göre ücretlendirileceğinizi unutmayın. Maliyetleri en aza indirmek için bunu `1` koruyun`n`.	No	1
parallel_tool_calls	ParallelToolCalls	Araç kullanımı sırasında paralel fonksiyon çağrısını etkinleştirip etkinleştirmediği.	No	True
response_format	ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema	Modelin çıkışı yapması gereken formatı belirten bir nesne. GPT-4o, GPT-4o mini, GPT-4 Turbo ve daha yeni tüm GPT-3.5 Turbo modelleri `gpt-3.5-turbo-1106`ile uyumludur. Ayarlanması `{ "type": "json_schema", "json_schema": {...} }` , modelin sağlanan JSON şemasına uyacağını garanti eden Yapılandırılmış Çıktıları etkinleştirir. JSON modunu `{ "type": "json_object" }` etkinleştirmek modelin oluşturduğu mesajın geçerli JSON olduğunu garanti eder. Önemli: JSON modunu kullanırken, modele sistem veya kullanıcı mesajı yoluyla JSON üretmesini de belirtmelisiniz. Bunun olmaması durumunda, model nesil token sınırına ulaşana kadar bitmek bilmeyen bir boşluk akışı oluşturabilir ve uzun süreli ve görünüşte "sıkışmış" bir talep ortaya çıkarabilir. Ayrıca, mesaj içeriğinin kısmen kesilebileceğini unutmayın, bu da `finish_reason="length"`üretimin `max_tokens` aşılmış veya konuşmanın maksimum bağlam uzunluğunu aştığını gösterir.	No
seed	integer	Bu özellik Beta'da. Belirtilirse, sistemimiz deterministik örnekleme için en iyi çabayı gösterir; böylece aynı `seed` ve parametreli tekrarlanan talepler aynı sonucu vermelidir. Determinizm garanti değildir ve arka uçtaki değişiklikleri izlemek için yanıt `system_fingerprint` parametresine başvurmalısınız.	No
tools	array	Modelin çağırabileceği araçlar listesi. Şu anda sadece fonksiyonlar bir araç olarak desteklenmektedir. Bunu, modelin JSON girdileri üretebileceği fonksiyonların bir listesini sağlamak için kullanın. Maksimum 128 fonksiyon desteklenmektedir.	No
tool_choice	chatCompletionToolChoiceOption	Modelin hangi (varsa) aracı denmesini sağlar. `none` bu, modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir mesaj oluşturacağı anlamına gelir. `auto` Modelin mesaj üretmek veya bir veya daha fazla aracı çağırmak arasında seçim yapabileceği anlamına gelir. `required` Modelin bir veya daha fazla aracı çağırması gerektiği anlamına gelir. Belirli bir aracı belirtmek, `{"type": "function", "function": {"name": "my_function"}}` modelin o aracı çağırmasını zorunlu kılar. `none` araç yokken varsayılan olarak kullanılır. `auto` araçlar varsa varsayılan olarak kullanılır.	No
function_call	string veya chatCompletionFunctionCallOption	Lehine kullanımdan `tool_choice`kaldırıldı. Hangi (varsa) fonksiyonun model tarafından çağrıldığını kontrol eder. `none` modelin bir fonksiyon çağırmayacağı ve bunun yerine bir mesaj oluşturacağı anlamına gelir. `auto` Modelin mesaj üretmek veya fonksiyon çağırmak arasında seçim yapabileceği anlamına gelir. Belirli bir fonksiyonu arayla `{"name": "my_function"}` belirtmek, modeli o fonksiyonu çağırmaya zorlar. `none` fonksiyon yokken varsayılan olarak kullanılır. `auto` eğer fonksiyonlar varsa varsayılan olarak kullanılır.	No
functions	array	Lehine kullanımdan `tools`kaldırıldı. Modelin JSON girdileri üretebileceği fonksiyonların listesi.	No

chatCompletionFunctions

Name	Type	Description	Required
description	string	Modelin fonksiyonu ne zaman ve nasıl çağıracağını seçmek için kullandığı fonksiyonun ne iş yaptığına dair bir açıklama.	No
name	string	Çağrılacak fonksiyonun adı. A-z, A-Z, 0-9 olmalı veya alt çizgi ve tire içeren olmalı, maksimum uzunluğu 64 olmalıdır.	Yes
parameters	FunctionParameters	Fonksiyonların kabul ettiği parametreler, JSON Şema nesnesi olarak tanımlanır. Örnekler için rehbere ve format hakkında dokümantasyon için JSON Schema referansına bakınız. Atlama, `parameters` boş bir parametre listesine sahip bir fonksiyon tanımlar.	No

chatCompletionFunctionCallOption

Belirli bir fonksiyonu arayla {"name": "my_function"} belirtmek, modeli o fonksiyonu çağırmaya zorlar.

Name	Type	Description	Required	Default
name	string	Çağrılacak fonksiyonun adı.	Yes

chatCompletionRequestMessage

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestSystemMessage

Name	Type	Description	Required
content	dizi veya dizi	Sistem mesajının içeriği.	Yes
role	enum	Mesaj yazarının rolü, bu durumda `system`. Olası değerler: sistem	Yes
name	string	Katılımcı için isteğe bağlı bir isim. Aynı roldeki katılımcıları ayırt etmek için model bilgisi sağlar.	No

chatCompletionRequestUserMessage

Name	Type	Description	Required
content	dizi veya dizi	Kullanıcı mesajının içeriği.	Yes
role	enum	Mesaj yazarının rolü, bu durumda `user`. Olası değerler: kullanıcı	Yes
name	string	Katılımcı için isteğe bağlı bir isim. Aynı roldeki katılımcıları ayırt etmek için model bilgisi sağlar.	No

chatCompletionRequestAssistantMessage

Name	Type	Description	Required
content	dizi veya dizi	Asistan mesajının içeriği. Belirtilmedikçe `tool_callsfunction_call` veya belirtilmedikçe gereklidir.	No
refusal	string	Asistanın reddetme mesajı.	No
role	enum	Mesaj yazarının rolü, bu durumda `assistant`. Olası değerler: asistan	Yes
name	string	Katılımcı için isteğe bağlı bir isim. Aynı roldeki katılımcıları ayırt etmek için model bilgisi sağlar.	No
tool_calls	chatCompletionMessageToolCalls	Model tarafından oluşturulan araç çağrıları, örneğin fonksiyon çağrıları.	No
function_call	object	Kullanımdan kaldırıldı ve yerine `tool_calls`. Model tarafından oluşturulan çağrılması gereken fonksiyonun adı ve argümanları.	No

function_call için özellikler

arguments

Name	Type	Description	Default
arguments	string	Fonksiyonu çağırmak için argümanlar, model tarafından JSON formatında oluşturulur. Modelin her zaman geçerli JSON üretmediğini ve fonksiyon şemanızda tanımlanmayan parametreler üretebileceğini unutmayın. Fonksiyonunuzu çağırmadan önce kodunuzdaki argümanları doğrulayın.

name

Name	Type	Description	Default
name	string	Çağrılacak fonksiyonun adı.

chatCompletionRequestToolMessage

Name	Type	Description	Required
role	enum	Mesaj yazarının rolü, bu durumda `tool`. Olası değerler: araç	Yes
content	dizi veya dizi	Araç mesajının içeriği.	Yes
tool_call_id	string	Bu mesajın yanıt verdiği araç çağrısı.	Yes

chatCompletionRequestFunctionMessage

Name	Type	Description	Required
role	enum	Mesaj yazarının rolü, bu durumda `function`. Olası değerler: fonksiyon	Yes
content	string	Fonksiyon mesajının içeriği.	Yes
name	string	Çağrılacak fonksiyonun adı.	Yes

chatCompletionRequestSystemMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestUserMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestAssistantMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestToolMessageContentPart

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionRequestMessageContentPartText

Name	Type	Description	Required	Default
type	enum	İçerik kısmının türü. Olası değerler: metin	Yes
text	string	Metin içeriği.	Yes

chatCompletionRequestMessageContentPartImage

Name	Type	Description	Required	Default
type	enum	İçerik kısmının türü. Olası değerler: image_url	Yes
image_url	object		Yes

image_url için özellikler

url

Name	Type	Description	Default
url	string	Ya görselin URL'si ya da base64 kodlanmış görüntü verisi.

detail

Name	Type	Description	Default
detail	string	Görüntünün detay seviyesini belirtir. Daha fazla bilgi için Vizyon rehberi.	auto

chatCompletionRequestMessageContentPartRefusal

Name	Type	Description	Required	Default
type	enum	İçerik kısmının türü. Olası değerler: reddetme	Yes
refusal	string	Model tarafından oluşturulan reddetme mesajı.	Yes

azureChatExtensionConfiguration

Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin bir temsili. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama talebi tarafından kullanılacaktır. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.

Name	Type	Description	Required	Default
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin bir temsili. Bu, bir sohbet tarafından kullanılacak Yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama talepleri. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Yes

azureChatExtensionType

Description: Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin temsili. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama talebi tarafından kullanılacaktır. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.

Type: string

Default:

Enum Name: AzureChatExtensionType

Enum Values:

Value	Description
azure_search	Azure Search'in Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.
azure_cosmos_db	Azure Cosmos DB'nin Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.

azureSearchChatExtensionConfiguration

Azure Search'i Azure OpenAI sohbet uzantısı olarak kullanıldığında yapılandırılabilir seçeneklerin özel bir temsili.

Name	Type	Description	Required	Default
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin bir temsili. Bu, bir sohbet tarafından kullanılacak Yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama talepleri. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Yes
parameters	azureSearchChatExtensionParameters	Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Arama parametreleri.	No

azureSearchChatExtensionParameters

Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Arama parametreleri.

Name	Type	Description	Required
authentication	onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	integer	Yapılandırılmış sorgu için özellik yapılacak en yüksek belge sayısı.	No
in_scope	boolean	Sorguların indekslenmiş verilerin kullanımıyla sınırlandırılıp sınırlamayacağı.	No
strictness	integer	Arama alaka filtrelemesinin yapılandırılmış katılığı. Ne kadar katı olursa, o kadar yüksek hassasiyet ama cevap hatırlama o kadar düşüktür.	No
role_information	string	Modele nasıl davranması gerektiği ve yanıt oluştururken referans vermesi gereken herhangi bir bağlama dair talimatlar verin. Asistanın kişiliğini tarif edebilir ve ona yanıtların nasıl biçimlendirileceğini söyleyebilirsiniz. Bunun için 100 token sınırı var ve bu toplam token sınırına dahil edilir.	No
endpoint	string	Azure Search kaynağının kullanması için mutlak uç nokta yolu.	Yes
index_name	string	Referans verilen Azure Search kaynağında kullanılabilir olan indeksin adı.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Yapılandırılmış bir Azure Search kaynağı kullanıldığında alanların nasıl işlendiğini kontrol etmek için isteğe bağlı ayarlar.	No
query_type	azureSearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanıldığında yürütülmesi gereken Azure Arama alma sorgusu türü.	No
semantic_configuration	string	Sorgu için ek anlamsal yapılandırma.	No
filter	string	Search filter.	No
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

Yapılandırılmış bir Azure Search kaynağı kullanıldığında alanların nasıl işlendiğini kontrol etmek için isteğe bağlı ayarlar.

Name	Type	Description	Required
title_field	string	Başlık olarak kullanılacak indeks alanının adı.	No
url_field	string	URL olarak kullanılacak indeks alanının adı.	No
filepath_field	string	Dosya yolu olarak kullanılacak indeks alanının adı.	No
content_fields	array	İçerik olarak ele alınması gereken indeks alanlarının isimleri.	No
content_fields_separator	string	İçerik alanlarının kullanması gereken ayırıcı deseni.	No
vector_fields	array	Vektör verisini temsil eden alanların isimleri.	No

azureSearchQueryType

Azure OpenAI sohbet uzantısı olarak kullanıldığında yürütülmesi gereken Azure Arama alma sorgusu türü.

Description: Azure OpenAI sohbet uzantısı olarak kullanıldığında yürütülmesi gereken Azure Arama arama sorgusu türü.

Type: string

Default:

Enum Name: AzureSearchQueryType

Enum Values:

Value	Description
simple	Varsayılan ve basit sorgu ayrıştırıcısını temsil eder.
semantic	İleri anlamsal modelleme için anlamsal sorgu ayrıştırıcısını temsil eder.
vector	Hesaplanan veri üzerinde vektör aramasını temsil eder.
vector_simple_hybrid	Basit sorgulama stratejisi ile vektör verisinin birleşimini temsil eder.
vector_semantic_hybrid	Anlamsal arama ve vektör veri sorgulamasının bir kombinasyonunu temsil eder.

azureCosmosDBChatExtensionConfiguration

Azure Cosmos DB'yi Azure OpenAI sohbet uzantısı olarak kullanıldığında yapılandırılabilir seçeneklerin özel bir temsili.

Name	Type	Description	Required	Default
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin bir temsili. Bu, bir sohbet tarafından kullanılacak Yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama talepleri. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Yes
parameters	azureCosmosDBChatExtensionParameters	Azure OpenAI On Your Data sohbet uzantılarını Azure Cosmos DB için kullanırken kullanılacak parametreler MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

MongoDB vCore için Azure Cosmos DB kullanırken Azure OpenAI On Your Data sohbet uzantılarını yapılandırırken kullanılacak parametreler.

Name	Type	Description	Required
authentication	onYourDataConnectionStringAuthenticationOptions	Azure OpenAI On Your Data için bağlantı dizesi kullanılırken kimlik doğrulama seçenekleri.	Yes
top_n_documents	integer	Yapılandırılmış sorgu için özellik yapılacak en yüksek belge sayısı.	No
in_scope	boolean	Sorguların indekslenmiş verilerin kullanımıyla sınırlandırılıp sınırlamayacağı.	No
strictness	integer	Arama alaka filtrelemesinin yapılandırılmış katılığı. Ne kadar katı olursa, o kadar yüksek hassasiyet ama cevap hatırlama o kadar düşüktür.	No
role_information	string	Modele nasıl davranması gerektiği ve yanıt oluştururken referans vermesi gereken herhangi bir bağlama dair talimatlar verin. Asistanın kişiliğini tarif edebilir ve ona yanıtların nasıl biçimlendirileceğini söyleyebilirsiniz. Bunun için 100 token sınırı var ve bu toplam token sınırına dahil edilir.	No
database_name	string	Azure Cosmos DB ile kullanılacak MongoDB vCore veritabanı adı.	Yes
container_name	string	Azure Cosmos DB kaynak konteynerinin adı.	Yes
index_name	string	Azure Cosmos DB ile kullanılacak MongoDB vCore indeks adı.	Yes
fields_mapping	azureCosmosDBFieldMappingOptions	Yapılandırılmış Azure Cosmos DB kaynağı kullanıldığında alanların nasıl işlenildiğini kontrol etmek için isteğe bağlı ayarlar.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Yes

azureCosmosDBFieldMappingOptions

Yapılandırılmış Azure Cosmos DB kaynağı kullanıldığında alanların nasıl işlenildiğini kontrol etmek için isteğe bağlı ayarlar.

Name	Type	Description	Required
title_field	string	Başlık olarak kullanılacak indeks alanının adı.	No
url_field	string	URL olarak kullanılacak indeks alanının adı.	No
filepath_field	string	Dosya yolu olarak kullanılacak indeks alanının adı.	No
content_fields	array	İçerik olarak ele alınması gereken indeks alanlarının isimleri.	Yes
content_fields_separator	string	İçerik alanlarının kullanması gereken ayırıcı deseni.	No
vector_fields	array	Vektör verisini temsil eden alanların isimleri.	Yes

onYourDataAuthenticationOptions

Azure OpenAI On Your Data için kimlik doğrulama seçenekleri.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.	Yes

onYourDataAuthenticationType

Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.

Description: OpenAI On Your Data Azure ile desteklenen kimlik doğrulama türleri.

Type: string

Default:

Enum Adı: OnYourDataAuthenticationType

Enum Values:

Value	Description
api_key	API anahtarı üzerinden kimlik doğrulama.
connection_string	Kimlik doğrulama bağlantı dizesi ile.
system_assigned_managed_identity	Sistem tarafından atanan yönetilen kimlik üzerinden kimlik doğrulama.
user_assigned_managed_identity	Kullanıcı tarafından atanan yönetilen kimlik üzerinden kimlik doğrulama.

onYourDataApiKeyAuthenticationOptions

API anahtarı kullanırken Azure OpenAI On Your Data için kimlik doğrulama seçenekleri.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.	Yes
key	string	Kimlik doğrulama için kullanılacak API anahtarı.	No

onYourDataConnectionStringAuthenticationOptions

Azure OpenAI On Your Data için bağlantı dizesi kullanılırken kimlik doğrulama seçenekleri.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.	Yes
connection_string	string	Kimlik doğrulama için kullanılacak bağlantı dizesi.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

Sistem tarafından atanan yönetilen bir kimlik kullanıldığında Azure OpenAI On Your Data için kimlik doğrulama seçenekleri.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

Kullanıcı tarafından atanan yönetilen bir kimlik kullanıldığında Azure OpenAI On Your Data için kimlik doğrulama seçenekleri.

Name	Type	Description	Required	Default
type	onYourDataAuthenticationType	Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.	Yes
managed_identity_resource_id	string	Kimlik doğrulama için kullanılacak kullanıcı tarafından atanan yönetilen kimliğin kaynak kimliği.	No

onYourDataVectorizationSource

Azure OpenAI On Your Data için vektör aramasıyla vektör aramasıyla vektörleşme kaynağının soyut bir temsili.

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Azure OpenAI On Your Data'nın verilerin vektörizasyonunu yapılandırmak için kullanabileceği mevcut kaynakları temsil eder vector search.	Yes

onYourDataVectorizationSourceType

Azure OpenAI On Your Data'nın veri vektör aramasıyla kullanılacak şekilde vektörleştirme yapılandırabileceği mevcut kaynakları temsil eder.

Description: OpenAI On Your Data'Azure nın verilerin vektörleştirilmesini yapılandırmak için kullanabileceği mevcut kaynakları temsil eder
vector search.

Type: string

Default:

Enum Adı: OnYourDataVectorizationSourceType

Enum Values:

Value	Description
endpoint	Azure OpenAI gömme modeline kamu hizmeti çağrılarıyla yapılan vektörizasyonu temsil eder.
deployment_name	Kullanılacak bir Ada model dağıtım adını temsil eder. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalı, ancak On Your Data, bu model dağıtımını genel çağrı yerine dahili bir çağrı yoluyla kullanır ve bu da vektör etkinleştirir Özel ağlarda bile arama yapın.

onYourDataDeploymentNameVectorizationSource

Azure OpenAI tarafından vektör araması uygulanırken kullanılan ve aynı Azure OpenAI kaynağında dahili gömme modeli dağıtım adına dayanan vektörizasyon kaynağının detayları.

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Azure OpenAI On Your Data'nın verilerin vektörizasyonunu yapılandırmak için kullanabileceği mevcut kaynakları temsil eder vector search.	Yes
deployment_name	string	Vektörleştirme için kullanılacak model dağıtımının adını belirtir. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalı, ancak On Your Data bu model dağıtımını genel çağrı yerine dahili çağrı yoluyla kullanacak; bu da özel ağlarda bile vektör aramasını mümkün kılıyor.	No

onYourDataEndpointVectorizationSource

Azure OpenAI tarafından vektör arama uygulanırken kullanılan ve kamuya açık Azure OpenAI uç noktasına dayalı bir vektörleştirme kaynağının detayları, gömme çağrısı yapar.

Name	Type	Description	Required
type	onYourDataVectorizationSourceType	Azure OpenAI On Your Data'nın verilerin vektörizasyonunu yapılandırmak için kullanabileceği mevcut kaynakları temsil eder vector search.	Yes
authentication	onYourDataApiKeyAuthenticationOptions	API anahtarı kullanırken Azure OpenAI On Your Data için kimlik doğrulama seçenekleri.	No
endpoint	string	Vektörleştirme için kullanılacak uç noktayı belirtir. Bu uç nokta aynı Azure OpenAI kaynağında olmalı, ancak On Your Data bu uç noktayı kamuya açık çağrı yerine dahili çağrı yoluyla kullanır; bu da özel ağlarda bile vektör aramasını mümkün kılar.	No

azureChatExtensionsMessageContext

Azure OpenAI sohbet uzantıları ilgili bir sohbet tamamlama yanıtının oluşturulmasında yer aldığında mevcut ek bağlam bilgisinin temsili. Bu bağlam bilgisi, yalnızca Azure OpenAI isteği kullanılarak eşleşen bir uzantı kullanıldığında doldurulur.

Name	Type	Description	Required	Default
citations	array	Veri kaynağı alma sonucu, yanıtta asistan mesajını oluşturmak için kullanılır.	No
intent	string	Sohbet geçmişinden tespit edilen niyet, bağlamı aktarmak için bir sonraki tura geçer.	No

citation

Sohbet tamamlama yanıt mesajı için kaynak bilgisi.

Name	Type	Description	Required
content	string	Alıntının içeriği.	Yes
title	string	Atakın başlığı.	No
url	string	Atıfın URL'si.	No
filepath	string	Atakın dosya yolu.	No
chunk_id	string	Atıfın bölüm ID'si.	No

chatCompletionMessageToolCall

Name	Type	Description	Required
id	string	Araç çağrısının kimliği.	Yes
type	toolCallType	Bu durumda araç çağrısının `function`türü.	Yes
function	object	Modelin çağırdığı fonksiyon.	Yes

Fonksiyon için özellikler

name

Name	Type	Description	Default
name	string	Çağrılacak fonksiyonun adı.

arguments

Name	Type	Description	Default
arguments	string	Fonksiyonu çağırmak için argümanlar, model tarafından JSON formatında oluşturulur. Modelin her zaman geçerli JSON üretmediğini ve fonksiyon şemanızda tanımlanmayan parametreler üretebileceğini unutmayın. Fonksiyonunuzu çağırmadan önce kodunuzdaki argümanları doğrulayın.

toolCallType

Bu durumda araç çağrısının functiontürü.

Açıklama: Bu durumda araç çağrısının functiontürü.

Type: string

Default:

Enum Adı: ToolCallType

Enum Values:

Value	Description
function	Araç çağrısı türü fonksiyondur.

chatCompletionRequestMessageTool

Name	Type	Description	Required	Default
tool_call_id	string	Bu mesajın yanıt verdiği araç çağrısı.	No
content	string	Mesajın içeriği.	No

chatCompletionRequestMessageFunction

Name	Type	Description	Required
role	enum	Mesaj yazarının rolü, bu durumda `function`. Olası değerler: fonksiyon	No
name	string	Mesajın içeriği.	No
content	string	Mesajın içeriği.	No

createChatCompletionResponse

Sunulan girdiye göre model tarafından döndürülen sohbet tamamlanma yanıtını temsil eder.

Name	Type	Description	Required
id	string	Sohbet tamamlanması için benzersiz bir tanımlayıcı.	Yes
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Bir yayın isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı sıralarda gelebilir.	No
choices	array	Sohbet tamamlama seçeneklerinin bir listesi. Birden fazla olabilir, eğer `n` 1'den büyükse.	Yes
created	integer	Sohbetin tamamlanma anının Unix zaman damgası (saniyeler cinsinden).	Yes
model	string	Sohbet tamamlama için kullanılan model.	Yes
system_fingerprint	string	Bu parmak izi, modelin çalıştığı arka uç konfigürasyonunu temsil eder. Backend değişikliklerinin determinizmi etkileyebileceği zamanlarda yapıldığını anlamak için `seed` talep parametresiyle birlikte kullanılabilir.	No
object	enum	Nesne türü, her zaman `chat.completion`. Olası değerler: chat.completion	Yes
usage	completionUsage	Tamamlama talebi için kullanım istatistikleri.	No

createChatCompletionStreamResponse

Sunulan girdiye göre model tarafından döndürülen sohbet tamamlanma yanıtının akışlı bir parçasını temsil eder.

Name	Type	Description	Required
id	string	Sohbet tamamlanması için benzersiz bir tanımlayıcı. Her parçanın aynı kimliği vardır.	Yes
choices	array	Sohbet tamamlama seçeneklerinin bir listesi. Eğer `n` 1'den büyükse, birden fazla eleman içerebilir.	Yes
created	integer	Sohbetin tamamlanma anının Unix zaman damgası (saniyeler cinsinden). Her parçanın aynı zaman damgası vardır.	Yes
model	string	Tamamlanmayı üreten model.	Yes
system_fingerprint	string	Bu parmak izi, modelin çalıştığı arka uç konfigürasyonunu temsil eder. Backend değişikliklerinin determinizmi etkileyebileceği zamanlarda yapıldığını anlamak için `seed` talep parametresiyle birlikte kullanılabilir.	No
object	enum	Nesne türü, her zaman `chat.completion.chunk`. Olası değerler: chat.completion.chunk	Yes

chatCompletionStreamResponseDelta

Akışlı model yanıtları tarafından oluşturulan bir sohbet tamamlama deltası.

Name	Type	Description	Required
content	string	Mesajın içeriği.	No
function_call	object	Kullanımdan kaldırıldı ve yerine `tool_calls`. Model tarafından oluşturulan çağrılması gereken fonksiyonun adı ve argümanları.	No
tool_calls	array		No
role	enum	Bu mesajın yazarının rolü. Olası değerler: sistem, kullanıcı, asistan, araç	No
refusal	string	Model tarafından oluşturulan reddetme mesajı.	No

function_call için özellikler

arguments

Name	Type	Description	Default
arguments	string	Fonksiyonu çağırmak için argümanlar, model tarafından JSON formatında oluşturulur. Modelin her zaman geçerli JSON üretmediğini ve fonksiyon şemanızda tanımlanmayan parametreler üretebileceğini unutmayın. Fonksiyonunuzu çağırmadan önce kodunuzdaki argümanları doğrulayın.

name

Name	Type	Description	Default
name	string	Çağrılacak fonksiyonun adı.

chatCompletionMessageToolCallChunk

Name	Type	Description	Required
index	integer		Yes
id	string	Araç çağrısının kimliği.	No
type	enum	Aracın türü. Şu anda sadece `function` destekleniyor. Olası değerler: fonksiyon	No
function	object		No

Fonksiyon için özellikler

name

Name	Type	Description	Default
name	string	Çağrılacak fonksiyonun adı.

arguments

Name	Type	Description	Default
arguments	string	Fonksiyonu çağırmak için argümanlar, model tarafından JSON formatında oluşturulur. Modelin her zaman geçerli JSON üretmediğini ve fonksiyon şemanızda tanımlanmayan parametreler üretebileceğini unutmayın. Fonksiyonunuzu çağırmadan önce kodunuzdaki argümanları doğrulayın.

chatCompletionStreamOptions

Yayın yanıtı seçenekleri. Bunu sadece ayarladığınızda stream: trueayarlayın.

Name	Type	Description	Required	Default
include_usage	boolean	Ayarlanmışsa, mesajdan `data: [DONE]` önce ek bir parça yayınlanır. Bu parçadaki alan, `usage` tüm isteğin token kullanım istatistiklerini gösterir ve alan `choices` her zaman boş bir dizi olur. Diğer tüm parçalar da bir `usage` alan içerecek, ancak sıfır değerli.	No

chatCompletionChoiceLogProbs

Seçim için olasılık bilgilerini kaydedin.

Name	Type	Description	Required	Default
content	array	Log olasılık bilgisi içeren mesaj içeriği tokenleri listesi.	Yes
refusal	array	Log olasılık bilgisi içeren mesaj reddetme tokenlarının bir listesi.	No

chatCompletionTokenLogprob

Name	Type	Description	Required
token	string	The token.	Yes
logprob	number	Bu tokenın log olasılığı.	Yes
bytes	array	Token'ın UTF-8 baytlık temsilini temsil eden tam sayıların bir listesi. Karakterlerin birden fazla token ile temsil edildiği ve bayt temsillerinin doğru metin temsili oluşturmak için birleştirilmesi gerektiğinde faydalıdır. Token için bayt temsili yoksa olabilir `null` .	Yes
top_logprobs	array	En muhtemel tokenların listesi ve log olasılıkları, bu token konumundaki konumda. Nadir durumlarda, başvurulan iade sayısından `top_logprobs` daha az olabilir.	Yes

chatCompletionResponseMessage

Model tarafından oluşturulan bir sohbet tamamlama mesajı.

Name	Type	Description	Required
role	chatCompletionResponseMessageRole	Yanıt mesajının yazarının rolü.	Yes
refusal	string	Model tarafından oluşturulan reddetme mesajı.	Yes
content	string	Mesajın içeriği.	Yes
tool_calls	array	Model tarafından oluşturulan araç çağrıları, örneğin fonksiyon çağrıları.	No
function_call	chatCompletionFunctionCall	Kullanımdan kaldırıldı ve yerine `tool_calls`. Model tarafından oluşturulan çağrılması gereken fonksiyonun adı ve argümanları.	No
context	azureChatExtensionsMessageContext	Azure OpenAI sohbet uzantıları söz verildiğinde mevcut ek bağlam bilgisinin bir temsili Karşılık gelen bir sohbet tamamlama yanıtının oluşturulmasında. Bu bağlam bilgisi ancak şu zaman doldurulur; Azure OpenAI isteği kullanılarak eşleşen bir uzantı kullanılıyor.	No

chatCompletionResponseMessageRole

Yanıt mesajının yazarının rolü.

Tanım: Yanıt mesajının yazarının rolü.

Type: string

Default:

Enum Values:

assistant

chatCompletionToolChoiceOption

Modelin hangi (varsa) aracı denmesini sağlar. none bu, modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir mesaj oluşturacağı anlamına gelir. auto Modelin mesaj üretmek veya bir veya daha fazla aracı çağırmak arasında seçim yapabileceği anlamına gelir. required Modelin bir veya daha fazla aracı çağırması gerektiği anlamına gelir. Belirli bir aracı belirtmek, {"type": "function", "function": {"name": "my_function"}} modelin o aracı çağırmasını zorunlu kılar. none araç yokken varsayılan olarak kullanılır. auto araçlar varsa varsayılan olarak kullanılır.

Bu bileşen aşağıdakilerden biri olabilir:

chatCompletionNamedToolChoice

Modelin kullanması gereken aracı belirtir. Modeli belirli bir fonksiyonu çağırmaya zorlamak için kullanılır.

Name	Type	Description	Required	Default
type	enum	Aracın türü. Şu anda sadece `function` destekleniyor. Olası değerler: fonksiyon	Yes
function	object		Yes

Fonksiyon için özellikler

name

Name	Type	Description	Default
name	string	Çağrılacak fonksiyonun adı.

ParallelToolCalls

Araç kullanımı sırasında paralel fonksiyon çağrısını etkinleştirip etkinleştirmediği.

Bu bileşen için tanımlanmış bir özellik yok.

chatCompletionMessageToolCalls

Model tarafından oluşturulan araç çağrıları, örneğin fonksiyon çağrıları.

Bu bileşen için tanımlanmış bir özellik yok.

chatCompletionFunctionCall

Kullanımdan kaldırıldı ve yerine tool_calls. Model tarafından oluşturulan çağrılması gereken fonksiyonun adı ve argümanları.

Name	Type	Description	Required	Default
name	string	Çağrılacak fonksiyonun adı.	Yes
arguments	string	Fonksiyonu çağırmak için argümanlar, model tarafından JSON formatında oluşturulur. Modelin her zaman geçerli JSON üretmediğini ve fonksiyon şemanızda tanımlanmayan parametreler üretebileceğini unutmayın. Fonksiyonunuzu çağırmadan önce kodunuzdaki argümanları doğrulayın.	Yes

completionUsage

Tamamlama talebi için kullanım istatistikleri.

Name	Type	Description	Required
prompt_tokens	integer	İsterdeki jeton sayısı.	Yes
completion_tokens	integer	Oluşturulan tamamlamada jeton sayısı.	Yes
total_tokens	integer	İstekte kullanılan toplam token sayısı (prompt + tamamlanma).	Yes
completion_tokens_details	object	Bir tamamlamada kullanılan jetonların dağılımı.	No

completion_tokens_details için özellikler

reasoning_tokens

Name	Type	Description	Default
reasoning_tokens	integer	Model tarafından oluşturulan tokenlar, akıl yürütme için.

chatCompletionTool

Name	Type	Description	Required	Default
type	enum	Aracın türü. Şu anda sadece `function` destekleniyor. Olası değerler: fonksiyon	Yes
function	FunctionObject		Yes

FunctionParameters

Fonksiyonların kabul ettiği parametreler, JSON Şema nesnesi olarak tanımlanır. Örnekler için rehbere ve format hakkında dokümantasyon için JSON Schema referansına bakınız.

Atlama, parameters boş bir parametre listesine sahip bir fonksiyon tanımlar.

Bu bileşen için tanımlanmış bir özellik yok.

FunctionObject

Name	Type	Description	Required	Default
description	string	Modelin fonksiyonu ne zaman ve nasıl çağıracağını seçmek için kullandığı fonksiyonun ne iş yaptığına dair bir açıklama.	No
name	string	Çağrılacak fonksiyonun adı. A-z, A-Z, 0-9 olmalı veya alt çizgi ve tire içeren olmalı, maksimum uzunluğu 64 olmalıdır.	Yes
parameters	FunctionParameters	Fonksiyonların kabul ettiği parametreler, JSON Şema nesnesi olarak tanımlanır. Örnekler için rehbere ve format hakkında dokümantasyon için JSON Schema referansına bakınız. Atlama, `parameters` boş bir parametre listesine sahip bir fonksiyon tanımlar.	No
strict	boolean	Fonksiyon çağrısı oluşturulurken sıkı şema uyumunu mümkün kılıp açmayacağı. Doğru olarak ayarlanırsa, model alanda `parameters` tanımlanan tam şemayı takip eder. Yalnızca JSON şemasının bir alt kümesi desteklenir, ne `strict` zaman .`true`	No	False

ResponseFormatText

Name	Type	Description	Required	Default
type	enum	Tanımlanan yanıt formatı türü: `text` Olası değerler: metin	Yes

ResponseFormatJsonObject

Name	Type	Description	Required	Default
type	enum	Tanımlanan yanıt formatı türü: `json_object` Olası değerler: json_object	Yes

ResponseFormatJsonSchemaSchema

Yanıt formatı için şema, JSON Şema nesnesi olarak tanımlanır.

Bu bileşen için tanımlanmış bir özellik yok.

ResponseFormatJsonSchema

Name	Type	Description	Required	Default
type	enum	Tanımlanan yanıt formatı türü: `json_schema` Olası değerler: json_schema	Yes
json_schema	object		Yes

json_schema için özellikler

description

Name	Type	Description	Default
description	string	Yanıt formatının ne için olduğunu tanımlayan bir açıklama, model tarafından formatta nasıl yanıt verileceğini belirlemek için kullanılır.

name

Name	Type	Description	Default
name	string	Yanıt formatının adı. A-z, A-Z, 0-9 olmalı veya alt çizgi ve tire içeren olmalı, maksimum uzunluğu 64 olmalıdır.

schema

Name	Type	Description	Default
schema	ResponseFormatJsonSchemaSchema	Yanıt formatı için şema, JSON Şema nesnesi olarak tanımlanır.

strict

Name	Type	Description	Default
strict	boolean	Çıktı üretirken sıkı şema uyumunu etkinleştirip etkinleştirilmeyeceği. Doğru olarak ayarlandığında, model her zaman alanda `schema` tanımlanan tam şemayı takip eder. Yalnızca JSON şemasının bir alt kümesi desteklenir, ne `strict` zaman .`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	Çevirilmesi gereken ses dosyası.	Yes
prompt	string	Modelin stilini yönlendirmek veya önceki bir ses segmentini sürdürmek için isteğe bağlı bir metin. Yönlendirme İngilizce olmalı.	No
response_format	audioResponseFormat	Çıktının formatını tanımlar.	No
temperature	number	Örnekleme sıcaklığı, 0 ile 1 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. 0 olarak ayarlandığında, model belirli eşiklere ulaşana kadar sıcaklığı otomatik olarak artırmak için log olasılık kullanır.	No	0

audioResponse

Çeviri veya transkripsiyon yanıtı response_format json olduğunda

Name	Type	Description	Required	Default
text	string	Çevirilmiş veya transkribe edilmiş metin.	Yes

audioVerboseResponse

Çeviri veya transkripsiyon yanıtı response_format verbose_json

Name	Type	Description	Required
text	string	Çevirilmiş veya transkribe edilmiş metin.	Yes
task	string	Sesli bir görev türü.	No
language	string	Language.	No
duration	number	Duration.	No
segments	array		No

audioResponseFormat

Çıktının formatını tanımlar.

Açıklama: Çıktının formatını tanımlar.

Type: string

Default:

Enum Values:

json
text
srt
verbose_json
vtt

createTranscriptionRequest

Transcription request.

Name	Type	Description	Required	Default
file	string	Ses dosyası nesnesini transkribe etmek için.	Yes
prompt	string	Modelin stilini yönlendirmek veya önceki bir ses segmentini sürdürmek için isteğe bağlı bir metin. İstem ses diline uymalı.	No
response_format	audioResponseFormat	Çıktının formatını tanımlar.	No
temperature	number	Örnekleme sıcaklığı, 0 ile 1 arasında. 0.8 gibi daha yüksek değerler çıktıyı daha rastgele yaparken, 0.2 gibi daha düşük değerler daha odaklanmış ve deterministik hale getirir. 0 olarak ayarlandığında, model belirli eşiklere ulaşana kadar sıcaklığı otomatik olarak artırmak için log olasılık kullanır.	No	0
language	string	Giriş sesinin dili. Giriş dilinin ISO-639-1 formatında sağlanması, doğruluk ve gecikmeyi artıracaktır.	No

audioSegment

Transkripsiyon veya çeviri bölümü.

Name	Type	Description	Required
id	integer	Segment identifier.	No
seek	number	Segmentin ofseti.	No
start	number	Segment başlangıcı offset.	No
end	number	Segment ucu offseti.	No
text	string	Segment text.	No
tokens	array	Metnin sembolleri.	No
temperature	number	Temperature.	No
avg_logprob	number	Ortalama log olasılığı.	No
compression_ratio	number	Compression ratio.	No
no_speech_prob	number	Olasılığı `no speech`.	No

imageQuality

Üretilecek görüntünün kalitesi.

Açıklama: Oluşturulacak görüntünün kalitesi.

Type: string

Default: standard

Enum Adı: Kalite

Enum Values:

Value	Description
standard	Standart kalite, standart kalitede görüntüler yaratır.
hd	HD kalitesi, görüntü boyunca daha ince detaylara ve daha yüksek tutarlılığa sahip görüntüler yaratır.

imagesResponseFormat

Oluşturulan görüntülerin geri dönüş biçimi.

Açıklama: Oluşturulan görüntülerin geri gönderildiği format.

Type: string

Default: url

Enum Adı: ImagesResponseFormat

Enum Values:

Value	Description
url	Oluşturulan görselleri indirmek için geçici erişim sağlayan URL.
b64_json	Oluşturulan görüntüler base64 kodlanmış dizi olarak geri döner.

imageSize

Oluşturulan görüntülerin boyutu.

Açıklama: Oluşturulan görüntülerin boyutu.

Type: string

Default: 1024x1024

Enum Adı: Boyut

Enum Values:

Value	Description
1792x1024	Üretilen görüntünün istenen boyutu 1792x1024 pikseldir.
1024x1792	Üretilen görüntünün istenen boyutu 1024x1792 pikseldir.
1024x1024	Üretilen görüntünün istenen boyutu 1024x1024 pikseldir.

imageStyle

Oluşturulan görüntülerin stili.

Açıklama: Oluşturulan görsellerin stili.

Type: string

Default: vivid

Enum Adı: Stil

Enum Values:

Value	Description
vivid	Vivid, aşırı gerçekçi ve dramatik görüntüler yaratıyor.
natural	Natural, daha doğal ve daha az aşırı gerçekçi görüntüler yaratır.

imageGenerationsRequest

Name	Type	Description	Required	Default
prompt	string	İstenen görsel(ler)in metin açıklaması. Maksimum uzunluk 4.000 karakterdir.	Yes
n	integer	Üretilecek görüntü sayısı.	No	1
size	imageSize	Oluşturulan görüntülerin boyutu.	No	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin geri dönüş biçimi.	No	url
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No
quality	imageQuality	Üretilecek görüntünün kalitesi.	No	standard
style	imageStyle	Oluşturulan görüntülerin stili.	No	vivid

generateImagesResponse

Name	Type	Description	Required	Default
created	integer	İşlemin oluşturulduğu unix zaman damgası.	Yes
data	array	İşlemin sonuç verileri, başarılı olursa	Yes

imageResult

Başarılıysa resim URL'si veya kodlanmış görüntü, aksi takdirde hata olur.

Name	Type	Description	Required
url	string	Resim URL'si.	No
b64_json	string	base64 kodlanmış görüntü	No
content_filter_results	dalleContentFilterResults	İçerik filtreleme sonuçları hakkında bilgi.	No
revised_prompt	string	Eğer isteğinde herhangi bir değişiklik varsa, görüntü oluşturmak için kullanılan istem kullanıldı.	No
prompt_filter_results	dalleFilterResults	İçerik filtreleme kategorisi hakkında bilgiler (nefret, cinsel, şiddet self_harm), tespit edilip edilmediği, şiddet seviyesi (zararlı içeriğin yoğunluğunu ve risk seviyesini belirleyen very_low, düşük, orta, yüksek ölçek) ve filtrelenip filtrelenmediği. Jailbreak içeriği ve küfürler hakkında bilgiler, tespit edilip edilmediği, filtrelenip filtrelenmediği hakkında bilgiler. Ve müşteri engelleme listesi hakkında, filtrelenip filtrelenmişler ve kimliği hakkında bilgiler.	No

Completions extensions

Tamamlama uzantıları, Azure OpenAI veri düzlemi çıkarım spesifikasyonunun en son GA sürümünde yer almaz.

Chatmessage

Sohbet mesajı nesnesi, Azure OpenAI veri düzlemi çıkarım spesifikasyonunun en son GA sürümünde yer almaz.

Metinden konuşmaya (Önizleme)

Şu anda Azure OpenAI veri düzlemi çıkarım spesifikasyonunun en son Azure OpenAI GA versiyonunun bir parçası değildir. Bu özellik için en son önizleme sürümüne bakabilirsiniz.

Next steps

Modeller hakkında bilgi edinin ve REST API ile ince ayar yapın. OpenAI Azure destekleyen underlying modelleri hakkında daha fazla bilgi edinin.

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2026-05-06