Not
Bu sayfaya erişim yetkilendirme gerektiriyor. Oturum açmayı veya dizinleri değiştirmeyi deneyebilirsiniz.
Bu sayfaya erişim yetkilendirme gerektiriyor. Dizinleri değiştirmeyi deneyebilirsiniz.
Bu makalede, Azure OpenAI için çıkarım REST API uç noktaları hakkında ayrıntılar sağlanır.
API belirtimleri
Azure OpenAI modellerini ve kaynaklarını yönetme ve bunlarla etkileşim kurma, üç birincil API yüzeyine ayrılır:
- Kontrol düzlemi
- Veri düzlemi - yazma
- Veri düzlemi - çıkarım
Her API yüzeyi/belirtimi farklı bir Azure OpenAI özellikleri kümesini kapsüller. Her API'nin kendi benzersiz önizleme ve kararlı/genel kullanıma açık (GA) API sürümleri vardır. Önizleme sürümleri şu anda aylık bir tempo takip etme eğilimindedir.
Önemli
Artık yeni bir önizleme çıkarım API'si vardır. API yaşam döngüsü kılavuzumuzdan daha fazla bilgi edinin.
Uygulama Programlama Arayüzü (API) | En son önizleme sürümü | En son GA sürümü | Özellikler | Açıklama |
---|---|---|---|---|
Kontrol düzlemi | 2024-06-01-preview |
2024-10-01 |
Belirtim dosyaları | Azure OpenAI, diğer tüm hizmetlerle ortak bir denetim düzlemi paylaşır. Denetim düzlemi API'si, Azure OpenAI kaynakları oluşturma, model dağıtımı ve diğer üst düzey kaynak yönetimi görevleri için kullanılır. Denetim düzlemi, Azure Resource Manager, Bicep, Terraform ve Azure CLI gibi özelliklerle neler yapabileceğinizi de yönetir. |
Veri düzlemi - yazma | 2025-04-01-preview |
2024-10-21 |
Belirtim dosyaları | Veri düzlemi yazma API'si ince ayarlama, dosya yükleme, alma işleri, toplu iş ve belirli model düzeyinde sorguları denetler |
Veri düzlemi - çıkarım | 2025-04-01-preview |
2024-10-21 |
Belirtim dosyaları | Veri düzlemi çıkarım API'si tamamlamalar, sohbet tamamlamaları, eklemeler, ses, verilerinize ekleme, Dall-e, yardımcılar vb. gibi özellikler için çıkarım özellikleri/uç noktaları sağlar. |
Kimlik doğrulama
Azure OpenAI, kimlik doğrulaması için iki yöntem sağlar. API Anahtarlarını veya Microsoft Entra Id'yi kullanabilirsiniz.
API Anahtarı kimlik doğrulaması: Bu kimlik doğrulaması türü için tüm API istekleri HTTP üst bilgisinde
api-key
API Anahtarını içermelidir. Hızlı Başlangıç, bu kimlik doğrulaması türüyle çağrı yapma konusunda rehberlik sağlar.Microsoft Entra Id kimlik doğrulaması: Microsoft Entra belirtecini kullanarak API çağrısının kimliğini doğrulayabilirsiniz. Kimlik doğrulama belirteçleri bir isteğe üst bilgi olarak
Authorization
eklenir. Sağlanan belirtecin önündeBearer
, örneğinBearer YOUR_AUTH_TOKEN
olmalıdır. Microsoft Entra Id ile kimlik doğrulamasıyla ilgili nasıl yapılır kılavuzumuzu okuyabilirsiniz.
REST API sürümü oluşturma
Hizmet API'lerinin sürümü api-version
sorgu parametresi kullanılarak oluşturulur. Tüm sürümler YYYY-AA-GG tarih yapısını izler. Örneğin:
POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01
Veri düzlemi çıkarımı
Makalenin geri kalanında Azure OpenAI veri düzlemi çıkarım belirtimi 2024-10-21
olan en son GA sürümü yer alır.
En son önizleme API'sinin sürümüyle ilgili belgeler arıyorsanız en son önizleme veri düzlemi çıkarım API'sine bakın
Tamamlamalar
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21
Sağlanan istem, parametreler ve seçilen model için bir tamamlama oluşturur.
URI Parametreleri
İsim | İçinde | Gerekli | Türü | Açıklama |
---|---|---|---|---|
uç nokta | yol | Evet | String 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 (yenileme kimliği) | yol | Evet | String | Dağıtılan modelin dağıtım kimliği. |
API-sürümü | soru | Evet | String | API sürümü |
İstek Başlığı
İsim | Gerekli | Türü | Açıklama |
---|---|---|---|
API anahtarı | Doğru | String | Azure OpenAI API anahtarını burada sağlayın |
İstek İçeriği
İçerik Türü: application/json
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Uyarı | dize veya dizi | Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi. |endoftext|< öğesinin>, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur. |
Evet | |
en iyi | tamsayı | Tamamlamaları best_of sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz.ile n kullanıldığında, best_of aday tamamlama sayısını denetler ve n döndürülecek sayı sayısını belirtir â€" best_of değerinin değerinden n büyük olması gerekir.Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokens için stop makul ayarlara sahip olduğunuzdan emin olun. |
Hayı | 1 |
yankı | Boolean | Tamamlamaya ek olarak istemi geri yankıla |
Hayı | Yanlış |
frekans cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak. |
Hayı | 0 |
logit önyargısı | object | Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (GPT belirteç oluşturucusunda belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, |endoftext| {"50256": -100} belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz>. |
Hayı | Hiç kimse |
logprobs | tamsayı | Günlük olasılıklarını logprobs en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise logprobs , API en olası beş belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür logprob , bu nedenle yanıtta en logprobs+1 fazla öğe olabilir.için logprobs en büyük değer 5'tir. |
Hayı | Hiç kimse |
maksimum_token | tamsayı | Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı. İsteminizin ve artı max_tokens değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz. |
Hayı | 16 |
n | tamsayı | Her istem için kaç tamamlama oluşturulacağı. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokens için stop makul ayarlara sahip olduğunuzdan emin olun. |
Hayı | 1 |
varlık cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır. |
Hayı | 0 |
tohum | tamsayı | Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir. |
Hayı | |
durmak | dize veya dizi | API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Döndürülen metin durdurma sırasını içermez. |
Hayı | |
yayın akışı | Boolean | Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. |
Hayı | Yanlış |
sonek | String | Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için gpt-3.5-turbo-instruct desteklenir. |
Hayı | Hiç kimse |
sıcaklık | Numara | 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
top_p | Numara | Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
kullanıcı | String | Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. |
Hayı |
Yanıtlar
Durum Kodu: 200
Açıklama: Tamam
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | createCompletionResponse | API'den bir tamamlama yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli paylaşır (sohbet uç noktasından farklı olarak). |
Durum Kodu: varsayılan
Açıklama: Hizmet kullanılamıyor
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | errorResponse |
Örnekler
Örnek
Sağlanan istem, parametreler ve seçilen model için bir tamamlama oluşturur.
POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21
{
"prompt": [
"tell me a joke about mango"
],
"max_tokens": 32,
"temperature": 1.0,
"n": 1
}
Yanıtlar: Durum Kodu: 200
{
"body": {
"id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
"created": 1686617332,
"choices": [
{
"text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
"index": 0,
"finish_reason": "stop",
"logprobs": null
}
],
"usage": {
"completion_tokens": 20,
"prompt_tokens": 6,
"total_tokens": 26
}
}
}
Eklemeler
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21
Makine öğrenmesi modelleri ve algoritmaları tarafından kolayca kullanılabilen belirli bir girişin vektör gösterimini alın.
URI Parametreleri
İsim | İçinde | Gerekli | Türü | Açıklama |
---|---|---|---|---|
uç nokta | yol | Evet | String 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 (yenileme kimliği) | yol | Evet | String | |
API-sürümü | soru | Evet | String | API sürümü |
İstek Başlığı
İsim | Gerekli | Türü | Açıklama |
---|---|---|---|
API anahtarı | Doğru | String | Azure OpenAI API anahtarını burada sağlayın |
İstek İçeriği
İçerik Türü: application/json
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
girdi | dize veya dizi | Eklemek için metin girin, dize veya belirteç dizisi olarak kodlanmış. Tek bir isteğe birden çok giriş eklemek için bir dizi dize veya belirteç dizisi geçirin. Giriş, model için maksimum giriş belirteçlerini aşmamalıdır (için text-embedding-ada-002 8.192 belirteç), boş bir dize olamaz ve herhangi bir dizi 2.048 boyut veya daha az olmalıdır. |
Evet | |
kullanıcı | String | Kötüye kullanımı izlemeye ve algılamaya yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. | Hayı | |
girdi_tipi | String | kullanılacak ekleme aramasının giriş türü | Hayı | |
kodlama_formatı | String | Eklemelerin döndürüleceği biçim. veya float olabilirbase64 . Varsayılan olarak float değerini alır. |
Hayı | |
boyutlar | tamsayı | Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca ve sonraki modellerde text-embedding-3 desteklenir. |
Hayı |
Yanıtlar
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
object | String | Evet | ||
örnek | String | Evet | ||
veriler | array | Evet | ||
kullanım | object | Evet |
Kullanım özellikleri
istem_jetonları
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
istem_jetonları | tamsayı |
toplam jetonlar
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
toplam jetonlar | tamsayı |
Durum Kodu: 200
Açıklama: Tamam
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | object |
Örnekler
Örnek
Belirli bir istem için eklemeleri döndürür.
POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21
{
"input": [
"this is a test"
]
}
Yanıtlar: Durum Kodu: 200
{
"body": {
"data": [
{
"index": 0,
"embedding": [
-0.012838088,
-0.007421397,
-0.017617522,
-0.028278312,
-0.018666342,
0.01737855,
-0.01821495,
-0.006950092,
-0.009937238,
-0.038580645,
0.010674067,
0.02412286,
-0.013647936,
0.013189907,
0.0021125758,
0.012406612,
0.020790534,
0.00074595667,
0.008397198,
-0.00535031,
0.008968075,
0.014351576,
-0.014086051,
0.015055214,
-0.022211088,
-0.025198232,
0.0065186154,
-0.036350243,
0.009180495,
-0.009698266,
0.009446018,
-0.008463579,
-0.0040426035,
-0.03443847,
-0.00091273896,
-0.0019217303,
0.002349888,
-0.021560553,
0.016515596,
-0.015572986,
0.0038666942,
-8.432463e-05
]
}
],
"usage": {
"prompt_tokens": 4,
"total_tokens": 4
}
}
}
Sohbet bitişleri
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21
Sohbet iletisi için tamamlama oluşturur
URI Parametreleri
İsim | İçinde | Gerekli | Türü | Açıklama |
---|---|---|---|---|
uç nokta | yol | Evet | String 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 (yenileme kimliği) | yol | Evet | String | Dağıtılan modelin dağıtım kimliği. |
API-sürümü | soru | Evet | String | API sürümü |
İstek Başlığı
İsim | Gerekli | Türü | Açıklama |
---|---|---|---|
API anahtarı | Doğru | String | Azure OpenAI API anahtarını burada sağlayın |
İstek İçeriği
İçerik Türü: application/json
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
sıcaklık | Numara | 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
top_p | Numara | Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
yayın akışı | Boolean | Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. |
Hayı | Yanlış |
durmak | dize veya dizi | API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. |
Hayı | |
maksimum_token | tamsayı | Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı. Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır. |
Hayı | |
maksimum_tamamlama_tokenları | tamsayı | Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır. | Hayı | |
varlık cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır. |
Hayı | 0 |
frekans cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak. |
Hayı | 0 |
logit önyargısı | object | Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. |
Hayı | Hiç kimse |
kullanıcı | String | Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. |
Hayı | |
iletiler | array | Şu ana kadarki konuşmayı içeren iletilerin listesi. | Evet | |
veri kaynakları | array | Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur. |
Hayı | |
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. |
Hayı | Yanlış |
top_logprobs | tamsayı | Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.
logprobs bu parametre kullanılıyorsa olarak ayarlanmalıdır true . |
Hayı | |
n | tamsayı | Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceksiniz. Maliyetleri en aza indirmek için farklı n tutun1 . |
Hayı | 1 |
paralel araç çağrıları | ParallelToolCalls | Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. | Hayı | Doğru |
yanıt formatı | ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema | Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşeceğini garanti eden Yapılandırılmış Çıkışlar'ı etkinleştirir.ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğunu garanti eden JSON modunu etkinleştirir.Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını finish_reason="length" gösteren ileti max_tokens içeriğinin kısmen kesilebileceğini unutmayın. |
Hayı | |
tohum | tamsayı | Bu özellik Beta sürümündedir. Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir. |
Hayı | |
araçlar | array | Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın. En fazla 128 işlev desteklenir. |
Hayı | |
araç seçimi | chatCompletionToolChoiceOption | Model tarafından çağrılan aracı (varsa) denetler.
none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla {"type": "function", "function": {"name": "my_function"}} belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar.
none hiçbir araç mevcut olmadığında varsayılan değerdir.
auto araçlar varsa varsayılan değerdir. |
Hayı | |
fonksiyon çağrısı | string veya chatCompletionFunctionCallOption | yerine tool_choice kullanım dışı bırakıldı.Model tarafından çağrılan (varsa) işlevi denetler. none modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.auto , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir.aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.none , hiçbir işlev mevcut olmadığında varsayılan değerdir.
auto , işlevler varsa varsayılan değerdir. |
Hayı | |
fonksiyonlar | array | yerine tools kullanım dışı bırakıldı.Modelin JSON girişleri oluşturabileceği işlevlerin listesi. |
Hayı |
Yanıtlar
Durum Kodu: 200
Açıklama: Tamam
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | createChatCompletionResponse veya createChatCompletionStreamResponse |
Durum Kodu: varsayılan
Açıklama: Hizmet kullanılamıyor
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | errorResponse |
Örnekler
Örnek
Sağlanan istem, parametreler ve seçilen model için bir tamamlama oluşturur.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21
{
"messages": [
{
"role": "system",
"content": "you are a helpful assistant that talks like a pirate"
},
{
"role": "user",
"content": "can you tell me how to care for a parrot?"
}
]
}
Yanıtlar: Durum Kodu: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
Örnek
Azure Search verilerini ve sistem tarafından atanan yönetilen kimliği temel alan bir tamamlama oluşturur.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "azure_search",
"parameters": {
"endpoint": "https://your-search-endpoint.search.windows.net/",
"index_name": "{index name}",
"authentication": {
"type": "system_assigned_managed_identity"
}
}
}
]
}
Yanıtlar: Durum Kodu: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content.",
"title": "Citation Title",
"filepath": "contoso.txt",
"url": "https://contoso.blob.windows.net/container/contoso.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
Örnek
Azure Search vektör verilerine, önceki yardımcı iletisine ve kullanıcı tarafından atanan yönetilen kimliğe göre bir tamamlama oluşturur.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a cat?"
},
{
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"intent": "cat care"
}
},
{
"role": "user",
"content": "how about dog?"
}
],
"data_sources": [
{
"type": "azure_search",
"parameters": {
"endpoint": "https://your-search-endpoint.search.windows.net/",
"authentication": {
"type": "user_assigned_managed_identity",
"managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
},
"index_name": "{index name}",
"query_type": "vector",
"embedding_dependency": {
"type": "deployment_name",
"deployment_name": "{embedding deployment name}"
},
"in_scope": true,
"top_n_documents": 5,
"strictness": 3,
"role_information": "You are an AI assistant that helps people find information.",
"fields_mapping": {
"content_fields_separator": "\\n",
"content_fields": [
"content"
],
"filepath_field": "filepath",
"title_field": "title",
"url_field": "url",
"vector_fields": [
"contentvector"
]
}
}
}
]
}
Yanıtlar: Durum Kodu: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content 2.",
"title": "Citation Title 2",
"filepath": "contoso2.txt",
"url": "https://contoso.blob.windows.net/container/contoso2.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
Örnek
Sağlanan Azure Cosmos DB için bir tamamlama oluşturur.
POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21
{
"messages": [
{
"role": "user",
"content": "can you tell me how to care for a dog?"
}
],
"data_sources": [
{
"type": "azure_cosmos_db",
"parameters": {
"authentication": {
"type": "connection_string",
"connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
},
"database_name": "vectordb",
"container_name": "azuredocs",
"index_name": "azuredocindex",
"embedding_dependency": {
"type": "deployment_name",
"deployment_name": "{embedding deployment name}"
},
"fields_mapping": {
"content_fields": [
"content"
],
"vector_fields": [
"contentvector"
]
}
}
}
]
}
Yanıtlar: Durum Kodu: 200
{
"body": {
"id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
"created": 1686676106,
"choices": [
{
"index": 0,
"finish_reason": "stop",
"message": {
"role": "assistant",
"content": "Content of the completion [doc1].",
"context": {
"citations": [
{
"content": "Citation content.",
"title": "Citation Title",
"filepath": "contoso.txt",
"url": "https://contoso.blob.windows.net/container/contoso.txt",
"chunk_id": "0"
}
],
"intent": "dog care"
}
}
}
],
"usage": {
"completion_tokens": 557,
"prompt_tokens": 33,
"total_tokens": 590
}
}
}
Transkripsiyonlar - Oluşturma
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21
Sesi giriş diline ayırır.
URI Parametreleri
İsim | İçinde | Gerekli | Türü | Açıklama |
---|---|---|---|---|
uç nokta | yol | Evet | String 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 (yenileme kimliği) | yol | Evet | String | Sesli yazılım modelinin dağıtım kimliği. Desteklenen modeller hakkında bilgi için bkz. [/azure/ai-services/openai/concepts/models#audio-models]. |
API-sürümü | soru | Evet | String | API sürümü |
İstek Başlığı
İsim | Gerekli | Türü | Açıklama |
---|---|---|---|
API anahtarı | Doğru | String | Azure OpenAI API anahtarını burada sağlayın |
İstek İçeriği
İçerik Türü: çok parçalı/form-veri
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
dosya | String | Dökümü yapılan ses dosyası nesnesi. | Evet | |
Uyarı | String | Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir. | Hayı | |
yanıt formatı | audioResponseFormat | Çıkışın biçimini tanımlar. | Hayı | |
sıcaklık | Numara | Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır. | Hayı | 0 |
dil | String | Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır. | Hayı |
Yanıtlar
Durum Kodu: 200
Açıklama: Tamam
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | audioResponse veya audioVerboseResponse | |
düz metin | String | Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda). |
Örnekler
Örnek
Sağlanan konuşulan ses verilerinden dökümü alınmış metinleri ve ilişkili meta verileri alır.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21
Yanıtlar: Durum Kodu: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Örnek
Sağlanan konuşulan ses verilerinden dökümü alınmış metinleri ve ilişkili meta verileri alır.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Yanıtlar: Durum Kodu: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Çeviriler - Oluşturma
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21
Giriş sesinin dökümünü alır ve İngilizce metne çevirir.
URI Parametreleri
İsim | İçinde | Gerekli | Türü | Açıklama |
---|---|---|---|---|
uç nokta | yol | Evet | String 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 (yenileme kimliği) | yol | Evet | String | Dağıtılan fısıltı modelinin dağıtım kimliği. Desteklenen modeller hakkında bilgi için bkz. [/azure/ai-services/openai/concepts/models#audio-models]. |
API-sürümü | soru | Evet | String | API sürümü |
İstek Başlığı
İsim | Gerekli | Türü | Açıklama |
---|---|---|---|
API anahtarı | Doğru | String | Azure OpenAI API anahtarını burada sağlayın |
İstek İçeriği
İçerik Türü: çok parçalı/form-veri
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
dosya | String | Çevrilecek ses dosyası. | Evet | |
Uyarı | String | Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır. | Hayı | |
yanıt formatı | audioResponseFormat | Çıkışın biçimini tanımlar. | Hayı | |
sıcaklık | Numara | Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır. | Hayı | 0 |
Yanıtlar
Durum Kodu: 200
Açıklama: Tamam
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | audioResponse veya audioVerboseResponse | |
düz metin | String | Çıktı biçimindeki metinlerin dökümünü alın (response_format metin, vtt veya srt'lerden biri olduğunda). |
Örnekler
Örnek
Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri alır.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Yanıtlar: Durum Kodu: 200
{
"body": {
"text": "A structured object when requesting json or verbose_json"
}
}
Örnek
Sağlanan konuşulan ses verilerinden İngilizce dil dökümü metni ve ilişkili meta verileri alır.
POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21
"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"
Yanıtlar: Durum Kodu: 200
{
"type": "string",
"example": "plain text when requesting text, srt, or vtt"
}
Görüntü oluşturma
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21
Belirli bir dall-e modeli dağıtımında metin başlığından bir toplu görüntü oluşturur
URI Parametreleri
İsim | İçinde | Gerekli | Türü | Açıklama |
---|---|---|---|---|
uç nokta | yol | Evet | String 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 (yenileme kimliği) | yol | Evet | String | Dağıtılan dall-e modelinin dağıtım kimliği. |
API-sürümü | soru | Evet | String | API sürümü |
İstek Başlığı
İsim | Gerekli | Türü | Açıklama |
---|---|---|---|
API anahtarı | Doğru | String | Azure OpenAI API anahtarını burada sağlayın |
İstek İçeriği
İçerik Türü: application/json
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Uyarı | String | İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir. | Evet | |
n | tamsayı | Oluşturulacak görüntü sayısı. | Hayı | 1 |
boyut | imageSize | Oluşturulan görüntülerin boyutu. | Hayı | 1024x1024 |
yanıt formatı | imagesResponseFormat | Oluşturulan görüntülerin döndürüldiği biçim. | Hayı | URL |
kullanıcı | String | Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. | Hayı | |
nitelik | imageQuality | Oluşturulacak görüntünün kalitesi. | Hayı | standart |
stil | imageStyle | Oluşturulan görüntülerin stili. | Hayı | Canlı |
Yanıtlar
Durum Kodu: 200
Açıklama: Tamam
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | generateImagesResponse |
Durum Kodu: varsayılan
Açıklama: Bir hata oluştu.
İçerik Türü | Türü | Açıklama |
---|---|---|
uygulama/json | dalleErrorResponse |
Örnekler
Örnek
İstendiğinde görüntüler oluşturur.
POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21
{
"prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
"n": 1,
"style": "natural",
"quality": "standard"
}
Yanıtlar: Durum Kodu: 200
{
"body": {
"created": 1698342300,
"data": [
{
"revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
"prompt_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
},
"profanity": {
"detected": false,
"filtered": false
}
},
"url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
"content_filter_results": {
"sexual": {
"severity": "safe",
"filtered": false
},
"violence": {
"severity": "safe",
"filtered": false
},
"hate": {
"severity": "safe",
"filtered": false
},
"self_harm": {
"severity": "safe",
"filtered": false
}
}
}
]
}
}
Bileşenler
hataYanıtı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
hata | hata | Hayı |
errorBase
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kod | String | Hayı | ||
mesaj | String | Hayı |
hata
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
param | String | Hayı | ||
tür | String | Hayı | ||
iç hata | innerError | Ek ayrıntılar içeren iç hata. | Hayı |
iç hata
Ek ayrıntılar içeren iç hata.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kod | innerErrorCode | İç hata nesnesi için hata kodları. | Hayı | |
içerik_filtreleme_sonuçları | contentFilterPromptResults | İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz. | Hayı |
içHataKodu
İç hata nesnesi için hata kodları.
Açıklama: İç hata nesnesi için hata kodları.
Tür: dize
Varsayılan:
Enum Adı: InnerErrorCode
Sabit Listesi Değerleri:
Değer | Açıklama |
---|---|
Sorumlu Yapay Zeka Politikası İhlali | İstem, diğer içerik filtresi kurallarından birini ihlal etti. |
dalleErrorResponse
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
hata | dalleError | Hayı |
dalleError
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
param | String | Hayı | ||
tür | String | Hayı | ||
iç hata | dalleInnerError | Ek ayrıntılar içeren iç hata. | Hayı |
dalleInnerError
Ek ayrıntılar içeren iç hata.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kod | innerErrorCode | İç hata nesnesi için hata kodları. | Hayı | |
içerik_filtreleme_sonuçları | dalleFilterResults | İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz. | Hayı | |
düzeltilmiş_yazı | String | İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem. | Hayı |
içerikFiltreSonucuTabanı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Filtre | Boolean | Evet |
içerik filtresi ciddiyet sonucu
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Filtre | Boolean | Evet | ||
ciddiyet | String | Hayı |
içerik filtresi algılandı sonucu
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Filtre | Boolean | Evet | ||
Algılandı | Boolean | Hayı |
İçerik Filtresi Algılandı (Alıntıyla Sonuçlandı)
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Alıntı | object | Hayı |
Alıntı özellikleri
URL
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
URL | String |
lisans
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
lisans | String |
içerik filtre sonuç temeli
İçerik filtreleme sonuçları hakkında bilgi.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
seksüel | contentFilterSeverityResult | Hayı | ||
şiddet | contentFilterSeverityResult | Hayı | ||
nefret | contentFilterSeverityResult | Hayı | ||
kendine zarar verme | contentFilterSeverityResult | Hayı | ||
Küfür | içerik filtresi tespit edilen sonuç | Hayı | ||
hata | errorBase | Hayı |
içerik filtresi istem sonuçları
İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
seksüel | contentFilterSeverityResult | Hayı | ||
şiddet | contentFilterSeverityResult | Hayı | ||
nefret | contentFilterSeverityResult | Hayı | ||
kendine zarar verme | contentFilterSeverityResult | Hayı | ||
Küfür | içerik filtresi tespit edilen sonuç | Hayı | ||
hata | errorBase | Hayı | ||
Jailbreak | içerik filtresi tespit edilen sonuç | Hayı |
İçerik Filtre Seçimi Sonuçları
İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Üçüncü taraf metin ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
seksüel | contentFilterSeverityResult | Hayı | ||
şiddet | contentFilterSeverityResult | Hayı | ||
nefret | contentFilterSeverityResult | Hayı | ||
kendine zarar verme | contentFilterSeverityResult | Hayı | ||
Küfür | içerik filtresi tespit edilen sonuç | Hayı | ||
hata | errorBase | Hayı | ||
korunan_malzeme_metni | içerik filtresi tespit edilen sonuç | Hayı | ||
korunan_malzeme_kodu | içerik Filtresi Algılandı ve Alıntı Sonucu | Hayı |
uyarı filtre sonucu
İstekteki tek bir istem için içerik filtreleme sonuçları.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
komut_dizini | tamsayı | Hayı | ||
içerik_filtreleme_sonuçları | contentFilterPromptResults | İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz. | Hayı |
Sonuçları Filtrele
İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir.
Bu bileşen için tanımlı özellik yok.
dalleİçerikFiltrelemeSonuçları
İçerik filtreleme sonuçları hakkında bilgi.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
seksüel | contentFilterSeverityResult | Hayı | ||
şiddet | contentFilterSeverityResult | Hayı | ||
nefret | İçerik Filtresi Şiddet Sonucu | Hayı | ||
kendine zarar verme | contentFilterSeverityResult | Hayı |
dalleFiltreSonuçları
İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
seksüel | Content Filtre Şiddet Sonucu | Hayı | ||
şiddet | contentFilterSeverityResult | Hayı | ||
nefret | contentFilterSeverityResult | Hayı | ||
kendine zarar verme | İçerik Filtresi Ciddiyet Sonucu | Hayı | ||
Küfür | içerik filtresi tespit edilen sonuç | Hayı | ||
Jailbreak | içerik filtresi tespit edilen sonuç | Hayı |
sohbetTamamlamaİstekOrtak
İsim | Türü | Açıklama | Gerekli | 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ı | 1 |
top_p | Numara | Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
yayın akışı | Boolean | Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. |
Hayı | Yanlış |
durmak | dize veya dizi | API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. | Hayı | |
maksimum_token | tamsayı | Oluşturulan yanıt için izin verilen en fazla belirteç sayısı. Varsayılan olarak, modelin döndürebileceği belirteç sayısı olacaktır (4096 - istem belirteçleri). Bu değer artık yerine kullanım dışı bırakılmıştır max_completion_tokens ve o1 serisi modelleriyle uyumlu değildir. |
Hayı | 4096 |
maksimum_tamamlama_tokenları | tamsayı | Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır. | Hayı | |
varlık cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır. | Hayı | 0 |
frekans cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak. | Hayı | 0 |
logit önyargısı | object | Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir json nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. | Hayı | |
kullanıcı | String | Azure OpenAI'nin kötüye kullanımı izlemesine ve algılamasına yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. | Hayı |
TamamlamaİsteğiOluştur
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Uyarı | dize veya dizi | Dize olarak kodlanmış, dize dizisi, belirteç dizisi veya belirteç dizi dizisi için tamamlamalar oluşturma istemi. |endoftext|< öğesinin>, modelin eğitim sırasında gördüğü belge ayırıcısı olduğunu unutmayın. Bu nedenle, bir istem belirtilmezse model, yeni belgenin başından itibaren oluşturulmuş gibi oluşturulur. |
Evet | |
en iyi | tamsayı | Tamamlamaları best_of sunucu tarafı oluşturur ve "en iyi" değerini (belirteç başına en yüksek günlük olasılığına sahip olan) döndürür. Sonuçlar akışla aktarılamaz.ile n kullanıldığında, best_of aday tamamlama sayısını denetler ve n döndürülecek sayı sayısını belirtir â€" best_of değerinin değerinden n büyük olması gerekir.Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokens için stop makul ayarlara sahip olduğunuzdan emin olun. |
Hayı | 1 |
yankı | Boolean | Tamamlamaya ek olarak istemi geri yankıla |
Hayı | Yanlış |
frekans cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak. |
Hayı | 0 |
logit önyargısı | object | Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (GPT belirteç oluşturucusunda belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. Örneğin, |endoftext| {"50256": -100} belirtecinin oluşturulmasını <önlemek için geçirebilirsiniz>. |
Hayı | Hiç kimse |
logprobs | tamsayı | Günlük olasılıklarını logprobs en olası çıkış belirteçlerine ve seçilen belirteçlere ekleyin. Örneğin, 5 ise logprobs , API en olası beş belirtecin listesini döndürür. API her zaman örneklenen belirtecin değerini döndürür logprob , bu nedenle yanıtta en logprobs+1 fazla öğe olabilir.için logprobs en büyük değer 5'tir. |
Hayı | Hiç kimse |
maksimum_token | tamsayı | Tamamlanma sırasında oluşturulabilecek en fazla belirteç sayısı. İsteminizin ve artı max_tokens değerin belirteç sayısı modelin bağlam uzunluğunu aşamaz. |
Hayı | 16 |
n | tamsayı | Her istem için kaç tamamlama oluşturulacağı. Not: Bu parametre birçok tamamlama oluşturduğundan belirteç kotanızı hızla kullanabilir. dikkatle kullanın ve ve max_tokens için stop makul ayarlara sahip olduğunuzdan emin olun. |
Hayı | 1 |
varlık cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır. |
Hayı | 0 |
tohum | tamsayı | Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir. |
Hayı | |
durmak | dize veya dizi | API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. Döndürülen metin durdurma sırasını içermez. |
Hayı | |
yayın akışı | Boolean | Kısmi ilerlemenin akışla geri aktarılıp aktarılmayacağı. Ayarlanırsa, belirteçler kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. |
Hayı | Yanlış |
sonek | String | Eklenen metnin tamamlanmasından sonra gelen sonek. Bu parametre yalnızca için gpt-3.5-turbo-instruct desteklenir. |
Hayı | Hiç kimse |
sıcaklık | Numara | 0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. Genellikle bunu değiştirmenizi öneririz top_p ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
top_p | Numara | Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
kullanıcı | String | Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. |
Hayı |
tamamlama cevabı oluştur
API'den bir tamamlama yanıtını temsil eder. Not: Hem akışlı hem de akışsız yanıt nesneleri aynı şekli paylaşır (sohbet uç noktasından farklı olarak).
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kimlik | String | Tamamlanma için benzersiz bir tanımlayıcı. | Evet | |
Seçenek | array | Giriş istemi için modelin oluşturduğu tamamlama seçeneklerinin listesi. | Evet | |
Oluşturulan | tamsayı | Tamamlanmanın oluşturulduğu Unix zaman damgası (saniye olarak). | Evet | |
örnek | String | Tamamlanmak için kullanılan model. | Evet | |
sonuçları_filtrele_giriş | promptFilterResults | İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir. | Hayı | |
sistem parmak izi | String | Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle seed birlikte kullanılabilir. |
Hayı | |
object | enum | Her zaman "text_completion" olan nesne türü Olası değerler: text_completion |
Evet | |
kullanım | tamamlama kullanımı | Tamamlanma isteği için kullanım istatistikleri. | Hayı |
SohbetTamamlanmaTalebiOluştur
İsim | Türü | Açıklama | Gerekli | 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ı | 1 |
top_p | Numara | Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu değiştirmenizi öneririz temperature ancak ikisini birden değiştirmemenizi öneririz. |
Hayı | 1 |
yayın akışı | Boolean | Ayarlanırsa, ChatGPT'deki gibi kısmi ileti değişimleri gönderilir. Belirteçler, kullanılabilir hale geldikçe yalnızca veri sunucu tarafından gönderilen olaylar olarak gönderilir ve akış bir data: [DONE] ileti tarafından sonlandırılır. |
Hayı | Yanlış |
durmak | dize veya dizi | API'nin başka belirteçler üretmeyi durduracağı en fazla dört dizi. |
Hayı | |
maksimum_token | tamsayı | Sohbet tamamlandığında oluşturulabilecek en fazla belirteç sayısı. Giriş belirteçlerinin ve oluşturulan belirteçlerin toplam uzunluğu modelin bağlam uzunluğuyla sınırlıdır. |
Hayı | |
maksimum_tamamlama_tokenları | tamsayı | Görünür çıkış belirteçleri ve muhakeme belirteçleri de dahil olmak üzere tamamlanmak üzere oluşturulabilecek belirteç sayısı için üst sınır. | Hayı | |
varlık cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metinde şu ana kadar görünip görünmediklerine göre cezalandırarak modelin yeni konularla ilgili konuşma olasılığını artırır. |
Hayı | 0 |
frekans cezası | Numara | -2,0 ile 2,0 arasında bir sayı. Pozitif değerler, yeni belirteçleri metindeki mevcut sıklıklarına göre cezalandırarak modelin aynı satır açıklamasını yineleme olasılığını azaltarak. |
Hayı | 0 |
logit önyargısı | object | Belirtilen belirteçlerin tamamlanmada görünme olasılığını değiştirin. Belirteçleri (belirteç oluşturucudaki belirteç kimliğiyle belirtilen) -100 ile 100 arasındaki ilişkili bir sapma değeriyle eşleyen bir JSON nesnesi kabul eder. Matematiksel olarak sapma, örneklemeden önce model tarafından oluşturulan logit'lere eklenir. Tam etki modele göre değişir, ancak -1 ile 1 arasındaki değerler seçim olasılığını azaltmalı veya artırmalıdır; -100 veya 100 gibi değerler, ilgili belirtecin yasaklanması veya özel olarak seçilmesiyle sonuçlanmalıdır. |
Hayı | Hiç kimse |
kullanıcı | String | Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. |
Hayı | |
iletiler | array | Şu ana kadarki konuşmayı içeren iletilerin listesi. | Evet | |
veri kaynakları | array | Bunları kullanan Azure OpenAI sohbet uzantıları için yapılandırma girişleri. Bu ek belirtim yalnızca Azure OpenAI ile uyumludur. |
Hayı | |
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. |
Hayı | Yanlış |
top_logprobs | tamsayı | Her biri ilişkili günlük olasılığına sahip her belirteç konumunda döndürülecek en olası belirteç sayısını belirten 0 ile 20 arasında bir tamsayı.
logprobs bu parametre kullanılıyorsa olarak ayarlanmalıdır true . |
Hayı | |
n | tamsayı | Her giriş iletisi için oluşturulacak sohbet tamamlama seçenekleri. Tüm seçeneklerde oluşturulan belirteç sayısına göre ücretlendirileceksiniz. Maliyetleri en aza indirmek için farklı n tutun1 . |
Hayı | 1 |
paralel araç çağrıları | ParallelToolCalls | Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği. | Hayı | Doğru |
yanıt formatı | ResponseFormatText veya ResponseFormatJsonObject veya ResponseFormatJsonSchema | Modelin çıkış yapması gereken biçimi belirten bir nesne. GPT-4o ayarı, { "type": "json_schema", "json_schema": {...} } modelin sağlanan JSON şemanızla eşleşeceğini garanti eden Yapılandırılmış Çıkışlar'ı etkinleştirir.ayarı { "type": "json_object" } , modelin oluşturduğu iletinin geçerli JSON olduğunu garanti eden JSON modunu etkinleştirir.Önemli: JSON modunu kullanırken, modele bir sistem veya kullanıcı iletisi aracılığıyla kendiniz JSON üretmesini de belirtmeniz gerekir . Bu olmadan model, nesil belirteç sınırına ulaşana kadar bitmeyen bir boşluk akışı oluşturabilir ve bu da uzun süre çalışan ve görünüşe göre "takılmış" bir istekle sonuçlanır. Ayrıca, neslin aşıldığını veya konuşmanın maksimum bağlam uzunluğunu aştığını finish_reason="length" gösteren ileti max_tokens içeriğinin kısmen kesilebileceğini unutmayın. |
Hayı | |
tohum | tamsayı | Bu özellik Beta sürümündedir. Belirtilirse sistemimiz, aynı ve parametrelere sahip yinelenen isteklerin aynı seed sonucu döndürmesi için belirleyici bir şekilde örneklemek için en iyi çabayı gösterir.Determinizm garanti değildir ve arka uçtaki system_fingerprint değişiklikleri izlemek için yanıt parametresine başvurmanız gerekir. |
Hayı | |
araçlar | array | Modelin çağırabileceği araçların listesi. Şu anda araç olarak yalnızca işlevler desteklenmektedir. Modelin JSON girişleri oluşturabileceği işlevlerin listesini sağlamak için bunu kullanın. En fazla 128 işlev desteklenir. |
Hayı | |
araç seçimi | chatCompletionToolChoiceOption | Model tarafından çağrılan aracı (varsa) denetler.
none modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
required modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla {"type": "function", "function": {"name": "my_function"}} belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar.
none hiçbir araç mevcut olmadığında varsayılan değerdir.
auto araçlar varsa varsayılan değerdir. |
Hayı | |
fonksiyon çağrısı | string veya chatCompletionFunctionCallOption | yerine tool_choice kullanım dışı bırakıldı.Model tarafından çağrılan (varsa) işlevi denetler. none modelin işlev çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.auto , modelin ileti oluşturma veya işlev çağırma arasında seçim yapabileceğiniz anlamına gelir.aracılığıyla {"name": "my_function"} belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.none , hiçbir işlev mevcut olmadığında varsayılan değerdir.
auto , işlevler varsa varsayılan değerdir. |
Hayı | |
fonksiyonlar | array | yerine tools kullanım dışı bırakıldı.Modelin JSON girişleri oluşturabileceği işlevlerin listesi. |
Hayı |
sohbetTamamlamaFonksiyonları
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Açıklama | String | İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması. | Hayı | |
isim | String | Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir. | Evet | |
Parametreler | FunctionParameters | İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.
Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar. |
Hayı |
sohbetTamamlamaFonksiyonÇağrıSeçeneği
aracılığıyla {"name": "my_function"}
belirli bir işlevin belirtilmesi, modeli bu işlevi çağırmaya zorlar.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
isim | String | Çağrılacak işlevin adı. | Evet |
sohbetTamamlamaİstekMesajı
Bu bileşen aşağıdakilerden biri olabilir:
sohbetTamamlamaIstegiSistemMesaji
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
içerik | dize veya dizi | Sistem iletisinin içeriği. | Evet | |
rol | enum | İleti yazarının rolü( bu örnekte system ).Olası değerler: sistem |
Evet | |
isim | String | Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar. | Hayı |
SohbetTamamlamaİsteğiKullanıcıMesajı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
içerik | dize veya dizi | Kullanıcı iletisinin içeriği. |
Evet | |
rol | enum | İleti yazarının rolü( bu örnekte user ).Olası değerler: kullanıcı |
Evet | |
isim | String | Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar. | Hayı |
Sohbet Tamamlama İsteği Yardımcı Mesajı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
içerik | dize veya dizi | Yardımcı iletisinin içeriği. Veya belirtilmediği sürece tool_calls function_call gereklidir. |
Hayı | |
Ret | String | Asistanın reddetme mesajı. | Hayı | |
rol | enum | İleti yazarının rolü( bu örnekte assistant ).Olası değerler: yardımcı |
Evet | |
isim | String | Katılımcı için isteğe bağlı bir ad. Aynı rolün katılımcılarını ayırt etmek için model bilgilerini sağlar. | Hayı | |
araç çağrıları | chatCompletionMessageToolCalls | Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar. | Hayı | |
fonksiyon çağrısı | object | kullanım dışı bırakıldı ve tarafından tool_calls değiştirildi. Model tarafından oluşturulduğu gibi çağrılması gereken bir işlevin adı ve bağımsız değişkenleri. |
Hayı |
function_call özellikleri
Argümanlar
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
Argümanlar | String | JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. |
isim
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
isim | String | Çağrılacak işlevin adı. |
sohbetTamamlamaİstekAracıMesajı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
rol | enum | İleti yazarının rolü( bu örnekte tool ).Olası değerler: araç |
Evet | |
içerik | dize veya dizi | Araç iletisinin içeriği. | Evet | |
araç çağrı kimliği | String | Bu iletinin yanıt verdiği araç çağrısı. | Evet |
sohbetTamamlamaİstekFonksiyonMesajı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
rol | enum | İleti yazarının rolü( bu örnekte function ).Olası değerler: işlev |
Evet | |
içerik | String | İşlev iletisinin içeriği. | Evet | |
isim | String | Çağrılacak işlevin adı. | Evet |
SohbetTamamlamaİstekSistemiMesajİçerikParçası
Bu bileşen aşağıdakilerden biri olabilir:
sohbetTamamlamaİsteğiKullanıcıMesajıİçerikParçası
Bu bileşen aşağıdakilerden biri olabilir:
ChatTamamlamaİsteğiAsistanMesajİçeriğiParçası
Bu bileşen aşağıdakilerden biri olabilir:
sohbetTamamlamaİstekAracıMesajİçeriğiParçası
Bu bileşen aşağıdakilerden biri olabilir:
chatTamamlamaİstekMesajİçerikParçaMetin
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | İçerik bölümünün türü. Olası değerler: metin |
Evet | |
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. | String | Metin içeriği. | Evet |
İletişimTamamlaTalepMesajİçerikKısımResim
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | İçerik bölümünün türü. Olası değerler: image_url |
Evet | |
image_url | object | Evet |
image_url özellikleri
URL
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
URL | String | Görüntünün URL'si veya base64 kodlanmış görüntü verileri. |
ayrıntı
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
ayrıntı | String | Görüntünün ayrıntı düzeyini belirtir. Görüntü İşleme kılavuzunda daha fazla bilgi edinin. | Otomatik |
sohbet tamamlaması talebi mesaj içeriği reddi
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | İçerik bölümünün türü. Olası değerler: reddetme |
Evet | |
Ret | String | Model tarafından oluşturulan reddetme iletisi. | Evet |
Azure Sohbet Uzantısı Yapılandırması
Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | azureChatExtensionType | Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, 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. |
Evet |
azureChatEklentiTürü
Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.
Açıklama: Tek bir Azure OpenAI sohbet uzantısı için yapılandırma verilerinin gösterimi. Bu, yanıt davranışını artırmak için Azure OpenAI sohbet uzantılarını kullanması gereken bir sohbet tamamlama isteği tarafından kullanılır. Bu yapılandırmanın kullanımı yalnızca Azure OpenAI ile uyumludur.
Tür: dize
Varsayılan:
Sabit Listesi Adı: AzureChatExtensionType
Sabit Listesi Değerleri:
Değer | Açıklama |
---|---|
azure_search | Azure Search'ün Azure OpenAI sohbet uzantısı olarak kullanımını temsil eder. |
Azure Cosmos Veritabanı | Azure OpenAI sohbet uzantısı olarak Azure Cosmos DB kullanımını temsil eder. |
Azure Arama Sohbet Uzantısı Yapılandırması
Azure OpenAI sohbet uzantısı olarak kullanılırken Azure Search için yapılandırılabilir seçeneklerin belirli bir gösterimi.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
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. |
Evet | |
Parametreler | azureAramaSohbetEklentiParametreleri | Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Search parametreleri. | Hayı |
azureSearchChatUzantıParametreleri
Azure OpenAI sohbet uzantısı olarak kullanıldığında Azure Search parametreleri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kimlik doğrulama | onYourDataApiKeyAuthenticationOptions veya onYourDataSystemAssignedManagedIdentityAuthenticationOptions veya onYourDataUserAssignedManagedIdentityAuthenticationOptions | Evet | ||
En iyi n belgeleri | tamsayı | Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. | Hayı | |
kapsam dahilinde | Boolean | Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. | Hayı | |
katılık | tamsayı | Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. | Hayı | |
rol_bilgisi | String | Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır. | Hayı | |
uç nokta | String | Kullanılacak Azure Search kaynağının mutlak uç nokta yolu. | Evet | |
endeks_adı | String | Başvuruda bulunulan Azure Search kaynağında kullanılabilir olarak kullanılacak dizinin adı. | Evet | |
alan eşleştirme | AzureAramaDizinAlanEşlemeSeçenekleri | Yapılandırılmış bir Azure Search kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar. | Hayı | |
sorgu_tipi | azureSearchQueryType | Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Search alma sorgusunun türü. | Hayı | |
anlamsal yapılandırma | String | Sorgu için ek anlamsal yapılandırma. | Hayı | |
filtre | String | Arama filtresi. | Hayı | |
gömülü_bağımlılık | onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource | Hayı |
azureAramaDizinAlanEşlemeSeçenekleri
Yapılandırılmış bir Azure Search kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
başlık_alanı | String | Başlık olarak kullanılacak dizin alanının adı. | Hayı | |
url_alanı | String | URL olarak kullanılacak dizin alanının adı. | Hayı | |
Dosya yolu alanı | String | Dosya yolu olarak kullanılacak dizin alanının adı. | Hayı | |
içerik alanları | array | İçerik olarak ele alınması gereken dizin alanlarının adları. | Hayı | |
içerik_alanları_ayırıcı | String | İçerik alanlarının kullanması gereken ayırıcı desen. | Hayı | |
vektör alanları | array | Vektör verilerini temsil eden alanların adları. | Hayı |
azureAramaSorguTürü
Azure OpenAI sohbet uzantısı olarak kullanılırken yürütülmesi gereken Azure Search alma sorgusunun türü.
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:
Değer | 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. |
vektör_basit_melez | Vektör verileriyle basit sorgu stratejisinin bir birleşimini temsil eder. |
vektör_anlam_hibrit | Anlamsal arama ve vektör verileri sorgulamanın bir bileşimini temsil eder. |
Azure Cosmos DB Sohbet Uzantısı Yapılandırması
Azure OpenAI sohbet uzantısı olarak kullanılırken Azure Cosmos DB için yapılandırılabilir seçeneklerin belirli bir gösterimi.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
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. |
Evet | |
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ı |
AzureCosmosDBSohbetUzantısıParametreleri
MongoDB sanal çekirdeği için Azure Cosmos DB kullanırken Verilerinizde Azure OpenAI sohbet uzantılarını yapılandırırken kullanılacak parametreler.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kimlik doğrulama | VeriBağlantıDizesiKimlikDoğrulamaSeçenekleriÜzerinde | bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri. | Evet | |
En iyi n belgeleri | tamsayı | Yapılandırılan sorgu için öne çıkan en fazla belge sayısı. | Hayı | |
kapsam dahilinde | Boolean | Sorguların dizine alınan verilerin kullanımıyla sınırlandırılıp kısıtlanmaması gerektiği. | Hayı | |
katılık | tamsayı | Arama ilgi filtresinin yapılandırılmış katılığı. Katılık ne kadar yüksekse, duyarlık o kadar yüksektir ancak yanıtın daha düşük geri çağrılır. | Hayı | |
rol_bilgisi | String | Modele nasıl davranması gerektiği ve yanıt oluştururken başvurması gereken bağlamlar hakkında yönergeler verin. Yardımcının kişiliğini açıklayabilir ve yanıtları nasıl biçimlendirebileceğini anlatabilirsiniz. Bunun için 100 belirteç sınırı vardır ve genel belirteç sınırına göre sayılır. | Hayı | |
veritabanı_adı | String | Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek veritabanı adı. | Evet | |
konteyner_adı | String | Azure Cosmos DB kaynak kapsayıcısının adı. | Evet | |
endeks_adı | String | Azure Cosmos DB ile kullanılacak MongoDB sanal çekirdek dizin adı. | Evet | |
alan eşleştirme | azureCosmosDBFieldMappingOptions | Yapılandırılmış bir Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar. | Evet | |
gömülü_bağımlılık | onYourDataEndpointVectorizationSource veya onYourDataDeploymentNameVectorizationSource | Evet |
Azure Cosmos DB Alan Eşleme Seçenekleri
Yapılandırılmış bir Azure Cosmos DB kaynağı kullanılırken alanların nasıl işlendiğini denetlemek için isteğe bağlı ayarlar.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
başlık_alanı | String | Başlık olarak kullanılacak dizin alanının adı. | Hayı | |
url_alanı | String | URL olarak kullanılacak dizin alanının adı. | Hayı | |
Dosya yolu alanı | String | Dosya yolu olarak kullanılacak dizin alanının adı. | Hayı | |
içerik alanları | array | İçerik olarak ele alınması gereken dizin alanlarının adları. | Evet | |
içerik_alanları_ayırıcı | String | İçerik alanlarının kullanması gereken ayırıcı desen. | Hayı | |
vektör alanları | array | Vektör verilerini temsil eden alanların adları. | Evet |
Veri Kimlik Doğrulama Seçenekleriniz
Verilerinizde Azure OpenAI için kimlik doğrulama seçenekleri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | VeriKimlikDoğrulamaTürünüzÜzerinde | Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. | Evet |
Verinizin Kimlik Doğrulama Türü
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:
Değer | Açıklama |
---|---|
API anahtarı | API anahtarı aracılığıyla kimlik doğrulaması. |
bağlantı_dizesi | bağlantı dizesi aracılığıyla kimlik doğrulaması. |
sistem tarafından atanan yönetilen kimlik | Sistem tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması. |
kullanıcı atamalı yönetilen kimlik | Kullanıcı tarafından atanan yönetilen kimlik aracılığıyla kimlik doğrulaması. |
VerinizÜzerindeApiAnahtarıKimlikDoğrulamaSeçenekleri
API anahtarı kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | VeriKimlikDoğrulamaTürünüzÜzerinde | Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. | Evet | |
anahtar | String | Kimlik doğrulaması için kullanılacak API anahtarı. | Hayı |
BağlantıDizinizdekiKimlikDoğrulamaSeçenekleri
bağlantı dizesi kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | VeriKimlikDoğrulamaTürünüzÜzerinde | Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. | Evet | |
bağlantı_dizesi | String | Kimlik doğrulaması için kullanılacak bağlantı dizesi. | Hayı |
onYourDataSistemAtananYönetilenKimlikDoğrulamaSeçenekleri
Sistem tarafından atanan yönetilen kimlik kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | VeriKimlikDoğrulamaTürünüzÜzerinde | Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. | Evet |
Kullanıcı Atamalı Yönetilen Kimlik Kimlik Doğrulama Seçenekleri
Kullanıcı tarafından atanan yönetilen kimlik kullanılırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | VeriKimlikDoğrulamaTürünüzÜzerinde | Verilerinizde Azure OpenAI ile desteklenen kimlik doğrulama türleri. | Evet | |
yönetilen_kimlik_kaynak_kimliği | String | Kimlik doğrulaması için kullanılacak kullanıcı tarafından atanan yönetilen kimliğin kaynak kimliği. | Hayı |
onYourVeriVektörleştirmeKaynağı
Vektör araması ile Verilerinizde Azure OpenAI için vektörleştirme kaynağının soyut bir gösterimi.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | Veri Vektorizasyon Kaynak Tipiniz Üzerinde | 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ı. |
Evet |
onYourDataVektörleştirmeKaynağıTürü
Verilerinizde Azure OpenAI'nin vektör arama ile kullanılacak verilerin vektörleştirilmesini yapılandırmak için kullanabileceği kaynakları temsil eder.
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:
Değer | Açıklama |
---|---|
uç nokta | Azure OpenAI ekleme modeline yönelik genel hizmet çağrıları tarafından gerçekleştirilen vektörleştirmeyi temsil eder. |
dağıtım_adı | 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. |
onYourDataDağıtımAdıVektörleştirmeKaynağı
Vektör araması uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve aynı Azure OpenAI kaynağındaki iç ekleme modeli dağıtım adını temel alan vektörleştirme kaynağının ayrıntıları.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | Veri Vektorizasyon Kaynak Tipiniz Üzerinde | 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ı. |
Evet | |
dağıtım_adı | String | Vektörleştirme için kullanılacak model dağıtımının adını belirtir. Bu model dağıtımı aynı Azure OpenAI kaynağında olmalı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ı |
VeriUçNoktasıVektörleştirmeKaynağıÜzerinde
Vektör araması uygularken Verilerinizde Azure OpenAI tarafından kullanılan ve eklemeler için genel bir Azure OpenAI uç nokta çağrısını temel alan vektörleştirme kaynağının ayrıntıları.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | Veri Vektorizasyon Kaynak Tipiniz Üzerinde | 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ı. |
Evet | |
kimlik doğrulama | onYourDataApiKeyKimlikDoğrulamaSeçenekleri | API anahtarı kullanırken Verilerinizde Azure OpenAI kimlik doğrulama seçenekleri. | Hayı | |
uç nokta | String | Vektörleştirme için kullanılacak uç noktayı belirtir. Bu uç nokta aynı Azure OpenAI kaynağında olmalıdır, ancak Verilerinizde bu uç noktayı özel ağlarda bile vektör aramasını etkinleştiren genel bir çağrı yerine iç çağrı yoluyla kullanır. | Hayı |
azureChatUzantılarıMesajBağlamı
Azure OpenAI sohbet uzantıları ilgili sohbet tamamlama yanıtının oluşturulmasına dahil olduğunda sağlanan ek bağlam bilgilerinin gösterimi. Bu bağlam bilgileri yalnızca eşleşen bir uzantı kullanmak üzere yapılandırılmış bir Azure OpenAI isteği kullanılırken doldurulur.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Alıntı | array | Yanıtta yardımcı iletisini oluşturmak için kullanılan veri kaynağı alma sonucu. | Hayı | |
kasıt | String | Bağlamı taşımak için bir sonraki dönüşe geçmek için kullanılan sohbet geçmişinden algılanan amaç. | Hayı |
Alıntı
sohbet tamamlamaları yanıt iletisi için alıntı bilgileri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
içerik | String | Alıntının içeriği. | Evet | |
başlık | String | Alıntının başlığı. | Hayı | |
URL | String | Alıntının URL'si. | Hayı | |
dosya yolu | String | Alıntının dosya yolu. | Hayı | |
chunk_id | String | Alıntının öbek kimliği. | Hayı |
SohbetTamamlamaMesajAracıÇağrısı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kimlik | String | Araç çağrısının kimliği. | Evet | |
tür | toolCallType | Bu durumda function araç çağrısının türü. |
Evet | |
fonksiyon | object | Modelin çağırdığını işlev. | Evet |
İşlevin özellikleri
isim
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
isim | String | Çağrılacak işlevin adı. |
Argümanlar
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
Argümanlar | String | JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. |
Araç Çağrı Türü
Bu durumda function
araç çağrısının türü.
Açıklama: Bu örnekte function
araç çağrısının türü.
Tür: dize
Varsayılan:
Sabit Listesi Adı: ToolCallType
Sabit Listesi Değerleri:
Değer | Açıklama |
---|---|
fonksiyon | Araç çağrı türü işlevdir. |
chatTamamlamaİstekMesajAracı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
araç çağrı kimliği | String | Bu iletinin yanıt verdiği araç çağrısı. | Hayı | |
içerik | String | İletinin içeriği. | Hayı |
SohbetTamamlamaTalepMesajFonksiyonu
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
rol | enum | İleti yazarının rolü( bu örnekte function ).Olası değerler: işlev |
Hayı | |
isim | String | İletinin içeriği. | Hayı | |
içerik | String | İletinin içeriği. | Hayı |
createChatCompletionResponse
Sağlanan girişe göre model tarafından döndürülen sohbet tamamlama yanıtını temsil eder.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kimlik | String | Sohbetin tamamlanması için benzersiz bir tanımlayıcı. | Evet | |
sonuçları_filtrele_giriş | promptFilterResults | İstekte sıfır veya daha fazla istem için içerik filtreleme sonuçları. Akış isteğinde, farklı istemlerin sonuçları farklı zamanlarda veya farklı siparişlerde gelebilir. | Hayı | |
Seçenek | array | Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse n birden fazla olabilir. |
Evet | |
Oluşturulan | tamsayı | Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak). | Evet | |
örnek | String | Sohbetin tamamlanması için kullanılan model. | Evet | |
sistem parmak izi | String | Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle seed birlikte kullanılabilir. |
Hayı | |
object | enum | Her zaman chat.completion olan nesne türü.Olası değerler: chat.completion |
Evet | |
kullanım | tamamlama kullanımı | Tamamlanma isteği için kullanım istatistikleri. | Hayı |
SohbetTamamlamaAkışYanıtıOluştur
Sağlanan girişe göre model tarafından döndürülen sohbet tamamlama yanıtının akışlı bir öbeği temsil eder.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kimlik | String | Sohbetin tamamlanması için benzersiz bir tanımlayıcı. Her öbek aynı kimliktedir. | Evet | |
Seçenek | array | Sohbet tamamlama seçeneklerinin listesi. 1'den büyükse n birden fazla öğe içerebilir. |
Evet | |
Oluşturulan | tamsayı | Sohbet tamamlamanın oluşturulduğu Unix zaman damgası (saniye olarak). Her öbek aynı zaman damgasına sahiptir. | Evet | |
örnek | String | Tamamlanmayı oluşturmak için model. | Evet | |
sistem parmak izi | String | Bu parmak izi, modelin birlikte çalıştığı arka uç yapılandırmasını temsil eder. Determinizmi etkileyebilecek arka uç değişikliklerinin ne zaman yapıldığını anlamak için istek parametresiyle seed birlikte kullanılabilir. |
Hayı | |
object | enum | Her zaman chat.completion.chunk olan nesne türü.Olası değerler: chat.completion.chunk |
Evet |
sohbetTamamlamaAkışYanıtDelta
Akışlı model yanıtları tarafından oluşturulan bir sohbet tamamlama deltası.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
içerik | String | Öbek iletisinin içeriği. | Hayı | |
fonksiyon çağrısı | object | kullanım dışı bırakıldı ve tarafından tool_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ı | |
araç çağrıları | array | Hayı | ||
rol | enum | Bu iletinin yazarının rolü. Olası değerler: sistem, kullanıcı, yardımcı, araç |
Hayı | |
Ret | String | Model tarafından oluşturulan reddetme iletisi. | Hayı |
function_call özellikleri
Argümanlar
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
Argümanlar | String | JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. |
isim
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
isim | String | Çağrılacak işlevin adı. |
sohbetTamamlamaMesajAracıÇağrıParçası
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
indeks | tamsayı | Evet | ||
kimlik | String | Araç çağrısının kimliği. | Hayı | |
tür | enum | Aracın türü. Şu anda yalnızca function desteklenmektedir.Olası değerler: işlev |
Hayı | |
fonksiyon | object | Hayı |
İşlevin özellikleri
isim
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
isim | String | Çağrılacak işlevin adı. |
Argümanlar
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
Argümanlar | String | JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. |
SohbetTamamlamaAkışSeçenekleri
Akış yanıtı seçenekleri. Bunu yalnızca ayarladığınızda ayarlayın stream: true
.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kullanım_dahil_et | Boolean | Ayarlanırsa, iletiden önce data: [DONE] ek bir öbek akışı oluşturulur.
usage Bu öbek üzerindeki alan, isteğin tamamı için belirteç kullanım istatistiklerini gösterir ve choices alan her zaman boş bir dizi olur. Diğer tüm öbekler de null değer içeren bir usage alan içerir. |
Hayı |
sohbetTamamlamaSecimiLogOlasiliklari
Seçim için olasılık bilgilerini günlüğe kaydedin.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
içerik | array | Günlük olasılık bilgilerini içeren ileti içerik belirteçlerinin listesi. | Evet | |
Ret | array | Günlük olasılık bilgilerini içeren ileti reddetme belirteçlerinin listesi. | Hayı |
chatCompletionTokenLogprob
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
jeton | String | Belirteç. | Evet | |
logprob | Numara | Bu belirtecin günlük olasılığı. | Evet | |
byte | array | Belirtecin UTF-8 bayt gösterimini temsil eden tamsayıların listesi. Karakterlerin birden çok belirteçle temsil edildiği ve bayt gösterimlerinin doğru metin gösterimini oluşturmak için birleştirildiği durumlarda kullanışlıdır. Belirtecin bayt gösterimi yoksa olabilir null . |
Evet | |
top_logprobs | array | Bu belirteç konumunda en olası belirteçlerin ve günlük olasılıklarının listesi. Nadir durumlarda, döndürülen istek top_logprobs sayısından daha az olabilir. |
Evet |
SohbetiTamamlamaYanıtMesajı
Model tarafından oluşturulan bir sohbet tamamlama iletisi.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
rol | chatTamamlamaYanıtMesajıRolü | Yanıt iletisinin yazarının rolü. | Evet | |
Ret | String | Model tarafından oluşturulan reddetme iletisi. | Evet | |
içerik | String | İletinin içeriği. | Evet | |
araç çağrıları | array | Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar. | Hayı | |
fonksiyon çağrısı | 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ı | |
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ı |
SohbetTamamlamaYanıtMesajRolü
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
sohbetTamamlamaAracıSeçenek
Model tarafından çağrılan aracı (varsa) denetler.
none
modelin herhangi bir aracı çağırmayacağı ve bunun yerine bir ileti oluşturduğu anlamına gelir.
auto
modelin ileti oluşturma veya bir veya daha fazla araç çağırma arasında seçim yapabileceğiniz anlamına gelir.
required
modelin bir veya daha fazla araç çağırması gerektiği anlamına gelir. aracılığıyla {"type": "function", "function": {"name": "my_function"}}
belirli bir aracın belirtilmesi, modeli söz konusu aracı çağırmaya zorlar.
none
hiçbir araç mevcut olmadığında varsayılan değerdir.
auto
araçlar varsa varsayılan değerdir.
Bu bileşen aşağıdakilerden biri olabilir:
chatTamamlanmasiAdlandırılmışAraçSeçimi
Modelin kullanması gereken aracı belirtir. Modeli belirli bir işlevi çağırmaya zorlamak için kullanın.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | Aracın türü. Şu anda yalnızca function desteklenmektedir.Olası değerler: işlev |
Evet | |
fonksiyon | object | Evet |
İşlevin özellikleri
isim
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
isim | String | Çağrılacak işlevin adı. |
ParallelToolCalls
Araç kullanımı sırasında paralel işlev çağrısının etkinleştirilip etkinleştirilmeyileceği.
Bu bileşen için tanımlı özellik yok.
chatTamamlamaMesajAracıÇağrıları
Araç, işlev çağrıları gibi model tarafından oluşturulan çağrılar.
Bu bileşen için tanımlı özellik yok.
sohbetTamamlamaFonksiyonCagırma
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.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
isim | String | Çağrılacak işlevin adı. | Evet | |
Argümanlar | String | JSON biçiminde model tarafından oluşturulan işlevi çağırmak için bağımsız değişkenler. Modelin her zaman geçerli JSON oluşturmadığını ve işlev şemanız tarafından tanımlanmayan parametreler oluşturabileceğini unutmayın. İşlevinizi çağırmadan önce kodunuzdaki bağımsız değişkenleri doğrulayın. | Evet |
tamamlama kullanımı
Tamamlanma isteği için kullanım istatistikleri.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
istem_jetonları | tamsayı | İstemdeki belirteç sayısı. | Evet | |
tamamlama belirteçleri | tamsayı | Oluşturulan tamamlamadaki belirteçlerin sayısı. | Evet | |
toplam jetonlar | tamsayı | İstekte kullanılan toplam belirteç sayısı (istem + tamamlama). | Evet | |
tamamlama_jeton_detayları | object | Tamamlanmada kullanılan belirteçlerin dökümü. | Hayı |
completion_tokens_details özellikleri
akıl yürütme birimleri
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
akıl yürütme birimleri | tamsayı | Model tarafından mantık yürütme için oluşturulan belirteçler. |
SohbetTamamlamaAracı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | Aracın türü. Şu anda yalnızca function desteklenmektedir.Olası değerler: işlev |
Evet | |
fonksiyon | FunctionObject | Evet |
Fonksiyon Parametreleri
İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler. Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın.
Atlama parameters
, boş parametre listesi olan bir işlevi tanımlar.
Bu bileşen için tanımlı özellik yok.
FunctionObject
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Açıklama | String | İşlevin ne zaman ve nasıl çağrıldığını seçmek için model tarafından kullanılan işlevin ne yaptığının açıklaması. | Hayı | |
isim | String | Çağrılacak işlevin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir. | Evet | |
Parametreler | FunctionParameters | İşlevlerin kabullediği, JSON Şeması nesnesi olarak tanımlanan parametreler.
Örnekler için kılavuza ve biçimle ilgili belgeler için JSON Şeması başvurusuna bakın. Atlama parameters , boş parametre listesi olan bir işlevi tanımlar. |
Hayı | |
Sıkı | Boolean | İşlev çağrısı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model alanda tanımlanan şemayı parameters tam olarak izler.
strict
true olduğunda yalnızca bir JSON Şeması alt kümesi desteklenir. |
Hayı | Yanlış |
YanıtFormatıMetni
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | Tanımlanan yanıt biçiminin türü: text Olası değerler: metin |
Evet |
YanıtFormatıJsonNesne
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | Tanımlanan yanıt biçiminin türü: json_object Olası değerler: json_object |
Evet |
ResponseFormatJsonSchemaSchema (Yanıt Biçimi JSON Şeması Şeması)
JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması.
Bu bileşen için tanımlı özellik yok.
YanıtFormatıJsonŞeması
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
tür | enum | Tanımlanan yanıt biçiminin türü: json_schema Olası değerler: json_schema |
Evet | |
json şeması | object | Evet |
json_schema özellikleri
Açıklama
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
Açıklama | String | Yanıt formatının amacına ilişkin bir açıklama, modelin bu formatta nasıl yanıt vereceğini belirlemesi için kullanılır. |
isim
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
isim | String | Yanıt biçiminin adı. En fazla uzunluğu 64 olan a-z, A-Z, 0-9 veya alt çizgi ve kısa çizgi içermelidir. |
şema
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
şema | YanıtFormatJsonŞemaŞeması | JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. |
Sıkı
İsim | Türü | Açıklama | Varsayılan |
---|---|---|---|
Sıkı | Boolean | Çıktı oluşturulurken sıkı şemaya bağlı kalınmasının etkinleştirilip etkinleştirilmeyileceği. True olarak ayarlanırsa, model her zaman alanda tanımlanan tam şemayı schema izler.
strict
true olduğunda yalnızca bir JSON Şeması alt kümesi desteklenir. |
Yanlış |
sohbetTamamlamaSeçimiOrtak
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
indeks | tamsayı | Hayı | ||
bitiş_nedeni | String | Hayı |
Çeviri İstek Oluştur
Çeviri isteği.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
dosya | String | Çevrilecek ses dosyası. | Evet | |
Uyarı | String | Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem İngilizce olmalıdır. | Hayı | |
yanıt formatı | audioResponseFormat | Çıkışın biçimini tanımlar. | Hayı | |
sıcaklık | Numara | Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır. | Hayı | 0 |
sesli yanıt
response_format json olduğunda çeviri veya transkripsiyon yanıtı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. | String | Çevrilmiş veya dökümü alınmış metin. | Evet |
audioVerboseResponse
response_format verbose_json çeviri veya transkripsiyon yanıtı
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. | String | Çevrilmiş veya dökümü alınmış metin. | Evet | |
görev | String | Ses görevinin türü. | Hayı | |
dil | String | Dil | Hayı | |
süre | Numara | Süre. | Hayı | |
segmentler | array | Hayı |
sesYanıtBiçimi
Çıkışın biçimini tanımlar.
Açıklama: Çıkışın biçimini tanımlar.
Tür: dize
Varsayılan:
Sabit Listesi Değerleri:
- JSON
- Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin.
- srt
- verbose_json
- vtt
Transkripsiyon İsteği Oluştur
Transkripsiyon isteği.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
dosya | String | Dökümü yapılan ses dosyası nesnesi. | Evet | |
Uyarı | String | Modelin stiline kılavuzluk etmek veya önceki bir ses kesimine devam etmek için isteğe bağlı bir metin. İstem, ses diliyle eşleşmelidir. | Hayı | |
yanıt formatı | audioResponseFormat | Çıkışın biçimini tanımlar. | Hayı | |
sıcaklık | Numara | Örnekleme sıcaklığı, 0 ile 1 arasında. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir. 0 olarak ayarlanırsa model, belirli eşiklere isabet edene kadar sıcaklığı otomatik olarak artırmak için günlük olasılığını kullanır. | Hayı | 0 |
dil | String | Giriş sesinin dili. Giriş dilini ISO-639-1 biçiminde sağlamak doğruluğu ve gecikme süresini artırır. | Hayı |
audioSegment
Transkripsiyon veya çeviri segmenti.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
kimlik | tamsayı | Segment tanımlayıcısı. | Hayı | |
aramak | Numara | Segmentin uzaklığı. | Hayı | |
Başla | Numara | Segment başlangıç uzaklığı. | Hayı | |
son | Numara | Segment sonu uzaklığı. | Hayı | |
Başka bir metin sağlanmadığı için, verilen metne dayalı bir çeviri yapmam mümkün değil. Lütfen çevirilecek metni belirtin. | String | Segment metni. | Hayı | |
Belirteç -leri | array | Metnin belirteçleri. | Hayı | |
sıcaklık | Numara | Sıcaklık. | Hayı | |
avg_logprob | Numara | Ortalama günlük olasılığı. | Hayı | |
sıkıştırma oranı | Numara | Sıkıştırma oranı. | Hayı | |
Konuşma_olasılığı_yok | Numara | olasılığı no speech . |
Hayı |
görüntü kalitesi
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:
Değer | 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. |
görüntüYanıtFormatı
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:
Değer | 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. |
görüntüBoyutu
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:
Değer | Açıklama |
---|---|
1792x1024 | Oluşturulan görüntünün istenen boyutu 1792x1024 pikseldir. |
1024x1792 | Oluşturulan görüntünün istenen boyutu 1024x1792 pikseldir. |
1024x1024 | Oluşturulan görüntünün istenen boyutu 1024x1024 pikseldir. |
görüntü stili
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:
Değer | 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. |
görüntüÜretimİsteği
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Uyarı | String | İstenen resimlerin metin açıklaması. Uzunluk üst sınırı 4.000 karakterdir. | Evet | |
n | tamsayı | Oluşturulacak görüntü sayısı. | Hayı | 1 |
boyut | imageSize | Oluşturulan görüntülerin boyutu. | Hayı | 1024x1024 |
yanıt formatı | imagesResponseFormat | Oluşturulan görüntülerin döndürüldiği biçim. | Hayı | URL |
kullanıcı | String | Kötüye kullanımı izlemenize ve algılamanıza yardımcı olabilecek, son kullanıcınızı temsil eden benzersiz bir tanımlayıcı. | Hayı | |
nitelik | imageQuality | Oluşturulacak görüntünün kalitesi. | Hayı | standart |
stil | imageStyle | Oluşturulan görüntülerin stili. | Hayı | Canlı |
generateImagesResponse
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
Oluşturulan | tamsayı | İşlemin oluşturulduğu unix zaman damgası. | Evet | |
veriler | array | Başarılı olursa işlemin sonuç verileri | Evet |
görüntüSonuç
Başarılı olursa resim URL'si veya kodlanmış görüntü ve aksi takdirde bir hata.
İsim | Türü | Açıklama | Gerekli | Varsayılan |
---|---|---|---|---|
URL | String | Resim URL'si. | Hayı | |
b64_json | String | base64 kodlanmış görüntüsü | Hayı | |
içerik_filtreleme_sonuçları | dalleİçerikFiltreSonuçları | İçerik filtreleme sonuçları hakkında bilgi. | Hayı | |
düzeltilmiş_yazı | String | İstemde herhangi bir düzeltme varsa, görüntüyü oluşturmak için kullanılan istem. | Hayı | |
sonuçları_filtrele_giriş | dalleFilterResults | İçerik filtreleme kategorisi (nefret, cinsel, şiddet, self_harm), algılanıp algılanmadığı, önem düzeyi (zararlı içeriğin yoğunluğunu ve risk düzeyini belirleyen very_low, düşük, orta, yüksek ölçekli) ve filtrelenip filtrelenmediği hakkında bilgi. Jailbreak içeriği ve küfür, algılanıp algılanmadığı ve filtrelenip filtrelenmediği hakkında bilgiler. Filtrelenip filtrelenmediği ve kimliği olan müşteri blok listesi hakkındaki bilgileri de bulabilirsiniz. | Hayı |
Tamamlama uzantıları
Tamamlama uzantıları, Azure OpenAI veri düzlemi çıkarım belirtiminin en son GA sürümünün bir parçası değildir.
Sohbet iletisi
Sohbet iletisi nesnesi, Azure OpenAI veri düzlemi çıkarım belirtiminin en son GA sürümünün bir parçası değildir.
Metin okuma (Önizleme)
Şu anda Azure OpenAI veri düzlemi çıkarım belirtiminin en son Azure OpenAI GA sürümünün bir parçası değildir. Bu özellik için en son önizleme sürümüne bakın.
Sonraki Adımlar
Modeller hakkında bilgi edinin ve REST API ile ince ayarlamalar yapın. Azure OpenAI'yi destekleyen temel modeller hakkında daha fazla bilgi edinin.