Azure OpenAI Hizmeti REST API önizleme başvurusu

Makale
07/10/2024

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

API belirtimleri

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

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

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

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

Kimlik Doğrulaması

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

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

REST API sürümü oluşturma

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

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

Veri düzlemi çıkarımı

Makalenin geri kalanında Azure OpenAI veri düzlemi çıkarım belirtimi 2024-05-01-previewolan en son önizleme sürümü yer alır. Bu makale yardımcılar, iş parçacıkları ve vektör depoları gibi en son önizleme özelliklerine yönelik belgeler içerir.

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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	yol	Yes	Dize	Dağıtılan modelin dağıtım kimliği.
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Istemi	dize veya dizi	Dize veya dize dizisi olarak kodlanmış tamamlamaları oluşturmak için istemler. \|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. İzin verilen en büyük dize listesi boyutu 2.048'dir.	Hayır
max_tokens	integer	İsteminizin ve max_tokens belirteç sayısı modelin bağlam uzunluğunu aşamaz. Çoğu modelin bağlam uzunluğu 2.048 belirteçtir (4096'yı destekleyen en yeni modeller hariç). En az 0'a sahiptir.	Hayır	16
sıcaklık	Numara	Kullanılacak örnekleme sıcaklığı. Daha yüksek değerler, modelin daha fazla risk alması anlamına gelir. Daha yaratıcı uygulamalar için 0,9 ve iyi tanımlanmış yanıta sahip uygulamalar için 0 (maksimum örnekleme) deneyin. Genellikle bunu veya top_p değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
logit_bias	nesne	Varsayılan değer null'tır. 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. Metni belirteç kimliklerine dönüştürmek için bu belirteç oluşturucu aracını (hem GPT-2 hem de GPT-3 için çalışır) kullanabilirsiniz. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, \|endoftext\|> belirtecinin <oluşturulmasını önlemek için {"50256":-100} geçirebilirsiniz.	Hayır
kullanıcı	Dize	Kötüye kullanımı izlemeye ve algılamaya yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı	Hayır
n	integer	Her istem için kaç tamamlama oluşturulacağı. En az 1 ve en fazla 128 izin verilir. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. Dikkatli kullanın ve max_tokens ve durdurmak için makul ayarlara sahip olduğunuzdan emin olun.	Hayır	1
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 veri tarafından sonlandırılır: [DONE] iletisi.	Hayır	Yanlış
logprobs	integer	Günlük olasılıklarını büyük olasılıkla logprobs belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin logprobs 5 ise, API en olası 5 belirtecin listesini döndürür. API her zaman örneklenen belirtecin logprob'unu döndürür, bu nedenle yanıtta en fazla logprobs+1 öğesi olabilir. En az 0 ve en fazla 5 izin verilir.	Hayır	None
sonek	Dize	Eklenen metnin tamamlanmasından sonra gelen sonek.	Hayır
echo	boolean	Tamamlamaya ek olarak istemi geri yankıla	Hayır	Yanlış
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ır
completion_config	Dize		Hayır
presence_penalty	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayır	0
frequency_penalty	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayır	0
best_of	integer	sunucu tarafında best_of tamamlama 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ı denetler ve n döndürülecek sayısını belirtir- best_of n'den büyük olmalıdır. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. Dikkatli kullanın ve max_tokens ve durdurmak için makul ayarlara sahip olduğunuzdan emin olun. En fazla 128 değerine sahiptir.	Hayır

Yanıtlar

Adı	Tür	Açıklama	Zorunlu
id	string		Yes
nesne	string		Yes
Oluşturulan	integer		Yes
model	string		Yes
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	Hayır
Seçenek	dizi		Yes
kullanım	nesne		Hayır

Kullanım özellikleri

completion_tokens

Adı	Tür	Açıklama	Varsayılan
completion_tokens	Numara

prompt_tokens

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

total_tokens

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

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu
input	dize veya dizi	Eklemeleri almak için metin girin, dize olarak kodlandı. Tek bir istekte birden çok girişin eklemelerini almak için bir dizi dize geçirin. Her girişin uzunluğu 2.048 belirteci aşmamalıdır. Kod eklemediğiniz sürece, girişinizdeki yeni çizgileri (\n) tek bir boşlukla değiştirmenizi öneririz çünkü yeni satırlar mevcut olduğunda daha düşük sonuçlar gözlemledik.	Yes
kullanıcı	Dize	Kötüye kullanımı izlemeye ve algılamaya yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayır
input_type	Dize	kullanılacak ekleme aramasının giriş türü	Hayır
encoding_format	Dize	Eklemelerin döndürüleceği biçim. veya `base64`olabilir`float`. varsayılan değeridir `float`.	Hayır
boyutlar	integer	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde `text-embedding-3` desteklenir.	Hayır

Yanıtlar

Adı	Tür	Zorunlu
nesne	string	Yes
model	string	Yes
veriler	dizi	Yes
kullanım	nesne	Yes

Kullanım özellikleri

prompt_tokens

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

total_tokens

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

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-05-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.017537864,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Sohbet tamamlamaları - Oluşturma

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

Sohbet iletisi için tamamlama oluşturur

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	yol	Yes	Dize	Dağıtılan modelin dağıtım kimliği.
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz `top_p` ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz `temperature` ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
akış	boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	Hayır	Yanlış
durmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi.	Hayır
max_tokens	integer	Oluşturulan yanıt için izin verilen en fazla belirteç sayısı. Varsayılan olarak, modelin döndürebileceği belirteç sayısı olacaktır (4096 - istem belirteçleri).	Hayır	4096
presence_penalty	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayır	0
frequency_penalty	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayır	0
logit_bias	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir json nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.	Hayır
kullanıcı	Dize	Azure OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayır
iletiler	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi. Örnek Python kodu.	Hayır
data_sources	dizi	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.	Hayır
n	integer	Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri.	Hayır	1
tohum	integer	Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayır	0
logprobs	boolean	Çıkış belirteçlerinin günlük olasılıklarının döndürülmesi veya döndürülmemesi. True ise, içinde döndürülen `content` `message`her çıkış belirtecinin günlük olasılıklarını döndürür. Bu seçenek şu anda modelde `gpt-4-vision-preview` kullanılamıyor.	Hayır	Yanlış
top_logprobs	integer	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 5 arasında bir tamsayı. `logprobs` bu parametre kullanılıyorsa olarak ayarlanmalıdır `true` .	Hayır
response_format	nesne	Modelin çıkış yapması gereken biçimi belirten bir nesne. JSON modunu etkinleştirmek için kullanılır.	Hayır
araçlar	dizi	Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın.	Hayır
tool_choice	chatCompletionToolChoiceOption	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 `{"type": "function", "function": {"name": "my_function"}}` belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.	Hayır
işlevleri	dizi	yerine `tools`kullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayır
function_call	dize veya nesne	yerine `tool_choice`kullanım dışı bırakıldı. Modelin işlev çağrılarına nasıl yanıt vereceğini denetler. "none", modelin bir işlevi çağırmadığı ve son kullanıcıya yanıt verdiği anlamına gelir. "auto", modelin son kullanıcı 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. Hiçbir işlev mevcut olmadığında "hiçbiri" varsayılan değerdir. İşlevler varsa varsayılan değer "otomatik"tir.	Hayır

response_format özellikleri

Tür

Adı	Tür	Açıklama	Varsayılan
Tür	chatCompletionResponseFormat	ayarı `json_object` JSON modunu etkinleştirir. Bu, modelin oluşturduğu iletinin geçerli bir JSON olduğunu garanti eder.	text

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Hizmet kullanılamıyor

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-05-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 might the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-05-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=2024-05-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=2024-05-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 AML dizini için bir tamamlama oluşturur.

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_ml_index",
   "parameters": {
    "project_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}",
    "name": "gm-cars",
    "version": "5",
    "authentication": {
     "type": "access_token",
     "access_token": "{access-token}"
    }
   }
  }
 ]
}

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",
                "file_path": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intents": [
              "dog care"
            ]
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-05-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 Elasticsearch için bir tamamlama oluşturur.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-05-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=2024-05-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=2024-05-01-preview

Sesi giriş diline ayırır.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	yol	Yes	Dize	Fısıltı modelinin dağıtım kimliği.
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dosyası	Dize	Dökümü yapılan ses dosyası nesnesi.	Yes
Istemi	Dize	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir.	Hayır
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayır
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayır	0
dil	Dize	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayır
timestamp_granularities[]	dizi	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ır	['segment']

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-05-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=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	yol	Yes	Dize	Dağıtılan fısıltı modelinin dağıtım kimliği.
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

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

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-05-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=2024-05-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=2024-05-01-preview

Giriş metninden ses oluşturur.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	yol	Yes	Dize	Dağıtılan tts modelinin dağıtım kimliği.
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
giriş	Dize	Ses sentezi için metin. Uzunluk üst sınırı 4096 karakterdir.	Yes
voice	enum	Konuşma sentezi için kullanılacak ses. Olası değerler: alaşım, yankı, fable, onyx, nova, shimmer	Yes
response_format	enum	Sesi sentezlemek için biçim. Olası değerler: mp3, opus, aac, flac, wav, pcm	Hayır
Hız	Numara	Sentezlenen sesin hızı. 'den `0.25` değerine `4.0`bir değer seçin. `1.0` varsayılan değerdir.	Hayır	1.0

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Sağlanan metinden ses sentezler.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-05-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=2024-05-01-preview

Belirli DALL-E bir model dağıtımındaki bir metin başlığından toplu görüntü oluşturur

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
deployment-id	yol	Yes	Dize	Dağıtılan modelin `DALL-E` dağıtım kimliği.
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Istemi	Dize	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4000 karakterdir.	Yes
n	integer	Oluşturulacak görüntü sayısı.	Hayır	1
size	imageSize	Oluşturulan görüntülerin boyutu.	Hayır	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	Hayır	url
kullanıcı	Dize	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayır
nitelik	imageQuality	Oluşturulacak görüntünün kalitesi.	Hayır	standart
stili	imageStyle	Oluşturulan görüntülerin stili.	Hayır	Canlı

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Durum Kodu: varsayılan

Açıklama: Bir hata oluştu.

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

Örnekler

Örnek

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

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-05-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
          }
        }
      }
    ]
  }
}

Liste - Yardımcılar

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

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
limit	query	Hayır	integer
sıralama	query	Hayır	Dize
sonra	query	Hayır	Dize
önce	query	Hayır	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

GET https://{endpoint}/openai/assistants?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
model			Yes
ad	Dize	Asistanın adı. Uzunluk üst sınırı 256 karakterdir.	Hayır
açıklama	Dize	Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.	Hayır
yönergeler	Dize	Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 256.000 karakterdir.	Hayır
araçlar	dizi	Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , `retrieval`veya `function`türünde `code_interpreter`olabilir.	Hayır	[]
tool_resources	nesne	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu yardımcıya bağlı vektör deposu. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
vector_stores	dizi	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.

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	assistantObject	Modeli çağırabilen ve araçları kullanabilen bir `assistant` öğesini temsil eder.

Örnekler

Örnek

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

POST https://{endpoint}/openai/assistants?api-version=2024-05-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=2024-05-01-preview

Bir yardımcı alır.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
assistant_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	assistantObject	Modeli çağırabilen ve araçları kullanabilen bir `assistant` öğesini temsil eder.

Örnekler

Örnek

Bir yardımcı alır.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
assistant_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
model			Hayır
Adı	Dize	Asistanın adı. Uzunluk üst sınırı 256 karakterdir.	Hayır
açıklama	Dize	Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.	Hayır
yönergeler	Dize	Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 32768 karakterdir.	Hayır
araçlar	dizi	Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , `retrieval`veya `function`türünde `code_interpreter`olabilir.	Hayır	[]
tool_resources	nesne	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına sunulan `code_interpreter` dosya kimliklerinin listesini geçersiz kılar. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	assistantObject	Modeli çağırabilen ve araçları kullanabilen bir `assistant` öğesini temsil eder.

Örnekler

Örnek

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

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-05-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=2024-05-01-preview

Bir yardımcıyı silin.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
assistant_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Bir yardımcıyı siler.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu
iletiler	dizi	İş parçacığını başlatacak iletilerin listesi.	Hayır
tool_resources	nesne	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ır
meta veriler	nesne	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ır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.
vector_stores	dizi	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.

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	threadObject	İleti içeren bir iş parçacığını temsil eder.

Örnekler

Örnek

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

POST https://{endpoint}/openai/threads?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	threadObject	İleti içeren bir iş parçacığını temsil eder.

Örnekler

Örnek

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

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
tool_resources	nesne	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ır
meta veriler	nesne	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ır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan Dosya Kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	threadObject	İleti içeren bir iş parçacığını temsil eder.

Örnekler

Örnek

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

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
limit	query	Hayır	integer
sıralama	query	Hayır	Dize
sonra	query	Hayır	Dize
önce	query	Hayır	Dize
run_id	query	Hayır	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

İletileri Listele

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-05-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=2024-05-01-preview

İleti oluşturun.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu
rol	Dize	İ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.	Yes
content	Dize	İletinin içeriği.	Yes
Ekleri	dizi	İletiye eklenen dosyaların listesi ve bunların eklenmesi gereken araçlar.	Hayır
meta veriler	nesne	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ır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	messageObject	İş parçacığı içindeki bir iletiyi temsil eder.

Örnekler

Örnek

İleti oluşturun.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-05-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=2024-05-01-preview

bir ileti alın.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
message_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	messageObject	İş parçacığı içindeki bir iletiyi temsil eder.

Örnekler

Örnek

bir ileti alın.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-05-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=2024-05-01-preview

İletiyi değiştirir.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
message_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
meta veriler	nesne	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ır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	messageObject	İş parçacığı içindeki bir iletiyi temsil eder.

Örnekler

Örnek

İletiyi değiştirme.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
assistant_id	Dize	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Yes
thread	createThreadRequest		Hayır
model	Dize	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ır
yönergeler	Dize	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ır
araçlar	dizi	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ır
tool_resources	nesne	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
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ır
max_prompt_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
max_completion_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
truncation_strategy	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ır
tool_choice	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ır
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu yardımcıya eklenmiş vektör deposunun kimliği. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

Örnekler

Örnek

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

POST https://{endpoint}/openai/threads/runs?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
limit	query	Hayır	integer
sıralama	query	Hayır	Dize
sonra	query	Hayır	Dize
önce	query	Hayır	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/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=2024-05-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=2024-05-01-preview

Çalıştırma oluşturun.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
assistant_id	Dize	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Yes
model	Dize	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ır
yönergeler	Dize	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ır
additional_instructions	Dize	Ç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ır
additional_messages	dizi	Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler.	Hayır
araçlar	dizi	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
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ır
max_prompt_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
max_completion_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
truncation_strategy	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ır
tool_choice	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ır
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

Örnekler

Örnek

Çalıştırma oluşturun.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-05-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"
  }
}

Get - Run

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

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
run_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

Örnekler

Örnek

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

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
run_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
meta veriler	nesne	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ır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

Örnekler

Örnek

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

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-05-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=2024-05-01-preview

Bir çalıştırmada status: "requires_action" ve required_action.type submit_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

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
run_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
tool_outputs	dizi	Çıkışların gönderildiği araçların listesi.	Yes
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ır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

Örnekler

Örnek

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
run_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

Örnekler

Örnek

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

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
run_id	yol	Yes	Dize
limit	query	Hayır	integer
sıralama	query	Hayır	Dize
sonra	query	Hayır	Dize
önce	query	Hayır	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/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=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
thread_id	yol	Yes	Dize
run_id	yol	Yes	Dize
step_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize	api sürümü

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	runStepObject	Çalıştırmanın yürütülmesindeki bir adımı temsil eder.

Ö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=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
limit	query	Hayır	integer
sıralama	query	Hayır	Dize
sonra	query	Hayır	Dize
önce	query	Hayır	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

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

GET https://{endpoint}/openai/vector_stores?api-version=2024-05-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=2024-05-01-preview

Vektör deposu oluşturma.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
api-sürümü	query	Yes	Dize

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu
file_ids	dizi	Vektör deposunun kullanması gereken dosya kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Hayır
Adı	Dize	Vektör deposunun adı.	Hayır
expires_after	vectorStoreExpirationAfter	Vektör deposu için süre sonu ilkesi.	Hayır
meta veriler	nesne	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ır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreObject	Vektör deposu, araç tarafından `file_search` kullanılabilecek işlenmiş dosya koleksiyonudur.

Örnekler

Örnek

Vektör deposu oluşturur.

POST https://{endpoint}/openai/vector_stores?api-version=2024-05-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=2024-05-01-preview

Bir vektör deposu alır.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreObject	Vektör deposu, araç tarafından `file_search` kullanılabilecek işlenmiş dosya koleksiyonudur.

Örnekler

Örnek

Bir vektör deposu alır.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu
Adı	Dize	Vektör deposunun adı.	Hayır
expires_after	vectorStoreExpirationAfter	Vektör deposu için süre sonu ilkesi.	Hayır
meta veriler	nesne	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ır

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreObject	Vektör deposu, araç tarafından `file_search` kullanılabilecek işlenmiş dosya koleksiyonudur.

Örnekler

Örnek

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-05-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=2024-05-01-preview

Vektör depolarını silme.

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

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

Örnekler

Örnek

Vektör depolarını siler.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
limit	query	Hayır	integer
sıralama	query	Hayır	Dize
sonra	query	Hayır	Dize
önce	query	Hayır	Dize
filtrele	query	Hayır	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/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=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
file_id	Dize	Vektör deposunun kullanması gereken dosya kimliği. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Yes

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreFileObject	Vektör deposuna eklenmiş dosyaların listesi.

Ö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=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
file_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreFileObject	Vektör deposuna eklenmiş dosyaların listesi.

Örnekler

Örnek

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-05-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=2024-05-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

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
file_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/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=2024-05-01-preview

Yanıtlar: Durum Kodu: 200

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

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

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

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

İstek Gövdesi

İçerik Türü: application/json

Adı	Tür	Açıklama	Zorunlu	Varsayılan
file_ids	dizi	Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Yes

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreFileBatchObject	Vektör deposuna eklenmiş bir dosya grubu.

Örnekler

Örnek

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
batch_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreFileBatchObject	Vektör deposuna eklenmiş bir dosya grubu.

Ö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=2024-05-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=2024-05-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

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
batch_id	yol	Yes	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/json	vectorStoreFileBatchObject	Vektör deposuna eklenmiş bir dosya grubu.

Ö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=2024-05-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=2024-05-01-preview

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

URI Parametreleri

Veri Akışı Adı	İçinde	Zorunlu	Türü	Açıklama
endpoint	yol	Yes	Dize url	Desteklenen Azure OpenAI uç noktaları (protokol ve konak adı, örneğin: `https://aoairesource.openai.azure.com`. "aoairesource" yerine Azure OpenAI kaynak adınızı yazın). https://{your-resource-name}.openai.azure.com
vector_store_id	yol	Yes	Dize
batch_id	yol	Yes	Dize
limit	query	Hayır	integer
sıralama	query	Hayır	Dize
sonra	query	Hayır	Dize
önce	query	Hayır	Dize
filtrele	query	Hayır	Dize
api-sürümü	query	Yes	Dize

İstek Başlığı

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

Yanıtlar

Durum Kodu: 200

Açıklama: Tamam

İçerik Türü	Tür	Açıklama
application/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=2024-05-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
  }
}

Bileşenler

errorResponse

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

errorBase

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

Hata

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

innerError

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

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

innerErrorCode

İç hata nesnesi için hata kodları.

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

Tür: dize

Varsayılan:

Enum Adı: InnerErrorCode

Sabit Listesi Değerleri:

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

dalleErrorResponse

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

dalleError

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

dalleInnerError

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

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

contentFilterResultBase

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

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

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

Alıntı özellikleri

URL

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

Lisans

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

contentFilterIdResult

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

contentFilterResultsBase

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

Adı	Tür	Açıklama	Zorunlu
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
custom_blocklists	contentFilterDetailedResults	filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları.	Hayır
error	errorBase		Hayır

contentFilterPromptResults

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

Adı	Tür	Açıklama	Zorunlu
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
custom_blocklists	contentFilterDetailedResults	filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları.	Hayır
error	errorBase		Hayır
Jailbreak	contentFilterDetectedResult		Hayır
indirect_attack	contentFilterDetectedResult		Hayır

contentFilterChoiceResults

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

Adı	Tür	Açıklama	Zorunlu
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
custom_blocklists	contentFilterDetailedResults	filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları.	Hayır
error	errorBase		Hayır
protected_material_text	contentFilterDetectedResult		Hayır
protected_material_code	contentFilterDetectedWithCitationResult		Hayır

contentFilterDetailedResults

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Filtre	boolean		Yes
ayrıntılar	dizi		Hayır

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

Adı	Tür	Zorunlu
seksüel	contentFilterSeverityResult	Hayır
şiddet	contentFilterSeverityResult	Hayır
nefret	contentFilterSeverityResult	Hayır
self_harm	contentFilterSeverityResult	Hayır

dalleFilterResults

Adı	Tür	Açıklama	Zorunlu
seksüel	contentFilterSeverityResult		Hayır
şiddet	contentFilterSeverityResult		Hayır
nefret	contentFilterSeverityResult		Hayır
self_harm	contentFilterSeverityResult		Hayır
Küfür	contentFilterDetectedResult		Hayır
Jailbreak	contentFilterDetectedResult		Hayır
custom_blocklists	contentFilterDetailedResults	filtrelenen kesimler için içerik filtresi kimliklerinin ayrıntılarını içeren içerik filtreleme sonuçları.	Hayır

chatCompletionsRequestCommon

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

createChatCompletionRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
sıcaklık	Numara	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz `top_p` ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz `temperature` ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
akış	boolean	Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir `data: [DONE]` ileti tarafından sonlandırılır.	Hayır	Yanlış
durmak	dize veya dizi	API'nin başka belirteçler üretmeyi durduracağı en fazla 4 dizi.	Hayır
max_tokens	integer	Oluşturulan yanıt için izin verilen en fazla belirteç sayısı. Varsayılan olarak, modelin döndürebileceği belirteç sayısı olacaktır (4096 - istem belirteçleri).	Hayır	4096
presence_penalty	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır.	Hayır	0
frequency_penalty	Numara	-2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak.	Hayır	0
logit_bias	nesne	Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir json nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır.	Hayır
kullanıcı	Dize	Azure OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayır
iletiler	dizi	Şu ana kadarki konuşmayı içeren iletilerin listesi. Örnek Python kodu.	Hayır
data_sources	dizi	Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur.	Hayır
n	integer	Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri.	Hayır	1
tohum	integer	Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı `seed` sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir. Determinizm garanti değildir ve arka uçtaki `system_fingerprint` değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir.	Hayır	0
logprobs	boolean	Çıkış belirteçlerinin günlük olasılıklarının döndürülmesi veya döndürülmemesi. True ise, içinde döndürülen `content` `message`her çıkış belirtecinin günlük olasılıklarını döndürür. Bu seçenek şu anda modelde `gpt-4-vision-preview` kullanılamıyor.	Hayır	Yanlış
top_logprobs	integer	Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 5 arasında bir tamsayı. `logprobs` bu parametre kullanılıyorsa olarak ayarlanmalıdır `true` .	Hayır
response_format	nesne	Modelin çıkış yapması gereken biçimi belirten bir nesne. JSON modunu etkinleştirmek için kullanılır.	Hayır
araçlar	dizi	Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın.	Hayır
tool_choice	chatCompletionToolChoiceOption	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 `{"type": "function", "function": {"name": "my_function"}}` belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.	Hayır
işlevleri	dizi	yerine `tools`kullanım dışı bırakıldı. Modelin JSON girişleri oluşturabileceği işlevlerin listesi.	Hayır
function_call	dize veya nesne	yerine `tool_choice`kullanım dışı bırakıldı. Modelin işlev çağrılarına nasıl yanıt vereceğini denetler. "none", modelin bir işlevi çağırmadığı ve son kullanıcıya yanıt verdiği anlamına gelir. "auto", modelin son kullanıcı 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. Hiçbir işlev mevcut olmadığında "hiçbiri" varsayılan değerdir. İşlevler varsa varsayılan değer "otomatik"tir.	Hayır

response_format özellikleri

Tür

Adı	Tür	Açıklama	Varsayılan
Tür	chatCompletionResponseFormat	ayarı `json_object` JSON modunu etkinleştirir. Bu, modelin oluşturduğu iletinin geçerli bir JSON olduğunu garanti eder.	text

chatCompletionResponseFormat

ayarı json_object JSON modunu etkinleştirir. Bu, modelin oluşturduğu iletinin geçerli bir JSON olduğunu garanti eder.

Açıklama: ayarı json_object JSON modunu etkinleştirir. Bu, modelin oluşturduğu iletinin geçerli bir JSON olduğunu garanti eder.

Tür: dize

Varsayılan: metin

Sabit Listesi Adı: ChatCompletionResponseFormat

Sabit Listesi Değerleri:

Value	Açıklama
text	Yanıt biçimi düz metin dizesidir.
json_object	Yanıt biçimi bir JSON nesnesidir.

chatCompletionFunction

Adı	Tür	Açıklama	Zorunlu
Adı	Dize	Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir.	Yes
açıklama	Dize	İşlevin ne yaptığının açıklaması.	Hayır
parametreler	chatCompletionFunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.	Hayır

chatCompletionFunctionParameters

İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.

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

chatCompletionRequestMessage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
rol	chatCompletionRequestMessageRole	İleti yazarının rolü.	Yes

chatCompletionRequestMessageRole

İleti yazarının rolü.

Açıklama: İleti yazarının rolü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: ChatCompletionRequestMessageRole

Sabit Listesi Değerleri:

Value	Açıklama
sistem	İleti yazarı rolü sistemdir.
kullanıcı	İleti yazarı rolü kullanıcıdır.
asistan	İleti yazarı rolü yardımcıdır.
alet	İleti yazarı rolü bir araçtır.
function	Kullanımdan kaldırıldı. İleti yazarı rolü işlevdir.

chatCompletionRequestMessageSystem

Adı	Tür	Açıklama	Zorunlu	Varsayılan
rol	chatCompletionRequestMessageRole	İleti yazarının rolü.	Yes
content	Dize	İletinin içeriği.	Hayır

chatCompletionRequestMessageUser

Adı	Tür	Açıklama	Zorunlu	Varsayılan
rol	chatCompletionRequestMessageRole	İleti yazarının rolü.	Yes
content	dize veya dizi		Hayır

chatCompletionRequestMessageContentPart

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	chatCompletionRequestMessageContentPartType	İçerik bölümünün türü.	Yes

chatCompletionRequestMessageContentPartType

İçerik bölümünün türü.

Açıklama: İçerik bölümünün türü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: ChatCompletionRequestMessageContentPartType

Sabit Listesi Değerleri:

Value	Açıklama
text	İçerik bölümü türü metindir.
image_url	İçerik bölümü türü image_url.

chatCompletionRequestMessageContentPartText

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	chatCompletionRequestMessageContentPartType	İçerik bölümünün türü.	Yes
text	Dize	Metin içeriği.	Hayır

chatCompletionRequestMessageContentPartImage

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	chatCompletionRequestMessageContentPartType	İçerik bölümünün türü.	Yes
url	Dize	Görüntünün URL'si veya base64 kodlanmış görüntü verileri.	Hayır
ayrıntı	imageDetailLevel	Görüntünün ayrıntı düzeyini belirtir.	Hayır	auto

imageDetailLevel

Görüntünün ayrıntı düzeyini belirtir.

Açıklama: Görüntünün ayrıntı düzeyini belirtir.

Tür: dize

Varsayılan: otomatik

Enum Adı: ImageDetailLevel

Sabit Listesi Değerleri:

Value	Açıklama
auto	Görüntü ayrıntı düzeyi otomatiktir.
Iowa	Görüntü ayrıntı düzeyi düşük.
yüksek	Görüntü ayrıntı düzeyi yüksektir.

chatCompletionRequestMessageAssistant

Adı	Tür	Açıklama	Zorunlu
rol	chatCompletionRequestMessageRole	İleti yazarının rolü.	Yes
content	Dize	İletinin içeriği.	Hayır
tool_calls	dizi	Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.	Hayır
bağlam	azureChatExtensionsMessageContext	Azure OpenAI sohbet uzantıları söz konusu olduğunda sağlanan ek bağlam bilgilerinin gösterimi ilgili sohbet tamamlama yanıtının oluşturulmasında. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanma.	Hayır

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureChatExtensionType

Sabit Listesi Değerleri:

Value	Açıklama
azure_search	Azure Search'ün Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.
azure_ml_index	Azure Machine Learning dizininin Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.
azure_cosmos_db	Azure OpenAI sohbet uzantısı olarak Azure Cosmos DB kullanımını temsil eder.
elasticsearch	Elasticsearch® dizininin Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.
pinecone	Pinecone dizininin Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder.

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kimlik doğrulaması	onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions veya onYourDataAccessTokenAuthenticationOptions		Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayır
max_search_queries	integer	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ır
allow_partial_result	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ır	Yanlış
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayır
katılık	integer	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	Hayır
role_information	Dize	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	Hayır
endpoint	Dize	Kullanılacak Azure Search kaynağının mutlak uç nokta yolu.	Yes
index_name	Dize	Başvuruda bulunulan Azure Search kaynağında kullanılabilir olarak kullanılacak dizinin adı.	Yes
fields_mapping	azureSearchIndexFieldMappingOptions	Yapılandırılmış bir Azure Search kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Hayır
query_type	azureSearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Search alma sorgusunun türü.	Hayır
semantic_configuration	Dize	Sorgu için ek anlamsal yapılandırma.	Hayır
filtrele	Dize	Arama filtresi.	Hayır
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Hayır
include_contexts	dizi	Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve `intent`olur`citations`.	Hayır

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: AzureSearchQueryType

Sabit Listesi Değerleri:

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

azureMachineLearningIndexChatExtensionConfiguration

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Yes
parametreler	azureMachineLearningIndexChatExtensionParameters	Azure Machine Learning vektör dizini sohbet uzantısının parametreleri.	Hayır

azureMachineLearningIndexChatExtensionParameters

Azure Machine Learning vektör dizini sohbet uzantısının parametreleri.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kimlik doğrulaması	onYourDataAccessTokenAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayır
max_search_queries	integer	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ır
allow_partial_result	boolean	True olarak belirtilirse, sistem kısmi arama sonuçlarının kullanılmasına izin verir. 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ır	Yanlış
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayır
katılık	integer	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	Hayır
role_information	Dize	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	Hayır
project_resource_id	Dize	Azure Machine Learning projesinin kaynak kimliği.	Yes
ad	Dize	Azure Machine Learning vektör dizini adı.	Yes
sürüm	Dize	Azure Machine Learning vektör dizininin sürümü.	Yes
filtrele	Dize	Arama filtresi. Yalnızca Azure Machine Learning vektör dizini AzureSearch türündeyse desteklenir.	Hayır
include_contexts	dizi	Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve `intent`olur`citations`.	Hayır

azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kimlik doğrulaması	onYourDataConnectionStringAuthenticationOptions	bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.	Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayır
max_search_queries	integer	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ır
allow_partial_result	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ır	Yanlış
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayır
katılık	integer	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	Hayır
role_information	Dize	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	Hayır
database_name	Dize	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı.	Yes
container_name	Dize	Azure Cosmos DB kaynak kapsayıcısının adı.	Yes
index_name	Dize	Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı.	Yes
fields_mapping	azureCosmosDBFieldMappingOptions	Yapılandırılmış bir Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.	Yes
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource		Yes
include_contexts	dizi	Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve `intent`olur`citations`.	Hayır

azureCosmosDBFieldMappingOptions

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

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

elasticsearchChatExtensionConfiguration

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

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

elasticsearchChatExtensionParameters

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kimlik doğrulaması	onYourDataKeyAndKeyIdAuthenticationOptions veya onYourDataEncodedApiKeyAuthenticationOptions		Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayır
max_search_queries	integer	Bir kullanıcı iletisi için arama sağlayıcısına en fazla yeniden yazılan sorgu sayısı gönderilmelidir. Belirtilmezse, sistem gönderilecek sorgu sayısına karar verir.	Hayır
allow_partial_result	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ır	Yanlış
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayır
katılık	integer	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	Hayır
role_information	Dize	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	Hayır
endpoint	Dize	Elasticsearch'in® uç noktası.	Yes
index_name	Dize	Elasticsearch'in® dizin adı.	Yes
fields_mapping	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ır
query_type	elasticsearchQueryType	Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Elasticsearch® alma sorgusunun türü.	Hayır
embedding_dependency	onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource veya onYourDataModelIdVectorizationSource		Hayır
include_contexts	dizi	Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve `intent`olur`citations`.	Hayır

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.

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

elasticsearchQueryType

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

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: ElasticsearchQueryType

Sabit Listesi Değerleri:

Value	Açıklama
basit	Varsayılan, basit sorgu ayrıştırıcısını temsil eder.
vektör	Hesaplanan veriler üzerinde vektör aramalarını temsil eder.

pineconeChatExtensionConfiguration

Pinecone'un Azure OpenAI sohbet uzantısı olarak kullanıldığında yapılandırılabilir seçeneklerinin belirli bir gösterimi.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	azureChatExtensionType	Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, bir sohbet tarafından kullanılır yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken tamamlama isteği. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.	Yes
parametreler	pineconeChatExtensionParameters	Azure OpenAI Pinecone sohbet uzantılarını yapılandırma parametreleri.	Hayır

pineconeChatExtensionParameters

Azure OpenAI Pinecone sohbet uzantılarını yapılandırma parametreleri.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
kimlik doğrulaması	onYourDataApiKeyAuthenticationOptions	API anahtarı kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.	Yes
top_n_documents	integer	Yapılandırılan sorgu için öne çıkan en fazla belge sayısı.	Hayır
max_search_queries	integer	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ır
allow_partial_result	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ır	Yanlış
in_scope	boolean	Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği.	Hayır
katılık	integer	Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır.	Hayır
role_information	Dize	Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır.	Hayır
ortamı	Dize	Pinecone'un ortam adı.	Yes
index_name	Dize	Pinecone veritabanı dizininin adı.	Yes
fields_mapping	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.	Yes
embedding_dependency	onYourDataDeploymentNameVectorizationSource	Vektör arama uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve temel alan bir vektörleştirme kaynağının ayrıntıları aynı Azure OpenAI kaynağında bir iç ekleme modeli dağıtım adı.	Yes
include_contexts	dizi	Çıkış bağlamının dahil edilen özellikleri. Belirtilmezse, varsayılan değer ve `intent`olur`citations`.	Hayır

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.

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

onYourDataAuthenticationOptions

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

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

onYourDataContextProperty

Bağlam özelliği.

Açıklama: Bağlam özelliği.

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataContextProperty

Sabit Listesi Değerleri:

Value	Açıklama
Alıntı	`citations` özelliği.
amaç	`intent` özelliği.
all_retrieved_documents	`all_retrieved_documents` özelliği.

onYourDataAuthenticationType

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

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataAuthenticationType

Sabit Listesi Değerleri:

Value	Açıklama
api_key	API anahtarı aracılığıyla kimlik doğrulaması.
connection_string	bağlantı dizesi aracılığıyla kimlik doğrulaması.
key_and_key_id	Anahtar ve anahtar kimliği çifti aracılığıyla kimlik doğrulaması.
encoded_api_key	Kodlanmış API anahtarıyla kimlik doğrulaması.
access_token	Erişim belirteci aracılığıyla kimlik doğrulaması.
system_assigned_managed_identity	Sistem tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.
user_assigned_managed_identity	Kullanıcı tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması.

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataKeyAndKeyIdAuthenticationOptions

Elasticsearch anahtarı ve anahtar kimliği çifti kullanılırken Verilerinizde Azure OpenAI kimlik doğrulaması seçenekleri.

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

onYourDataEncodedApiKeyAuthenticationOptions

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

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

onYourDataAccessTokenAuthenticationOptions

Erişim belirteci kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataVectorizationSource

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

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

onYourDataVectorizationSourceType

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

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: OnYourDataVectorizationSourceType

Sabit Listesi Değerleri:

Value	Açıklama
endpoint	Azure OpenAI ekleme modeline yönelik genel hizmet çağrıları tarafından gerçekleştirilen vektörleştirmeyi temsil eder.
deployment_name	Kullanılacak Ada modeli dağıtım adını temsil eder. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu model dağıtımını vektöre olanak tanıyan genel bir çağrı yerine iç çağrı aracılığıyla kullanır özel ağlarda bile arama.
model_id	Arama hizmetinde tanımlanan belirli bir ekleme modeli kimliğini temsil eder. Şu anda yalnızca Elasticsearch® tarafından desteklenmektedir.

onYourDataEndpointVectorizationSource

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

Adı	Tür	Açıklama	Zorunlu
Tür	onYourDataVectorizationSourceType	Azure OpenAI On Your Data ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder vektör araması.	Yes
endpoint	Dize	Eklemelerin alınması gereken kaynak uç noktası URL'sini belirtir. biçiminde `https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings`olmalıdır. Api sürümü sorgu parametresine izin verilmiyor.	Hayır
kimlik doğrulaması	onYourDataApiKeyAuthenticationOptions veya onYourDataAccessTokenAuthenticationOptions		Hayır
boyutlar	integer	Eklemelerin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde `text-embedding-3` desteklenir.	Hayır

onYourDataDeploymentNameVectorizationSource

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

Adı	Tür	Açıklama	Zorunlu
Tür	onYourDataVectorizationSourceType	Azure OpenAI On Your Data ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder vektör araması.	Yes
deployment_name	Dize	Vektörleştirme için kullanılacak model dağıtımının adını belirtir. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu model dağıtımını özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine bir iç çağrı aracılığıyla kullanır.	Hayır
boyutlar	integer	Eklemelerin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde `text-embedding-3` desteklenir.	Hayır

onYourDataModelIdVectorizationSource

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	onYourDataVectorizationSourceType	Azure OpenAI On Your Data ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder vektör araması.	Yes
model_id	Dize	Vektörleştirme için kullanılacak model kimliğini belirtir. Bu model kimliği arama hizmetinde tanımlanmalıdır.	Hayır

azureChatExtensionsMessageContext

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

Adı	Tür	Açıklama	Zorunlu
Alıntı	dizi	Yanıtta yardımcı iletisini oluşturmak için kullanılan veri kaynağı alma sonucu.	Hayır
amaç	Dize	Bağlamı taşımak için bir sonraki dönüşe geçmek için kullanılan sohbet geçmişinden algılanan amaç.	Hayır
all_retrieved_documents	dizi	Alınan tüm belgeler.	Hayır

Alıntı

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

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

retrievedDocument

Alınan belge.

Adı	Tür	Açıklama	Zorunlu
content	Dize	Alıntının içeriği.	Yes
başlık	Dize	Alıntının başlığı.	Hayır
url	Dize	Alıntının URL'si.	Hayır
dosya yolu	Dize	Alıntının dosya yolu.	Hayır
chunk_id	Dize	Alıntının öbek kimliği.	Hayır
search_queries	dizi	Belgeyi almak için kullanılan arama sorguları.	Hayır
data_source_index	integer	Veri kaynağının dizini.	Hayır
original_search_score	Numara	Alınan belgenin özgün arama puanı.	Hayır
rerank_score	Numara	Alınan belgenin yeniden kırpma puanı.	Hayır
filter_reason	filterReason	Alınan belgenin filtreleme nedeni.	Hayır

filterReason

Alınan belgenin filtreleme nedeni.

Açıklama: Alınan belgenin filtreleme nedeni.

Tür: dize

Varsayılan:

Sabit Listesi Adı: FilterReason

Sabit Listesi Değerleri:

Value	Açıklama
puan	Belge, yapılandırma tarafından `strictness` tanımlanan özgün arama puanı eşiğine göre filtrelenmiştir.
yeniden kırpma	Belge özgün arama puanı eşiğine göre filtrelenmez, ancak yeniden dilim puanına göre `top_n_documents` filtrelenip yapılandırılır.

chatCompletionMessageToolCall

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

İşlevin özellikleri

Veri Akışı Adı

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

Bağımsız değişkenler

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

toolCallType

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

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

Tür: dize

Varsayılan:

Sabit Listesi Adı: ToolCallType

Sabit Listesi Değerleri:

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

chatCompletionRequestMessageTool

Adı	Tür	Açıklama	Zorunlu
rol	chatCompletionRequestMessageRole	İleti yazarının rolü.	Yes
tool_call_id	Dize	Bu iletinin yanıt verdiği araç çağrısı.	Hayır
content	Dize	İletinin içeriği.	Hayır

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

Adı	Tür	Açıklama	Zorunlu
id	dize	Sohbetin tamamlanması için benzersiz bir tanımlayıcı.	Yes
nesne	chatCompletionResponseObject	Nesne türü.	Yes
Oluşturulan	integer	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak).	Yes
model	Dize	Sohbetin tamamlanması için kullanılan model.	Yes
kullanım	completionUsage	Tamamlanma isteği için kullanım istatistikleri.	Hayır
system_fingerprint	Dize	Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle `seed` birlikte kullanılabilir.	Hayır
prompt_filter_results	promptFilterResults	İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.	Hayır
Seçenek	dizi		Hayır

chatCompletionChoiceLogProbs

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

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

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

chatCompletionResponseMessageRole

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

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

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

asistan

chatCompletionToolChoiceOption

Model tarafından çağrılan (varsa) işlevi denetler. none modelin bir işlevi ç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 {"type": "function", "function": {"name": "my_function"}} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.

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

chatCompletionNamedToolChoice

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

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

İşlevin özellikleri

Veri Akışı Adı

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

chatCompletionFunctionCall

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Adı	Dize	Çağrılacak işlevin adı.	Yes
Bağımsız değişken	Dize	JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler üretebileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın.	Yes

chatCompletionsResponseCommon

Adı	Tür	Açıklama	Zorunlu
id	dize	Sohbetin tamamlanması için benzersiz bir tanımlayıcı.	Yes
nesne	chatCompletionResponseObject	Nesne türü.	Yes
Oluşturulan	integer	Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak).	Yes
model	Dize	Sohbetin tamamlanması için kullanılan model.	Yes
kullanım	completionUsage	Tamamlanma isteği için kullanım istatistikleri.	Hayır
system_fingerprint	Dize	Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle `seed` birlikte kullanılabilir.	Hayır

chatCompletionResponseObject

Nesne türü.

Açıklama: Nesne türü.

Tür: dize

Varsayılan:

Sabit Listesi Adı: ChatCompletionResponseObject

Sabit Listesi Değerleri:

Value	Açıklama
chat.completion	Nesne türü sohbet tamamlamadır.

completionUsage

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

Adı	Tür	Açıklama	Zorunlu
prompt_tokens	integer	İstemdeki belirteç sayısı.	Yes
completion_tokens	integer	Oluşturulan tamamlamadaki belirteçlerin sayısı.	Yes
total_tokens	integer	İstekte kullanılan toplam belirteç sayısı (istem + tamamlama).	Yes

chatCompletionTool

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	chatCompletionToolType	Aracın türü. Şu anda yalnızca `function` desteklenmektedir.	Yes
function	nesne		Yes

İşlevin özellikleri

Açıklama

Ad	Tür	Açıklama	Varsayılan
açıklama	Dize	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.

Veri Akışı Adı

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

Parametreler

Ad	Tür	Açıklama	Varsayılan
parametreler	chatCompletionFunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.

FunctionParameters

İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.

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

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

functionObject

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

chatCompletionToolType

Aracın türü. Şu anda yalnızca function desteklenmektedir.

Açıklama: Aracın türü. Şu anda yalnızca function desteklenmektedir.

Tür: dize

Varsayılan:

Sabit Listesi Adı: ChatCompletionToolType

Sabit Listesi Değerleri:

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

chatCompletionChoiceCommon

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

createTranslationRequest

Çeviri isteği.

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

audioResponse

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

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

audioVerboseResponse

response_format verbose_json çeviri veya transkripsiyon yanıtı

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

audioResponseFormat

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

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

Tür: dize

Varsayılan:

Sabit Listesi Değerleri:

json
text
srt
verbose_json
vtt

createTranscriptionRequest

Transkripsiyon isteği.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
dosyası	Dize	Dökümü yapılan ses dosyası nesnesi.	Yes
Istemi	Dize	Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir.	Hayır
response_format	audioResponseFormat	Çıkışın biçimini tanımlar.	Hayır
sıcaklık	Numara	Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır.	Hayır	0
dil	Dize	Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır.	Hayır
timestamp_granularities[]	dizi	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ır	['segment']

audioSegment

Transkripsiyon veya çeviri segmenti.

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

audioWord

Transkripsiyon veya çeviri sözcüğü.

Adı	Tür	Açıklama	Zorunlu
kelime	Dize	Word	Hayır
start	Numara	Başlangıç uzaklığı sözcüğü.	Hayır
end	Numara	Sözcük sonu uzaklığı.	Hayır

createSpeechRequest

Konuşma isteği.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
giriş	Dize	Ses sentezi için metin. Uzunluk üst sınırı 4096 karakterdir.	Yes
voice	enum	Konuşma sentezi için kullanılacak ses. Olası değerler: alaşım, yankı, fable, onyx, nova, shimmer	Yes
response_format	enum	Sesi sentezlemek için biçim. Olası değerler: mp3, opus, aac, flac, wav, pcm	Hayır
Hız	Numara	Sentezlenen sesin hızı. 'den `0.25` değerine `4.0`bir değer seçin. `1.0` varsayılan değerdir.	Hayır	1.0

imageQuality

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

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

Tür: dize

Varsayılan: standart

Sabit Listesi Adı: Kalite

Sabit Listesi Değerleri:

Value	Açıklama
standart	Standart kalite, standart kalitede görüntüler oluşturur.
sabit disk	HD kalitesi, görüntü genelinde daha ayrıntılı ve daha tutarlı görüntüler oluşturur.

imagesResponseFormat

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

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

Tür: dize

Varsayılan: url

Sabit Listesi Adı: ImagesResponseFormat

Sabit Listesi Değerleri:

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

imageSize

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

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

Tür: dize

Varsayılan: 1024x1024

Sabit Listesi Adı: Boyut

Sabit Listesi Değerleri:

Value	Açıklama
256x256	Oluşturulan görüntünün istenen boyutu 256x256 pikseldir. Yalnızca dall-e-2 için desteklenir.
512x512	Oluşturulan görüntünün istenen boyutu 512x512 pikseldir. Yalnızca dall-e-2 için desteklenir.
1792x1024	Oluşturulan görüntünün istenen boyutu 1792x1024 pikseldir. Yalnızca dall-e-3 için desteklenir.
1024x1792	Oluşturulan görüntünün istenen boyutu 1024x1792 pikseldir. Yalnızca dall-e-3 için desteklenir.
1024x1024	Oluşturulan görüntünün istenen boyutu 1024x1024 pikseldir.

imageStyle

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

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

Tür: dize

Varsayılan: canlı

Sabit Listesi Adı: Stil

Sabit Listesi Değerleri:

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

imageGenerationsRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Istemi	Dize	İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4000 karakterdir.	Yes
n	integer	Oluşturulacak görüntü sayısı.	Hayır	1
size	imageSize	Oluşturulan görüntülerin boyutu.	Hayır	1024x1024
response_format	imagesResponseFormat	Oluşturulan görüntülerin döndürüldiği biçim.	Hayır	url
kullanıcı	Dize	Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı.	Hayır
nitelik	imageQuality	Oluşturulacak görüntünün kalitesi.	Hayır	standart
stili	imageStyle	Oluşturulan görüntülerin stili.	Hayır	Canlı

generateImagesResponse

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

imageResult

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

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

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
text	string		Yes
Yayılan	dizi	Algılanan nesneleri ve sınırlayıcı kutu bilgilerini temsil eden bir span dizisi.	Yes

Span

Algılanan bir nesneyi ve sınırlayıcı kutu bilgilerini temsil eden bir span nesnesi.

Adı	Tür	Açıklama	Zorunlu
text	Dize	Algılanan nesneyi temsil eden yayılma alanının metin içeriği.	Yes
fark	integer	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.	Yes
uzunluk	integer	Unicode kod noktalarıyla ölçülen karakter cinsinden yayılma alanının uzunluğu.	Yes
çokgen	dizi	Algılanan nesneyi kapsayan çokgendeki noktaları temsil eden bir nesne dizisi.	Yes

runCompletionUsage

Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma bir terminal durumunda değilse (örneğinin_progress, , queuedvb.) bu değer olacaktırnull.

Adı	Tür	Açıklama	Zorunlu
completion_tokens	integer	Çalıştırma boyunca kullanılan tamamlanma belirteçlerinin sayısı.	Yes
prompt_tokens	integer	Çalıştırma boyunca kullanılan istem belirteçlerinin sayısı.	Yes
total_tokens	integer	Kullanılan toplam belirteç sayısı (istem + tamamlama).	Yes

runStepCompletionUsage

Çalıştırma adımıyla ilgili kullanım istatistikleri. Bu değer, çalıştırma adımının durumu olduğunda in_progressolurnull.

Adı	Tür	Açıklama	Zorunlu
completion_tokens	integer	Çalıştırma adımı boyunca kullanılan tamamlama belirteçlerinin sayısı.	Yes
prompt_tokens	integer	Çalıştırma adımı boyunca kullanılan istem belirteçlerinin sayısı.	Yes
total_tokens	integer	Kullanılan toplam belirteç sayısı (istem + tamamlama).	Yes

assistantsApiResponseFormatOption

Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm gpt-3.5-turbo-1106GPT-3.5 Turbo modelleri ile uyumludur.

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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını max_tokens gösteren ileti finish_reason="length"içeriğinin kısmen kesilebileceğini unutmayın.

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

assistantsApiResponseFormat

Modelin beklenen çıkışını açıklayan nesne. Yalnızca function türün tools Çalıştır'a geçirilmesine izin veriliyorsajson_object. Model metin döndürebiliyorsa text veya gerekli herhangi bir değer varsa.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	veya `json_object`'nin `text` biri olmalıdır.	Hayır	text

type Enum: AssistantsApiResponseFormat

Value	Açıklama
text
json_object

assistantObject

Modeli çağırabilen ve araçları kullanabilen bir assistant öğesini temsil eder.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
id	dize	API uç noktalarında başvurulabilen tanımlayıcı.	Yes
nesne	Dize	Her zaman `assistant`olan nesne türü.	Yes
created_at	integer	Yardımcının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
ad	Dize	Asistanın adı. Uzunluk üst sınırı 256 karakterdir.	Yes
açıklama	Dize	Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.	Yes
model	Dize	Kullanılacak modelin kimliği. Tüm kullanılabilir modellerinizi görmek için API'yi kullanabilir `List models` veya bunların açıklamaları için Modele genel bakış bilgilerimize bakabilirsiniz.	Yes
yönergeler	Dize	Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 256.000 karakterdir.	Yes
araçlar	dizi	Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , `file_search`veya `function`türünde `code_interpreter`olabilir.	Yes	[]
tool_resources	nesne	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ır
meta veriler	nesne	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.	Yes
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	'code_interpreter' aracının kullanımına sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu yardımcıya eklenmiş vektör deposunun kimliği. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.

object Enum: AssistantObjectType

Value	Açıklama
asistan	Her zaman yardımcı olan nesne türü

createAssistantRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
model			Yes
ad	Dize	Asistanın adı. Uzunluk üst sınırı 256 karakterdir.	Hayır
açıklama	Dize	Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.	Hayır
yönergeler	Dize	Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 256.000 karakterdir.	Hayır
araçlar	dizi	Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , `retrieval`veya `function`türünde `code_interpreter`olabilir.	Hayır	[]
tool_resources	nesne	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu yardımcıya bağlı vektör deposu. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.
vector_stores	dizi	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.

modifyAssistantRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
model			Hayır
Adı	Dize	Asistanın adı. Uzunluk üst sınırı 256 karakterdir.	Hayır
açıklama	Dize	Asistanın açıklaması. Uzunluk üst sınırı 512 karakterdir.	Hayır
yönergeler	Dize	Yardımcının kullandığı sistem yönergeleri. Uzunluk üst sınırı 32768 karakterdir.	Hayır
araçlar	dizi	Yardımcıda etkinleştirilen aracın listesi. Yardımcı başına en fazla 128 araç olabilir. Araçlar , `retrieval`veya `function`türünde `code_interpreter`olabilir.	Hayır	[]
tool_resources	nesne	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına sunulan `code_interpreter` dosya kimliklerinin listesini geçersiz kılar. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

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

deleteAssistantResponse

Adı	Tür	Zorunlu
id	string	Yes
silindi	boolean	Yes
nesne	string	Yes

object Enum: DeleteAssistantResponseState

Value	Açıklama
assistant.deleted

listAssistantsResponse

Adı	Tür	Zorunlu
nesne	string	Yes
veriler	dizi	Yes
first_id	string	Yes
last_id	string	Yes
has_more	boolean	Yes

assistantToolsCode

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Tanımlanan araç türü: `code_interpreter`	Yes

type Enum: assistantToolsCodeType

Value	Açıklama
code_interpreter

assistantToolsFileSearch

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Tanımlanan araç türü: `file_search`	Yes

type Enum: assistantToolsFileSearchType

Value	Açıklama
file_search

assistantToolsFunction

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Tanımlanan araç türü: `function`	Yes
function	nesne	İşlev tanımı.	Yes

İşlevin özellikleri

Açıklama

Ad	Tür	Açıklama	Varsayılan
açıklama	Dize	İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması.

Veri Akışı Adı

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

Parametreler

Ad	Tür	Açıklama	Varsayılan
parametreler	chatCompletionFunctionParameters	İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.

type Enum: assistantToolsFunction

Value	Açıklama
function

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	İş 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 `auto`ayarlandığında, iş parçacığının ortasındaki iletiler, modelin `max_prompt_tokens`bağlam uzunluğuna uyacak şekilde bırakılır.	Yes
last_messages	integer	Çalıştırma bağlamını oluştururken iş parçacığından gelen en son iletilerin sayısı.	Hayır

type Enum: TruncationType

Value	Açıklama
auto
last_messages

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.

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

assistantsNamedToolChoice

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Aracın türü. türü ise `function`, işlev adı ayarlanmalıdır	Yes
function	nesne		Hayır

İşlevin özellikleri

Veri Akışı Adı

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

type Enum: AssistantsNamedToolChoiceType

Value	Açıklama
function
code_interpreter
file_search

runObject

bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
id	dize	API uç noktalarında başvurulabilen tanımlayıcı.	Yes
nesne	Dize	Her zaman `thread.run`olan nesne türü.	Yes
created_at	integer	Çalıştırmanın oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
thread_id	Dize	Bu çalıştırmanın bir parçası olarak üzerinde yürütülen iş parçacığının kimliği.	Yes
assistant_id	Dize	Bu çalıştırmanın yürütülmesi için kullanılan yardımcının kimliği.	Yes
durum	Dize	Çalıştırmanın durumu ; , `in_progress`, `requires_action`, , `cancelling`, `cancelled`, `failed`, `completed`veya `expired`olabilir`queued`.	Yes
required_action	nesne	Çalıştırmaya devam etmek için gereken eylemle ilgili ayrıntılar. Herhangi bir eylem gerekli değilse olacaktır `null` .	Yes
last_error	nesne	Bu çalıştırmayla ilişkili son hata. Hata yoksa olacaktır `null` .	Yes
expires_at	integer	Çalıştırmanın süresinin dolacağı zaman için Unix zaman damgası (saniye olarak).	Yes
started_at	integer	Çalıştırmanın başlatıldığı zaman için Unix zaman damgası (saniye olarak).	Yes
cancelled_at	integer	Çalıştırmanın iptal edildiği zaman için Unix zaman damgası (saniye olarak).	Yes
failed_at	integer	Çalıştırmanın başarısız olduğu zaman için Unix zaman damgası (saniye olarak).	Yes
completed_at	integer	Çalıştırmanın ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak).	Yes
incomplete_details	nesne	Çalıştırmanın neden tamamlanmamış olduğuna ilişkin ayrıntılar. Çalıştırma tamamlanmamışsa olacaktır `null` .	Yes
model	Dize	Yardımcının bu çalıştırma için kullandığı model.	Yes
yönergeler	Dize	Yardımcının bu çalıştırma için kullandığı yönergeler.	Yes
araçlar	dizi	Yardımcının bu çalıştırma için kullandığı araçların listesi.	Yes	[]
meta veriler	nesne	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.	Yes
kullanım	runCompletionUsage	Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma bir terminal durumunda değilse (örneğin`in_progress`, , `queued`vb.) bu değer olacaktır`null`.	Yes
sıcaklık	Numara	Bu çalıştırma için kullanılan örnekleme sıcaklığı. Ayarlanmadıysa, varsayılan olarak 1 olur.	Hayır
top_p	Numara	Bu çalıştırma için kullanılan çekirdek örnekleme değeri. Ayarlanmadıysa, varsayılan olarak 1 olur.	Hayır
max_prompt_tokens	integer	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla istem belirteci sayısı.	Yes
max_completion_tokens	integer	Çalıştırma boyunca kullanılmak üzere belirtilen en fazla tamamlanma belirteci sayısı.	Yes
truncation_strategy	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.	Yes
tool_choice	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.	Yes
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Yes

required_action özellikleri

Tür

Adı	Tür	Açıklama	Varsayılan
Tür	Dize	Şimdilik, bu her zaman `submit_tool_outputs`.

submit_tool_outputs

Adı	Tür	Açıklama	Varsayılan
tool_calls	dizi	İlgili araç çağrılarının listesi.

last_error özellikleri

Kod

Adı	Tür	Açıklama	Varsayılan
kod	Dize	veya `rate_limit_exceeded`'nin `server_error` biri.

İleti

Adı	Tür	Açıklama	Varsayılan
ileti	Dize	Hatanın insan tarafından okunabilen açıklaması.

incomplete_details özellikleri

Nedeni

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

object Enum: runObjectType

Value	Açıklama
thread.run	Her zaman thread.run olan çalıştırma nesnesi türü

status Enum: RunObjectStatus

Value	Açıklama
Sıraya	Kuyruğa alınmış durum
in_progress	in_progress durumu
requires_action	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

createRunRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
assistant_id	Dize	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Yes
model	Dize	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ır
yönergeler	Dize	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ır
additional_instructions	Dize	Ç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ır
additional_messages	dizi	Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler.	Hayır
araçlar	dizi	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
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ır
max_prompt_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
max_completion_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
truncation_strategy	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ır
tool_choice	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ır
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

listRunsResponse

Adı	Tür	Zorunlu
nesne	string	Yes
veriler	dizi	Yes
first_id	string	Yes
last_id	string	Yes
has_more	boolean	Yes

modifyRunRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
meta veriler	nesne	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ır

submitToolOutputsRunRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
tool_outputs	dizi	Çıkışların gönderildiği araçların listesi.	Yes
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ır

runToolCallObject

Araç çağrısı nesneleri

Adı	Tür	Açıklama	Zorunlu
id	dize	Araç çağrısının kimliği. Uç noktayı kullanarak araç çıkışlarını gönderdiğinizde bu kimlik belirtilmelidir `Submit tool outputs to run` .	Yes
Tür	Dize	Çıkış için gereken araç çağrısının türü. Şimdilik, bu her zaman `function`.	Yes
function	nesne	İşlev tanımı.	Yes

İşlevin özellikleri

Veri Akışı Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	İşlevin adı.

Bağımsız değişkenler

Adı	Tür	Açıklama	Varsayılan
Bağımsız değişken	Dize	Modelin işleve geçirmenizi beklediği bağımsız değişkenler.

type Enum: RunToolCallObjectType

Value	Açıklama
function

createThreadAndRunRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
assistant_id	Dize	Bu çalıştırmayı yürütmek için kullanılacak yardımcının kimliği.	Yes
thread	createThreadRequest		Hayır
model	Dize	Bu çalıştırmayı yürütmek için kullanılacak model dağıtım adı. 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ır
yönergeler	Dize	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ır
araçlar	dizi	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ır
tool_resources	nesne	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ır
meta veriler	nesne	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ır
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ır	1
top_p	Numara	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.	Hayır	1
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ır
max_prompt_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
max_completion_tokens	integer	Ç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 `incomplete`ile sona erer. Daha fazla bilgi için bkz `incomplete_details` .	Hayır
truncation_strategy	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ır
tool_choice	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ır
response_format	assistantsApiResponseFormatOption	Modelin çıkış yapması gereken biçimi belirtir. GPT-4 Turbo ve tüm `gpt-3.5-turbo-1106`GPT-3.5 Turbo modelleri ile uyumludur. 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 "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını `max_tokens` gösteren ileti `finish_reason="length"`içeriğinin kısmen kesilebileceğini unutmayın.	Hayır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu yardımcıya eklenmiş vektör deposunun kimliği. Yardımcıya bağlı en fazla 1 vektör deposu olabilir.

threadObject

İleti içeren bir iş parçacığını temsil eder.

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarında başvurulabilen tanımlayıcı.	Yes
nesne	Dize	Her zaman `thread`olan nesne türü.	Yes
created_at	integer	İş parçacığının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
tool_resources	nesne	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.	Yes
meta veriler	nesne	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.	Yes

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.

object Enum: ThreadObjectType

Value	Açıklama
thread	Her zaman olan iş parçacığı nesnesi türü `thread`

createThreadRequest

Adı	Tür	Açıklama	Zorunlu
iletiler	dizi	İş parçacığını başlatacak iletilerin listesi.	Hayır
tool_resources	nesne	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ır
meta veriler	nesne	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ır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan dosya kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.
vector_stores	dizi	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.

modifyThreadRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
tool_resources	nesne	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ır
meta veriler	nesne	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ır

tool_resources özellikleri

code_interpreter

Adı	Tür	Açıklama	Varsayılan
file_ids	dizi	Aracın kullanımına `code_interpreter` sunulan Dosya Kimliklerinin listesi. Araçla ilişkili en fazla 20 dosya olabilir.	[]

file_search

Adı	Tür	Açıklama	Varsayılan
vector_store_ids	dizi	Bu iş parçacığına bağlı vektör deposu. İş parçacığına en fazla 1 vektör deposu eklenebilir.

deleteThreadResponse

Adı	Tür	Zorunlu
id	string	Yes
silindi	boolean	Yes
nesne	string	Yes

object Enum: DeleteThreadResponseObjectState

Value	Açıklama
thread.deleted	Silinen iş parçacığı yanıt nesnesi durumu `thread.deleted`

listThreadsResponse

Adı	Tür	Zorunlu
nesne	string	Yes
veriler	dizi	Yes
first_id	string	Yes
last_id	string	Yes
has_more	boolean	Yes

messageObject

İş parçacığı içindeki bir iletiyi temsil eder.

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarında başvurulabilen tanımlayıcı.	Yes
nesne	Dize	Her zaman `thread.message`olan nesne türü.	Yes
created_at	integer	İletinin oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
thread_id	Dize	Bu iletinin ait olduğu iş parçacığı kimliği.	Yes
durum	Dize	İletinin durumu , veya `completed`olabilir`in_progressincomplete`.	Yes
incomplete_details	nesne	Tamamlanmamış bir iletide, iletinin neden eksik olduğuna ilişkin ayrıntılar.	Yes
completed_at	integer	İletinin ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak).	Yes
incomplete_at	integer	İletinin tamamlanmamış olarak işaretlendiği zaman için Unix zaman damgası (saniye olarak).	Yes
rol	Dize	İletiyi oluşturan varlık. veya `assistant`'nin `user` biri.	Yes
content	dizi	İletinin metin ve/veya resim dizisi içindeki içeriği.	Yes
assistant_id	Dize	Varsa, bu iletiyi yazan yardımcının kimliği.	Yes
run_id	Dize	Varsa, bu iletinin yazmasıyla ilişkili çalıştırmanın kimliği.	Yes
Ekleri	dizi	İletiye eklenen dosyaların listesi ve eklendikleri araçlar.	Yes
meta veriler	nesne	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.	Yes

incomplete_details özellikleri

Nedeni

Adı	Tür	Açıklama	Varsayılan
reason	Dize	İletinin tamamlanmamış olmasının nedeni.

object Enum: MessageObjectType

Value	Açıklama
thread.message	İleti nesnesi türü: `thread.message`

status Enum: MessageObjectStatus

Value	Açıklama
in_progress
Eksik
tamamlandı

role Enum: MessageObjectRole

Value	Açıklama
kullanıcı
asistan

messageDeltaObject

Akış sırasında iletideki değiştirilmiş alanlar gibi bir ileti deltasını temsil eder.

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarına başvurulabilen iletinin tanımlayıcısı.	Yes
nesne	Dize	Her zaman `thread.message.delta`olan nesne türü.	Yes
delta	nesne	İletide değiştirilen alanları içeren delta.	Yes

Delta özellikleri

Rol

Adı	Tür	Açıklama	Varsayılan
rol	Dize	İletiyi oluşturan varlık. veya `assistant`'nin `user` biri.

Content

Adı	Tür	Açıklama	Varsayılan
content	dizi	İletinin metin ve/veya resim dizisi içindeki içeriği.

object Enum: MessageDeltaObjectType

Value	Açıklama
thread.message.delta

createMessageRequest

Adı	Tür	Açıklama	Zorunlu
rol	Dize	İ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.	Yes
content	Dize	İletinin içeriği.	Yes
Ekleri	dizi	İletiye eklenen dosyaların listesi ve bunların eklenmesi gereken araçlar.	Hayır
meta veriler	nesne	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ır

role Enum: CreateMessageRequestRole

Value	Açıklama
kullanıcı
asistan

modifyMessageRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
meta veriler	nesne	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ır

deleteMessageResponse

Adı	Tür	Zorunlu
id	string	Yes
silindi	boolean	Yes
nesne	string	Yes

object Enum: DeleteMessageResponseObject

Value	Açıklama
thread.message.deleted	Silinen ileti yanıt nesnesi durumu

listMessagesResponse

Adı	Tür	Zorunlu
nesne	string	Yes
veriler	dizi	Yes
first_id	string	Yes
last_id	string	Yes
has_more	boolean	Yes

messageContentImageFileObject

İletinin içeriğindeki bir görüntü Dosyasına başvurur.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman `image_file`.	Yes
image_file	nesne		Yes

image_file özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	İleti içeriğindeki görüntünün Dosya Kimliği.

type Enum: MessageContentImageFileObjectType

Value	Açıklama
image_file	İleti içerik görüntüsü dosya türü

messageContentTextObject

İletinin parçası olan metin içeriği.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman `text`.	Yes
text	nesne		Yes

Metin özellikleri

Değer

Adı	Tür	Açıklama	Varsayılan
değer	Dize	Metni oluşturan veriler.

Ek Açıklamalar

Adı	Tür	Açıklama	Varsayılan
Ek açıklama -ları	dizi

type Enum: messageContentTextObjectType

Value	Açıklama
text	İleti içeriği metni Nesne türü

messageContentTextAnnotationsFileCitationObject

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

Adı	Tür	Açıklama	Zorunlu
Tür	Dize	Her zaman `file_citation`.	Yes
text	Dize	İleti içeriğindeki değiştirilmesi gereken metin.	Yes
file_citation	nesne		Yes
start_index	integer		Yes
end_index	integer		Yes

file_citation özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	Alıntının ait olduğu dosyanın kimliği.

Teklif

Adı	Tür	Açıklama	Varsayılan
alıntı	Dize	Dosyadaki belirli tırnak işareti.

type Enum: FileCitationObjectType

Value	Açıklama
file_citation	Dosya alıntısı nesne türü

messageContentTextAnnotationsFilePathObject

Yardımcı bir dosya oluşturmak için aracı kullandığında code_interpreter oluşturulan dosyanın URL'si.

Adı	Tür	Açıklama	Zorunlu
Tür	Dize	Her zaman `file_path`.	Yes
text	Dize	İleti içeriğindeki değiştirilmesi gereken metin.	Yes
file_path	nesne		Yes
start_index	integer		Yes
end_index	integer		Yes

file_path özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	Oluşturulan dosyanın kimliği.

type Enum: FilePathObjectType

Value	Açıklama
file_path	Dosya yolu nesne türü

messageDeltaContentImageFileObject

İletinin içeriğindeki bir görüntü Dosyasına başvurur.

Adı	Tür	Açıklama	Zorunlu
dizin	integer	İletideki içerik bölümünün dizini.	Yes
Tür	Dize	Her zaman `image_file`.	Yes
image_file	nesne		Hayır

image_file özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	İleti içeriğindeki görüntünün Dosya Kimliği.

type Enum: MessageDeltaContentImageFileObjectType

Value	Açıklama
image_file

messageDeltaContentTextObject

İletinin parçası olan metin içeriği.

Adı	Tür	Açıklama	Zorunlu
dizin	integer	İletideki içerik bölümünün dizini.	Yes
Tür	Dize	Her zaman `text`.	Yes
text	nesne		Hayır

Metin özellikleri

Değer

Adı	Tür	Açıklama	Varsayılan
değer	Dize	Metni oluşturan veriler.

Ek Açıklamalar

Adı	Tür	Açıklama	Varsayılan
Ek açıklama -ları	dizi

type Enum: MessageDeltaContentTextObjectType

Value	Açıklama
text

messageDeltaContentTextAnnotationsFileCitationObject

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

Adı	Tür	Açıklama	Zorunlu
dizin	integer	Metin içeriği bölümündeki ek açıklamanın dizini.	Yes
Tür	Dize	Her zaman `file_citation`.	Yes
text	Dize	İleti içeriğindeki değiştirilmesi gereken metin.	Hayır
file_citation	nesne		Hayır
start_index	integer		Hayır
end_index	integer		Hayır

file_citation özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	Alıntının ait olduğu dosyanın kimliği.

Teklif

Adı	Tür	Açıklama	Varsayılan
alıntı	Dize	Dosyadaki belirli tırnak işareti.

tür Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Value	Açıklama
file_citation

messageDeltaContentTextAnnotationsFilePathObject

Yardımcı bir dosya oluşturmak için aracı kullandığında code_interpreter oluşturulan dosyanın URL'si.

Adı	Tür	Açıklama	Zorunlu
dizin	integer	Metin içeriği bölümündeki ek açıklamanın dizini.	Yes
Tür	Dize	Her zaman `file_path`.	Yes
text	Dize	İleti içeriğindeki değiştirilmesi gereken metin.	Hayır
file_path	nesne		Hayır
start_index	integer		Hayır
end_index	integer		Hayır

file_path özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	Oluşturulan dosyanın kimliği.

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Value	Açıklama
file_path

runStepObject

Çalıştırmanın yürütülmesindeki bir adımı temsil eder.

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarında başvurulabilen çalıştırma adımının tanımlayıcısı.	Yes
nesne	Dize	Her zaman `assistant.run.step`olan nesne türü.	Yes
created_at	integer	Çalıştırma adımının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
assistant_id	Dize	Çalıştırma adımıyla ilişkili yardımcının kimliği.	Yes
thread_id	Dize	Çalıştırılan iş parçacığının kimliği.	Yes
run_id	Dize	Bu çalıştırma adımının parçası olduğu çalıştırmanın kimliği.	Yes
Tür	Dize	veya `tool_calls`olabilecek `message_creation` çalıştırma adımının türü.	Yes
durum	Dize	Çalıştırmanın durumu; , , `failed`, `completed`veya `expired`olabilir`in_progresscancelled`.	Yes
step_details	runStepDetailsMessageCreationObject veya runStepDetailsToolCallsObject	Çalıştırma adımının ayrıntıları.	Yes
last_error	nesne	Bu çalıştırma adımıyla ilişkili son hata. Hata yoksa olacaktır `null` .	Yes
expired_at	integer	Ç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.	Yes
cancelled_at	integer	Çalıştırma adımının iptal edildiği zaman için Unix zaman damgası (saniye olarak).	Yes
failed_at	integer	Çalıştırma adımının başarısız olduğu zaman için Unix zaman damgası (saniye olarak).	Yes
completed_at	integer	Çalıştırma adımının ne zaman tamamlandığına ilişkin Unix zaman damgası (saniye olarak).	Yes
meta veriler	nesne	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.	Yes

last_error özellikleri

Kod

Adı	Tür	Açıklama	Varsayılan
kod	Dize	veya `rate_limit_exceeded`'nin `server_error` biri.

İleti

Adı	Tür	Açıklama	Varsayılan
ileti	Dize	Hatanın insan tarafından okunabilen açıklaması.

object Enum: RunStepObjectType

Value	Açıklama
assistant.run.step	Her zaman olan nesne türü `assistant.run.step`

type Enum: RunStepObjectType

Value	Açıklama
message_creation	message_creation çalıştırma adımı
tool_calls	tool_calls çalıştırma adımı

status Enum: RunStepObjectStatus

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

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarında başvurulabilen çalıştırma adımının tanımlayıcısı.	Yes
nesne	Dize	Her zaman `thread.run.step.delta`olan nesne türü.	Yes
delta	nesne	Çalıştırma adımında değiştirilen alanları içeren delta.	Yes

Delta özellikleri

step_details

Adı	Tür	Açıklama	Varsayılan
step_details	runStepDeltaStepDetailsMessageCreationObject veya runStepDeltaStepDetailsToolCallsObject	Çalıştırma adımının ayrıntıları.

object Enum: RunStepDeltaObjectType

Value	Açıklama
thread.run.step.delta

listRunStepsResponse

Adı	Tür	Zorunlu
nesne	string	Yes
veriler	dizi	Yes
first_id	string	Yes
last_id	string	Yes
has_more	boolean	Yes

runStepDetailsMessageCreationObject

Çalıştırma adımına göre ileti oluşturma işleminin ayrıntıları.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman 'message_creation'.	Yes
message_creation	nesne		Yes

message_creation özellikleri

message_id

Adı	Tür	Açıklama	Varsayılan
message_id	Dize	Bu çalıştırma adımı tarafından oluşturulan iletinin kimliği.

type Enum: RunStepDetailsMessageCreationObjectType

Value	Açıklama
message_creation

runStepDeltaStepDetailsMessageCreationObject

Çalıştırma adımına göre ileti oluşturma işleminin ayrıntıları.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman `message_creation`.	Yes
message_creation	nesne		Hayır

message_creation özellikleri

message_id

Adı	Tür	Açıklama	Varsayılan
message_id	Dize	Bu çalıştırma adımı tarafından oluşturulan iletinin kimliği.

type Enum: RunStepDeltaStepDetailsMessageCreationObjectType

Value	Açıklama
message_creation

runStepDetailsToolCallsObject

Araç çağrısının ayrıntıları.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman `tool_calls`.	Yes
tool_calls	dizi	Ç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`.	Yes

type Enum: RunStepDetailsToolCallsObjectType

Value	Açıklama
tool_calls

runStepDeltaStepDetailsToolCallsObject

Araç çağrısının ayrıntıları.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman `tool_calls`.	Yes
tool_calls	dizi	Ç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ır

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Value	Açıklama
tool_calls

runStepDetailsToolCallsCodeObject

Çalıştırma adımının dahil olduğu Kod Yorumlayıcı aracı çağrısının ayrıntıları.

Adı	Tür	Açıklama	Zorunlu
id	dize	Araç çağrısının kimliği.	Yes
Tür	Dize	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` .	Yes
code_interpreter	nesne	Kod Yorumlayıcı aracı çağrı tanımı.	Yes

code_interpreter özellikleri

Girdi

Adı	Tür	Açıklama	Varsayılan
giriş	Dize	Kod Yorumlayıcı aracı çağrısına giriş.

Çıkışlar

Adı	Tür	Açıklama	Varsayılan
Çıkış	dizi	Kod Yorumlayıcı araç çağrısının çıkışları. Kod Yorumlayıcı, metin () veya resimler`image` (`logs`) dahil olmak üzere bir veya daha fazla öğe çıkışı yapabilir. Bunların her biri farklı bir nesne türüyle temsil edilir.

type Enum: RunStepDetailsToolCallsCodeObjectType

Value	Açıklama
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Çalıştırma adımının dahil olduğu Kod Yorumlayıcı aracı çağrısının ayrıntıları.

Adı	Tür	Açıklama	Zorunlu
dizin	integer	Araçtaki araç çağrısının dizini diziyi çağırır.	Yes
id	dize	Araç çağrısının kimliği.	Hayır
Tür	Dize	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` .	Yes
code_interpreter	nesne	Kod Yorumlayıcı aracı çağrı tanımı.	Hayır

code_interpreter özellikleri

Girdi

Adı	Tür	Açıklama	Varsayılan
giriş	Dize	Kod Yorumlayıcı aracı çağrısına giriş.

Çıkışlar

Adı	Tür	Açıklama	Varsayılan
Çıkış	dizi	Kod Yorumlayıcı araç çağrısının çıkışları. Kod Yorumlayıcı, metin () veya resimler`image` (`logs`) dahil olmak üzere bir veya daha fazla öğe çıkışı yapabilir. Bunların her biri farklı bir nesne türüyle temsil edilir.

type Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Value	Açıklama
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

Çalıştırma adımının bir parçası olarak Kod Yorumlayıcı aracı çağrısından metin çıktısı.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman `logs`.	Yes
günlükler	Dize	Kod Yorumlayıcı araç çağrısından metin çıkışı.	Yes

type Enum: RunStepDetailsToolCallsCodeOutputLogsObjectType

Value	Açıklama
günlükler

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

Çalıştırma adımının bir parçası olarak Kod Yorumlayıcı aracı çağrısından metin çıktısı.

Adı	Tür	Açıklama	Zorunlu
dizin	integer	Çıkış dizisindeki çıkışın dizini.	Yes
Tür	Dize	Her zaman `logs`.	Yes
günlükler	Dize	Kod Yorumlayıcı araç çağrısından metin çıkışı.	Hayır

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Value	Açıklama
günlükler

runStepDetailsToolCallsCodeOutputImageObject

Adı	Tür	Açıklama	Zorunlu	Varsayılan
Tür	Dize	Her zaman `image`.	Yes
görüntü	nesne		Yes

Görüntü özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	Görüntünün Dosya Kimliği.

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Value	Açıklama
görüntü

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Adı	Tür	Açıklama	Zorunlu
dizin	integer	Çıkış dizisindeki çıkışın dizini.	Yes
Tür	Dize	Her zaman `image`.	Yes
görüntü	nesne		Hayır

Görüntü özellikleri

file_id

Adı	Tür	Açıklama	Varsayılan
file_id	Dize	Görüntünün dosya kimliği.

type Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Value	Açıklama
görüntü

runStepDetailsToolCallsFileSearchObject

Adı	Tür	Açıklama	Zorunlu
id	dize	Araç çağrısı nesnesinin kimliği.	Yes
Tür	Dize	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` .	Yes
file_search	nesne	Şimdilik bu her zaman boş bir nesne olacak.	Yes

type Enum: RunStepDetailsToolCallsFileSearchObjectType

Value	Açıklama
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

Adı	Tür	Açıklama	Zorunlu
dizin	integer	Araçtaki araç çağrısının dizini diziyi çağırır.	Yes
id	dize	Araç çağrısı nesnesinin kimliği.	Hayır
Tür	Dize	Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır `retrieval` .	Yes
file_search	nesne	Şimdilik bu her zaman boş bir nesne olacak.	Yes

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Value	Açıklama
file_search

runStepDetailsToolCallsFunctionObject

Adı	Tür	Açıklama	Zorunlu
id	dize	Araç çağrısı nesnesinin kimliği.	Yes
Tür	Dize	Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır `function` .	Yes
function	nesne	Çağrılan işlevin tanımı.	Yes

İşlevin özellikleri

Veri Akışı Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	İşlevin adı.

Bağımsız değişkenler

Adı	Tür	Açıklama	Varsayılan
Bağımsız değişken	Dize	İşleve geçirilen bağımsız değişkenler.

Çıktı

Ad	Tür	Açıklama	Varsayılan
çıkış	Dize	İşlevin çıkışı. Bu, çıkışlar henüz yapılmamışsa `submitted` olacaktır`null`.

type Enum: RunStepDetailsToolCallsFunctionObjectType

Value	Açıklama
function

runStepDeltaStepDetailsToolCallsFunctionObject

Adı	Tür	Açıklama	Zorunlu
dizin	integer	Araçtaki araç çağrısının dizini diziyi çağırır.	Yes
id	dize	Araç çağrısı nesnesinin kimliği.	Hayır
Tür	Dize	Araç çağrısının türü. Bu her zaman bu tür bir araç çağrısı için olacaktır `function` .	Yes
function	nesne	Çağrılan işlevin tanımı.	Hayır

İşlevin özellikleri

Veri Akışı Adı

Adı	Tür	Açıklama	Varsayılan
Adı	Dize	İşlevin adı.

Bağımsız değişkenler

Adı	Tür	Açıklama	Varsayılan
Bağımsız değişken	Dize	İşleve geçirilen bağımsız değişkenler.

Çıktı

Ad	Tür	Açıklama	Varsayılan
çıkış	Dize	İşlevin çıkışı. Bu, çıkışlar henüz gönderilmediyse olacaktır `null` .

type Enum: RunStepDetailsToolCallsFunctionObjectType

Value	Açıklama
function

vectorStoreExpirationAfter

Vektör deposu için süre sonu ilkesi.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
yer işareti	Dize	Süre sonu ilkesinin uygulanacağı bağlantı zaman damgası. Desteklenen tutturucular: `last_active_at`.	Yes
gün	integer	Vektör deposunun süresinin dolacağı yer işareti saatinden sonraki gün sayısı.	Yes

anchor Enum: VectorStoreExpirationAfterAnchor

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

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarında başvurulabilen tanımlayıcı.	Yes
nesne	enum	Her zaman `vector_store`olan nesne türü. Olası değerler: vector_store	Yes
created_at	integer	Vektör deposunun oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
ad	Dize	Vektör deposunun adı.	Yes
usage_bytes	integer	Vektör deposundaki dosyalar tarafından kullanılan toplam bayt sayısı.	Yes
file_counts	nesne		Yes
durum	Dize	, veya `completed`olabilir `expiredin_progress`vektör deposunun durumu. durumu `completed` , vektör deposunun kullanıma hazır olduğunu gösterir.	Yes
expires_after	vectorStoreExpirationAfter	Vektör deposu için süre sonu ilkesi.	Hayır
expires_at	integer	Vektör deposunun süresinin ne zaman dolacağı için Unix zaman damgası (saniye olarak).	Hayır
last_active_at	integer	Vektör deposunun en son etkin olduğu zaman için Unix zaman damgası (saniye olarak).	Yes
meta veriler	nesne	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.	Yes

file_counts özellikleri

in_progress

Adı	Tür	Açıklama	Varsayılan
in_progress	integer	İşlenmekte olan dosyaların sayısı.

Tamamlandı

Adı	Tür	Açıklama	Varsayılan
tamamlandı	integer	Başarıyla işlenen dosyaların sayısı.

Başarısız

Adı	Tür	Açıklama	Varsayılan
başarısız	integer	İşlenemeyen dosyaların sayısı.

İptal edildi

Adı	Tür	Açıklama	Varsayılan
Iptal	integer	İptal edilen dosya sayısı.

Toplam

Adı	Tür	Açıklama	Varsayılan
total	integer	Toplam dosya sayısı.

status Enum: VectorStoreObjectStatus

Value	Açıklama
Süresi dolmuş
in_progress
tamamlandı

createVectorStoreRequest

Adı	Tür	Açıklama	Zorunlu
file_ids	dizi	Vektör deposunun kullanması gereken dosya kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Hayır
Adı	Dize	Vektör deposunun adı.	Hayır
expires_after	vectorStoreExpirationAfter	Vektör deposu için süre sonu ilkesi.	Hayır
meta veriler	nesne	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ır

updateVectorStoreRequest

Adı	Tür	Açıklama	Zorunlu
Adı	Dize	Vektör deposunun adı.	Hayır
expires_after	vectorStoreExpirationAfter	Vektör deposu için süre sonu ilkesi.	Hayır
meta veriler	nesne	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ır

listVectorStoresResponse

Adı	Tür	Zorunlu
nesne	string	Yes
veriler	dizi	Yes
first_id	string	Yes
last_id	string	Yes
has_more	boolean	Yes

deleteVectorStoreResponse

Adı	Tür	Zorunlu
id	string	Yes
silindi	boolean	Yes
nesne	string	Yes

object Enum: DeleteVectorStoreResponseObject

Value	Açıklama
vector_store.deleted	Silinen vektör deposu yanıt nesnesi durumu

vectorStoreFileObject

Vektör deposuna eklenmiş dosyaların listesi.

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarında başvurulabilen tanımlayıcı.	Yes
nesne	Dize	Her zaman `vector_store.file`olan nesne türü.	Yes
usage_bytes	integer	Bayt cinsinden toplam vektör deposu kullanımı. Bunun özgün dosya boyutundan farklı olabileceğini unutmayın.	Yes
created_at	integer	Vektör deposu dosyasının oluşturulduğu zaman için Unix zaman damgası (saniye olarak).	Yes
vector_store_id	Dize	Dosyanın eklendiği vektör deposunun kimliği.	Yes
durum	Dize	, , `cancelled`veya `failed`olabilir `in_progresscompleted`vektör deposu dosyasının durumu. Durum `completed` , vektör deposu dosyasının kullanıma hazır olduğunu gösterir.	Yes
last_error	nesne	Bu vektör deposu dosyasıyla ilişkili son hata. Hata yoksa olacaktır `null` .	Yes

last_error özellikleri

Kod

Adı	Tür	Açıklama	Varsayılan
kod	Dize	veya `rate_limit_exceeded`'nin `server_error` biri.

İleti

Adı	Tür	Açıklama	Varsayılan
ileti	Dize	Hatanın insan tarafından okunabilen açıklaması.

object Enum: VectorStoreFileObjectType

Value	Açıklama
vector_store.file

status Enum: VectorStoreFileObjectStatus

Value	Açıklama
in_progress
tamamlandı
Iptal
başarısız

createVectorStoreFileRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
file_id	Dize	Vektör deposunun kullanması gereken dosya kimliği. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Yes

listVectorStoreFilesResponse

Adı	Tür	Zorunlu
nesne	string	Yes
veriler	dizi	Yes
first_id	string	Yes
last_id	string	Yes
has_more	boolean	Yes

deleteVectorStoreFileResponse

Adı	Tür	Zorunlu
id	string	Yes
silindi	boolean	Yes
nesne	string	Yes

object Enum: DeleteVectorStoreFileResponseObject

Value	Açıklama
vector_store.file.deleted

vectorStoreFileBatchObject

Vektör deposuna eklenmiş bir dosya grubu.

Adı	Tür	Açıklama	Zorunlu
id	dize	API uç noktalarında başvurulabilen tanımlayıcı.	Yes
nesne	Dize	Her zaman `vector_store.file_batch`olan nesne türü.	Yes
created_at	integer	Vektör depolama dosyaları toplu işleminin oluşturulduğu zaman için Unix zaman damgası (saniye cinsinden).	Yes
vector_store_id	Dize	Dosyanın bağlı olduğu vektör deposunun kimliği.	Yes
durum	Dize	Vektör deposu dosyaları toplu işleminin durumu , veya `failed`olabilir`in_progresscompletedcancelled`.	Yes
file_counts	nesne		Yes

file_counts özellikleri

in_progress

Adı	Tür	Açıklama	Varsayılan
in_progress	integer	İşlenmekte olan dosyaların sayısı.

Tamamlandı

Adı	Tür	Açıklama	Varsayılan
tamamlandı	integer	İşlenen dosyaların sayısı.

Başarısız

Adı	Tür	Açıklama	Varsayılan
başarısız	integer	İşlenemeyen dosyaların sayısı.

İptal edildi

Adı	Tür	Açıklama	Varsayılan
Iptal	integer	İptal edilen dosya sayısı.

Toplam

Adı	Tür	Açıklama	Varsayılan
total	integer	Toplam dosya sayısı.

object Enum: VectorStoreFileBatchObjectType

Value	Açıklama
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Value	Açıklama
in_progress
tamamlandı
Iptal
başarısız

createVectorStoreFileBatchRequest

Adı	Tür	Açıklama	Zorunlu	Varsayılan
file_ids	dizi	Vektör deposunun kullanması gereken Dosya Kimliklerinin listesi. Dosyalara erişebilecek gibi `file_search` araçlar için kullanışlıdır.	Yes

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.completed bir çalıştırma tamamlandığında vb. yayarızthread.run.created. 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:

thread.created

Yeni bir iş parçacığı oluşturulduğunda gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	threadObject	İleti içeren bir iş parçacığını temsil eder.	Yes

Veri: threadObject

Olay Sabit Listesi: ThreadStreamEventEnum

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

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Numaralandırması: RunStreamEventCreated

Value	Açıklama
thread.run.created

thread.run.queued

Bir çalıştırma bir duruma geçtiğinde queued gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventQueued

Value	Açıklama
thread.run.queued

thread.run.in_progress

Bir çalıştırma bir duruma geçtiğinde in_progress gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventInProgress

Value	Açıklama
thread.run.in_progress

thread.run.requires_action

Bir çalıştırma bir duruma geçtiğinde requires_action gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventRequiresAction

Value	Açıklama
thread.run.requires_action

thread.run.completed

Bir çalıştırma tamamlandığında gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventCompleted

Value	Açıklama
thread.run.completed

thread.run.failed

Çalıştırma başarısız olduğunda gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventFailed

Value	Açıklama
thread.run.failed

thread.run.cancelling

Bir çalıştırma bir duruma geçtiğinde cancelling gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventCancelling

Value	Açıklama
thread.run.cancelling

thread.run.cancelled

Bir çalıştırma iptal edildiğinde gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventCancelled

Value	Açıklama
thread.run.cancelled

thread.run.expired

Bir çalıştırmanın süresi dolduğunda gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runObject	bir iş parçacığındaki yürütme çalıştırmalarını temsil eder.	Yes

Veri: runObject

Olay Sabit Listesi: RunStreamEventExpired

Value	Açıklama
thread.run.expired

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.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runStepObject	Çalıştırmanın yürütülmesindeki bir adımı temsil eder.	Yes

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventCreated

Value	Açıklama
thread.run.step.created

thread.run.step.in_progress

Çalıştırma adımı bir in_progress duruma geçtiğinde gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runStepObject	Çalıştırmanın yürütülmesindeki bir adımı temsil eder.	Yes

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventInProgress

Value	Açıklama
thread.run.step.in_progress

thread.run.step.delta

Çalıştırma adımının bölümleri akışa alınırken gerçekleşir.

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

Veri: runStepDeltaObject

Olay Sabit Listesi: RunStepStreamEventDelta

Value	Açıklama
thread.run.step.delta

thread.run.step.completed

Bir çalıştırma adımı tamamlandığında gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runStepObject	Çalıştırmanın yürütülmesindeki bir adımı temsil eder.	Yes

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventCompleted

Value	Açıklama
thread.run.step.completed

thread.run.step.failed

Çalıştırma adımı başarısız olduğunda gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runStepObject	Çalıştırmanın yürütülmesindeki bir adımı temsil eder.	Yes

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventFailed

Value	Açıklama
thread.run.step.failed

thread.run.step.cancelled

Çalıştırma adımı iptal edildiğinde gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runStepObject	Çalıştırmanın yürütülmesindeki bir adımı temsil eder.	Yes

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventCancelled

Value	Açıklama
thread.run.step.cancelled

thread.run.step.expired

Çalıştırma adımının süresi dolduğunda gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	runStepObject	Çalıştırmanın yürütülmesindeki bir adımı temsil eder.	Yes

Veri: runStepObject

Olay Sabit Listesi: RunStepStreamEventExpired

Value	Açıklama
thread.run.step.expired

messageStreamEvent

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

thread.message.created

İleti oluşturulduğunda gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	messageObject	İş parçacığı içindeki bir iletiyi temsil eder.	Yes

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventCreated

Value	Açıklama
thread.message.created

thread.message.in_progress

İleti bir duruma geçtiğinde in_progress gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	messageObject	İş parçacığı içindeki bir iletiyi temsil eder.	Yes

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventInProgress

Value	Açıklama
thread.message.in_progress

thread.message.delta

İletinin bölümleri akışa alındığında gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	messageDeltaObject	Akış sırasında iletideki değiştirilmiş alanlar gibi bir ileti deltasını temsil eder.	Yes

Veri: messageDeltaObject

Olay Sabit Listesi: MessageStreamEventDelta

Value	Açıklama
thread.message.delta

thread.message.completed

İleti tamamlandığında gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	messageObject	İş parçacığı içindeki bir iletiyi temsil eder.	Yes

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventCompleted

Value	Açıklama
thread.message.completed

thread.message.incomplete

İleti tamamlanmadan önce sona erdiğinde gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	messageObject	İş parçacığı içindeki bir iletiyi temsil eder.	Yes

Veri: messageObject

Olay Sabit Listesi: MessageStreamEventIncomplete

Value	Açıklama
thread.message.incomplete

errorEvent

Bir hata oluştuğunda oluşur. Bu, iç sunucu hatası veya zaman aşımı nedeniyle oluşabilir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	hata		Yes

event Enum: ErrorEventEnum

Value	Açıklama
error

doneEvent

Bir akış sona erdiğinde gerçekleşir.

Adı	Tür	Açıklama	Zorunlu	Varsayılan
event	string		Yes
veriler	string		Yes

event Enum: DoneEventEnum

Value	Açıklama
done

data Enum: DoneEventDataEnum

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

Aracılığıyla paylaş

Azure OpenAI Hizmeti REST API önizleme başvurusu

API belirtimleri

Kimlik Doğrulaması

REST API sürümü oluşturma

Veri düzlemi çıkarımı

Tamamlamalar - Oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Kullanım özellikleri

completion_tokens

prompt_tokens

total_tokens

Örnekler

Örnek

Eklemeler - Oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Kullanım özellikleri

prompt_tokens

total_tokens

Örnekler

Örnek

Sohbet tamamlamaları - Oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

response_format özellikleri

Tür

Yanıtlar

Örnekler

Örnek

Örnek

Örnek

Örnek

Örnek

Örnek

Örnek

Örnek

Transkripsiyonlar - Oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Örnekler

Örnek

Örnek

Çeviriler - Oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Örnekler

Örnek

Örnek

Konuşma - Oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Örnekler

Örnek

Görüntü nesilleri - Oluşturma

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Örnekler

Örnek

Liste - Yardımcılar

URI Parametreleri

İstek Başlığı

Yanıtlar

Örnekler

Örnek

Oluşturma - Yardımcı