Microsoft Foundry Modellerinde Azure OpenAI REST API başvurusu

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

API belirtimleri

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

• Kontrol düzlemi
• Veri düzlemi - yazarlık
• Veri düzlemi - çıkarım

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

Important

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

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

Authentication

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

• API Anahtarı Doğrulama: Bu tür kimlik doğrulama için, tüm API talepleri HTTP başlığında API Anahtarını api-key içermelidir. Quickstart, bu tür kimlik doğrulama ile aramaların nasıl yapılacağına dair rehberlik sağlar.

• Microsoft Entra ID kimlik doğrulama: Bir Microsoft Entra token kullanarak API çağrısını kimlik doğrulaması yapabilirsiniz. Kimlik doğrulama tokenları, bir talebe başlık Authorization olarak dahil edilir. Sağlanan belirteç, örneğin , ile gelmelidirBearerBearer YOUR_AUTH_TOKEN. Microsoft Entra ID<doğrulama rehberimizi okuyabilirsiniz>.

REST API sürümleme

Servis API'leri sorgu parametresi kullanılarak api-version versiyonlandırılır. Tüm sürümler YYYY-MM-DD tarih yapısını takip eder. Ö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ı ise Azure OpenAI veri düzlemi çıkarım spesifikasyonunun GA sürümünü 2024-10-21 kapsar.

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

Tamamlamalar

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

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

URI Parametreleri

İsim	İçinde	Zorunlu	Türü	Description
endpoint	path	Evet	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
dağıtım kimliği	path	Evet	string	Dağıtılan modelin dağıtım kimliği.
API sürümü	soru	Evet	string	API sürümü

İstek Başlığı

İsim	Zorunlu	Türü	Description
API anahtarı	True	string	Azure OpenAI API anahtarını buradan paylaşın

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Tanım
uygulama/json	createCompletionResponse	API'den gelen bir tamamlanma yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli taşır (sohbet uç noktasının aksine).

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

İçerik Türü	Türü	Tanım
uygulama/json	errorResponse

Examples

Örnek

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

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

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Embeddings

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

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

URI Parametreleri

İsim	İçinde	Zorunlu	Türü	Description
endpoint	path	Evet	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
dağıtım kimliği	path	Evet	string
API sürümü	soru	Evet	string	API sürümü

İstek Başlığı

İsim	Zorunlu	Türü	Description
API anahtarı	True	string	Azure OpenAI API anahtarını buradan paylaşın

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

İsim	Türü	Description	Zorunlu	Varsayılan
Obje	string		Evet
model	string		Evet
veriler	Dizi		Evet
usage	Obje		Evet

Kullanım için özellikler

prompt_tokens

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

total_tokens

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

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Tanım
uygulama/json	Obje

Examples

Örnek

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

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

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

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Sohbet bitişleri

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

Sohbet mesajı için bir tamamlanma yaratır

URI Parametreleri

İsim	İçinde	Zorunlu	Türü	Description
endpoint	path	Evet	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
dağıtım kimliği	path	Evet	string	Dağıtılan modelin dağıtım kimliği.
API sürümü	soru	Evet	string	API sürümü

İstek Başlığı

İsim	Zorunlu	Türü	Description
API anahtarı	True	string	Azure OpenAI API anahtarını buradan paylaşın

İstek Gövdesi

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Tanım
uygulama/json	createChatCompletionResponse veya createChatCompletionStreamResponse

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

İçerik Türü	Türü	Tanım
uygulama/json	errorResponse

Examples

Örnek

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

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

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

Azure Arama verileri ve sistem tarafından atanan yönetilen kimlik temelinde bir tamamlama oluşturur.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

Azure Search vektör verilerine, önceki asistan mesajına ve kullanıcı tarafından atanan yönetilen kimlik temelinde bir tamamlama oluşturur.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Ö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 - Yarat

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

Sesi giriş diline aktarır.

URI Parametreleri

İsim	İçinde	Zorunlu	Türü	Description
endpoint	path	Evet	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
dağıtım kimliği	path	Evet	string	Konuşmadan metne modelin dağıtım kimliği. Desteklenen modeller hakkında bilgi için [/azure/ai-foundry/openai/concepts/models#audio-models] adresine bakınız.
API sürümü	soru	Evet	string	API sürümü

İstek Başlığı

İsim	Zorunlu	Türü	Description
API anahtarı	True	string	Azure OpenAI API anahtarını buradan paylaşın

İstek Gövdesi

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

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Tanım
uygulama/json	audioResponse veya audioVerboseResponse
düz metin	string	Çıktı formatında (response_format metin, vtt veya srt'den oluştuğunda) transkripsiyon edilen metin.

Examples

Örnek

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

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

Yanıtlar: Durum Kodu: 200

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

Örnek

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Yanıtlar: Durum Kodu: 200

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

Çeviriler - Yarat

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

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

URI Parametreleri

İsim	İçinde	Zorunlu	Türü	Description
endpoint	path	Evet	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
dağıtım kimliği	path	Evet	string	Dağıtılan fısıltı modelinin dağıtım kimliği. Desteklenen modeller hakkında bilgi için [/azure/ai-foundry/openai/concepts/models#audio-models] adresine bakınız.
API sürümü	soru	Evet	string	API sürümü

İstek Başlığı

İsim	Zorunlu	Türü	Description
API anahtarı	True	string	Azure OpenAI API anahtarını buradan paylaşın

İstek Gövdesi

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

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Tanım
uygulama/json	audioResponse veya audioVerboseResponse
düz metin	string	Çıktı formatında (response_format metin, vtt veya srt'den oluştuğunda) transkripsiyon edilen metin.

Examples

Örnek

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Yanıtlar: Durum Kodu: 200

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

Örnek

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Yanıtlar: Durum Kodu: 200

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

Görüntü oluşturma

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

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

URI Parametreleri

İsim	İçinde	Zorunlu	Türü	Description
endpoint	path	Evet	string url	OpenAI uç noktaları Azure destekleniyor (örneğin protokol ve ana adı: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı verin). https://{your-resource-name}.openai.azure.com
dağıtım kimliği	path	Evet	string	Dağıtılan dall-e modelinin dağıtım kimliği.
API sürümü	soru	Evet	string	API sürümü

İstek Başlığı

İsim	Zorunlu	Türü	Description
API anahtarı	True	string	Azure OpenAI API anahtarını buradan paylaşın

İstek Gövdesi

İçerik Türü: application/json

İsim	Türü	Description	Zorunlu	Varsayılan
prompt	string	İstenen görsel(ler)in metin açıklaması. Maksimum uzunluk 4.000 karakterdir.	Evet
n	integer	Üretilecek görüntü sayısı.	No	1
size	imageSize	Oluşturulan görüntülerin boyutu.	No	1024x1024
yanıt formatı	imagesResponseFormat	Oluşturulan görüntülerin geri dönüş biçimi.	No	url
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No
nitelik	imageQuality	Üretilecek görüntünün kalitesi.	No	standart
Stil	imageStyle	Oluşturulan görüntülerin stili.	No	Canlı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Türü	Tanım
uygulama/json	generateImagesResponse

Durum Kodu: varsayılan

Açıklama: Bir hata meydana geldi.

İçerik Türü	Türü	Tanım
uygulama/json	dalleErrorResponse

Examples

Örnek

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

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

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Components

errorResponse

İsim	Türü	Description	Zorunlu	Varsayılan
error	error		No

errorBase

İsim	Türü	Description	Zorunlu	Varsayılan
kod	string		No
mesaj	string		No

error

İsim	Türü	Description	Zorunlu	Varsayılan
param	string		No
type	string		No
inner_error	innerError	İç hata ve ek detaylar.	No

innerError

İç hata ve ek detaylar.

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

innerErrorCode

İç hata nesnesi için hata kodları.

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

Tür: dize

Varsayılan:

Enum Adı: InnerErrorCode

Sabit Listesi Değerleri:

Değer	Description
Sorumlu Yapay Zeka Politikası İhlali	Bu istem, içerik filtresi kurallarından birini ihlal ediyordu.

dalleErrorResponse

İsim	Türü	Description	Zorunlu	Varsayılan
error	dalleError		No

dalleError

İsim	Türü	Description	Zorunlu	Varsayılan
param	string		No
type	string		No
inner_error	dalleInnerError	İç hata ve ek detaylar.	No

dalleInnerError

İç hata ve ek detaylar.

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

içerikFiltreSonucuTabanı

İsim	Türü	Description	Zorunlu	Varsayılan
filtered	boolean		Evet

içerik filtresi ciddiyet sonucu

İsim	Türü	Description	Zorunlu	Varsayılan
filtered	boolean		Evet
severity	string		No

içerik filtresi algılandı sonucu

İsim	Türü	Description	Zorunlu	Varsayılan
filtered	boolean		Evet
detected	boolean		No

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

İsim	Türü	Description	Zorunlu	Varsayılan
Alıntı	Obje		No

Atıf için özellikler

URL

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

lisans

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

içerik filtre sonuç temeli

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

İsim	Türü	Description	Zorunlu	Varsayılan
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	içerik filtresi tespit edilen sonuç		No
error	errorBase		No

contentFilterPromptResults

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

İsim	Türü	Description	Zorunlu	Varsayılan
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	içerik filtresi tespit edilen sonuç		No
error	errorBase		No
jailbreak	içerik filtresi tespit edilen sonuç		No

İçerik Filtre Seçimi Sonuçları

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

İsim	Türü	Description	Zorunlu	Varsayılan
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	içerik filtresi tespit edilen sonuç		No
error	errorBase		No
protected_material_text	içerik filtresi tespit edilen sonuç		No
protected_material_code	içerik Filtresi Algılandı ve Alıntı Sonucu		No

uyarı filtre sonucu

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

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

Sonuçları Filtrele

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

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

dalleİçerikFiltrelemeSonuçları

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

İsim	Türü	Description	Zorunlu	Varsayılan
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No

dalleFiltreSonuçları

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

İsim	Türü	Description	Zorunlu	Varsayılan
sexual	contentFilterSeverityResult		No
violence	contentFilterSeverityResult		No
hate	contentFilterSeverityResult		No
self_harm	contentFilterSeverityResult		No
profanity	içerik filtresi tespit edilen sonuç		No
jailbreak	içerik filtresi tespit edilen sonuç		No

sohbetTamamlamaİstekOrtak

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

TamamlamaİsteğiOluştur

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

createCompletionResponse

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

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

SohbetTamamlanmaTalebiOluştur

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

sohbetTamamlamaFonksiyonları

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

sohbetTamamlamaFonksiyonÇağrıSeçeneği

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

İsim	Türü	Description	Zorunlu	Varsayılan
name	string	Çağrılacak fonksiyonun adı.	Evet

sohbetTamamlamaİstekMesajı

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

chatCompletionRequestSystemMessage

İsim	Türü	Description	Zorunlu	Varsayılan
içerik	dizi veya dizi	Sistem mesajının içeriği.	Evet
role	enum	Mesaj yazarının rolü, bu durumda system. Olası değerler: sistem	Evet
name	string	Katılımcı için isteğe bağlı bir isim. Aynı roldeki katılımcıları ayırt etmek için model bilgisi sağlar.	No

SohbetTamamlamaİsteğiKullanıcıMesajı

İsim	Türü	Description	Zorunlu	Varsayılan
içerik	dizi veya dizi	Kullanıcı mesajının içeriği.	Evet
role	enum	Mesaj yazarının rolü, bu durumda user. Olası değerler: kullanıcı	Evet
name	string	Katılımcı için isteğe bağlı bir isim. Aynı roldeki katılımcıları ayırt etmek için model bilgisi sağlar.	No

chatCompletionRequestAssistantMessage

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

function_call için özellikler

arguments

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

name

İsim	Türü	Description	Varsayılan
name	string	Çağrılacak fonksiyonun adı.

chatCompletionRequestToolMessage

İsim	Türü	Description	Zorunlu	Varsayılan
role	enum	Mesaj yazarının rolü, bu durumda tool. Olası değerler: araç	Evet
içerik	dizi veya dizi	Araç mesajının içeriği.	Evet
tool_call_id	string	Bu mesajın yanıt verdiği araç çağrısı.	Evet

chatCompletionRequestFunctionMessage

İsim	Türü	Description	Zorunlu	Varsayılan
role	enum	Mesaj yazarının rolü, bu durumda function. Olası değerler: fonksiyon	Evet
içerik	string	Fonksiyon mesajının içeriği.	Evet
name	string	Çağrılacak fonksiyonun adı.	Evet

SohbetTamamlamaİstekSistemiMesajİçerikParçası

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

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

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

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

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

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

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

chatCompletionRequestMessageContentPartText

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	İçerik kısmının türü. Olası değerler: metin	Evet
text	string	Metin içeriği.	Evet

chatCompletionRequestMessageContentPartImage

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	İçerik kısmının türü. Olası değerler: image_url	Evet
image_url	Obje		Evet

image_url için özellikler

url

İsim	Türü	Description	Varsayılan
url	string	Ya görselin URL'si ya da base64 kodlanmış görüntü verisi.

detail

İsim	Türü	Description	Varsayılan
detail	string	Görüntünün detay seviyesini belirtir. Daha fazla bilgi için Vizyon rehberi.	otomatik

sohbet tamamlaması talebi mesaj içeriği reddi

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	İçerik kısmının türü. Olası değerler: reddetme	Evet
Ret	string	Model tarafından oluşturulan reddetme mesajı.	Evet

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

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin bir temsili. Bu, bir sohbet tarafından kullanılacak Yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama talepleri. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet

azureChatExtensionType

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

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureChatExtensionType

Sabit Listesi Değerleri:

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

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

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

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

azureAramaSohbetEklentiParametreleri

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

İsim	Türü	Description	Zorunlu	Varsayılan
authentication	onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions		Evet
En iyi n belgeleri	integer	Yapılandırılmış sorgu için özellik yapılacak en yüksek belge sayısı.	No
kapsam dahilinde	boolean	Sorguların indekslenmiş verilerin kullanımıyla sınırlandırılıp sınırlamayacağı.	No
katılık	integer	Arama alaka filtrelemesinin yapılandırılmış katılığı. Ne kadar katı olursa, o kadar yüksek hassasiyet ama cevap hatırlama o kadar düşüktür.	No
rol_bilgisi	string	Modele nasıl davranması gerektiği ve yanıt oluştururken referans vermesi gereken herhangi bir bağlama dair talimatlar verin. Asistanın kişiliğini tarif edebilir ve ona yanıtların nasıl biçimlendirileceğini söyleyebilirsiniz. Bunun için 100 token sınırı var ve bu toplam token sınırına dahil edilir.	No
endpoint	string	Azure Search kaynağının kullanması için mutlak uç nokta yolu.	Evet
endeks_adı	string	Referans verilen Azure Search kaynağında kullanılabilir olan indeksin adı.	Evet
alan eşleştirme	AzureAramaDizinAlanEşlemeSeçenekleri	Yapılandırılmış bir Azure Search kaynağı kullanıldığında alanların nasıl işlendiğini kontrol etmek için isteğe bağlı ayarlar.	No
sorgu_türü	azureSearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanıldığında yürütülmesi gereken Azure Arama alma sorgusu türü.	No
anlamsal yapılandırma	string	Sorgu için ek anlamsal yapılandırma.	No
filter	string	Arama filtresi.	No
gömülü_bağımlılık	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		No

AzureAramaDizinAlanEşlemeSeçenekleri

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

İsim	Türü	Description	Zorunlu	Varsayılan
başlık_alanı	string	Başlık olarak kullanılacak indeks alanının adı.	No
url_alanı	string	URL olarak kullanılacak indeks alanının adı.	No
Dosya yolu alanı	string	Dosya yolu olarak kullanılacak indeks alanının adı.	No
içerik alanları	Dizi	İçerik olarak ele alınması gereken indeks alanlarının isimleri.	No
içerik_alanları_ayırıcı	string	İçerik alanlarının kullanması gereken ayırıcı deseni.	No
vektör alanları	Dizi	Vektör verisini temsil eden alanların isimleri.	No

azureAramaSorguTürü

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

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureSearchQueryType

Sabit Listesi Değerleri:

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

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

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin bir temsili. Bu, bir sohbet tarafından kullanılacak Yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama talepleri. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Evet
parameters	azureCosmosDBChatExtensionParameters	Azure OpenAI On Your Data sohbet uzantılarını Azure Cosmos DB için kullanırken kullanılacak parametreler MongoDB sanal çekirdeği.	No

AzureCosmosDBSohbetUzantısıParametreleri

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

İsim	Türü	Description	Zorunlu	Varsayılan
authentication	VeriBağlantıDizesiKimlikDoğrulamaSeçenekleriÜzerinde	Azure OpenAI On Your Data için bağlantı dizesi kullanılırken kimlik doğrulama seçenekleri.	Evet
En iyi n belgeleri	integer	Yapılandırılmış sorgu için özellik yapılacak en yüksek belge sayısı.	No
kapsam dahilinde	boolean	Sorguların indekslenmiş verilerin kullanımıyla sınırlandırılıp sınırlamayacağı.	No
katılık	integer	Arama alaka filtrelemesinin yapılandırılmış katılığı. Ne kadar katı olursa, o kadar yüksek hassasiyet ama cevap hatırlama o kadar düşüktür.	No
rol_bilgisi	string	Modele nasıl davranması gerektiği ve yanıt oluştururken referans vermesi gereken herhangi bir bağlama dair talimatlar verin. Asistanın kişiliğini tarif edebilir ve ona yanıtların nasıl biçimlendirileceğini söyleyebilirsiniz. Bunun için 100 token sınırı var ve bu toplam token sınırına dahil edilir.	No
veritabanı_adı	string	Azure Cosmos DB ile kullanılacak MongoDB vCore veritabanı adı.	Evet
konteyner_adı	string	Azure Cosmos DB kaynak konteynerinin adı.	Evet
endeks_adı	string	Azure Cosmos DB ile kullanılacak MongoDB vCore indeks adı.	Evet
alan eşleştirme	azureCosmosDBFieldMappingOptions	Yapılandırılmış Azure Cosmos DB kaynağı kullanıldığında alanların nasıl işlenildiğini kontrol etmek için isteğe bağlı ayarlar.	Evet
gömülü_bağımlılık	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Evet

Azure Cosmos DB Alan Eşleme Seçenekleri

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

İsim	Türü	Description	Zorunlu	Varsayılan
başlık_alanı	string	Başlık olarak kullanılacak indeks alanının adı.	No
url_alanı	string	URL olarak kullanılacak indeks alanının adı.	No
Dosya yolu alanı	string	Dosya yolu olarak kullanılacak indeks alanının adı.	No
içerik alanları	Dizi	İçerik olarak ele alınması gereken indeks alanlarının isimleri.	Evet
içerik_alanları_ayırıcı	string	İçerik alanlarının kullanması gereken ayırıcı deseni.	No
vektör alanları	Dizi	Vektör verisini temsil eden alanların isimleri.	Evet

Veri Kimlik Doğrulama Seçenekleriniz

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

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

VeriKimlikDoğrulamaTürünüzÜzerinde

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

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

Tür: dize

Varsayılan:

Enum Adı: OnYourDataAuthenticationType

Sabit Listesi Değerleri:

Değer	Description
API anahtarı	API anahtarı üzerinden kimlik doğrulama.
connection_string	Kimlik doğrulama bağlantı dizesi ile.
sistem tarafından atanan yönetilen kimlik	Sistem tarafından atanan yönetilen kimlik üzerinden kimlik doğrulama.
kullanıcı atamalı yönetilen kimlik	Kullanıcı tarafından atanan yönetilen kimlik üzerinden kimlik doğrulama.

onYourDataApiKeyKimlikDoğrulamaSeçenekleri

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	VeriKimlikDoğrulamaTürünüzÜzerinde	Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.	Evet
key	string	Kimlik doğrulama için kullanılacak API anahtarı.	No

VeriBağlantıDizesiKimlikDoğrulamaSeçenekleriÜzerinde

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	VeriKimlikDoğrulamaTürünüzÜzerinde	Azure OpenAI On Your Data ile desteklenen kimlik doğrulama türleri.	Evet
connection_string	string	Kimlik doğrulama için kullanılacak bağlantı dizesi.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourVeriVektörleştirmeKaynağı

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	Veri Vektorizasyon Kaynak Tipiniz Üzerinde	Azure OpenAI On Your Data'nın verilerin vektörizasyonunu yapılandırmak için kullanabileceği mevcut kaynakları temsil eder vektör araması.	Evet

Veri Vektorizasyon Kaynak Tipiniz Üzerinde

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

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

Tür: dize

Varsayılan:

Enum Adı: OnYourDataVectorizationSourceType

Sabit Listesi Değerleri:

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

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

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	Veri Vektorizasyon Kaynak Tipiniz Üzerinde	Azure OpenAI On Your Data'nın verilerin vektörizasyonunu yapılandırmak için kullanabileceği mevcut kaynakları temsil eder vektör araması.	Evet
dağıtım_adı	string	Vektörleştirme için kullanılacak model dağıtımının adını belirtir. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalı, ancak On Your Data bu model dağıtımını genel çağrı yerine dahili çağrı yoluyla kullanacak; bu da özel ağlarda bile vektör aramasını mümkün kılıyor.	No

onYourDataEndpointVectorizationSource

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	Veri Vektorizasyon Kaynak Tipiniz Üzerinde	Azure OpenAI On Your Data'nın verilerin vektörizasyonunu yapılandırmak için kullanabileceği mevcut kaynakları temsil eder vektör araması.	Evet
authentication	onYourDataApiKeyKimlikDoğrulamaSeçenekleri	API anahtarı kullanırken Azure OpenAI On Your Data için kimlik doğrulama seçenekleri.	No
endpoint	string	Vektörleştirme için kullanılacak uç noktayı belirtir. Bu uç nokta aynı Azure OpenAI kaynağında olmalı, ancak On Your Data bu uç noktayı kamuya açık çağrı yerine dahili çağrı yoluyla kullanır; bu da özel ağlarda bile vektör aramasını mümkün kılar.	No

azureChatUzantılarıMesajBağlamı

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

İsim	Türü	Description	Zorunlu	Varsayılan
Alıntı	Dizi	Veri kaynağı alma sonucu, yanıtta asistan mesajını oluşturmak için kullanılır.	No
kasıt	string	Sohbet geçmişinden tespit edilen niyet, bağlamı aktarmak için bir sonraki tura geçer.	No

Alıntı

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

İsim	Türü	Description	Zorunlu	Varsayılan
içerik	string	Alıntının içeriği.	Evet
title	string	Atakın başlığı.	No
url	string	Atıfın URL'si.	No
Filepath	string	Atakın dosya yolu.	No
chunk_id	string	Atıfın bölüm ID'si.	No

SohbetTamamlamaMesajAracıÇağrısı

İsim	Türü	Description	Zorunlu	Varsayılan
kimlik	string	Araç çağrısının kimliği.	Evet
type	toolCallType	Bu durumda araç çağrısının functiontürü.	Evet
function	Obje	Modelin çağırdığı fonksiyon.	Evet

Fonksiyon için özellikler

name

İsim	Türü	Description	Varsayılan
name	string	Çağrılacak fonksiyonun adı.

arguments

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

toolCallType

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

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

Tür: dize

Varsayılan:

Enum Adı: ToolCallType

Sabit Listesi Değerleri:

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

chatTamamlamaİstekMesajAracı

İsim	Türü	Description	Zorunlu	Varsayılan
tool_call_id	string	Bu mesajın yanıt verdiği araç çağrısı.	No
içerik	string	Mesajın içeriği.	No

SohbetTamamlamaTalepMesajFonksiyonu

İsim	Türü	Description	Zorunlu	Varsayılan
role	enum	Mesaj yazarının rolü, bu durumda function. Olası değerler: fonksiyon	No
name	string	Mesajın içeriği.	No
içerik	string	Mesajın içeriği.	No

createChatCompletionResponse

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

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

SohbetTamamlamaAkışYanıtıOluştur

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

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

sohbetTamamlamaAkışYanıtDelta

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

İsim	Türü	Description	Zorunlu	Varsayılan
içerik	string	Mesajın içeriği.	No
function_call	Obje	Kullanımdan kaldırıldı ve yerine tool_calls. Model tarafından oluşturulan çağrılması gereken fonksiyonun adı ve argümanları.	No
tool_calls	Dizi		No
role	enum	Bu mesajın yazarının rolü. Olası değerler: sistem, kullanıcı, asistan, araç	No
Ret	string	Model tarafından oluşturulan reddetme mesajı.	No

function_call için özellikler

arguments

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

name

İsim	Türü	Description	Varsayılan
name	string	Çağrılacak fonksiyonun adı.

sohbetTamamlamaMesajAracıÇağrıParçası

İsim	Türü	Description	Zorunlu	Varsayılan
indeks	integer		Evet
kimlik	string	Araç çağrısının kimliği.	No
type	enum	Aracın türü. Şu anda sadece function destekleniyor. Olası değerler: fonksiyon	No
function	Obje		No

Fonksiyon için özellikler

name

İsim	Türü	Description	Varsayılan
name	string	Çağrılacak fonksiyonun adı.

arguments

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

chatCompletionStreamOptions

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

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

sohbetTamamlamaSecimiLogOlasiliklari

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

İsim	Türü	Description	Zorunlu	Varsayılan
içerik	Dizi	Log olasılık bilgisi içeren mesaj içeriği tokenleri listesi.	Evet
Ret	Dizi	Log olasılık bilgisi içeren mesaj reddetme tokenlarının bir listesi.	No

chatCompletionTokenLogprob

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

SohbetiTamamlamaYanıtMesajı

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

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

chatTamamlamaYanıtMesajıRolü

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

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

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

• Yardımcısı

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	Aracın türü. Şu anda sadece function destekleniyor. Olası değerler: fonksiyon	Evet
function	Obje		Evet

Fonksiyon için özellikler

name

İsim	Türü	Description	Varsayılan
name	string	Çağrılacak fonksiyonun adı.

ParallelToolCalls

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

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

chatTamamlamaMesajAracıÇağrıları

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

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

chatCompletionFunctionCall

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

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

tamamlama kullanımı

Tamamlama talebi için kullanım istatistikleri.

İsim	Türü	Description	Zorunlu	Varsayılan
prompt_tokens	integer	İsterdeki jeton sayısı.	Evet
completion_tokens	integer	Oluşturulan tamamlamada jeton sayısı.	Evet
total_tokens	integer	İstekte kullanılan toplam token sayısı (prompt + tamamlanma).	Evet
completion_tokens_details	Obje	Bir tamamlamada kullanılan jetonların dağılımı.	No

completion_tokens_details için özellikler

akıl yürütme birimleri

İsim	Türü	Description	Varsayılan
akıl yürütme birimleri	integer	Model tarafından oluşturulan tokenlar, akıl yürütme için.

SohbetTamamlamaAracı

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	Aracın türü. Şu anda sadece function destekleniyor. Olası değerler: fonksiyon	Evet
function	FunctionObject		Evet

FunctionParameters

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

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

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

FunctionObject

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

YanıtFormatıMetni

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt formatı türü: text Olası değerler: metin	Evet

YanıtFormatıJsonNesne

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt formatı türü: json_object Olası değerler: json_object	Evet

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

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

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

YanıtFormatıJsonŞeması

İsim	Türü	Description	Zorunlu	Varsayılan
type	enum	Tanımlanan yanıt formatı türü: json_schema Olası değerler: json_schema	Evet
json şeması	Obje		Evet

json_schema için özellikler

description

İsim	Türü	Description	Varsayılan
description	string	Yanıt formatının ne için olduğunu tanımlayan bir açıklama, model tarafından formatta nasıl yanıt verileceğini belirlemek için kullanılır.

name

İsim	Türü	Description	Varsayılan
name	string	Yanıt formatının adı. A-z, A-Z, 0-9 olmalı veya alt çizgi ve tire içeren olmalı, maksimum uzunluğu 64 olmalıdır.

şema

İsim	Türü	Description	Varsayılan
şema	YanıtFormatJsonŞemaŞeması	Yanıt formatı için şema, JSON Şema nesnesi olarak tanımlanır.

Kesin

İsim	Türü	Description	Varsayılan
Kesin	boolean	Çıktı üretirken sıkı şema uyumunu etkinleştirip etkinleştirilmeyeceği. Doğru olarak ayarlandığında, model her zaman alanda schema tanımlanan tam şemayı takip eder. Yalnızca JSON şemasının bir alt kümesi desteklenir, ne strict zaman .true	Yanlış

sohbetTamamlamaSeçimiOrtak

İsim	Türü	Description	Zorunlu	Varsayılan
indeks	integer		No
bitiş_nedeni	string		No

Çeviri İstek Oluştur

Çeviri isteği.

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

sesli yanıt

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

İsim	Türü	Description	Zorunlu	Varsayılan
text	string	Çevirilmiş veya transkribe edilmiş metin.	Evet

audioVerboseResponse

Çeviri veya transkripsiyon yanıtı response_format verbose_json

İsim	Türü	Description	Zorunlu	Varsayılan
text	string	Çevirilmiş veya transkribe edilmiş metin.	Evet
görev	string	Sesli bir görev türü.	No
language	string	Language.	No
duration	number	Süre.	No
segments	Dizi		No

audioResponseFormat

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

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

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

• JSON
• text
• srt
• verbose_json
• vtt

Transkripsiyon İsteği Oluştur

Transkripsiyon isteği.

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

audioSegment

Transkripsiyon veya çeviri bölümü.

İsim	Türü	Description	Zorunlu	Varsayılan
kimlik	integer	Segment tanımlayıcısı.	No
seek	number	Segmentin ofseti.	No
start	number	Segment başlangıcı offset.	No
son	number	Segment ucu offseti.	No
text	string	Segment metni.	No
tokens	Dizi	Metnin sembolleri.	No
sıcaklık	number	Sıcaklık.	No
avg_logprob	number	Ortalama log olasılığı.	No
compression_ratio	number	Sıkıştırma oranı.	No
no_speech_prob	number	Olasılığı no speech.	No

görüntü kalitesi

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

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

Tür: dize

Varsayılan: standart

Enum Adı: Kalite

Sabit Listesi Değerleri:

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

imagesResponseFormat

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

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

Tür: dize

Varsayılan: url

Enum Adı: ImagesResponseFormat

Sabit Listesi Değerleri:

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

imageSize

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

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

Tür: dize

Varsayılan: 1024x1024

Enum Adı: Boyut

Sabit Listesi Değerleri:

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

imageStyle

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

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

Tür: dize

Varsayılan: canlı

Enum Adı: Stil

Sabit Listesi Değerleri:

Değer	Description
Canlı	Vivid, aşırı gerçekçi ve dramatik görüntüler yaratıyor.
Doğal	Natural, daha doğal ve daha az aşırı gerçekçi görüntüler yaratır.

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

İsim	Türü	Description	Zorunlu	Varsayılan
prompt	string	İstenen görsel(ler)in metin açıklaması. Maksimum uzunluk 4.000 karakterdir.	Evet
n	integer	Üretilecek görüntü sayısı.	No	1
size	imageSize	Oluşturulan görüntülerin boyutu.	No	1024x1024
yanıt formatı	imagesResponseFormat	Oluşturulan görüntülerin geri dönüş biçimi.	No	url
user	string	Son kullanıcınızı temsil eden benzersiz bir tanımlayıcı, kötüye kullanımı izlemeye ve tespit etmeye yardımcı olabilir.	No
nitelik	imageQuality	Üretilecek görüntünün kalitesi.	No	standart
Stil	imageStyle	Oluşturulan görüntülerin stili.	No	Canlı

generateImagesResponse

İsim	Türü	Description	Zorunlu	Varsayılan
created	integer	İşlemin oluşturulduğu unix zaman damgası.	Evet
veriler	Dizi	İşlemin sonuç verileri, başarılı olursa	Evet

görüntüSonuç

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

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

Tamamlama uzantıları

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

Sohbet iletisi

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

Metinden konuşmaya (Önizleme)

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

Sonraki Adımlar

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