Microsoft Döküm Modellerinde OpenAI REST API başvurusu Azure

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

API specs

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

Control plane
Veri düzlemi - yazma
Veri düzlemi - çıkarım

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

Important

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

API	En son önizleme sürümü	En son GA sürümü	Specifications	Description
Control plane	`2025-07-01-preview`	`2025-06-01`	Spec files	Denetim düzlemi API'si kaynak oluşturma, model dağıtımı ve diğer üst düzey kaynak yönetimi görevleri gibi işlemler için kullanılır. Denetim düzlemi ayrıca Azure Resource Manager, Bicep, Terraform ve Azure CLI gibi özelliklerle neler yapabileceğinizi de yönetir.
Data plane	`v1 preview`	`v1`	Spec files	Veri düzlemi API'si çıkarım ve yazma işlemlerini denetler.

Authentication

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

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

REST API sürümü oluşturma

Hizmet API'leri sorgu parametresi kullanılarak api-version sürümlenir. Tüm sürümler YYYY-MM-DD tarih yapısını izler. For example:

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

Veri düzlemi çıkarımı

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

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

Completions

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

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

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Burada Azure OpenAI API anahtarı sağlayın

Request Body

Content-Type: application/json

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

Responses

Durum Kodu: 200

Description: OK

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

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

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

Yanıtlar: Durum Kodu: 200

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

Embeddings

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

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

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Burada Azure OpenAI API anahtarı sağlayın

Request Body

Content-Type: application/json

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

Responses

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

Kullanım özellikleri

prompt_tokens

Name	Type	Description	Default
prompt_tokens	integer

total_tokens

Name	Type	Description	Default
total_tokens	integer

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	object

Examples

Example

Belirli bir istem için eklemeleri döndürür.

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

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

Yanıtlar: Durum Kodu: 200

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

Chat completions

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

Sohbet iletisi için tamamlama oluşturur

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Burada Azure OpenAI API anahtarı sağlayın

Request Body

Content-Type: application/json

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

Responses

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	createChatCompletionResponse veya createChatCompletionStreamResponse

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

Content-Type	Type	Description
application/json	errorResponse

Examples

Example

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

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

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

Yanıtlar: Durum Kodu: 200

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

Example

Azure Arama verilerine ve sistem tarafından atanan yönetilen kimliğe göre bir tamamlama oluşturur.

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

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

Yanıtlar: Durum Kodu: 200

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

Example

Azure Arama vektör verilerini, önceki yardımcı iletisini ve kullanıcı tarafından atanan yönetilen kimliği temel alan bir tamamlama oluşturur.

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

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

Yanıtlar: Durum Kodu: 200

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

Example

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

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Yanıtlar: Durum Kodu: 200

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

Transkripsiyonlar - Oluşturma

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

Sesi giriş diline ayırır.

URI Parameters

Name	In	Required	Type	Description
endpoint	path	Yes	string url	OpenAI uç noktaları Azure desteklenir (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	path	Yes	string	Konuşmayı metin modeline dağıtma kimliği. Desteklenen modeller hakkında bilgi için bkz. [/azure/ai-foundry/openai/concepts/models#audio-models].
api-version	query	Yes	string	API version

Request Header

Name	Required	Type	Description
api-key	True	string	Burada Azure OpenAI API anahtarı sağlayın

Request Body

Content-Type: multipart/form-data

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

Responses

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse veya audioVerboseResponse
text/plain	string	Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda).

Examples

Example

Sağlanan konuşulan ses verilerinden dökümü alınmış metinleri ve ilişkili meta verileri alır.

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

Yanıtlar: Durum Kodu: 200

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

Example

Sağlanan konuşulan ses verilerinden dökümü alınmış metinleri ve ilişkili meta verileri alır.

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

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

Yanıtlar: Durum Kodu: 200

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

Çeviriler - Oluşturma

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

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

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Burada Azure OpenAI API anahtarı sağlayın

Request Body

Content-Type: multipart/form-data

Name	Type	Description	Required	Default
file	string	Çevrilecek ses dosyası.	Yes
prompt	string	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır.	No
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	No
temperature	number	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	No	0

Responses

Durum Kodu: 200

Description: OK

Content-Type	Type	Description
application/json	audioResponse veya audioVerboseResponse
text/plain	string	Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda).

Examples

Example

Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri alır.

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

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

Yanıtlar: Durum Kodu: 200

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

Example

Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri alır.

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

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

Yanıtlar: Durum Kodu: 200

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

Image generation

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

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

URI Parameters

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

Request Header

Name	Required	Type	Description
api-key	True	string	Burada Azure OpenAI API anahtarı sağlayın

Request Body

Content-Type: application/json

Name	Type	Description	Required	Default
prompt	string	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Yes
n	integer	Oluşturulacak görüntü sayısı.	No	1
size	imageSize	Oluşturulan görüntülerin boyutu.	No	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	No	url
user	string	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	No
quality	imageQuality	Oluşturulacak görüntünün kalitesi.	No	standard
style	imageStyle	Oluşturulan görüntülerin stili.	No	vivid

Responses

Durum Kodu: 200

Description: Ok

Content-Type	Type	Description
application/json	generateImagesResponse

Durum Kodu: varsayılan

Açıklama: Bir hata oluştu.

Content-Type	Type	Description
application/json	dalleErrorResponse

Examples

Example

İstendiğinde görüntüler oluşturur.

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

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

Yanıtlar: Durum Kodu: 200

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

Components

errorResponse

Name	Type	Description	Required	Default
error	error		No

errorBase

Name	Type	Description	Required	Default
code	string		No
message	string		No

error

Name	Type	Description	Required
param	string		No
type	string		No
inner_error	innerError	Ek ayrıntılar içeren iç hata.	No

innerError

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

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

innerErrorCode

İç hata nesnesi için hata kodları.

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

Type: string

Default:

Enum Adı: InnerErrorCode

Enum Values:

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

dalleErrorResponse

Name	Type	Description	Required	Default
error	dalleError		No

dalleError

Name	Type	Description	Required
param	string		No
type	string		No
inner_error	dalleInnerError	Ek ayrıntılar içeren iç hata.	No

dalleInnerError

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

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

contentFilterResultBase

Name	Type	Description	Required	Default
filtered	boolean		Yes

contentFilterSeverityResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
severity	string		No

contentFilterDetectedResult

Name	Type	Description	Required	Default
filtered	boolean		Yes
detected	boolean		No

contentFilterDetectedWithCitationResult

Name	Type	Description	Required	Default
citation	object		No

Alıntı özellikleri

URL

Name	Type	Description	Default
URL	string

license

Name	Type	Description	Default
license	string

contentFilterResultsBase

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

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

contentFilterPromptResults

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

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

contentFilterChoiceResults

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

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

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

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

dalleFilterResults

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

chatCompletionsRequestCommon

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

createCompletionRequest

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

createCompletionResponse

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

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

createChatCompletionRequest

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

chatCompletionFunctions

Name	Type	Description	Required
description	string	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	No
name	string	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Yes
parameters	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	No

chatCompletionFunctionCallOption

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

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

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

Name	Type	Description	Required
content	dize veya dizi	Sistem iletisinin içeriği.	Yes
role	enum	İleti yazarının rolü( bu örnekte `system`). Olası değerler: sistem	Yes
name	string	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	No

chatCompletionRequestUserMessage

Name	Type	Description	Required
content	dize veya dizi	Kullanıcı iletisinin içeriği.	Yes
role	enum	İleti yazarının rolü( bu örnekte `user`). Olası değerler: kullanıcı	Yes
name	string	Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar.	No

chatCompletionRequestAssistantMessage

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

function_call özellikleri

arguments

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

name

Name	Type	Description	Default
name	string	Çağrılacak işlevin adı.

chatCompletionRequestToolMessage

Name	Type	Description	Required
role	enum	İleti yazarının rolü( bu örnekte `tool`). Olası değerler: araç	Yes
content	dize veya dizi	Araç iletisinin içeriği.	Yes
tool_call_id	string	Bu iletinin yanıt verdiği araç çağrısı.	Yes

chatCompletionRequestFunctionMessage

Name	Type	Description	Required
role	enum	İleti yazarının rolü( bu örnekte `function`). Olası değerler: işlev	Yes
content	string	İşlev iletisinin içeriği.	Yes
name	string	Çağrılacak işlevin adı.	Yes

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartImage

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

image_url özellikleri

url

Name	Type	Description	Default
url	string	Görüntünün URL'si veya base64 kodlanmış görüntü verileri.

detail

Name	Type	Description	Default
detail	string	Görüntünün ayrıntı düzeyini belirtir. Görüntü İşleme kılavuzunda daha fazla bilgi edinin.	auto

chatCompletionRequestMessageContentPartRefusal

Name	Type	Description	Required	Default
type	enum	İçerik bölümünün türü. Olası değerler: reddetme	Yes
refusal	string	Model tarafından oluşturulan reddetme iletisi.	Yes

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

Type: string

Default:

Sabit Listesi Adı: AzureChatExtensionType

Enum Values:

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

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

Name	Type	Description	Required
authentication	onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	No
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	No
strictness	integer	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	No
role_information	string	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	No
endpoint	string	Kullanılacak Azure Arama kaynağının mutlak uç nokta yolu.	Yes
index_name	string	Başvuruda bulunulan Azure Arama kaynağında kullanılabilir olarak kullanılacak dizinin adı.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Yapılandırılmış bir Azure Arama kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	No
query_type	azureSearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Arama alma sorgusunun türü.	No
semantic_configuration	string	Sorgu için ek anlamsal yapılandırma.	No
filter	string	Search filter.	No
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Type: string

Default:

Sabit Listesi Adı: AzureSearchQueryType

Enum Values:

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

azureCosmosDBChatExtensionConfiguration

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

Name	Type	Description	Required	Default
type	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Yes
parameters	azureCosmosDBChatExtensionParameters	için Azure Cosmos DB kullanırken Verinizde OpenAI Azure sohbet uzantılarını yapılandırırken kullanılacak parametreler MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

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

Name	Type	Description	Required
authentication	onYourDataConnectionStringAuthenticationOptions	bağlantı dizesi kullanırken Verilerinizde OpenAI Azure için kimlik doğrulama seçenekleri.	Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	No
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	No
strictness	integer	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	No
role_information	string	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	No
database_name	string	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı.	Yes
container_name	string	Azure Cosmos DB kaynak kapsayıcısının adı.	Yes
index_name	string	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı.	Yes
fields_mapping	azureCosmosDBFieldMappingOptions	Yapılandırılmış Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Yes

azureCosmosDBFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

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

onYourDataAuthenticationType

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

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

Type: string

Default:

Sabit Listesi Adı: OnYourDataAuthenticationType

Enum Values:

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

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataVectorizationSource

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

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vector search.	Yes

onYourDataVectorizationSourceType

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

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

Type: string

Default:

Sabit Listesi Adı: OnYourDataVectorizationSourceType

Enum Values:

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

onYourDataDeploymentNameVectorizationSource

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

Name	Type	Description	Required	Default
type	onYourDataVectorizationSourceType	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vector search.	Yes
deployment_name	string	Vektörleştirme için kullanılacak model dağıtımının adını belirtir. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu model dağıtımını özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı aracılığıyla kullanır.	No

onYourDataEndpointVectorizationSource

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

Name	Type	Description	Required
type	onYourDataVectorizationSourceType	Verilerinizde OpenAI Azure ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kullanılabilir kaynakları temsil eder vector search.	Yes
authentication	onYourDataApiKeyAuthenticationOptions	API anahtarı kullanırken Verilerinizde OpenAI Azure 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ıdır, ancak Verilerinizde bu uç nokta özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı aracılığıyla kullanılır.	No

azureChatExtensionsMessageContext

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

Name	Type	Description	Required	Default
citations	array	Yanıtta yardımcı iletisini oluşturmak için kullanılan veri kaynağı alma sonucu.	No
intent	string	Bağlamı taşımak için bir sonraki dönüşe geçmek için kullanılan sohbet geçmişinden algılanan amaç.	No

citation

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

Name	Type	Description	Required
content	string	Alıntının içeriği.	Yes
title	string	Alıntının başlığı.	No
url	string	Alıntının URL'si.	No
filepath	string	Alıntının dosya yolu.	No
chunk_id	string	Alıntının öbek kimliği.	No

chatCompletionMessageToolCall

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

İşlevin özellikleri

name

Name	Type	Description	Default
name	string	Çağrılacak işlevin adı.

arguments

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

toolCallType

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

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

Type: string

Default:

Sabit Listesi Adı: ToolCallType

Enum Values:

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

chatCompletionRequestMessageTool

Name	Type	Description	Required	Default
tool_call_id	string	Bu iletinin yanıt verdiği araç çağrısı.	No
content	string	İletinin içeriği.	No

chatCompletionRequestMessageFunction

Name	Type	Description	Required
role	enum	İleti yazarının rolü( bu örnekte `function`). Olası değerler: işlev	No
name	string	İletinin içeriği.	No
content	string	İletinin içeriği.	No

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

Name	Type	Description	Required
content	string	Öbek iletisinin içeriği.	No
function_call	object	kullanım dışı bırakıldı ve tarafından `tool_calls`değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri.	No
tool_calls	array		No
role	enum	Bu iletinin yazarının rolü. Olası değerler: sistem, kullanıcı, yardımcı, araç	No
refusal	string	Model tarafından oluşturulan reddetme iletisi.	No

function_call özellikleri

arguments

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

name

Name	Type	Description	Default
name	string	Çağrılacak işlevin adı.

chatCompletionMessageToolCallChunk

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

İşlevin özellikleri

name

Name	Type	Description	Default
name	string	Çağrılacak işlevin adı.

arguments

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

chatCompletionStreamOptions

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

Name	Type	Description	Required	Default
include_usage	boolean	Ayarlanırsa, iletiden önce `data: [DONE]` ek bir öbek akışı oluşturulur. `usage` Bu öbek üzerindeki alan, isteğin tamamı için belirteç kullanım istatistiklerini gösterir ve `choices` alan her zaman boş bir dizi olur. Diğer tüm öbekler de null değer içeren bir `usage` alan içerir.	No

chatCompletionChoiceLogProbs

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

Name	Type	Description	Required	Default
content	array	Günlük olasılık bilgilerini içeren ileti içerik belirteçlerinin listesi.	Yes
refusal	array	Günlük olasılık bilgilerini içeren ileti reddetme belirteçlerinin listesi.	No

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

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

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

Type: string

Default:

Enum Values:

assistant

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

Name	Type	Description	Required	Default
type	enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	Yes
function	object		Yes

İşlevin özellikleri

name

Name	Type	Description	Default
name	string	Çağrılacak işlevin adı.

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

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

completionUsage

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

Name	Type	Description	Required
prompt_tokens	integer	İstemdeki belirteç sayısı.	Yes
completion_tokens	integer	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Yes
total_tokens	integer	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Yes
completion_tokens_details	object	Tamamlanmada kullanılan belirteçlerin dökümü.	No

completion_tokens_details özellikleri

reasoning_tokens

Name	Type	Description	Default
reasoning_tokens	integer	Model tarafından mantık yürütme için oluşturulan belirteçler.

chatCompletionTool

Name	Type	Description	Required	Default
type	enum	Aracın türü. Şu anda yalnızca `function` desteklenmektedir. Olası değerler: işlev	Yes
function	FunctionObject		Yes

FunctionParameters

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

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

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

FunctionObject

Name	Type	Description	Required	Default
description	string	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.	No
name	string	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Yes
parameters	FunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama `parameters` , boş parametre listesi olan bir işlevi tanımlar.	No
strict	boolean	İşlev çağrısı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model alanda tanımlanan şemayı `parameters` tam olarak izler. olduğunda `stricttrue`JSON Şemasının yalnızca bir alt kümesi desteklenir.	No	False

ResponseFormatText

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

ResponseFormatJsonObject

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

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

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

json_schema özellikleri

description

Name	Type	Description	Default
description	string	Yanıt biçiminin ne için olduğuna ilişkin bir açıklama, model tarafından biçimde nasıl yanıt verileceğini belirlemek için kullanılır.

name

Name	Type	Description	Default
name	string	Yanıt biçiminin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.

schema

Name	Type	Description	Default
schema	ResponseFormatJsonSchemaSchema	JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması.

strict

Name	Type	Description	Default
strict	boolean	Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman alanda tanımlanan tam şemayı `schema` izler. olduğunda `stricttrue`JSON Şemasının yalnızca bir alt kümesi desteklenir.	False

chatCompletionChoiceCommon

Name	Type	Description	Required	Default
index	integer		No
finish_reason	string		No

createTranslationRequest

Translation request.

Name	Type	Description	Required	Default
file	string	Çevrilecek ses dosyası.	Yes
prompt	string	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır.	No
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	No
temperature	number	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	No	0

audioResponse

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

Name	Type	Description	Required	Default
text	string	Çevrilmiş veya dökümü alınmış metin.	Yes

audioVerboseResponse

response_format verbose_json çeviri veya transkripsiyon yanıtı

Name	Type	Description	Required
text	string	Çevrilmiş veya dökümü alınmış metin.	Yes
task	string	Ses görevinin türü.	No
language	string	Language.	No
duration	number	Duration.	No
segments	array		No

audioResponseFormat

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

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

Type: string

Default:

Enum Values:

json
text
srt
verbose_json
vtt

createTranscriptionRequest

Transcription request.

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

audioSegment

Transkripsiyon veya çeviri segmenti.

Name	Type	Description	Required
id	integer	Segment identifier.	No
seek	number	Segmentin uzaklığı.	No
start	number	Segment başlangıç uzaklığı.	No
end	number	Segment sonu uzaklığı.	No
text	string	Segment text.	No
tokens	array	Metnin belirteçleri.	No
temperature	number	Temperature.	No
avg_logprob	number	Ortalama günlük olasılığı.	No
compression_ratio	number	Compression ratio.	No
no_speech_prob	number	olasılığı `no speech`.	No

imageQuality

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

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

Type: string

Default: standard

Sabit Listesi Adı: Kalite

Enum Values:

Value	Description
standard	Standart kalite, standart kalitede görüntüler oluşturur.
hd	HD kalitesi, görüntü genelinde daha ayrıntılı ve daha tutarlı görüntüler oluşturur.

imagesResponseFormat

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

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

Type: string

Default: url

Sabit Listesi Adı: ImagesResponseFormat

Enum Values:

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

imageSize

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

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

Type: string

Default: 1024x1024

Sabit Listesi Adı: Boyut

Enum Values:

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

imageStyle

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

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

Type: string

Default: vivid

Sabit Listesi Adı: Stil

Enum Values:

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

imageGenerationsRequest

Name	Type	Description	Required	Default
prompt	string	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir.	Yes
n	integer	Oluşturulacak görüntü sayısı.	No	1
size	imageSize	Oluşturulan görüntülerin boyutu.	No	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	No	url
user	string	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	No
quality	imageQuality	Oluşturulacak görüntünün kalitesi.	No	standard
style	imageStyle	Oluşturulan görüntülerin stili.	No	vivid

generateImagesResponse

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

imageResult

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

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

Completions extensions

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

Chatmessage

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

Metin okuma (Önizleme)

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

Next steps

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

Geri Bildirim

Bu sayfayı yararlı buldunuz mu?

Last updated on 2026-04-30