Aracılığıyla paylaş

Azure OpenAI Azure AI Foundry Modellerinde REST API önizleme referansı

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

API belirtimleri

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

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

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

Önemli

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

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

Kimlik doğrulama

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

  • API Anahtarı kimlik doğrulaması: Bu kimlik doğrulaması türü için tüm API istekleri HTTP üst bilgisinde api-key API Anahtarını içermelidir. Hızlı Başlangıç, bu kimlik doğrulaması türüyle çağrı yapma konusunda rehberlik sağlar.

  • Microsoft Entra Id kimlik doğrulaması: Microsoft Entra belirtecini kullanarak API çağrısının kimliğini doğrulayabilirsiniz. Kimlik doğrulama belirteçleri bir isteğe üst bilgi olarak Authorization eklenir. Sağlanan belirtecin önünde Bearer, örneğin Bearer YOUR_AUTH_TOKENolmalıdır. Microsoft Entra Id ile kimlik doğrulamasıyla ilgili nasıl yapılır kılavuzumuzu okuyabilirsiniz.

REST API sürümü oluşturma

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

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

Veri düzlemi çıkarımı

Makalenin geri kalanında Azure OpenAI veri düzlemi çıkarım belirtiminin önizleme sürümü yer alır 2025-04-01-preview .

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

Tamamlamalar - Oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
en iyi tamsayı Tamamlamaları best_of sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz.

ile nbest_of kullanıldığında, aday tamamlamalarının sayısını denetler ve n ââ'¬â€œ best_of değerinin değerinden nbüyük olması gerektiğini belirtir.

Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokensiçin stop makul ayarlara sahip olduğunuzdan emin olun.		 Hayı 1
yankı Boolean Tamamlamaya ek olarak istemi geri yankıla Hayı Yanlış
frekans cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak. Hayı 0
logit önyargısı 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 nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.

Örneğin, |endoftext|{"50256": -100} belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz>.		 Hayı Hiç kimse
logprobs tamsayı Günlük olasılıklarını logprobs en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise logprobs , API en olası 5 belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür logprob , bu nedenle yanıtta en logprobs+1 fazla öğe olabilir.

için logprobs en büyük değer 5'tir.		 Hayı Hiç kimse
maksimum_token tamsayı Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı.

İsteminizin ve artı max_tokens değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz.		 Hayı 16
n tamsayı Her istem için kaç tamamlama oluşturulacağı.

Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokensiçin stop makul ayarlara sahip olduğunuzdan emin olun.		 Hayı 1
varlık cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır. Hayı 0
Uyarı dize veya dizi Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi.

|endoftext|< öğesinin>, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur.		 Evet
tohum tamsayı Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.

Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.		 Hayı
durmak dize veya dizi API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi. Döndürülen metin durdurma sırasını içermez. Hayı
yayın akışı Boolean Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. Örnek Python kodu.
 Hayı Yanlış
sonek String Eklenen metnin tamamlanmasından sonra gelen sonek.

Bu parametre yalnızca için gpt-3.5-turbo-instructdesteklenir.
 Hayı Hiç kimse
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.

Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.
 Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

Yanıtlar: Durum Kodu: 200

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

Eklemeler - Oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

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

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String Dağıtılan modelin dağıtım kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Sohbet tamamlamaları - Oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Sohbet iletisi için tamamlama oluşturur

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
ses object Ses çıkışı parametreleri. ile modalities: ["audio"]ses çıkışı istendiğinde gereklidir. Hayı
└─ biçimi enum Çıkış ses biçimini belirtir. wav, mp3, flac, opus veya pcm16'den biri olmalıdır.

Olası değerler: wav, mp3, flac, opus, pcm16		 Hayı
└─ ses enum Ses türünü belirtir. Desteklenen sesler : alloy, echo, fable, onyx, novave shimmer.

Olası değerler: alloy, echo, fable, onyx, , nova, shimmer		 Hayı
veri kaynakları array Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri.
Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.		 Hayı
frekans cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.
 Hayı 0
fonksiyon çağrısı string veya chatCompletionFunctionCallOption yerine tool_choicekullanım dışı bırakıldı.

Model tarafından çağrılan (varsa) işlevi denetler.
none modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir.
aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.

none , hiçbir işlev mevcut olmadığında varsayılan değerdir. auto , işlevler varsa varsayılan değerdir.
 Hayı
fonksiyonlar array yerine toolskullanım dışı bırakıldı.

Modelin JSON girişleri oluşturabileceği işlevlerin listesi.
 Hayı
logit önyargısı object Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin.

Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.
 Hayı Hiç kimse
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 contentmessageher çıkış belirtecinin günlük olasılıklarını döndürür. Hayı Yanlış
maksimum_tamamlama_tokenları tamsayı Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır. Bu yalnızca o1 serisi modellerde desteklenir. Gelecek API sürümünde desteği diğer modellere genişletecektir. Hayı
maksimum_token tamsayı Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı.

Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır.		 Hayı
iletiler array Şu ana kadarki konuşmayı içeren iletilerin listesi. Örnek Python kodu. Evet
meta veriler object Depolanan tamamlamalar panosunda tamamlamaları filtrelemek için kullanılan geliştirici tanımlı etiketler ve değerler. Hayı
kalıcılıklar ChatCompletionModalities Modelin bu istek için oluşturmasını istediğiniz çıkış türleri.
Çoğu model, varsayılan olan metin oluşturabilir:

["text"]

Model gpt-4o-audio-preview ses oluşturmak için de kullanılabilir. Bu modelin hem metin hem de ses yanıtları oluşturmasını istemek için şunları kullanabilirsiniz:

["text", "audio"]
 Hayı
n tamsayı Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceğini unutmayın. Maliyetleri en aza indirmek için farklı n tutun1. Hayı 1
paralel araç çağrıları ParallelToolCalls Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. Hayı Doğru
tahmin PredictionContent Model yanıtının büyük bölümlerinin önceden bilindiği yanıt sürelerini büyük ölçüde geliştirebilen Tahmin Edilen Çıktı yapılandırması. Bu en yaygın olarak, içeriğin çoğunda yalnızca küçük değişiklikler içeren bir dosyayı yeniden oluştururken görülür. Hayı
varlık cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.
 Hayı 0
akıl yürütme çabası enum Yalnızca o1 modelleri

Mantıp modelleri için mantık yürütme çabasını kısıtlar.

Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.
Olası değerler: low, medium, high		 Hayı
yanıt formatı ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o

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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.
 Hayı
tohum tamsayı Bu özellik Beta sürümündedir.
Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.
Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.
 Hayı
durmak dize veya dizi API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi.
 Hayı
eklemesini iste Boolean Bu sohbet tamamlama isteğinin çıkışını model damıtma veya değerlendirme ürünlerimizde kullanmak üzere depolamak isteyip istemediğiniz. Hayı
yayın akışı Boolean Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. Örnek Python kodu.
 Hayı Yanlış
akış_seçenekleri chatCompletionStreamOptions Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.
 Hayı Hiç kimse
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.

Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
araç seçimi chatCompletionToolChoiceOption Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla {"type": "function", "function": {"name": "my_function"}} belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar. none hiçbir araç mevcut olmadığında varsayılan değerdir. auto araçlar varsa varsayılan değerdir. Hayı
araçlar 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.
 Hayı
top_logprobs tamsayı Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı. logprobs bu parametre kullanılıyorsa olarak ayarlanmalıdır true . Hayı
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.
 Hayı
kullanıcı güvenlik bağlamı userSecurityContext Kullanıcı güvenlik bağlamı, yapay zeka uygulamasının kendisini ve yapay zeka uygulamasıyla etkileşim kuran son kullanıcıyı tanımlayan çeşitli parametreler içerir. Bu alanlar, yapay zeka uygulamalarınızı korumaya yönelik kapsamlı bir yaklaşım sağlayarak güvenlik operasyonları ekiplerinizin güvenlik olaylarını araştırmalarına ve azaltmalarına yardımcı olur. Bulut için Microsoft Defender kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin. Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Yanıtlar: Durum Kodu: 200

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

Örnek

Azure Search verilerini ve sistem tarafından atanan yönetilen kimliği temel alan bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Yanıtlar: Durum Kodu: 200

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

Örnek

Azure Search görüntü vektör verilerini temel alan bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

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."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

Azure Search vektör verilerine, önceki yardımcı iletisine ve kullanıcı tarafından atanan yönetilen kimliğe göre bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Yanıtlar: Durum Kodu: 200

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

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "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
    }
  }
}

Örnek

Sağlanan Elasticsearch için bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

Yanıtlar: Durum Kodu: 200

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

Örnek

Sağlanan Pinecone kaynağı için bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

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=2025-04-01-preview

Sesi giriş diline ayırır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

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

İsim Türü Açıklama Gerekli Varsayılan
dosya String Dökümü yapılan ses dosyası nesnesi. Evet
dil String Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır. Hayı
Uyarı String Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir. Hayı
yanıt formatı audioResponseFormat Çıkışın biçimini tanımlar. Hayı
sıcaklık Numara Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır. Hayı 0
zaman damgası ayrıntılılıkları[] array Bu transkripsiyon için doldurulacak zaman damgası tanecikleri. response_format zaman damgası taneciklerini kullanacak şekilde ayarlanmalıdır verbose_json . Bu seçeneklerden biri veya her ikisi de desteklenir: word, veya segment. Not: Segment zaman damgaları için ek gecikme süresi yoktur, ancak sözcük zaman damgaları oluşturmak ek gecikmeye neden olur. Hayı ['bölüm']

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü Türü Açıklama
uygulama/json object
düz metin String Çıkış formatı text, vtt veya srt olduğunda dökümü alınmış metin.

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

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

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---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=2025-04-01-preview

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

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

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

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

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

Yanıtlar: Durum Kodu: 200

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

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

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

Konuşma - Oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Giriş metninden ses oluşturur.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

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

İsim Türü Açıklama Gerekli Varsayılan
girdi String Ses sentezi için metin. Uzunluk üst sınırı 4096 karakterdir. Evet
yanıt formatı enum Sesi sentezlemek için biçim.
Olası değerler: mp3, opus, aac, flac, , wav, pcm		 Hayı
Hız Numara Sentezlenen sesin hızı. 'den 0.25 değerine 4.0bir değer seçin. 1.0 varsayılan değerdir. Hayı 1.0
ses enum Konuşma sentezi için kullanılacak ses.
Olası değerler: alloy, echo, fable, onyx, , nova, shimmer		 Evet

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü Türü Açıklama
application/octet-stream String

Örnekler

Örnek

Sağlanan metinden ses sentezler.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Yanıtlar: Durum Kodu: 200

{
  "body": "101010101"
}

Görüntü nesilleri - Oluşturma

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Belirli bir DALLE veya gpt-image-1 model dağıtımındaki bir metin başlığından toplu görüntüler oluşturur

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
arka plan imageBackground Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1 için desteklenir. Hayı Otomatik
n tamsayı Oluşturulacak görüntü sayısı. dall-e-3 için yalnızca n=1 desteklenir. Hayı 1
çıktı sıkıştırma tamsayı Oluşturulan görüntüler için sıkıştırma düzeyi (0-100%). Bu parametre yalnızca jpeg çıkış biçimine sahip gpt-image-1 için desteklenir. Hayı 100
çıkış formatı imagesOutputFormat Oluşturulan görüntülerin döndürüldiği dosya biçimi. Yalnızca gpt-image-1 için desteklenir. Hayı png
Uyarı String İstenen resimlerin metin açıklaması. Maksimum uzunluk gpt-image-1 için 32000 karakter ve dall-e-3 için 4000 karakterdir Evet
nitelik imageQuality Oluşturulacak görüntünün kalitesi. Hayı Otomatik
yanıt formatı imagesResponseFormat Oluşturulan görüntülerin döndürüldiği biçim. Hayı URL
boyut imageSize Oluşturulan görüntülerin boyutu. Hayı Otomatik
stil imageStyle Oluşturulan görüntülerin stili. Yalnızca dall-e-3 için desteklenir. Hayı Canlı
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Bir hata oluştu.

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "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
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Görüntü oluşturma - Düzenle

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Verilen gpt-image-1 model dağıtımındaki bir metin yazısından görüntü düzenler

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id (yenileme kimliği) yol Evet String
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

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

İsim Türü Açıklama Gerekli Varsayılan
resim dize veya dizi Düzenleyebileceğiniz görüntüler. Desteklenen bir görüntü dosyası veya görüntü dizisi olmalıdır. Her resim 25 MB'tan küçük bir png veya jpg dosyası olmalıdır. Evet
maske String Tamamen saydam alanları (örneğin, alfa sıfır) olan ek bir görüntü, görüntünün nerede düzenlenmesi gerektiğini gösterir. Sağlanan birden çok görüntü varsa, maske ilk görüntüye uygulanır. 4 MB'tan küçük geçerli bir PNG dosyası olmalı ve resimle aynı boyutlara sahip olmalıdır. Hayı
n tamsayı Oluşturulacak görüntü sayısı. Hayı 1
Uyarı String İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 32000 karakterdir. Evet
nitelik imageQuality Oluşturulacak görüntünün kalitesi. Hayı Otomatik
yanıt formatı imagesResponseFormat Oluşturulan görüntülerin döndürüldiği biçim. Hayı URL
boyut imageSize Oluşturulan görüntülerin boyutu. Hayı Otomatik
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Bir hata oluştu.

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

Liste - Yardımcılar

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Yardımcıların listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan düzen ve desc azalan düzen için.
sonra soru Hayı String Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir.
önce soru Hayı String Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo başlayarak 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Yardımcıların listesini döndürür.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Oluşturma - Yardımcı

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Model ve yönergeler içeren bir yardımcı oluşturun.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.
 Hayı
talimatlar String Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 256.000 karakterdir.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Evet
isim String Asistanın adı. Uzunluk üst sınırı 256 karakterdir.
 Hayı
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
araç_kaynakları object Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu yardımcıya bağlı vektör deposu. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
└─ vector depoları array file_ids ile bir vektör deposu oluşturmak ve bu yardımcıya eklemek için bir yardımcı. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
araçlar array Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , code_interpreterveya retrievaltüründe functionolabilir.
 Hayı []
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Model ve yönergeler içeren bir yardımcı oluşturun.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Get - Yardımcı

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Bir yardımcı alır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
asistan_kimlik yol Evet String Alınacak yardımcının kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir yardımcı alır.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Değiştir - Yardımcı

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Bir yardımcıyı değiştirir.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
asistan_kimlik yol Evet String Değiştirilecek yardımcının kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.
 Hayı
talimatlar String Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 32768 karakterdir.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Hayı
isim String Asistanın adı. Uzunluk üst sınırı 256 karakterdir.
 Hayı
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
araç_kaynakları object Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına sunulan code_interpreter dosya kimliklerinin listesini geçersiz kılar. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu yardımcıya bağlı vektör depoyu geçersiz kılar. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
araçlar array Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , code_interpreterveya retrievaltüründe functionolabilir.
 Hayı []
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir yardımcıyı değiştirir.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Sil - Yardımcı

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Bir yardımcıyı silin.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
asistan_kimlik yol Evet String Silinecek yardımcının kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir yardımcıyı siler.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Oluştur - İş Parçacığı

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

bir iş parçacığı oluşturun.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
iletiler array Diziyi başlatacak iletilerin listesi. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
araç_kaynakları object Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.
 Hayı
└─ vector depoları array file_ids ile bir vektör deposu oluşturmak ve bunu bu iş parçacığına eklemek için bir yardımcı. İş parçacığına en fazla 1 vektör deposu eklenebilir.
 Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

bir iş parçacığı oluşturur.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Get - İş Parçacığı

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

bir iş parçacığı alır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Alınacak iş parçacığının kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

bir iş parçacığı alır.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Değiştir - İş Parçacığı

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

bir iş parçacığını değiştirir.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Değiştirilecek iş parçacığının kimliği. metadata Yalnızca değiştirilebilir.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
araç_kaynakları object Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan Dosya Kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.
 Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

bir iş parçacığını değiştirir.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Sil - İş Parçacığı

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

bir iş parçacığını silin.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Silinecek iş parçacığının kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

bir iş parçacığını siler.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Liste - İletiler

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Belirli bir iş parçacığı için iletilerin listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Mesajların ait olduğu iş parçacıklarının kimliği.
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan düzen ve desc azalan düzen için.
sonra soru Hayı String Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir.
önce soru Hayı String Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo başlayarak 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
run_id soru Hayı String İletileri, bunları oluşturan çalıştırma kimliğine göre filtreleyin.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

İletileri Listele

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Oluştur - İleti

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

İleti oluşturun.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Mesaj oluşturulacak iş parçacıklarının kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
Ekleri array İletiye eklenen dosyaların listesi ve bunların eklenmesi gereken araçlar. Hayı
içerik String İletinin içeriği. Evet
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
rol String İletiyi oluşturan varlığın rolü. İzin verilen değerler şunlardır:
- user: İletinin gerçek bir kullanıcı tarafından gönderildiğini gösterir ve çoğu durumda kullanıcı tarafından oluşturulan iletileri temsil etmek için kullanılmalıdır.
- assistant: İletinin yardımcı tarafından oluşturulduğunu gösterir. Yardımcıdan konuşmaya ileti eklemek için bu değeri kullanın.
 Evet

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

İleti oluşturun.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Get - İleti

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

bir ileti alın.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Bu mesajın ait olduğu iş parçacıklarının kimlik numarası.
mesaj_kimliği yol Evet String Alınacak iletinin kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

bir ileti alın.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Değiştir - İleti

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

İletiyi değiştirir.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Bu iletinin ait olduğu iş parçacığının kimliği.
mesaj_kimliği yol Evet String Değiştirileceği iletinin kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

İletiyi değiştirme.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Oluşturma - İş parçacığı ve çalıştırma

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Bir iş parçacığı oluşturun ve tek bir istekte çalıştırın.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
asistan_kimlik String Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği. Evet
talimatlar String Yardımcının varsayılan sistem iletisini geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
maksimum_tamamlama_tokenları tamsayı Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
max_prompt_tokens tamsayı Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Bu çalıştırmayı yürütmek için kullanılacak modellerin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır. Hayı
paralel araç çağrıları ParallelToolCalls Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. Hayı Doğru
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
yayın akışı Boolean ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.
 Hayı
akış_seçenekleri chatCompletionStreamOptions Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.
 Hayı Hiç kimse
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
iplik createThreadRequest Hayı
araç seçimi assistantsApiToolChoiceOption Model tarafından çağrılan aracı (varsa) denetler.
none modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto varsayılan değerdir ve modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
veya gibi {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.
 Hayı
araç_kaynakları object Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu yardımcıya eklenmiş vektör deposunun kimliği. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
araçlar array Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kesme_stratejisi truncationObject Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın. Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir iş parçacığı oluşturun ve tek bir istekte çalıştırın.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Liste - Çalıştırmalar

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

bir iş parçacığına ait çalıştırmaların listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Çalıştırmanın ait olduğu iş parçacığının kimliği.
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan düzen ve desc azalan düzen için.
sonra soru Hayı String Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir.
önce soru Hayı String Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo başlayarak 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

bir iş parçacığına ait çalıştırmaların listesini döndürür.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Oluştur - Çalıştır

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Çalıştırma oluşturun.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Çalıştırılacak iş parçacığının ID'si.
içermek[] soru Hayı array Yanıta eklenecek ek alanların listesi. Şu anda desteklenen tek değer, dosya arama sonucu içeriğini getirmektir step_details.tool_calls[*].file_search.results[*].content .
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
ek talimatlar String Çalıştırma yönergelerinin sonuna ek yönergeler ekler. Bu, diğer yönergeleri geçersiz kılmadan çalıştırma başına davranışı değiştirmek için kullanışlıdır. Hayı
ek_mesajlar array Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler. Hayı
asistan_kimlik String Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği. Evet
talimatlar String Yardımcının varsayılan sistem iletisini geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
maksimum_tamamlama_tokenları tamsayı Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
max_prompt_tokens tamsayı Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Bu çalıştırmayı yürütmek için kullanılacak Modelin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır. Hayı
paralel araç çağrıları ParallelToolCalls Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. Hayı Doğru
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
yayın akışı Boolean ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.
 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
araç seçimi assistantsApiToolChoiceOption Model tarafından çağrılan aracı (varsa) denetler.
none modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto varsayılan değerdir ve modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
veya gibi {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.
 Hayı
araçlar array Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kesme_stratejisi truncationObject Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın. Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Çalıştırma oluşturun.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Al - Çalıştır

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Çalıştırmayı alır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Çalıştırılan iş parçacıklarının kimliği.
run_id yol Evet String Alınacak çalıştırmanın kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Çalıştırmayı alır.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Değiştir - Çalıştır

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Çalıştırmayı değiştirir.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Çalıştırılan iş parçacıklarının kimliği.
run_id yol Evet String Değiştirileceği çalıştırmanın kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Çalıştırmayı değiştirir.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Gönder - Çalıştırılacak Araç Çıkışları

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Bir çalıştırmada status: "requires_action" ve required_action.typesubmit_tool_outputsolduğunda, hepsi tamamlandıktan sonra araç çağrılarından çıkışları göndermek için bu uç nokta kullanılabilir. Tüm çıkışlar tek bir istekte gönderilmelidir.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Bu çalıştırmanın ait olduğu iş parçacıklarının kimliği.
run_id yol Evet String Çalıştırmanın, araç çıktısı gönderimini gerektiren kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
yayın akışı Boolean ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.
 Hayı
araç çıktıları array Çıkışların gönderildiği araçların listesi. Evet

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir çalıştırmada status: "requires_action" ve required_action.typesubmit_tool_outputsolduğunda, hepsi tamamlandıktan sonra araç çağrılarından çıkışları göndermek için bu uç nokta kullanılabilir. Tüm çıkışlar tek bir istekte gönderilmelidir.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

İptal - Çalıştır

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

olan in_progressbir çalıştırmayı iptal eder.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Bu çalıştırmanın ait olduğu iş parçacığının kimliği.
run_id yol Evet String İptal edilen çalıştırmanın kimliği.
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

olan in_progressbir çalıştırmayı iptal eder.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Liste - Çalıştırma Adımları

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Bir çalıştırmaya ait çalıştırma adımlarının listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Çalıştırma ve çalıştırma adımlarının ait olduğu iş parçacığının kimliği.
run_id yol Evet String Çalıştırma adımlarının ait olduğu çalışmanın kimliği.
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan düzen ve desc azalan düzen için.
sonra soru Hayı String Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir.
önce soru Hayı String Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo başlayarak 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
API-sürümü soru Evet String
içermek[] soru Hayı array Yanıta eklenecek ek alanların listesi. Şu anda desteklenen tek değer, dosya arama sonucu içeriğini getirmektir step_details.tool_calls[*].file_search.results[*].content .

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir çalıştırmaya ait çalıştırma adımlarının listesini döndürür.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Get - Çalıştırma Adımı

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Çalıştırma adımlarını alır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id yol Evet String Çalıştırma ve çalıştırma adımının ait olduğu iş parçacığının kimliği.
run_id yol Evet String Çalıştırma adımının bağlı olduğu çalıştırmanın kimliği.
step_id yol Evet String Alınacak işlem adımının kimliği.
içermek[] soru Hayı array Yanıta eklenecek ek alanların listesi. Şu anda desteklenen tek değer, dosya arama sonucu içeriğini getirmektir step_details.tool_calls[*].file_search.results[*].content .
API-sürümü soru Evet String

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Çalıştırma adımlarını alır.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Liste - Vektör Depoları

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Vektör depolarının listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan düzen ve desc azalan düzen için.
sonra soru Hayı String Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir.
önce soru Hayı String Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo başlayarak 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör depolarının listesini döndürür.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Oluşturma - Vektör Deposu

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Vektör deposu oluşturma.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
bölme stratejisi autoChunkingStrategyRequestParam veya staticChunkingStrategyRequestParam Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Yalnızca file_ids boş değilse geçerlidir. Hayı
sona_erdikten_sonra vectorStoreExpirationAfter Vektör deposu için süre sonu ilkesi. Hayı
dosya_kimlikleri array Vektör deposunun kullanması gereken dosya kimliklerinin listesi. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
isim String Vektör deposunun adı. Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu oluşturur.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get - Vektör Deposu

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Bir vektör deposu alır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Erişilecek vektör deposunun ID'si.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir vektör deposu alır.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Değiştir - Vektör Deposu

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Vektör depolarını değiştirir.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Değiştirileceği vektör deposunun kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
sona_erdikten_sonra vectorStoreExpirationAfter Vektör deposu için süre sonu ilkesi. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
isim String Vektör deposunun adı. Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör depolarını değiştirir.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Sil - Vektör Deposu

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Vektör depolarını silme.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Silinecek vektör deposunun kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör depolarını siler.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Liste - Vektör Deposu Dosyaları

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Vektör deposu dosyalarının listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosyaların ait olduğu vektör deposunun kimliği.
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan düzen ve desc azalan düzen için.
sonra soru Hayı String Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir.
önce soru Hayı String Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo başlayarak 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
filtre soru Hayı String
Olası değerler: in_progress, completed, failed, cancelled		 Dosya durumuna göre filtreleyin. in_progress, completed, failed veya cancelled'den biri.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu dosyalarının listesini döndürür.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Oluştur - Vektör Deposu Dosyası

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Vektör deposuna dosya ekleyerek vektör deposu dosyası oluşturun.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosya oluşturulacak vektör deposunun kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
bölme stratejisi chunkingStrategyRequestParam Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Hayı
dosya_kimlik String Vektör deposunun kullanması gereken dosya kimliği. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır. Evet

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposuna dosya ekleyerek vektör deposu dosyası oluşturun.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - Vektör Deposu Dosyası

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Vektör deposu dosyasını alır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosyanın ait olduğu vektör deposunun kimliği.
dosya_kimlik yol Evet String Alınan dosyanın kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu dosyasını alır.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Sil - Vektör Deposu Dosyası

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Vektör deposu dosyasını silin. Bu işlem dosyayı vektör deposundan kaldırır, ancak dosyanın kendisi silinmez. Dosyayı silmek için dosya silme uç noktasını kullanın.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosyanın ait olduğu vektör deposunun kimliği.
dosya_kimlik yol Evet String Silinecek dosyanın kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu dosyasını silin. Bu işlem dosyayı vektör deposundan kaldırır, ancak dosyanın kendisi silinmez. Dosyayı silmek için dosya silme uç noktasını kullanın.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

VektörDepoDosyaÖznitelikleriniGüncelle

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Vektör deposu dosyasındaki öznitelikleri güncelleştirin.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosyanın ait olduğu vektör deposunun kimliği.
dosya_kimlik yol Evet String Öznitelikleri güncelleştirmek için dosyanın kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
öznitelikler VectorStoreFileAttributes Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.
 Evet

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Vektör deposu dosya içeriğini alma

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Bir vektör deposu dosyasının ayrıştırılmış içeriğini alın.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Vektör deposunun kimliği.
dosya_kimlik yol Evet String Vektör deposundaki dosyanın kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Vektör deposunu ara

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Bir sorgu ve dosya öznitelikleri filtresine göre bir vektör deposunda ilgili öbekleri arayın.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Aranacak vektör deposunun kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
filtreler ComparisonFilter veya CompoundFilter Dosya özniteliklerine göre uygulanacak bir filtre. Hayı
maks_sonuç_sayısı tamsayı Döndürülecek en fazla sonuç sayısı. Bu sayı 1 ile 50 (dahil) arasında olmalıdır. Hayı 10
soru dize veya dizi Arama için sorgu dizesi Evet
Sıralama_seçenekleri object Arama için derecelendirme seçenekleri. Hayı
└─ sıralama yapıcı enum
Olası değerler: auto, default-2024-11-15		 Hayı
└─ skor_eşiği Numara Hayı 0
sorguyu yeniden yaz Boolean Vektör araması için doğal dil sorgusunun yeniden yazıp yazılmayacağı. Hayı Yanlış

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Oluştur - Vektör Depolama Dosyası Toplu İşlemi

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Vektör deposu dosyası toplu işlemi oluşturun.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosya Toplu İşlemi oluşturulacak vektör deposunun kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
bölme stratejisi parçalamaStratejisiİstekParametresi Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Hayı
dosya_kimlikleri array Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır. Evet

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu dosyası toplu işlemi oluşturun.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Yanıtlar: Durum Kodu: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get - Vektör Depolama Dosyası Toplu İşlemi

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Vektör deposu dosya toplu işlemini alır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosya toplu işleminin ait olduğu vektör deposunun kimliği.
batch_id yol Evet String Edinilen dosya kümesinin kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu dosya toplu işlemini alır.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

İptal - Vektör Depolama Dosyası Toplu İşlemi

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Vektör deposu dosya toplu işlemini iptal etme. Bu, bu toplu işteki dosyaların işlenmesini mümkün olan en kısa sürede iptal etmeye çalışır.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosya toplu işleminin ait olduğu vektör deposunun kimliği.
batch_id yol Evet String İptal edilecek dosya kümesinin kimliği.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu dosya toplu işlemini iptal etme. Bu, bu toplu işteki dosyaların işlenmesini mümkün olan en kısa sürede iptal etmeye çalışır.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Liste - Vektör Depolama Dosyası Toplu İş Dosyaları

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Toplu işlemdeki vektör deposu dosyalarının listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vektör_depolama_kimliği yol Evet String Dosyaların ait olduğu vektör deposunun kimliği.
batch_id yol Evet String Dosyaların ait olduğu dosya partisinin kimliği.
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 Düzeni nesnelerin zaman damgasına göre created_at sıralayın. asc artan düzen ve desc azalan düzen için.
sonra soru Hayı String Sayfalandırmada kullanılacak bir imleç. after , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız, listenin sonraki sayfasını getirmek için sonraki çağrınız after=obj_foo içerebilir.
önce soru Hayı String Sayfalandırmada kullanılacak bir imleç. before , listedeki yerinizi tanımlayan bir nesne kimliğidir. Örneğin, bir liste isteğinde bulunur ve obj_foo başlayarak 100 nesne alırsanız, listenin önceki sayfasını getirmek için sonraki çağrınız before=obj_foo içerebilir.
filtre soru Hayı String
Olası değerler: in_progress, completed, failed, cancelled		 Dosya durumuna göre filtreleyin. in_progress, completed, failed veya cancelled'den biri.
API-sürümü soru Evet String api sürümü

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör deposu dosyalarının listesini döndürür.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Yanıtlar: Durum Kodu: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Oluştur - Gerçek zamanlı oturum

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Gerçek Zamanlı API ile istemci tarafı uygulamalarında kullanmak üzere kısa ömürlü bir API belirteci oluşturun. Aynı oturum parametreleri kullanılarak session.update istemci olayına göre yapılandırılabilir. Bir oturum nesnesinin yanı sıra Gerçek Zamanlı API için tarayıcı istemcilerinin kimliğini doğrulamak için kullanılabilecek kullanılabilir kısa ömürlü API belirteci içeren bir client_secret anahtarla yanıt verir.

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
giriş_ses_formatı enum Giriş sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
pcm16 için, giriş sesi 24kHz örnekleme hızında, 16 bit PCM, tek kanallı (mono) ve küçük endian bayt düzeninde olmalıdır.

Olası değerler: pcm16, g711_ulaw, g711_alaw		 Hayı
giriş_ses_gürültü_azaltma object Giriş ses gürültüsünü azaltma yapılandırması. Bu, kapatmak için null olarak ayarlanabilir.
Gürültü azaltma, VAD'ye ve modele gönderilmeden önce giriş ses arabelleğine eklenen sesi filtreler.
Sesi filtrelemek, giriş sesinin algısını geliştirerek VAD ve dönüş algılama doğruluğunu (hatalı pozitifleri azaltma) ve model performansını geliştirebilir.
 Hayı
└─ türü enum Gürültü azaltma türü. near_field kulaklık gibi yakın konuşan mikrofonlar için, far_field dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.

Olası değerler: near_field, far_field		 Hayı
giriş_ses_dönüşümü object Giriş ses transkripsiyonu yapılandırması, varsayılan olarak kapalıdır ve kapatılmak için null olarak ayarlanabilir. Giriş ses transkripsiyonu modelde yerel değildir, çünkü model doğrudan ses tüketir. Transkripsiyon Transkripsiyon uç noktası üzerinden eşzamansız olarak çalışır ve modelin tam olarak duyduklarından ziyade giriş ses içeriğine rehberlik etmek için kullanılmalıdır. İstemci isteğe bağlı olarak dili ayarlayabilir ve transkripsiyon isteyebilir, bunlar transkripsiyon hizmetine ek rehberlik sunar.
 Hayı
└─ dili String Giriş sesinin dili. Giriş dilini ISO-639-1 (ör. en) biçiminde sağlamak doğruluğu ve gecikme süresini artırır.
 Hayı
└─ model String Transkripsiyon için kullanılacak model, geçerli seçenekler , gpt-4o-transcribeve gpt-4o-mini-transcribeşeklindedirwhisper-1.
 Hayı
└─ istemi String Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin.
için whisper-1, istem anahtar sözcüklerin listesidir.
Modeller için gpt-4o-transcribe istem, "teknolojiyle ilgili sözcükleri bekleme" gibi bir serbest metin dizesidir.
 Hayı
talimatlar String Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örn. "son derece kısa", "kolay davran", "iyi yanıt örnekleri" ve ses davranışı (örneğin, "hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar.

Sunucunun, bu alan ayarlı değilse kullanılacak varsayılan yönergeleri ayarladığını ve oturumun session.created başındaki olayda görünür olduğunu unutmayın.
 Hayı
Maksimum yanıt çıktı birimleri (max_response_output_tokens) tamsayı veya dize Araç çağrıları dahil olmak üzere tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı. Çıkış belirteçlerini sınırlamak için 1 ile 4096 arasında bir tamsayı veya inf belirli bir model için kullanılabilir en yüksek belirteçleri sağlayın. Varsayılan olarak inf değerini alır.
 Hayı
kalıcılıklar Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.
 Hayı
örnek String Bu oturum için kullanılan dağıtımın adı.
 Hayı
çıkış_ses_formatı enum Çıkış sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
için pcm16çıkış sesi 24kHz hızında örneklendirilir.

Olası değerler: pcm16, g711_ulaw, g711_alaw		 Hayı
sıcaklık Numara [0,6, 1,2] ile sınırlı olan model için örnekleme sıcaklığı. Ses modellerinde en iyi performans için 0,8 sıcaklık önerilir.
 Hayı 0.8
araç seçimi String Modelin araçları seçme şekli. Seçenekler , autonone, requiredveya bir işlev belirtir.
 Hayı Otomatik
araçlar array Modelde kullanılabilen araçlar (işlevler). Hayı
dönüş algılama object Dönüş algılama, ether Server VAD veya Semantik VAD için yapılandırma. Bu, kapatmak için null olarak ayarlanabilir; bu durumda istemci model yanıtını manuel olarak tetiklemelidir.
Sunucu VAD, modelin ses ses düzeyine göre konuşmanın başlangıç ve bitişini algılayıp kullanıcı konuşmasının sonunda yanıt vereceği anlamına gelir.
Anlamsal VAD daha gelişmiştir ve kullanıcının konuşmayı bitirip bitirmediğini anlamsal olarak tahmin etmek için bir dönüş algılama modeli (VAD ile birlikte) kullanır, ardından dinamik olarak bu olasılığa göre bir zaman aşımı ayarlar. Örneğin, kullanıcı sesi uhhm ile kesildiğinde, model dönüşün sona erme olasılığını düşük olarak değerlendirir ve kullanıcının konuşmaya devam etmesi için daha uzun süre bekler. Bu, daha doğal konuşmalar için yararlı olabilir, ancak gecikme süresi daha yüksek olabilir.
 Hayı
└─ yanıt_oluştur Boolean VAD durdurma olayı gerçekleştiğinde otomatik olarak yanıt oluşturulup oluşturulmayacağı.
 Hayı Doğru
└─ isteklilik enum semantic_vad modu için yalnızca kullanılır. Modelin yanıt verme istekliliği. low kullanıcının konuşmaya devam etmesi için daha uzun süre bekler, high daha hızlı yanıt verir. auto varsayılan değerdir ve ile mediumeşdeğerdir.

Olası değerler: low, medium, high, auto		 Hayı
└─ interrupt_response (kesinti_cevabı) Boolean VAD başlatma olayı gerçekleştiğinde, devam eden yanıtların varsayılan konuşmanın (örneğin conversation , öğesinin auto) çıkışıyla otomatik olarak kesintiye uğratılıp kesilmeyeceği.
 Hayı Doğru
└─ ön_ek_yastıklama_ms tamsayı server_vad modu için yalnızca kullanılır. VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden). Varsayılan değer 300ms'tir.
 Hayı
└─ sessizlik_süresi_ms tamsayı server_vad modu için yalnızca kullanılır. Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Varsayılan değer 500ms'tir. Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.
 Hayı
└─ eşik Numara server_vad modu için yalnızca kullanılır. VAD için etkinleştirme eşiği (0,0 - 1,0), bu varsayılan olarak 0,5'tir. Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.
 Hayı
└─ türü enum Dönüş algılama türü.

Olası değerler: server_vad, semantic_vad		 Hayı
ses VoiceIdsShared Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Oturum başarıyla oluşturuldu.

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

Oluşturma - Transkripsiyon GerçekZamanlıOturum

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Gerçek zamanlı transkripsiyonlar için özel olarak Gerçek Zamanlı API ile istemci tarafı uygulamalarında kullanmak üzere kısa ömürlü bir API belirteci oluşturun. Aynı oturum parametreleri kullanılarak transcription_session.update istemci olayına göre yapılandırılabilir. Bir oturum nesnesinin yanı sıra Gerçek Zamanlı API için tarayıcı istemcilerinin kimliğini doğrulamak için kullanılabilecek kullanılabilir kısa ömürlü API belirteci içeren bir client_secret anahtarla yanıt verir.

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
içermek array Transkripsiyona eklenecek öğe kümesi. Geçerli kullanılabilir öğeler şunlardır:
- item.input_audio_transcription.logprobs
 Hayı
giriş_ses_formatı enum Giriş sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
pcm16 için, giriş sesi 24kHz örnekleme hızında, 16 bit PCM, tek kanallı (mono) ve küçük endian bayt düzeninde olmalıdır.

Olası değerler: pcm16, g711_ulaw, g711_alaw		 Hayı
giriş_ses_gürültü_azaltma object Giriş ses gürültüsünü azaltma yapılandırması. Bu, kapatmak için null olarak ayarlanabilir.
Gürültü azaltma, VAD'ye ve modele gönderilmeden önce giriş ses arabelleğine eklenen sesi filtreler.
Sesi filtrelemek, giriş sesinin algısını geliştirerek VAD ve dönüş algılama doğruluğunu (hatalı pozitifleri azaltma) ve model performansını geliştirebilir.
 Hayı
└─ türü enum Gürültü azaltma türü. near_field kulaklık gibi yakın konuşan mikrofonlar için, far_field dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.

Olası değerler: near_field, far_field		 Hayı
giriş_ses_dönüşümü object Giriş ses transkripsiyonu yapılandırması. İstemci isteğe bağlı olarak dili ayarlayabilir ve transkripsiyon isteyebilir, bunlar transkripsiyon hizmetine ek rehberlik sunar.
 Hayı
└─ dili String Giriş sesinin dili. Giriş dilini ISO-639-1 (ör. en) biçiminde sağlamak doğruluğu ve gecikme süresini artırır.
 Hayı
└─ model enum Transkripsiyon için kullanılacak model, geçerli seçenekler , gpt-4o-transcribeve gpt-4o-mini-transcribeşeklindedirwhisper-1.

Olası değerler: gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1		 Hayı
└─ istemi String Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin.
için whisper-1, istem anahtar sözcüklerin listesidir.
Modeller için gpt-4o-transcribe istem, "teknolojiyle ilgili sözcükleri bekleme" gibi bir serbest metin dizesidir.
 Hayı
kalıcılıklar Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.
 Hayı
dönüş algılama object Dönüş algılama, ether Server VAD veya Semantik VAD için yapılandırma. Bu, kapatmak için null olarak ayarlanabilir; bu durumda istemci model yanıtını manuel olarak tetiklemelidir.
Sunucu VAD, modelin ses ses düzeyine göre konuşmanın başlangıç ve bitişini algılayıp kullanıcı konuşmasının sonunda yanıt vereceği anlamına gelir.
Anlamsal VAD daha gelişmiştir ve kullanıcının konuşmayı bitirip bitirmediğini anlamsal olarak tahmin etmek için bir dönüş algılama modeli (VAD ile birlikte) kullanır, ardından dinamik olarak bu olasılığa göre bir zaman aşımı ayarlar. Örneğin, kullanıcı sesi uhhm ile kesildiğinde, model dönüşün sona erme olasılığını düşük olarak değerlendirir ve kullanıcının konuşmaya devam etmesi için daha uzun süre bekler. Bu, daha doğal konuşmalar için yararlı olabilir, ancak gecikme süresi daha yüksek olabilir.
 Hayı
└─ yanıt_oluştur Boolean VAD durdurma olayı gerçekleştiğinde otomatik olarak yanıt oluşturulup oluşturulmayacağı. Transkripsiyon oturumları için kullanılamaz.
 Hayı Doğru
└─ isteklilik enum semantic_vad modu için yalnızca kullanılır. Modelin yanıt verme istekliliği. low kullanıcının konuşmaya devam etmesi için daha uzun süre bekler, high daha hızlı yanıt verir. auto varsayılan değerdir ve ile mediumeşdeğerdir.

Olası değerler: low, medium, high, auto		 Hayı
└─ interrupt_response (kesinti_cevabı) Boolean VAD başlatma olayı gerçekleştiğinde, devam eden yanıtların varsayılan konuşmanın (örneğin conversation , öğesinin auto) çıkışıyla otomatik olarak kesintiye uğratılıp kesilmeyeceği. Transkripsiyon oturumları için kullanılamaz.
 Hayı Doğru
└─ ön_ek_yastıklama_ms tamsayı server_vad modu için yalnızca kullanılır. VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden). Varsayılan değer 300ms'tir.
 Hayı
└─ sessizlik_süresi_ms tamsayı server_vad modu için yalnızca kullanılır. Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Varsayılan değer 500ms'tir. Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.
 Hayı
└─ eşik Numara server_vad modu için yalnızca kullanılır. VAD için etkinleştirme eşiği (0,0 - 1,0), bu varsayılan olarak 0,5'tir. Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.
 Hayı
└─ türü enum Dönüş algılama türü.

Olası değerler: server_vad, semantic_vad		 Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Oturum başarıyla oluşturuldu.

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

Yanıtlar

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Model yanıtı oluşturur.

İstek İçeriği

İçerik Türü: application/json

İsim Türü Açıklama Gerekli Varsayılan
içermek array Hayı
girdi dize veya dizi Model girişleri Evet
talimatlar String Model bağlamında ilk öğe olarak bir sistem (veya geliştirici) iletisi ekler.

ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.
 Hayı
maksimum_çıktı_birimleri tamsayı Görünür çıkış belirteçleri ve konuşma durumu da dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.
 Hayı
paralel araç çağrıları Boolean Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.
 Hayı Doğru
önceki_cevap_id String Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın. Konuşma durumu hakkında daha fazla bilgi edinin.
 Hayı
muhakeme Muhakeme yalnızca o serisi modeller

Mantık modelleri için yapılandırma seçenekleri.
 Hayı
eklemesini iste Boolean Oluşturulan model yanıtının daha sonra API ile alınabilmesi için depolanıp depolanmayacağı.
 Hayı Doğru
yayın akışı Boolean true olarak ayarlanırsa, model yanıt verileri sunucu tarafından gönderilen olaylar kullanılarak oluşturulduğundan istemciye akışla gönderilir.
Daha fazla bilgi için aşağıdaki Akış bölümüne bakın.
 Hayı Yanlış
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. object Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir. Daha fazla bilgi edinin:
- Metin girişleri ve çıkışları
- Şekillendirilmiş Çıktılar		 Hayı
└─ biçimi TextResponseFormatConfiguration Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir.

Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.
 Hayı
araç seçimi ToolChoiceOptions veya ToolChoiceTypes veya ToolChoiceFunction Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.
 Hayı
araçlar array Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz.

Modeli sağlayabileceğiniz iki araç kategorisi şunlardır:

- Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar
modelin özellikleri		 Hayı
Kısaltma enum Model yanıtı için kullanılacak kesme stratejisi.
- auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir.
- disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur.

Olası değerler: auto, disabled		 Hayı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü Türü Açıklama
uygulama/json yanıt
metin/olay akışı responseStreamEvent

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Yanıtlar API'si - giriş öğeleri

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Belirtilen ID numarası ile bir model tepkisi getirir.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
yanıt_kodu yol Evet String Geri alınacak yanıtın kimliği.
içermek soru Hayı array Yanıta eklenecek ek alanlar. include Daha fazla bilgi için yukarıdaki Yanıt oluşturma parametresine bakın.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Yanıtı silme

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Verilen kimlikle bir model yanıtını siler.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
yanıt_kodu yol Evet String Silinecek yanıtın kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

Durum Kodu: 404

Açıklama: Bulunamadı

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Yanıtlar API'si - yanıt öğesi listesi

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Belirli bir yanıt için giriş öğelerinin listesini döndürür.

URI Parametreleri

İsim İçinde Gerekli Türü Açıklama
uç nokta yol Evet dize URL'si Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: https://aoairesource.openai.azure.com. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
yanıt_kodu yol Evet String Giriş öğelerini almak için kullanılacak yanıtın kimliği.
sınır soru Hayı tamsayı Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir.
sipariş/emir soru Hayı String
Olası değerler: asc, desc		 giriş öğelerini döndürme sırası. Varsayılan asc değeridir.
- asc: Giriş öğelerini artan düzende döndürür.
- desc: Giriş öğelerini azalan sırada döndürür.
sonra soru Hayı String Sayfalandırmada kullanılan, sonra öğeleri listelemek için bir öğe kimliği.
önce soru Hayı String Öğeleri daha önce listelemek için sayfalandırmada kullanılan bir öğe kimliği.

İstek Başlığı

Belirteç tabanlı kimlik doğrulaması veya API anahtarı kullanın. Belirteç tabanlı kimlik doğrulamasıyla kimlik doğrulaması önerilir ve daha güvenlidir.

İsim Gerekli Türü Açıklama
İzin Doğru String Örnek: Authorization: Bearer {Azure_OpenAI_Auth_Token}

Azure CLI kullanarak kimlik doğrulama belirteci oluşturmak için: az account get-access-token --resource https://cognitiveservices.azure.com

Tür: oauth2
Yetkilendirme Url'si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
kapsam: https://cognitiveservices.azure.com/.default
API anahtarı Doğru String Azure OpenAI API anahtarını burada sağlayın

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Bileşenler

hataYanıtı

İsim Türü Açıklama Gerekli Varsayılan
hata hata Hayı

errorBase

İsim Türü Açıklama Gerekli Varsayılan
kod String Hayı
mesaj String Hayı

hata

İsim Türü Açıklama Gerekli Varsayılan
iç hata innerError Ek ayrıntılar içeren iç hata. Hayı
param String Hayı
tür String Hayı

iç hata

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

İsim Türü Açıklama Gerekli Varsayılan
kod innerErrorCode İç hata nesnesi için hata kodları. Hayı
içerik_filtreleme_sonuçları 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 engelleme listesi hakkındaki bilgileri de bulabilirsiniz. Hayı

içHataKodu

İç hata nesnesi için hata kodları.

Mülkiyet Değer
Açıklama İç hata nesnesi için hata kodları.
Türü String
Değerler ResponsibleAIPolicyViolation

dalleErrorResponse

İsim Türü Açıklama Gerekli Varsayılan
hata dalleError Hayı

dalleError

İsim Türü Açıklama Gerekli Varsayılan
iç hata dalleInnerError Ek ayrıntılar içeren iç hata. Hayı
param String Hayı
tür String Hayı

dalleInnerError

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

İsim Türü Açıklama Gerekli Varsayılan
kod innerErrorCode İç hata nesnesi için hata kodları. Hayı
içerik_filtreleme_sonuçları 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 engelleme listesi hakkındaki bilgileri de bulabilirsiniz. Hayı
düzeltilmiş_yazı String İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem. Hayı

içerikFiltrelemeTamamlamaMetinAralığı

Oluşturulan tamamlama metni içindeki bir aralığı açıklar. Uzaklık 0, tamamlanma metninin ilk UTF32 kod noktasıdır.

İsim Türü Açıklama Gerekli Varsayılan
tamamlama_bitiş_ofseti tamsayı İlk UTF32 kod noktasının yayılma alanından dışlanan uzaklığı. Bu alan her zaman boş aralıklar için completion_start_offset eşittir. Bu alan, boş olmayan aralıklar için her zaman completion_start_offset'tan daha büyüktür. Evet
tamamlama_başlangıç_ofseti tamsayı Yayılmaya başlayan UTF32 kod noktasının uzaklığı. Evet

içerikFiltreSonucuTabanı

İsim Türü Açıklama Gerekli Varsayılan
Filtre Boolean Evet

içerik filtresi ciddiyet sonucu

İsim Türü Açıklama Gerekli Varsayılan
Filtre Boolean Evet
ciddiyet String Hayı

içerik filtresi algılandı sonucu

İsim Türü Açıklama Gerekli Varsayılan
Algılandı Boolean Hayı
Filtre Boolean Evet

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

İsim Türü Açıklama Gerekli Varsayılan
Alıntı object Hayı
└─ URL String Hayı
└─ lisans String Hayı

içerikFiltresiTespitEdildiTamamlamaMetinAralıklarıSonucu

İsim Türü Açıklama Gerekli Varsayılan
detaylar array Hayı

içerikFiltreKimliğiSonucu

İsim Türü Açıklama Gerekli Varsayılan
Filtre Boolean Evet
kimlik String Hayı

içerik filtre sonuç temeli

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

İsim Türü Açıklama Gerekli Varsayılan
özel engelleme listeleri içerikFiltresiDetaylıSonuçlar filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları. Hayı
hata errorBase Hayı
nefret contentFilterSeverityResult Hayı
Küfür içerik filtresi tespit edilen sonuç Hayı
kendine zarar verme contentFilterSeverityResult Hayı
seksüel contentFilterSeverityResult Hayı
şiddet contentFilterSeverityResult Hayı

içerik filtresi istem sonuçları

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

İsim Türü Açıklama Gerekli Varsayılan
özel engelleme listeleri içerikFiltresiDetaylıSonuçlar filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları. Hayı
hata errorBase Hayı
nefret contentFilterSeverityResult Hayı
dolaylı saldırı içerik filtresi tespit edilen sonuç Hayı
Jailbreak içerik filtresi tespit edilen sonuç Hayı
Küfür içerik filtresi tespit edilen sonuç Hayı
kendine zarar verme contentFilterSeverityResult Hayı
seksüel contentFilterSeverityResult Hayı
şiddet contentFilterSeverityResult Hayı

İçerik Filtre Seçimi Sonuçları

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

İsim Türü Açıklama Gerekli Varsayılan
özel engelleme listeleri içerikFiltresiDetaylıSonuçlar filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları. Hayı
hata errorBase Hayı
nefret contentFilterSeverityResult Hayı
Küfür içerik filtresi tespit edilen sonuç Hayı
korunan_malzeme_kodu içerik Filtresi Algılandı ve Alıntı Sonucu Hayı
korunan_malzeme_metni içerik filtresi tespit edilen sonuç Hayı
kendine zarar verme contentFilterSeverityResult Hayı
seksüel contentFilterSeverityResult Hayı
Temelsiz_malzeme contentFilterAramaTamamlamaMetinAralığıSonucu Hayı
şiddet contentFilterSeverityResult Hayı

içerik filtresi ayrıntılı sonuçlar

filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları.

İsim Türü Açıklama Gerekli Varsayılan
detaylar array Hayı
Filtre Boolean Evet

uyarı filtre sonucu

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

İsim Türü Açıklama Gerekli Varsayılan
içerik_filtreleme_sonuçları 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 engelleme listesi hakkındaki bilgileri de bulabilirsiniz. Hayı
komut_dizini tamsayı Hayı

Sonuçları Filtrele

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

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

dalleİçerikFiltrelemeSonuçları

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

İsim Türü Açıklama Gerekli Varsayılan
nefret contentFilterSeverityResult Hayı
kendine zarar verme contentFilterSeverityResult Hayı
seksüel contentFilterSeverityResult Hayı
şiddet contentFilterSeverityResult Hayı

dalleFiltreSonuçları

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

İsim Türü Açıklama Gerekli Varsayılan
özel engelleme listeleri içerikFiltresiDetaylıSonuçlar filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları. Hayı
nefret contentFilterSeverityResult Hayı
Jailbreak içerik filtresi tespit edilen sonuç Hayı
Küfür içerik filtresi tespit edilen sonuç Hayı
kendine zarar verme contentFilterSeverityResult Hayı
seksüel contentFilterSeverityResult Hayı
şiddet contentFilterSeverityResult Hayı

sohbetTamamlamaİstekOrtak

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

TamamlamaİsteğiOluştur

İsim Türü Açıklama Gerekli Varsayılan
en iyi tamsayı Tamamlamaları best_of sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz.

n ile kullanıldığında, best_of aday tamamlama sayısını kontrol eder ve n döndürülecek sayıyı belirtir. best_of değerinden nbüyük olmalıdır.

Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokensiçin stop makul ayarlara sahip olduğunuzdan emin olun.
 Hayı 1
yankı Boolean Tamamlamaya ek olarak istemi geri yankıla
 Hayı Yanlış
frekans cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.
 Hayı 0
logit önyargısı 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 nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.

Örneğin, |endoftext|{"50256": -100} belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz>.
 Hayı Hiç kimse
logprobs tamsayı Günlük olasılıklarını logprobs en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise logprobs , API en olası 5 belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür logprob , bu nedenle yanıtta en logprobs+1 fazla öğe olabilir.

için logprobs en büyük değer 5'tir.
 Hayı Hiç kimse
maksimum_token tamsayı Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı.

İsteminizin ve artı max_tokens değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz.		 Hayı 16
n tamsayı Her istem için kaç tamamlama oluşturulacağı.

Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokensiçin stop makul ayarlara sahip olduğunuzdan emin olun.
 Hayı 1
varlık cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.
 Hayı 0
Uyarı dize veya dizi Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi.

|endoftext|< öğesinin>, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur.
 Evet
tohum tamsayı Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.

Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.
 Hayı
durmak dize veya dizi API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi. Döndürülen metin durdurma sırasını içermez.
 Hayı
yayın akışı Boolean Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. Örnek Python kodu.
 Hayı Yanlış
sonek String Eklenen metnin tamamlanmasından sonra gelen sonek.

Bu parametre yalnızca için gpt-3.5-turbo-instructdesteklenir.
 Hayı Hiç kimse
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.

Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.
 Hayı

tamamlama cevabı oluştur

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

İsim Türü Açıklama Gerekli Varsayılan
Seçenek array Giriş istemi için modelin oluşturduğu tamamlama seçeneklerinin listesi. Evet
Oluşturulan tamsayı Tamamlanmanın oluşturulduğu Unix zaman damgası (saniye olarak). Evet
kimlik String Tamamlanma için benzersiz bir tanımlayıcı. Evet
örnek String Tamamlanmak için kullanılan model. Evet
object enum Her zaman "text_completion" olan nesne türü
Olası değerler: text_completion		 Evet
sonuçları_filtrele_giriş promptFilterResults İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir. Hayı
sistem parmak izi String Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder.

Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle seed birlikte kullanılabilir.
 Hayı
kullanım tamamlama kullanımı Tamamlanma isteği için kullanım istatistikleri. Hayı

SohbetTamamlanmaTalebiOluştur

İsim Türü Açıklama Gerekli Varsayılan
ses object Ses çıkışı parametreleri. ile modalities: ["audio"]ses çıkışı istendiğinde gereklidir. Hayı
└─ biçimi enum Çıkış ses biçimini belirtir. wav, mp3, flac, opus veya pcm16'den biri olmalıdır.

Olası değerler: wav, mp3, flac, opus, pcm16		 Hayı
└─ ses enum Ses türünü belirtir. Desteklenen sesler : alloy, echo, fable, onyx, novave shimmer.

Olası değerler: alloy, echo, fable, onyx, , nova, shimmer		 Hayı
veri kaynakları array Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri.
Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.		 Hayı
frekans cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.
 Hayı 0
fonksiyon çağrısı string veya chatCompletionFunctionCallOption yerine tool_choicekullanım dışı bırakıldı.

Model tarafından çağrılan (varsa) işlevi denetler.
none modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir.
aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.

none , hiçbir işlev mevcut olmadığında varsayılan değerdir. auto , işlevler varsa varsayılan değerdir.
 Hayı
fonksiyonlar array yerine toolskullanım dışı bırakıldı.

Modelin JSON girişleri oluşturabileceği işlevlerin listesi.
 Hayı
logit önyargısı object Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin.

Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.
 Hayı Hiç kimse
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 contentmessageher çıkış belirtecinin günlük olasılıklarını döndürür. Hayı Yanlış
maksimum_tamamlama_tokenları tamsayı Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır. Bu yalnızca o1 serisi modellerde desteklenir. Gelecek API sürümünde desteği diğer modellere genişletecektir. Hayı
maksimum_token tamsayı Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı.

Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır.		 Hayı
iletiler array Şu ana kadarki konuşmayı içeren iletilerin listesi. Örnek Python kodu. Evet
meta veriler object Depolanan tamamlamalar panosunda tamamlamaları filtrelemek için kullanılan geliştirici tanımlı etiketler ve değerler. Hayı
kalıcılıklar ChatCompletionModalities Modelin bu istek için oluşturmasını istediğiniz çıkış türleri.
Çoğu model, varsayılan olan metin oluşturabilir:

["text"]

Model gpt-4o-audio-preview ses oluşturmak için de kullanılabilir. Bu modelin hem metin hem de ses yanıtları oluşturmasını istemek için şunları kullanabilirsiniz:

["text", "audio"]
 Hayı
n tamsayı Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceğini unutmayın. Maliyetleri en aza indirmek için farklı n tutun1. Hayı 1
paralel araç çağrıları ParallelToolCalls Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. Hayı Doğru
tahmin PredictionContent Model yanıtının büyük bölümlerinin önceden bilindiği yanıt sürelerini büyük ölçüde geliştirebilen Tahmin Edilen Çıktı yapılandırması. Bu en yaygın olarak, içeriğin çoğunda yalnızca küçük değişiklikler içeren bir dosyayı yeniden oluştururken görülür. Hayı
varlık cezası Numara -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.
 Hayı 0
akıl yürütme çabası enum Yalnızca o1 modelleri

Mantıp modelleri için mantık yürütme çabasını kısıtlar.

Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.
Olası değerler: low, medium, high		 Hayı
yanıt formatı ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o

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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.
 Hayı
tohum tamsayı Bu özellik Beta sürümündedir.
Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.
Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.
 Hayı
durmak dize veya dizi API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi.
 Hayı
eklemesini iste Boolean Bu sohbet tamamlama isteğinin çıkışını model damıtma veya değerlendirme ürünlerimizde kullanmak üzere depolamak isteyip istemediğiniz. Hayı
yayın akışı Boolean Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. Örnek Python kodu.
 Hayı Yanlış
akış_seçenekleri chatCompletionStreamOptions Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.
 Hayı Hiç kimse
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.

Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
araç seçimi chatCompletionToolChoiceOption Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir. required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla {"type": "function", "function": {"name": "my_function"}} belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar. none hiçbir araç mevcut olmadığında varsayılan değerdir. auto araçlar varsa varsayılan değerdir. Hayı
araçlar 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.
 Hayı
top_logprobs tamsayı Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı. logprobs bu parametre kullanılıyorsa olarak ayarlanmalıdır true . Hayı
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.
 Hayı
kullanıcı güvenlik bağlamı userSecurityContext Kullanıcı güvenlik bağlamı, yapay zeka uygulamasının kendisini ve yapay zeka uygulamasıyla etkileşim kuran son kullanıcıyı tanımlayan çeşitli parametreler içerir. Bu alanlar, yapay zeka uygulamalarınızı korumaya yönelik kapsamlı bir yaklaşım sağlayarak güvenlik operasyonları ekiplerinizin güvenlik olaylarını araştırmalarına ve azaltmalarına yardımcı olur. Bulut için Microsoft Defender kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin. Hayı

kullanıcıGüvenlikBağlamı

Kullanıcı güvenlik bağlamı, yapay zeka uygulamasının kendisini ve yapay zeka uygulamasıyla etkileşim kuran son kullanıcıyı tanımlayan çeşitli parametreler içerir. Bu alanlar, yapay zeka uygulamalarınızı korumaya yönelik kapsamlı bir yaklaşım sağlayarak güvenlik operasyonları ekiplerinizin güvenlik olaylarını araştırmalarına ve azaltmalarına yardımcı olur. Bulut için Microsoft Defender kullanarak yapay zeka uygulamalarını koruma hakkında daha fazla bilgi edinin.

İsim Türü Açıklama Gerekli Varsayılan
uygulama_adı String Uygulamanın adı. Hassas kişisel bilgiler bu alana dahil edilmemelidir. Hayı
son_kullanıcı_kimliği String Bu tanımlayıcı, oluşturan yapay zeka uygulamasında son kullanıcıların kimliğini doğrulamak için kullanılan Microsoft Entra Id (eski adıYla Azure Active Directory) kullanıcı nesnesi kimliğidir. Hassas kişisel bilgiler bu alana dahil edilmemelidir. Hayı
son_kullanıcı_kiracı_kimliği String Son kullanıcının ait olduğu Microsoft 365 kiracı kimliği. Oluşturan yapay zeka uygulaması çok kiracılı olduğunda gereklidir. Hayı
kaynak_ip String Hem IPv4 hem de IPv6 biçimlerini kabul ederek özgün istemcinin IP adresini yakalar. Hayı

sohbetTamamlamaFonksiyonları

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması. Hayı
isim String Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir. Evet
Parametreler 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.		 Hayı

sohbetTamamlamaFonksiyonÇağrıSeçeneği

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

İsim Türü Açıklama Gerekli Varsayılan
isim String Çağrılacak işlevin adı. Evet

SohbetTamamlamaFonksiyonuParametreleri

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

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

sohbetTamamlamaİstekMesajı

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

SohbetTamamlamaİsteğiGeliştiriciMesajı

Kullanıcı tarafından gönderilen iletilerden bağımsız olarak modelin izlemesi gereken geliştirici tarafından sağlanan yönergeler. o1 modelleri ve daha yenisi ile iletiler önceki developersystem iletilerin yerini alır.

İsim Türü Açıklama Gerekli Varsayılan
içerik dize veya dizi Geliştirici iletisinin içeriği. Evet
isim String Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar. Hayı
rol enum İleti yazarının rolü( bu örnekte developer).
Olası değerler: developer		 Evet

sohbetTamamlamaIstegiSistemMesaji

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

SohbetTamamlamaİsteğiKullanıcıMesajı

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

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

İsim Türü Açıklama Gerekli Varsayılan
içerik dize veya dizi Yardımcı iletisinin içeriği. Veya belirtilmediği sürece tool_callsfunction_call gereklidir.
 Hayı
fonksiyon çağrısı object kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri. Hayı
└─ argümanlar 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 parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. Hayı
└─ ad String Çağrılacak işlevin adı. Hayı
isim String Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar. Hayı
Ret String Asistanın reddetme mesajı. Hayı
rol enum İleti yazarının rolü( bu örnekte assistant).
Olası değerler: assistant		 Evet
araç çağrıları chatCompletionMessageToolCalls Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar. Hayı

sohbetTamamlamaİstekAracıMesajı

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

sohbetTamamlamaİstekFonksiyonMesajı

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

SohbetTamamlamaİsteğiGeliştiriciMesajİçerikKısmı

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

SohbetTamamlamaİstekSistemiMesajİçerikParçası

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

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

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

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

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

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

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

chatTamamlamaİstekMesajİçerikParçaMetin

İsim Türü Açıklama Gerekli Varsayılan
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Metin içeriği. Evet
tür enum İçerik bölümünün türü.
Olası değerler: text		 Evet

sohbetTamamlamaTalebiMesajİçeriğiSesParçası

İsim Türü Açıklama Gerekli Varsayılan
giriş_sesi object Evet
└─ veri String Base64 ile kodlanmış ses verileri. Hayı
└─ biçimi enum Kodlanmış ses verilerinin biçimi. Şu anda "wav" ve "mp3" desteklemektedir.

Olası değerler: wav, mp3		 Hayı
tür enum İçerik bölümünün türü. Her zaman input_audio.
Olası değerler: input_audio		 Evet

İletişimTamamlaTalepMesajİçerikKısımResim

İsim Türü Açıklama Gerekli Varsayılan
image_url object Evet
└─ ayrıntı enum Görüntünün ayrıntı düzeyini belirtir. Görüntü İşleme kılavuzunda daha fazla bilgi edinin.
Olası değerler: auto, low, high		 Hayı
└─ url String Görüntünün URL'si veya base64 kodlanmış görüntü verileri. Hayı
tür enum İçerik bölümünün türü.
Olası değerler: image_url		 Evet

sohbet tamamlaması talebi mesaj içeriği reddi

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

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

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

azureChatExtensionConfiguration için ###Discriminator

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri Şema
azure_search azureSearchChatExtensionConfiguration
azure_cosmos_db azureCosmosDBChatExtensionConfiguration
elasticsearch elasticsearchChatExtensionConfiguration
mongo_db mongoDBChatExtensionConfiguration
pinecone pineconeChatExtensionConfiguration
İsim Türü Açıklama Gerekli Varsayılan
tür azureChatExtensionType Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır.
Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.		 Evet

azureChatEklentiTürü

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.

Mülkiyet Değer
Açıklama Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır.
Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.
Türü String
Değerler azure_search
azure_cosmos_db
elasticsearch
mongo_db
pinecone

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

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

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

azureSearchChatUzantıParametreleri

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

İsim Türü Açıklama Gerekli Varsayılan
kısmi_sonuç_izni_ver Boolean True olarak belirtilirse, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilirse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur. Hayı Yanlış
kimlik doğrulama onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions veya onYourDataAccessTokenAuthenticationOptions Evet
gömülü_bağımlılık onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource veya onYourDataIntegratedVectorizationSource Hayı
uç nokta String Kullanılacak Azure Search kaynağının mutlak uç nokta yolu. Evet
alan eşleştirme AzureAramaDizinAlanEşlemeSeçenekleri Yapılandırılmış bir Azure Search kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar. Hayı
filtre String Arama filtresi. Hayı
kapsam dahilinde Boolean Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. Hayı
bağlamları dahil et array Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve citationsolurintent. Hayı
endeks_adı String Başvuruda bulunulan Azure Search kaynağında kullanılabilir olarak kullanılacak dizinin adı. Evet
maksimum_arama_sorguları tamsayı En fazla yeniden yazılan sorgu sayısı, bir kullanıcı iletisi için arama sağlayıcısına gönderilmelidir. Belirtilmezse, sistem gönderilecek sorgu sayısına karar verir. Hayı
sorgu_tipi azureSearchQueryType Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Search alma sorgusunun türü. Hayı
anlamsal yapılandırma String Sorgu için ek anlamsal yapılandırma. Hayı
katılık tamsayı Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. Hayı
En iyi n belgeleri tamsayı Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. Hayı

azureAramaDizinAlanEşlemeSeçenekleri

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

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

azureAramaSorguTürü

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

Mülkiyet Değer
Açıklama Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Search alma sorgusunun türü.
Türü String
Değerler simple
semantic
vector
vector_simple_hybrid
vector_semantic_hybrid

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

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

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

AzureCosmosDBSohbetUzantısıParametreleri

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

İsim Türü Açıklama Gerekli Varsayılan
kısmi_sonuç_izni_ver Boolean True olarak belirtilirse, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilirse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur. Hayı Yanlış
kimlik doğrulama VeriBağlantıDizesiKimlikDoğrulamaSeçenekleriÜzerinde bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri. Evet
konteyner_adı String Azure Cosmos DB kaynak kapsayıcısının adı. Evet
veritabanı_adı String Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı. Evet
gömülü_bağımlılık onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource Evet
alan eşleştirme azureCosmosDBFieldMappingOptions Yapılandırılmış bir Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar. Evet
kapsam dahilinde Boolean Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. Hayı
bağlamları dahil et array Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve citationsolurintent. Hayı
endeks_adı String Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı. Evet
maksimum_arama_sorguları tamsayı En fazla yeniden yazılan sorgu sayısı, bir kullanıcı iletisi için arama sağlayıcısına gönderilmelidir. Belirtilmezse, sistem gönderilecek sorgu sayısına karar verir. Hayı
katılık tamsayı Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. Hayı
En iyi n belgeleri tamsayı Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. Hayı

Azure Cosmos DB Alan Eşleme Seçenekleri

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

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

Elasticsearch Sohbet Uzantısı Yapılandırması

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

İsim Türü Açıklama Gerekli Varsayılan
Parametreler elasticsearchChatExtensionParameters ElasticsearchÂ'yı® Azure OpenAI sohbet uzantısı olarak yapılandırırken kullanılacak parametreler. Hayı
tür azureChatExtensionType Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır.
Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.		 Evet

ElasticsearchSohbetEklentiParametreleri

ElasticsearchÂ'yı® Azure OpenAI sohbet uzantısı olarak yapılandırırken kullanılacak parametreler.

İsim Türü Açıklama Gerekli Varsayılan
kısmi_sonuç_izni_ver Boolean True olarak belirtilirse, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilirse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur. Hayı Yanlış
kimlik doğrulama onYourDataKeyAndKeyIdAuthenticationOptions veya onYourDataEncodedApiKeyAuthenticationOptions Evet
gömülü_bağımlılık onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource veya onYourDataModelIdVectorizationSource Hayı
uç nokta String ElasticsearchÂ'nın® uç noktası. Evet
alan eşleştirme elasticsearchIndexFieldMappingOptions Yapılandırılmış bir Elasticsearch® kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar. Hayı
kapsam dahilinde Boolean Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. Hayı
bağlamları dahil et array Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve citationsolurintent. Hayı
endeks_adı String ElasticsearchÂ'nın® dizin adı. Evet
maksimum_arama_sorguları tamsayı En fazla yeniden yazılan sorgu sayısı, bir kullanıcı iletisi için arama sağlayıcısına gönderilmelidir. Belirtilmezse, sistem gönderilecek sorgu sayısına karar verir. Hayı
sorgu_tipi elasticsearchQueryType Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Elasticsearch® alma sorgusunun türü. Hayı
katılık tamsayı Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. Hayı
En iyi n belgeleri tamsayı Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. Hayı

ElasticsearchIndexFieldMappingOptions

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

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

ElasticsearchAramaTipi

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

Mülkiyet Değer
Açıklama Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Elasticsearch® alma sorgusunun türü.
Türü String
Değerler simple
vector

MongoDBChatUzantıYapılandırması

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

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

mongoDB Sohbet Uzantısı Parametreleri

Mongo DB kullanırken Verilerinizde Azure OpenAI sohbet uzantılarını yapılandırırken kullanılacak parametreler.

İsim Türü Açıklama Gerekli Varsayılan
kısmi_sonuç_izni_ver Boolean True olarak belirtilirse, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilirse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur. Hayı Yanlış
uygulama_adı String Mongo DB Uygulamasının adı. Evet
kimlik doğrulama onYourDataUsernameAndPasswordAuthenticationOptions - Veri Kullanıcı Adı ve Şifre Kimlik Doğrulama Seçenekleri Kullanıcı adı ve parola kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri. Evet
Koleksiyon_adı String Mongo DB Koleksiyonunun adı. Evet
veritabanı_adı String Mongo DB veritabanının adı. Evet
gömülü_bağımlılık onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource Evet
uç nokta String Mongo DB küme uç noktasının adı. Evet
alan eşleştirme mongoDBFieldMappingOptions Yapılandırılmış bir Mongo DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar. Evet
kapsam dahilinde Boolean Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. Hayı
bağlamları dahil et array Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve citationsolurintent. Hayı
endeks_adı String Mongo DB dizininin adı. Evet
maksimum_arama_sorguları tamsayı En fazla yeniden yazılan sorgu sayısı, bir kullanıcı iletisi için arama sağlayıcısına gönderilmelidir. Belirtilmezse, sistem gönderilecek sorgu sayısına karar verir. Hayı
katılık tamsayı Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. Hayı
En iyi n belgeleri tamsayı Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. Hayı

mongoDB Alan Eşleme Seçenekleri

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

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

pineconeSohbetEklentiYapılandırması

Pinecone'un Azure OpenAI sohbet uzantısı olarak kullanıldığında yapılandırılabilir seçeneklerinin belirli bir gösterimi.

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

pineconeSohbetUzantısıParametreleri

Azure OpenAI Pinecone sohbet uzantılarını yapılandırma parametreleri.

İsim Türü Açıklama Gerekli Varsayılan
kısmi_sonuç_izni_ver Boolean True olarak belirtilirse, sistem kısmi arama sonuçlarının kullanılmasına izin verir ve tüm sorgular başarısız olursa istek başarısız olur. Belirtilmezse veya false olarak belirtilirse, herhangi bir arama sorgusu başarısız olursa istek başarısız olur. Hayı Yanlış
kimlik doğrulama onYourDataApiKeyKimlikDoğrulamaSeçenekleri API anahtarı kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri. Evet
gömülü_bağımlılık VeriDağıtımAdınızVektörleştirmeKaynağı Vektör araması uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve aynı Azure OpenAI kaynağındaki iç ekleme modeli dağıtım adını temel alan bir vektörleştirme kaynağının ayrıntıları. Evet
çevre String Pinecone'un ortam adı. Evet
alan eşleştirme pineconeFieldMappingOptions Yapılandırılmış bir Pinecone kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar. Evet
kapsam dahilinde Boolean Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. Hayı
bağlamları dahil et array Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve citationsolurintent. Hayı
endeks_adı String Pinecone veritabanı dizininin adı. Evet
maksimum_arama_sorguları tamsayı En fazla yeniden yazılan sorgu sayısı, bir kullanıcı iletisi için arama sağlayıcısına gönderilmelidir. Belirtilmezse, sistem gönderilecek sorgu sayısına karar verir. Hayı
katılık tamsayı Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. Hayı
En iyi n belgeleri tamsayı Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. Hayı

ÇamKozalağıAlanEşlemeSeçenekleri

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

İsim Türü Açıklama Gerekli Varsayılan
içerik alanları array İçerik olarak ele alınması gereken dizin alanlarının adları. Evet
içerik_alanları_ayırıcı String İçerik alanlarının kullanması gereken ayırıcı desen. Hayı
Dosya yolu alanı String Dosya yolu olarak kullanılacak dizin alanının adı. Hayı
başlık_alanı String Başlık olarak kullanılacak dizin alanının adı. Hayı
url_alanı String URL olarak kullanılacak dizin alanının adı. Hayı

Veri Kimlik Doğrulama Seçenekleriniz

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

onYourDataAuthenticationOptions için Ayrıştırıcı Özelliği

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri Şema
api_key onYourDataApiKeyKimlikDoğrulamaSeçenekleri
connection_string VeriBağlantıDizesiKimlikDoğrulamaSeçenekleriÜzerinde
key_and_key_id Verinizin Anahtarı ve Anahtar Kimliği Kimlik Doğrulama Seçenekleri
encoded_api_key onYourDataEncodedApiAnahtarDoğrulamaSeçenekleri
access_token VeriErişiminizTokenKimlikDoğrulamaSeçenekleri
system_assigned_managed_identity Sisteminizdeki Atanan Yönetilen Kimlik Doğrulama Seçenekleri
user_assigned_managed_identity VeriKullanıcıAtanmışYönetilenKimlikDoğrulamaSeçenekleri
username_and_password onYourDataUsernameAndPasswordAuthenticationOptions - Veri Kullanıcı Adı ve Şifre Kimlik Doğrulama Seçenekleri
İsim Türü Açıklama Gerekli Varsayılan
tür VeriKimlikDoğrulamaTürünüzÜzerinde Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. Evet

SizinVeriBağlamıÖzelliğinizÜzerinde

Bağlam özelliği.

Mülkiyet Değer
Açıklama Bağlam özelliği.
Türü String
Değerler citations
intent
all_retrieved_documents

Verinizin Kimlik Doğrulama Türü

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

Mülkiyet Değer
Açıklama Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri.
Türü String
Değerler api_key
connection_string
key_and_key_id
encoded_api_key
access_token
system_assigned_managed_identity
user_assigned_managed_identity
username_and_password

VerinizÜzerindeApiAnahtarıKimlikDoğrulamaSeçenekleri

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

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

BağlantıDizinizdekiKimlikDoğrulamaSeçenekleri

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

İsim Türü Açıklama Gerekli Varsayılan
bağlantı_dizesi String Kimlik doğrulaması için kullanılacak bağlantı dizesi. Hayı
tür VeriKimlikDoğrulamaTürünüzÜzerinde Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. Evet

VeriAnahtarıVeAnahtarKimliğiKimlikDoğrulamaSeçenekleriÜzerinde

Elasticsearch anahtarı ve anahtar kimliği çifti kullanılırken Verilerinizde Azure OpenAI kimlik doğrulaması seçenekleri.

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

VerinizÜzerindeKodlanmışApiAnahtarıKimlikDoğrulamaSeçenekleri

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

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

VeriErişimSimgeKimlikDoğrulamaSeçenekleriÜzerinde

Erişim belirteci kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.

İsim Türü Açıklama Gerekli Varsayılan
erişim_token String Kimlik doğrulaması için kullanılacak erişim belirteci. Hayı
tür VeriKimlikDoğrulamaTürünüzÜzerinde Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. Evet

onYourDataSistemAtananYönetilenKimlikDoğrulamaSeçenekleri

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

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

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

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

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

VerilerinizinKullanıcıAdıVeŞifreKimlikDoğrulamaSeçenekleri

Kullanıcı adı ve parola kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.

İsim Türü Açıklama Gerekli Varsayılan
şifre String Parola. ögesini seçin. Hayı
tür VeriKimlikDoğrulamaTürünüzÜzerinde Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. Evet
kullanıcı adı String Kimlik doğrulaması için kullanılacak kullanıcı adı. Hayı

onYourVeriVektörleştirmeKaynağı

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

Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:

Tür Değeri Şema
endpoint VeriUçvektörleştirmeKaynağında
deployment_name VeriDağıtımAdınızVektörleştirmeKaynağı
integrated VeriEntegreVektorizasyonKaynağınızÜzerinde
model_id VeriModelinizIdVektorizasyonKaynağı
İsim Türü Açıklama Gerekli Varsayılan
tür Veri Vektorizasyon Kaynak Tipiniz Üzerinde Verilerinizde Azure OpenAI'nin vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder. Evet

onYourDataVektörleştirmeKaynağıTürü

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

Mülkiyet Değer
Açıklama Verilerinizde Azure OpenAI'nin vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder.
Türü String
Değerler endpoint
deployment_name
integrated
model_id

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

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

İsim Türü Açıklama Gerekli Varsayılan
kimlik doğrulama onYourDataApiKeyAuthenticationOptions veya onYourDataAccessTokenAuthenticationOptions Hayı
boyutlar tamsayı Eklemelerin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde text-embedding-3 desteklenir. Hayı
uç nokta String Eklemelerin alınması gereken kaynak uç noktası URL'sini belirtir. biçiminde https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddingsolmalıdır. Api sürümü sorgu parametresine izin verilmiyor. Hayı
tür Veri Vektorizasyon Kaynak Tipiniz Üzerinde Verilerinizde Azure OpenAI'nin vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder. Evet

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

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

İsim Türü Açıklama Gerekli Varsayılan
dağıtım_adı String Vektörleştirme için kullanılacak model dağıtımının adını belirtir. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu model dağıtımını özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine bir iç çağrı aracılığıyla kullanır. Hayı
boyutlar tamsayı Eklemelerin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde text-embedding-3 desteklenir. Hayı
tür Veri Vektorizasyon Kaynak Tipiniz Üzerinde Verilerinizde Azure OpenAI'nin vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder. Evet

VerinizEntegreVektörleştirmeKaynağı

Arama kaynağı içinde tanımlanan tümleşik vektörleştiriciyi temsil eder.

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

onYourDataModelIdVektorizasyonKaynağı

Vektör araması uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve arama hizmeti modeli kimliğini temel alan vektörleştirme kaynağının ayrıntıları. Şu anda yalnızca Elasticsearch tarafından desteklenmektedir®.

İsim Türü Açıklama Gerekli Varsayılan
model kimliği String Vektörleştirme için kullanılacak model kimliğini belirtir. Bu model kimliği arama hizmetinde tanımlanmalıdır. Hayı
tür Veri Vektorizasyon Kaynak Tipiniz Üzerinde Verilerinizde Azure OpenAI'nin vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder. Evet

azureChatUzantılarıMesajBağlamı

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

İsim Türü Açıklama Gerekli Varsayılan
tüm_alınan_dokümanlar array Alınan tüm belgeler. Hayı
Alıntı array Yanıtta yardımcı iletisini oluşturmak için kullanılan veri kaynağı alma sonucu. Hayı
kasıt String Bağlamı taşımak için bir sonraki dönüşe geçmek için kullanılan sohbet geçmişinden algılanan amaç. Hayı

Alıntı

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

İsim Türü Açıklama Gerekli Varsayılan
chunk_id String Alıntının öbek kimliği. Hayı
içerik String Alıntının içeriği. Evet
dosya yolu String Alıntının dosya yolu. Hayı
yeniden sıralama puanı Numara Alınan belgenin yeniden kırpma puanı. Hayı
başlık String Alıntının başlığı. Hayı
URL String Alıntının URL'si. Hayı

alınan belge

Alınan belge.

İsim Türü Açıklama Gerekli Varsayılan
chunk_id String Alıntının öbek kimliği. Hayı
içerik String Alıntının içeriği. Evet
veri_kaynağı_indeksi tamsayı Veri kaynağının dizini. Hayı
dosya yolu String Alıntının dosya yolu. Hayı
filtre_neden filterReason Alınan belgenin filtreleme nedeni. Hayı
orijinal arama puanı Numara Alınan belgenin özgün arama puanı. Hayı
yeniden sıralama puanı Numara Alınan belgenin yeniden kırpma puanı. Hayı
arama_sorguları array Belgeyi almak için kullanılan arama sorguları. Hayı
başlık String Alıntının başlığı. Hayı
URL String Alıntının URL'si. Hayı

filtreNedeni

Alınan belgenin filtreleme nedeni.

Mülkiyet Değer
Açıklama Alınan belgenin filtreleme nedeni.
Türü String
Değerler score
rerank

SohbetTamamlamaMesajAracıÇağrısı

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object Modelin çağırdığını işlev. Evet
└─ argümanlar 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 parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. Hayı
└─ ad String Çağrılacak işlevin adı. Hayı
kimlik String Araç çağrısının kimliği. Evet
tür toolCallType Bu durumda functionaraç çağrısının türü. Evet

Araç Çağrı Türü

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

Mülkiyet Değer
Açıklama Bu durumda functionaraç çağrısının türü.
Türü String
Değerler function

chatTamamlamaİstekMesajAracı

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

SohbetTamamlamaTalepMesajFonksiyonu

İsim Türü Açıklama Gerekli Varsayılan
içerik String İletinin içeriği. Hayı
isim String İletinin içeriği. Hayı
rol enum İleti yazarının rolü( bu örnekte function).
Olası değerler: function		 Hayı

createChatCompletionResponse

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

İsim Türü Açıklama Gerekli Varsayılan
Seçenek array Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse n birden fazla olabilir. Evet
Oluşturulan tamsayı Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak). Evet
kimlik String Sohbetin tamamlanması için benzersiz bir tanımlayıcı. Evet
örnek String Sohbetin tamamlanması için kullanılan model. Evet
object enum Her zaman chat.completionolan nesne türü.
Olası değerler: chat.completion		 Evet
sonuçları_filtrele_giriş promptFilterResults İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir. Hayı
sistem parmak izi String Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder.

Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle seed birlikte kullanılabilir.
 Hayı
kullanım tamamlama kullanımı Tamamlanma isteği için kullanım istatistikleri. Hayı

SohbetTamamlamaAkışYanıtıOluştur

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

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

sohbetTamamlamaAkışYanıtDelta

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

İsim Türü Açıklama Gerekli Varsayılan
içerik String Öbek iletisinin içeriği. Hayı
fonksiyon çağrısı object kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri. Hayı
└─ argümanlar 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 parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. Hayı
└─ ad String Çağrılacak işlevin adı. Hayı
Ret String Model tarafından oluşturulan reddetme iletisi. Hayı
rol enum Bu iletinin yazarının rolü.
Olası değerler: system, user, assistant, tool		 Hayı
araç çağrıları array Hayı

sohbetTamamlamaMesajAracıÇağrıParçası

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object Hayı
└─ argümanlar 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 parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. Hayı
└─ ad String Çağrılacak işlevin adı. Hayı
kimlik String Araç çağrısının kimliği. Hayı
indeks tamsayı Evet
tür enum Aracın türü. Şu anda yalnızca function desteklenmektedir.
Olası değerler: function		 Hayı

SohbetTamamlamaAkışSeçenekleri

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

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

sohbetTamamlamaSecimiLogOlasiliklari

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

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

chatCompletionTokenLogprob

İsim Türü Açıklama Gerekli Varsayılan
byte 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 . Evet
logprob Numara Bu belirtecin günlük olasılığı. Evet
jeton String Belirteç. Evet
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. Evet

SohbetiTamamlamaYanıtMesajı

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

İsim Türü Açıklama Gerekli Varsayılan
ses object Ses çıkış modu istenirse, bu nesne modelin ses yanıtıyla ilgili verileri içerir. Hayı
└─ veri String Model tarafından oluşturulan ve istekte belirtilen biçimde Base64 ile kodlanmış ses baytları.
 Hayı
└─ sona_erme_tarihi tamsayı Unix zaman damgası (saniye olarak), bu ses yanıtının çok aşamalı konuşmalarda kullanılmak üzere artık sunucuda erişilebilir olmayacağı zamanı belirtir.
 Hayı
└─ kimlik String Bu ses yanıtı için benzersiz tanımlayıcı. Hayı
└─ transkript String Model tarafından oluşturulan sesin dökümü. Hayı
içerik String İletinin içeriği. Evet
Bağlam 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. Hayı
fonksiyon çağrısı chatCompletionFunctionCall kullanım dışı bırakıldı ve tarafından tool_callsdeğiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri. Hayı
Ret String Model tarafından oluşturulan reddetme iletisi. Evet
rol chatTamamlamaYanıtMesajıRolü Yanıt iletisinin yazarının rolü. Evet
araç çağrıları array Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar. Hayı

SohbetTamamlamaYanıtMesajRolü

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

Mülkiyet Değer
Açıklama Yanıt iletisinin yazarının rolü.
Türü String
Değerler assistant

sohbetTamamlamaAracıSeçenek

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

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

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

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

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object Evet
└─ ad String Çağrılacak işlevin adı. Hayı
tür enum Aracın türü. Şu anda yalnızca function desteklenmektedir.
Olası değerler: function		 Evet

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.

Tahmin İçeriği

Yeniden oluşturulan bir metin dosyasının içeriği gibi statik tahmin edilen çıkış içeriği.

İsim Türü Açıklama Gerekli Varsayılan
içerik dize veya dizi Model yanıtı oluşturulurken eşleşmesi gereken içerik. Oluşturulan belirteçler bu içerikle eşleşirse, model yanıtının tamamı çok daha hızlı döndürülebilir. Evet
tür enum Sağlamak istediğiniz tahmin edilen içeriğin türü. Bu tür şu anda her zaman contentşeklindedir.
Olası değerler: content		 Evet

chatTamamlamaMesajAracıÇağrıları

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

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

SohbetTamamlamaYöntemleri

Modelin bu istek için oluşturmasını istediğiniz çıkış türleri. Çoğu model, varsayılan olan metin oluşturabilir:

["text"]

Model gpt-4o-audio-preview ses oluşturmak için de kullanılabilir. Bu modelin hem metin hem de ses yanıtları oluşturmasını istemek için şunları kullanabilirsiniz:

["text", "audio"]

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

sohbetTamamlamaFonksiyonCagırma

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

İsim Türü Açıklama Gerekli Varsayılan
Argümanlar 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 parametrelerin halüsinasyona neden olabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. Evet
isim String Çağrılacak işlevin adı. Evet

tamamlama kullanımı

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

İsim Türü Açıklama Gerekli Varsayılan
tamamlama belirteçleri tamsayı Oluşturulan tamamlamadaki belirteçlerin sayısı. Evet
tamamlama_jeton_detayları object Tamamlanmada kullanılan belirteçlerin dökümü. Hayı
└─ kabul edilen tahmin belirteçleri tamsayı Tahmin Edilen Çıkışlar kullanılırken, tahmindeki tamamlanmada görünen belirteç sayısı. Hayı
└─ ses_öğeleri tamsayı Model tarafından oluşturulan ses giriş belirteçleri. Hayı
└─ akıl yürütme_tokenlar tamsayı Model tarafından mantık yürütme için oluşturulan belirteçler. Hayı
└─ reddedilen_tahmin_tokenları tamsayı Tahmin Edilen Çıkışlar kullanılırken, tahmindeki tamamlanmada görünmeyen belirteçlerin sayısı. Ancak, akıl yürütme belirteçleri gibi bu belirteçler de faturalama, çıkış ve bağlam penceresi sınırları için toplam tamamlanma belirteçlerinde sayılır. Hayı
istem_jetonları tamsayı İstemdeki belirteç sayısı. Evet
uyarı_jetonları_detayları object İstem belirteçlerinin ayrıntıları. Hayı
└─ ses_öğeleri tamsayı İstemde ses giriş belirteçleri bulunur. Hayı
└─ önbelleğe alınmış jetonlar tamsayı Önbelleğe alınmış istem belirteçlerinin sayısı. Hayı
toplam jetonlar tamsayı İstekte kullanılan toplam belirteç sayısı (istem + tamamlama). Evet

SohbetTamamlamaAracı

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon FunctionObject Evet
tür enum Aracın türü. Şu anda yalnızca function desteklenmektedir.
Olası değerler: function		 Evet

Fonksiyon Parametreleri

İş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

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması. Hayı
isim String Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir. Evet
Parametreler 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.		 Hayı
Sıkı Boolean İşlev çağrısı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model alanda tanımlanan şemayı parameters tam olarak izler. strict trueolduğunda yalnızca bir JSON Şeması alt kümesi desteklenir. Hayı Yanlış

YanıtFormatıMetni

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

YanıtFormatıJsonNesne

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

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

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

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

YanıtFormatıJsonŞeması

İsim Türü Açıklama Gerekli Varsayılan
json şeması object Evet
└─ açıklama String Yanıt formatının amacına ilişkin bir açıklama, modelin bu formatta nasıl yanıt vereceğini belirlemesi için kullanılır. Hayı
└─ ad 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. Hayı
└─ şeması YanıtFormatJsonŞemaŞeması JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. Hayı
└─ katı Boolean Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman alanda tanımlanan tam şemayı schema izler. strict trueolduğunda yalnızca bir JSON Şeması alt kümesi desteklenir. Hayı Yanlış
tür enum Tanımlanan yanıt biçiminin türü: json_schema
Olası değerler: json_schema		 Evet

sohbetTamamlamaSeçimiOrtak

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

Çeviri İstek Oluştur

Çeviri isteği.

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

sesli yanıt

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

İsim Türü Açıklama Gerekli Varsayılan
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Çevrilmiş veya dökümü alınmış metin. Evet

audioVerboseResponse

response_format verbose_json çeviri veya transkripsiyon yanıtı

İsim Türü Açıklama Gerekli Varsayılan
süre Numara Süre. Hayı
dil String Dil Hayı
segmentler array Hayı
görev String Ses görevinin türü. Hayı
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Çevrilmiş veya dökümü alınmış metin. Evet
Kelime array Hayı

sesYanıtBiçimi

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

Mülkiyet Değer
Açıklama Çıkışın biçimini tanımlar.
Türü String
Değerler json
text
srt
verbose_json
vtt

Transkripsiyon İsteği Oluştur

Transkripsiyon isteği.

İsim Türü Açıklama Gerekli Varsayılan
dosya String Dökümü yapılan ses dosyası nesnesi. Evet
dil String Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır. Hayı
Uyarı String Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir. Hayı
yanıt formatı audioResponseFormat Çıkışın biçimini tanımlar. Hayı
sıcaklık Numara Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır. Hayı 0
zaman damgası ayrıntılılıkları[] array Bu transkripsiyon için doldurulacak zaman damgası tanecikleri. response_format zaman damgası taneciklerini kullanacak şekilde ayarlanmalıdır verbose_json . Bu seçeneklerden biri veya her ikisi de desteklenir: word, veya segment. Not: Segment zaman damgaları için ek gecikme süresi yoktur, ancak sözcük zaman damgaları oluşturmak ek gecikmeye neden olur. Hayı ['bölüm']

audioSegment

Transkripsiyon veya çeviri segmenti.

İsim Türü Açıklama Gerekli Varsayılan
avg_logprob Numara Ortalama günlük olasılığı. Hayı
sıkıştırma oranı Numara Sıkıştırma oranı. Hayı
son Numara Segment sonu uzaklığı. Hayı
kimlik tamsayı Segment tanımlayıcısı. Hayı
Konuşma_olasılığı_yok Numara 'Konuşma yok' olasılığı. Hayı
aramak Numara Segmentin uzaklığı. Hayı
Başla Numara Segment başlangıç uzaklığı. Hayı
sıcaklık Numara Sıcaklık. Hayı
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Segment metni. Hayı
Belirteç -leri array Metnin belirteçleri. Hayı

audioWord

Transkripsiyon veya çeviri sözcüğü.

İsim Türü Açıklama Gerekli Varsayılan
son Numara Sözcük sonu uzaklığı. Hayı
Başla Numara Sözcük başlangıç uzaklığı. Hayı
kelime String Kelime Hayı

Ses İsteği Oluşturma

Konuşma isteği.

İsim Türü Açıklama Gerekli Varsayılan
girdi String Ses sentezi için metin. Uzunluk üst sınırı 4096 karakterdir. Evet
yanıt formatı enum Sesi sentezlemek için biçim.
Olası değerler: mp3, opus, aac, flac, , wav, pcm		 Hayı
Hız Numara Sentezlenen sesin hızı. 'den 0.25 değerine 4.0bir değer seçin. 1.0 varsayılan değerdir. Hayı 1.0
ses enum Konuşma sentezi için kullanılacak ses.
Olası değerler: alloy, echo, fable, onyx, , nova, shimmer		 Evet

görüntü kalitesi

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

Mülkiyet Değer
Açıklama Oluşturulacak görüntünün kalitesi.
Türü String
Varsayılan Otomatik
Değerler auto
high
medium
low
hd
standard

görüntüYanıtFormatı

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

Mülkiyet Değer
Açıklama Oluşturulan görüntülerin döndürüldiği biçim.
Türü String
Varsayılan URL
Değerler url
b64_json

resimlerinÇıkışFormatı

Oluşturulan görüntülerin döndürüldiği dosya biçimi. Yalnızca gpt-image-1 için desteklenir.

Mülkiyet Değer
Açıklama Oluşturulan görüntülerin döndürüldiği dosya biçimi. Yalnızca gpt-image-1 için desteklenir.
Türü String
Varsayılan png
Değerler png
jpeg

görüntüBoyutu

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

Mülkiyet Değer
Açıklama Oluşturulan görüntülerin boyutu.
Türü String
Varsayılan Otomatik
Değerler auto
1792x1024
1024x1792
1024x1024
1024x1536
1536x1024

görüntü stili

Oluşturulan görüntülerin stili. Yalnızca dall-e-3 için desteklenir.

Mülkiyet Değer
Açıklama Oluşturulan görüntülerin stili. Yalnızca dall-e-3 için desteklenir.
Türü String
Varsayılan Canlı
Değerler vivid
natural

görüntü arka planı

Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1 için desteklenir.

Mülkiyet Değer
Açıklama Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1 için desteklenir.
Türü String
Varsayılan Otomatik
Değerler transparent
opaque
auto

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

İsim Türü Açıklama Gerekli Varsayılan
arka plan imageBackground Oluşturulan görüntülerin arka planı için saydamlık ayarlamaya olanak tanır. Bu parametre yalnızca gpt-image-1 için desteklenir. Hayı Otomatik
n tamsayı Oluşturulacak görüntü sayısı. dall-e-3 için yalnızca n=1 desteklenir. Hayı 1
çıktı sıkıştırma tamsayı Oluşturulan görüntüler için sıkıştırma düzeyi (0-100%). Bu parametre yalnızca jpeg çıkış biçimine sahip gpt-image-1 için desteklenir. Hayı 100
çıkış formatı imagesOutputFormat Oluşturulan görüntülerin döndürüldiği dosya biçimi. Yalnızca gpt-image-1 için desteklenir. Hayı png
Uyarı String İstenen resimlerin metin açıklaması. Maksimum uzunluk gpt-image-1 için 32000 karakter ve dall-e-3 için 4000 karakterdir Evet
nitelik imageQuality Oluşturulacak görüntünün kalitesi. Hayı Otomatik
yanıt formatı imagesResponseFormat Oluşturulan görüntülerin döndürüldiği biçim. Hayı URL
boyut imageSize Oluşturulan görüntülerin boyutu. Hayı Otomatik
stil imageStyle Oluşturulan görüntülerin stili. Yalnızca dall-e-3 için desteklenir. Hayı Canlı
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. Hayı

resimDüzenlemeTalebi

İsim Türü Açıklama Gerekli Varsayılan
resim dize veya dizi Düzenleyebileceğiniz görüntüler. Desteklenen bir görüntü dosyası veya görüntü dizisi olmalıdır. Her resim 25 MB'tan küçük bir png veya jpg dosyası olmalıdır. Evet
maske String Tamamen saydam alanları (örneğin, alfa sıfır) olan ek bir görüntü, görüntünün nerede düzenlenmesi gerektiğini gösterir. Sağlanan birden çok görüntü varsa, maske ilk görüntüye uygulanır. 4 MB'tan küçük geçerli bir PNG dosyası olmalı ve resimle aynı boyutlara sahip olmalıdır. Hayı
n tamsayı Oluşturulacak görüntü sayısı. Hayı 1
Uyarı String İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 32000 karakterdir. Evet
nitelik imageQuality Oluşturulacak görüntünün kalitesi. Hayı Otomatik
yanıt formatı imagesResponseFormat Oluşturulan görüntülerin döndürüldiği biçim. Hayı URL
boyut imageSize Oluşturulan görüntülerin boyutu. Hayı Otomatik
kullanıcı String Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. Hayı

generateImagesResponse

İsim Türü Açıklama Gerekli Varsayılan
Oluşturulan tamsayı İşlemin oluşturulduğu unix zaman damgası. Evet
veriler array Başarılı olursa işlemin sonuç verileri Evet
kullanım imageGenerationsUsage Görüntü oluşturma taleplerindeki belirteç kullanım ayrıntılarını temsil eder. Yalnızca gpt-image-1 için. Hayı

görüntüSonuç

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

İsim Türü Açıklama Gerekli Varsayılan
b64_json String base64 kodlanmış görüntüsü Hayı
içerik_filtreleme_sonuçları dalleİçerikFiltreSonuçları İçerik filtreleme sonuçları hakkında bilgi. Hayı
sonuçları_filtrele_giriş 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 engelleme listesi hakkındaki bilgileri de bulabilirsiniz. Hayı
düzeltilmiş_yazı String İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem. Hayı
URL String Resim URL'si. Hayı

görüntü üretimleri kullanımı

Görüntü oluşturma taleplerindeki belirteç kullanım ayrıntılarını temsil eder. Yalnızca gpt-image-1 için.

İsim Türü Açıklama Gerekli Varsayılan
giriş belirteçleri tamsayı Giriş belirteçlerinin sayısı. Hayı
girdi_jeton_detayları object Giriş belirteçlerinin ayrıntılı dökümü. Hayı
└─ resim_jetonları tamsayı Görüntü belirteçlerinin sayısı. Hayı
└─ metin_tokenleri tamsayı Metin belirteçlerinin sayısı. Hayı
çıktı_jetonları tamsayı Çıkış belirteçlerinin sayısı. Hayı
toplam jetonlar tamsayı Kullanılan toplam belirteç sayısı. Hayı

satır

Sözcükler ve seçim işaretleri gibi bitişik bir içerik öğesi dizisini içeren bir içerik satırı nesnesi.

İsim Türü Açıklama Gerekli Varsayılan
Yayılan array Algılanan nesneleri ve sınırlayıcı kutu bilgilerini temsil eden bir span dizisi. Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Evet

Span

Algılanan bir nesneyi ve sınırlayıcı kutu bilgilerini temsil eden bir span nesnesi.

İsim Türü Açıklama Gerekli Varsayılan
uzunluk tamsayı Unicode kod noktalarıyla ölçülen karakter cinsinden yayılma alanının uzunluğu. Evet
ofset baskı tamsayı Metnin içinde, yayılma alanının başladığı karakter uzaklığı. Bu uzaklık, metnin başından Unicode kod noktaları olarak sayarak yayılma alanının ilk karakterinin konumu olarak tanımlanır. Evet
çokgen array Algılanan nesneyi kapsayan çokgendeki noktaları temsil eden bir nesne dizisi. Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Algılanan nesneyi temsil eden yayılma alanının metin içeriği. Evet

çalıştırmaTamamlanmaKullanımı

Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma bir terminal durumunda değilse (örneğinnull, , in_progressvb.) bu değer olacaktırqueued.

İsim Türü Açıklama Gerekli Varsayılan
tamamlama belirteçleri tamsayı Çalıştırma boyunca kullanılan tamamlanma belirteçlerinin sayısı. Evet
istem_jetonları tamsayı Çalıştırma boyunca kullanılan istem belirteçlerinin sayısı. Evet
toplam jetonlar tamsayı Kullanılan toplam belirteç sayısı (istem + tamamlama). Evet

adım tamamlama kullanımı yürüt

Çalıştırma adımıyla ilgili kullanım istatistikleri. Bu değer, çalıştırma adımının durumu olduğunda nullolurin_progress.

İsim Türü Açıklama Gerekli Varsayılan
tamamlama belirteçleri tamsayı Çalıştırma adımı boyunca kullanılan tamamlama belirteçlerinin sayısı. Evet
istem_jetonları tamsayı Çalıştırma adımı boyunca kullanılan istem belirteçlerinin sayısı. Evet
toplam jetonlar tamsayı Kullanılan toplam belirteç sayısı (istem + tamamlama). Evet

asistanlarApiYanıtFormatıSeçeneği

Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.

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

assistantsApiYanıtFormatı

Modelin beklenen çıkışını açıklayan nesne. Yalnızca json_object türün function Çalıştır'a geçirilmesine izin veriliyorsatools. Model metin döndürebiliyorsa text veya gerekli herhangi bir değer varsa.

İsim Türü Açıklama Gerekli Varsayılan
tür String text veya json_objectbiri olmalıdır. Hayı Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin.

Enum türü: AssistantsApiResponseFormat

Değer Açıklama
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin.
json_object

YardımcıNesne

Modeli çağırabilen ve araçları kullanabilen bir assistant öğesini temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
oluşturulma_tarihi tamsayı Yardımcının oluşturulduğu zaman için Unix zaman damgası (saniye olarak). Evet
Açıklama String Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.
 Evet
kimlik String API uç noktalarında başvurulabilen tanımlayıcı. Evet
talimatlar String Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 256.000 karakterdir.
 Evet
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Evet
örnek String Kullanılacak modelin kimliği. Evet
isim String Asistanın adı. Uzunluk üst sınırı 256 karakterdir.
 Evet
object String Her zaman assistantolan nesne türü. Evet
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
araç_kaynakları object Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu yardımcıya eklenmiş vektör deposunun kimliği. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
araçlar array Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , code_interpreterveya file_searchtüründe functionolabilir.
 Evet []
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1

object Enum: AssistantObjectType

Değer Açıklama
asistan Her zaman yardımcı olan nesne türü

asistan isteği oluştur

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.
 Hayı
talimatlar String Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 256.000 karakterdir.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Evet
isim String Asistanın adı. Uzunluk üst sınırı 256 karakterdir.
 Hayı
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
araç_kaynakları object Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu yardımcıya bağlı vektör deposu. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
└─ vector depoları array file_ids ile bir vektör deposu oluşturmak ve bu yardımcıya eklemek için bir yardımcı. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
araçlar array Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , code_interpreterveya retrievaltüründe functionolabilir.
 Hayı []
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1

Asistan İsteklerini Değiştir

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.
 Hayı
talimatlar String Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 32768 karakterdir.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Hayı
isim String Asistanın adı. Uzunluk üst sınırı 256 karakterdir.
 Hayı
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
araç_kaynakları object Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına sunulan code_interpreter dosya kimliklerinin listesini geçersiz kılar. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu yardımcıya bağlı vektör depoyu geçersiz kılar. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
araçlar array Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , code_interpreterveya retrievaltüründe functionolabilir.
 Hayı []
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1

AsistanCevabınıSil

İsim Türü Açıklama Gerekli Varsayılan
silindi Boolean Evet
kimlik String Evet
object String Evet

object Enum: DeleteAssistantResponseState

Değer Açıklama
asistan.silindi

AsistanlarıListelemeYanıtı

İsim Türü Açıklama Gerekli Varsayılan
veriler array Evet
ilk_kimlik String Evet
daha_fazla Boolean Evet
son_kimlik String Evet
object String Evet

asistanAraçlarKodu

İsim Türü Açıklama Gerekli Varsayılan
tür String Tanımlanan araç türü: code_interpreter Evet

type Enum: yardımcıAraçlarKodTürü

Değer Açıklama
kod yorumlayıcı

asistanAraçlarDosyaArama

İsim Türü Açıklama Gerekli Varsayılan
dosya_arama object Dosya arama aracı için geçersiz kılmalar. Hayı
└─ maks_sonuç_sayısı tamsayı Dosya arama aracının vermesi gereken en fazla sonuç sayısı. Varsayılan değer gpt-4* modelleri için 20 ve gpt-3.5-turbo için 5'tir. Bu sayı 1 ile 50 (dahil) arasında olmalıdır.

Dosya arama aracının sonuçlardan daha max_num_results az çıkış oluşturabileceğini unutmayın.
Hayı
tür String Tanımlanan araç türü: file_search Evet

type Enum: asistanAraçlarDosyaAramaTürü

Değer Açıklama
dosya_arama

Asistan Araçları Dosya Arama Türü Yalnızca

İsim Türü Açıklama Gerekli Varsayılan
tür String Tanımlanan araç türü: file_search Evet

type Enum: asistanAraçlarDosyaAramaTürü

Değer Açıklama
dosya_arama

asistanAraçlarİşlevi

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object İşlev tanımı. Evet
└─ açıklama String İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması. Hayı
└─ ad 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. Hayı
└─ parametreleri chatCompletionFonksiyonParametreleri İş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. Hayı
tür String Tanımlanan araç türü: function Evet

type Enum: yardımcıAraçlarFonksiyonu

Değer Açıklama
fonksiyon

truncationObject

Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.

İsim Türü Açıklama Gerekli Varsayılan
son_mesajlar tamsayı Çalıştırma bağlamını oluştururken iş parçacığından gelen en son iletilerin sayısı. Hayı
tür String İş parçacığı için kullanılacak kesme stratejisi. Varsayılan değer: auto. olarak ayarlanırsa last_messages, iş parçacığı iş parçacığındaki n en son iletiye kesilir. olarak autoayarlandığında, iş parçacığının ortasındaki iletiler, modelin max_prompt_tokensbağlam uzunluğuna uyacak şekilde bırakılır. Evet

Enum Türü: KesimTürü

Değer Açıklama
Otomatik
son_mesajlar

yardımcılarApiAraçSeçimSeçeneği

Model tarafından çağrılan aracı (varsa) denetler. none modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir. auto varsayılan değerdir ve modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir. veya gibi {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.

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

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

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

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object Hayı
└─ ad String Çağrılacak işlevin adı. Hayı
tür String Aracın türü. türü ise function, işlev adı ayarlanmalıdır Evet

type Enum: AssistantsNamedToolChoiceType

Değer Açıklama
fonksiyon
kod yorumlayıcı
dosya_arama

runObject

bir iş parçacığı üzerinde yürütme çalıştırması temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
asistan_kimlik String Bu çalıştırmanın yürütülmesi için kullanılan yardımcının kimliği. Evet
iptal edildiğinde tamsayı Çalıştırmanın iptal edildiği zaman için Unix zaman damgası (saniye olarak). Evet
tamamlanma_tarihi tamsayı Çalıştırmanın ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak). Evet
oluşturulma_tarihi tamsayı Çalıştırmanın oluşturulduğu zaman için Unix zaman damgası (saniye olarak). Evet
sona_erdigi_tarih tamsayı Çalıştırmanın süresinin dolacağı zaman için Unix zaman damgası (saniye olarak). Evet
başarısız_olduğunda tamsayı Çalıştırmanın başarısız olduğu zaman için Unix zaman damgası (saniye olarak). Evet
kimlik String API uç noktalarında başvurulabilen tanımlayıcı. Evet
eksik_bilgiler object Çalıştırmanın neden tamamlanmamış olduğuna ilişkin ayrıntılar. Çalıştırma tamamlanmamışsa olacaktır null . Evet
└─ neden String Çalıştırmanın tamamlanmamış olmasının nedeni. Bu, çalıştırma boyunca belirli bir belirteç sınırına ulaşıldığına işaret eder. Hayı
talimatlar String Yardımcının bu çalıştırma için kullandığı yönergeler. Evet
Son_hata object Bu çalıştırmayla ilişkili son hata. Hata yoksa olacaktır null . Evet
└─ kod String veya server_error'nin rate_limit_exceeded biri. Hayı
└─ ileti String Hatanın insan tarafından okunabilen açıklaması. Hayı
maksimum_tamamlama_tokenları tamsayı Çalıştırma boyunca kullanılmak üzere belirtilen en fazla tamamlanma belirteci sayısı.
 Evet
max_prompt_tokens tamsayı Çalıştırma boyunca kullanılmak üzere belirtilen en fazla istem belirteci sayısı.
 Evet
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Evet
örnek String Yardımcının bu çalıştırma için kullandığı model. Evet
object String Her zaman thread.runolan nesne türü. Evet
paralel araç çağrıları ParallelToolCalls Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. Hayı Doğru
gerekli_eylem object Çalıştırmaya devam etmek için gereken eylemle ilgili ayrıntılar. Herhangi bir eylem gerekli değilse olacaktır null . Evet
└─ araç çıktıları gönder object Bu çalıştırmanın devam etmesi için gereken araç çıktılarıyla ilgili ayrıntılar. Hayı
└─ tool_calls array İlgili araç çağrılarının listesi. Hayı
└─ türü enum Şimdilik, bu her zaman submit_tool_outputs.
Olası değerler: submit_tool_outputs		 Hayı
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Evet
başlangıç_zamanı tamsayı Çalıştırmanın başlatıldığı zaman için Unix zaman damgası (saniye olarak). Evet
statü String Çalıştırmanın durumu ; , queued, in_progress, , requires_action, cancelling, cancelled, failedveya completedolabilirexpired. Evet
sıcaklık Numara Bu çalıştırma için kullanılan örnekleme sıcaklığı. Ayarlanmadıysa, varsayılan olarak 1 olur. Hayı
thread_id String Bu çalıştırmanın bir parçası olarak üzerinde yürütülen iş parçacıklarının kimliği. Evet
araç seçimi assistantsApiToolChoiceOption Model tarafından çağrılan aracı (varsa) denetler.
none modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto varsayılan değerdir ve modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
veya gibi {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.
 Evet
araçlar array Yardımcının bu çalıştırma için kullandığı araçların listesi. Evet []
top_p Numara Bu çalıştırma için kullanılan çekirdek örnekleme değeri. Ayarlanmadıysa, varsayılan olarak 1 olur. Hayı
kesme_stratejisi truncationObject Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın. Evet
kullanım runCompletionKullanımı Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma bir terminal durumunda değilse (örneğinnull, , in_progressvb.) bu değer olacaktırqueued. Evet

object Enum: runObjectType

Değer Açıklama
thread çalıştır Her zaman thread.run olan çalıştırma nesnesi türü

status Enum: RunObjectStatus

Değer Açıklama
Sıraya Kuyruğa alınmış durum
devam ediyor in_progress durumu
eylem gerekiyor required_action durumu
Iptal İptal etme durumu
iptal İptal edilen durum
başarısız Başarısız durum
Tamamlandı Tamamlanmış durum
Süresi dolmuş Süresi dolan durum

ÇalıştırmaİsteğiOluştur

İsim Türü Açıklama Gerekli Varsayılan
ek talimatlar String Çalıştırma yönergelerinin sonuna ek yönergeler ekler. Bu, diğer yönergeleri geçersiz kılmadan çalıştırma başına davranışı değiştirmek için kullanışlıdır. Hayı
ek_mesajlar array Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler. Hayı
asistan_kimlik String Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği. Evet
talimatlar String Yardımcının varsayılan sistem iletisini geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
maksimum_tamamlama_tokenları tamsayı Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
max_prompt_tokens tamsayı Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Bu çalıştırmayı yürütmek için kullanılacak Modelin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır. Hayı
paralel araç çağrıları ParallelToolCalls Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. Hayı Doğru
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
yayın akışı Boolean ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.
 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
araç seçimi assistantsApiToolChoiceOption Model tarafından çağrılan aracı (varsa) denetler.
none modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto varsayılan değerdir ve modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
veya gibi {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.
 Hayı
araçlar array Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kesme_stratejisi truncationObject Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın. Hayı

listRunsResponse

İsim Türü Açıklama Gerekli Varsayılan
veriler array Evet
ilk_kimlik String Evet
daha_fazla Boolean Evet
son_kimlik String Evet
object String Evet

Çalıştırma İsteğini Değiştir

İsim Türü Açıklama Gerekli Varsayılan
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı

AraçÇıktılarınıGönderÇalıştırmaİsteği

İsim Türü Açıklama Gerekli Varsayılan
yayın akışı Boolean ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.
 Hayı
araç çıktıları array Çıkışların gönderildiği araçların listesi. Evet

runToolCallObject

Araç çağrısı nesneleri

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object İşlev tanımı. Evet
└─ argümanlar String Modelin işleve geçirmenizi beklediği bağımsız değişkenler. Hayı
└─ ad String İşlevin adı. Hayı
kimlik String Araç çağrısının kimliği. Bu kimlik, uç noktada aracı çalıştırmak için arayüz çıktılarınızı gönderirken belirtilmelidir. Evet
tür String Çıktının gerekli olduğu araç çağrısı türü. Şimdilik, bu her zaman function. Evet

type Enum: RunToolCallObjectType

Değer Açıklama
fonksiyon

createThreadVeÇalıştırİstek

İsim Türü Açıklama Gerekli Varsayılan
asistan_kimlik String Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği. Evet
talimatlar String Yardımcının varsayılan sistem iletisini geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
maksimum_tamamlama_tokenları tamsayı Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
max_prompt_tokens tamsayı Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
 Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
örnek String Bu çalıştırmayı yürütmek için kullanılacak modellerin kimliği. Burada bir değer sağlanırsa, yardımcıyla ilişkili modeli geçersiz kılar. Aksi takdirde, yardımcıyla ilişkili model kullanılır. Hayı
paralel araç çağrıları ParallelToolCalls Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. Hayı Doğru
yanıt formatı assistantsApiResponseFormatOption Modelin çıkış yapması gereken biçimi belirtir. GPT-4o, GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Yapılandırılmış Çıkışlar kılavuzunda daha fazla bilgi edinin.

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli bir JSON olduğundan emin olan 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_tokensiçeriğinin kısmen kesilebileceğini unutmayın.		 Hayı
yayın akışı Boolean ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.
 Hayı
akış_seçenekleri chatCompletionStreamOptions Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true.
 Hayı Hiç kimse
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
 Hayı 1
iplik createThreadRequest Hayı
araç seçimi assistantsApiToolChoiceOption Model tarafından çağrılan aracı (varsa) denetler.
none modelin herhangi bir araç çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto varsayılan değerdir ve modelin ileti oluşturma veya araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
veya gibi {"type": "file_search"}{"type": "function", "function": {"name": "my_function"}} belirli bir aracı belirtmek, modeli söz konusu aracı çağırmaya zorlar.
 Hayı
araç_kaynakları object Yardımcının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu yardımcıya eklenmiş vektör deposunun kimliği. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
 Hayı
araçlar array Yardımcının bu çalıştırma için kullanabileceği araçları geçersiz kılın. Bu, çalışma başına davranışı değiştirmek için kullanışlıdır. Hayı
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kesme_stratejisi truncationObject Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın. Hayı

threadObject

İleti içeren bir iş parçacığını temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
oluşturulma_tarihi tamsayı İş parçacığının oluşturulduğu zaman için Unix zaman damgası (saniye olarak). Evet
kimlik String API uç noktalarında başvurulabilen tanımlayıcı. Evet
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Evet
object String Her zaman threadolan nesne türü. Evet
araç_kaynakları object Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Evet
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.
 Hayı

object Enum: ThreadObjectType

Değer Açıklama
iplik Her zaman olan iş parçacığı nesnesi türü thread

konu oluşturma isteği

İsim Türü Açıklama Gerekli Varsayılan
iletiler array Diziyi başlatacak iletilerin listesi. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
araç_kaynakları object Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.
 Hayı
└─ vector depoları array file_ids ile bir vektör deposu oluşturmak ve bunu bu iş parçacığına eklemek için bir yardımcı. İş parçacığına en fazla 1 vektör deposu eklenebilir.
 Hayı

konuDeğiştirmeİsteği

İsim Türü Açıklama Gerekli Varsayılan
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
araç_kaynakları object Bu iş parçacığında yardımcının araçlarının kullanımına sunulan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.
 Hayı
└─ kod yorumlayıcı object Hayı
└─ dosya_kimlikleri array Aracın kullanımına code_interpreter sunulan Dosya Kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.
 Hayı []
└─ dosya_ara object Hayı
└─ vector_store_ids array Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.
 Hayı

KonuYanıtınıSil

İsim Türü Açıklama Gerekli Varsayılan
silindi Boolean Evet
kimlik String Evet
object String Evet

object Enum: DeleteThreadResponseObjectState

Değer Açıklama
konu.silindi İş parçacığı yanıt nesnesi durumunu silme thread.deleted

listThreadsResponse

İsim Türü Açıklama Gerekli Varsayılan
veriler array Evet
ilk_kimlik String Evet
daha_fazla Boolean Evet
son_kimlik String Evet
object String Evet

mesajNesnesi

İş parçacığı içindeki bir iletiyi temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
asistan_kimlik String Varsa, bu iletiyi yazan yardımcının kimliği. Evet
Ekleri array İletiye eklenen dosyaların listesi ve eklendikleri araçlar. Evet
tamamlanma_tarihi tamsayı İletinin ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak). Evet
içerik array İletinin metin ve/veya resim dizisi içindeki içeriği. Evet
oluşturulma_tarihi tamsayı İletinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak). Evet
kimlik String API uç noktalarında başvurulabilen tanımlayıcı. Evet
eksik_tarihinde tamsayı İletinin tamamlanmamış olarak işaretlendiği zaman için Unix zaman damgası (saniye olarak). Evet
eksik_bilgiler object Tamamlanmamış bir iletide, iletinin neden eksik olduğuna ilişkin ayrıntılar. Evet
└─ neden String İletinin tamamlanmamış olmasının nedeni. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Evet
object String Her zaman thread.messageolan nesne türü. Evet
rol String İletiyi oluşturan varlık. veya user'nin assistant biri. Evet
run_id String Varsa, bu iletinin yazmasıyla ilişkili çalıştırmanın kimliği. Evet
statü String İletinin durumu , veya in_progressolabilirincompletecompleted. Evet
thread_id String Bu mesajın ait olduğu iş parçacığı kimliği. Evet

object Enum: MesajNesneTürü

Değer Açıklama
iş_parçacığı.mesaj İleti nesnesi türü: thread.message

status Enum: MessageObjectStatus

Değer Açıklama
devam ediyor
Eksik
Tamamlandı

role Enum: Mesaj Nesne Rolü

Değer Açıklama
kullanıcı
asistan

MesajDeltaNesnesi

Akış sırasında iletideki değiştirilmiş alanlar gibi bir ileti deltasını temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
delta object İletide değiştirilen alanları içeren delta. Evet
└─ içerik array İletinin metin ve/veya resim dizisi içindeki içeriği. Hayı
└─ rol String İletiyi oluşturan varlık. veya user'nin assistant biri. Hayı
kimlik String API uç noktalarına başvurulabilen iletinin tanımlayıcısı. Evet
object String Her zaman thread.message.deltaolan nesne türü. Evet

object Enum: MessageDeltaObjectType

Değer Açıklama
thread.message.delta

mesajOluşturmaİsteği

İsim Türü Açıklama Gerekli Varsayılan
Ekleri array İletiye eklenen dosyaların listesi ve bunların eklenmesi gereken araçlar. Hayı
içerik String İletinin içeriği. Evet
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
rol String İletiyi oluşturan varlığın rolü. İzin verilen değerler şunlardır:
- user: İletinin gerçek bir kullanıcı tarafından gönderildiğini gösterir ve çoğu durumda kullanıcı tarafından oluşturulan iletileri temsil etmek için kullanılmalıdır.
- assistant: İletinin yardımcı tarafından oluşturulduğunu gösterir. Yardımcıdan konuşmaya ileti eklemek için bu değeri kullanın.
 Evet

role Enum: CreateMessageRequestRole

Değer Açıklama
kullanıcı
asistan

mesajDüzenlemeİsteği

İsim Türü Açıklama Gerekli Varsayılan
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı

deleteMessageResponse

İsim Türü Açıklama Gerekli Varsayılan
silindi Boolean Evet
kimlik String Evet
object String Evet

object Enum: DeleteMessageResponseObject

Değer Açıklama
konu.mesaj.silindi İletiyi sil yanıt nesnesi durumu

listMesajlarYanıtı

İsim Türü Açıklama Gerekli Varsayılan
veriler array Evet
ilk_kimlik String Evet
daha_fazla Boolean Evet
son_kimlik String Evet
object String Evet

mesajİçerikGörüntüDosyaNesnesi

İletinin içeriğindeki bir görüntü Dosyasına başvurur.

İsim Türü Açıklama Gerekli Varsayılan
görüntü_dosyası object Evet
└─ dosya_kimliği String İleti içeriğindeki görüntünün Dosya Kimliği. Hayı
tür String Her zaman image_file. Evet

Enum türü: MessageContentImageFileObjectType

Değer Açıklama
görüntü_dosyası İleti içerik görüntüsü dosya türü

MesajİçeriğiMetinNesnesi

İletinin parçası olan metin içeriği.

İsim Türü Açıklama Gerekli Varsayılan
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. object Evet
└─ ek açıklamalar array Hayı
└─ değer String Metni oluşturan veriler. Hayı
tür String Her zaman text. Evet

type Enum: mesajİçeriğiMetinNesnesiTürü

Değer Açıklama
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. İleti içeriği metni Nesne türü

mesajİçeriğiMetinEkAçıklamalarıDosyaReferansNesnesi

İletinin içinde, yardımcıyla veya iletiyle ilişkilendirilmiş belirli bir Dosyadan belirli bir alıntıya işaret eden alıntı. Yardımcı dosyaları aramak için "alma" aracını kullandığında oluşturulur.

İsim Türü Açıklama Gerekli Varsayılan
bitiş_indeksi tamsayı Evet
dosya_atıf object Evet
└─ dosya_kimliği String Alıntının ait olduğu dosyanın kimliği. Hayı
başlangıç_indeksi tamsayı Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String İleti içeriğindeki değiştirilmesi gereken metin. Evet
tür String Her zaman file_citation. Evet

type Enum: DosyaAlıntıNesneTürü

Değer Açıklama
dosya_atıf Dosya alıntısı nesne türü

mesajIçeriğiMetinÖzellikleriDosyaYoluNesnesi

Yardımcı bir dosya oluşturmak için aracı kullandığında code_interpreter oluşturulan dosyanın URL'si.

İsim Türü Açıklama Gerekli Varsayılan
bitiş_indeksi tamsayı Evet
dosya yolu object Evet
└─ dosya_kimliği String Oluşturulan dosyanın kimliği. Hayı
başlangıç_indeksi tamsayı Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String İleti içeriğindeki değiştirilmesi gereken metin. Evet
tür String Her zaman file_path. Evet

type Enum: DosyaYoluNesneTürü

Değer Açıklama
dosya yolu Dosya yolu nesne türü

mesajDeltaİçerikGörüntüDosyaNesnesi

İletinin içeriğindeki bir görüntü Dosyasına başvurur.

İsim Türü Açıklama Gerekli Varsayılan
görüntü_dosyası object Hayı
└─ dosya_kimliği String İleti içeriğindeki görüntünün Dosya Kimliği. Hayı
indeks tamsayı İletideki içerik bölümünün dizini. Evet
tür String Her zaman image_file. Evet

type Enum: MessageDeltaContentImageFileObjectType

Değer Açıklama
görüntü_dosyası

mesajDeltaİçerikMetinNesnesi

İletinin parçası olan metin içeriği.

İsim Türü Açıklama Gerekli Varsayılan
indeks tamsayı İletideki içerik bölümünün dizini. Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. object Hayı
└─ ek açıklamalar array Hayı
└─ değer String Metni oluşturan veriler. Hayı
tür String Her zaman text. Evet

Enum türü: Mesaj Delta İçerik Metni Nesne Tipi

Değer Açıklama
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin.

mesajDeltaİçerikMetinAçıklamalarıDosyaAlıntıNesnesi

İletinin içinde, yardımcıyla veya iletiyle ilişkilendirilmiş belirli bir Dosyadan belirli bir alıntıya işaret eden alıntı. Yardımcı dosyaları aramak için "file_search" aracını kullandığında oluşturulur.

İsim Türü Açıklama Gerekli Varsayılan
bitiş_indeksi tamsayı Hayı
dosya_atıf object Hayı
└─ dosya_kimliği String Alıntının ait olduğu dosyanın kimliği. Hayı
└─ alıntı String Dosyadaki belirli tırnak işareti. Hayı
indeks tamsayı Metin içeriği bölümündeki ek açıklamanın dizini. Evet
başlangıç_indeksi tamsayı Hayı
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String İleti içeriğindeki değiştirilmesi gereken metin. Hayı
tür String Her zaman file_citation. Evet

tür Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Değer Açıklama
dosya_atıf

mesajDeltaİçerikMetinAçıklamalarıDosyaYoluNesnesi

Yardımcı bir dosya oluşturmak için aracı kullandığında code_interpreter oluşturulan dosyanın URL'si.

İsim Türü Açıklama Gerekli Varsayılan
bitiş_indeksi tamsayı Hayı
dosya yolu object Hayı
└─ dosya_kimliği String Oluşturulan dosyanın kimliği. Hayı
indeks tamsayı Metin içeriği bölümündeki ek açıklamanın dizini. Evet
başlangıç_indeksi tamsayı Hayı
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String İleti içeriğindeki değiştirilmesi gereken metin. Hayı
tür String Her zaman file_path. Evet

Enum türü: MesajDeltaİçeriğiMetinAçıklamalarıDosyaYoluNesneTürü

Değer Açıklama
dosya yolu

runStepObject

Çalıştırmanın yürütülmesindeki bir adımı temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
asistan_kimlik String Çalıştırma adımıyla ilişkili yardımcının kimliği. Evet
iptal edildiğinde tamsayı Çalıştırma adımının iptal edildiği zaman için Unix zaman damgası (saniye olarak). Evet
tamamlanma_tarihi tamsayı Çalıştırma adımının ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak). Evet
oluşturulma_tarihi tamsayı Çalıştırma adımının oluşturulduğu zaman için Unix zaman damgası (saniye olarak). Evet
süresi dolma tarihi tamsayı Çalıştırma adımının süresinin dolmasına ilişkin Unix zaman damgası (saniye olarak). Üst çalıştırmanın süresi dolduysa bir adımın süresi dolmuş olarak kabul edilir. Evet
başarısız_olduğunda tamsayı Çalıştırma adımının başarısız olduğu zaman için Unix zaman damgası (saniye olarak). Evet
kimlik String API uç noktalarında başvurulabilen çalıştırma adımının tanımlayıcısı. Evet
Son_hata object Bu çalıştırma adımıyla ilişkili son hata. Hata yoksa olacaktır null . Evet
└─ kod String veya server_error'nin rate_limit_exceeded biri. Hayı
└─ ileti String Hatanın insan tarafından okunabilen açıklaması. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Evet
object String Her zaman assistant.run.stepolan nesne türü. Evet
run_id String Bu çalıştırma adımının parçası olduğu çalıştırmanın kimliği. Evet
statü String Çalıştırmanın durumu; , , in_progress, cancelledveya failedolabilircompletedexpired. Evet
adım_detayları runStepDetailsMessageCreationObject veya runStepDetailsToolCallsObject Çalıştırma adımının ayrıntıları. Evet
thread_id String Çalıştırılan iş parçacıklarının kimliği. Evet
tür String veya message_creationolabilecek tool_calls çalıştırma adımının türü. Evet

object Enum: RunStepObjectType

Değer Açıklama
assistant.run.step Her zaman olan nesne türü assistant.run.step

Enum türü: RunStepObjectType

Değer Açıklama
mesaj_oluşturma message_creation çalıştırma adımı
araç çağrıları tool_calls çalıştırma adımı

status Enum: RunStepObjectStatus

Değer Açıklama
devam ediyor in_progress çalıştırma durumu
iptal İptal edilen çalıştırma durumu
başarısız İptal edilen çalıştırma durumu
Tamamlandı İptal edilen çalıştırma durumu
Süresi dolmuş İptal edilen çalıştırma durumu

runStepDeltaObject

Akış sırasında bir çalıştırma adımındaki değiştirilmiş alanlar gibi bir çalıştırma adımı deltasını temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
delta object Çalıştırma adımında değiştirilen alanları içeren delta. Evet
adım_detayları runStepDeltaStepDetailsMessageCreationObject veya runStepDeltaStepDetailsToolCallsObject Çalıştırma adımının ayrıntıları. Hayı
kimlik String API uç noktalarında başvurulabilen çalıştırma adımının tanımlayıcısı. Evet
object String Her zaman thread.run.step.deltaolan nesne türü. Evet

object Enum: RunStepDeltaObjectType

Değer Açıklama
thread.run.step.delta

Liste Çalıştırma Adımları Yanıtı

İsim Türü Açıklama Gerekli Varsayılan
veriler array Evet
ilk_kimlik String Evet
daha_fazla Boolean Evet
son_kimlik String Evet
object String Evet

AdımDetaylarıMesajYaratmaNesnesi Çalıştır

Çalıştırma adımına göre ileti oluşturma işleminin ayrıntıları.

İsim Türü Açıklama Gerekli Varsayılan
mesaj_oluşturma object Evet
└─ mesaj_kimliği String Bu çalıştırma adımı tarafından oluşturulan iletinin kimliği. Hayı
tür String Her zaman message_creation. Evet

type Enum: ÇalışmaAdımDetaylarıMesajOluşturmaNesneTürü

Değer Açıklama
mesaj_oluşturma

çalıştırAdımDeltaAdımDetaylarıMesajOluşturmaNesnesi

Çalıştırma adımına göre ileti oluşturma işleminin ayrıntıları.

İsim Türü Açıklama Gerekli Varsayılan
mesaj_oluşturma object Hayı
└─ mesaj_kimliği String Bu çalıştırma adımı tarafından oluşturulan iletinin kimliği. Hayı
tür String Her zaman message_creation. Evet

Enum Türü: RunStepDeltaStepDetailsMessageCreationObjectType

Değer Açıklama
mesaj_oluşturma

runStepDetailsToolCallsObject

Araç çağrısının ayrıntıları.

İsim Türü Açıklama Gerekli Varsayılan
araç çağrıları array Çalıştırma adımının dahil olduğu bir araç çağrısı dizisi. Bunlar üç araç türünden biriyle ilişkilendirilebilir: code_interpreter, retrieval veya function.
 Evet
tür String Her zaman tool_calls. Evet

Enum türü: RunStepDetailsToolCallsObjectType

Değer Açıklama
araç çağrıları

AdımDeltaAdımDetaylarıAraçÇağrılarıNesnesi

Araç çağrısının ayrıntıları.

İsim Türü Açıklama Gerekli Varsayılan
araç çağrıları array Çalıştırma adımının dahil olduğu bir araç çağrısı dizisi. Bunlar üç araç türünden biriyle ilişkilendirilebilir: code_interpreter, file_search veya function.
 Hayı
tür String Her zaman tool_calls. Evet

Enum türü: RunStepDeltaStepDetailsToolCallsObjectType

Değer Açıklama
araç çağrıları

ÇalıştırmaAdımDetaylarıAraçÇağrılarıKodNesnesi

Çalıştırma adımının dahil olduğu Kod Yorumlayıcı aracı çağrısının ayrıntıları.

İsim Türü Açıklama Gerekli Varsayılan
kod yorumlayıcı object Kod Yorumlayıcı aracı çağrı tanımı. Evet
└─ giriş String Kod Yorumlayıcı aracı çağrısına giriş. Hayı
└─ çıkışlar array Kod Yorumlayıcı araç çağrısının çıkışları. Kod Yorumlayıcı, metin () veya resimlerlogs (image) dahil olmak üzere bir veya daha fazla öğe çıkışı yapabilir. Bunların her biri farklı bir nesne türüyle temsil edilir. Hayı
kimlik String Araç çağrısının kimliği. Evet
tür String Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır code_interpreter . Evet

Enum türü: RunStepDetailsToolCallsCodeObjectType

Değer Açıklama
kod yorumlayıcı

StepDeltaAdımDetaylarıAracıÇağrılarıKodNesnesiÇalıştır

Çalıştırma adımının dahil olduğu Kod Yorumlayıcı aracı çağrısının ayrıntıları.

İsim Türü Açıklama Gerekli Varsayılan
kod yorumlayıcı object Kod Yorumlayıcı aracı çağrı tanımı. Hayı
└─ giriş String Kod Yorumlayıcı aracı çağrısına giriş. Hayı
└─ çıkışlar array Kod Yorumlayıcı araç çağrısının çıkışları. Kod Yorumlayıcı, metin () veya resimlerlogs (image) dahil olmak üzere bir veya daha fazla öğe çıkışı yapabilir. Bunların her biri farklı bir nesne türüyle temsil edilir. Hayı
kimlik String Araç çağrısının kimliği. Hayı
indeks tamsayı Araçtaki araç çağrısının dizini diziyi çağırır. Evet
tür String Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır code_interpreter . Evet

Enum türü: RunStepDeltaStepDetailsToolCallsCodeObjectType

Değer Açıklama
kod yorumlayıcı

ÇalıştırAdımDetaylarıAraçÇağrılarıKodÇıkışıGünlüklerNesne

Çalıştırma adımının bir parçası olarak Kod Yorumlayıcı aracı çağrısından metin çıktısı.

İsim Türü Açıklama Gerekli Varsayılan
kayıtlar String Kod Yorumlayıcı araç çağrısından metin çıkışı. Evet
tür String Her zaman logs. Evet

Enum türü: RunStepDetailsToolCallsCodeOutputLogsObjectType

Değer Açıklama
kayıtlar

çalıştırAdımDeltaAdımDetaylarAraçÇağrılarıKodÇıktıGünlüklerNesnesi

Çalıştırma adımının bir parçası olarak Kod Yorumlayıcı aracı çağrısından metin çıktısı.

İsim Türü Açıklama Gerekli Varsayılan
indeks tamsayı Çıkış dizisindeki çıkışın dizini. Evet
kayıtlar String Kod Yorumlayıcı araç çağrısından metin çıkışı. Hayı
tür String Her zaman logs. Evet

type Enum: Çalıştırma Adımı Delta Adım Detayları Araç Çağrıları Kod Çıkış Günlükleri Nesne Tipi

Değer Açıklama
kayıtlar

AdımÇalıştırmaDetaylarıAraçÇağrılarıKodÇıktısıGörüntüNesnesi

İsim Türü Açıklama Gerekli Varsayılan
resim object Evet
└─ dosya_kimliği String Görüntünün Dosya Kimliği. Hayı
tür String Her zaman image. Evet

type Enum: Çalıştırma Adımı Detayları Araç Çağrıları Kod Çıkışı Görüntü Nesne Türü

Değer Açıklama
resim

çalıştırAdımDeltaAdımAyrıntılarıAraçÇağrılarıKodÇıktısıGörüntüNesnesi

İsim Türü Açıklama Gerekli Varsayılan
resim object Hayı
└─ dosya_kimliği String Görüntünün dosya kimliği. Hayı
indeks tamsayı Çıkış dizisindeki çıkışın dizini. Evet
tür String Her zaman image. Evet

type Enum: ÇalıştırmaAdımıDeltaAdımDetaylarıAraçÇağrılarıKodÇıkışGörüntüNesnesi

Değer Açıklama
resim

runStepDetailsToolCallsFileSearchObject

İsim Türü Açıklama Gerekli Varsayılan
dosya_arama object Şimdilik bu her zaman boş bir nesne olacak. Evet
└─ sonuçlar array Dosya aramasının sonuçları. Hayı
kimlik String Araç çağrısı nesnesinin kimliği. Evet
tür String Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır file_search . Evet

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Değer Açıklama
dosya_arama

adımDetaylarıAracıÇağrılarıDosyaAramaSonucuNesnesi

Dosya aramasının sonuç örneği.

İsim Türü Açıklama Gerekli Varsayılan
içerik array Bulunan sonucun içeriği. İçerik yalnızca ekleme sorgusu parametresi aracılığıyla istenirse eklenir. Hayı
dosya_kimlik String Sonucun bulunduğu dosyanın kimliği. Evet
dosya_adı String Sonucun bulunduğu dosyanın adı. Evet
Puan Numara Sonucun puanı. Tüm değerler 0 ile 1 arasında kayan noktalı bir sayı olmalıdır. Evet

ÇalıştırAdımDeltaAdımDetaylarıAraçÇağırmaDosyaAramaNesnesi

İsim Türü Açıklama Gerekli Varsayılan
dosya_arama object Şimdilik bu her zaman boş bir nesne olacak. Evet
kimlik String Araç çağrısı nesnesinin kimliği. Hayı
indeks tamsayı Araçtaki araç çağrısının dizini diziyi çağırır. Evet
tür String Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır retrieval . Evet

Enum türü: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Değer Açıklama
dosya_arama

adım detayları aracı fonksiyon nesnesini çalıştırır

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object Çağrılan işlevin tanımı. Evet
└─ argümanlar String İşleve geçirilen bağımsız değişkenler. Hayı
└─ ad String İşlevin adı. Hayı
└─ çıkış String İşlevin çıkışı. Bu, çıkışlar henüz gönderilmediyse olacaktır null . Hayı
kimlik String Araç çağrısı nesnesinin kimliği. Evet
tür String Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır function . Evet

type Enum: RunStepDetailsToolCallsFunctionObjectType

Değer Açıklama
fonksiyon

çalıştırAdımDeltaAdımDetaylarıAraçÇağrıFonksiyonNesnesi

İsim Türü Açıklama Gerekli Varsayılan
fonksiyon object Çağrılan işlevin tanımı. Hayı
└─ argümanlar String İşleve geçirilen bağımsız değişkenler. Hayı
└─ ad String İşlevin adı. Hayı
└─ çıkış String İşlevin çıkışı. Bu, çıkışlar henüz gönderilmediyse olacaktır null . Hayı
kimlik String Araç çağrısı nesnesinin kimliği. Hayı
indeks tamsayı Araçtaki araç çağrısının dizini diziyi çağırır. Evet
tür String Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır function . Evet

type Enum: RunStepDetailsToolCallsFunctionObjectType

Değer Açıklama
fonksiyon

vektörDepolamaSonraSonuçlanma

Vektör deposu için süre sonu ilkesi.

İsim Türü Açıklama Gerekli Varsayılan
yer işareti String Süre sonu ilkesinin uygulanacağı bağlantı zaman damgası. Desteklenen tutturucular: last_active_at. Evet
Günler tamsayı Vektör deposunun süresinin dolacağı yer işareti saatinden sonraki gün sayısı. Evet

anchor Enum: VectorStoreExpirationAfterAnchor

Değer Açıklama
son etkinlik zamanı Süre sonu ilkesinin uygulandığı yer işareti zaman damgası.

vectorStoreObject

Vektör deposu, araç tarafından file_search kullanılabilecek işlenmiş dosya koleksiyonudur.

İsim Türü Açıklama Gerekli Varsayılan
oluşturulma_tarihi tamsayı Vektör deposunun oluşturulduğu zaman için Unix zaman damgası (saniye olarak). Evet
sona_erdikten_sonra vectorStoreExpirationAfter Vektör deposu için süre sonu ilkesi. Hayı
sona_erdigi_tarih tamsayı Vektör deposunun süresinin ne zaman dolacağı için Unix zaman damgası (saniye olarak). Hayı
dosya_sayıları object Evet
└─ iptal edildi tamsayı İptal edilen dosya sayısı. Hayı
└─ tamamlandı tamsayı Başarıyla işlenen dosyaların sayısı. Hayı
└─ başarısız oldu tamsayı İşlenemeyen dosyaların sayısı. Hayı
└─ devam ediyor tamsayı İşlenmekte olan dosyaların sayısı. Hayı
└─ toplam tamsayı Toplam dosya sayısı. Hayı
kimlik String API uç noktalarında başvurulabilen tanımlayıcı. Evet
son etkinlik zamanı tamsayı Vektör deposunun en son etkin olduğu zaman için Unix zaman damgası (saniye olarak). Evet
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Evet
isim String Vektör deposunun adı. Evet
object enum Her zaman vector_storeolan nesne türü.
Olası değerler: vector_store		 Evet
statü String , veya expiredolabilir in_progresscompletedvektör deposunun durumu. durumu completed , vektör deposunun kullanıma hazır olduğunu gösterir. Evet
kullanım_baytları tamsayı Vektör deposundaki dosyalar tarafından kullanılan toplam bayt sayısı. Evet

status Enum: VectorStoreObjectStatus

Değer Açıklama
Süresi dolmuş
devam ediyor
Tamamlandı

VektorDepoİsteğiOluştur

İsim Türü Açıklama Gerekli Varsayılan
bölme stratejisi autoChunkingStrategyRequestParam veya staticChunkingStrategyRequestParam Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Yalnızca file_ids boş değilse geçerlidir. Hayı
sona_erdikten_sonra vectorStoreExpirationAfter Vektör deposu için süre sonu ilkesi. Hayı
dosya_kimlikleri array Vektör deposunun kullanması gereken dosya kimliklerinin listesi. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
isim String Vektör deposunun adı. Hayı

vektörDeposuGüncellemeİsteği

İsim Türü Açıklama Gerekli Varsayılan
sona_erdikten_sonra vectorStoreExpirationAfter Vektör deposu için süre sonu ilkesi. Hayı
meta veriler object Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak için yararlı olabilir. Anahtarlar en fazla 64 karakter uzunluğunda ve değerler en fazla 512 karakter uzunluğunda olabilir.
 Hayı
isim String Vektör deposunun adı. Hayı

listVectorStoresResponse

İsim Türü Açıklama Gerekli Varsayılan
veriler array Evet
ilk_kimlik String Evet
daha_fazla Boolean Evet
son_kimlik String Evet
object String Evet

deleteVectorStoreResponse

İsim Türü Açıklama Gerekli Varsayılan
silindi Boolean Evet
kimlik String Evet
object String Evet

object Enum: DeleteVectorStoreResponseObject

Değer Açıklama
vektör_deposu.silindi Sil vektör deposu yanıt nesnesi durumu

Vektör Depo Dosya Nesnesi

Vektör deposuna eklenmiş dosyaların listesi.

İsim Türü Açıklama Gerekli Varsayılan
bölme stratejisi autoChunkingStrategyRequestParam veya staticChunkingStrategyRequestParam Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Yalnızca file_ids boş değilse geçerlidir. Hayı
oluşturulma_tarihi tamsayı Vektör deposu dosyasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak). Evet
kimlik String API uç noktalarında başvurulabilen tanımlayıcı. Evet
Son_hata object Bu vektör deposu dosyasıyla ilişkili son hata. Hata yoksa olacaktır null . Evet
└─ kod String server_error veya invalid_fileunsupported_fileveya ... Hayı
└─ ileti String Hatanın insan tarafından okunabilen açıklaması. Hayı
object String Her zaman vector_store.fileolan nesne türü. Evet
statü String , , in_progressveya completedolabilir cancelledfailedvektör deposu dosyasının durumu. Durum completed , vektör deposu dosyasının kullanıma hazır olduğunu gösterir. Evet
kullanım_baytları tamsayı Bayt cinsinden toplam vektör deposu kullanımı. Bunun özgün dosya boyutundan farklı olabileceğini unutmayın. Evet
vektör_depolama_kimliği String Dosyanın eklendiği vektör deposunun kimliği. Evet

object Enum: VectorStoreFileObjectType

Değer Açıklama
vector_store.file

status Enum: VectorStoreFileObjectStatus

Değer Açıklama
devam ediyor
Tamamlandı
iptal
başarısız

diğerChunkingStrategyResponseParam

Öbekleme stratejisi bilinmediğinde bu döndürülür. Bunun nedeni genellikle dosyanın API'de kavram kullanılmadan önce chunking_strategy dizine eklenmiş olmasıdır.

İsim Türü Açıklama Gerekli Varsayılan
tür String Her zaman other. Evet

type Enum: OtherChunkingStrategyYanıtParametreTipi

Değer Açıklama
diğer

statikBölütlemeStratejisiYanıtParametresi

İsim Türü Açıklama Gerekli Varsayılan
durağan staticChunkingStrategy Evet
tür String Her zaman static. Evet

enum türü: Statik Bölme Stratejisi Yanıt Parametre Türü

Değer Açıklama
durağan

statik bölümleme stratejisi

İsim Türü Açıklama Gerekli Varsayılan
blok_örtüşen_tokenlar tamsayı Öbekler arasında çakışan belirteçlerin sayısı. Varsayılan değer şudur: 400.

Çakışmanın yarısını max_chunk_size_tokensaşmaması gerektiğini unutmayın.
 Evet
maksimum_parça_boyutu_jetonlar tamsayı Her öbekteki en fazla belirteç sayısı. Varsayılan değer şudur: 800. En düşük değer, 100 en büyük değer ise şeklindedir 4096. Evet

Otomatik Küçük Parça Oluşturma Stratejisi İstek Parametresi

Varsayılan strateji. Bu strateji şu anda ve'nin max_chunk_size_tokens bir 800 sürümünü chunk_overlap_tokens400kullanır.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Her zaman auto.
Olası değerler: auto		 Evet

statikParçalamaStratejiİstekParametresi

İsim Türü Açıklama Gerekli Varsayılan
durağan staticChunkingStrategy Evet
tür enum Her zaman static.
Olası değerler: static		 Evet

parçalamaStratejiIstekParametre

Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır.

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

createVectorStoreFileRequest

İsim Türü Açıklama Gerekli Varsayılan
bölme stratejisi chunkingStrategyRequestParam Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Hayı
dosya_kimlik String Vektör deposunun kullanması gereken dosya kimliği. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır. Evet

listVectorStoreFilesResponse

İsim Türü Açıklama Gerekli Varsayılan
veriler array Evet
ilk_kimlik String Evet
daha_fazla Boolean Evet
son_kimlik String Evet
object String Evet

deleteVectorStoreFileResponse

İsim Türü Açıklama Gerekli Varsayılan
silindi Boolean Evet
kimlik String Evet
object String Evet

object Enum: DeleteVectorStoreFileResponseObject

Değer Açıklama
vektör_deposu.dosya.silindi

vectorStoreFileBatchObject

Vektör deposuna eklenmiş bir dosya grubu.

İsim Türü Açıklama Gerekli Varsayılan
oluşturulma_tarihi tamsayı Vektör depolama dosyaları toplu işleminin oluşturulduğu zaman için Unix zaman damgası (saniye cinsinden). Evet
dosya_sayıları object Evet
└─ iptal edildi tamsayı İptal edilen dosya sayısı. Hayı
└─ tamamlandı tamsayı İşlenen dosyaların sayısı. Hayı
└─ başarısız oldu tamsayı İşlenemeyen dosyaların sayısı. Hayı
└─ devam ediyor tamsayı İşlenmekte olan dosyaların sayısı. Hayı
└─ toplam tamsayı Toplam dosya sayısı. Hayı
kimlik String API uç noktalarında başvurulabilen tanımlayıcı. Evet
object String Her zaman vector_store.file_batcholan nesne türü. Evet
statü String Vektör deposu dosyaları toplu işleminin durumu , veya in_progressolabilircompletedcancelledfailed. Evet
vektör_depolama_kimliği String Dosyanın bağlı olduğu vektör deposunun kimliği. Evet

object Enum: VectorStoreFileBatchObjectType

Değer Açıklama
vektör_depolama.dosyalar_toplu

status Enum: VectorStoreFileBatchObjectStatus

Değer Açıklama
devam ediyor
Tamamlandı
iptal
başarısız

createVectorStoreFileBatchRequest

İsim Türü Açıklama Gerekli Varsayılan
bölme stratejisi chunkingStrategyRequestParam Dosyaları öbekleme için kullanılan öbekleme stratejisi. Ayarlanmadıysa, stratejiyi auto kullanır. Hayı
dosya_kimlikleri array Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi file_search araçlar için kullanışlıdır. Evet

assistantStreamEvent

Çalıştırma akışı sırasında yayılan bir olayı temsil eder.

Sunucu tarafından gönderilen olaylar akışındaki her olayın bir event ve data özelliği vardır:

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Yeni bir nesne oluşturulduğunda, yeni bir duruma geçişte veya parçalar halinde (deltalar) akışla aktarıldığında olayları yayarız. Örneğin, yeni bir çalıştırma oluşturulduğunda, thread.run.created bir çalıştırma tamamlandığında vb. yayarızthread.run.completed. Bir Yardımcı bir çalıştırma sırasında ileti oluşturmayı seçtiğinde, bir thread.message.created event, olayı thread.message.in_progress , birçok thread.message.delta olay ve son olarak bir thread.message.completed olay yayarız.

Zaman içinde ek olaylar ekleyebiliriz, bu nedenle kodunuzda bilinmeyen olayları düzgün bir şekilde işlemenizi öneririz.

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

threadStreamEvent

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

konu.oluşturuldu

Yeni bir iş parçacığı oluşturulduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler threadObject İleti içeren bir iş parçacığını temsil eder. Evet
etkinlik String Evet

Veri: threadObject

Olay Sabit Listesi: ThreadStreamEventEnum

Değer Açıklama
konu.oluşturuldu Oluşturulan iş parçacığı olayı

runStreamEvent

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

thread.run.created

Yeni bir çalıştırma oluşturulduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Numaralandırması: RunStreamEventCreated

Değer Açıklama
thread.run.created

thread.run.queued

Bir çalıştırma bir duruma geçtiğinde queued gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventQueued

Değer Açıklama
thread.run.queued

thread.run.devam etmekte

Bir çalıştırma bir duruma geçtiğinde in_progress gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventInProgress

Değer Açıklama
thread.run.devam etmekte

iş parçacığı çalıştırma eylem gerektiriyor

Bir çalıştırma bir duruma geçtiğinde requires_action gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventRequiresAction

Değer Açıklama
iş parçacığı çalıştırma eylem gerektiriyor

iş_parçacığı.çalıştır.tamamlandı

Bir çalıştırma tamamlandığında gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventCompleted

Değer Açıklama
iş_parçacığı.çalıştır.tamamlandı

thread.run.failed

Çalıştırma başarısız olduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventFailed

Değer Açıklama
thread.run.failed

thread.run.iptal ediliyor

Bir çalıştırma bir duruma geçtiğinde cancelling gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventCancelling

Değer Açıklama
thread.run.iptal ediliyor

thread.run.iptal edildi

Bir çalıştırma iptal edildiğinde gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventCancelled

Değer Açıklama
thread.run.iptal edildi

iş parçacığı çalışması sona erdi

Bir çalıştırmanın süresi dolduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runObject bir iş parçacığı üzerinde yürütme çalıştırması temsil eder. Evet
etkinlik String Evet

Veri: runObject

Olay Sabit Listesi: RunStreamEventExpired

Değer Açıklama
iş parçacığı çalışması sona erdi

runStepStreamEvent

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

thread.run.step.created

Bir çalıştırma adımı oluşturulduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runStepObject Çalıştırmanın yürütülmesindeki bir adımı temsil eder.
 Evet
etkinlik String Evet

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventCreated

Değer Açıklama
thread.run.step.created

thread.çalış.step.devam_ediyor

Çalıştırma adımı bir in_progress duruma geçtiğinde gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runStepObject Çalıştırmanın yürütülmesindeki bir adımı temsil eder.
 Evet
etkinlik String Evet

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventInProgress

Değer Açıklama
thread.çalış.step.devam_ediyor

thread.run.step.delta

Çalıştırma adımının bölümleri akışa alınırken gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runStepDeltaObject Akış sırasında bir çalıştırma adımındaki değiştirilmiş alanlar gibi bir çalıştırma adımı deltasını temsil eder.
 Evet
etkinlik String Evet

Veri: runStepDeltaObject

Olay Sabit Listesi: RunStepStreamEventDelta

Değer Açıklama
thread.run.step.delta

iş parçacığı çalıştırma adımı tamamlandı

Bir çalıştırma adımı tamamlandığında gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runStepObject Çalıştırmanın yürütülmesindeki bir adımı temsil eder.
 Evet
etkinlik String Evet

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventCompleted

Değer Açıklama
iş parçacığı çalıştırma adımı tamamlandı

iş parçacığı.çalıştır.adım.basarisiz

Çalıştırma adımı başarısız olduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runStepObject Çalıştırmanın yürütülmesindeki bir adımı temsil eder.
 Evet
etkinlik String Evet

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventFailed

Değer Açıklama
iş parçacığı.çalıştır.adım.basarisiz

iş parçacığı çalıştırma adımı iptal edildi

Çalıştırma adımı iptal edildiğinde gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runStepObject Çalıştırmanın yürütülmesindeki bir adımı temsil eder.
 Evet
etkinlik String Evet

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventCancelled

Değer Açıklama
iş parçacığı çalıştırma adımı iptal edildi

iş_parçacığı.çalıştır.adım.süresi_doldu

Çalıştırma adımının süresi dolduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler runStepObject Çalıştırmanın yürütülmesindeki bir adımı temsil eder.
 Evet
etkinlik String Evet

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventExpired

Değer Açıklama
iş_parçacığı.çalıştır.adım.süresi_doldu

mesajAkışOlayı

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

"konu.mesaj.oluşturuldu"

İleti oluşturulduğunda gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler messageObject İş parçacığı içindeki bir iletiyi temsil eder. Evet
etkinlik String Evet

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventCreated

Değer Açıklama
"konu.mesaj.oluşturuldu"

thread.mesaj.devam_ediyor

İleti bir duruma geçtiğinde in_progress gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler messageObject İş parçacığı içindeki bir iletiyi temsil eder. Evet
etkinlik String Evet

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventInProgress

Değer Açıklama
thread.mesaj.devam_ediyor

thread.mesaj.delta

İletinin bölümleri akışa alındığında gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler messageDeltaObject Akış sırasında iletideki değiştirilmiş alanlar gibi bir ileti deltasını temsil eder.
 Evet
etkinlik String Evet

Veri: messageDeltaObject

Olay Sabit Listesi: MessageStreamEventDelta

Değer Açıklama
thread.message.delta

konu.mesaj.tamamlandı

İleti tamamlandığında gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler messageObject İş parçacığı içindeki bir iletiyi temsil eder. Evet
etkinlik String Evet

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventCompleted

Değer Açıklama
konu.mesaj.tamamlandı

konu.mesaj.tamamlanmamış

İleti tamamlanmadan önce sona erdiğinde gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler messageObject İş parçacığı içindeki bir iletiyi temsil eder. Evet
etkinlik String Evet

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventIncomplete

Değer Açıklama
konu.mesaj.tamamlanmamış

Açıklama

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

Tık

Tıklama eylemi.

İsim Türü Açıklama Gerekli Varsayılan
düğme enum Tıklama sırasında hangi fare düğmesine basıldığını gösterir. left, , right, wheelbackveya forward.

Olası değerler: left, right, wheel, back, forward		 Evet
tür enum Olay türünü belirtir. Tıklama eylemi için bu özellik her zaman olarak clickayarlanır.

Olası değerler: click		 Evet
x tamsayı Tıklamanın gerçekleştiği x koordinatı.
 Evet
y tamsayı Tıklamanın gerçekleştiği y koordinatı.
 Evet

Kod Yorumlayıcı Dosya Çıkışı

Kod yorumlayıcı aracı çağrısının dosya olarak çıktısı.

İsim Türü Açıklama Gerekli Varsayılan
Dosyalar array Evet
tür enum Kod yorumlayıcı dosya çıkışının türü. Her zaman files.

Olası değerler: files		 Evet

KodYorumlayıcıMetinÇıktısı

Metin olan bir kod yorumlayıcı aracı çağrısının çıktısı.

İsim Türü Açıklama Gerekli Varsayılan
kayıtlar String Kod yorumlayıcı aracının çağrı günlükleri.
 Evet
tür enum Kod yorumlayıcı metin çıkışının türü. Her zaman logs.

Olası değerler: logs		 Evet

CodeInterpreterTool

Kod çalıştıran bir araç.

İsim Türü Açıklama Gerekli Varsayılan
dosya_kimlikleri array Kodun çalıştırıldığı dosyaların kimlikleri.
 Evet
tür enum Kod yorumlayıcı aracının türü. Her zaman code_interpreter.

Olası değerler: code_interpreter		 Evet

Kod Yorumlayıcı Araç Çağrısı

Kodu çalıştırmak için bir araç çağrısı.

İsim Türü Açıklama Gerekli Varsayılan
kod String Çalıştırılacak kod.
 Evet
kimlik String Kod yorumlayıcısı araç çağrısının benzersiz kimliği.
 Evet
Sonuçlar array Kod yorumlayıcı aracı çağrısının sonuçları.
 Evet
statü enum Kod yorumlayıcı aracı çağrısının durumu.

Olası değerler: in_progress, interpreting, completed		 Evet
tür enum Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call.

Olası değerler: code_interpreter_call		 Evet

KodYorumlayıcıAraçÇıktısı

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

Karşılaştırma Filtresi

Tanımlı bir karşılaştırma işlemi kullanarak belirtilen öznitelik anahtarını belirli bir değerle karşılaştırmak için kullanılan filtre.

İsim Türü Açıklama Gerekli Varsayılan
anahtar String Değerle karşılaştırmak için anahtar. Evet
tür enum Karşılaştırma işlecini belirtir: eq, ne, gt, gte, lt, lte.
- eq:Eşit -tir
- ne: eşit değil
- gt: büyüktür
- gte: büyüktür veya eşittir
- lt: daha azdır
- lte: küçüktür veya eşittir

Olası değerler: eq, ne, gt, gte, , lt, lte		 Evet
değer dize veya sayı ya da boole değeri Öznitelik anahtarıyla karşılaştıracak değer; dize, sayı veya boole türlerini destekler. Evet

Bileşik Filtre

and veya or kullanarak birden çok filtreyi birleştirin.

İsim Türü Açıklama Gerekli Varsayılan
filtreler array Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir. Evet
tür enum İşlem türü: and veya or.
Olası değerler: and, or		 Evet

ComputerAction

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

BilgisayarEkranGörüntüsüResmi

Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.

İsim Türü Açıklama Gerekli Varsayılan
dosya_kimlik String Yüklenmiş dosyanın, ekran görüntüsünü içeren kimliği. Hayı
image_url String Ekran görüntüsü URL'si. Hayı
tür enum Olay türünü belirtir. Bilgisayar ekran görüntüsü için bu özellik her zaman olarak computer_screenshotayarlanır.

Olası değerler: computer_screenshot		 Evet

ComputerTool

Sanal bilgisayarı denetleyebilen bir araç.

İsim Türü Açıklama Gerekli Varsayılan
görüntü yüksekliği Numara Bilgisayar ekranının yüksekliği.
 Evet
görüntü genişliği Numara Bilgisayar ekranının genişliği.
 Evet
çevre enum Denetlenecek bilgisayar ortamının türü.

Olası değerler: mac, windows, ubuntu, browser		 Evet
tür enum Bilgisayar kullanım aracının türü. Her zaman computer_use_preview.

Olası değerler: computer-use-preview		 Evet

ComputerToolCall

Bilgisayar kullanım araçlarına bir araç komutu verme.

İsim Türü Açıklama Gerekli Varsayılan
hareket ComputerAction Evet
call_id String Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.
 Evet
kimlik String Bilgisayar çağrısının benzersiz tanımlayıcısı. Evet
güvenlik_kontrolleri_beklemede array Bilgisayar çağrısı için bekleyen güvenlik denetimleri.
 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Evet
tür enum Bilgisayar çağrısının türü. Her zaman computer_call.
Olası değerler: computer_call		 Evet

BilgisayarAracıÇağrıÇıktısı

Bir bilgisayar aracı çağrısının çıktısı.

İsim Türü Açıklama Gerekli Varsayılan
onaylanmış güvenlik kontrolleri array API tarafından bildirilen ve geliştirici tarafından onaylanan güvenlik denetimleri.
 Hayı
call_id String Çıktı üreten bilgisayar aracı çağrısının kimliği.
 Evet
kimlik String Bilgisayar aracı çağrısı çıkış kimliği.
 Hayı
çıktı ComputerScreenshotImage Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.
 Evet
statü enum İleti girişinin durumu. in_progress, completedveya incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output.

Olası değerler: computer_call_output		 Evet

BilgisayarAraçÇağrıÇıkışKaynağı

İsim Türü Açıklama Gerekli Varsayılan
onaylanmış güvenlik kontrolleri array API tarafından bildirilen ve geliştirici tarafından onaylanan güvenlik denetimleri.
 Hayı
call_id String Çıktı üreten bilgisayar aracı çağrısının kimliği.
 Evet
kimlik String Bilgisayar çağrı aracı çıkışının benzersiz kimliği.
 Evet
çıktı ComputerScreenshotImage Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.
 Evet
statü enum İleti girişinin durumu. in_progress, completedveya incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output.

Olası değerler: computer_call_output		 Evet

BilgisayarAraçÇağrıGüvenlikKontrolü

Bilgisayar çağrısı için bekleyen bir güvenlik denetimi.

İsim Türü Açıklama Gerekli Varsayılan
kod String Bekleyen güvenlik denetiminin türü. Evet
kimlik String Bekleyen güvenlik denetiminin kimliği. Evet
mesaj String Henüz gerçekleştirilmemiş güvenlik denetimi hakkındaki ayrıntılar. Evet

İçerik

Çok modlu giriş ve çıkış içeriği.

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

Koordinat

X/y koordinat çifti, örneğin. { x: 100, y: 200 }

İsim Türü Açıklama Gerekli Varsayılan
x tamsayı X koordinatı.
 Evet
y tamsayı Y koordinatı.
 Evet

ModelYanıtÖzellikleriOluştur

İsim Türü Açıklama Gerekli Varsayılan
meta veriler Meta veriler Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir.

Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.
 Hayı
örnek String Yanıtları oluşturmak için kullanılan model. Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kullanıcı String OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. .
 Hayı

createResponse

İsim Türü Açıklama Gerekli Varsayılan
içermek array {"$ref": "#/components/schemas/includable/description"} Hayı
girdi dize veya dizi Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Evet
talimatlar String Model bağlamında ilk öğe olarak bir sistem (veya geliştirici) iletisi ekler.

ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.
 Hayı
maksimum_çıktı_birimleri tamsayı Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.
 Hayı
paralel araç çağrıları Boolean Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.
 Hayı Doğru
önceki_cevap_id String Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın. Hayı
muhakeme Muhakeme yalnızca o serisi modeller

Mantık modelleri için yapılandırma seçenekleri.
 Hayı
eklemesini iste Boolean Oluşturulan model yanıtının daha sonra API ile alınabilmesi için depolanıp depolanmayacağı.
 Hayı Doğru
yayın akışı Boolean true olarak ayarlanırsa, model yanıt verileri sunucu tarafından gönderilen olaylar kullanılarak oluşturulduğundan istemciye akışla gönderilir. Hayı Yanlış
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. object Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir. Daha fazla bilgi edinin:
- metin girişleri ve çıkışları
- Şekillendirilmiş Çıktılar
 Hayı
└─ biçimi TextResponseFormatConfiguration Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.
 Hayı
araç seçimi ToolChoiceOptions veya ToolChoiceTypes veya ToolChoiceFunction Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.
 Hayı
araçlar array Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz.

Modeli sağlayabileceğiniz iki araç kategorisi şunlardır:

- Yerleşik araçlar		 Hayı
Kısaltma enum Model yanıtı için kullanılacak kesme stratejisi.
- auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model bu bağlamı keser.
giriş öğelerini konuşmanın ortasına bırakarak bağlam penceresine sığacak şekilde yanıt verme.
- disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur.

Olası değerler: auto, disabled		 Hayı

DoubleClick

Çift tıklama eylemi.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Olay türünü belirtir. Çift tıklama eylemi için bu özellik her zaman olarak double_clickayarlanır.

Olası değerler: double_click		 Evet
x tamsayı Çift tıklamanın gerçekleştiği x koordinatı.
 Evet
y tamsayı Çift tıklamanın gerçekleştiği y koordinatı.
 Evet

Sürükleme

Sürükleme eylemi.

İsim Türü Açıklama Gerekli Varsayılan
yol array Sürükleme eyleminin yolunu temsil eden koordinat dizisi. Koordinatlar bir nesne dizisi olarak görünür, örneğin[{ x: 100, y: 200 }, { x: 200, y: 300 }] Evet
tür enum Olay türünü belirtir. Sürükleme eylemi için bu özellik her zaman olarak dragayarlanır.

Olası değerler: drag		 Evet

KolayGirişMesajı

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir. assistant rolüne sahip iletilerin, önceki etkileşimlerde model tarafından oluşturulduğu varsayılır.

İsim Türü Açıklama Gerekli Varsayılan
içerik string veya InputMessageContentList Yanıt oluşturmak için kullanılan modele metin, görüntü veya ses girişi.
Önceki yardımcı yanıtlarını da içerebilir.
 Evet
rol enum İleti girişinin rolü. user, , assistantsystemveya developer.

Olası değerler: user, assistant, system, developer		 Evet
tür enum İleti girişinin türü. Her zaman message.

Olası değerler: message		 Hayı

FileCitation

Bir dosyaya referans.

İsim Türü Açıklama Gerekli Varsayılan
dosya_kimlik String Dosyanın kimliği.
 Evet
indeks tamsayı Dosya listesindeki dosyanın dizini.
 Evet
tür enum Dosya alıntısının türü. Her zaman file_citation.

Olası değerler: file_citation		 Evet

FilePath

Bir dosyaya giden yol.

İsim Türü Açıklama Gerekli Varsayılan
dosya_kimlik String Dosyanın kimliği.
 Evet
indeks tamsayı Dosya listesindeki dosyanın dizini.
 Evet
tür enum Dosya yolunun türü. Her zaman file_path.

Olası değerler: file_path		 Evet

FileSearchRanker

Dosya araması için kullanılacak dereceleyici. Belirtilmezse auto ranker kullanılır.

Mülkiyet Değer
Açıklama Dosya araması için kullanılacak dereceleyici. Belirtilmezse auto ranker kullanılır.
Türü String
Değerler auto
default_2024_08_21

DosyaAramaAracı

Yüklenen dosyalardan ilgili içeriği arayan bir araç.

İsim Türü Açıklama Gerekli Varsayılan
filtreler ComparisonFilter veya CompoundFilter Dosya özniteliklerine göre uygulanacak bir filtre. Hayı
maks_sonuç_sayısı tamsayı Döndürülecek en fazla sonuç sayısı. Bu sayı 1 ile 50 (dahil) arasında olmalıdır.
 Hayı
Sıralama_seçenekleri object Arama için derecelendirme seçenekleri. Hayı
└─ sıralama yapıcı enum Dosya araması için kullanılacak dereceleyici.
Olası değerler: auto, default-2024-11-15		 Hayı
└─ skor_eşiği Numara Dosya araması için puan eşiği, 0 ile 1 arasında bir sayı.
1'e yakın sayılar yalnızca en uygun sonuçları döndürmeye çalışır, ancak daha az sonuç döndürebilir.
 Hayı 0
tür enum Dosya arama aracının türü. Her zaman file_search.

Olası değerler: file_search		 Evet
vector_store_ids array Aranacak vektör depolarının kimlikleri.
 Evet

Dosya Arama Aracı Çağrısı

Dosya arama aracı çağrısının sonuçları.

İsim Türü Açıklama Gerekli Varsayılan
kimlik String Dosya arama aracı çağrısının benzersiz kimliği.
 Evet
sorgular array Dosyaları aramak için kullanılan sorgular.
 Evet
Sonuçlar array Dosya arama aracı çağrısının sonuçları.
 Hayı
statü enum Dosya arama aracı çağrısının durumu. in_progress, searching, incomplete veya failed'den biri

Olası değerler: in_progress, searching, completed, incomplete, failed		 Evet
tür enum Dosya arama aracı çağrısının türü. Her zaman file_search_call.

Olası değerler: file_search_call		 Evet

FunctionTool

Modelin çağırmayı seçebileceği kendi kodunuzda bir işlev tanımlar.

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String İşlevin açıklaması. İşlevin çağrılıp çağrılmayacağını belirlemek için model tarafından kullanılır.
 Hayı
isim String Çağrılacak işlevin adı.
 Evet
Parametreler object İşlevin parametrelerini açıklayan bir JSON şema nesnesi.
 Evet
Sıkı Boolean Katı parametre doğrulamasının zorunlu kılınıp uygulanmayacağı. Varsayılan true.
 Evet
tür enum İşlev aracının türü. Her zaman function.

Olası değerler: function		 Evet

FunctionToolCall

Bir fonksiyonu çalıştırmak için bir araç çağrısı.

İsim Türü Açıklama Gerekli Varsayılan
Argümanlar String İşleve geçirecek bağımsız değişkenlerin JSON dizesi.
 Evet
call_id String Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.
 Evet
kimlik String İşlev aracı çağrısının benzersiz kimliği.
 Evet
isim String Çalıştırılacak işlevin adı.
 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum İşlev aracı çağrısının türü. Her zaman function_call.

Olası değerler: function_call		 Evet

FunctionToolCallOutput

İşlev aracı çağrısının çıktısı.

İsim Türü Açıklama Gerekli Varsayılan
call_id String Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.
 Evet
kimlik String İşlev aracının çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur.
 Hayı
çıktı String İşlev aracı çağrısının çıkışının JSON dizesi.
 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum İşlev aracının çağrı çıktısının türü. Her zaman function_call_output.

Olası değerler: function_call_output		 Evet

FunctionToolCallOutputResource

İsim Türü Açıklama Gerekli Varsayılan
call_id String Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği.
 Evet
kimlik String İşlev çağrı aracı çıkışının benzersiz kimliği.
 Evet
çıktı String İşlev aracı çağrısının çıkışının JSON dizesi.
 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum İşlev aracının çağrı çıktısının türü. Her zaman function_call_output.

Olası değerler: function_call_output		 Evet

dahil edilebilir

Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:

  • file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
  • message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
  • computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
Mülkiyet Değer
Açıklama Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:
- file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.
- message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.
- computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.
Türü String
Değerler file_search_call.results
message.input_image.image_url
computer_call_output.output.image_url

Ses Girişi

Modele ses girişi.

İsim Türü Açıklama Gerekli Varsayılan
veriler String Base64 ile kodlanmış ses verileri.
 Evet
biçim enum Ses verilerinin biçimi. Şu anda desteklenen biçimler mp3 ve wav'dir.

Olası değerler: mp3, wav		 Evet
tür enum Giriş öğesinin türü. Her zaman input_audio.

Olası değerler: input_audio		 Evet

Giriş İçeriği

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

Giriş Dosyası

Modele bir dosya girişi.

İsim Türü Açıklama Gerekli Varsayılan
dosya_verisi String Modele gönderilecek dosyanın içeriği.
 Hayı
dosya_kimlik String Modele gönderilecek dosyanın kimliği.
 Hayı
Dosyaadı String Modele gönderilecek dosyanın adı.
 Hayı
tür enum Giriş öğesinin türü. Her zaman input_file.

Olası değerler: input_file		 Evet

GirdiGörüntü

Modele bir görüntü girişi.

İsim Türü Açıklama Gerekli Varsayılan
ayrıntı enum Modele gönderilecek görüntünün ayrıntı düzeyi. high, lowveya auto. Varsayılan olarak auto değerini alır.

Olası değerler: high, low, auto		 Evet
dosya_kimlik String Modele gönderilecek dosyanın kimliği.
 Hayı
image_url String Modele gönderilecek görüntünün URL'si. Tam bir URL veya veri URL'sinde base64 kodlanmış görüntü.
 Hayı
tür enum Giriş öğesinin türü. Her zaman input_image.

Olası değerler: input_image		 Evet

Girdi Öğesi

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

GirdiMesajı

Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi. developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir.

İsim Türü Açıklama Gerekli Varsayılan
içerik GirişMesajİçerikListesi Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi
Türler
 Evet
rol enum İleti girişinin rolü. user, systemveya developer.

Olası değerler: user, system, developer		 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum İleti girişinin türü. Her zaman messageolarak ayarlayın.

Olası değerler: message		 Hayı

MesajİçeriğiGirdiListesi

Modelde farklı içerik türleri içeren bir veya birden çok giriş öğesinin listesi.

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

GirdiMesajKaynağı

İsim Türü Açıklama Gerekli Varsayılan
içerik GirişMesajİçerikListesi Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi
Türler
 Evet
kimlik String İleti girişinin benzersiz kimliği.
 Evet
rol enum İleti girişinin rolü. user, systemveya developer.

Olası değerler: user, system, developer		 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum İleti girişinin türü. Her zaman messageolarak ayarlayın.

Olası değerler: message		 Hayı

GirdiMetni

Modele metin girişi.

İsim Türü Açıklama Gerekli Varsayılan
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Modele metin girişi.
 Evet
tür enum Giriş öğesinin türü. Her zaman input_text.

Olası değerler: input_text		 Evet

Ürün

Yanıt oluşturmak için kullanılan içerik öğesi.

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

ÖğeReferansı

Başvurulacak bir öğenin iç tanımlayıcısı.

İsim Türü Açıklama Gerekli Varsayılan
kimlik String Başvurulacak öğenin kimliği.
 Evet
tür enum Başvurulacak öğenin türü. Her zaman item_reference.

Olası değerler: item_reference		 Evet

Öge Kaynağı

Yanıt oluşturmak için kullanılan içerik öğesi.

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

Keypress

Modelin gerçekleştirmek istediği tuş baskıları koleksiyonu.

İsim Türü Açıklama Gerekli Varsayılan
anahtarlar array Modelin basılmasını istediği tuş kombinasyonu. Bu, her biri bir anahtarı temsil eden bir dize dizisidir.
 Evet
tür enum Olay türünü belirtir. Bir tuşa basma eylemi için bu özellik her zaman olarak keypressayarlanır.

Olası değerler: keypress		 Evet

Meta veriler

Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir.

Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.

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

ModelResponseProperties

İsim Türü Açıklama Gerekli Varsayılan
meta veriler Meta veriler Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir.

Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.
 Hayı
örnek String Yanıtları oluşturmak için kullanılan model. Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
 Hayı 1
kullanıcı String OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. .
 Hayı

Hareket ettir

Fare hareket ettirme eylemi.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Olay türünü belirtir. Taşıma eylemi için bu özellik her zaman move olarak ayarlanır.

Olası değerler: move		 Evet
x tamsayı Taşınacak x koordinatı.
 Evet
y tamsayı Taşınması gereken y koordinatı.
 Evet

Çıkış Sesi

Modelden gelen bir ses çıkışı.

İsim Türü Açıklama Gerekli Varsayılan
veriler String Modelden alınan Base64 ile kodlanmış ses verileri.
 Evet
Transkript String Modeldeki ses verilerinin dökümü.
 Evet
tür enum Çıkış sesinin türü. Her zaman output_audio.

Olası değerler: output_audio		 Evet

Çıktı İçeriği

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

Çıktı Öğesi

İsim Türü Açıklama Gerekli Varsayılan
hareket ComputerAction Evet
Argümanlar String İşleve geçirecek bağımsız değişkenlerin JSON dizesi.
 Evet
call_id String Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı.
 Evet
içerik array Metin içeriğini muhakeme etme.
 Evet
kimlik String Akıl yürütme içeriğinin benzersiz tanımlayıcısı.
 Evet
isim String Çalıştırılacak işlevin adı.
 Evet
güvenlik_kontrolleri_beklemede array Bilgisayar çağrısı için bekleyen güvenlik denetimleri.
 Evet
sorgular array Dosyaları aramak için kullanılan sorgular.
 Evet
Sonuçlar array Dosya arama aracı çağrısının sonuçları.
 Hayı
rol enum Çıkış iletisinin rolü. Her zaman assistant.

Olası değerler: assistant		 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Evet
tür enum Nesnenin türü. Her zaman reasoning.

Olası değerler: reasoning		 Evet

Çıkış Mesajı

Modelden bir çıkış iletisi.

İsim Türü Açıklama Gerekli Varsayılan
içerik array Çıkış iletisinin içeriği.
 Evet
kimlik String Çıkış iletisinin benzersiz kimliği.
 Evet
rol enum Çıkış iletisinin rolü. Her zaman assistant.

Olası değerler: assistant		 Evet
statü enum İleti girişinin durumu. in_progress, completedveya incomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.

Olası değerler: in_progress, completed, incomplete		 Evet
tür enum Çıkış iletisinin türü. Her zaman message.

Olası değerler: message		 Evet

Çıktı Metni

Modelden bir metin çıktısı.

İsim Türü Açıklama Gerekli Varsayılan
Açıklamalar array Metin çıkışının ek açıklamaları.
 Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Modelden metin çıkışı.
 Evet
tür enum Çıkış metninin türü. Her zaman output_text.

Olası değerler: output_text		 Evet

GerçekZamanlıOturumOluşturmaİsteği

Gerçek zamanlı oturum nesnesi yapılandırması.

İsim Türü Açıklama Gerekli Varsayılan
giriş_ses_formatı enum Giriş sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
pcm16 için, giriş sesi 24kHz örnekleme hızında, 16 bit PCM, tek kanallı (mono) ve küçük endian bayt düzeninde olmalıdır.

Olası değerler: pcm16, g711_ulaw, g711_alaw		 Hayı
giriş_ses_gürültü_azaltma object Giriş ses gürültüsünü azaltma yapılandırması. Bu, kapatmak için null olarak ayarlanabilir.
Gürültü azaltma, VAD'ye ve modele gönderilmeden önce giriş ses arabelleğine eklenen sesi filtreler.
Sesi filtrelemek, giriş sesinin algısını geliştirerek VAD ve dönüş algılama doğruluğunu (hatalı pozitifleri azaltma) ve model performansını geliştirebilir.
 Hayı
└─ türü enum Gürültü azaltma türü. near_field kulaklık gibi yakın konuşan mikrofonlar için, far_field dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.

Olası değerler: near_field, far_field		 Hayı
giriş_ses_dönüşümü object Giriş ses transkripsiyonu yapılandırması, varsayılan olarak kapalıdır ve kapatılmak için null olarak ayarlanabilir. Giriş ses transkripsiyonu modelde yerel değildir, çünkü model doğrudan ses tüketir. Transkripsiyon Transkripsiyon uç noktası üzerinden eşzamansız olarak çalışır ve modelin tam olarak duyduklarından ziyade giriş ses içeriğine rehberlik etmek için kullanılmalıdır. İstemci isteğe bağlı olarak dili ayarlayabilir ve transkripsiyon isteyebilir, bunlar transkripsiyon hizmetine ek rehberlik sunar.
 Hayı
└─ dili String Giriş sesinin dili. Giriş dilini ISO-639-1 (ör. en) biçiminde sağlamak doğruluğu ve gecikme süresini artırır.
 Hayı
└─ model String Transkripsiyon için kullanılacak model, geçerli seçenekler , gpt-4o-transcribeve gpt-4o-mini-transcribeşeklindedirwhisper-1.
 Hayı
└─ istemi String Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin.
için whisper-1, istem anahtar sözcüklerin listesidir.
Modeller için gpt-4o-transcribe istem, "teknolojiyle ilgili sözcükleri bekleme" gibi bir serbest metin dizesidir.
 Hayı
talimatlar String Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örn. "son derece kısa", "kolay davran", "iyi yanıt örnekleri" ve ses davranışı (örneğin, "hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar.

Sunucunun, bu alan ayarlı değilse kullanılacak varsayılan yönergeleri ayarladığını ve oturumun session.created başındaki olayda görünür olduğunu unutmayın.
 Hayı
Maksimum yanıt çıktı birimleri (max_response_output_tokens) tamsayı veya dize Araç çağrıları dahil olmak üzere tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı. Çıkış belirteçlerini sınırlamak için 1 ile 4096 arasında bir tamsayı veya inf belirli bir model için kullanılabilir en yüksek belirteçleri sağlayın. Varsayılan olarak inf değerini alır.
 Hayı
kalıcılıklar Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.
 Hayı
örnek String Bu oturum için kullanılan dağıtımın adı.
 Hayı
çıkış_ses_formatı enum Çıkış sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
için pcm16çıkış sesi 24kHz hızında örneklendirilir.

Olası değerler: pcm16, g711_ulaw, g711_alaw		 Hayı
sıcaklık Numara [0,6, 1,2] ile sınırlı olan model için örnekleme sıcaklığı. Ses modellerinde en iyi performans için 0,8 sıcaklık önerilir.
 Hayı 0.8
araç seçimi String Modelin araçları seçme şekli. Seçenekler , autonone, requiredveya bir işlev belirtir.
 Hayı Otomatik
araçlar array Modelde kullanılabilen araçlar (işlevler). Hayı
dönüş algılama object Dönüş algılama, ether Server VAD veya Semantik VAD için yapılandırma. Bu, kapatmak için null olarak ayarlanabilir; bu durumda istemci model yanıtını manuel olarak tetiklemelidir.
Sunucu VAD, modelin ses ses düzeyine göre konuşmanın başlangıç ve bitişini algılayıp kullanıcı konuşmasının sonunda yanıt vereceği anlamına gelir.
Anlamsal VAD daha gelişmiştir ve kullanıcının konuşmayı bitirip bitirmediğini anlamsal olarak tahmin etmek için bir dönüş algılama modeli (VAD ile birlikte) kullanır, ardından dinamik olarak bu olasılığa göre bir zaman aşımı ayarlar. Örneğin, kullanıcı sesi uhhm ile kesildiğinde, model dönüşün sona erme olasılığını düşük olarak değerlendirir ve kullanıcının konuşmaya devam etmesi için daha uzun süre bekler. Bu, daha doğal konuşmalar için yararlı olabilir, ancak gecikme süresi daha yüksek olabilir.
 Hayı
└─ yanıt_oluştur Boolean VAD durdurma olayı gerçekleştiğinde otomatik olarak yanıt oluşturulup oluşturulmayacağı.
 Hayı Doğru
└─ isteklilik enum semantic_vad modu için yalnızca kullanılır. Modelin yanıt verme istekliliği. low kullanıcının konuşmaya devam etmesi için daha uzun süre bekler, high daha hızlı yanıt verir. auto varsayılan değerdir ve ile mediumeşdeğerdir.

Olası değerler: low, medium, high, auto		 Hayı
└─ interrupt_response (kesinti_cevabı) Boolean VAD başlatma olayı gerçekleştiğinde, devam eden yanıtların varsayılan konuşmanın (örneğin conversation , öğesinin auto) çıkışıyla otomatik olarak kesintiye uğratılıp kesilmeyeceği.
 Hayı Doğru
└─ ön_ek_yastıklama_ms tamsayı server_vad modu için yalnızca kullanılır. VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden). Varsayılan değer 300ms'tir.
 Hayı
└─ sessizlik_süresi_ms tamsayı server_vad modu için yalnızca kullanılır. Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Varsayılan değer 500ms'tir. Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.
 Hayı
└─ eşik Numara server_vad modu için yalnızca kullanılır. VAD için etkinleştirme eşiği (0,0 - 1,0), bu varsayılan olarak 0,5'tir. Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.
 Hayı
└─ türü enum Dönüş algılama türü.

Olası değerler: server_vad, semantic_vad		 Hayı
ses VoiceIdsShared Hayı

RealtimeSessionCreateResponse

Geçici anahtarla yeni bir gerçek zamanlı oturum yapılandırması. Anahtarlar için varsayılan TTL bir dakikadır.

İsim Türü Açıklama Gerekli Varsayılan
istemci_sırrı object API tarafından döndürülen kısa ömürlü anahtar. Evet
└─ sona_erme_tarihi tamsayı Belirtecin süresinin dolmasına ilişkin zaman damgası. Şu anda tüm jetonlar bir dakika sonra süresi doluyor.
 Hayı
└─ değer String gerçek zamanlı API bağlantılarının kimliğini doğrulamak için istemci ortamlarında kullanılabilir kısa ömürlü anahtar. Bunu yalnızca sunucu tarafında kullanılması gereken standart API belirteci yerine istemci tarafı ortamlarında kullanın.
 Hayı
giriş_ses_formatı String Giriş sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
 Hayı
giriş_ses_dönüşümü object Giriş ses transkripsiyonu yapılandırması, varsayılan olarak kapalıdır ve kapatılmak için null olarak ayarlanabilir. Giriş ses transkripsiyonu modelde yerel değildir, çünkü model doğrudan ses tüketir. Transkripsiyon, Whisper aracılığıyla asenkron olarak çalışır ve modelin anladığı şekil yerine kaba bir kılavuz olarak değerlendirilmelidir.
 Hayı
└─ model String Transkripsiyon için kullanılacak model, whisper-1 şu anda desteklenen tek modeldir.
 Hayı
talimatlar String Varsayılan sistem talimatları (sistem iletisi), model çağrılarına önceden eklenir. Bu alan, istemcinin istenen yanıtlarda modele yol göstermesine olanak tanır. Modele yanıt içeriği ve biçimi (örn. "son derece kısa", "kolay davran", "iyi yanıt örnekleri" gibi) ve ses davranışı (örn. "hızlı konuşma", "sesinize duygu ekleme", "sık sık gülme") hakkında bilgi verilebilir. Yönergelerin model tarafından takip edilmesi garanti değildir, ancak istenen davranışla ilgili modele rehberlik sağlar.
Sunucunun, bu alan ayarlı değilse kullanılacak varsayılan yönergeleri ayarladığını ve oturumun session.created başındaki olayda görünür olduğunu unutmayın.
 Hayı
Maksimum yanıt çıktı birimleri (max_response_output_tokens) tamsayı veya dize Araç çağrıları dahil olmak üzere tek bir yardımcı yanıtı için en fazla çıkış belirteci sayısı. Çıkış belirteçlerini sınırlamak için 1 ile 4096 arasında bir tamsayı veya inf belirli bir model için kullanılabilir en yüksek belirteçleri sağlayın. Varsayılan olarak inf değerini alır.
 Hayı
kalıcılıklar Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.
 Hayı
çıkış_ses_formatı String Çıkış sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
 Hayı
sıcaklık Numara [0,6, 1,2] ile sınırlı olan model için örnekleme sıcaklığı. Varsayılan değer 0,8'tir.
 Hayı
araç seçimi String Modelin araçları seçme şekli. Seçenekler , autonone, requiredveya bir işlev belirtir.
 Hayı
araçlar array Modelde kullanılabilen araçlar (işlevler). Hayı
dönüş algılama object Dönüş algılama yapılandırması. Kapatmak için null olarak ayarlanabilir. Sunucu VAD, modelin ses ses düzeyine göre konuşmanın başlangıç ve bitişini algılayıp kullanıcı konuşmasının sonunda yanıt vereceği anlamına gelir.
 Hayı
└─ ön_ek_yastıklama_ms tamsayı VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden). Varsayılan değer 300ms'tir.
 Hayı
└─ sessizlik_süresi_ms tamsayı Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Varsayılan değer 500ms'tir. Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.
 Hayı
└─ eşik Numara VAD için etkinleştirme eşiği (0,0 - 1,0), bu varsayılan olarak 0,5'tir. Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.
 Hayı
└─ türü String Dönüş algılama türü, yalnızca server_vad şu anda desteklenmektedir.
 Hayı
ses VoiceIdsShared Hayı

RealtimeTranscriptionSessionCreateRequest (Gerçek Zamanlı Transkripsiyon Oturumu Oluşturma İsteği)

Gerçek zamanlı transkripsiyon oturumu nesne yapılandırması.

İsim Türü Açıklama Gerekli Varsayılan
içermek array Transkripsiyona eklenecek öğe kümesi. Geçerli kullanılabilir öğeler şunlardır:
- item.input_audio_transcription.logprobs
 Hayı
giriş_ses_formatı enum Giriş sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
pcm16 için, giriş sesi 24kHz örnekleme hızında, 16 bit PCM, tek kanallı (mono) ve küçük endian bayt düzeninde olmalıdır.

Olası değerler: pcm16, g711_ulaw, g711_alaw		 Hayı
giriş_ses_gürültü_azaltma object Giriş ses gürültüsünü azaltma yapılandırması. Bu, kapatmak için null olarak ayarlanabilir.
Gürültü azaltma, VAD'ye ve modele gönderilmeden önce giriş ses arabelleğine eklenen sesi filtreler.
Sesi filtrelemek, giriş sesinin algısını geliştirerek VAD ve dönüş algılama doğruluğunu (hatalı pozitifleri azaltma) ve model performansını geliştirebilir.
 Hayı
└─ türü enum Gürültü azaltma türü. near_field kulaklık gibi yakın konuşan mikrofonlar için, far_field dizüstü bilgisayar veya konferans odası mikrofonları gibi uzak alan mikrofonları içindir.

Olası değerler: near_field, far_field		 Hayı
giriş_ses_dönüşümü object Giriş ses transkripsiyonu yapılandırması. İstemci isteğe bağlı olarak dili ayarlayabilir ve transkripsiyon isteyebilir, bunlar transkripsiyon hizmetine ek rehberlik sunar.
 Hayı
└─ dili String Giriş sesinin dili. Giriş dilini ISO-639-1 (ör. en) biçiminde sağlamak doğruluğu ve gecikme süresini artırır.
 Hayı
└─ model enum Transkripsiyon için kullanılacak model, geçerli seçenekler , gpt-4o-transcribeve gpt-4o-mini-transcribeşeklindedirwhisper-1.

Olası değerler: gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1		 Hayı
└─ istemi String Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin.
için whisper-1, istem anahtar sözcüklerin listesidir.
Modeller için gpt-4o-transcribe istem, "teknolojiyle ilgili sözcükleri bekleme" gibi bir serbest metin dizesidir.
 Hayı
kalıcılıklar Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.
 Hayı
dönüş algılama object Dönüş algılama, ether Server VAD veya Semantik VAD için yapılandırma. Bu, kapatmak için null olarak ayarlanabilir; bu durumda istemci model yanıtını manuel olarak tetiklemelidir.
Sunucu VAD, modelin ses ses düzeyine göre konuşmanın başlangıç ve bitişini algılayıp kullanıcı konuşmasının sonunda yanıt vereceği anlamına gelir.
Anlamsal VAD daha gelişmiştir ve kullanıcının konuşmayı bitirip bitirmediğini anlamsal olarak tahmin etmek için bir dönüş algılama modeli (VAD ile birlikte) kullanır, ardından dinamik olarak bu olasılığa göre bir zaman aşımı ayarlar. Örneğin, kullanıcı sesi uhhm ile kesildiğinde, model dönüşün sona erme olasılığını düşük olarak değerlendirir ve kullanıcının konuşmaya devam etmesi için daha uzun süre bekler. Bu, daha doğal konuşmalar için yararlı olabilir, ancak gecikme süresi daha yüksek olabilir.
 Hayı
└─ yanıt_oluştur Boolean VAD durdurma olayı gerçekleştiğinde otomatik olarak yanıt oluşturulup oluşturulmayacağı. Transkripsiyon oturumları için kullanılamaz.
 Hayı Doğru
└─ isteklilik enum semantic_vad modu için yalnızca kullanılır. Modelin yanıt verme istekliliği. low kullanıcının konuşmaya devam etmesi için daha uzun süre bekler, high daha hızlı yanıt verir. auto varsayılan değerdir ve ile mediumeşdeğerdir.

Olası değerler: low, medium, high, auto		 Hayı
└─ interrupt_response (kesinti_cevabı) Boolean VAD başlatma olayı gerçekleştiğinde, devam eden yanıtların varsayılan konuşmanın (örneğin conversation , öğesinin auto) çıkışıyla otomatik olarak kesintiye uğratılıp kesilmeyeceği. Transkripsiyon oturumları için kullanılamaz.
 Hayı Doğru
└─ ön_ek_yastıklama_ms tamsayı server_vad modu için yalnızca kullanılır. VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden). Varsayılan değer 300ms'tir.
 Hayı
└─ sessizlik_süresi_ms tamsayı server_vad modu için yalnızca kullanılır. Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Varsayılan değer 500ms'tir. Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.
 Hayı
└─ eşik Numara server_vad modu için yalnızca kullanılır. VAD için etkinleştirme eşiği (0,0 - 1,0), bu varsayılan olarak 0,5'tir. Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.
 Hayı
└─ türü enum Dönüş algılama türü.

Olası değerler: server_vad, semantic_vad		 Hayı

RealtimeTranscriptionSessionCreateResponse

Yeni bir Gerçek zamanlı transkripsiyon oturumu yapılandırması.

SUNUCUDA REST API aracılığıyla bir oturum oluşturulduğunda, oturum nesnesi kısa ömürlü bir anahtar da içerir. Anahtarlar için varsayılan TTL bir dakikadır. WebSocket API'si aracılığıyla bir oturum güncelleştirildiğinde bu özellik mevcut değildir.

İsim Türü Açıklama Gerekli Varsayılan
istemci_sırrı object API tarafından döndürülen kısa ömürlü anahtar. Yalnızca rest API aracılığıyla sunucuda oturum oluşturulduğunda sunulur.
 Evet
└─ sona_erme_tarihi tamsayı Belirtecin süresinin dolmasına ilişkin zaman damgası. Şu anda tüm jetonlar bir dakika sonra süresi doluyor.
 Hayı
└─ değer String gerçek zamanlı API bağlantılarının kimliğini doğrulamak için istemci ortamlarında kullanılabilir kısa ömürlü anahtar. Bunu yalnızca sunucu tarafında kullanılması gereken standart API belirteci yerine istemci tarafı ortamlarında kullanın.
 Hayı
giriş_ses_formatı String Giriş sesinin biçimi. Seçenekler , pcm16veya g711_ulawşeklindedirg711_alaw.
 Hayı
giriş_ses_dönüşümü object Transkripsiyon modelinin yapılandırması.
 Hayı
└─ dili String Giriş sesinin dili. Giriş dilini ISO-639-1 (ör. en) biçiminde sağlamak doğruluğu ve gecikme süresini artırır.
 Hayı
└─ model enum Transkripsiyon için kullanılacak model. , gpt-4o-transcribeveya gpt-4o-mini-transcribeolabilirwhisper-1.

Olası değerler: gpt-4o-transcribe, gpt-4o-mini-transcribe, whisper-1		 Hayı
└─ istemi String Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir.
 Hayı
kalıcılıklar Modelin yanıt verebileceği modalite kümesi. Sesi devre dışı bırakmak için bunu ["text"] olarak ayarlayın.
 Hayı
dönüş algılama object Dönüş algılama yapılandırması. Kapatmak için null olarak ayarlanabilir. Sunucu VAD, modelin ses ses düzeyine göre konuşmanın başlangıç ve bitişini algılayıp kullanıcı konuşmasının sonunda yanıt vereceği anlamına gelir.
 Hayı
└─ ön_ek_yastıklama_ms tamsayı VAD konuşma algılamadan önce eklenecek ses miktarı (milisaniye cinsinden). Varsayılan değer 300ms'tir.
 Hayı
└─ sessizlik_süresi_ms tamsayı Konuşma durdurmayı algılamak için sessizlik süresi (milisaniye cinsinden). Varsayılan değer 500ms'tir. Daha kısa değerlerle model daha hızlı yanıt verir, ancak kullanıcı kısa durakladığında araya girebilir.
 Hayı
└─ eşik Numara VAD için etkinleştirme eşiği (0,0 - 1,0), bu varsayılan olarak 0,5'tir. Daha yüksek bir eşik, modeli etkinleştirmek için daha yüksek ses gerektirir ve bu nedenle gürültülü ortamlarda daha iyi performans gösterebilir.
 Hayı
└─ türü String Dönüş algılama türü, yalnızca server_vad şu anda desteklenmektedir.
 Hayı

Mantık yürütme

yalnızca o serisi modeller

Mantık modelleri için yapılandırma seçenekleri.

İsim Türü Açıklama Gerekli Varsayılan
çaba ReasoningEffort yalnızca o serisi modeller

Mantıp modelleri için mantık yürütme çabasını kısıtlar.
Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.
 Evet orta
özet enum yalnızca o serisi modeller

Model tarafından gerçekleştirilen mantığın özeti. Bu, hata ayıklama ve modelin akıl yürütme işlemini anlamak için yararlı olabilir.
veya concise'nin detailed biri.

Olası değerler: concise, detailed		 Hayı

Akıl Yürütme Öğesi

Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması.

İsim Türü Açıklama Gerekli Varsayılan
içerik array Metin içeriğini muhakeme etme.
 Evet
kimlik String Akıl yürütme içeriğinin benzersiz tanımlayıcısı.
 Evet
statü enum Öğenin durumu. in_progress, completedveya incomplete. Öğeler API aracılığıyla döndürülürken doldurulur.

Olası değerler: in_progress, completed, incomplete		 Hayı
tür enum Nesnenin türü. Her zaman reasoning.

Olası değerler: reasoning		 Evet

Ret

Model tarafından reddedilme.

İsim Türü Açıklama Gerekli Varsayılan
Ret String Modelin sunduğu reddetme gerekçesi.
 Evet
tür enum Reddetmenin türü. Her zaman refusal.

Olası değerler: refusal		 Evet

yanıt

İsim Türü Açıklama Gerekli Varsayılan
oluşturulma_tarihi Numara Bu Yanıtın oluşturulduğu unix zaman damgası (saniye).
 Evet
hata ResponseError Model yanıt oluşturamadığında döndürülen bir hata nesnesi.
 Evet
kimlik String Bu Yanıt için benzersiz tanımlayıcı.
 Evet
eksik_bilgiler object Yanıtın neden eksik olduğuna ilişkin ayrıntılar.
 Evet
└─ neden enum Yanıtın tamamlanmamış olmasının nedeni.
Olası değerler: max_output_tokens, content_filter		 Hayı
talimatlar String Model bağlamında ilk öğe olarak bir sistem (veya geliştirici) iletisi ekler.

ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.
 Evet
maksimum_çıktı_birimleri tamsayı Görünür çıkış belirteçleri ve konuşma durumu da dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.
 Hayı
meta veriler Meta veriler Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir.

Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.
 Evet
örnek String Yanıtları oluşturmak için kullanılan model. Evet
object enum Bu kaynağın nesne türü - her zaman response olarak ayarlanır.

Olası değerler: response		 Evet
çıktı array Model tarafından oluşturulan içerik öğeleri dizisi.

- Dizideki output öğelerin uzunluğu ve sırası modelin yanıtına bağlıdır.
- Dizideki output ilk öğeye erişmek ve bunun model tarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsaymak yerine SDK'larda desteklenen özelliğini kullanmayı output_text düşünebilirsiniz.
 Evet
çıktı_metni String SDK özellikli yalnızca kolaylık sağlayan bir özellik olan, varsa dizideki tüm output_text öğelerinin metin çıktılarını bir araya getiren output içeren özellik.
Python ve JavaScript SDK'larında desteklenir.
 Hayı
paralel araç çağrıları Boolean Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği.
 Evet Doğru
önceki_cevap_id String Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın. Hayı
muhakeme Muhakeme yalnızca o serisi modeller

Mantık modelleri için yapılandırma seçenekleri.
 Hayı
statü enum Yanıt oluşturma durumu. completed, , failedin_progressveya incomplete.

Olası değerler: completed, failed, in_progress, incomplete		 Hayı
sıcaklık Numara 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz.
 Evet 1
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. object Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir. Daha fazla bilgi edinin:
- metin girişleri ve çıkışları
- Şekillendirilmiş Çıktılar
 Hayı
└─ biçimi TextResponseFormatConfiguration Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.
 Hayı
araç seçimi ToolChoiceOptions veya ToolChoiceTypes veya ToolChoiceFunction Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.
 Evet
araçlar array Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz.

Modeli sağlayabileceğiniz iki araç kategorisi şunlardır:

- Yerleşik araçlar		 Evet
top_p Numara Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz.
 Evet 1
Kısaltma enum Model yanıtı için kullanılacak kesme stratejisi.
- auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir.
- disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur.

Olası değerler: auto, disabled		 Hayı
kullanım Yanıt Kullanımı Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.
 Hayı
kullanıcı String OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. .
 Hayı

ResponseAudioDeltaEvent

Kısmi bir ses yanıtı olduğunda yayılır.

İsim Türü Açıklama Gerekli Varsayılan
delta String Base64 kodlanmış yanıt ses baytlarının bir öbeği.
 Evet
tür enum Olayın türü. Her zaman response.audio.delta.

Olası değerler: response.audio.delta		 Evet

YanıtSesTamamEtkinliği

Ses yanıtı tamamlandığında gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Olayın türü. Her zaman response.audio.done.

Olası değerler: response.audio.done		 Evet

ResponseAudioTranscriptDeltaEvent

Sesin kısmi bir transkripti olduğunda yayılır.

İsim Türü Açıklama Gerekli Varsayılan
delta String Ses yanıtının kısmi transkripti.
 Evet
tür enum Olayın türü. Her zaman response.audio.transcript.delta.

Olası değerler: response.audio.transcript.delta		 Evet

YanıtSesliTranskriptTamamlandıOlayı

Tam ses transkripti tamamlandığında gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Olayın türü. Her zaman response.audio.transcript.done.

Olası değerler: response.audio.transcript.done		 Evet

YanıtKoduYorumlayıcıÇağrıKoduDeltaOlayı

Kısmi bir kod parçacığı kod yorumlayıcı tarafından eklendiğinde oluşturulur.

İsim Türü Açıklama Gerekli Varsayılan
delta String Kod yorumlayıcısı tarafından eklenen kısmi kod parçacığı.
 Evet
çıktı_endeksi tamsayı Kod yorumlayıcı çağrısının devam etmekte olduğu çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.code_interpreter_call.code.delta.

Olası değerler: response.code_interpreter_call.code.delta		 Evet

YanıtKoduYorumlayıcıAramaKodTamamlandıOlayı

Kod parçacığı çıkışı kod yorumlayıcı tarafından tamamlandığında tetiklenir.

İsim Türü Açıklama Gerekli Varsayılan
kod String Kod yorumlayıcısı tarafından son kod parçacığı çıkışı.
 Evet
çıktı_endeksi tamsayı Kod yorumlayıcı çağrısının devam etmekte olduğu çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.code_interpreter_call.code.done.

Olası değerler: response.code_interpreter_call.code.done		 Evet

ResponseCodeInterpreterCallCompletedEvent

Kod yorumlayıcı çağrısı tamamlandığında gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
kod yorumlayıcı çağrısı CodeInterpreterToolCall Kodu çalıştırmak için bir araç çağrısı.
 Evet
çıktı_endeksi tamsayı Kod yorumlayıcı çağrısının devam etmekte olduğu çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.code_interpreter_call.completed.

Olası değerler: response.code_interpreter_call.completed		 Evet

ResponseCodeInterpreterCallInProgressEvent

Bir kod yorumlayıcı çağrısı sırasında tetiklenir.

İsim Türü Açıklama Gerekli Varsayılan
kod yorumlayıcı çağrısı CodeInterpreterToolCall Kodu çalıştırmak için bir araç çağrısı.
 Evet
çıktı_endeksi tamsayı Kod yorumlayıcı çağrısının devam etmekte olduğu çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.code_interpreter_call.in_progress.

Olası değerler: response.code_interpreter_call.in_progress		 Evet

YanıtKoduYorumlayıcıÇağırmaYorumlamaEtkinliği

Kod yorumlayıcısı kod parçacığını etkin bir şekilde yorumladığında yayılır.

İsim Türü Açıklama Gerekli Varsayılan
kod yorumlayıcı çağrısı CodeInterpreterToolCall Kodu çalıştırmak için bir araç çağrısı.
 Evet
çıktı_endeksi tamsayı Kod yorumlayıcı çağrısının devam etmekte olduğu çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.code_interpreter_call.interpreting.

Olası değerler: response.code_interpreter_call.interpreting		 Evet

YanıtTamamlandıEtkinliği

Model yanıtı tamamlandığında gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
yanıt yanıt Evet
tür enum Olayın türü. Her zaman response.completed.

Olası değerler: response.completed		 Evet

YanıtİçeriğiParçasıEklendiOlayı

Yeni bir içerik bölümü eklendiğinde gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
içerik_dizini tamsayı Eklenen içerik bölümünün dizini.
 Evet
item_id String İçerik bölümünün eklendiği çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı İçerik bölümünün eklendiği çıkış öğesinin dizini.
 Evet
bölümü OutputContent Evet
tür enum Olayın türü. Her zaman response.content_part.added.

Olası değerler: response.content_part.added		 Evet

YanıtİçerikParçasıTamamlandıOlayı

İçerik bölümü tamamlandığında gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
içerik_dizini tamsayı Tamamlanan içerik bölümünün dizini.
 Evet
item_id String İçerik bölümünün eklendiği çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı İçerik bölümünün eklendiği çıkış öğesinin dizini.
 Evet
bölümü OutputContent Evet
tür enum Olayın türü. Her zaman response.content_part.done.

Olası değerler: response.content_part.done		 Evet

YanıtOluşturulduOlayı

Bir yanıt oluşturulduğunda yayılan bir olay.

İsim Türü Açıklama Gerekli Varsayılan
yanıt yanıt Evet
tür enum Olayın türü. Her zaman response.created.

Olası değerler: response.created		 Evet

YanıtHatası

Model yanıt oluşturamadığında döndürülen bir hata nesnesi.

İsim Türü Açıklama Gerekli Varsayılan
kod ResponseErrorCode Yanıtın hata kodu.
 Evet
mesaj String Hatanın insan tarafından okunabilen açıklaması.
 Evet

YanıtHataKodu

Yanıtın hata kodu.

Mülkiyet Değer
Açıklama Yanıtın hata kodu.
Türü String
Değerler server_error
rate_limit_exceeded
invalid_prompt
vector_store_timeout
invalid_image
invalid_image_format
invalid_base64_image
invalid_image_url
image_too_large
image_too_small
image_parse_error
image_content_policy_violation
invalid_image_mode
image_file_too_large
unsupported_image_media_type
empty_image_file
failed_to_download_image
image_file_not_found

Yanıt Hatası Olayı

Bir hata oluştuğunda yayılır.

İsim Türü Açıklama Gerekli Varsayılan
kod String Hata kodu.
 Evet
mesaj String Hata iletisi.
 Evet
param String Hata parametresi.
 Evet
tür enum Olayın türü. Her zaman error.

Olası değerler: error		 Evet

YanıtBaşarısızOlduOlayı

Yanıt başarısız olduğunda yayılan bir olay.

İsim Türü Açıklama Gerekli Varsayılan
yanıt yanıt Evet
tür enum Olayın türü. Her zaman response.failed.

Olası değerler: response.failed		 Evet

YanıtDosyaAramaÇağrısıTamamlandıOlayı

Bir dosya arama çağrısı tamamlandığında (sonuçlar bulundu) yayılır.

İsim Türü Açıklama Gerekli Varsayılan
item_id String Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.file_search_call.completed.

Olası değerler: response.file_search_call.completed		 Evet

ResponseFileSearchCallInProgressEvent

Bir dosya arama çağrısı başlatıldığında gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
item_id String Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.file_search_call.in_progress.

Olası değerler: response.file_search_call.in_progress		 Evet

YanıtDosyaAramaÇağrıAramaOlayı

Bir dosya araması sırasında arama yapıldığında tetiklenir.

İsim Türü Açıklama Gerekli Varsayılan
item_id String Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Dosya arama çağrısının arama yaptığı çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.file_search_call.searching.

Olası değerler: response.file_search_call.searching		 Evet

YanıtFonksiyonuÇağrıArgümanlarıDeltaOlayı

Kısmi işlev çağrısı bağımsız değişkenleri delta olduğunda yayılır.

İsim Türü Açıklama Gerekli Varsayılan
delta String Fonksiyon çağrısı argümanlarına eklenen delta.
 Evet
item_id String delta işlev çağrısı bağımsız değişkenlerinin eklendiği çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı İşlev çağrısı bağımsız değişkenlerinin delta'sının toplandığı çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.function_call_arguments.delta.

Olası değerler: response.function_call_arguments.delta		 Evet

YanıtFonksiyonÇağrıArgümanlarıTamamlandıEtkinliği

İşlev çağrısı bağımsız değişkenleri sonlandırıldığında verilir.

İsim Türü Açıklama Gerekli Varsayılan
Argümanlar String İşlev çağrısı için argümanlar. Evet
item_id String Öğenin kimliği. Evet
çıktı_endeksi tamsayı Çıkış öğesinin dizini. Evet
tür enum
Olası değerler: response.function_call_arguments.done		 Evet

Yanıt Devam Ediyor Etkinliği

Yanıt devam ederken gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
yanıt yanıt Evet
tür enum Olayın türü. Her zaman response.in_progress.

Olası değerler: response.in_progress		 Evet

YanıtTamamlanmamışOlay

Yanıt eksik olduğunda yayılan bir olay.

İsim Türü Açıklama Gerekli Varsayılan
yanıt yanıt Evet
tür enum Olayın türü. Her zaman response.incomplete.

Olası değerler: response.incomplete		 Evet

yanıtÖğeListesi

Yanıt öğelerinin listesi.

İsim Türü Açıklama Gerekli Varsayılan
veriler array Bu yanıtı oluşturmak için kullanılan öğelerin listesi. Evet
ilk_kimlik String Listedeki ilk öğenin kimliği. Evet
daha_fazla Boolean Kullanılabilir daha fazla öğe olup olmadığı. Evet
son_kimlik String Listedeki son öğenin kimliği. Evet
object enum Döndürülen nesnenin türü olmalıdır list.
Olası değerler: list		 Evet

Yanıt Modaliteleri

Modelin oluşturmasını istediğiniz çıkış türleri. Çoğu model, varsayılan olan metin oluşturabilir:

["text"]

Model gpt-4o-audio-preview ses oluşturmak için de kullanılabilir. Bu modelin hem metin hem de ses yanıtları oluşturmasını istemek için şunları kullanabilirsiniz:

["text", "audio"]

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

Yanıt Yöntemleri Yalnızca Metin

Modelin oluşturmasını istediğiniz çıkış türleri. Çoğu model, varsayılan olan metin oluşturabilir:

["text"]

Bu API yakında ses ve görüntüler de dahil olmak üzere diğer çıkış yöntemlerini destekleyecektir.

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

YanıtÇıktıÖğesiEklendiOlayı

Yeni bir çıkış öğesi eklendiğinde gönderilir.

İsim Türü Açıklama Gerekli Varsayılan
öğe OutputItem Evet
çıktı_endeksi tamsayı Eklenen çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.output_item.added.

Olası değerler: response.output_item.added		 Evet

YanıtÇıktısıÖğeTamamlandıEtkinliği

Çıktı öğesi tamamlandı olarak işaretlendiğinde yayılır.

İsim Türü Açıklama Gerekli Varsayılan
öğe OutputItem Evet
çıktı_endeksi tamsayı Bitti olarak işaretlenen çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.output_item.done.

Olası değerler: response.output_item.done		 Evet

Yanıt Özellikleri

İsim Türü Açıklama Gerekli Varsayılan
talimatlar String Model bağlamında ilk öğe olarak bir sistem (veya geliştirici) iletisi ekler.

ile previous_response_idbirlikte kullanıldığında, önceki yanıttan alınan yönergeler sonraki yanıta taşınmaz. Bu, sistem (veya geliştirici) iletilerini yeni yanıtlarda değiştirme işlemini basitleştirir.
 Hayı
maksimum_çıktı_birimleri tamsayı Görünür çıkış belirteçleri ve konuşma durumu da dahil olmak üzere yanıt için oluşturulabilecek belirteç sayısı için üst sınır.
 Hayı
önceki_cevap_id String Modele önceki yanıtın benzersiz kimliği. Çok aşamalı konuşmalar oluşturmak için bunu kullanın. Hayı
muhakeme Muhakeme yalnızca o serisi modeller

Mantık modelleri için yapılandırma seçenekleri.
 Hayı
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. object Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir. Daha fazla bilgi edinin:
- metin girişleri ve çıkışları
- Şekillendirilmiş Çıktılar
 Hayı
└─ biçimi TextResponseFormatConfiguration Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.
 Hayı
araç seçimi ToolChoiceOptions veya ToolChoiceTypes veya ToolChoiceFunction Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.
 Hayı
araçlar array Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz.

Modeli sağlayabileceğiniz iki araç kategorisi şunlardır:

- Yerleşik araçlar		 Hayı
Kısaltma enum Model yanıtı için kullanılacak kesme stratejisi.
- auto: Bu yanıtın bağlamı ve öncekiler modelin bağlam penceresi boyutunu aşarsa, model konuşmanın ortasına giriş öğelerini bırakarak yanıtı bağlam penceresine uyacak şekilde kesecektir.
- disabled (varsayılan): Model yanıtı bir modelin bağlam penceresi boyutunu aşarsa istek 400 hatasıyla başarısız olur.

Olası değerler: auto, disabled		 Hayı

YanıtReddetmeDeltaOlayı

Kısmi bir reddetme metni olduğunda yayılır.

İsim Türü Açıklama Gerekli Varsayılan
içerik_dizini tamsayı Reddetme metninin eklendiği içerik bölümünün dizini.
 Evet
delta String Eklenen ret metni.
 Evet
item_id String Reddetme metninin eklendiği çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Reddetme metninin eklendiği çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.refusal.delta.

Olası değerler: response.refusal.delta		 Evet

YanıtReddetmeTamamlandıOlay

Reddeden metin sonlandırıldığında yayılır.

İsim Türü Açıklama Gerekli Varsayılan
içerik_dizini tamsayı Red metni kesinleştiren içerik bölümünün dizini.
 Evet
item_id String Sonlandırılan reddetme metninin ait olduğu çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Reddetme metninin sonlandırıldığı çıkış öğesinin dizini.
 Evet
Ret String Kesinleştirilen reddetme metni.
 Evet
tür enum Olayın türü. Her zaman response.refusal.done.

Olası değerler: response.refusal.done		 Evet

Yanıt Akış Etkinliği

İsim Türü Açıklama Gerekli Varsayılan
ek açıklama Ek Açıklama Evet
anotasyon_indeksi tamsayı Eklenen açıklamanın dizin numarası.
 Evet
Argümanlar String İşlev çağrısı için argümanlar. Evet
kod String Hata kodu.
 Evet
kod yorumlayıcı çağrısı CodeInterpreterToolCall Kodu çalıştırmak için bir araç çağrısı.
 Evet
içerik_dizini tamsayı Metin içeriğinin tamamlandığı içerik bölümünün dizini.
 Evet
delta String Eklenen metin deltası.
 Evet
öğe OutputItem Bitti olarak işaretlenen çıkış öğesi.
 Evet
item_id String Metin içeriğinin sonlandırıldığı çıkış öğesinin kimliği.
 Evet
mesaj String Hata iletisi.
 Evet
çıktı_endeksi tamsayı Son haline getirilen metin içeriğine ait çıktı öğesinin dizini.
 Evet
param String Hata parametresi.
 Evet
bölümü OutputContent Yapılan içerik bölümü.
 Evet
Ret String Kesinleştirilen reddetme metni.
 Evet
yanıt yanıt Tamamlanmamış yanıt.
 Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Son haline getirilmiş metin içeriği.
 Evet
tür enum Olayın türü. Her zaman response.output_text.done.

Olası değerler: response.output_text.done		 Evet

ResponseTextAnnotationDeltaEvent

Metin ek açıklaması eklendiğinde tetiklenir.

İsim Türü Açıklama Gerekli Varsayılan
ek açıklama Ek Açıklama Evet
anotasyon_indeksi tamsayı Eklenen açıklamanın dizin numarası.
 Evet
içerik_dizini tamsayı Metin açıklamasının eklendiği içerik bölümünün dizini.
 Evet
item_id String Metin ek açıklamasının eklendiği çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Metin ek açıklamasının eklendiği çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.output_text.annotation.added.

Olası değerler: response.output_text.annotation.added		 Evet

ResponseTextDeltaEvent

İlave bir metin deltası olduğunda oluşur.

İsim Türü Açıklama Gerekli Varsayılan
içerik_dizini tamsayı Metin deltasının eklendiği içerik bölümünün dizini.
 Evet
delta String Eklenen metin deltası.
 Evet
item_id String Metin deltasının eklendiği çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Metin deltasının eklendiği çıkış öğesinin dizini.
 Evet
tür enum Olayın türü. Her zaman response.output_text.delta.

Olası değerler: response.output_text.delta		 Evet

YanıtMetniTamamlandıEtkinliği

Metin içeriği sonlandırıldığında yayınlanır.

İsim Türü Açıklama Gerekli Varsayılan
içerik_dizini tamsayı Metin içeriğinin tamamlandığı içerik bölümünün dizini.
 Evet
item_id String Metin içeriğinin sonlandırıldığı çıkış öğesinin kimliği.
 Evet
çıktı_endeksi tamsayı Son haline getirilen metin içeriğine ait çıktı öğesinin dizini.
 Evet
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Son haline getirilmiş metin içeriği.
 Evet
tür enum Olayın türü. Her zaman response.output_text.done.

Olası değerler: response.output_text.done		 Evet

YanıtKullanımı

Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
giriş belirteçleri tamsayı Giriş belirteçlerinin sayısı. Evet
çıktı_jetonları tamsayı Çıkış belirteçlerinin sayısı. Evet
çıktı_jeton_detayları object Çıkış belirteçlerinin ayrıntılı dökümü. Evet
└─ akıl yürütme_tokenlar tamsayı Akıl yürütme belirteçlerinin sayısı. Hayı
toplam jetonlar tamsayı Kullanılan toplam belirteç sayısı. Evet

Ekran görüntüsü

Ekran görüntüsü alma işlemi.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Olay türünü belirtir. Ekran görüntüsü eylemi için bu özellik her zaman olarak screenshotayarlanır.

Olası değerler: screenshot		 Evet

Kaydır

Kaydırma eylemi.

İsim Türü Açıklama Gerekli Varsayılan
yatay kaydırma tamsayı Yatay kaydırma uzaklığı.
 Evet
kaydırma_y tamsayı Dikey kaydırma uzaklığı.
 Evet
tür enum Olay türünü belirtir. Kaydırma eylemi için bu özellik her zaman olarak scrollayarlanır.

Olası değerler: scroll		 Evet
x tamsayı Kaydırmanın gerçekleştiği x koordinatı.
 Evet
y tamsayı Kaydırmanın gerçekleştiği y koordinatı.
 Evet

Yapılandırmayı Durdur

API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi. Döndürülen metin durdurma sırasını içermez.

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

Metin Yanıtı Biçim Yapılandırması

Modelin çıkış yapması gereken biçimi belirten bir nesne.

Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir.

Varsayılan biçim { "type": "text" } ek seçenek yoktur.

gpt-4o ve daha yeni modeller için önerilmez:

ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğundan emin olan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.

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

MetinYanıtBiçimiJsonŞeması

JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır. Yapılandırılmış Çıkışlar hakkında daha fazla bilgi edinin.

İsim Türü Açıklama Gerekli Varsayılan
Açıklama String Yanıt formatının amacına ilişkin bir açıklama, modelin bu formatta nasıl yanıt vereceğini belirlemesi için kullanılır.
 Hayı
isim 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.
 Hayı
şema YanıtFormatJsonŞemaŞeması JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. Evet
Sıkı Boolean Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği.
True olarak ayarlanırsa, model her zaman alanda tanımlanan tam şemayı schema izler. strict trueolduğunda yalnızca bir JSON Şeması alt kümesi desteklenir.		 Hayı Yanlış
tür enum Tanımlanan yanıt biçiminin türü. Her zaman json_schema.
Olası değerler: json_schema		 Evet

Araç

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

Araç Seçim Fonksiyonu

Modeli belirli bir işlevi çağırmaya zorlamak için bu seçeneği kullanın.

İsim Türü Açıklama Gerekli Varsayılan
isim String Çağrılacak işlevin adı. Evet
tür enum İşlev çağrısı için türü her zaman functionşeklindedir.
Olası değerler: function		 Evet

Araç Seçenekleri

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.

Mülkiyet Değer
Açıklama 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.
Türü String
Değerler none
auto
required

Araç Tercih Türleri

Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Modelin kullanması gereken barındırılan araç türü. İzin verilen değerler şunlardır:
- file_search
- computer_use_preview

Olası değerler: file_search, computer_use_preview		 Evet

Türü

Metin yazmak için bir eylem.

İsim Türü Açıklama Gerekli Varsayılan
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Yazılacak metin.
 Evet
tür enum Olay türünü belirtir. Tür eylemi için bu özellik her zaman olarak typeayarlanır.

Olası değerler: type		 Evet

Vektör Depo Dosya Özelliklerini Güncelleme İsteği

İsim Türü Açıklama Gerekli Varsayılan
öznitelikler VectorStoreFileAttributes Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.
 Evet

URL Atıf

Model yanıtı oluşturmak için kullanılan bir web kaynağı alıntısı.

İsim Türü Açıklama Gerekli Varsayılan
bitiş_indeksi tamsayı İletideki URL alıntısının son karakterinin dizini.
 Evet
başlangıç_indeksi tamsayı İletideki URL alıntısının ilk karakterinin dizini.
 Evet
başlık String Web kaynağının başlığı.
 Evet
tür enum URL alıntısının türü. Her zaman url_citation.

Olası değerler: url_citation		 Evet
URL String Web kaynağının URL'si.
 Evet

VectorStoreFileAttributes

Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.

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

VectorStoreFileContentResponse

Vektör deposu dosyasının ayrıştırılmış içeriğini temsil eder.

İsim Türü Açıklama Gerekli Varsayılan
veriler array Dosyanın ayrıştırılmış içeriği. Evet
daha_fazla Boolean Getirebileceğiniz daha fazla içerik sayfası olup olmadığını gösterir. Evet
sonraki_sayfa String Varsa sonraki sayfanın belirteci. Evet
object enum Her zaman olan nesne türü vector_store.file_content.page
Olası değerler: vector_store.file_content.page		 Evet

Vektör Mağazası Arama Talebi

İsim Türü Açıklama Gerekli Varsayılan
filtreler ComparisonFilter veya CompoundFilter Dosya özniteliklerine göre uygulanacak bir filtre. Hayı
maks_sonuç_sayısı tamsayı Döndürülecek en fazla sonuç sayısı. Bu sayı 1 ile 50 (dahil) arasında olmalıdır. Hayı 10
soru dize veya dizi Arama için sorgu dizesi Evet
Sıralama_seçenekleri object Arama için derecelendirme seçenekleri. Hayı
└─ sıralama yapıcı enum Olası değerler: auto, default-2024-11-15 Hayı
└─ skor_eşiği Numara Hayı 0
sorguyu yeniden yaz Boolean Vektör araması için doğal dil sorgusunun yeniden yazıp yazılmayacağı. Hayı Yanlış

VectorStoreAramaSonucuİçerikNesnesi

İsim Türü Açıklama Gerekli Varsayılan
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. String Aramadan döndürülen metin içeriği. Evet
tür enum İçerik türü.
Olası değerler: text		 Evet

VectorMağazaAramaSonuçÖğesi

İsim Türü Açıklama Gerekli Varsayılan
öznitelikler VectorStoreFileAttributes Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.
 Evet
içerik array Dosyadan içerik öbekleri. Evet
dosya_kimlik String Vektör deposu dosyasının kimliği. Evet
Dosyaadı String Vektör deposu dosyasının adı. Evet
Puan Numara Sonuç için benzerlik puanı. Evet

VektörDepoAramaSonuçlarıSayfası

İsim Türü Açıklama Gerekli Varsayılan
veriler array Arama sonucu öğelerinin listesi. Evet
daha_fazla Boolean Getirilecek daha fazla sonuç olup olmadığını gösterir. Evet
sonraki_sayfa String Varsa sonraki sayfanın belirteci. Evet
object enum Her zaman olan nesne türü vector_store.search_results.page
Olası değerler: vector_store.search_results.page		 Evet
arama sorgusu array Evet

PaylaşılanSesKimlikleri

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

Dur

Bir bekleme eylemi.

İsim Türü Açıklama Gerekli Varsayılan
tür enum Olay türünü belirtir. Bir bekleme eylemi için bu özellik her zaman olarak waitayarlanır.

Olası değerler: wait		 Evet

Akıl Yürütme Çabası

yalnızca o serisi modeller

Mantıp modelleri için mantık yürütme çabasını kısıtlar. Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.

Mülkiyet Değer
Açıklama yalnızca o serisi modeller

Mantıp modelleri için mantık yürütme çabasını kısıtlar.
Şu anda desteklenen değerler , lowve medium'tirhigh. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.
Türü String
Varsayılan orta
Değerler low
medium
high

HataOlayı

Bir hata oluştuğunda oluşur. Bu, iç sunucu hatası veya zaman aşımı nedeniyle oluşabilir.

İsim Türü Açıklama Gerekli Varsayılan
veriler hata Evet
etkinlik String Evet

event Enum: ErrorEventEnum

Değer Açıklama
hata

TamamlananOlay

Bir akış sona erdiğinde gerçekleşir.

İsim Türü Açıklama Gerekli Varsayılan
veriler String Evet
etkinlik String Evet

event Enum: DoneEventEnum

Değer Açıklama
tamam

data Enum: DoneEventDataEnum

Değer Açıklama
[BITTI]

Sonraki Adımlar

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