Microsoft Foundry Modellerinde OpenAI REST API başvurusu Azure

Bu makalede, Azure OpenAI için çıkarım REST API uç noktalarıyla ilgili ayrıntılar sağlanır.

API belirtimleri

Azure OpenAI modellerini ve kaynaklarını yönetme ve bunlarla etkileşim kurma, üç birincil API yüzeyine ayrılır:

Kontrol düzlemi
Veri düzlemi - yazma
Veri düzlemi - çıkarım

Her API surface/belirtimi farklı bir Azure OpenAI özelliklerini kapsüller. Her API'nin kendi benzersiz önizleme ve kararlı/genel kullanıma açık (GA) API sürümleri vardır. Önizleme sürümleri şu anda aylık bir tempo takip etme eğilimindedir.

Önemli

Artık yeni bir önizleme çıkarım API'si vardır. API yaşam döngüsü kılavuzumuzdan daha fazla bilgi edinin.

API	En son önizleme sürümü	En son GA sürümü	Specifications	Description
Kontrol düzlemi	`2025-07-01-preview`	`2025-06-01`	Spec dosyaları	Denetim düzlemi API'si 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. Azure Resource Manager, Bicep, Terraform ve Azure CLI gibi özelliklerle to do mümkün olanları da kontrol düzlemi yönetir.
Veri düzlemi	`v1 preview`	`v1`	Spec dosyaları	Veri düzlemi API'si çıkarım ve yazma işlemlerini denetler.

Authentication

Azure OpenAI kimlik doğrulaması için iki yöntem sağlar. API Anahtarlarını veya Microsoft Entra ID kullanabilirsiniz.

API Anahtarı kimlik doğrulaması: Bu kimlik doğrulaması türü için tüm API istekleri HTTP üst bilgisinde api-key API Anahtarını içermelidir. Hızlı Başlangıç, bu kimlik doğrulaması türüyle çağrı yapma konusunda rehberlik sağlar.
Microsoft Entra ID authentication: Microsoft Entra belirtecini kullanarak API çağrısının kimliğini doğrulayabilirsiniz. Kimlik doğrulama belirteçleri bir isteğe üst bilgi olarak Authorization eklenir. Sağlanan belirtecin önünde Bearer, örneğin Bearer YOUR_AUTH_TOKENolmalıdır. Microsoft Entra ID ile authenticating ile ilgili nasıl yapılır kılavuzumuzu okuyabilirsiniz.

REST API sürümü oluşturma

Hizmet API'lerinin sürümü api-version sorgu parametresi kullanılarak oluşturulur. Tüm sürümler YYYY-AA-GG tarih yapısını izler. Örneğin:

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ı, Azure OpenAI veri düzlemi çıkarım belirtimi 2024-10-21 GA sürümünü kapsar.

En son önizleme API'sinin sürümüyle ilgili belgeler arıyorsanız en son önizleme veri düzlemi çıkarım API'sine bakın

Tamamlamalar

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

Sağlanan istem, parametreler ve seçilen model için bir tamamlama oluşturur.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai. azure.com
deployment-id (yenileme kimliği)	path	Evet	String	Dağıtılan modelin dağıtım kimliği.
API-sürümü	soru	Evet	String	API sürümü

İstek Başlığı

İsim	Gerekli	Türü	Description
API anahtarı	Doğru	String	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
prompt	dize veya dizi	Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi. \|endoftext\|< öğesinin>, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur.	Evet
en iyi	tamsayı	Tamamlamaları `best_of` sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz. ile `n`kullanıldığında, `best_of` aday tamamlama sayısını denetler ve `n` döndürülecek sayı sayısını belirtir â€" `best_of` değerinin değerinden `n`büyük olması gerekir. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `max_tokens`için `stop` makul ayarlara sahip olduğunuzdan emin olun.	Hayı	1
echo	Boolean	Tamamlamaya ek olarak istemi geri yankıla	Hayı	Yanlış
frekans cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayı	0
logit önyargısı	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (GPT belirteç oluşturucusunda belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, \|endoftext\|`{"50256": -100}` belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz>.	Hayı	Hiç kimse
logprobs	tamsayı	Günlük olasılıklarını `logprobs` en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise `logprobs` , API en olası beş belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür `logprob` , bu nedenle yanıtta en `logprobs+1` fazla öğe olabilir. için `logprobs` en büyük değer 5'tir.	Hayı	Hiç kimse
maksimum_token	tamsayı	Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı. İsteminizin ve artı `max_tokens` değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz.	Hayı	16
n	tamsayı	Her istem için kaç tamamlama oluşturulacağı. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `max_tokens`için `stop` makul ayarlara sahip olduğunuzdan emin olun.	Hayı	1
varlık cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayı	0
seed	tamsayı	Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayı
stop	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Döndürülen metin durdurma sırasını içermez.	Hayı
veri akışı	Boolean	Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	Hayı	Yanlış
suffix	String	Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için `gpt-3.5-turbo-instruct`desteklenir.	Hayı	Hiç kimse
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz `top_p` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz `temperature` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
uygulama/json	createCompletionResponse	API'den bir tamamlama yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli paylaşır (sohbet uç noktasından farklı olarak).

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

İçerik Türü	Türü	Açıklama
uygulama/json	errorResponse

Örnekler

Example

Sağlanan istem, 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
    }
  }
}

Eklemeler

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

machine learning modelleri ve algoritmaları tarafından kolayca tüketilebilen belirli bir girişin vektör gösterimini alın.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai. azure.com
deployment-id (yenileme kimliği)	path	Evet	String
API-sürümü	soru	Evet	String	API sürümü

İstek Başlığı

İsim	Gerekli	Türü	Description
API anahtarı	Doğru	String	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli
girdi	dize veya dizi	Eklemek için metin girin, dize veya belirteç dizisi olarak kodlanmış. Tek bir isteğe birden çok giriş eklemek için bir dizi dize veya belirteç dizisi geçirin. Giriş, model için maksimum giriş belirteçlerini aşmamalıdır (için `text-embedding-ada-002`8.192 belirteç), boş bir dize olamaz ve herhangi bir dizi 2.048 boyut veya daha az olmalıdır.	Evet
user	String	Kötüye kullanımı izlemeye ve algılamaya yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
girdi_tipi	String	kullanılacak ekleme aramasının giriş türü	Hayı
encoding_format	String	Eklemelerin döndürüleceği biçim. veya `float`olabilir`base64`. Varsayılan olarak `float` değerini alır.	Hayı
dimensions	tamsayı	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde `text-embedding-3` desteklenir.	Hayı

Yanıtlar

İsim	Türü	Gerekli
nesne	String	Evet
model	String	Evet
veriler	dizi	Evet
usage	nesne	Evet

Kullanım özellikleri

prompt_tokens

İsim	Türü	Description	Varsayılan
prompt_tokens	tamsayı

total_tokens

İsim	Türü	Description	Varsayılan
total_tokens	tamsayı

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
uygulama/json	nesne

Örnekler

Example

Belirli bir istem için eklemeleri döndürü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
    }
  }
}

Sohbet bitişleri

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

Sohbet iletisi için tamamlama oluşturur

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai. azure.com
deployment-id (yenileme kimliği)	path	Evet	String	Dağıtılan modelin dağıtım kimliği.
API-sürümü	soru	Evet	String	API sürümü

İstek Başlığı

İsim	Gerekli	Türü	Description
API anahtarı	Doğru	String	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz `top_p` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz `temperature` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
veri akışı	Boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	Hayı	Yanlış
stop	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	Hayı
maksimum_token	tamsayı	Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı. Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır.	Hayı
max_completion_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
varlık cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayı	0
frekans cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayı	0
logit önyargısı	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.	Hayı	Hiç kimse
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
Mesajlar	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi.	Evet
data_sources	dizi	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.	Hayı
logprobs	Boolean	Çıkış belirteçlerinin günlük olasılıklarının döndürülmesi veya döndürülmemesi. True ise, içinde döndürülen `contentmessage`her çıkış belirtecinin günlük olasılıklarını döndürür.	Hayı	Yanlış
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı. `logprobs` bu parametre kullanılıyorsa olarak ayarlanmalıdır `true` .	Hayı
n	tamsayı	Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceksiniz. Maliyetleri en aza indirmek için farklı `n` tutun`1`.	Hayı	1
paralel araç çağrıları	ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı	Doğru
yanıt formatı	ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema	Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o, GPT-4o mini, GPT-4 Turbo ve tüm GPT-3.5 Turbo modelleri `gpt-3.5-turbo-1106` daha yenidir. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşeceğini garanti eden Yapılandırılmış Çıkışlar'ı etkinleştirir. ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli JSON olduğunu garanti eden JSON modunu etkinleştirir. Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `finish_reason="length"` gösteren ileti `max_tokens`içeriğinin kısmen kesilebileceğini unutmayın.	Hayı
seed	tamsayı	Bu özellik Beta sürümündedir. Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayı
araçlar	dizi	Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın. En fazla 128 işlev desteklenir.	Hayı
tool_choice	chatCompletionToolChoiceOption	Model tarafından çağrılan aracı (varsa) denetler. `none` modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. `required` modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla `{"type": "function", "function": {"name": "my_function"}}` belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar. `none` hiçbir araç mevcut olmadığında varsayılan değerdir. `auto` araçlar varsa varsayılan değerdir.	Hayı
function_call	string veya chatCompletionFunctionCallOption	yerine `tool_choice`kullanım dışı bırakıldı. Model tarafından çağrılan (varsa) işlevi denetler. `none` modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir. aracılığıyla `{"name": "my_function"}` belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar. `none` , hiçbir işlev mevcut olmadığında varsayılan değerdir. `auto` , işlevler varsa varsayılan değerdir.	Hayı
functions	dizi	yerine `tools`kullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
uygulama/json	createChatCompletionResponse veya createChatCompletionStreamResponse

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

İçerik Türü	Türü	Açıklama
uygulama/json	errorResponse

Örnekler

Example

Sağlanan istem, 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 verilerine ve sistem tarafından atanan yönetilen kimliğe göre 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 Arama vektör verilerini, önceki yardımcı iletisini ve kullanıcı tarafından atanan yönetilen kimliği temel alan 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 - Oluşturma

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

Sesi giriş diline ayırır.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai. azure.com
deployment-id (yenileme kimliği)	path	Evet	String	Sesli yazılım modelinin dağıtım kimliği. Desteklenen modeller hakkında bilgi için bkz. [/azure/ai-foundry/openai/concepts/models#audio-models].
API-sürümü	soru	Evet	String	API sürümü

İstek Başlığı

İsim	Gerekli	Türü	Description
API anahtarı	Doğru	String	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: çok parçalı/form-veri

İsim	Türü	Description	Gerekli	Varsayılan
dosya	String	Dökümü yapılan ses dosyası nesnesi.	Evet
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir.	Hayı
yanıt formatı	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayı
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0
language	String	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
uygulama/json	audioResponse veya audioVerboseResponse
düz metin	String	Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda).

Örnekler

Example

Sağlanan konuşulan ses verilerinden dökümü alınmış metinleri ve ilişkili 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

Sağlanan konuşulan ses verilerinden dökümü alınmış metinleri ve ilişkili 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 - Oluşturma

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

Giriş sesinin dökümünü alır ve İngilizce metne çevirir.

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai. azure.com
deployment-id (yenileme kimliği)	path	Evet	String	Dağıtılan fısıltı modelinin dağıtım kimliği. Desteklenen modeller hakkında bilgi için bkz. [/azure/ai-foundry/openai/concepts/models#audio-models].
API-sürümü	soru	Evet	String	API sürümü

İstek Başlığı

İsim	Gerekli	Türü	Description
API anahtarı	Doğru	String	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: çok parçalı/form-veri

İsim	Türü	Description	Gerekli	Varsayılan
dosya	String	Çevrilecek ses dosyası.	Evet
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır.	Hayı
yanıt formatı	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayı
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
uygulama/json	audioResponse veya audioVerboseResponse
düz metin	String	Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda).

Örnekler

Example

Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri 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

Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri 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"
}

Görüntü oluşturma

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

Belirli bir dall-e modeli dağıtımında metin başlığından bir toplu görüntü oluşturur

URI Parametreleri

İsim	In	Gerekli	Türü	Description
endpoint	path	Evet	String url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai. azure.com
deployment-id (yenileme kimliği)	path	Evet	String	Dağıtılan dall-e modelinin dağıtım kimliği.
API-sürümü	soru	Evet	String	API sürümü

İstek Başlığı

İsim	Gerekli	Türü	Description
API anahtarı	Doğru	String	Burada Azure OpenAI API anahtarı sağlayın

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Gerekli	Varsayılan
prompt	String	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Evet
n	tamsayı	Oluşturulacak görüntü sayısı.	Hayı	1
boyut	imageSize	Oluşturulan görüntülerin boyutu.	Hayı	1024x1024
yanıt formatı	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	Hayı	url
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
nitelik	imageQuality	Oluşturulacak görüntünün kalitesi.	Hayı	standart
style	imageStyle	Oluşturulan görüntülerin stili.	Hayı	vivid

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Açıklama
uygulama/json	generateImagesResponse

Durum Kodu: varsayılan

Açıklama: Bir hata oluştu.

İçerik Türü	Türü	Açıklama
uygulama/json	dalleErrorResponse

Örnekler

Example

İstendiğinde görüntüler 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

hataYanıtı

İsim	Türü	Description	Gerekli	Varsayılan
hata	hata		Hayı

errorBase

İsim	Türü	Description	Gerekli	Varsayılan
kod	String		Hayı
mesaj	String		Hayı

hata

İsim	Türü	Description	Gerekli
param	String		Hayı
type	String		Hayı
inner_error	innerError	Ek ayrıntılar içeren iç hata.	Hayı

iç hata

Ek ayrıntılar içeren iç hata.

İsim	Türü	Description	Gerekli	Varsayılan
kod	innerErrorCode	İç hata nesnesi için hata kodları.	Hayı
content_filter_results	contentFilterPromptResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	Hayı

içHataKodu

İç hata nesnesi için hata kodları.

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

Tür: dize

Varsayılan:

Enum Adı: InnerErrorCode

Sabit Listesi Değerleri:

Değer	Description
Sorumlu Yapay Zeka Politikası İhlali	İstem, diğer içerik filtresi kurallarından birini ihlal etti.

dalleErrorResponse

İsim	Türü	Description	Gerekli	Varsayılan
hata	dalleError		Hayı

dalleError

İsim	Türü	Description	Gerekli
param	String		Hayı
type	String		Hayı
inner_error	dalleInnerError	Ek ayrıntılar içeren iç hata.	Hayı

dalleInnerError

Ek ayrıntılar içeren iç hata.

İsim	Türü	Description	Gerekli
kod	innerErrorCode	İç hata nesnesi için hata kodları.	Hayı
content_filter_results	dalleFilterResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	Hayı
düzeltilmiş_yazı	String	İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem.	Hayı

içerikFiltreSonucuTabanı

İsim	Türü	Description	Gerekli	Varsayılan
filtered	Boolean		Evet

içerik filtresi ciddiyet sonucu

İsim	Türü	Description	Gerekli	Varsayılan
filtered	Boolean		Evet
severity	String		Hayı

içerik filtresi algılandı sonucu

İsim	Türü	Description	Gerekli	Varsayılan
filtered	Boolean		Evet
detected	Boolean		Hayı

İçerik Filtresi Algılandı (Alıntıyla Sonuçlandı)

İsim	Türü	Description	Gerekli	Varsayılan
citation	nesne		Hayı

Alıntı özellikleri

URL

İsim	Türü	Description	Varsayılan
URL	String

lisans

İsim	Türü	Description	Varsayılan
lisans	String

içerik filtre sonuç temeli

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

İsim	Türü	Gerekli
sexual	contentFilterSeverityResult	Hayı
violence	contentFilterSeverityResult	Hayı
hate	contentFilterSeverityResult	Hayı
self_harm	contentFilterSeverityResult	Hayı
profanity	içerik filtresi tespit edilen sonuç	Hayı
hata	errorBase	Hayı

içerik filtresi istem sonuçları

İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.

İsim	Türü	Gerekli
sexual	contentFilterSeverityResult	Hayı
violence	contentFilterSeverityResult	Hayı
hate	contentFilterSeverityResult	Hayı
self_harm	contentFilterSeverityResult	Hayı
profanity	içerik filtresi tespit edilen sonuç	Hayı
hata	errorBase	Hayı
jailbreak	içerik filtresi tespit edilen sonuç	Hayı

İçerik Filtre Seçimi Sonuçları

İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Üçüncü taraf metin ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.

İsim	Türü	Gerekli
sexual	contentFilterSeverityResult	Hayı
violence	contentFilterSeverityResult	Hayı
hate	contentFilterSeverityResult	Hayı
self_harm	contentFilterSeverityResult	Hayı
profanity	içerik filtresi tespit edilen sonuç	Hayı
hata	errorBase	Hayı
protected_material_text	içerik filtresi tespit edilen sonuç	Hayı
protected_material_code	içerik Filtresi Algılandı ve Alıntı Sonucu	Hayı

uyarı filtre sonucu

İstekteki tek bir istem için içerik filtreleme sonuçları.

İsim	Türü	Description	Gerekli	Varsayılan
prompt_index	tamsayı		Hayı
content_filter_results	contentFilterPromptResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	Hayı

Sonuçları Filtrele

İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.

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

dalleİçerikFiltrelemeSonuçları

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

İsim	Türü	Gerekli
sexual	contentFilterSeverityResult	Hayı
violence	contentFilterSeverityResult	Hayı
hate	contentFilterSeverityResult	Hayı
self_harm	contentFilterSeverityResult	Hayı

dalleFiltreSonuçları

İsim	Türü	Gerekli
sexual	contentFilterSeverityResult	Hayı
violence	contentFilterSeverityResult	Hayı
hate	contentFilterSeverityResult	Hayı
self_harm	contentFilterSeverityResult	Hayı
profanity	içerik filtresi tespit edilen sonuç	Hayı
jailbreak	içerik filtresi tespit edilen sonuç	Hayı

sohbetTamamlamaİstekOrtak

İsim	Türü	Description	Gerekli	Varsayılan
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz `top_p` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz `temperature` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
veri akışı	Boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	Hayı	Yanlış
stop	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	Hayı
maksimum_token	tamsayı	Oluşturulan yanıt için izin verilen en fazla belirteç sayısı. Varsayılan olarak, modelin döndürebileceği belirteç sayısı olacaktır (4096 - istem belirteçleri). Bu değer artık yerine kullanım dışı bırakılmıştır `max_completion_tokens`ve o1 serisi modelleriyle uyumlu değildir.	Hayı	4096
max_completion_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
varlık cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayı	0
frekans cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayı	0
logit önyargısı	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir json nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.	Hayı
user	String	Uygunsuz kullanımı izlemek ve algılamak için OpenAI'Azure yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

TamamlamaİsteğiOluştur

İsim	Türü	Description	Gerekli	Varsayılan
prompt	dize veya dizi	Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi. \|endoftext\|< öğesinin>, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur.	Evet
en iyi	tamsayı	Tamamlamaları `best_of` sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz. ile `n`kullanıldığında, `best_of` aday tamamlama sayısını denetler ve `n` döndürülecek sayı sayısını belirtir â€" `best_of` değerinin değerinden `n`büyük olması gerekir. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `max_tokens`için `stop` makul ayarlara sahip olduğunuzdan emin olun.	Hayı	1
echo	Boolean	Tamamlamaya ek olarak istemi geri yankıla	Hayı	Yanlış
frekans cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayı	0
logit önyargısı	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (GPT belirteç oluşturucusunda belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, \|endoftext\|`{"50256": -100}` belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz>.	Hayı	Hiç kimse
logprobs	tamsayı	Günlük olasılıklarını `logprobs` en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise `logprobs` , API en olası beş belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür `logprob` , bu nedenle yanıtta en `logprobs+1` fazla öğe olabilir. için `logprobs` en büyük değer 5'tir.	Hayı	Hiç kimse
maksimum_token	tamsayı	Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı. İsteminizin ve artı `max_tokens` değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz.	Hayı	16
n	tamsayı	Her istem için kaç tamamlama oluşturulacağı. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve `max_tokens`için `stop` makul ayarlara sahip olduğunuzdan emin olun.	Hayı	1
varlık cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayı	0
seed	tamsayı	Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayı
stop	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Döndürülen metin durdurma sırasını içermez.	Hayı
veri akışı	Boolean	Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	Hayı	Yanlış
suffix	String	Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için `gpt-3.5-turbo-instruct`desteklenir.	Hayı	Hiç kimse
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz `top_p` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz `temperature` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı

tamamlama cevabı oluştur

API'den bir tamamlama yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli paylaşır (sohbet uç noktasından farklı olarak).

İsim	Türü	Description	Gerekli
kimlik	String	Tamamlanma için benzersiz bir tanımlayıcı.	Evet
choices	dizi	Giriş istemi için modelin oluşturduğu tamamlama seçeneklerinin listesi.	Evet
created	tamsayı	Tamamlanmanın oluşturulduğu Unix zaman damgası (saniye olarak).	Evet
model	String	Tamamlanmak için kullanılan model.	Evet
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	Hayı
system_fingerprint	String	Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle `seed` birlikte kullanılabilir.	Hayı
nesne	enum	Her zaman "text_completion" olan nesne türü Olası değerler: text_completion	Evet
usage	tamamlama kullanımı	Tamamlanma isteği için kullanım istatistikleri.	Hayı

SohbetTamamlanmaTalebiOluştur

İsim	Türü	Description	Gerekli	Varsayılan
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz `top_p` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz `temperature` ancak ikisini birden değiştirmemenizi öneririz.	Hayı	1
veri akışı	Boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	Hayı	Yanlış
stop	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	Hayı
maksimum_token	tamsayı	Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı. Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır.	Hayı
max_completion_tokens	tamsayı	Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır.	Hayı
varlık cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayı	0
frekans cezası	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayı	0
logit önyargısı	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.	Hayı	Hiç kimse
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
Mesajlar	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi.	Evet
data_sources	dizi	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.	Hayı
logprobs	Boolean	Çıkış belirteçlerinin günlük olasılıklarının döndürülmesi veya döndürülmemesi. True ise, içinde döndürülen `contentmessage`her çıkış belirtecinin günlük olasılıklarını döndürür.	Hayı	Yanlış
top_logprobs	tamsayı	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı. `logprobs` bu parametre kullanılıyorsa olarak ayarlanmalıdır `true` .	Hayı
n	tamsayı	Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceksiniz. Maliyetleri en aza indirmek için farklı `n` tutun`1`.	Hayı	1
paralel araç çağrıları	ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayı	Doğru
yanıt formatı	ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema	Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o, GPT-4o mini, GPT-4 Turbo ve tüm GPT-3.5 Turbo modelleri `gpt-3.5-turbo-1106` daha yenidir. ayarı, `{ "type": "json_schema", "json_schema": {...} }` modelin sağlanan JSON şemanızla eşleşeceğini garanti eden Yapılandırılmış Çıkışlar'ı etkinleştirir. ayarı `{ "type": "json_object" }` , modelin oluşturduğu iletinin geçerli JSON olduğunu garanti eden JSON modunu etkinleştirir. Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `finish_reason="length"` gösteren ileti `max_tokens`içeriğinin kısmen kesilebileceğini unutmayın.	Hayı
seed	tamsayı	Bu özellik Beta sürümündedir. Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayı
araçlar	dizi	Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın. En fazla 128 işlev desteklenir.	Hayı
tool_choice	chatCompletionToolChoiceOption	Model tarafından çağrılan aracı (varsa) denetler. `none` modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. `required` modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla `{"type": "function", "function": {"name": "my_function"}}` belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar. `none` hiçbir araç mevcut olmadığında varsayılan değerdir. `auto` araçlar varsa varsayılan değerdir.	Hayı
function_call	string veya chatCompletionFunctionCallOption	yerine `tool_choice`kullanım dışı bırakıldı. Model tarafından çağrılan (varsa) işlevi denetler. `none` modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. `auto` , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir. aracılığıyla `{"name": "my_function"}` belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar. `none` , hiçbir işlev mevcut olmadığında varsayılan değerdir. `auto` , işlevler varsa varsayılan değerdir.	Hayı
functions	dizi	yerine `tools`kullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayı

sohbetTamamlamaFonksiyonları

İsim	Türü	Description	Gerekli
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
name	String	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Evet
parameters	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuzu ve biçimle ilgili belgeler için JSON Şema başvurusu bakın. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	Hayı

sohbetTamamlamaFonksiyonÇağrıSeçeneği

aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak işlevin adı.	Evet

sohbetTamamlamaİstekMesajı

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

sohbetTamamlamaIstegiSistemMesaji

İsim	Türü	Description	Gerekli
içerik	dize veya dizi	Sistem iletisinin içeriği.	Evet
role	enum	İleti yazarının rolü( bu örnekte `system`). Olası değerler: sistem	Evet
name	String	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	Hayı

SohbetTamamlamaİsteğiKullanıcıMesajı

İsim	Türü	Description	Gerekli
içerik	dize veya dizi	Kullanıcı iletisinin içeriği.	Evet
role	enum	İleti yazarının rolü( bu örnekte `user`). Olası değerler: kullanıcı	Evet
name	String	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	Hayı

Sohbet Tamamlama İsteği Yardımcı Mesajı

İsim	Türü	Description	Gerekli
içerik	dize veya dizi	Yardımcı iletisinin içeriği. Veya belirtilmediği sürece `tool_callsfunction_call` gereklidir.	Hayı
Ret	String	Asistanın reddetme mesajı.	Hayı
role	enum	İleti yazarının rolü( bu örnekte `assistant`). Olası değerler: yardımcı	Evet
name	String	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	Hayı
tool_calls	chatCompletionMessageToolCalls	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	Hayı
function_call	nesne	kullanım dışı bırakıldı ve tarafından `tool_calls`değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	Hayı

function_call özellikleri

arguments

İsim	Türü	Description	Varsayılan
arguments	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

name

İsim	Türü	Description	Varsayılan
name	String	Çağrılacak işlevin adı.

sohbetTamamlamaİstekAracıMesajı

İsim	Türü	Description	Gerekli
role	enum	İleti yazarının rolü( bu örnekte `tool`). Olası değerler: araç	Evet
içerik	dize veya dizi	Araç iletisinin içeriği.	Evet
tool_call_id	String	Bu iletinin yanıt verdiği araç çağrısı.	Evet

sohbetTamamlamaİstekFonksiyonMesajı

İsim	Türü	Description	Gerekli
role	enum	İleti yazarının rolü( bu örnekte `function`). Olası değerler: işlev	Evet
içerik	String	İşlev iletisinin içeriği.	Evet
name	String	Çağrılacak işlevin adı.	Evet

SohbetTamamlamaİstekSistemiMesajİçerikParçası

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

sohbetTamamlamaİsteğiKullanıcıMesajıİçerikParçası

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

ChatTamamlamaİsteğiAsistanMesajİçeriğiParçası

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

sohbetTamamlamaİstekAracıMesajİçeriğiParçası

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

chatTamamlamaİstekMesajİçerikParçaMetin

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	İçerik bölümünün türü. Olası değerler: metin	Evet
text	String	Metin içeriği.	Evet

İletişimTamamlaTalepMesajİçerikKısımResim

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	İçerik bölümünün türü. Olası değerler: image_url	Evet
image_url	nesne		Evet

image_url özellikleri

url

İsim	Türü	Description	Varsayılan
url	String	Görüntünün URL'si veya base64 kodlanmış görüntü verileri.

detail

İsim	Türü	Description	Varsayılan
detail	String	Görüntünün ayrıntı düzeyini belirtir. daha fazla bilgi için Vision kılavuzu.	otomatik

sohbet tamamlaması talebi mesaj içeriği reddi

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	İçerik bölümünün türü. Olası değerler: reddetme	Evet
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Evet

Azure Sohbet Uzantısı Yapılandırması

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

İsim	Türü	Description	Gerekli	Varsayılan
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet

azureChatEklentiTürü

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureChatExtensionType

Sabit Listesi Değerleri:

Değer	Description
azure_search	Azure Arama'nın Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.
Azure Cosmos Veritabanı	Azure Cosmos DB'nin Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.

Azure Arama Sohbet Uzantısı Yapılandırması

Azure OpenAI sohbet uzantısı olarak kullanırken Azure Arama için yapılandırılabilir seçeneklerin belirli bir gösterimi.

İsim	Türü	Description	Gerekli	Varsayılan
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet
parameters	azureAramaSohbetEklentiParametreleri	Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Arama parametreleri.	Hayı

azureSearchChatUzantıParametreleri

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

İsim	Türü	Description	Gerekli
kimlik doğrulama	onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions		Evet
En iyi n belgeleri	tamsayı	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayı
kapsam dahilinde	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayı
strictness	tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	Hayı
rol_bilgisi	String	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	Hayı
endpoint	String	Kullanılacak Azure Arama kaynağının mutlak uç nokta yolu.	Evet
endeks_adı	String	Başvuruda bulunulan Azure Arama kaynağında kullanılabilir olarak kullanılacak dizinin adı.	Evet
alan eşleştirme	AzureAramaDizinAlanEşlemeSeçenekleri	Yapılandırılmış bir Azure Arama kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Hayı
sorgu_tipi	azureSearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Arama alma sorgusunun türü.	Hayı
anlamsal yapılandırma	String	Sorgu için ek anlamsal yapılandırma.	Hayı
filtre	String	Arama filtresi.	Hayı
gömülü_bağımlılık	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Hayı

azureAramaDizinAlanEşlemeSeçenekleri

Yapılandırılmış bir Azure Arama kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.

İsim	Türü	Description	Gerekli
başlık_alanı	String	Başlık olarak kullanılacak dizin alanının adı.	Hayı
url_alanı	String	URL olarak kullanılacak dizin alanının adı.	Hayı
Dosya yolu alanı	String	Dosya yolu olarak kullanılacak dizin alanının adı.	Hayı
içerik alanları	dizi	İçerik olarak ele alınması gereken dizin alanlarının adları.	Hayı
içerik_alanları_ayırıcı	String	İçerik alanlarının kullanması gereken ayırıcı desen.	Hayı
vektör alanları	dizi	Vektör verilerini temsil eden alanların adları.	Hayı

azureAramaSorguTürü

Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Arama alma sorgusunun türü.

Description: Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Arama alma sorgusunun türü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureSearchQueryType

Sabit Listesi Değerleri:

Değer	Description
simple	Varsayılan, basit sorgu ayrıştırıcısını temsil eder.
anlam	Gelişmiş anlamsal modelleme için anlamsal sorgu ayrıştırıcısını temsil eder.
vektör	Hesaplanan veriler üzerinde vektör aramalarını temsil eder.
vektör_basit_melez	Vektör verileriyle basit sorgu stratejisinin bir birleşimini temsil eder.
vektör_anlam_hibrit	Anlamsal arama ve vektör verileri sorgulamanın bir bileşimini temsil eder.

Azure Cosmos DB Sohbet Uzantısı Yapılandırması

Azure Cosmos DB'yi Azure OpenAI sohbet uzantısı olarak kullanırken yapılandırılabilir seçeneklerin belirli bir gösterimi.

İsim	Türü	Description	Gerekli	Varsayılan
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet
parameters	azureCosmosDBChatExtensionParameters	için Azure Cosmos DB kullanırken Veri sohbeti uzantılarınızda OpenAI Azure yapılandırırken kullanılacak parametreler MongoDB sanal çekirdeği.	Hayı

AzureCosmosDBSohbetUzantısıParametreleri

MongoDB sanal çekirdeği için Azure Cosmos DB kullanırken Veri sohbeti uzantılarınızda OpenAI Azure yapılandırırken kullanılacak parametreler.

İsim	Türü	Description	Gerekli
kimlik doğrulama	VeriBağlantıDizesiKimlikDoğrulamaSeçenekleriÜzerinde	connection string kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.	Evet
En iyi n belgeleri	tamsayı	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayı
kapsam dahilinde	Boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayı
strictness	tamsayı	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	Hayı
rol_bilgisi	String	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	Hayı
veritabanı_adı	String	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı.	Evet
konteyner_adı	String	Azure Cosmos DB kaynak kapsayıcısının adı.	Evet
endeks_adı	String	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı.	Evet
alan eşleştirme	azureCosmosDBFieldMappingOptions	Yapılandırılmış Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Evet
gömülü_bağımlılık	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Evet

Azure Cosmos DB Alan Eşleme Seçenekleri

Yapılandırılmış Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.

İsim	Türü	Description	Gerekli
başlık_alanı	String	Başlık olarak kullanılacak dizin alanının adı.	Hayı
url_alanı	String	URL olarak kullanılacak dizin alanının adı.	Hayı
Dosya yolu alanı	String	Dosya yolu olarak kullanılacak dizin alanının adı.	Hayı
içerik alanları	dizi	İçerik olarak ele alınması gereken dizin alanlarının adları.	Evet
içerik_alanları_ayırıcı	String	İçerik alanlarının kullanması gereken ayırıcı desen.	Hayı
vektör alanları	dizi	Vektör verilerini temsil eden alanların adları.	Evet

Veri Kimlik Doğrulama Seçenekleriniz

Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
type	VeriKimlikDoğrulamaTürünüzÜzerinde	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet

Verinizin Kimlik Doğrulama Türü

Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.

Description: Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataAuthenticationType

Sabit Listesi Değerleri:

Değer	Description
API anahtarı	API anahtarı aracılığıyla kimlik doğrulaması.
connection_string	connection string aracılığıyla kimlik doğrulaması.
sistem tarafından atanan yönetilen kimlik	Sistem tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.
kullanıcı atamalı yönetilen kimlik	Kullanıcı tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.

VerinizÜzerindeApiAnahtarıKimlikDoğrulamaSeçenekleri

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

İsim	Türü	Description	Gerekli	Varsayılan
type	VeriKimlikDoğrulamaTürünüzÜzerinde	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet
key	String	Kimlik doğrulaması için kullanılacak API anahtarı.	Hayı

BağlantıDizinizdekiKimlikDoğrulamaSeçenekleri

connection string kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
type	VeriKimlikDoğrulamaTürünüzÜzerinde	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet
connection_string	String	Kimlik doğrulaması için kullanılacak connection string.	Hayı

onYourDataSistemAtananYönetilenKimlikDoğrulamaSeçenekleri

Sistem tarafından atanan yönetilen kimlik kullanılırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
type	VeriKimlikDoğrulamaTürünüzÜzerinde	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet

Kullanıcı Atamalı Yönetilen Kimlik Kimlik Doğrulama Seçenekleri

Kullanıcı tarafından atanan yönetilen kimlik kullanılırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.

İsim	Türü	Description	Gerekli	Varsayılan
type	VeriKimlikDoğrulamaTürünüzÜzerinde	Verilerinizde OpenAI Azure ile desteklenen kimlik doğrulama türleri.	Evet
managed_identity_resource_id	String	Kimlik doğrulaması için kullanılacak kullanıcı tarafından atanan yönetilen kimliğin kaynak kimliği.	Hayı

onYourVeriVektörleştirmeKaynağı

Vektör araması ile Verilerinizde OpenAI Azure için vektörleştirme kaynağının soyut gösterimi.

İsim	Türü	Description	Gerekli	Varsayılan
type	Veri Vektorizasyon Kaynak Tipiniz Üzerinde	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vektör araması.	Evet

onYourDataVektörleştirmeKaynağıTürü

Verilerinizde OpenAI Azure vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder.

Description: Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder
vektör araması.

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataVectorizationSourceType

Sabit Listesi Değerleri:

Değer	Description
endpoint	Azure OpenAI ekleme modeline yapılan genel hizmet çağrıları tarafından gerçekleştirilen vektörleştirmeyi temsil eder.
dağıtım_adı	Kullanılacak Ada modeli dağıtım adını temsil eder. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu model dağıtımını vektöre olanak tanıyan genel bir çağrı yerine iç çağrı aracılığıyla kullanır özel ağlarda bile arama.

onYourDataDağıtımAdıVektörleştirmeKaynağı

Aynı Azure OpenAI kaynağındaki iç ekleme modeli dağıtım adını temel alan vektör arama uygularken Verilerinizde OpenAI Azure tarafından kullanılan vektörleştirme kaynağının ayrıntıları.

İsim	Türü	Description	Gerekli	Varsayılan
type	Veri Vektorizasyon Kaynak Tipiniz Üzerinde	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vektör araması.	Evet
dağıtım_adı	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ıdır, ancak Verilerinizde bu model dağıtımını özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı aracılığıyla kullanır.	Hayı

VeriUçNoktasıVektörleştirmeKaynağıÜzerinde

Vektör arama uygularken Verilerinizde OpenAI Azure tarafından kullanılan ve eklemeler için genel Azure OpenAI uç nokta çağrısına dayanan vektörleştirme kaynağının ayrıntıları.

İsim	Türü	Description	Gerekli
type	Veri Vektorizasyon Kaynak Tipiniz Üzerinde	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vektör araması.	Evet
kimlik doğrulama	onYourDataApiKeyKimlikDoğrulamaSeçenekleri	API anahtarı kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.	Hayı
endpoint	String	Vektörleştirme için kullanılacak uç noktayı belirtir. Bu uç nokta aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu uç nokta özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı aracılığıyla kullanılır.	Hayı

azureChatUzantılarıMesajBağlamı

Azure OpenAI sohbet uzantıları ilgili sohbet tamamlama yanıtının oluşturulmasına dahil olduğunda sağlanan ek bağlam bilgilerinin gösterimi. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanılırken doldurulur.

İsim	Türü	Description	Gerekli	Varsayılan
citations	dizi	Yanıtta yardımcı iletisini oluşturmak için kullanılan veri kaynağı alma sonucu.	Hayı
intent	String	Bağlamı taşımak için bir sonraki dönüşe geçmek için kullanılan sohbet geçmişinden algılanan amaç.	Hayı

citation

sohbet tamamlamaları yanıt iletisi için alıntı bilgileri.

İsim	Türü	Description	Gerekli
içerik	String	Alıntının içeriği.	Evet
title	String	Alıntının başlığı.	Hayı
url	String	Alıntının URL'si.	Hayı
filepath	String	Alıntının dosya yolu.	Hayı
chunk_id	String	Alıntının öbek kimliği.	Hayı

SohbetTamamlamaMesajAracıÇağrısı

İsim	Türü	Description	Gerekli
kimlik	String	Araç çağrısının kimliği.	Evet
type	toolCallType	Bu durumda `function`araç çağrısının türü.	Evet
function	nesne	Modelin çağırdığını işlev.	Evet

İşlevin özellikleri

name

İsim	Türü	Description	Varsayılan
name	String	Çağrılacak işlevin adı.

arguments

İsim	Türü	Description	Varsayılan
arguments	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

Araç Çağrı Türü

Bu durumda functionaraç çağrısının türü.

Açıklama: Bu örnekte functionaraç çağrısının türü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: ToolCallType

Sabit Listesi Değerleri:

Değer	Description
function	Araç çağrı türü işlevdir.

chatTamamlamaİstekMesajAracı

İsim	Türü	Description	Gerekli	Varsayılan
tool_call_id	String	Bu iletinin yanıt verdiği araç çağrısı.	Hayı
içerik	String	İletinin içeriği.	Hayı

SohbetTamamlamaTalepMesajFonksiyonu

İsim	Türü	Description	Gerekli
role	enum	İleti yazarının rolü( bu örnekte `function`). Olası değerler: işlev	Hayı
name	String	İletinin içeriği.	Hayı
içerik	String	İletinin içeriği.	Hayı

createChatCompletionResponse

Sağlanan girişe göre model tarafından döndürülen sohbet tamamlama yanıtını temsil eder.

İsim	Türü	Description	Gerekli
kimlik	String	Sohbetin tamamlanması için benzersiz bir tanımlayıcı.	Evet
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	Hayı
choices	dizi	Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse `n` birden fazla olabilir.	Evet
created	tamsayı	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak).	Evet
model	String	Sohbetin tamamlanması için kullanılan model.	Evet
system_fingerprint	String	Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle `seed` birlikte kullanılabilir.	Hayı
nesne	enum	Her zaman `chat.completion`olan nesne türü. Olası değerler: chat.completion	Evet
usage	tamamlama kullanımı	Tamamlanma isteği için kullanım istatistikleri.	Hayı

SohbetTamamlamaAkışYanıtıOluştur

Sağlanan girişe göre model tarafından döndürülen sohbet tamamlama yanıtının akışlı bir öbeği temsil eder.

İsim	Türü	Description	Gerekli
kimlik	String	Sohbetin tamamlanması için benzersiz bir tanımlayıcı. Her öbek aynı kimliktedir.	Evet
choices	dizi	Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse `n` birden fazla öğe içerebilir.	Evet
created	tamsayı	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak). Her öbek aynı zaman damgasına sahiptir.	Evet
model	String	Tamamlanmayı oluşturmak için model.	Evet
system_fingerprint	String	Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle `seed` birlikte kullanılabilir.	Hayı
nesne	enum	Her zaman `chat.completion.chunk`olan nesne türü. Olası değerler: chat.completion.chunk	Evet

sohbetTamamlamaAkışYanıtDelta

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

İsim	Türü	Description	Gerekli
içerik	String	Öbek iletisinin içeriği.	Hayı
function_call	nesne	kullanım dışı bırakıldı ve tarafından `tool_calls`değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	Hayı
tool_calls	dizi		Hayı
role	enum	Bu iletinin yazarının rolü. Olası değerler: sistem, kullanıcı, yardımcı, araç	Hayı
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Hayı

function_call özellikleri

arguments

İsim	Türü	Description	Varsayılan
arguments	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

name

İsim	Türü	Description	Varsayılan
name	String	Çağrılacak işlevin adı.

sohbetTamamlamaMesajAracıÇağrıParçası

İsim	Türü	Description	Gerekli
indeks	tamsayı		Evet
kimlik	String	Araç çağrısının kimliği.	Hayı
type	enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	Hayı
function	nesne		Hayı

İşlevin özellikleri

name

İsim	Türü	Description	Varsayılan
name	String	Çağrılacak işlevin adı.

arguments

İsim	Türü	Description	Varsayılan
arguments	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.

SohbetTamamlamaAkışSeçenekleri

Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.

İsim	Türü	Description	Gerekli	Varsayılan
include_usage	Boolean	Ayarlanırsa, iletiden önce `data: [DONE]` ek bir öbek akışı oluşturulur. `usage` Bu öbek üzerindeki alan, isteğin tamamı için belirteç kullanım istatistiklerini gösterir ve `choices` alan her zaman boş bir dizi olur. Diğer tüm öbekler de null değer içeren bir `usage` alan içerir.	Hayı

sohbetTamamlamaSecimiLogOlasiliklari

Seçim için olasılık bilgilerini günlüğe kaydedin.

İsim	Türü	Description	Gerekli	Varsayılan
içerik	dizi	Günlük olasılık bilgilerini içeren ileti içerik belirteçlerinin listesi.	Evet
Ret	dizi	Günlük olasılık bilgilerini içeren ileti reddetme belirteçlerinin listesi.	Hayı

chatCompletionTokenLogprob

İsim	Türü	Description	Gerekli
token	String	Belirteç.	Evet
logprob	Numara	Bu belirtecin günlük olasılığı.	Evet
bytes	dizi	Belirtecin UTF-8 bayt gösterimini temsil eden tamsayıların listesi. Karakterlerin birden çok belirteçle temsil edildiği ve bayt gösterimlerinin doğru metin gösterimini oluşturmak için birleştirildiği durumlarda kullanışlıdır. Belirtecin bayt gösterimi yoksa olabilir `null` .	Evet
top_logprobs	dizi	Bu belirteç konumunda en olası belirteçlerin ve günlük olasılıklarının listesi. Nadir durumlarda, döndürülen istek `top_logprobs` sayısından daha az olabilir.	Evet

SohbetiTamamlamaYanıtMesajı

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

İsim	Türü	Description	Gerekli
role	chatTamamlamaYanıtMesajıRolü	Yanıt iletisinin yazarının rolü.	Evet
Ret	String	Model tarafından oluşturulan reddetme iletisi.	Evet
içerik	String	İletinin içeriği.	Evet
tool_calls	dizi	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	Hayı
function_call	chatCompletionFunctionCall	kullanım dışı bırakıldı ve tarafından `tool_calls`değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	Hayı
context	azureChatExtensionsMessageContext	Azure OpenAI sohbet uzantıları söz konusu olduğunda sağlanan ek bağlam bilgilerinin gösterimi ilgili sohbet tamamlama yanıtının oluşturulmasında. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanma.	Hayı

SohbetTamamlamaYanıtMesajRolü

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

Açıklama: Yanıt iletisinin yazarının rolü.

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

assistant

sohbetTamamlamaAracıSeçenek

Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla {"type": "function", "function": {"name": "my_function"}} belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar. none hiçbir araç mevcut olmadığında varsayılan değerdir. auto araçlar varsa varsayılan değerdir.

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

chatTamamlanmasiAdlandırılmışAraçSeçimi

Modelin kullanması gereken aracı belirtir. Modeli belirli bir işlevi çağırmaya zorlamak için kullanın.

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	Evet
function	nesne		Evet

İşlevin özellikleri

name

İsim	Türü	Description	Varsayılan
name	String	Çağrılacak işlevin adı.

ParallelToolCalls

Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.

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

chatTamamlamaMesajAracıÇağrıları

Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.

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

sohbetTamamlamaFonksiyonCagırma

kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.

İsim	Türü	Description	Gerekli	Varsayılan
name	String	Çağrılacak işlevin adı.	Evet
arguments	String	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.	Evet

tamamlama kullanımı

Tamamlanma isteği için kullanım istatistikleri.

İsim	Türü	Description	Gerekli
prompt_tokens	tamsayı	İstemdeki belirteç sayısı.	Evet
completion_tokens	tamsayı	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Evet
total_tokens	tamsayı	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Evet
completion_tokens_details	nesne	Tamamlanmada kullanılan belirteçlerin dökümü.	Hayı

completion_tokens_details özellikleri

akıl yürütme birimleri

İsim	Türü	Description	Varsayılan
akıl yürütme birimleri	tamsayı	Model tarafından mantık yürütme için oluşturulan belirteçler.

SohbetTamamlamaAracı

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	Evet
function	FunctionObject		Evet

Fonksiyon Parametreleri

İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuzu ve biçimle ilgili belgeler için JSON Şema başvurusu bakın.

Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.

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

FunctionObject

İsim	Türü	Description	Gerekli	Varsayılan
açıklama	String	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	Hayı
name	String	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Evet
parameters	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuzu ve biçimle ilgili belgeler için JSON Şema başvurusu bakın. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	Hayı
Sıkı	Boolean	İşlev çağrısı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model alanda tanımlanan şemayı `parameters` tam olarak izler. `strict` `true`olduğunda yalnızca bir JSON Şeması alt kümesi desteklenir.	Hayı	Yanlış

YanıtFormatıMetni

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü: `text` Olası değerler: metin	Evet

YanıtFormatıJsonNesne

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü: `json_object` Olası değerler: json_object	Evet

ResponseFormatJsonSchemaSchema (Yanıt Biçimi JSON Şeması Şeması)

JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması.

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

YanıtFormatıJsonŞeması

İsim	Türü	Description	Gerekli	Varsayılan
type	enum	Tanımlanan yanıt biçiminin türü: `json_schema` Olası değerler: json_schema	Evet
json şeması	nesne		Evet

json_schema özellikleri

açıklama

İsim	Türü	Description	Varsayılan
açıklama	String	Yanıt formatının amacına ilişkin bir açıklama, modelin bu formatta nasıl yanıt vereceğini belirlemesi için kullanılır.

name

İsim	Türü	Description	Varsayılan
name	String	Yanıt biçiminin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.

şema

İsim	Türü	Description	Varsayılan
şema	YanıtFormatJsonŞemaŞeması	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması.

Sıkı

İsim	Türü	Description	Varsayılan
Sıkı	Boolean	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman alanda tanımlanan tam şemayı `schema` izler. `strict` `true`olduğunda yalnızca bir JSON Şeması alt kümesi desteklenir.	Yanlış

sohbetTamamlamaSeçimiOrtak

İsim	Türü	Description	Gerekli	Varsayılan
indeks	tamsayı		Hayı
bitiş_nedeni	String		Hayı

Çeviri İstek Oluştur

Çeviri isteği.

İsim	Türü	Description	Gerekli	Varsayılan
dosya	String	Çevrilecek ses dosyası.	Evet
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır.	Hayı
yanıt formatı	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayı
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0

sesli yanıt

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

İsim	Türü	Description	Gerekli	Varsayılan
text	String	Çevrilmiş veya dökümü alınmış metin.	Evet

audioVerboseResponse

response_format verbose_json çeviri veya transkripsiyon yanıtı

İsim	Türü	Description	Gerekli
text	String	Çevrilmiş veya dökümü alınmış metin.	Evet
görev	String	Ses görevinin türü.	Hayı
language	String	Dil	Hayı
duration	Numara	Süre.	Hayı
segments	dizi		Hayı

sesYanıtBiçimi

Çıkışın biçimini tanımlar.

Açıklama: Çıkışın biçimini tanımlar.

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

JSON
text
srt
verbose_json
vtt

Transkripsiyon İsteği Oluştur

Transkripsiyon isteği.

İsim	Türü	Description	Gerekli	Varsayılan
dosya	String	Dökümü yapılan ses dosyası nesnesi.	Evet
prompt	String	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir.	Hayı
yanıt formatı	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayı
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayı	0
language	String	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayı

audioSegment

Transkripsiyon veya çeviri segmenti.

İsim	Türü	Description	Gerekli
kimlik	tamsayı	Segment tanımlayıcısı.	Hayı
seek	Numara	Segmentin uzaklığı.	Hayı
start	Numara	Segment başlangıç uzaklığı.	Hayı
son	Numara	Segment sonu uzaklığı.	Hayı
text	String	Segment metni.	Hayı
tokens	dizi	Metnin belirteçleri.	Hayı
sıcaklık	Numara	Temperature.	Hayı
avg_logprob	Numara	Ortalama günlük olasılığı.	Hayı
compression_ratio	Numara	Sıkıştırma oranı.	Hayı
no_speech_prob	Numara	olasılığı `no speech`.	Hayı

görüntü kalitesi

Oluşturulacak görüntünün kalitesi.

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

Tür: dize

Varsayılan: standart

Sabit Listesi Adı: Kalite

Sabit Listesi Değerleri:

Değer	Description
standart	Standart kalite, standart kalitede görüntüler oluşturur.
sabit disk	HD kalitesi, görüntü genelinde daha ayrıntılı ve daha tutarlı görüntüler oluşturur.

görüntüYanıtFormatı

Oluşturulan görüntülerin döndürüldiği biçim.

Açıklama: Oluşturulan görüntülerin döndürülme biçimi.

Tür: dize

Varsayılan: url

Sabit Listesi Adı: ImagesResponseFormat

Sabit Listesi Değerleri:

Değer	Description
url	Oluşturulan görüntüleri indirmek için geçici access sağlayan URL.
b64_json	Oluşturulan görüntüler base64 kodlanmış dize olarak döndürülür.

imageSize

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

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

Tür: dize

Varsayılan: 1024x1024

Sabit Listesi Adı: Boyut

Sabit Listesi Değerleri:

Değer	Description
1792x1024	Oluşturulan görüntünün istenen boyutu 1792x1024 pikseldir.
1024x1792	Oluşturulan görüntünün istenen boyutu 1024x1792 pikseldir.
1024x1024	Oluşturulan görüntünün istenen boyutu 1024x1024 pikseldir.

görüntü stili

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

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

Tür: dize

Varsayılan: canlı

Sabit Listesi Adı: Stil

Sabit Listesi Değerleri:

Değer	Description
vivid	Canlı, hiper gerçekçi ve dramatik görüntüler oluşturur.
doğal	Doğal, daha doğal ve daha az hiper gerçekçi görüntüler oluşturur.

görüntüÜretimİsteği

İsim	Türü	Description	Gerekli	Varsayılan
prompt	String	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Evet
n	tamsayı	Oluşturulacak görüntü sayısı.	Hayı	1
boyut	imageSize	Oluşturulan görüntülerin boyutu.	Hayı	1024x1024
yanıt formatı	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	Hayı	url
user	String	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayı
nitelik	imageQuality	Oluşturulacak görüntünün kalitesi.	Hayı	standart
style	imageStyle	Oluşturulan görüntülerin stili.	Hayı	vivid

generateImagesResponse

İsim	Türü	Description	Gerekli	Varsayılan
created	tamsayı	İşlemin oluşturulduğu unix zaman damgası.	Evet
veriler	dizi	Başarılı olursa işlemin sonuç verileri	Evet

görüntüSonuç

Başarılı olursa resim URL'si veya kodlanmış görüntü ve aksi takdirde bir hata.

İsim	Türü	Description	Gerekli
url	String	Resim URL'si.	Hayı
b64_json	String	base64 kodlanmış görüntüsü	Hayı
content_filter_results	dalleİçerikFiltreSonuçları	İçerik filtreleme sonuçları hakkında bilgi.	Hayı
düzeltilmiş_yazı	String	İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem.	Hayı
prompt_filter_results	dalleFilterResults	İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.	Hayı

Tamamlama uzantıları

Tamamlama uzantıları, OpenAI veri düzlemi çıkarım belirtiminin Azure en son GA sürümünün bir parçası değildir.

Sohbet iletisi

Sohbet iletisi nesnesi, Azure OpenAI veri düzlemi çıkarım belirtiminin en son GA sürümünün bir parçası değildir.

Text to speech (Önizleme)

Şu anda Azure OpenAI veri düzlemi çıkarım belirtiminin en son Azure OpenAI GA sürümünün parçası değildir. Bu özelliğin en son preview sürümüne bakın.

Sonraki Adımlar

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

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2026-02-28