Azure OpenAI Service REST API başvurusu

Bu makalede, Azure OpenAI için çıkarım REST API uç noktaları hakkında 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 yüzeyi/belirtimi farklı bir Azure OpenAI özellikleri kümesini 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.

API	En son önizleme sürümü	En son GA sürümü	Belirtimler	Açıklama
Kontrol düzlemi	2024-06-01-preview	2024-10-01	Belirtim dosyaları	Azure OpenAI, diğer tüm Azure AI Hizmetleri ile ortak bir denetim düzlemi paylaşır. Denetim düzlemi API'si, Azure OpenAI kaynakları oluşturma, model dağıtımı ve diğer üst düzey kaynak yönetimi görevleri için kullanılır. Denetim düzlemi, Azure Resource Manager, Bicep, Terraform ve Azure CLI gibi özelliklerle neler yapabileceğinizi de yönetir.
Veri düzlemi - yazma	2024-10-01-preview	2024-10-21	Belirtim dosyaları	Veri düzlemi yazma API'si ince ayarlama, dosya yükleme, alma işleri, toplu iş ve belirli model düzeyinde sorguları denetler
Veri düzlemi - çıkarım	2024-10-01-preview	2024-10-21	Belirtim dosyaları	Veri düzlemi çıkarım API'sinde tamamlamalar, sohbet tamamlamaları, eklemeler, konuşma/fısıltı, verilerinize, Dall-e, yardımcılara vb. gibi özellikler için çıkarım özellikleri/uç noktaları sağlanır.

Kimlik Doğrulaması

Azure OpenAI, kimlik doğrulaması için iki yöntem sağlar. API Anahtarlarını veya Microsoft Entra Id'yi 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 kimlik doğrulaması: 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 kimlik doğrulamasıyla 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ında Azure OpenAI veri düzlemi çıkarım belirtimi 2024-10-21olan en son GA sürümü yer alır.

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

Tamamlama

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

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (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	yol	Yes	Dize	Dağıtılan modelin dağıtım kimliği.
api-sürümü	query	Yes	Dize	API sürümü

İstek Başlığı

Veri Akışı Adı	Zorunlu	Türü	Açıklama
api-key	Doğru	Dize	Azure OpenAI API anahtarını burada sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Istemi	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.	Yes
best_of	integer	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 nkullanı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 nbüyük olması gerekir. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve stopiçin max_tokens makul ayarlara sahip olduğunuzdan emin olun.	Hayır	1
echo	boolean	Tamamlamaya ek olarak istemi geri yankıla	Hayır	Yanlış
frequency_penalty	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ır	0
logit_bias	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|> belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz{"50256": -100}.	Hayır	None
logprobs	integer	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ır	None
max_tokens	integer	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ır	16
n	integer	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 stopiçin max_tokens makul ayarlara sahip olduğunuzdan emin olun.	Hayır	1
presence_penalty	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ır	0
tohum	integer	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ır
durmak	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ır
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ır	Yanlış
sonek	Dize	Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için gpt-3.5-turbo-instructdesteklenir.	Hayır	None
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ır	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ır	1
kullanıcı	Dize	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ır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/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
application/json	errorResponse

Örnekler

Örnek

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

Makine öğrenmesi modelleri ve algoritmaları tarafından kolayca kullanılabilen belirli bir girişin vektör gösterimini alın.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (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	yol	Yes	Dize
api-sürümü	query	Yes	Dize	API sürümü

İstek Başlığı

Veri Akışı Adı	Zorunlu	Türü	Açıklama
api-key	Doğru	Dize	Azure OpenAI API anahtarını burada sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
input	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-0028.192 belirteç), boş bir dize olamaz ve herhangi bir dizi 2.048 boyut veya daha az olmalıdır.	Yes
kullanıcı	Dize	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ır
input_type	Dize	kullanılacak ekleme aramasının giriş türü	Hayır
encoding_format	Dize	Eklemelerin döndürüleceği biçim. veya base64olabilirfloat. varsayılan değeridir float.	Hayır
boyutlar	integer	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde text-embedding-3 desteklenir.	Hayır

Yanıtlar

Adı	Tür	Açıklama	Zorunlu	Varsayılan
nesne	string		Yes
model	string		Yes
veriler	dizi		Yes
kullanım	nesne		Yes

Kullanım özellikleri

prompt_tokens

Adı	Tür	Açıklama	Varsayılan
prompt_tokens	integer

total_tokens

Adı	Tür	Açıklama	Varsayılan
total_tokens	integer

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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 tamamlamaları

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

Sohbet iletisi için tamamlama oluşturur

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (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	yol	Yes	Dize	Dağıtılan modelin dağıtım kimliği.
api-sürümü	query	Yes	Dize	API sürümü

İstek Başlığı

Veri Akışı Adı	Zorunlu	Türü	Açıklama
api-key	Doğru	Dize	Azure OpenAI API anahtarını burada sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	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ır	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ır	1
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ır	Yanlış
durmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	Hayır
max_tokens	integer	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ır
max_completion_tokens	integer	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ır
presence_penalty	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ır	0
frequency_penalty	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ır	0
logit_bias	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ır	None
kullanıcı	Dize	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ır
iletiler	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi.	Yes
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ır
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 content messageher çıkış belirtecinin günlük olasılıklarını döndürür.	Hayır	Yanlış
top_logprobs	integer	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ır
n	integer	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ı 1 tutunn.	Hayır	1
parallel_tool_calls	ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayır	Doğru
response_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 ile gpt-3.5-turbo-1106uyumludur. 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ı max_tokens gösteren ileti finish_reason="length"içeriğinin kısmen kesilebileceğini unutmayın.	Hayır
tohum	integer	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ır
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ır
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ır
function_call	string veya chatCompletionFunctionCallOption	yerine tool_choicekullanı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ır
işlevleri	dizi	yerine toolskullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Örnekler

Örnek

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

Örnek

Azure Search verilerini ve sistem 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 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
    }
  }
}

Örnek

Azure Search vektör verilerine, önceki yardımcı iletisine ve kullanıcı 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 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
    }
  }
}

Örnek

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

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (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	yol	Yes	Dize	Fısıltı modelinin dağıtım kimliği.
api-sürümü	query	Yes	Dize	API sürümü

İstek Başlığı

Veri Akışı Adı	Zorunlu	Türü	Açıklama
api-key	Doğru	Dize	Azure OpenAI API anahtarını burada sağlayın

İstek Gövdesi

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dosyası	Dize	Dökümü yapılan ses dosyası nesnesi.	Yes
Istemi	Dize	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ır
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayır
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ır	0
dil	Dize	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

Örnek

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

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (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	yol	Yes	Dize	Dağıtılan fısıltı modelinin dağıtım kimliği.
api-sürümü	query	Yes	Dize	API sürümü

İstek Başlığı

Veri Akışı Adı	Zorunlu	Türü	Açıklama
api-key	Doğru	Dize	Azure OpenAI API anahtarını burada sağlayın

İstek Gövdesi

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dosyası	Dize	Çevrilecek ses dosyası.	Yes
Istemi	Dize	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ır
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayır
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ır	0

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

Örnek

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

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (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	yol	Yes	Dize	Dağıtılan dall-e modelinin dağıtım kimliği.
api-sürümü	query	Yes	Dize	API sürümü

İstek Başlığı

Veri Akışı Adı	Zorunlu	Türü	Açıklama
api-key	Doğru	Dize	Azure OpenAI API anahtarını burada sağlayın

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Istemi	Dize	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Yes
n	integer	Oluşturulacak görüntü sayısı.	Hayır	1
size	imageSize	Oluşturulan görüntülerin boyutu.	Hayır	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	Hayır	url
kullanıcı	Dize	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ır
nitelik	imageQuality	Oluşturulacak görüntünün kalitesi.	Hayır	standart
stili	imageStyle	Oluşturulan görüntülerin stili.	Hayır	Canlı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Bir hata oluştu.

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

Örnekler

Örnek

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

Bileşenler

errorResponse

Adı	Tür	Açıklama	Zorunlu	Varsayılan
hata	hata		Hayır

errorBase

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kod	string		Hayır
ileti	Dize		Hayır

hata

Adı	Tür	Açıklama	Zorunlu	Varsayılan
param	Dize		Hayır
Tür	Dize		Hayır
inner_error	innerError	Ek ayrıntılar içeren iç hata.	Hayır

innerError

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kod	innerErrorCode	İç hata nesnesi için hata kodları.	Hayır
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ır

innerErrorCode

İç 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:

Value	Açıklama
ResponsibleAIPolicyViolation	İstem, diğer içerik filtresi kurallarından birini ihlal etti.

dalleErrorResponse

Adı	Tür	Açıklama	Zorunlu	Varsayılan
hata	dalleError		Hayır

dalleError

Adı	Tür	Açıklama	Zorunlu	Varsayılan
param	Dize		Hayır
Tür	Dize		Hayır
inner_error	dalleInnerError	Ek ayrıntılar içeren iç hata.	Hayır

dalleInnerError

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kod	innerErrorCode	İç hata nesnesi için hata kodları.	Hayır
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ır
revised_prompt	Dize	İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem.	Hayır

contentFilterResultBase

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Filtre	boolean		Yes

contentFilterSeverityResult

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Filtre	boolean		Yes
önem derecesi	Dize		Hayır

contentFilterDetectedResult

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Filtre	boolean		Yes
Algılandı	boolean		Hayır

contentFilterDetectedWithCitationResult

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Alıntı	nesne		Hayır

Alıntı özellikleri

URL

Adı	Tür	Açıklama	Varsayılan
URL	Dize

lisans

Adı	Tür	Açıklama	Varsayılan
lisans	Dize

contentFilterResultsBase

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
hata	errorBase		Hayır

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
hata	errorBase		Hayır
Jailbreak	contentFilterDetectedResult		Hayır

contentFilterChoiceResults

İç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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
hata	errorBase		Hayır
protected_material_text	contentFilterDetectedResult		Hayır
protected_material_code	contentFilterDetectedWithCitationResult		Hayır

promptFilterResult

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
prompt_index	integer		Hayır
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ır

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.

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

dalleContentFilterResults

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
Jailbreak	contentFilterDetectedResult		Hayır

chatCompletionsRequestCommon

Adı	Tür	Açıklama	Zorunlu	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ır	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ır	1
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ır	Yanlış
durmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	Hayır
max_tokens	integer	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_tokensve o1 serisi modelleriyle uyumlu değildir.	Hayır	4096
max_completion_tokens	integer	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ır
presence_penalty	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ır	0
frequency_penalty	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ır	0
logit_bias	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ır
kullanıcı	Dize	Azure OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayır

createCompletionRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Istemi	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.	Yes
best_of	integer	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 nkullanı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 nbüyük olması gerekir. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve stopiçin max_tokens makul ayarlara sahip olduğunuzdan emin olun.	Hayır	1
echo	boolean	Tamamlamaya ek olarak istemi geri yankıla	Hayır	Yanlış
frequency_penalty	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ır	0
logit_bias	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|> belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz{"50256": -100}.	Hayır	None
logprobs	integer	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ır	None
max_tokens	integer	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ır	16
n	integer	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 stopiçin max_tokens makul ayarlara sahip olduğunuzdan emin olun.	Hayır	1
presence_penalty	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ır	0
tohum	integer	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ır
durmak	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ır
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ır	Yanlış
sonek	Dize	Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için gpt-3.5-turbo-instructdesteklenir.	Hayır	None
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ır	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ır	1
kullanıcı	Dize	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ır

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).

Adı	Tür	Açıklama	Zorunlu	Varsayılan
id	dize	Tamamlanma için benzersiz bir tanımlayıcı.	Yes
Seçenek	dizi	Giriş istemi için modelin oluşturduğu tamamlama seçeneklerinin listesi.	Yes
oluşturulan	integer	Tamamlanmanın oluşturulduğu Unix zaman damgası (saniye olarak).	Yes
model	Dize	Tamamlanmak için kullanılan model.	Yes
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	Hayır
system_fingerprint	Dize	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ır
nesne	enum	Her zaman "text_completion" olan nesne türü Olası değerler: text_completion	Yes
kullanım	completionUsage	Tamamlanma isteği için kullanım istatistikleri.	Hayır

createChatCompletionRequest

Adı	Tür	Açıklama	Zorunlu	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ır	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ır	1
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ır	Yanlış
durmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi.	Hayır
max_tokens	integer	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ır
max_completion_tokens	integer	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ır
presence_penalty	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ır	0
frequency_penalty	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ır	0
logit_bias	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ır	None
kullanıcı	Dize	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ır
iletiler	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi.	Yes
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ır
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 content messageher çıkış belirtecinin günlük olasılıklarını döndürür.	Hayır	Yanlış
top_logprobs	integer	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ır
n	integer	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ı 1 tutunn.	Hayır	1
parallel_tool_calls	ParallelToolCalls	Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.	Hayır	Doğru
response_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 ile gpt-3.5-turbo-1106uyumludur. 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ı max_tokens gösteren ileti finish_reason="length"içeriğinin kısmen kesilebileceğini unutmayın.	Hayır
tohum	integer	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ır
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ır
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ır
function_call	string veya chatCompletionFunctionCallOption	yerine tool_choicekullanı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ır
işlevleri	dizi	yerine toolskullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayır

chatCompletionFunctions

Adı	Tür	Açıklama	Zorunlu	Varsayılan
açıklama	Dize	İş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ır
Adı	Dize	Ç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.	Yes
parametreler	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza](/azure/ai-services/openai/how-to/function-calling) ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.	Hayır

chatCompletionFunctionCallOption

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.	Yes

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
content	dize veya dizi	Sistem iletisinin içeriği.	Yes
rol	enum	İleti yazarının rolü( bu örnekte system). Olası değerler: sistem	Yes
ad	Dize	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ır

chatCompletionRequestUserMessage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
content	dize veya dizi	Kullanıcı iletisinin içeriği.	Yes
rol	enum	İleti yazarının rolü( bu örnekte user). Olası değerler: kullanıcı	Yes
ad	Dize	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ır

chatCompletionRequestAssistantMessage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
content	dize veya dizi	Yardımcı iletisinin içeriği. Veya belirtilmediği sürece tool_calls function_call gereklidir.	Hayır
Ret	Dize	Asistanın reddetme mesajı.	Hayır
rol	enum	İleti yazarının rolü( bu örnekte assistant). Olası değerler: yardımcı	Yes
ad	Dize	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ır
tool_calls	chatCompletionMessageToolCalls	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	Hayır
function_call	nesne	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.	Hayır

function_call özellikleri

Bağımsız değişken

Adı	Tür	Açıklama	Varsayılan
Bağımsız değişken	Dize	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.

Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

chatCompletionRequestToolMessage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
rol	enum	İleti yazarının rolü( bu örnekte tool). Olası değerler: araç	Yes
content	dize veya dizi	Araç iletisinin içeriği.	Yes
tool_call_id	Dize	Bu iletinin yanıt verdiği araç çağrısı.	Yes

chatCompletionRequestFunctionMessage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
rol	enum	İleti yazarının rolü( bu örnekte function). Olası değerler: işlev	Yes
content	Dize	İşlev iletisinin içeriği.	Yes
ad	Dize	Çağrılacak işlevin adı.	Yes

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	İçerik bölümünün türü. Olası değerler: metin	Yes
text	Dize	Metin içeriği.	Yes

chatCompletionRequestMessageContentPartImage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	İçerik bölümünün türü. Olası değerler: image_url	Yes
image_url	nesne		Yes

image_url özellikleri

url

Adı	Tür	Açıklama	Varsayılan
url	Dize	Görüntünün URL'si veya base64 kodlanmış görüntü verileri.

ayrıntı

Adı	Tür	Açıklama	Varsayılan
ayrıntı	Dize	Görüntünün ayrıntı düzeyini belirtir. Görüntü İşleme kılavuzunda daha fazla bilgi edinin.	auto

chatCompletionRequestMessageContentPartRefusal

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	İçerik bölümünün türü. Olası değerler: reddetme	Yes
Ret	Dize	Model tarafından oluşturulan reddetme iletisi.	Yes

azureChatExtensionConfiguration

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	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.	Yes

azureChatExtensionType

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.

Açıklama: 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:

Value	Açıklama
azure_search	Azure Search'ün Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.
azure_cosmos_db	Azure OpenAI sohbet uzantısı olarak Azure Cosmos DB kullanımını temsil eder.

azureSearchChatExtensionConfiguration

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	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.	Yes
parametreler	azureSearchChatExtensionParameters	Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Search parametreleri.	Hayır

azureSearchChatExtensionParameters

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kimlik doğrulaması	onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayır
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayır
katılık	integer	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ır
role_information	Dize	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ır
endpoint	Dize	Kullanılacak Azure Search kaynağının mutlak uç nokta yolu.	Yes
index_name	Dize	Başvuruda bulunulan Azure Search kaynağında kullanılabilir olarak kullanılacak dizinin adı.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Yapılandırılmış bir Azure Search kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Hayır
query_type	azureSearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Search alma sorgusunun türü.	Hayır
semantic_configuration	Dize	Sorgu için ek anlamsal yapılandırma.	Hayır
filtrele	Dize	Arama filtresi.	Hayır
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Hayır

azureSearchIndexFieldMappingOptions

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
title_field	Dize	Başlık olarak kullanılacak dizin alanının adı.	Hayır
url_field	Dize	URL olarak kullanılacak dizin alanının adı.	Hayır
filepath_field	Dize	Dosya yolu olarak kullanılacak dizin alanının adı.	Hayır
content_fields	dizi	İçerik olarak ele alınması gereken dizin alanlarının adları.	Hayır
content_fields_separator	Dize	İçerik alanlarının kullanması gereken ayırıcı desen.	Hayır
vector_fields	dizi	Vektör verilerini temsil eden alanların adları.	Hayır

azureSearchQueryType

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

Açıklama: Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Search alma sorgusunun türü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureSearchQueryType

Sabit Listesi Değerleri:

Value	Açıklama
basit	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.
vector_simple_hybrid	Vektör verileriyle basit sorgu stratejisinin bir birleşimini temsil eder.
vector_semantic_hybrid	Anlamsal arama ve vektör verileri sorgulamanın bir bileşimini temsil eder.

azureCosmosDBChatExtensionConfiguration

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	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.	Yes
parametreler	azureCosmosDBChatExtensionParameters	için Azure Cosmos DB kullanırken Verilerinizde Azure OpenAI sohbet uzantılarını yapılandırırken kullanılacak parametreler MongoDB sanal çekirdeği.	Hayır

azureCosmosDBChatExtensionParameters

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kimlik doğrulaması	onYourDataConnectionStringAuthenticationOptions	bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.	Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayır
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayır
katılık	integer	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ır
role_information	Dize	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ır
database_name	Dize	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı.	Yes
container_name	Dize	Azure Cosmos DB kaynak kapsayıcısının adı.	Yes
index_name	Dize	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı.	Yes
fields_mapping	azureCosmosDBFieldMappingOptions	Yapılandırılmış bir Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Yes

azureCosmosDBFieldMappingOptions

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
title_field	Dize	Başlık olarak kullanılacak dizin alanının adı.	Hayır
url_field	Dize	URL olarak kullanılacak dizin alanının adı.	Hayır
filepath_field	Dize	Dosya yolu olarak kullanılacak dizin alanının adı.	Hayır
content_fields	dizi	İçerik olarak ele alınması gereken dizin alanlarının adları.	Yes
content_fields_separator	Dize	İçerik alanlarının kullanması gereken ayırıcı desen.	Hayır
vector_fields	dizi	Vektör verilerini temsil eden alanların adları.	Yes

onYourDataAuthenticationOptions

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataAuthenticationType	Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri.	Yes

onYourDataAuthenticationType

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

Açıklama: Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri.

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataAuthenticationType

Sabit Listesi Değerleri:

Value	Açıklama
api_key	API anahtarı aracılığıyla kimlik doğrulaması.
connection_string	bağlantı dizesi aracılığıyla kimlik doğrulaması.
system_assigned_managed_identity	Sistem tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.
user_assigned_managed_identity	Kullanıcı tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.

onYourDataApiKeyAuthenticationOptions

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataAuthenticationType	Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri.	Yes
anahtar	Dize	Kimlik doğrulaması için kullanılacak API anahtarı.	Hayır

onYourDataConnectionStringAuthenticationOptions

bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataAuthenticationType	Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri.	Yes
connection_string	Dize	Kimlik doğrulaması için kullanılacak bağlantı dizesi.	Hayır

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataAuthenticationType	Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataAuthenticationType	Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri.	Yes
managed_identity_resource_id	Dize	Kimlik doğrulaması için kullanılacak kullanıcı tarafından atanan yönetilen kimliğin kaynak kimliği.	Hayır

onYourDataVectorizationSource

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataVectorizationSourceType	Azure OpenAI On Your Data ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder vektör araması.	Yes

onYourDataVectorizationSourceType

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

Açıklama: Verilerinizde Azure OpenAI'nin 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:

Value	Açıklama
endpoint	Azure OpenAI ekleme modeline yönelik genel hizmet çağrıları tarafından gerçekleştirilen vektörleştirmeyi temsil eder.
deployment_name	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.

onYourDataDeploymentNameVectorizationSource

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataVectorizationSourceType	Azure OpenAI On Your Data ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder vektör araması.	Yes
deployment_name	Dize	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 bir iç çağrı aracılığıyla kullanır.	Hayır

onYourDataEndpointVectorizationSource

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataVectorizationSourceType	Azure OpenAI On Your Data ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder vektör araması.	Yes
kimlik doğrulaması	onYourDataApiKeyAuthenticationOptions	API anahtarı kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.	Hayır
endpoint	Dize	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ç noktayı özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı yoluyla kullanır.	Hayır

azureChatExtensionsMessageContext

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Alıntı	dizi	Yanıtta yardımcı iletisini oluşturmak için kullanılan veri kaynağı alma sonucu.	Hayır
amaç	Dize	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ır

Alıntı

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
content	Dize	Alıntının içeriği.	Yes
başlık	Dize	Alıntının başlığı.	Hayır
url	Dize	Alıntının URL'si.	Hayır
dosya yolu	Dize	Alıntının dosya yolu.	Hayır
chunk_id	Dize	Alıntının öbek kimliği.	Hayır

chatCompletionMessageToolCall

Adı	Tür	Açıklama	Zorunlu	Varsayılan
id	dize	Araç çağrısının kimliği.	Yes
Tür	toolCallType	Bu durumda functionaraç çağrısının türü.	Yes
function	nesne	Modelin çağırdığını işlev.	Yes

İşlevin özellikleri

Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

Bağımsız değişken

Adı	Tür	Açıklama	Varsayılan
Bağımsız değişken	Dize	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.

toolCallType

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:

Value	Açıklama
function	Araç çağrı türü işlevdir.

chatCompletionRequestMessageTool

Adı	Tür	Açıklama	Zorunlu	Varsayılan
tool_call_id	Dize	Bu iletinin yanıt verdiği araç çağrısı.	Hayır
content	Dize	İletinin içeriği.	Hayır

chatCompletionRequestMessageFunction

Adı	Tür	Açıklama	Zorunlu	Varsayılan
rol	enum	İleti yazarının rolü( bu örnekte function). Olası değerler: işlev	Hayır
Adı	Dize	İletinin içeriği.	Hayır
content	Dize	İletinin içeriği.	Hayır

createChatCompletionResponse

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
id	dize	Sohbetin tamamlanması için benzersiz bir tanımlayıcı.	Yes
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	Hayır
Seçenek	dizi	Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse n birden fazla olabilir.	Yes
oluşturulan	integer	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak).	Yes
model	Dize	Sohbetin tamamlanması için kullanılan model.	Yes
system_fingerprint	Dize	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ır
nesne	enum	Her zaman chat.completionolan nesne türü. Olası değerler: chat.completion	Yes
kullanım	completionUsage	Tamamlanma isteği için kullanım istatistikleri.	Hayır

createChatCompletionStreamResponse

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
id	dize	Sohbetin tamamlanması için benzersiz bir tanımlayıcı. Her öbek aynı kimliktedir.	Yes
Seçenek	dizi	Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse n birden fazla öğe içerebilir.	Yes
oluşturulan	integer	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak). Her öbek aynı zaman damgasına sahiptir.	Yes
model	Dize	Tamamlanmayı oluşturmak için model.	Yes
system_fingerprint	Dize	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ır
nesne	enum	Her zaman chat.completion.chunkolan nesne türü. Olası değerler: chat.completion.chunk	Yes

chatCompletionStreamResponseDelta

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
content	Dize	Öbek iletisinin içeriği.	Hayır
function_call	nesne	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.	Hayır
tool_calls	dizi		Hayır
rol	enum	Bu iletinin yazarının rolü. Olası değerler: sistem, kullanıcı, yardımcı, araç	Hayır
Ret	Dize	Model tarafından oluşturulan reddetme iletisi.	Hayır

function_call özellikleri

Bağımsız değişken

Adı	Tür	Açıklama	Varsayılan
Bağımsız değişken	Dize	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.

Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

chatCompletionMessageToolCallChunk

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dizin	integer		Yes
id	dize	Araç çağrısının kimliği.	Hayır
Tür	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: işlev	Hayır
function	nesne		Hayır

İşlevin özellikleri

Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.

Bağımsız değişken

Adı	Tür	Açıklama	Varsayılan
Bağımsız değişken	Dize	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.

chatCompletionStreamOptions

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

Adı	Tür	Açıklama	Zorunlu	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ır

chatCompletionChoiceLogProbs

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
content	dizi	Günlük olasılık bilgilerini içeren ileti içerik belirteçlerinin listesi.	Yes
Ret	dizi	Günlük olasılık bilgilerini içeren ileti reddetme belirteçlerinin listesi.	Hayır

chatCompletionTokenLogprob

Adı	Tür	Açıklama	Zorunlu	Varsayılan
token	Dize	Belirteç.	Yes
logprob	Numara	Bu belirtecin günlük olasılığı.	Yes
bayt	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 .	Yes
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.	Yes

chatCompletionResponseMessage

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
rol	chatCompletionResponseMessageRole	Yanıt iletisinin yazarının rolü.	Yes
Ret	Dize	Model tarafından oluşturulan reddetme iletisi.	Yes
content	Dize	İletinin içeriği.	Yes
tool_calls	dizi	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	Hayır
function_call	chatCompletionFunctionCall	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.	Hayır
bağlam	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ır

chatCompletionResponseMessageRole

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:

• asistan

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.

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

chatCompletionNamedToolChoice

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: işlev	Yes
function	nesne		Yes

İşlevin özellikleri

Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	Ç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.

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.	Yes
Bağımsız değişken	Dize	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.	Yes

completionUsage

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
prompt_tokens	integer	İstemdeki belirteç sayısı.	Yes
completion_tokens	integer	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Yes
total_tokens	integer	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Yes
completion_tokens_details	nesne	Tamamlanmada kullanılan belirteçlerin dökümü.	Hayır

completion_tokens_details özellikleri

reasoning_tokens

Adı	Tür	Açıklama	Varsayılan
reasoning_tokens	integer	Model tarafından mantık yürütme için oluşturulan belirteçler.

chatCompletionTool

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	Aracın türü. Şu anda yalnızca function desteklenmektedir. Olası değerler: işlev	Yes
function	FunctionObject		Yes

FunctionParameters

İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza](/azure/ai-services/openai/how-to/function-calling) ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.

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

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

FunctionObject

Adı	Tür	Açıklama	Zorunlu	Varsayılan
açıklama	Dize	İş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ır
Adı	Dize	Ç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.	Yes
parametreler	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza](/azure/ai-services/openai/how-to/function-calling) ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar.	Hayır
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. olduğunda strict trueJSON Şemasının yalnızca bir alt kümesi desteklenir.	Hayır	Yanlış

ResponseFormatText

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	Tanımlanan yanıt biçiminin türü: text Olası değerler: metin	Yes

ResponseFormatJsonObject

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	Tanımlanan yanıt biçiminin türü: json_object Olası değerler: json_object	Yes

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	enum	Tanımlanan yanıt biçiminin türü: json_schema Olası değerler: json_schema	Yes
json_schema	nesne		Yes

json_schema özellikleri

açıklama

Ad	Tür	Açıklama	Varsayılan
açıklama	Dize	Yanıt biçiminin ne için olduğuna ilişkin bir açıklama, model tarafından biçimde nasıl yanıt verileceğini belirlemek için kullanılır.

Adı

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

schema

Adı	Tür	Açıklama	Varsayılan
schema	ResponseFormatJsonSchemaSchema	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması.

Sıkı

Adı	Tür	Açıklama	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. olduğunda strict trueJSON Şemasının yalnızca bir alt kümesi desteklenir.	False

chatCompletionChoiceCommon

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dizin	integer		Hayır
finish_reason	Dize		Hayır

createTranslationRequest

Çeviri isteği.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dosyası	Dize	Çevrilecek ses dosyası.	Yes
Istemi	Dize	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ır
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayır
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ır	0

audioResponse

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
text	Dize	Çevrilmiş veya dökümü alınmış metin.	Yes

audioVerboseResponse

response_format verbose_json çeviri veya transkripsiyon yanıtı

Adı	Tür	Açıklama	Zorunlu	Varsayılan
text	Dize	Çevrilmiş veya dökümü alınmış metin.	Yes
görev	Dize	Ses görevinin türü.	Hayır
dil	Dize	Dil.	Hayır
süre	Numara	Süre.	Hayır
segmentler	dizi		Hayır

audioResponseFormat

Çı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

createTranscriptionRequest

Transkripsiyon isteği.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dosyası	Dize	Dökümü yapılan ses dosyası nesnesi.	Yes
Istemi	Dize	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ır
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayır
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ır	0
dil	Dize	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayır

audioSegment

Transkripsiyon veya çeviri segmenti.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
id	integer	Segment tanımlayıcısı.	Hayır
aramak	Numara	Segmentin uzaklığı.	Hayır
start	Numara	Segment başlangıç uzaklığı.	Hayır
end	Numara	Segment sonu uzaklığı.	Hayır
text	Dize	Segment metni.	Hayır
Belirteç -leri	dizi	Metnin belirteçleri.	Hayır
sıcaklık	Numara	Sıcaklık.	Hayır
avg_logprob	Numara	Ortalama günlük olasılığı.	Hayır
compression_ratio	Numara	Sıkıştırma oranı.	Hayır
no_speech_prob	Numara	olasılığı no speech.	Hayır

imageQuality

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:

Value	Açıklama
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.

imagesResponseFormat

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:

Value	Açıklama
url	Oluşturulan görüntüleri indirmek için geçici erişim 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:

Value	Açıklama
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.

imageStyle

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:

Value	Açıklama
Canlı	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.

imageGenerationsRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Istemi	Dize	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Yes
n	integer	Oluşturulacak görüntü sayısı.	Hayır	1
size	imageSize	Oluşturulan görüntülerin boyutu.	Hayır	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	Hayır	url
kullanıcı	Dize	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ır
nitelik	imageQuality	Oluşturulacak görüntünün kalitesi.	Hayır	standart
stili	imageStyle	Oluşturulan görüntülerin stili.	Hayır	Canlı

generateImagesResponse

Adı	Tür	Açıklama	Zorunlu	Varsayılan
oluşturulan	integer	İşlemin oluşturulduğu unix zaman damgası.	Yes
veriler	dizi	Başarılı olursa işlemin sonuç verileri	Yes

imageResult

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
url	Dize	Resim URL'si.	Hayır
b64_json	Dize	base64 kodlanmış görüntüsü	Hayır
content_filter_results	dalleContentFilterResults	İçerik filtreleme sonuçları hakkında bilgi.	Hayır
revised_prompt	Dize	İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem.	Hayır
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ır

Tamamlama uzantıları

Tamamlama uzantıları, Azure OpenAI veri düzlemi çıkarım belirtiminin 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.

Metin okuma

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

Sonraki adımlar

Modeller hakkında bilgi edinin ve REST API ile ince ayarlamalar yapın. Azure OpenAI'yi destekleyen temel modeller hakkında daha fazla bilgi edinin.