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.
API Sürümü: v1
Server:{endpoint}/openai/v1 — Azure Yapay Zeka Atölyesi Models API'leri
Sunucu Değişkenleri:
| Variable | Varsayılan | Description |
|---|---|---|
| endpoint | Desteklenen Azure Yapay Zeka Atölyesi Models API uç noktası, protokol ve ana bilgisayar adı dahil. Örneğin: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/. ) |
Kimlik Doğrulaması
ApiKeyAuth (API Anahtarı)
API anahtarınızı api-key başlığa ekleyin.
ApiKeyAuth_ (API Anahtarı)
API anahtarınızı authorization başlığa ekleyin.
OAuth2Auth (OAuth 2.0)
Akış: örtük
Yetkilendirme URL'si:https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Kapsam:
https://cognitiveservices.azure.com/.default
Güvenlik Gereksinimleri
Uç noktalar, aşağıdaki kimlik doğrulama yöntemlerinden herhangi birini kabul eder:
- ApiKeyAuth
- ApiKeyAuth_
-
OAuth2Auth (dürbünler:
https://cognitiveservices.azure.com/.default)
Yanıt oluşturma
POST {endpoint}/openai/v1/responses
Model yanıtı oluşturur.
URI Parametreleri
| Name | In | Zorunlu | Türü | Description |
|---|---|---|---|---|
| endpoint | server | Yes | Dize | Desteklenen Azure Yapay Zeka Atölyesi Models API uç noktası, protokol ve ana bilgisayar adı dahil. Örneğin: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/. ) |
| API sürümü | soru | Hayır | Dize Olası değerler: v1, preview |
Bu istek için kullanılacak açık Azure Yapay Zeka Atölyesi Modelleri API sürümü.v1 aksi belirtilmediyse. |
İstek Gövdesi
İçerik Türü: application/json
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arka plan | boole veya null | Hayır | ||
| context_management | OpenAI.ContextManagementParam veya null dizisi | Bu istek için bağlam yönetimi yapılandırması. | Hayır | |
| konuşma | OpenAI.ConversationParam veya null | Hayır | ||
| include | OpenAI.IncludeEnum veya null dizisi | Hayır | ||
| input | OpenAI.InputParam | Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Görüntü girişleri - Dosya girişleri - Konuşma durumu - Fonksiyon çağrısı |
Hayır | |
| instructions | dize veya null | Hayır | ||
| max_output_tokens | tamsayı veya null | Hayır | ||
| max_tool_calls | tamsayı veya null | Hayır | ||
| metadata | OpenAI.Metadata veya null | Hayır | ||
| model | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| paralel araç çağrıları | boole veya null | Hayır | ||
| previous_response_id | dize veya null | Hayır | ||
| prompt | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| prompt_cache_retention | dize veya null | Hayır | ||
| reasoning | OpenAI.Reasoning veya null | Hayır | ||
| safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| store | boole veya null | Hayır | ||
| veri akışı | boole veya null | Hayır | ||
| stream_options | OpenAI.ResponseStreamOptions veya null | Hayır | ||
| sıcaklık | sayı veya null | Hayır | ||
| text | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| tool_choice | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| tools | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar dosya arama gibi modelin özellikleri. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. |
Hayır | |
| top_logprobs | tamsayı veya null | Hayır | ||
| top_p | sayı veya null | Hayır | ||
| truncation | dize veya null | Hayır | ||
| user | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır |
Responses
Durum Kodu: 200
Açıklama: İstek başarılı oldu.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje | |
| text/event-stream | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arka plan | boole veya null | Hayır | ||
| tamamlanma_tarihi | dize veya null | Hayır | ||
| content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| hata | OpenAI.ResponseError veya null | Yes | ||
| kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| incomplete_details | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| instructions | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| max_output_tokens | tamsayı veya null | Hayır | ||
| max_tool_calls | tamsayı veya null | Hayır | ||
| metadata | OpenAI.Metadata veya null | Hayır | ||
| model | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| Obje | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| output | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| output_text | dize veya null | Hayır | ||
| paralel araç çağrıları | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| previous_response_id | dize veya null | Hayır | ||
| prompt | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| prompt_cache_retention | dize veya null | Hayır | ||
| reasoning | OpenAI.Reasoning veya null | Hayır | ||
| safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| durum | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| sıcaklık | sayı veya null | Hayır | ||
| text | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| tool_choice | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| tools | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| top_logprobs | tamsayı veya null | Hayır | ||
| top_p | sayı veya null | Hayır | ||
| truncation | dize veya null | Hayır | ||
| usage | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| user | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Durum Kodu: varsayılan
Açıklama: Beklenmeyen bir hata yanıtı.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| inner_error | Hayır | |||
| message | Dize | Yes | ||
| param | dize veya null | Hayır | ||
| type | Dize | Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Örnekler
Example
Model yanıtı oluşturma
POST {endpoint}/openai/v1/responses?api-version=v1
Yanıtı al
GET {endpoint}/openai/v1/responses/{response_id}
Belirtilen ID numarası ile bir model tepkisi getirir.
URI Parametreleri
| Name | In | Zorunlu | Türü | Description |
|---|---|---|---|---|
| endpoint | server | Yes | Dize | Desteklenen Azure Yapay Zeka Atölyesi Models API uç noktası, protokol ve ana bilgisayar adı dahil. Örneğin: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/. ) |
| API sürümü | soru | Hayır | Dize Olası değerler: v1, preview |
Bu istek için kullanılacak açık Azure Yapay Zeka Atölyesi Modelleri API sürümü.v1 aksi belirtilmediyse. |
| response_id | path | Yes | Dize | |
| include[] | soru | Hayır | Dizi | Yanıta eklenecek ek alanlar. Daha fazla bilgi için yukarıdaki Yanıt oluşturma için include parametresine bakın. |
| veri akışı | soru | Hayır | boolean | true olarak ayarlanırsa, model yanıt verileri sunucu tarafından gönderilen olaylar kullanılarak oluşturulduğundan istemciye akışla gönderilir. Serileştirme: patlama: yanlış |
| starting_after | soru | Hayır | tamsayı (int32) | Akışın başlatıldığı olayın sıra numarası. Serileştirme: patlama: yanlış |
| include_obfuscation | soru | Hayır | boolean | True olduğunda, akış gizleme etkinleştirilir. Akış gizleme, belirli yan kanal saldırılarına karşı koruma olarak, yük boyutlarını normalleştirmek amacıyla akış delta olayları üzerinde bir obfuscation alana rastgele karakterler ekler. Bu gizleme alanları varsayılan olarak eklenir, ancak veri akışına az miktarda ek yük ekler. Uygulamanızla OpenAI API'si arasındaki ağ bağlantılarına güveniyorsanız bant genişliğini iyileştirmek için false olarak ayarlayabilirsiniz include_obfuscation .Serileştirme: patlama: yanlış |
Responses
Durum Kodu: 200
Açıklama: İstek başarılı oldu.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arka plan | boole veya null | Hayır | ||
| tamamlanma_tarihi | dize veya null | Hayır | ||
| content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| hata | OpenAI.ResponseError veya null | Yes | ||
| kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| incomplete_details | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| instructions | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| max_output_tokens | tamsayı veya null | Hayır | ||
| max_tool_calls | tamsayı veya null | Hayır | ||
| metadata | OpenAI.Metadata veya null | Hayır | ||
| model | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| Obje | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| output | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| output_text | dize veya null | Hayır | ||
| paralel araç çağrıları | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| previous_response_id | dize veya null | Hayır | ||
| prompt | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| prompt_cache_retention | dize veya null | Hayır | ||
| reasoning | OpenAI.Reasoning veya null | Hayır | ||
| safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| durum | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| sıcaklık | sayı veya null | Hayır | ||
| text | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| tool_choice | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| tools | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| top_logprobs | tamsayı veya null | Hayır | ||
| top_p | sayı veya null | Hayır | ||
| truncation | dize veya null | Hayır | ||
| usage | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| user | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Durum Kodu: varsayılan
Açıklama: Beklenmeyen bir hata yanıtı.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| inner_error | Hayır | |||
| message | Dize | Yes | ||
| param | dize veya null | Hayır | ||
| type | Dize | Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Yanıtı silme
DELETE {endpoint}/openai/v1/responses/{response_id}
Kimlik numarasına göre bir yanıtı siler.
URI Parametreleri
| Name | In | Zorunlu | Türü | Description |
|---|---|---|---|---|
| endpoint | server | Yes | Dize | Desteklenen Azure Yapay Zeka Atölyesi Models API uç noktası, protokol ve ana bilgisayar adı dahil. Örneğin: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/. ) |
| API sürümü | soru | Hayır | Dize Olası değerler: v1, preview |
Bu istek için kullanılacak açık Azure Yapay Zeka Atölyesi Modelleri API sürümü.v1 aksi belirtilmediyse. |
| response_id | path | Yes | Dize |
Responses
Durum Kodu: 200
Açıklama: İstek başarılı oldu.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| silindi | enum | Olası değerler: True |
Yes | |
| kimlik | Dize | Yes | ||
| Obje | enum | Olası değerler: response.deleted |
Yes |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Durum Kodu: varsayılan
Açıklama: Beklenmeyen bir hata yanıtı.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| inner_error | Hayır | |||
| message | Dize | Yes | ||
| param | dize veya null | Hayır | ||
| type | Dize | Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Yanıtı iptal et
POST {endpoint}/openai/v1/responses/{response_id}/cancel
Verilen kimlikle bir model yanıtını iptal eder. Yalnızca arka plan parametresi true olarak ayarlanmış olarak oluşturulan yanıtlar iptal edilebilir.
URI Parametreleri
| Name | In | Zorunlu | Türü | Description |
|---|---|---|---|---|
| endpoint | server | Yes | Dize | Desteklenen Azure Yapay Zeka Atölyesi Models API uç noktası, protokol ve ana bilgisayar adı dahil. Örneğin: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/. ) |
| API sürümü | soru | Hayır | Dize Olası değerler: v1, preview |
Bu istek için kullanılacak açık Azure Yapay Zeka Atölyesi Modelleri API sürümü.v1 aksi belirtilmediyse. |
| response_id | path | Yes | Dize |
Responses
Durum Kodu: 200
Açıklama: İstek başarılı oldu.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arka plan | boole veya null | Hayır | ||
| tamamlanma_tarihi | dize veya null | Hayır | ||
| content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| hata | OpenAI.ResponseError veya null | Yes | ||
| kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| incomplete_details | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| instructions | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| max_output_tokens | tamsayı veya null | Hayır | ||
| max_tool_calls | tamsayı veya null | Hayır | ||
| metadata | OpenAI.Metadata veya null | Hayır | ||
| model | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| Obje | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| output | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| output_text | dize veya null | Hayır | ||
| paralel araç çağrıları | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| previous_response_id | dize veya null | Hayır | ||
| prompt | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| prompt_cache_retention | dize veya null | Hayır | ||
| reasoning | OpenAI.Reasoning veya null | Hayır | ||
| safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| durum | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| sıcaklık | sayı veya null | Hayır | ||
| text | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| tool_choice | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| tools | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| top_logprobs | tamsayı veya null | Hayır | ||
| top_p | sayı veya null | Hayır | ||
| truncation | dize veya null | Hayır | ||
| usage | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| user | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Durum Kodu: varsayılan
Açıklama: Beklenmeyen bir hata yanıtı.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| inner_error | Hayır | |||
| message | Dize | Yes | ||
| param | dize veya null | Hayır | ||
| type | Dize | Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Giriş öğelerini listeleme
GET {endpoint}/openai/v1/responses/{response_id}/input_items
Belirli bir yanıt için giriş öğelerinin listesini döndürür.
URI Parametreleri
| Name | In | Zorunlu | Türü | Description |
|---|---|---|---|---|
| endpoint | server | Yes | Dize | Desteklenen Azure Yapay Zeka Atölyesi Models API uç noktası, protokol ve ana bilgisayar adı dahil. Örneğin: https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/. ) |
| API sürümü | soru | Hayır | Dize Olası değerler: v1, preview |
Bu istek için kullanılacak açık Azure Yapay Zeka Atölyesi Modelleri API sürümü.v1 aksi belirtilmediyse. |
| response_id | path | Yes | Dize | |
| limit | soru | Hayır | tamsayı (int32) | Döndürülecek nesne sayısıyla ilgili bir sınır. Sınır 1 ile 100 arasında olabilir ve varsayılan değer 20'dir. Serileştirme: patlama: yanlış |
| order | soru | Hayır | Dize Olası değerler: asc, desc |
Düzeni nesnelerin zaman damgasına göre created_at sıralayın.
asc artan sırayla ve descazalan sırayla Serileştirme: patlama: yanlış |
| after | soru | Hayır | Dize | Sayfalandırmada kullanılacak bir imleç.
after , listedeki yerinizi tanımlayan bir nesne kimliğidir.Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin sonraki sayfasını getirmek için after=obj_foo içerebilir. Serileştirme: patlama: yanlış |
| önce | soru | Hayır | Dize | Sayfalandırmada kullanılacak bir imleç.
before , listedeki yerinizi tanımlayan bir nesne kimliğidir.Örneğin, bir liste isteğinde bulunur ve obj_foo ile biten 100 nesne alırsanız sonraki çağrı, listenin önceki sayfasını getirmek için before=obj_foo içerebilir. Serileştirme: patlama: yanlış |
Responses
Durum Kodu: 200
Açıklama: İstek başarılı oldu.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | OpenAI.ResponseItemList |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Durum Kodu: varsayılan
Açıklama: Beklenmeyen bir hata yanıtı.
| İçerik Türü | Türü | Tanım |
|---|---|---|
| application/json | Obje |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| inner_error | Hayır | |||
| message | Dize | Yes | ||
| param | dize veya null | Hayır | ||
| type | Dize | Hayır |
Yanıt Üst Bilgileri:
| Başlık | Türü | Description |
|---|---|---|
| apim-request-id | Dize | Sorun giderme amacıyla kullanılan istek kimliği. |
Components
AzureAIFoundryModelsApiVersion
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | v1preview |
AzureContentFilterBlocklistResult
Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| details | nesne dizisi | Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı. | Hayır | |
| filtered | boolean | Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer. | Yes |
AzureContentFilterCompletionTextSpan
Azure OpenAI içerik filtresi sonuçları tarafından kullanılan tamamlama metni aralığının bir gösterimi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| completion_end_offset | tamsayı (int32) | İlk UTF32 kod noktasının yayılma alanından dışlanan uzaklığı. Boş aralıklar için bu alan her zaman completion_start_offset değerine eşittir. Bu alan, boş olmayan aralıklar için her zaman completion_start_offset'tan daha büyüktür. | Yes | |
| completion_start_offset | tamsayı (int32) | Yayılmaya başlayan UTF32 kod noktasının uzaklığı. | Yes |
AzureContentFilterCompletionTextSpanDetectionResult
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| details | AzureContentFilterCompletionTextSpan dizisi | Tespit edilen tamamlama metin aralıkları hakkında ayrıntılı bilgi. | Yes | |
| detected | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| filtered | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes |
AzureContentFilterCustomTopicResult
Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| details | nesne dizisi | Konu kimliği çiftleri ve tespit edilip edilmedikleri. | Hayır | |
| filtered | boolean | Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer. | Yes |
AzureContentFilterDetectionResult
İçeriğin algılanıp algılandığını ve içeriğin filtrelenip filtrelenmediğini gösteren etiketli bir içerik filtresi sonuç öğesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detected | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| filtered | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes |
AzureContentFilterForResponsesAPI
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Engellenmiş | boolean | Yanıtın engellenip engellenmediğini belirtin. | Yes | |
| content_filter_offsets | AzureContentFilterResultOffsets | Yes | ||
| content_filter_results | AzureContentFilterResultsForResponsesAPI | Yes | ||
| └─ özel blok listeleri | AzureContentFilterBlocklistResult | Yapılandırılmış özel blok listeleri için ikili filtreleme sonuçları koleksiyonu. | Hayır | |
| └─ özelleştirilmiş_konular | AzureContentFilterCustomTopicResult | Yapılandırılmış özel konular için ikili filtreleme sonuçları koleksiyonu. | Hayır | |
| └─ hata | Obje | Varsa, içerik filtrelemenin değerlendirmesini tamamlamasını engelleyen bir hatayla ilgili ayrıntılar. | Hayır | |
| └─ kod | tamsayı (int32) | Hatayla ilişkili ayrı, makine tarafından okunabilir bir kod. | Yes | |
| └─ ileti | Dize | Hata ile ilişkili insan tarafından okunabilir bir mesaj. | Yes | |
| └─ nefret | AzureContentFilterSeverityResult | Pejorative veya discriminatory kullanan herhangi bir içeriğe başvurabilen bir içerik filtresi kategorisi bu grupların belirli ayırt edici özniteliklerine dayalı olarak bir kişi veya kimlik grubuna başvuru içeren dil ırk, etnik köken, milliyet, cinsiyet kimliği ve ifadesi, cinsel yönelim dahil ancak bunlarla sınırlı olmamak üzere, din, göçmenlik durumu, yetenek durumu, kişisel görünüm ve vücut boyutu. |
Hayır | |
| └─ dolaylı_saldırı | AzureContentFilterDetectionResult | Her seferinde gerçekleşebilecek, Üretken yapay zeka modelleri tarafından desteklenen sistemlere yönelik saldırıları açıklayan bir algılama sonucu Bir uygulama, doğrudan uygulama geliştiricisi tarafından yazılmış olmayan bilgileri işler veya kullanıcısını seçin. |
Hayır | |
| └─ jailbreak (cihazdaki kısıtlamaların kaldırılması) | AzureContentFilterDetectionResult | Kötü amaçlı kullanıcıların kasıtlı olarak yararlandığı kullanıcı istemi ekleme saldırılarını açıklayan bir algılama sonucu LLM'den yetkisiz davranışlar elde etmek için sistem güvenlik açıkları. Bu, uygunsuz içeriğe yol açabilir sistem tarafından uygulanan kısıtlamaların oluşturulması veya ihlalleri. |
Yes | |
| └─ personally_identifiable_information | AzureContentFilterPersonallyIdentifiableInformationResult | Yapılandırılabilir alt kategorilere sahip Kişisel Tanımlanabilir Bilgilerle eşleşmeleri açıklayan bir algılama sonucu. | Hayır | |
| └─ küfür | AzureContentFilterDetectionResult | Crude, kaba veya başka bir itiraz dilinin Içerik. |
Hayır | |
| └─ protected_material_code | Obje | Lisanslı kod veya diğer korunan kaynak malzemeyle eşleşmeyi açıklayan bir tespit sonucu. | Hayır | |
| └─ alıntı | Obje | Mümkünse, ilişkili lisansı ve onun yerini açıklayan atıf ayrıntıları. | Hayır | |
| └─ Web Adresi | dize (uri) | Lisansla ilişkili URL. | Hayır | |
| └─ lisans | Dize | Algılamayla ilişkili lisansın adı veya tanımlayıcısı. | Hayır | |
| └─ algılandı | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| └─ filtrelenmiş | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| └─ protected_material_text | AzureContentFilterDetectionResult | Telif hakkı veya başka bir durum altında korunan metne karşı eşleşmeyi açıklayan bir algılama sonucu. | Hayır | |
| └─ kendine zarar verme | AzureContentFilterSeverityResult | Kasıtlı olarak yaralanan, yaralanan fiziksel eylemlerle ilgili dili açıklayan bir içerik filtresi kategorisi, vücuduna zarar verebilir veya kendini öldürebilirsiniz. |
Hayır | |
| └─ cinsel | AzureContentFilterSeverityResult | Anatomik organlar ve cinsel organlar, romantik ilişkiler, eylemlerle ilgili dil için içerik filtresi kategorisi erotik veya sevgi dolu terimlerle, hamilelik, fiziksel cinsel eylemler, bir olarak tasvir edilenler de dahil olmak üzere saldırı ya da zorla cinsel şiddet eylemleri, fuhuş, pornografi ve suistimal. |
Hayır | |
| └─ task_adherence | AzureContentFilterDetectionResult | Yürütme akışının plana hala bağlı kalıp kalmadığını gösteren bir algılama sonucu. | Yes | |
| └─ ungrounded_material | AzureContentFilterCompletionTextSpanDetectionResult | Hayır | ||
| └─ şiddet | AzureContentFilterSeverityResult | Zarar verme, yaralanma, zarar verme veya öldürme amaçlı fiziksel eylemlerle ilgili dil için içerik filtresi kategorisi birini veya başka bir şeyi; silahlar, silahlar ve imalatlar, ilişkilendirmeler gibi ilgili varlıkları açıklar, ve benzeri. |
Hayır | |
| source_type | Dize | İletinin kaynak türünün adı. | Yes | |
| tool_call_id | Dize | Bu içerik filtresi sonucuna ilişkin araç çağrısının kimliği, varsa. | Hayır |
AzureİçerikFiltresiKişiselOlarakTanımlanabilirBilgiSonucu
Zarar uzantılarını içeren Kişisel Bilgiler için bir içerik filtresi algılama sonucu.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detected | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| filtered | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| redacted_text | Dize | PII bilgilerinin kaldırıldığı veya maskelendiği değiştirilmiş metin. | Hayır | |
| alt_kategoriler | AzurePiiSubCategoryResult dizisi | Her bir PIIHarmSubCategory için ayrıntılı sonuçlar. | Hayır |
AzureContentFilterResultOffsets
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| check_offset | tamsayı (int32) | Yes | ||
| end_offset | tamsayı (int32) | Yes | ||
| start_offset | tamsayı (int32) | Yes |
AzureContentFilterResultsForResponsesAPI
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| custom_blocklists | AzureContentFilterBlocklistResult | Yapılandırılmış özel blok listeleri için true/false filtreleme sonuçları koleksiyonu. | Hayır | |
| └─ ayrıntılar | nesne dizisi | Bireysel blok listesi kimlik çiftleri ve bunların filtreleme işlemine yol açıp açmadığı. | Hayır | |
| └─ filtrelenmiş | boolean | Blok listesinin bir filtreleme eylemi oluşturup oluşturmadığını gösteren değer. | Yes | |
| └─ kimlik | Dize | Değerlendirilen özel blok listesinin kimliği. | Yes | |
| └─ filtrelenmiş | boolean | Ayrıntılı blok listelerinden herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer. | Yes | |
| Özel Konular | AzureContentFilterCustomTopicResult | Yapılandırılmış özel konular için doğru/yanlış filtreleme sonuçları koleksiyonu. | Hayır | |
| └─ ayrıntılar | nesne dizisi | Konu kimliği çiftleri ve tespit edilip edilmedikleri. | Hayır | |
| └─ algılandı | boolean | Konunun algılanıp algılanmadığını gösteren değer. | Yes | |
| └─ kimlik | Dize | Değerlendirilen özel konunun kimliği. | Yes | |
| └─ filtrelenmiş | boolean | Ayrıntılı konu başlıklarından herhangi birinin filtreleme eylemiyle sonuçlanıp sonuçlanmadığını gösteren değer. | Yes | |
| hata | Obje | Varsa, içerik filtrelemenin değerlendirmesini tamamlamasını engelleyen bir hatayla ilgili ayrıntılar. | Hayır | |
| └─ kod | tamsayı (int32) | Hatayla ilişkili ayrı, makine tarafından okunabilir bir kod. | Yes | |
| └─ ileti | Dize | Hata ile ilişkili insan tarafından okunabilir bir mesaj. | Yes | |
| hate | AzureContentFilterSeverityResult | İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi. |
Hayır | |
| └─ filtrelenmiş | boolean | İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| └─ önem derecesi | enum | İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high |
Yes | |
| indirect_attack | AzureContentFilterDetectionResult | İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş. |
Hayır | |
| └─ algılandı | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| └─ filtrelenmiş | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| jailbreak | AzureContentFilterDetectionResult | İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş. |
Yes | |
| └─ algılandı | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| └─ filtrelenmiş | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| kişisel olarak tanımlanabilir bilgi | AzureContentFilterPersonallyIdentifiableInformationResult | Zarar uzantılarını içeren Kişisel Bilgiler için bir içerik filtresi algılama sonucu. | Hayır | |
| └─ redacted_text | Dize | PII bilgilerinin kaldırıldığı veya maskelendiği değiştirilmiş metin. | Hayır | |
| └─ alt_kategoriler | AzurePiiSubCategoryResult dizisi | Her bir PIIHarmSubCategory için ayrıntılı sonuçlar. | Hayır | |
| profanity | AzureContentFilterDetectionResult | İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş. |
Hayır | |
| └─ algılandı | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| └─ filtrelenmiş | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| protected_material_code | Obje | Lisanslı kod veya diğer korunan kaynak malzemeyle eşleşmeyi açıklayan bir tespit sonucu. | Hayır | |
| └─ alıntı | Obje | Mümkünse, ilişkili lisansı ve onun yerini açıklayan atıf ayrıntıları. | Hayır | |
| └─ Web Adresi | dize (uri) | Lisansla ilişkili URL. | Hayır | |
| └─ lisans | Dize | Algılamayla ilişkili lisansın adı veya tanımlayıcısı. | Hayır | |
| └─ algılandı | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| └─ filtrelenmiş | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| protected_material_text | AzureContentFilterDetectionResult | İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş. |
Hayır | |
| └─ algılandı | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| └─ filtrelenmiş | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| self_harm | AzureContentFilterSeverityResult | İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi. |
Hayır | |
| └─ filtrelenmiş | boolean | İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| └─ önem derecesi | enum | İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high |
Yes | |
| sexual | AzureContentFilterSeverityResult | İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi. |
Hayır | |
| └─ filtrelenmiş | boolean | İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| └─ önem derecesi | enum | İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high |
Yes | |
| task_adherence | AzureContentFilterDetectionResult | İçeriğin algılanıp algılandığını ve içeriğin algılanıp algılanmamış olduğunu gösteren etiketli bir içerik filtresi sonuç öğesi Filtrelenmiş. |
Yes | |
| └─ algılandı | boolean | Etiketli içerik kategorisinin içerikte algılanıp algılanmadığını. | Yes | |
| └─ filtrelenmiş | boolean | İçerik algılamanın bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| ungrounded_material | AzureContentFilterCompletionTextSpanDetectionResult | Hayır | ||
| violence | AzureContentFilterSeverityResult | İçeriğin filtrelenip filtrelenmediğini ve nitel öğenin ne olduğunu gösteren etiketli içerik filtresi sonuç öğesi kategori için içerik filtresi yapılandırmasına göre değerlendirildiği gibi, içeriğin önem derecesi düzeyiydi. |
Hayır | |
| └─ filtrelenmiş | boolean | İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| └─ önem derecesi | enum | İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high |
Yes |
AzureContentFilterSeverityResult
İçeriğin filtrelenip filtrelenmediğini ve kategorinin içerik filtresi yapılandırmasına göre değerlendirildiği şekilde içeriğin nitel önem düzeyini gösteren etiketli bir içerik filtresi sonuç öğesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| filtered | boolean | İçerik önem derecesinin içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| severity | enum | İçeriğin etiketli önem derecesi. Olası değerler: safe, low, medium, high |
Yes |
AzurePiiSubCategoryResult
Bireysel PIIHarmSubCategory(ler) için sonuç ayrıntıları.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detected | boolean | etiketli içerik alt kategorisinin içerikte algılanıp algılanamadıdığı. | Yes | |
| filtered | boolean | İçerik algılamanın bu alt kategori için bir içerik filtreleme eylemiyle sonuçlanıp sonuçlanmadığı. | Yes | |
| Sansürlenmiş | boolean | İçeriğin bu alt kategori için sansürlenip sansürlenmediği. | Yes | |
| alt_kategori | Dize | Değerlendirilmiş olan PIIHarmAltKategori. | Yes |
AzureToolApprovalRequest
Azure araç onay talebi
Yanıt çıktısında bir Azure araç onay talebi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | Araç için bir JSON bağımsız değişken dizesi. | Yes | |
| call_id | Dize | Onay gerektiren araç çağrısının kimliği. | Yes | |
| kimlik | Dize | Onay talebinin benzersiz kimliği. | Yes | |
| etiket | Dize | Aracın etiketi (örneğin, 'remote_functions'). | Yes | |
| name | Dize | Araç fonksiyonunun adı (örneğin, 'output_binding'). | Yes | |
| type | enum | Öğenin türü. Her zaman tool_approval_request.Olası değerler: tool_approval_request |
Yes |
AzureToolApprovalResponse
Azure araç onay yanıtı
İstek girişinde bir Azure araç onay yanıtı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| approval_request_id | Dize | Yanıtlanan onay isteğinin ID'si. | Yes | |
| approve | boolean | İsteğin onaylanıp onaylanmadı. | Yes | |
| type | enum | Öğenin türü. Her zaman tool_approval_response.Olası değerler: tool_approval_response |
Yes |
OpenAI.Annotation
Çıkış metninin yayılma alanına uygulanan bir ek açıklama.
OpenAI.Annotation için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
file_citation |
OpenAI.FileCitationBody |
url_citation |
OpenAI.UrlCitationBody |
container_file_citation |
OpenAI.ContainerFileCitationBody |
file_path |
OpenAI.FilePath |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.AnnotationType | Yes |
OpenAI.AnnotationType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | file_citationurl_citationcontainer_file_citationfile_path |
OpenAI.ApplyPatchCallOutputStatus
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | completedfailed |
OpenAI.ApplyPatchCallOutputStatusParam
Patch çağrısı çıkış durumunu uygula
apply_patch araç çağrısı çıkışları için bildirilen sonuç değerleri.
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | completedfailed |
OpenAI.ApplyPatchCallStatus
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompleted |
OpenAI.ApplyPatchCallStatusParam
Patch çağrısı durumunu uygula
apply_patch araç çağrıları için bildirilen durum değerleri.
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompleted |
OpenAI.ApplyPatchCreateFileOperation
Uygulama patch dosya oluşturma işlemi
apply_patch aracı aracılığıyla dosya oluşturmayı açıklayan yönerge.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Fark | Dize | Uygulanacak fark. | Yes | |
| path | Dize | Oluşturulacak dosyanın yolu. | Yes | |
| type | enum | Sağlanan fark ile yeni bir dosya oluşturun. Olası değerler: create_file |
Yes | create_file |
OpenAI.ApplyPatchCreateFileOperationParam
Uygulama patch dosya oluşturma işlemi
apply_patch aracı aracılığıyla yeni dosya oluşturma yönergesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Fark | Dize | Dosyayı oluştururken uygulanacak birleşik fark içeriği. Kısıtlamalar: maxLength: 10485760 |
Yes | |
| path | Dize | Çalışma alanı köküne göre oluşturulacak dosyanın yolu. Kısıtlamalar: minLength: 1 |
Yes | |
| type | enum | İşlem türü. Her zaman create_file.Olası değerler: create_file |
Yes | create_file |
OpenAI.ApplyPatchDeleteFileOperation
Uygulama patch silme dosya işlemi
apply_patch aracı aracılığıyla bir dosyanın nasıl silineceği hakkında yönergeler.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| path | Dize | Silinecek dosyanın yolu. | Yes | |
| type | enum | Belirtilen dosyayı silin. Olası değerler: delete_file |
Yes | delete_file |
OpenAI.ApplyPatchDeleteFileOperationParam
Uygulama patch silme dosya işlemi
apply_patch aracı aracılığıyla var olan bir dosyayı silme yönergesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| path | Dize | Çalışma alanı köküne göre silinecek dosyanın yolu. Kısıtlamalar: minLength: 1 |
Yes | |
| type | enum | İşlem türü. Her zaman delete_file.Olası değerler: delete_file |
Yes | delete_file |
OpenAI.ApplyPatchFileOperation
Yama işlemini uygula
apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri.
OpenAI.ApplyPatchFileOperation için Ayrıştırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
create_file |
OpenAI.ApplyPatchCreateFileOperation |
delete_file |
OpenAI.ApplyPatchDeleteFileOperation |
update_file |
OpenAI.ApplyPatchUpdateFileOperation |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ApplyPatchFileOperationType | Yes |
OpenAI.ApplyPatchFileOperationType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | create_filedelete_fileupdate_file |
OpenAI.ApplyPatchOperationParam
Yama işlemini uygula
apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerinden biri.
OpenAI.ApplyPatchOperationParam için Ayrıştırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
create_file |
OpenAI.ApplyPatchCreateFileOperationParam |
delete_file |
OpenAI.ApplyPatchDeleteFileOperationParam |
update_file |
OpenAI.ApplyPatchUpdateFileOperationParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ApplyPatchOperationParamType | Yes |
OpenAI.ApplyPatchOperationParamType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | create_filedelete_fileupdate_file |
OpenAI.ApplyPatchToolParam
Patch aracı uygula
Asistanın dosyaları birleşik farklılıklar kullanarak oluşturmasına, silmesine veya güncellemesine olanak tanır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Aracın türü. Her zaman apply_patch.Olası değerler: apply_patch |
Yes | apply_patch |
OpenAI.ApplyPatchUpdateFileOperation
Patch güncelleme dosya işlemini uygula
apply_patch aracı aracılığıyla bir dosyanın nasıl güncelleştirileceklerini açıklayan yönerge.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Fark | Dize | Uygulanacak fark. | Yes | |
| path | Dize | Güncelleştirilecek dosyanın yolu. | Yes | |
| type | enum | Mevcut bir dosyayı sağlanan farkla güncelleştirin. Olası değerler: update_file |
Yes | update_file |
OpenAI.ApplyPatchUpdateFileOperationParam
Patch güncelleme dosya işlemini uygula
apply_patch aracı aracılığıyla var olan bir dosyayı güncelleştirme yönergesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Fark | Dize | Mevcut dosyaya uygulanacak birleşik fark içeriği. Kısıtlamalar: maxLength: 10485760 |
Yes | |
| path | Dize | Çalışma alanı köküne göre güncelleştirilecek dosyanın yolu. Kısıtlamalar: minLength: 1 |
Yes | |
| type | enum | İşlem türü. Her zaman update_file.Olası değerler: update_file |
Yes | update_file |
OpenAI.YaklaşıkKonum
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| city | dize veya null | Hayır | ||
| country | dize veya null | Hayır | ||
| region | dize veya null | Hayır | ||
| timezone | dize veya null | Hayır | ||
| type | enum | Konum yaklaşımının türü. Her zaman approximate.Olası değerler: approximate |
Yes | Yaklaşık |
OpenAI.AutoCodeInterpreterToolParam
Otomatik Kod Yorumlayıcı Aracı Parametreleri
Kod yorumlayıcı kapsayıcısı için yapılandırma. İsteğe bağlı olarak kodun çalıştırıldığı dosyaların kimliklerini belirtin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| dosya_kimlikleri | dize dizisi | Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi. Kısıtlamalar: maxItems: 50 |
Hayır | |
| bellek sınırı | OpenAI.ContainerMemoryLimit veya null | Hayır | ||
| network_policy | OpenAI.ContainerNetworkPolicyParam | Konteyner için ağ erişim politikası. | Hayır | |
| type | enum | Her zaman auto.Olası değerler: auto |
Yes | otomatik |
OpenAI.ClickButtonType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | leftrightwheelbackforward |
OpenAI.ClickParam
Click
Tıklama eylemi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| düğme | OpenAI.ClickButtonType | Yes | ||
| keys | dize dizisi veya null | Hayır | ||
| type | enum | Olay türünü belirtir. Tıklama hareketi için bu özellik her clickzaman .Olası değerler: click |
Yes | click |
| x | integer | Tıklamanın gerçekleştiği x koordinatı. | Yes | |
| y | integer | Tıklamanın gerçekleştiği y koordinatı. | Yes |
OpenAI.KodYorumlayıcıÇıktıGörüntüsü
Kod yorumlayıcı çıkış görüntüsü
Kod yorumlayıcıdan görüntü çıkışı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Çıktının türü. Her zaman image.Olası değerler: image |
Yes | image |
| url | dize (uri) | Kod yorumlayıcıdan görüntü çıkışının URL'si. | Yes |
OpenAI.KodYorumlayıcıÇıkışLogları
Kod yorumlayıcı çıktı logları
Kod yorumlayıcısının günlük çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| logs | Dize | Kod yorumlayıcısının günlük çıktısı. | Yes | |
| type | enum | Çıktının türü. Her zaman logs.Olası değerler: logs |
Yes | logs |
OpenAI.CodeInterpreterTool
Kod yorumlayıcı
Bir istem için yanıt oluşturmaya yardımcı olmak için Python kodu çalıştıran bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| container | string veya OpenAI.AutoCodeInterpreterToolParam | Kod yorumlayıcı kapsayıcısı. Kapsayıcı kimliği veya bir nesne olabilir , kodunuz için kullanılabilir hale getirmek için karşıya yüklenen dosya kimliklerini ve bir isteğe bağlı memory_limit ayarına bakın. |
Yes | |
| type | enum | Kod yorumlayıcı aracının türü. Her zaman code_interpreter.Olası değerler: code_interpreter |
Yes |
OpenAI.KıyaslamaFiltresi
Karşılaştırma Filtresi
Tanımlı bir karşılaştırma işlemi kullanarak belirtilen öznitelik anahtarını belirli bir değerle karşılaştırmak için kullanılan filtre.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| key | Dize | Değerle karşılaştırmak için anahtar. | Yes | |
| type | enum | Karşılaştırma operatörünü belirtir: eq, ne, gt, gteltlteinnin.- eq:Eşit -tir- ne: eşit değil- gt: büyüktür- gte: büyüktür veya eşittir- lt: daha azdır- lte: küçüktür veya eşittir- in:Inç- nin: içinde değilOlası değerler: eq, ne, gt, gte, lt, lte, in, nin |
Yes | eq |
| value | dizi, sayı veya boolean, dizi veya sayı dizisi | Öznitelik anahtarıyla karşılaştıracak değer; dize, sayı veya boole türlerini destekler. | Yes |
OpenAI.CompoundFilter
Bileşik Filtre
and veya or kullanarak birden çok filtreyi birleştirin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| filters | OpenAI.ComparisonFilter dizisi veya nesnesi | Birleştirilecek filtreler dizisi. Öğeler ComparisonFilter veya CompoundFilter olabilir. |
Yes | |
| type | enum | İşlem türü: and veya or.Olası değerler: and, or |
Yes |
OpenAI.ComputerAction
OpenAI.ComputerAction için Ayrıştırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
click |
OpenAI.ClickParam |
double_click |
OpenAI.DoubleClickAction |
drag |
OpenAI.DragParam |
keypress |
OpenAI.KeyPressAction |
move |
OpenAI.MoveParam |
screenshot |
OpenAI.ScreenshotParam |
scroll |
OpenAI.ScrollParam |
type |
OpenAI.TypeParam |
wait |
OpenAI.WaitParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ComputerActionType | Yes |
OpenAI.ComputerActionList
Bilgisayar Eylem Listesi
Düzleştirilmiş toplu aksiyonlar için computer_use. Her eylem bir type ayrımcıcı ve eyleme özgü alanlar içerir.
Dizisi: OpenAI.ComputerAction
OpenAI.ComputerActionType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | clickdouble_clickdragkeypressmovescreenshotscrolltypewait |
OpenAI.ComputerCallSafetyCheckParam
Bilgisayar çağrısı için bekleyen bir güvenlik denetimi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Hayır | ||
| kimlik | Dize | Bekleyen güvenlik denetiminin kimliği. | Yes | |
| message | dize veya null | Hayır |
OpenAI.ComputerEnvironment
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | windowsmaclinuxubuntubrowser |
OpenAI.ComputerScreenshotContent
Bilgisayar ekran görüntüsü
Bilgisayarın ekran görüntüsü.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| dosya_kimlik | dize veya null | Yes | ||
| image_url | dize veya null | Yes | ||
| type | enum | Olay türünü belirtir. Bilgisayar ekran görüntüsü için bu özellik her zaman olarak computer_screenshotayarlanır.Olası değerler: computer_screenshot |
Yes | computer_screenshot |
OpenAI.ComputerScreenshotImage
Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| dosya_kimlik | Dize | Yüklenmiş dosyanın, ekran görüntüsünü içeren kimliği. | Hayır | |
| image_url | dize (uri) | Ekran görüntüsü URL'si. | Hayır | |
| type | enum | Olay türünü belirtir. Bir bilgisayar ekran görüntüsü için bu özellik şu şekildedir: her zaman computer_screenshot olarak ayarlanır.Olası değerler: computer_screenshot |
Yes | computer_screenshot |
OpenAI.ComputerTool
Bilgisayar
Sanal bilgisayarı denetleyebilen bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Bilgisayar aracının türü. Her zaman computer.Olası değerler: computer |
Yes | bilgisayar |
OpenAI Bilgisayar Kullanımı Önizleme Aracı
Bilgisayar kullanımı önizlemesi
Sanal bilgisayarı denetleyebilen bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| görüntü yüksekliği | integer | Bilgisayar ekranının yüksekliği. | Yes | |
| görüntü genişliği | integer | Bilgisayar ekranının genişliği. | Yes | |
| environment | OpenAI.ComputerEnvironment | Yes | ||
| type | enum | Bilgisayar kullanım aracının türü. Her zaman computer_use_preview.Olası değerler: computer_use_preview |
Yes | computer_use_preview |
OpenAI.ContainerAutoParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| dosya_kimlikleri | dize dizisi | Kodunuz için kullanılabilir hale getirmek üzere yüklenen dosyaların isteğe bağlı bir listesi. Kısıtlamalar: maxItems: 50 |
Hayır | |
| bellek sınırı | OpenAI.ContainerMemoryLimit veya null | Hayır | ||
| network_policy | OpenAI.ContainerNetworkPolicyParam | Konteyner için ağ erişim politikası. | Hayır | |
| Beceri | OpenAI.ContainerSkill dizisi | Kimlik veya iç veri ile referans verilen isteğe bağlı bir beceri listesi. Kısıtlamalar: maxEşyalar: 200 |
Hayır | |
| type | enum | Bu istek için otomatik olarak bir konteyner oluşturur Olası değerler: container_auto |
Yes | container_auto |
OpenAI.ContainerFileCitationBody
Konteyner dosyası alıntısı
Model yanıtı oluşturmak için kullanılan bir konteyner dosyası için bir atıf.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| container_id | Dize | Konteyner dosyasının kimliği. | Yes | |
| end_index | integer | Mesajdaki konteyner dosyası alıntısının son karakterinin indeksi. | Yes | |
| dosya_kimlik | Dize | Dosyanın kimliği. | Yes | |
| filename | Dize | Bahsedilen konteyner dosyasının dosya adı. | Yes | |
| start_index | integer | Mesajdaki konteyner dosyası atıfının ilk karakterinin indeksi. | Yes | |
| type | enum | Konteyner dosyası atıfının türü. Her zaman container_file_citation.Olası değerler: container_file_citation |
Yes | container_file_citation |
OpenAI.ContainerMemoryLimit
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | 1g4g16g64g |
OpenAI.ContainerNetworkPolicyAllowlistParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| allowed_domains | dize dizisi | Tip olduğunda allowlistizin verilen alan alan türlerinin listesi.Kısıtlamalar: minItems: 1 |
Yes | |
| type | enum | Yalnızca belirli alan alanlarına giden ağ erişimine izin verin. Her zaman allowlist.Olası değerler: allowlist |
Yes | allowlist |
OpenAI.ContainerNetworkPolicyDisabledParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Çıkış ağ erişimini devre dışı bırakın. Her zaman disabled.Olası değerler: disabled |
Yes | engelli |
OpenAI.ContainerNetworkPolicyParam
Konteyner için ağ erişim politikası.
OpenAI.ContainerNetworkPolicyParam için ayrımcı.
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
disabled |
OpenAI.ContainerNetworkPolicyDisabledParam |
allowlist |
OpenAI.ContainerNetworkPolicyAllowlistParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ContainerNetworkPolicyParamType | Yes |
OpenAI.ContainerNetworkPolicyParamType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | disabledallowlist |
OpenAI.ContainerReferenceResource
Konteyner Referansı
/v1/containers ile oluşturulan bir konteyneri temsil eder.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| container_id | Dize | Yes | ||
| type | enum | Ortam türü. Her zaman container_reference.Olası değerler: container_reference |
Yes | container_reference |
OpenAI.ContainerSkill
OpenAI.ContainerSkill için ayrımcılayıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
skill_reference |
OpenAI.SkillReferenceParam |
inline |
OpenAI.InlineSkillParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ContainerSkillType | Yes |
OpenAI.ContainerSkillType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | skill_referenceinline |
OpenAI.ContextManagementParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| compact_threshold | tamsayı veya null | Hayır | ||
| type | Dize | Bağlam yönetimi giriş türü. Şu anda sadece 'sıkıştırma' destekleniyor. | Yes |
OpenAI.ConversationParam
Bu yanıtın ait olduğu konuşma. Bu konuşmadaki öğeler, bu yanıt isteği için öğesine input_items eklenir.
Bu yanıt tamamlandıktan sonra bu yanıttaki giriş öğeleri ve çıkış öğeleri otomatik olarak bu konuşmaya eklenir.
Bu bileşen aşağıdakilerden biri olabilir:
- string
- OpenAI.ConversationParam-2
OpenAI.ConversationParam-2
Konuşma nesnesi
Bu yanıtın ait olduğu konuşma.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Konuşmanın benzersiz kimliği. | Yes |
OpenAI.ConversationReference
Konuşma
Bu yanıtın ait olduğu konuşma. Bu yanıttaki giriş öğeleri ve çıkış öğeleri bu konuşmaya otomatik olarak eklendi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Bu yanıtın ilişkilendirildiği konuşmanın benzersiz kimliği. | Yes |
OpenAI.CoordParam
Koordinat
X/y koordinat çifti, örneğin. { x: 100, y: 200 }
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| x | integer | X koordinatı. | Yes | |
| y | integer | Y koordinatı. | Yes |
OpenAI.CreateResponse
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arka plan | boole veya null | Hayır | ||
| context_management | OpenAI.ContextManagementParam veya null dizisi | Bu istek için bağlam yönetimi yapılandırması. | Hayır | |
| konuşma | OpenAI.ConversationParam veya null | Hayır | ||
| include | OpenAI.IncludeEnum veya null dizisi | Hayır | ||
| input | OpenAI.InputParam | Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Görüntü girişleri - Dosya girişleri - Konuşma durumu - Fonksiyon çağrısı |
Hayır | |
| instructions | dize veya null | Hayır | ||
| max_output_tokens | tamsayı veya null | Hayır | ||
| max_tool_calls | tamsayı veya null | Hayır | ||
| metadata | OpenAI.Metadata veya null | Hayır | ||
| model | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| paralel araç çağrıları | boole veya null | Hayır | ||
| previous_response_id | dize veya null | Hayır | ||
| prompt | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| prompt_cache_retention | dize veya null | Hayır | ||
| reasoning | OpenAI.Reasoning veya null | Hayır | ||
| safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| store | boole veya null | Hayır | ||
| veri akışı | boole veya null | Hayır | ||
| stream_options | OpenAI.ResponseStreamOptions veya null | Hayır | ||
| sıcaklık | sayı veya null | Hayır | ||
| text | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| tool_choice | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| tools | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Modeli sağlayabileceğiniz iki araç kategorisi şunlardır: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar dosya arama gibi modelin özellikleri. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, Modelin kendi yazdığınız kodu çağırmasını sağlama. |
Hayır | |
| top_logprobs | tamsayı veya null | Hayır | ||
| top_p | sayı veya null | Hayır | ||
| truncation | dize veya null | Hayır | ||
| user | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır |
OpenAI.CustomGrammarFormatParam
Dilbilgisi formatı
Kullanıcı tarafından tanımlanan bir dilbilgisi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| tanım | Dize | Dilbilgisi tanımı. | Yes | |
| syntax | OpenAI.GrammarSyntax1 | Yes | ||
| type | enum | Dilbilgisi formatı. Her zaman grammar.Olası değerler: grammar |
Yes | Dilbilgisi |
OpenAI.CustomTextFormatParam
Metin biçimi
Sınırsız serbest biçimli metin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Sınırsız metin formatı. Her zaman text.Olası değerler: text |
Yes | text |
OpenAI.CustomToolParam
Özel araç
Belirli bir formatla girdiyi işleyen özel bir araç. Özel araçlar hakkında daha fazla bilgi edinin
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| defer_loading | boolean | Bu aracın ertelenip araç aramasıyla keşfedilip keşfedilmemesi gerekiyor. | Hayır | |
| Açıklama | Dize | Daha fazla bağlam sağlamak için kullanılan özel aracın isteğe bağlı açıklaması. | Hayır | |
| format | OpenAI.CustomToolParamFormat | Özel araç için giriş formatı. Varsayılan metin sınırsız olur. | Hayır | |
| └─ türü | OpenAI.CustomToolParamFormatType | Yes | ||
| name | Dize | Özel aracın adı, aracı çağırmalarda tanımlamak için kullanılır. | Yes | |
| type | enum | Özel aracın türü. Her zaman custom.Olası değerler: custom |
Yes | custom |
OpenAI.CustomToolParamFormat
Özel araç için giriş formatı. Varsayılan metin sınırsız olur.
OpenAI.CustomToolParamFormat için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
text |
OpenAI.CustomTextFormatParam |
grammar |
OpenAI.CustomGrammarFormatParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.CustomToolParamFormatType | Yes |
OpenAI.CustomToolParamFormatType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | textgrammar |
OpenAI.DetailEnum
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | lowhighautooriginal |
OpenAI.DoubleClickAction
DoubleClick
Çift tıklama eylemi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| keys | dize dizisi veya null | Yes | ||
| type | enum | Olay türünü belirtir. Çift tıklama eylemi için bu özellik her zaman olarak double_clickayarlanır.Olası değerler: double_click |
Yes | double_click |
| x | integer | Çift tıklamanın gerçekleştiği x koordinatı. | Yes | |
| y | integer | Çift tıklamanın gerçekleştiği y koordinatı. | Yes |
OpenAI.DragParam
Drag
Sürükleme eylemi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| keys | dize dizisi veya null | Hayır | ||
| path | OpenAI.CoordParam dizisi | Sürükleme eyleminin yolunu temsil eden koordinat dizisi. Koordinatlar bir nesne dizisi olarak görünür, örneğin<br> [ { x: 100, y: 200 }, { x: 200, y: 300 } ]<br> |
Yes | |
| type | enum | Olay türünü belirtir. Sürükleme eylemi için bu özellik her zaman olarak dragayarlanır.Olası değerler: drag |
Yes | sürüklenme |
OpenAI.EasyInputMessage
Giriş mesajı
Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi.
developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir.
assistant rolüne sahip iletilerin, önceki etkileşimlerde model tarafından oluşturulduğu varsayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | string veya OpenAI.InputMessageContentList | Yanıt oluşturmak için kullanılan modele metin, görüntü veya ses girişi. Önceki yardımcı yanıtlarını da içerebilir. |
Yes | |
| phase | OpenAI.MessagePhase veya null | Hayır | ||
| role | enum | İleti girişinin rolü.
user, assistant, system'den birideveloper.Olası değerler: user, assistant, system, developer |
Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | İleti girişinin türü. Her zaman message.Olası değerler: message |
Yes |
OpenAI.EmptyModelParam
Tür: nesne
OpenAI.FileCitationBody
Dosya atıfı
Bir dosyaya referans.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| dosya_kimlik | Dize | Dosyanın kimliği. | Yes | |
| filename | Dize | Belirtilen dosyanın dosya adı. | Yes | |
| indeks | integer | Dosya listesindeki dosyanın dizini. | Yes | |
| type | enum | Dosya alıntısının türü. Her zaman file_citation.Olası değerler: file_citation |
Yes | file_citation |
OpenAI.FileInputDetail
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | lowhigh |
OpenAI.FilePath
Dosya yolu
Bir dosyaya giden yol.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| dosya_kimlik | Dize | Dosyanın kimliği. | Yes | |
| indeks | integer | Dosya listesindeki dosyanın dizini. | Yes | |
| type | enum | Dosya yolunun türü. Her zaman file_path.Olası değerler: file_path |
Yes |
OpenAI.FileSearchTool
Dosya arama
Yüklenen dosyalardan ilgili içeriği arayan bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| filters | OpenAI.Filters veya null | Hayır | ||
| maks_sonuç_sayısı | integer | Döndürülecek en fazla sonuç sayısı. Bu sayı 1 ile 50 (dahil) arasında olmalıdır. | Hayır | |
| Sıralama_seçenekleri | OpenAI.RankingOptions | Hayır | ||
| └─ hybrid_search | OpenAI.HybridSearchOptions | Hibrit arama etkinleştirildiğinde karşılıklı sıralama birleşiminin anlamsal gömütme eşleşmeleri ile seyrek anahtar kelime eşleşmelerini nasıl dengelediğini kontrol eden ağırlıklar. | Hayır | |
| └─ sıralama yapıcı | OpenAI.RankerVersionType | Dosya araması için kullanılacak dereceleyici. | Hayır | |
| └─ skor_eşiği | number | Dosya araması için puan eşiği, 0 ile 1 arasında bir sayı. 1'e yakın sayılar yalnızca en uygun sonuçları döndürmeye çalışır, ancak daha az sonuç döndürebilir. | Hayır | |
| type | enum | Dosya arama aracının türü. Her zaman file_search.Olası değerler: file_search |
Yes | file_search |
| vector_store_ids | dize dizisi | Aranacak vektör depolarının kimlikleri. | Yes |
OpenAI.FileSearchToolCallResults
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| attributes | OpenAI.VectorStoreFileAttributes veya null | Hayır | ||
| dosya_kimlik | Dize | Hayır | ||
| filename | Dize | Hayır | ||
| Skor | sayı (yüzerlik) | Hayır | ||
| text | Dize | Hayır |
OpenAI.Filters
Tür: OpenAI.ComparisonFilter veya OpenAI.CompoundFilter
OpenAI.FunctionAndCustomToolCallOutput
OpenAI.FunctionAndCustomToolCallOutput için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
input_text |
OpenAI.FunctionAndCustomToolCallOutputInputTextContent |
input_image |
OpenAI.FunctionAndCustomToolCallOutputInputImageContent |
input_file |
OpenAI.FunctionAndCustomToolCallOutputInputFileContent |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.FunctionAndCustomToolCallOutputType | Yes |
OpenAI.FunctionAndCustomToolCallOutputInputFileContent
Giriş dosyası
Modele bir dosya girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.FileInputDetail | Hayır | ||
| file_data | Dize | Modele gönderilecek dosyanın içeriği. | Hayır | |
| dosya_kimlik | dize veya null | Hayır | ||
| file_url | dize (uri) | Modele gönderilecek dosyanın URL'si. | Hayır | |
| filename | Dize | Modele gönderilecek dosyanın adı. | Hayır | |
| type | enum | Giriş öğesinin türü. Her zaman input_file.Olası değerler: input_file |
Yes | input_file |
OpenAI.FunctionAndCustomToolCallOutputInputImageContent
Giriş görüntüsü
Modele bir görüntü girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| dosya_kimlik | dize veya null | Hayır | ||
| image_url | dize veya null | Hayır | ||
| type | enum | Giriş öğesinin türü. Her zaman input_image.Olası değerler: input_image |
Yes | input_image |
OpenAI.FunctionAndCustomToolCallOutputInputTextContent
Giriş metni
Modele metin girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modele metin girişi. | Yes | |
| type | enum | Giriş öğesinin türü. Her zaman input_text.Olası değerler: input_text |
Yes | input_text |
OpenAI.FunctionAndCustomToolCallOutputType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | input_textinput_imageinput_file |
OpenAI.FunctionCallItemStatus
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompletedincomplete |
OpenAI.FunctionCallOutputStatusEnum
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompletedincomplete |
OpenAI.FunctionCallStatus
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompletedincomplete |
OpenAI.FunctionShellAction
Shell yönetici eylemi
Bir kabuk komutu yürütür.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| commands | dize dizisi | Yes | ||
| max_output_length | tamsayı veya null | Yes | ||
| zaman_aşımı_ms | tamsayı veya null | Yes |
OpenAI.FunctionShellActionParam
Mermi mekanizması
Kabuk aracı çağrısını çalıştırmayı açıklayan komutlar ve sınırlar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| commands | dize dizisi | Yürütme ortamının çalışması için sıralı kabuk komutları. | Yes | |
| max_output_length | tamsayı veya null | Hayır | ||
| zaman_aşımı_ms | tamsayı veya null | Hayır |
OpenAI.FunctionShellCallEnvironment
OpenAI için ayrımcı.FunctionShellCallEnvironment
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
local |
OpenAI.LocalEnvironmentResource |
container_reference |
OpenAI.ContainerReferenceResource |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.FunctionShellCallEnvironmentType | Yes |
OpenAI.FunctionShellCallEnvironmentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | localcontainer_reference |
OpenAI.FunctionShellCallItemParamEnvironment
Shell komutlarını çalıştırmak için ortam.
OpenAI.FunctionShellCallItemParamEnvironment için diskriminator
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
local |
OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam |
container_reference |
OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.FunctionShellCallItemParamEnvironmentType | Yes |
OpenAI.FunctionShellCallItemParamEnvironmentContainerReferenceParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| container_id | Dize | Referans edilen konteynerin kimliği. | Yes | |
| type | enum | /v1/containers uç noktasıyla oluşturulan bir konteynere referanslar Olası değerler: container_reference |
Yes | container_reference |
OpenAI.FunctionShellCallItemParamEnvironmentLocalEnvironmentParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Beceri | OpenAI.LocalSkillParam dizisi | İsteğe bağlı bir beceri listesi. Kısıtlamalar: maxEşyalar: 200 |
Hayır | |
| type | enum | Yerel bir bilgisayar ortamı kullanın. Olası değerler: local |
Yes | yerel |
OpenAI.FunctionShellCallItemParamEnvironmentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | localcontainer_reference |
OpenAI.FunctionShellCallItemStatus
Shell çağrısı durumu
Kabuk aracı çağrıları için bildirilen durum değerleri.
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompletedincomplete |
OpenAI.FunctionShellCallOutputContent
Shell çağrısı çıkış içeriği
Bir kabuk aracının içeriği, yayılan çağrı çıkışını çağırır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| sonuç | OpenAI.FunctionShellCallOutputOutcome | Bir çıkış sonucunu (çıkış koduyla) veya kabuk çağrısı çıkış öbekleri için zaman aşımı sonucunu temsil eder. | Yes | |
| └─ türü | OpenAI.FunctionShellCallOutputOutcomeType | Yes | ||
| Stderr | Dize | Yakalanan standart hata çıkışı. | Yes | |
| stdout | Dize | Yakalanan standart çıkış. | Yes |
OpenAI.FunctionShellCallOutputContentParam
Shell çıkış içeriği
Kabuk aracı çağrı çıkışının bir bölümü için yakalanan stdout ve stderr.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| sonuç | OpenAI.FunctionShellCallOutputOutcomeParam | Bu kabuk çağrısıyla ilişkili çıkış veya zaman aşımı sonucu. | Yes | |
| └─ türü | OpenAI.FunctionShellCallOutputOutcomeParamType | Yes | ||
| Stderr | Dize | Kabuk çağrısı için yakalanan stderr çıkışı. Kısıtlamalar: maxLength: 10485760 |
Yes | |
| stdout | Dize | Kabuk çağrısı için yakalanan stdout çıkışı. Kısıtlamalar: maxLength: 10485760 |
Yes |
OpenAI.FunctionShellCallOutputExitOutcome
Shell çağrısı çıkış sonucu
Shell komutlarının tamamlandığını ve çıkış kodunu döndürdüğünü gösterir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| exit_code | integer | Kabuk işleminden çıkış kodu. | Yes | |
| type | enum | Sonuç türü. Her zaman exit.Olası değerler: exit |
Yes | exit |
OpenAI.FunctionShellCallOutputExitOutcomeParam
Shell çağrısı çıkış sonucu
Shell komutlarının tamamlandığını ve çıkış kodunu döndürdüğünü gösterir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| exit_code | integer | Shell süreciyle geri dönen çıkış kodu. | Yes | |
| type | enum | Sonuç türü. Her zaman exit.Olası değerler: exit |
Yes | exit |
OpenAI.FunctionShellCallOutputOutcome
Shell çağrısı sonucu
Bir çıkış sonucunu (çıkış koduyla) veya kabuk çağrısı çıkış öbekleri için zaman aşımı sonucunu temsil eder.
OpenAI.FunctionShellCallOutputOutcome için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
timeout |
OpenAI.FunctionShellCallOutputTimeoutOutcome |
exit |
OpenAI.FunctionShellCallOutputExitOutcome |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.FunctionShellCallOutputOutcomeType | Yes |
OpenAI.FunctionShellCallOutputOutcomeParam
Shell çağrısı sonucu
Bu kabuk çağrısıyla ilişkili çıkış veya zaman aşımı sonucu.
OpenAI.FunctionShellCallOutputOutcomeParam için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
timeout |
OpenAI.FunctionShellCallOutputTimeoutOutcomeParam |
exit |
OpenAI.FunctionShellCallOutputExitOutcomeParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.FunctionShellCallOutputOutcomeParamType | Yes |
OpenAI.FunctionShellCallOutputOutcomeParamType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | timeoutexit |
OpenAI.FunctionShellCallOutputOutcomeType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | timeoutexit |
OpenAI.FunctionShellCallOutputStatusEnum
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompletedincomplete |
OpenAI.FunctionShellCallOutputTimeoutOutcome
Shell call timeout sonucu
Shell çağrısının ayarlanmış zaman sınırını aştığını gösterir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Sonuç türü. Her zaman timeout.Olası değerler: timeout |
Yes | timeout |
OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
Shell call timeout sonucu
Shell çağrısının ayarlanmış zaman sınırını aştığını gösterir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Sonuç türü. Her zaman timeout.Olası değerler: timeout |
Yes | timeout |
OpenAI.FunctionShellCallStatus
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompletedincomplete |
OpenAI.FunctionShellToolParam
Shell alet
Modelin shell komutlarını çalıştırmasına olanak tanıyan bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| environment | OpenAI.FunctionShellToolParamEnvironment veya null | Hayır | ||
| type | enum | Kabuk aracının türü. Her zaman shell.Olası değerler: shell |
Yes | Kabuk |
OpenAI.FunctionShellToolParamEnvironment
OpenAI için ayrımcı.FunctionShellToolParamEnvironment
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
local |
OpenAI.FunctionShellToolParamEnvironmentEnvironmentParam |
container_reference |
OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam |
container_auto |
OpenAI.ContainerAutoParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.FunctionShellToolParamEnvironmentType | Yes |
OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| container_id | Dize | Referans edilen konteynerin kimliği. | Yes | |
| type | enum | /v1/containers uç noktasıyla oluşturulan bir konteynere referanslar Olası değerler: container_reference |
Yes | container_reference |
OpenAI.FunctionShellToolParamEnvironmentEnvironmentParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Beceri | OpenAI.LocalSkillParam dizisi | İsteğe bağlı bir beceri listesi. Kısıtlamalar: maxEşyalar: 200 |
Hayır | |
| type | enum | Yerel bir bilgisayar ortamı kullanın. Olası değerler: local |
Yes | yerel |
OpenAI.FunctionShellToolParamEnvironmentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | container_autolocalcontainer_reference |
OpenAI.FunctionTool
Function
Modelin çağırmayı seçebileceği kendi kodunuzda bir işlev tanımlar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| defer_loading | boolean | Bu fonksiyonun araç aramasıyla erteleyip yüklenip yüklenmediği. | Hayır | |
| Açıklama | dize veya null | Hayır | ||
| name | Dize | Çağrılacak işlevin adı. | Yes | |
| parameters | object veya null | Yes | ||
| Kesin | boole veya null | Yes | ||
| type | enum | İşlev aracının türü. Her zaman function.Olası değerler: function |
Yes | function |
OpenAI.FunctionToolParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| defer_loading | boolean | Bu fonksiyonun araç aramasıyla ertelenip keşfedilmemesi gerekip bilinmediği. | Hayır | |
| Açıklama | dize veya null | Hayır | ||
| name | Dize |
Kısıtlamalar: minUzunluk: 1, maxUzunluk: 128, desen: ^[a-zA-Z0-9_-]+$ |
Yes | |
| parameters | OpenAI.EmptyModelParam or null | Hayır | ||
| Kesin | boole veya null | Hayır | ||
| type | enum | Olası değerler: function |
Yes | function |
OpenAI.GrammarSyntax1
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | larkregex |
OpenAI.HybridSearchOptions
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| embedding_weight | number | Karşılıklı sıralama füzyonundaki gömülen ağırlığı. | Yes | |
| text_weight | number | Karşılıklı sıralama birleşimindeki metnin ağırlığı. | Yes |
OpenAI.ImageDetail
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | lowhighautooriginal |
OpenAI.ImageGenActionEnum
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | generateeditauto |
OpenAI.ImageGenTool
Görüntü oluşturma aracı
GPT görüntü modelleriyle görüntü üreten bir araç.
Geçerli modeller:
gpt-image-1
gpt-image-1-mini
gpt-image-1.5
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.ImageGenActionEnum | Hayır | ||
| arka plan | enum | Oluşturulan görüntünün arka plan türü. Bunlardan biri transparentopaqueveya auto. Varsayılan: auto.Olası değerler: transparent, opaque, auto |
Hayır | otomatik |
| input_fidelity | OpenAI.InputFidelity veya null | Hayır | ||
| girdi_görüntü_maskesi | OpenAI.ImageGenToolInputImageMask | Hayır | ||
| └─ dosya_kimliği | Dize | Hayır | ||
| └─ image_url (görsel URL'si) | dize (uri) | Hayır | ||
| model | dize (aşağıdaki geçerli modellere bakın) | Hayır | ||
| moderation | enum | Oluşturulan görüntü için denetim düzeyi. Varsayılan: auto.Olası değerler: auto, low |
Hayır | otomatik |
| çıktı sıkıştırma | integer | Çıkış görüntüsü için sıkıştırma düzeyi. Varsayılan: 100. Kısıtlamalar: min: 0, max: 100 |
Hayır | 100 |
| çıkış formatı | enum | Oluşturulan görüntünün çıkış biçimi.
png, webp, veya bunlardan birijpeg. Varsayılan: png.Olası değerler: png, webp, jpeg |
Hayır | png |
| kısmi_görüntüler | integer | Akış modunda 0 'dan (varsayılan değer) 3'e kadar oluşturulacak kısmi görüntü sayısı. Kısıtlamalar: min: 0, max: 3 |
Hayır | |
| nitelik | enum | Oluşturulan görüntünün kalitesi.
low'den biri, medium, high,veya auto. Varsayılan: auto.Olası değerler: low, medium, high, auto |
Hayır | otomatik |
| size | dize (aşağıdaki geçerli modellere bakın) | Oluşturulan görüntülerin boyutu. ve içingpt-image-2, rastgele çözünürlükler dizi gpt-image-2-2026-04-21 olarak desteklenir, örneğin WIDTHxHEIGHT.1536x864 Genişlik ve yükseklik 16'ya bölünebilir olmalı ve istenen en-boy oranı 1:3 ile 3:1 arasında olmalıdır. Yukarıdaki 2560x1440 çözümler deneyseldir ve desteklenen maksimum çözünürlük .3840x2160 İstenen boyut ayrıca modelin mevcut piksel ve kenar sınırlarını karşılamalıdır. Standart boyutlar 1024x1024, 1536x1024, ve 1024x1536 GPT görüntü modelleri tarafından desteklenir; auto otomatik boyutlandırmaya izin veren modeller için desteklenir. için, dall-e-2, veya '256x256512x5121024x1024den birini kullanın. için, dall-e-3, veya '1024x10241792x10241024x1792den birini kullanın. |
Hayır | |
| type | enum | Görüntü oluşturma aracının türü. Her zaman image_generation.Olası değerler: image_generation |
Yes | image_generation |
OpenAI.ImageGenToolInputImageMask
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| dosya_kimlik | Dize | Hayır | ||
| image_url | dize (uri) | Hayır |
OpenAI.IncludeEnum
Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır:
-
web_search_call.results: Web arama aracı çağrısının arama sonuçlarını ekleyin. -
web_search_call.action.sources: Web arama aracı çağrısının kaynaklarını ekleyin. -
code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir. -
computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin. -
file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin. -
message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin. -
message.output_text.logprobs: Yardımcı mesajlara logprobs ekleyin. -
reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin,storeparametresifalseolarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar.
| Property | Değer |
|---|---|
| Tanım | Model yanıtına eklenecek ek çıktı verilerini belirtin. Şu anda desteklenen değerler şunlardır: - web_search_call.results: Web arama aracı çağrısının arama sonuçlarını ekleyin.- web_search_call.action.sources: Web arama aracı çağrısının kaynaklarını ekleyin.- code_interpreter_call.outputs: Kod yorumlayıcı aracı çağrı öğelerinde python kod yürütme çıktılarını içerir.- computer_call_output.output.image_url: Bilgisayar çağrısı çıkışından görüntü URL'lerini ekleyin.- file_search_call.results: Dosya arama aracı çağrısının arama sonuçlarını ekleyin.- message.input_image.image_url: Giriş iletisinden görüntü URL'lerini ekleyin.- message.output_text.logprobs: Yardımcı iletilerine logprobs ekleyin.- reasoning.encrypted_content: Akıl yürütme öğesi çıkışlarında akıl yürütme belirteçlerinin şifrelenmiş bir sürümünü içerir. Bu, Yanıtlar API'sini durum bilgisi olmadan kullanırken (örneğin, store parametresi false olarak ayarlandığında veya bir kuruluş sıfır veri saklama programına kaydedildiğinde) akıl yürütme öğelerinin çok aşamalı konuşmalarda kullanılmasını sağlar. |
| Türü | Dize |
| Değerler | file_search_call.resultsweb_search_call.resultsweb_search_call.action.sourcesmessage.input_image.image_urlcomputer_call_output.output.image_urlcode_interpreter_call.outputsreasoning.encrypted_contentmessage.output_text.logprobs |
OpenAI.InlineSkillParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Açıklama | Dize | Becerinin tanımı. | Yes | |
| name | Dize | Becerinin adı. | Yes | |
| kaynak | OpenAI.InlineSkillSourceParam | Hat içi beceri yükü | Yes | |
| └─ veri | Dize | Base64 kodlu yetenek zip paketi. Kısıtlamalar: minUzunluk: 1, maxUzunluk: 70254592 |
Yes | |
| └─ media_type | enum | Hat içi beceri yükünün medya türü. olmalıdır application/zip.Olası değerler: application/zip |
Yes | application/zip |
| └─ türü | enum | Hat içi beceri kaynağının türü. olmalıdır base64.Olası değerler: base64 |
Yes | base64 |
| type | enum | Bu istek için bir satır içi yetenek tanımlar. Olası değerler: inline |
Yes | inline |
OpenAI.InlineSkillSourceParam
Hat içi beceri yükü
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| data | Dize | Base64 kodlu yetenek zip paketi. Kısıtlamalar: minUzunluk: 1, maxUzunluk: 70254592 |
Yes | |
| media_type | enum | Hat içi beceri yükünün medya türü. olmalıdır application/zip.Olası değerler: application/zip |
Yes | application/zip |
| type | enum | Hat içi beceri kaynağının türü. olmalıdır base64.Olası değerler: base64 |
Yes | base64 |
OpenAI.InputContent
OpenAI.InputContent için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
input_text |
OpenAI.InputContentInputTextContent |
input_image |
OpenAI.InputContentInputImageContent |
input_file |
OpenAI.InputContentInputFileContent |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.InputContentType | Yes |
OpenAI.InputContentInputFileContent
Giriş dosyası
Modele bir dosya girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.FileInputDetail | Hayır | ||
| file_data | Dize | Modele gönderilecek dosyanın içeriği. | Hayır | |
| dosya_kimlik | dize veya null | Hayır | ||
| file_url | dize (uri) | Modele gönderilecek dosyanın URL'si. | Hayır | |
| filename | Dize | Modele gönderilecek dosyanın adı. | Hayır | |
| type | enum | Giriş öğesinin türü. Her zaman input_file.Olası değerler: input_file |
Yes | input_file |
OpenAI.InputContentInputImageContent
Giriş görüntüsü
Modele bir görüntü girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| dosya_kimlik | dize veya null | Hayır | ||
| image_url | dize veya null | Hayır | ||
| type | enum | Giriş öğesinin türü. Her zaman input_image.Olası değerler: input_image |
Yes | input_image |
OpenAI.InputContentInputTextContent
Giriş metni
Modele metin girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modele metin girişi. | Yes | |
| type | enum | Giriş öğesinin türü. Her zaman input_text.Olası değerler: input_text |
Yes | input_text |
OpenAI.InputContentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | input_textinput_imageinput_file |
OpenAI.InputFidelity
Modelin giriş görüntülerinin stil ve özellikleriyle, özellikle yüz özellikleriyle eşleşmesi için ne kadar çaba göstereceğini kontrol edin. Bu parametre yalnızca ve gpt-image-1 sonraki modeller için desteklenirgpt-image-1.5, desteklenmezgpt-image-1-mini.
high ve lowdestekler. Varsayılan değer low’dır.
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | highlow |
OpenAI.InputFileContent
Giriş dosyası
Modele bir dosya girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.FileInputDetail | Hayır | ||
| file_data | Dize | Modele gönderilecek dosyanın içeriği. | Hayır | |
| dosya_kimlik | dize veya null | Hayır | ||
| file_url | dize (uri) | Modele gönderilecek dosyanın URL'si. | Hayır | |
| filename | Dize | Modele gönderilecek dosyanın adı. | Hayır | |
| type | enum | Giriş öğesinin türü. Her zaman input_file.Olası değerler: input_file |
Yes | input_file |
OpenAI.InputFileContentParam
Giriş dosyası
Modele bir dosya girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.FileInputDetail | Hayır | ||
| file_data | dize veya null | Hayır | ||
| dosya_kimlik | dize veya null | Hayır | ||
| file_url | dize veya null | Hayır | ||
| filename | dize veya null | Hayır | ||
| type | enum | Giriş öğesinin türü. Her zaman input_file.Olası değerler: input_file |
Yes | input_file |
OpenAI.InputImageContent
Giriş görüntüsü
Modele bir görüntü girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| dosya_kimlik | dize veya null | Hayır | ||
| image_url | dize veya null | Hayır | ||
| type | enum | Giriş öğesinin türü. Her zaman input_image.Olası değerler: input_image |
Yes | input_image |
OpenAI.InputImageContentParamAutoParam
Giriş görüntüsü
Modele bir görüntü girişi. Görüntü girişleri hakkında bilgi edinin
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.DetailEnum or null | Hayır | ||
| dosya_kimlik | dize veya null | Hayır | ||
| image_url | dize veya null | Hayır | ||
| type | enum | Giriş öğesinin türü. Her zaman input_image.Olası değerler: input_image |
Yes | input_image |
OpenAI.InputItem
Model tarafından oluşturulacak yanıt için bağlamın bir bölümünü temsil eden bir öğe. Metin, görüntü ve ses girişlerinin yanı sıra önceki yardımcı yanıtları ve araç çağrısı çıkışlarını içerebilir.
OpenAI.InputItem için Ayrıştırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.InputItemType | Yes |
OpenAI.InputItemApplyPatchToolCallItemParam
Yama aracı çağrısını uygula
Fark düzeltme eklerini kullanarak dosya oluşturma, silme veya güncelleştirme isteğini temsil eden bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64 |
Yes | |
| kimlik | dize veya null | Hayır | ||
| Operasyon | OpenAI.ApplyPatchOperationParam | apply_patch aracına sağlanan create_file, delete_file veya update_file işlemlerinden biri. | Yes | |
| └─ türü | OpenAI.ApplyPatchOperationParamType | Yes | ||
| durum | OpenAI.ApplyPatchCallStatusParam | apply_patch araç çağrıları için bildirilen durum değerleri. | Yes | |
| type | enum | Öğenin türü. Her zaman apply_patch_call.Olası değerler: apply_patch_call |
Yes | apply_patch_call |
OpenAI.InputItemApplyPatchToolCallOutputItemParam
Patch tool çağrı çıktısını uygula
Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan akış çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64 |
Yes | |
| kimlik | dize veya null | Hayır | ||
| output | dize veya null | Hayır | ||
| durum | OpenAI.ApplyPatchCallOutputStatusParam | apply_patch araç çağrısı çıkışları için bildirilen sonuç değerleri. | Yes | |
| type | enum | Öğenin türü. Her zaman apply_patch_call_output.Olası değerler: apply_patch_call_output |
Yes | apply_patch_call_output |
OpenAI.InputItemCodeInterpreterToolCall
Kod yorumlayıcı araç çağrısı
Kodu çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| container_id | Dize | Kodu çalıştırmak için kullanılan kapsayıcının kimliği. | Yes | |
| kimlik | Dize | Kod yorumlayıcısı araç çağrısının benzersiz kimliği. | Yes | |
| outputs | OpenAI.CodeInterpreterOutputLogs dizisi veya OpenAI.CodeInterpreterOutputImage veya null | Yes | ||
| durum | enum | Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed.Olası değerler: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call.Olası değerler: code_interpreter_call |
Yes | code_interpreter_call |
OpenAI.InputItemCompactionSummaryItemParam
Sıkıştırma maddesi
API tarafından v1/responses/compact oluşturulan bir sıkıştırma öğesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| encrypted_content | Dize | Sıkıştırma özetinin şifrelenmiş içeriği. Kısıtlamalar: maxLength: 10485760 |
Yes | |
| kimlik | dize veya null | Hayır | ||
| type | enum | Öğenin türü. Her zaman compaction.Olası değerler: compaction |
Yes | sıkıştırma |
OpenAI.InputItemComputerCallOutputItemParam
Bilgisayar aracı çağrısı çıkışı
Bir bilgisayar aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| acknowledged_safety_checks | OpenAI.ComputerCallSafetyCheckParam dizisi veya null | Hayır | ||
| call_id | Dize | Çıktı üreten bilgisayar aracı çağrısının kimliği. Kısıtlamalar: minLength: 1, maxLength: 64 |
Yes | |
| kimlik | dize veya null | Hayır | ||
| output | OpenAI.ComputerScreenshotImage | Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü. | Yes | |
| durum | OpenAI.FunctionCallItemStatus or null | Hayır | ||
| type | enum | Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output.Olası değerler: computer_call_output |
Yes | computer_call_output |
OpenAI.InputItemComputerToolCall
Bilgisayar aracı çağrısı
Bilgisayar kullanım araçlarına bir araç komutu verme.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Hayır | ||
| actions | OpenAI.ComputerActionList | Düzleştirilmiş toplu aksiyonlar için computer_use. Her eylem birtype ayrımcı ve eyleme özgü alanlar. |
Hayır | |
| call_id | Dize | Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı. | Yes | |
| kimlik | Dize | Bilgisayar çağrısının benzersiz tanımlayıcısı. | Yes | |
| pending_safety_checks | OpenAI.ComputerCallSafetyCheckParam dizisi | Bilgisayar çağrısı için bekleyen güvenlik denetimleri. | Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Bilgisayar çağrısının türü. Her zaman computer_call.Olası değerler: computer_call |
Yes | computer_call |
OpenAI.InputItemCustomToolCall
Özel araç çağrısı
Model tarafından oluşturulan özel bir araca çağrı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı. | Yes | |
| kimlik | Dize | OpenAI platformundaki özel araç çağrısının benzersiz kimliği. | Hayır | |
| input | Dize | Model tarafından oluşturulan özel araç çağrısı için girdi. | Yes | |
| name | Dize | Çağrılan özel aracın adı. | Yes | |
| namespace | Dize | Çağrılan özel aracın isim alanı. | Hayır | |
| type | enum | Özel araç çağrısının türü. Her zaman custom_tool_call.Olası değerler: custom_tool_call |
Yes |
OpenAI.InputItemCustomToolCallOutput
Özel araç çağrısı çıkışı
Kodunuzdan özel bir araç çağrısının çıktısı, modele geri gönderiliyor.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Çağrı kimliği, bu özel araç çağrısı çıktısını özel bir araç çağrısına eşlemek için kullanılır. | Yes | |
| kimlik | Dize | OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği. | Hayır | |
| output | OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi | Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dize veya çıkış içeriği listesi olabilir. |
Yes | |
| type | enum | Özel araç çağrısı çıkışının türü. Her zaman custom_tool_call_output.Olası değerler: custom_tool_call_output |
Yes |
OpenAI.InputItemFileSearchToolCall
Dosya arama aracı çağrısı
Dosya arama aracı çağrısının sonuçları.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Dosya arama aracı çağrısının benzersiz kimliği. | Yes | |
| queries | dize dizisi | Dosyaları aramak için kullanılan sorgular. | Yes | |
| results | OpenAI.FileSearchToolCallResults veya null dizisi | Hayır | ||
| durum | enum | Dosya arama aracı çağrısının durumu. Bunlardan biri in_progresssearching, incomplete veya failed,Olası değerler: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | Dosya arama aracı çağrısının türü. Her zaman file_search_call.Olası değerler: file_search_call |
Yes |
OpenAI.InputItemFunctionCallOutputItemParam
Fonksiyon aracı çağrı çıktısı
İşlev aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64 |
Yes | |
| kimlik | dize veya null | Hayır | ||
| output | OpenAI.InputTextContentParam veya OpenAI.InputImageContentParamAutoParam veya OpenAI.InputFileContentParam dizesi veya dizisi | İşlev aracı çağrısının metin, görüntü veya dosya çıkışı. | Yes | |
| durum | OpenAI.FunctionCallItemStatus or null | Hayır | ||
| type | enum | İşlev aracının çağrı çıktısının türü. Her zaman function_call_output.Olası değerler: function_call_output |
Yes | function_call_output |
OpenAI.InputItemFunctionShellCallItemParam
Shell araç çağrısı
Bir veya daha fazla kabuk komutu yürütme isteğini temsil eden bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.FunctionShellActionParam | Kabuk aracı çağrısını çalıştırmayı açıklayan komutlar ve sınırlar. | Yes | |
| └─ komutları | dize dizisi | Yürütme ortamının çalışması için sıralı kabuk komutları. | Yes | |
| └─ max_output_length | tamsayı veya null | Hayır | ||
| └─ timeout_ms | tamsayı veya null | Hayır | ||
| call_id | Dize | Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64 |
Yes | |
| environment | OpenAI.FunctionShellCallItemParamEnvironment veya null | Hayır | ||
| kimlik | dize veya null | Hayır | ||
| durum | OpenAI.FunctionShellCallItemStatus or null | Hayır | ||
| type | enum | Öğenin türü. Her zaman shell_call.Olası değerler: shell_call |
Yes | shell_call |
OpenAI.InputItemFunctionShellCallOutputItemParam
Shell araç çağrısı çıkışı
Bir kabuk aracı çağrısı tarafından yayılan akışlı çıkış öğeleri.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. Kısıtlamalar: minLength: 1, maxLength: 64 |
Yes | |
| kimlik | dize veya null | Hayır | ||
| max_output_length | tamsayı veya null | Hayır | ||
| output | OpenAI.FunctionShellCallOutputContentParam dizisi | Stdout ve stderr çıkışının yakalanan öbekleri ve bunların ilişkili sonuçları. | Yes | |
| durum | OpenAI.FunctionShellCallItemStatus or null | Hayır | ||
| type | enum | Öğenin türü. Her zaman shell_call_output.Olası değerler: shell_call_output |
Yes | shell_call_output |
OpenAI.InputItemFunctionToolCall
Fonksiyon araç çağrısı
Bir fonksiyonu çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | İşleve geçirecek bağımsız değişkenlerin JSON dizesi. | Yes | |
| call_id | Dize | Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | dize (salt okunur) | İşlev aracı çağrısının benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılacak işlevin adı. | Yes | |
| namespace | Dize | Çalıştırılacak fonksiyonun isim alanı. | Hayır | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | İşlev aracı çağrısının türü. Her zaman function_call.Olası değerler: function_call |
Yes |
OpenAI.InputItemImageGenToolCall
Görüntü oluşturma çağrısı
Model tarafından yapılan bir görüntü oluşturma isteği.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Görüntü oluşturma çağrısının benzersiz kimliği. | Yes | |
| result | dize veya null | Yes | ||
| durum | enum | Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed |
Yes | |
| type | enum | Görüntü oluşturma çağrısının türü. Her zaman image_generation_call.Olası değerler: image_generation_call |
Yes |
OpenAI.InputItemLocalShellToolCall
Yerel shell çağrısı
Yerel kabukta komut çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Sunucuda bir shell komutu çalıştırın. | Yes | |
| call_id | Dize | Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | Dize | Yerel shell çağrısının benzersiz kimliği. | Yes | |
| durum | enum | Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Yerel shell call'ın türü. Her zaman local_shell_call.Olası değerler: local_shell_call |
Yes |
OpenAI.InputItemLocalShellToolCallOutput
Yerel kabuk çağrısı çıkışı
Yerel kabuk aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği. | Yes | |
| output | Dize | Yerel shell aracı çağrısının çıktısının JSON dizesi. | Yes | |
| durum | dize veya null | Hayır | ||
| type | enum | Yerel kabuk aracı çağrı çıkışının türü. Her zaman local_shell_call_output.Olası değerler: local_shell_call_output |
Yes |
OpenAI.InputItemMcpApprovalRequest
MCP onay talebi
Bir araç çağrısı işlemi için insan onayı isteği.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | Araç için bir JSON bağımsız değişken dizesi. | Yes | |
| kimlik | Dize | Onay talebinin benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılacak aracın adı. | Yes | |
| sunucu etiketi | Dize | İsteği yapan MCP sunucusunun etiketi. | Yes | |
| type | enum | Öğenin türü. Her zaman mcp_approval_request.Olası değerler: mcp_approval_request |
Yes |
OpenAI.InputItemMcpApprovalResponse
MCP onay yanıtı
MCP onay isteğine yanıt.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| approval_request_id | Dize | Yanıtlanan onay isteğinin ID'si. | Yes | |
| approve | boolean | İsteğin onaylanıp onaylanmadı. | Yes | |
| kimlik | dize veya null | Hayır | ||
| neden | dize veya null | Hayır | ||
| type | enum | Öğenin türü. Her zaman mcp_approval_response.Olası değerler: mcp_approval_response |
Yes |
OpenAI.InputItemMcpListTools
MCP liste araçları
MCP sunucusunda kullanılabilen araçların listesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| hata | OpenAI.RealtimeMCPError | Hayır | ||
| kimlik | Dize | Listenin benzersiz kimliği. | Yes | |
| sunucu etiketi | Dize | MCP sunucusunun etiketi. | Yes | |
| tools | OpenAI.MCPListToolsTool dizisi | Sunucuda bulunan araçlar. | Yes | |
| type | enum | Öğenin türü. Her zaman mcp_list_tools.Olası değerler: mcp_list_tools |
Yes |
OpenAI.InputItemMcpToolCall
MCP araç çağrısı
MCP sunucusundaki bir aracın çağrılması.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| approval_request_id | dize veya null | Hayır | ||
| arguments | Dize | Araca geçirilen bağımsız değişkenlerin JSON dizesi. | Yes | |
| hata | OpenAI.RealtimeMCPError | Hayır | ||
| kimlik | Dize | Araç çağrısının benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılan aracın adı. | Yes | |
| output | dize veya null | Hayır | ||
| sunucu etiketi | Dize | Aracı çalıştıran MCP sunucusunun etiketi. | Yes | |
| durum | OpenAI.MCPToolCallStatus | Hayır | ||
| type | enum | Öğenin türü. Her zaman mcp_call.Olası değerler: mcp_call |
Yes |
OpenAI.InputItemOutputMessage
Çıkış mesajı
Modelden bir çıkış iletisi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | OpenAI.OutputMessageContent dizisi | Çıkış iletisinin içeriği. | Yes | |
| kimlik | Dize | Çıkış iletisinin benzersiz kimliği. | Yes | |
| phase | OpenAI.MessagePhase veya null | Hayır | ||
| role | enum | Çıkış iletisinin rolü. Her zaman assistant.Olası değerler: assistant |
Yes | |
| durum | enum | İleti girişinin durumu.
in_progress, completed, veya bunlardan biriincomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Çıkış iletisinin türü. Her zaman message.Olası değerler: output_message |
Yes |
OpenAI.InputItemReasoningItem
Reasoning
Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Bağlamı el ile yönetiyorsanız, bu öğeleri konuşmanın sonraki dönüşleri için Yanıtlar API'nize input eklediğinizden emin olun.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | OpenAI.ReasoningTextContent dizisi | Metin içeriğini akıl yürütme. | Hayır | |
| encrypted_content | dize veya null | Hayır | ||
| kimlik | Dize | Akıl yürütme içeriğinin benzersiz tanımlayıcısı. | Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| summary | OpenAI dizisi.ÖzetMetinİçkisi | Akıl yürütme özeti içeriği. | Yes | |
| type | enum | Nesnenin türü. Her zaman reasoning.Olası değerler: reasoning |
Yes |
OpenAI.InputItemToolSearchCallItemParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | OpenAI.EmptyModelParam | Yes | ||
| call_id | dize veya null | Hayır | ||
| idam | OpenAI.ToolSearchExecutionType | Hayır | ||
| kimlik | dize veya null | Hayır | ||
| durum | OpenAI.FunctionCallItemStatus or null | Hayır | ||
| type | enum | Öğe türü. Her zaman tool_search_call.Olası değerler: tool_search_call |
Yes | tool_search_call |
OpenAI.InputItemToolSearchOutputItemParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | dize veya null | Hayır | ||
| idam | OpenAI.ToolSearchExecutionType | Hayır | ||
| kimlik | dize veya null | Hayır | ||
| durum | OpenAI.FunctionCallItemStatus or null | Hayır | ||
| tools | OpenAI.Tool dizisi | Yüklenen araç tanımları, araç arama çıktısıyla döner. | Yes | |
| type | enum | Öğe türü. Her zaman tool_search_output.Olası değerler: tool_search_output |
Yes | tool_search_output |
OpenAI.InputItemType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | messageoutput_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputtool_search_calltool_search_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callitem_referencetool_approval_response |
OpenAI.InputItemWebSearchToolCall
Web arama aracı çağrısı
Bir web arama aracı çağrısının sonuçları.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind | Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına dair detaylar içerir (arama, open_page, find_in_page). |
Yes | |
| kimlik | Dize | Web arama aracının benzersiz kimliği çağrı. | Yes | |
| durum | enum | Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed |
Yes | |
| type | enum | Web arama aracının türü. Her zaman web_search_call.Olası değerler: web_search_call |
Yes |
OpenAI.InputMessageContentList
Giriş öğesi içerik listesi
Modelde farklı içerik türleri içeren bir veya birden çok giriş öğesinin listesi.
Dizisi: OpenAI.InputContent
OpenAI.InputParam
Yanıt oluşturmak için kullanılan modele metin, görüntü veya dosya girişleri. Daha fazla bilgi edinin:
- Metin girişleri ve çıkışları
- Görüntü girişleri
- Dosya girişleri
- Konuşma durumu
- İşlev çağrısı
Bu bileşen aşağıdakilerden biri olabilir:
- string
- array
OpenAI.InputTextContent
Giriş metni
Modele metin girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modele metin girişi. | Yes | |
| type | enum | Giriş öğesinin türü. Her zaman input_text.Olası değerler: input_text |
Yes | input_text |
OpenAI.InputTextContentParam
Giriş metni
Modele metin girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modele metin girişi. Kısıtlamalar: maxLength: 10485760 |
Yes | |
| type | enum | Giriş öğesinin türü. Her zaman input_text.Olası değerler: input_text |
Yes | input_text |
OpenAI.ItemReferenceParam
Öğe referansı
Başvurulacak bir öğenin iç tanımlayıcısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Başvurulacak öğenin kimliği. | Yes | |
| type | enum | Başvurulacak öğenin türü. Her zaman item_reference.Olası değerler: item_reference |
Yes | item_reference |
OpenAI.ItemResource
Yanıt oluşturmak için kullanılan içerik öğesi.
OpenAI.ItemResource için Ayrıştırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ItemResourceType | Yes |
OpenAI.ItemResourceApplyPatchToolCall
Yama aracı çağrısını uygula
Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Bu araç çağrısını oluşturan varlığın kimliği. | Hayır | |
| kimlik | Dize | Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| Operasyon | OpenAI.ApplyPatchFileOperation | apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri. | Yes | |
| └─ türü | OpenAI.ApplyPatchFileOperationType | Yes | ||
| durum | OpenAI.ApplyPatchCallStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman apply_patch_call.Olası değerler: apply_patch_call |
Yes | apply_patch_call |
OpenAI.ItemResourceApplyPatchToolCallOutput
Patch tool çağrı çıktısını uygula
Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Bu aracı oluşturan varlığın kimliği çağrı çıktısı. | Hayır | |
| kimlik | Dize | Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| output | dize veya null | Hayır | ||
| durum | OpenAI.ApplyPatchCallOutputStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman apply_patch_call_output.Olası değerler: apply_patch_call_output |
Yes | apply_patch_call_output |
OpenAI.ItemResourceCodeInterpreterToolCall
Kod yorumlayıcı araç çağrısı
Kodu çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| container_id | Dize | Kodu çalıştırmak için kullanılan kapsayıcının kimliği. | Yes | |
| kimlik | Dize | Kod yorumlayıcısı araç çağrısının benzersiz kimliği. | Yes | |
| outputs | OpenAI.CodeInterpreterOutputLogs dizisi veya OpenAI.CodeInterpreterOutputImage veya null | Yes | ||
| durum | enum | Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed.Olası değerler: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call.Olası değerler: code_interpreter_call |
Yes | code_interpreter_call |
OpenAI.ItemResourceCompactionBody
Sıkıştırma maddesi
API tarafından v1/responses/compact oluşturulan bir sıkıştırma öğesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| encrypted_content | Dize | Sıkıştırma tarafından oluşturulan şifrelenmiş içerik. | Yes | |
| kimlik | Dize | Sıkıştırma öğesinin benzersiz kimliği. | Yes | |
| type | enum | Öğenin türü. Her zaman compaction.Olası değerler: compaction |
Yes | sıkıştırma |
OpenAI.ItemResourceComputerToolCall
Bilgisayar aracı çağrısı
Bilgisayar kullanım araçlarına bir araç komutu verme.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Hayır | ||
| actions | OpenAI.ComputerActionList | Düzleştirilmiş toplu aksiyonlar için computer_use. Her eylem birtype ayrımcı ve eyleme özgü alanlar. |
Hayır | |
| call_id | Dize | Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı. | Yes | |
| kimlik | Dize | Bilgisayar çağrısının benzersiz tanımlayıcısı. | Yes | |
| pending_safety_checks | OpenAI.ComputerCallSafetyCheckParam dizisi | Bilgisayar çağrısı için bekleyen güvenlik denetimleri. | Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Bilgisayar çağrısının türü. Her zaman computer_call.Olası değerler: computer_call |
Yes | computer_call |
OpenAI.ItemResourceComputerToolCallOutput
Bilgisayar aracı çağrısı çıkışı
Bir bilgisayar aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| acknowledged_safety_checks | OpenAI.ComputerCallSafetyCheckParam dizisi | API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici. |
Hayır | |
| call_id | Dize | Çıktı üreten bilgisayar aracı çağrısının kimliği. | Yes | |
| kimlik | dize (salt okunur) | Bilgisayar aracı çağrısı çıkış kimliği. | Yes | |
| output | OpenAI.ComputerScreenshotImage | Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü. | Yes | |
| durum | enum | İleti girişinin durumu.
in_progress, completed, veya bunlardan biriincomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output.Olası değerler: computer_call_output |
Yes | computer_call_output |
OpenAI.ItemResourceCustomToolCallOutputResource
ResponseCustomToolCallOutputItem
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Çağrı kimliği, bu özel araç çağrısı çıktısını özel bir araç çağrısına eşlemek için kullanılır. | Yes | |
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| kimlik | Dize | OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği. | Hayır | |
| output | OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi | Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dize veya çıkış içeriği listesi olabilir. |
Yes | |
| durum | OpenAI.FunctionCallOutputStatusEnum | Yes | ||
| type | enum | Özel araç çağrısı çıkışının türü. Her zaman custom_tool_call_output.Olası değerler: custom_tool_call_output |
Yes |
OpenAI.ItemResourceCustomToolCallResource
ResponseCustomToolCallItem
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı. | Yes | |
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| kimlik | Dize | OpenAI platformundaki özel araç çağrısının benzersiz kimliği. | Hayır | |
| input | Dize | Model tarafından oluşturulan özel araç çağrısı için girdi. | Yes | |
| name | Dize | Çağrılan özel aracın adı. | Yes | |
| namespace | Dize | Çağrılan özel aracın isim alanı. | Hayır | |
| durum | OpenAI.FunctionCallStatus | Yes | ||
| type | enum | Özel araç çağrısının türü. Her zaman custom_tool_call.Olası değerler: custom_tool_call |
Yes |
OpenAI.ItemResourceFileSearchToolCall
Dosya arama aracı çağrısı
Dosya arama aracı çağrısının sonuçları.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Dosya arama aracı çağrısının benzersiz kimliği. | Yes | |
| queries | dize dizisi | Dosyaları aramak için kullanılan sorgular. | Yes | |
| results | OpenAI.FileSearchToolCallResults veya null dizisi | Hayır | ||
| durum | enum | Dosya arama aracı çağrısının durumu. Bunlardan biri in_progresssearching, incomplete veya failed,Olası değerler: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | Dosya arama aracı çağrısının türü. Her zaman file_search_call.Olası değerler: file_search_call |
Yes |
OpenAI.ItemResourceFunctionShellCall
Shell araç çağrısı
Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.FunctionShellAction | Bir kabuk komutu yürütür. | Yes | |
| └─ komutları | dize dizisi | Yes | ||
| └─ max_output_length | tamsayı veya null | Yes | ||
| └─ timeout_ms | tamsayı veya null | Yes | ||
| call_id | Dize | Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Bu araç çağrısını oluşturan varlığın kimliği. | Hayır | |
| environment | OpenAI.FunctionShellCallEnvironment veya null | Yes | ||
| kimlik | Dize | Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| durum | OpenAI.FunctionShellCallStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman shell_call.Olası değerler: shell_call |
Yes | shell_call |
OpenAI.ItemResourceFunctionShellCallOutput
Shell çağrı çıkışı
Yayılan bir kabuk aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| kimlik | Dize | Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| max_output_length | tamsayı veya null | Yes | ||
| output | OpenAI.FunctionShellCallOutputContent dizisi | Kabuk çağrısı çıkış içeriği dizisi | Yes | |
| durum | OpenAI.FunctionShellCallOutputStatusEnum | Yes | ||
| type | enum | Kabuk çağrısı çıkışının türü. Her zaman shell_call_output.Olası değerler: shell_call_output |
Yes | shell_call_output |
OpenAI.ItemResourceFunctionToolCall
Fonksiyon araç çağrısı
Bir fonksiyonu çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | İşleve geçirecek bağımsız değişkenlerin JSON dizesi. | Yes | |
| call_id | Dize | Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | dize (salt okunur) | İşlev aracı çağrısının benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılacak işlevin adı. | Yes | |
| namespace | Dize | Çalıştırılacak fonksiyonun isim alanı. | Hayır | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | İşlev aracı çağrısının türü. Her zaman function_call.Olası değerler: function_call |
Yes |
OpenAI.ItemResourceFunctionToolCallOutput
Fonksiyon aracı çağrı çıktısı
İşlev aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | dize (salt okunur) | İşlev aracının çağrı çıkışının benzersiz kimliği. Bu öğe doldurulduğunda API aracılığıyla döndürülür. |
Yes | |
| output | OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi | Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dize veya çıkış içeriği listesi olabilir. |
Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | İşlev aracının çağrı çıktısının türü. Her zaman function_call_output.Olası değerler: function_call_output |
Yes |
OpenAI.ItemResourceImageGenToolCall
Görüntü oluşturma çağrısı
Model tarafından yapılan bir görüntü oluşturma isteği.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Görüntü oluşturma çağrısının benzersiz kimliği. | Yes | |
| result | dize veya null | Yes | ||
| durum | enum | Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed |
Yes | |
| type | enum | Görüntü oluşturma çağrısının türü. Her zaman image_generation_call.Olası değerler: image_generation_call |
Yes |
OpenAI.ItemResourceInputMessage
Giriş mesajı
Modele, hiyerarşiyi izleyen yönergeyi belirten bir rol içeren bir ileti girişi.
developer veya system rolüyle verilen yönergeler, user rolüyle verilen yönergelerden önceliklidir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | OpenAI.InputMessageContentList | Modelde farklı içerik içeren bir veya birden çok giriş öğesinin listesi types. |
Yes | |
| kimlik | dize (salt okunur) | İleti girişinin benzersiz kimliği. | Yes | |
| role | enum | İleti girişinin rolü.
user, systemveya developer.Olası değerler: user, system, developer |
Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | İleti girişinin türü. Her zaman messageolarak ayarlayın.Olası değerler: message |
Yes | message |
OpenAI.ItemResourceLocalShellToolCall
Yerel shell çağrısı
Yerel kabukta komut çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Sunucuda bir shell komutu çalıştırın. | Yes | |
| call_id | Dize | Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | Dize | Yerel shell çağrısının benzersiz kimliği. | Yes | |
| durum | enum | Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Yerel shell call'ın türü. Her zaman local_shell_call.Olası değerler: local_shell_call |
Yes |
OpenAI.ItemResourceLocalShellToolCallOutput
Yerel kabuk çağrısı çıkışı
Yerel kabuk aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği. | Yes | |
| output | Dize | Yerel shell aracı çağrısının çıktısının JSON dizesi. | Yes | |
| durum | dize veya null | Hayır | ||
| type | enum | Yerel kabuk aracı çağrı çıkışının türü. Her zaman local_shell_call_output.Olası değerler: local_shell_call_output |
Yes |
OpenAI.ItemResourceMcpApprovalRequest
MCP onay talebi
Bir araç çağrısı işlemi için insan onayı isteği.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | Araç için bir JSON bağımsız değişken dizesi. | Yes | |
| kimlik | Dize | Onay talebinin benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılacak aracın adı. | Yes | |
| sunucu etiketi | Dize | İsteği yapan MCP sunucusunun etiketi. | Yes | |
| type | enum | Öğenin türü. Her zaman mcp_approval_request.Olası değerler: mcp_approval_request |
Yes |
OpenAI.ItemResourceMcpApprovalResponseResource
MCP onay yanıtı
MCP onay isteğine yanıt.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| approval_request_id | Dize | Yanıtlanan onay isteğinin ID'si. | Yes | |
| approve | boolean | İsteğin onaylanıp onaylanmadı. | Yes | |
| kimlik | Dize | Onay yanıtının benzersiz kimliği | Yes | |
| neden | dize veya null | Hayır | ||
| type | enum | Öğenin türü. Her zaman mcp_approval_response.Olası değerler: mcp_approval_response |
Yes |
OpenAI.ItemResourceMcpListTools
MCP liste araçları
MCP sunucusunda kullanılabilen araçların listesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| hata | OpenAI.RealtimeMCPError | Hayır | ||
| kimlik | Dize | Listenin benzersiz kimliği. | Yes | |
| sunucu etiketi | Dize | MCP sunucusunun etiketi. | Yes | |
| tools | OpenAI.MCPListToolsTool dizisi | Sunucuda bulunan araçlar. | Yes | |
| type | enum | Öğenin türü. Her zaman mcp_list_tools.Olası değerler: mcp_list_tools |
Yes |
OpenAI.ItemResourceMcpToolCall
MCP araç çağrısı
MCP sunucusundaki bir aracın çağrılması.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| approval_request_id | dize veya null | Hayır | ||
| arguments | Dize | Araca geçirilen bağımsız değişkenlerin JSON dizesi. | Yes | |
| hata | OpenAI.RealtimeMCPError | Hayır | ||
| kimlik | Dize | Araç çağrısının benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılan aracın adı. | Yes | |
| output | dize veya null | Hayır | ||
| sunucu etiketi | Dize | Aracı çalıştıran MCP sunucusunun etiketi. | Yes | |
| durum | OpenAI.MCPToolCallStatus | Hayır | ||
| type | enum | Öğenin türü. Her zaman mcp_call.Olası değerler: mcp_call |
Yes |
OpenAI.ItemResourceOutputMessage
Çıkış mesajı
Modelden bir çıkış iletisi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | OpenAI.OutputMessageContent dizisi | Çıkış iletisinin içeriği. | Yes | |
| kimlik | Dize | Çıkış iletisinin benzersiz kimliği. | Yes | |
| phase | OpenAI.MessagePhase veya null | Hayır | ||
| role | enum | Çıkış iletisinin rolü. Her zaman assistant.Olası değerler: assistant |
Yes | |
| durum | enum | İleti girişinin durumu.
in_progress, completed, veya bunlardan biriincomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Çıkış iletisinin türü. Her zaman message.Olası değerler: output_message |
Yes |
OpenAI.ItemKaynakReasoningItem
Reasoning
Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Bağlamı el ile yönetiyorsanız, bu öğeleri konuşmanın sonraki dönüşleri için Yanıtlar API'nize input eklediğinizden emin olun.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | OpenAI.ReasoningTextContent dizisi | Metin içeriğini akıl yürütme. | Hayır | |
| encrypted_content | dize veya null | Hayır | ||
| kimlik | Dize | Akıl yürütme içeriğinin benzersiz tanımlayıcısı. | Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| summary | OpenAI dizisi.ÖzetMetinİçkisi | Akıl yürütme özeti içeriği. | Yes | |
| type | enum | Nesnenin türü. Her zaman reasoning.Olası değerler: reasoning |
Yes |
OpenAI.ItemResourceToolSearchCall
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Araç arama çağrısı için kullanılan argümanlar. | Yes | ||
| call_id | dize veya null | Yes | ||
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| idam | OpenAI.ToolSearchExecutionType | Yes | ||
| kimlik | Dize | Arama aracı çağrı öğesinin benzersiz kimliği. | Yes | |
| durum | OpenAI.FunctionCallStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman tool_search_call.Olası değerler: tool_search_call |
Yes | tool_search_call |
OpenAI.ItemResourceToolSearchOutput
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | dize veya null | Yes | ||
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| idam | OpenAI.ToolSearchExecutionType | Yes | ||
| kimlik | Dize | Araç arama çıktı öğesinin benzersiz kimliği. | Yes | |
| durum | OpenAI.FunctionCallOutputStatusEnum | Yes | ||
| tools | OpenAI.Tool dizisi | Yüklenmiş araç tanımları araç aramasıyla döner. | Yes | |
| type | enum | Öğenin türü. Her zaman tool_search_output.Olası değerler: tool_search_output |
Yes | tool_search_output |
OpenAI.ItemResourceType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | messageoutput_messagefile_search_callcomputer_callcomputer_call_outputweb_search_callfunction_callfunction_call_outputtool_search_calltool_search_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_callcustom_tool_call_output |
OpenAI.ItemResourceWebSearchToolCall
Web arama aracı çağrısı
Bir web arama aracı çağrısının sonuçları.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind | Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına dair detaylar içerir (arama, open_page, find_in_page). |
Yes | |
| kimlik | Dize | Web arama aracının benzersiz kimliği çağrı. | Yes | |
| durum | enum | Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed |
Yes | |
| type | enum | Web arama aracının türü. Her zaman web_search_call.Olası değerler: web_search_call |
Yes |
OpenAI.KeyPressAction
KeyPress
Modelin gerçekleştirmek istediği tuş baskıları koleksiyonu.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| keys | dize dizisi | Modelin basılmasını istediği tuş kombinasyonu. Bu, her biri bir anahtarı temsil eden bir dize dizisidir. | Yes | |
| type | enum | Olay türünü belirtir. Bir tuşa basma eylemi için bu özellik her zaman olarak keypressayarlanır.Olası değerler: keypress |
Yes | Tuş baskısı |
OpenAI.LocalEnvironmentResource
Yerel Çevre
Shell eylemlerini gerçekleştirmek için yerel bir ortamın kullanımını temsil eder.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Ortam türü. Her zaman local.Olası değerler: local |
Yes | yerel |
OpenAI.LocalShellExecAction
Yerel shell yönetici eylemi
Sunucuda bir shell komutu çalıştırın.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| komut | dize dizisi | Çalıştırılacak komut. | Yes | |
| env | Obje | Komutu için ayarlanacağı ortam değişkenleri. | Yes | |
| zaman_aşımı_ms | tamsayı veya null | Hayır | ||
| type | enum | Yerel kabuk eyleminin türü. Her zaman exec.Olası değerler: exec |
Yes | exec |
| user | dize veya null | Hayır | ||
| çalışma_dizini | dize veya null | Hayır |
OpenAI.LocalShellToolParam
Yerel kabuk aracı
Modelin yerel bir ortamda kabuk komutlarını yürütmesine izin veren bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Yerel kabuk aracının türü. Her zaman local_shell.Olası değerler: local_shell |
Yes | local_shell |
OpenAI.LocalSkillParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Açıklama | Dize | Becerinin tanımı. | Yes | |
| name | Dize | Becerinin adı. | Yes | |
| path | Dize | Yetiği içeren dizine giden yol. | Yes |
OpenAI.LogProb
Log olasılığı
Belirtecin logaritmik olasılığı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| bytes | tamsayı dizisi | Yes | ||
| logprob | number | Yes | ||
| token | Dize | Yes | ||
| top_logprobs | OpenAI.TopLogProb dizisi | Yes |
OpenAI.MCPListToolsTool
MCP liste araçları aracı
MCP sunucusunda kullanılabilen bir araç.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| annotations | OpenAI.MCPListToolsToolAnnotations veya null | Hayır | ||
| Açıklama | dize veya null | Hayır | ||
| input_schema | OpenAI.MCPListToolsToolInputSchema | Yes | ||
| name | Dize | Araç adı. | Yes |
OpenAI.MCPListToolsToolAnnotations
Tür: nesne
OpenAI.MCPListToolsToolInputSchema
Tür: nesne
OpenAI.MCPTool
MCP aracı
Modele uzak Model Bağlam Protokolü (MCP) sunucuları aracılığıyla ek araçlara erişim verin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| izin verilen araçlar | dize dizisi veya OpenAI.MCPToolFilter veya null | Hayır | ||
| authorization | Dize | Uzak bir MCP sunucusuyla kullanılabilen bir OAuth access token, şu iki özel bir MCP sunucu URL'si veya hizmet bağlayıcısı ile. Uygulamanız OAuth yetkilendirme akışını işlemesi ve belirteci burada sağlaması gerekir. |
Hayır | |
| connector_id | enum | ChatGPT'de bulunanlara benzer hizmet bağlayıcıları için tanımlayıcı. Bunlardan biriserver_url veya connector_id sağlanmalıdır. Hizmet hakkında daha fazla bilgi edininBağlantı noktaları burada. Şu anda desteklenen connector_id değerler şunlardır:-Dropbox: connector_dropbox-Gmail: connector_gmail- Google Takvim: connector_googlecalendar- Google Drive: connector_googledrive- Microsoft Teams: connector_microsoftteams- Outlook Takvimi: connector_outlookcalendar- Outlook E-postası: connector_outlookemail-Sharepoint: connector_sharepointOlası değerler: connector_dropbox, connector_gmail, connector_googlecalendar, connector_googledrive, connector_microsoftteams, connector_outlookcalendar, connector_outlookemail, connector_sharepoint |
Hayır | |
| defer_loading | boolean | Bu MCP aracının araç aramasıyla erteleyip keşfedilip keşfedilmediği. | Hayır | |
| headers | object veya null | Hayır | ||
| onay_gerektir | OpenAI.MCPToolRequireApproval veya dize veya null | Hayır | ||
| server_description | Dize | MCP sunucusunun isteğe bağlı açıklaması, daha fazla bağlam sağlamak için kullanılır. | Hayır | |
| sunucu etiketi | Dize | Bu MCP sunucusu için araç çağrılarında tanımlamak için kullanılan bir etiket. | Yes | |
| sunucu_url | dize (uri) | MCP sunucusunun URL'si.
server_url Bunlardan biri veya connector_id olması gerekirSağlanan. |
Hayır | |
| type | enum | MCP aracının türü. Her zaman mcp.Olası değerler: mcp |
Yes |
OpenAI.MCPToolCallStatus
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | in_progresscompletedincompletecallingfailed |
OpenAI.MCPToolFilter
MCP araç filtresi
Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| read_only | boolean | Bir aracın veriyi değiştirip değiştirmediğini veya sadece okunabilir olup olmadığını gösterir. Bir MCP sunucusuna ile readOnlyHintek açıklama eklenir.bu filtreyle eşleşecektir. |
Hayır | |
| tool_names | dize dizisi | İzin verilen araç adlarının listesi. | Hayır |
OpenAI.MCPToolRequireApproval
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| always | OpenAI.MCPToolFilter | Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi. | Hayır | |
| hiç | OpenAI.MCPToolFilter | Hangi araçların izin verildiğini belirtmek için bir filtre nesnesi. | Hayır |
OpenAI.MessageContent
Giriş veya çıkış öğesini oluşturan içerik bölümü.
OpenAI.MessageContent için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
text |
OpenAI.TextContent |
computer_screenshot |
OpenAI.ComputerScreenshotContent |
input_text |
OpenAI.MessageContentInputTextContent |
output_text |
OpenAI.MessageContentOutputTextContent |
reasoning_text |
OpenAI.MessageContentReasoningTextContent |
refusal |
OpenAI.MessageContentRefusalContent |
input_image |
OpenAI.MessageContentInputImageContent |
input_file |
OpenAI.MessageContentInputFileContent |
summary_text |
OpenAI.SummaryTextContent |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.MessageContentType | Yes |
OpenAI.MessageContentInputFileContent
Giriş dosyası
Modele bir dosya girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.FileInputDetail | Hayır | ||
| file_data | Dize | Modele gönderilecek dosyanın içeriği. | Hayır | |
| dosya_kimlik | dize veya null | Hayır | ||
| file_url | dize (uri) | Modele gönderilecek dosyanın URL'si. | Hayır | |
| filename | Dize | Modele gönderilecek dosyanın adı. | Hayır | |
| type | enum | Giriş öğesinin türü. Her zaman input_file.Olası değerler: input_file |
Yes | input_file |
OpenAI.MessageContentInputImageContent
Giriş görüntüsü
Modele bir görüntü girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| detail | OpenAI.ImageDetail | Yes | ||
| dosya_kimlik | dize veya null | Hayır | ||
| image_url | dize veya null | Hayır | ||
| type | enum | Giriş öğesinin türü. Her zaman input_image.Olası değerler: input_image |
Yes | input_image |
OpenAI.MessageContentInputTextContent
Giriş metni
Modele metin girişi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modele metin girişi. | Yes | |
| type | enum | Giriş öğesinin türü. Her zaman input_text.Olası değerler: input_text |
Yes | input_text |
OpenAI.MessageContentOutputTextContent
Çıktı metni
Modelden bir metin çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| annotations | OpenAI.Annotation dizisi | Metin çıkışının ek açıklamaları. | Yes | |
| logprobs | OpenAI.LogProb dizisi | Yes | ||
| text | Dize | Modelden metin çıkışı. | Yes | |
| type | enum | Çıkış metninin türü. Her zaman output_text.Olası değerler: output_text |
Yes | output_text |
OpenAI.MessageContentReasoningTextContent
Gerekçe metni
Modelden mantık metni.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modelden gelen mantık metni. | Yes | |
| type | enum | Akıl yürütme metninin türü. Her zaman reasoning_text.Olası değerler: reasoning_text |
Yes | reasoning_text |
OpenAI.MessageContentRefusalContent
Refusal
Model tarafından reddedilme.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Ret | Dize | Modelin sunduğu reddetme gerekçesi. | Yes | |
| type | enum | Reddetmenin türü. Her zaman refusal.Olası değerler: refusal |
Yes | Ret |
OpenAI.MessageContentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | input_textoutput_texttextsummary_textreasoning_textrefusalinput_imagecomputer_screenshotinput_file |
OpenAI.MessagePhase
Bir mesajı assistant ara yorum (commentary) veya nihai cevap (final_answer) olarak etiketler.
Benzer gpt-5.3-codex ve öteki modellerde, takip talepleri gönderirken, tüm asistan mesajlarında fazı koruyup yeniden gönderin — bu aşamayı bırakmak performansı düşürebilir. Kullanıcı mesajları için kullanılmıyor.
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | commentaryfinal_answer |
OpenAI.Metadata
Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter olan dizelerdir.
Tür: nesne
OpenAI.MoveParam
Move
Fare hareket ettirme eylemi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| keys | dize dizisi veya null | Hayır | ||
| type | enum | Olay türünü belirtir. Taşıma eylemi için bu özellik her zaman move olarak ayarlanır.Olası değerler: move |
Yes | move |
| x | integer | Taşınacak x koordinatı. | Yes | |
| y | integer | Taşınması gereken y koordinatı. | Yes |
OpenAI.NamespaceToolParam
Namespace
Gruplar ortak bir isim alanı altında işlev/özel araçlar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Açıklama | Dize | Modele gösterilen isim alanının bir açıklaması. Kısıtlamalar: minLength: 1 |
Yes | |
| name | Dize | Araç çağrılarında kullanılan isim alanı adı (örneğin, crm).Kısıtlamalar: minLength: 1 |
Yes | |
| tools | OpenAI.FunctionToolParam veya OpenAI.CustomToolParam dizisi | Bu isim alanı içinde mevcut olan fonksiyon/özel araçlar. Kısıtlamalar: minItems: 1 |
Yes | |
| type | enum | Aracın türü. Her zaman namespace.Olası değerler: namespace |
Yes | namespace |
OpenAI.OutputContent
OpenAI.OutputContent için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
output_text |
OpenAI.OutputContentOutputTextContent |
refusal |
OpenAI.OutputContentRefusalContent |
reasoning_text |
OpenAI.OutputContentReasoningTextContent |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.OutputContentType | Yes |
OpenAI.OutputContentOutputTextContent
Çıktı metni
Modelden bir metin çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| annotations | OpenAI.Annotation dizisi | Metin çıkışının ek açıklamaları. | Yes | |
| logprobs | OpenAI.LogProb dizisi | Yes | ||
| text | Dize | Modelden metin çıkışı. | Yes | |
| type | enum | Çıkış metninin türü. Her zaman output_text.Olası değerler: output_text |
Yes | output_text |
OpenAI.OutputContentReasoningTextContent
Gerekçe metni
Modelden mantık metni.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modelden gelen mantık metni. | Yes | |
| type | enum | Akıl yürütme metninin türü. Her zaman reasoning_text.Olası değerler: reasoning_text |
Yes | reasoning_text |
OpenAI.OutputContentRefusalContent
Refusal
Model tarafından reddedilme.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Ret | Dize | Modelin sunduğu reddetme gerekçesi. | Yes | |
| type | enum | Reddetmenin türü. Her zaman refusal.Olası değerler: refusal |
Yes | Ret |
OpenAI.OutputContentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | output_textrefusalreasoning_text |
OpenAI.OutputItem
OpenAI.OutputItem için Ayrıştırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.OutputItemType | Yes |
OpenAI.OutputItemApplyPatchToolCall
Yama aracı çağrısını uygula
Dosya oluşturarak, silerek veya güncelleştirerek dosya farklarını uygulayan bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Bu araç çağrısını oluşturan varlığın kimliği. | Hayır | |
| kimlik | Dize | Düzeltme eki uygulama aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| Operasyon | OpenAI.ApplyPatchFileOperation | apply_patch aracılığıyla uygulanan create_file, delete_file veya update_file işlemlerinden biri. | Yes | |
| └─ türü | OpenAI.ApplyPatchFileOperationType | Yes | ||
| durum | OpenAI.ApplyPatchCallStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman apply_patch_call.Olası değerler: apply_patch_call |
Yes | apply_patch_call |
OpenAI.OutputItemApplyPatchToolCallOutput
Patch tool çağrı çıktısını uygula
Bir düzeltme eki uygulama aracı çağrısı tarafından yayılan çıkış.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan uygulama yama aracı çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Bu aracı oluşturan varlığın kimliği çağrı çıktısı. | Hayır | |
| kimlik | Dize | Düzeltme eki uygulama aracı çağrı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| output | dize veya null | Hayır | ||
| durum | OpenAI.ApplyPatchCallOutputStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman apply_patch_call_output.Olası değerler: apply_patch_call_output |
Yes | apply_patch_call_output |
OpenAI.OutputItemCodeInterpreterToolCall
Kod yorumlayıcı araç çağrısı
Kodu çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| container_id | Dize | Kodu çalıştırmak için kullanılan kapsayıcının kimliği. | Yes | |
| kimlik | Dize | Kod yorumlayıcısı araç çağrısının benzersiz kimliği. | Yes | |
| outputs | OpenAI.CodeInterpreterOutputLogs dizisi veya OpenAI.CodeInterpreterOutputImage veya null | Yes | ||
| durum | enum | Kod yorumlayıcı aracı çağrısının durumu. Geçerli değerler : in_progress, completed, incomplete, interpretingve failed.Olası değerler: in_progress, completed, incomplete, interpreting, failed |
Yes | |
| type | enum | Kod yorumlayıcı aracı çağrısının türü. Her zaman code_interpreter_call.Olası değerler: code_interpreter_call |
Yes | code_interpreter_call |
OpenAI.OutputItemCompactionBody
Sıkıştırma maddesi
API tarafından v1/responses/compact oluşturulan bir sıkıştırma öğesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| encrypted_content | Dize | Sıkıştırma tarafından oluşturulan şifrelenmiş içerik. | Yes | |
| kimlik | Dize | Sıkıştırma öğesinin benzersiz kimliği. | Yes | |
| type | enum | Öğenin türü. Her zaman compaction.Olası değerler: compaction |
Yes | sıkıştırma |
OpenAI.OutputItemComputerToolCall
Bilgisayar aracı çağrısı
Bilgisayar kullanım araçlarına bir araç komutu verme.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.ComputerAction | Hayır | ||
| actions | OpenAI.ComputerActionList | Düzleştirilmiş toplu aksiyonlar için computer_use. Her eylem birtype ayrımcı ve eyleme özgü alanlar. |
Hayır | |
| call_id | Dize | Çıkış verisi ile araç çağrısına yanıt verirken kullanılan tanımlayıcı. | Yes | |
| kimlik | Dize | Bilgisayar çağrısının benzersiz tanımlayıcısı. | Yes | |
| pending_safety_checks | OpenAI.ComputerCallSafetyCheckParam dizisi | Bilgisayar çağrısı için bekleyen güvenlik denetimleri. | Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Bilgisayar çağrısının türü. Her zaman computer_call.Olası değerler: computer_call |
Yes | computer_call |
OpenAI.OutputItemComputerToolCallOutput
Bilgisayar aracı çağrısı çıkışı
Bir bilgisayar aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| acknowledged_safety_checks | OpenAI.ComputerCallSafetyCheckParam dizisi | API tarafından bildirilen ve kabul edilen güvenlik kontrolleri geliştirici. |
Hayır | |
| call_id | Dize | Çıktı üreten bilgisayar aracı çağrısının kimliği. | Yes | |
| kimlik | dize (salt okunur) | Bilgisayar aracı çağrısı çıkış kimliği. | Yes | |
| output | OpenAI.ComputerScreenshotImage | Bilgisayar kullanım aracıyla kullanılan bir bilgisayar ekran görüntüsü. | Yes | |
| durum | enum | İleti girişinin durumu.
in_progress, completed, veya bunlardan biriincomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | Bilgisayar araçlarının çağrı çıktısının türü. Her zaman computer_call_output.Olası değerler: computer_call_output |
Yes | computer_call_output |
OpenAI.OutputItemCustomToolCallOutputResource
ResponseCustomToolCallOutputItem
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Çağrı kimliği, bu özel araç çağrısı çıktısını özel bir araç çağrısına eşlemek için kullanılır. | Yes | |
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| kimlik | Dize | OpenAI platformunda çıkan özel araç çağrısının benzersiz kimliği. | Hayır | |
| output | OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi | Kodunuz tarafından oluşturulan özel araç çağrısından çıkan çıktı. Bir dize veya çıkış içeriği listesi olabilir. |
Yes | |
| durum | OpenAI.FunctionCallOutputStatusEnum | Yes | ||
| type | enum | Özel araç çağrısı çıkışının türü. Her zaman custom_tool_call_output.Olası değerler: custom_tool_call_output |
Yes |
OpenAI.OutputItemCustomToolCallResource
ResponseCustomToolCallItem
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Bu özel araç çağrısını bir araç çağrısı çıktısına eşlemek için kullanılan bir tanımlayıcı. | Yes | |
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| kimlik | Dize | OpenAI platformundaki özel araç çağrısının benzersiz kimliği. | Hayır | |
| input | Dize | Model tarafından oluşturulan özel araç çağrısı için girdi. | Yes | |
| name | Dize | Çağrılan özel aracın adı. | Yes | |
| namespace | Dize | Çağrılan özel aracın isim alanı. | Hayır | |
| durum | OpenAI.FunctionCallStatus | Yes | ||
| type | enum | Özel araç çağrısının türü. Her zaman custom_tool_call.Olası değerler: custom_tool_call |
Yes |
OpenAI.OutputItemFileSearchToolCall
Dosya arama aracı çağrısı
Dosya arama aracı çağrısının sonuçları.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Dosya arama aracı çağrısının benzersiz kimliği. | Yes | |
| queries | dize dizisi | Dosyaları aramak için kullanılan sorgular. | Yes | |
| results | OpenAI.FileSearchToolCallResults veya null dizisi | Hayır | ||
| durum | enum | Dosya arama aracı çağrısının durumu. Bunlardan biri in_progresssearching, incomplete veya failed,Olası değerler: in_progress, searching, completed, incomplete, failed |
Yes | |
| type | enum | Dosya arama aracı çağrısının türü. Her zaman file_search_call.Olası değerler: file_search_call |
Yes |
OpenAI.OutputItemFunctionShellCall
Shell araç çağrısı
Yönetilen bir ortamda bir veya daha fazla kabuk komutu yürüten bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.FunctionShellAction | Bir kabuk komutu yürütür. | Yes | |
| └─ komutları | dize dizisi | Yes | ||
| └─ max_output_length | tamsayı veya null | Yes | ||
| └─ timeout_ms | tamsayı veya null | Yes | ||
| call_id | Dize | Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Bu araç çağrısını oluşturan varlığın kimliği. | Hayır | |
| environment | OpenAI.FunctionShellCallEnvironment veya null | Yes | ||
| kimlik | Dize | Kabuk aracı çağrısının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| durum | OpenAI.FunctionShellCallStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman shell_call.Olası değerler: shell_call |
Yes | shell_call |
OpenAI.OutputItemFunctionShellCallOutput
Shell çağrı çıkışı
Yayılan bir kabuk aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan shell araç çağrısının benzersiz kimliği. | Yes | |
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| kimlik | Dize | Kabuk çağrısı çıkışının benzersiz kimliği. Bu öğe, API aracılığıyla iade edildiğinde doldurulur. | Yes | |
| max_output_length | tamsayı veya null | Yes | ||
| output | OpenAI.FunctionShellCallOutputContent dizisi | Kabuk çağrısı çıkış içeriği dizisi | Yes | |
| durum | OpenAI.FunctionShellCallOutputStatusEnum | Yes | ||
| type | enum | Kabuk çağrısı çıkışının türü. Her zaman shell_call_output.Olası değerler: shell_call_output |
Yes | shell_call_output |
OpenAI.OutputItemFunctionToolCall
Fonksiyon araç çağrısı
Bir fonksiyonu çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | İşleve geçirecek bağımsız değişkenlerin JSON dizesi. | Yes | |
| call_id | Dize | Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | dize (salt okunur) | İşlev aracı çağrısının benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılacak işlevin adı. | Yes | |
| namespace | Dize | Çalıştırılacak fonksiyonun isim alanı. | Hayır | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | İşlev aracı çağrısının türü. Her zaman function_call.Olası değerler: function_call |
Yes |
OpenAI.OutputItemFunctionToolCallOutput
Fonksiyon aracı çağrı çıktısı
İşlev aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | Dize | Model tarafından oluşturulan işlev aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | dize (salt okunur) | İşlev aracının çağrı çıkışının benzersiz kimliği. Bu öğe doldurulduğunda API aracılığıyla döndürülür. |
Yes | |
| output | OpenAI.FunctionAndCustomToolCallOutput dizesi veya dizisi | Kodunuz tarafından oluşturulan işlev çağrısının çıktısı. Bir dize veya çıkış içeriği listesi olabilir. |
Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| type | enum | İşlev aracının çağrı çıktısının türü. Her zaman function_call_output.Olası değerler: function_call_output |
Yes |
OpenAI.OutputItemImageGenToolCall
Görüntü oluşturma çağrısı
Model tarafından yapılan bir görüntü oluşturma isteği.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Görüntü oluşturma çağrısının benzersiz kimliği. | Yes | |
| result | dize veya null | Yes | ||
| durum | enum | Görüntü oluşturma çağrısının durumu. Olası değerler: in_progress, completed, generating, failed |
Yes | |
| type | enum | Görüntü oluşturma çağrısının türü. Her zaman image_generation_call.Olası değerler: image_generation_call |
Yes |
OpenAI.OutputItemLocalShellToolCall
Yerel shell çağrısı
Yerel kabukta komut çalıştırmak için bir araç çağrısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.LocalShellExecAction | Sunucuda bir shell komutu çalıştırın. | Yes | |
| call_id | Dize | Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği. | Yes | |
| kimlik | Dize | Yerel shell çağrısının benzersiz kimliği. | Yes | |
| durum | enum | Yerel shell çağrısının durumu. Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Yerel shell call'ın türü. Her zaman local_shell_call.Olası değerler: local_shell_call |
Yes |
OpenAI.OutputItemLocalShellToolCallOutput
Yerel kabuk çağrısı çıkışı
Yerel kabuk aracı çağrısının çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Model tarafından oluşturulan yerel kabuk aracı çağrısının benzersiz kimliği. | Yes | |
| output | Dize | Yerel shell aracı çağrısının çıktısının JSON dizesi. | Yes | |
| durum | dize veya null | Hayır | ||
| type | enum | Yerel kabuk aracı çağrı çıkışının türü. Her zaman local_shell_call_output.Olası değerler: local_shell_call_output |
Yes |
OpenAI.OutputItemMcpApprovalRequest
MCP onay talebi
Bir araç çağrısı işlemi için insan onayı isteği.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | Araç için bir JSON bağımsız değişken dizesi. | Yes | |
| kimlik | Dize | Onay talebinin benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılacak aracın adı. | Yes | |
| sunucu etiketi | Dize | İsteği yapan MCP sunucusunun etiketi. | Yes | |
| type | enum | Öğenin türü. Her zaman mcp_approval_request.Olası değerler: mcp_approval_request |
Yes |
OpenAI.OutputItemMcpApprovalResponseResource
MCP onay yanıtı
MCP onay isteğine yanıt.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| approval_request_id | Dize | Yanıtlanan onay isteğinin ID'si. | Yes | |
| approve | boolean | İsteğin onaylanıp onaylanmadı. | Yes | |
| kimlik | Dize | Onay yanıtının benzersiz kimliği | Yes | |
| neden | dize veya null | Hayır | ||
| type | enum | Öğenin türü. Her zaman mcp_approval_response.Olası değerler: mcp_approval_response |
Yes |
OpenAI.OutputItemMcpListTools
MCP liste araçları
MCP sunucusunda kullanılabilen araçların listesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| hata | OpenAI.RealtimeMCPError | Hayır | ||
| kimlik | Dize | Listenin benzersiz kimliği. | Yes | |
| sunucu etiketi | Dize | MCP sunucusunun etiketi. | Yes | |
| tools | OpenAI.MCPListToolsTool dizisi | Sunucuda bulunan araçlar. | Yes | |
| type | enum | Öğenin türü. Her zaman mcp_list_tools.Olası değerler: mcp_list_tools |
Yes |
OpenAI.OutputItemMcpToolCall
MCP araç çağrısı
MCP sunucusundaki bir aracın çağrılması.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| approval_request_id | dize veya null | Hayır | ||
| arguments | Dize | Araca geçirilen bağımsız değişkenlerin JSON dizesi. | Yes | |
| hata | OpenAI.RealtimeMCPError | Hayır | ||
| kimlik | Dize | Araç çağrısının benzersiz kimliği. | Yes | |
| name | Dize | Çalıştırılan aracın adı. | Yes | |
| output | dize veya null | Hayır | ||
| sunucu etiketi | Dize | Aracı çalıştıran MCP sunucusunun etiketi. | Yes | |
| durum | OpenAI.MCPToolCallStatus | Hayır | ||
| type | enum | Öğenin türü. Her zaman mcp_call.Olası değerler: mcp_call |
Yes |
OpenAI.OutputItemOutputMessage
Çıkış mesajı
Modelden bir çıkış iletisi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | OpenAI.OutputMessageContent dizisi | Çıkış iletisinin içeriği. | Yes | |
| kimlik | Dize | Çıkış iletisinin benzersiz kimliği. | Yes | |
| phase | OpenAI.MessagePhase veya null | Hayır | ||
| role | enum | Çıkış iletisinin rolü. Her zaman assistant.Olası değerler: assistant |
Yes | |
| durum | enum | İleti girişinin durumu.
in_progress, completed, veya bunlardan biriincomplete. API aracılığıyla giriş öğeleri döndürüldüğünde doldurulur.Olası değerler: in_progress, completed, incomplete |
Yes | |
| type | enum | Çıkış iletisinin türü. Her zaman message.Olası değerler: output_message |
Yes |
OpenAI.OutputItemReasoningItem
Reasoning
Bir yanıt oluştururken bir akıl yürütme modeli tarafından kullanılan düşünce zincirinin açıklaması. Bağlamı el ile yönetiyorsanız, bu öğeleri konuşmanın sonraki dönüşleri için Yanıtlar API'nize input eklediğinizden emin olun.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| içerik | OpenAI.ReasoningTextContent dizisi | Metin içeriğini akıl yürütme. | Hayır | |
| encrypted_content | dize veya null | Hayır | ||
| kimlik | Dize | Akıl yürütme içeriğinin benzersiz tanımlayıcısı. | Yes | |
| durum | enum | Öğenin durumu.
in_progress, completed, veya bunlardan biriincomplete. Öğeler API aracılığıyla döndürülürken doldurulur.Olası değerler: in_progress, completed, incomplete |
Hayır | |
| summary | OpenAI dizisi.ÖzetMetinİçkisi | Akıl yürütme özeti içeriği. | Yes | |
| type | enum | Nesnenin türü. Her zaman reasoning.Olası değerler: reasoning |
Yes |
OpenAI.OutputItemToolSearchCall
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Araç arama çağrısı için kullanılan argümanlar. | Yes | ||
| call_id | dize veya null | Yes | ||
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| idam | OpenAI.ToolSearchExecutionType | Yes | ||
| kimlik | Dize | Arama aracı çağrı öğesinin benzersiz kimliği. | Yes | |
| durum | OpenAI.FunctionCallStatus | Yes | ||
| type | enum | Öğenin türü. Her zaman tool_search_call.Olası değerler: tool_search_call |
Yes | tool_search_call |
OpenAI.OutputItemToolSearchOutput
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| call_id | dize veya null | Yes | ||
| Oluşturan | Dize | Öğeyi oluşturan aktörün tanımlayıcısı. | Hayır | |
| idam | OpenAI.ToolSearchExecutionType | Yes | ||
| kimlik | Dize | Araç arama çıktı öğesinin benzersiz kimliği. | Yes | |
| durum | OpenAI.FunctionCallOutputStatusEnum | Yes | ||
| tools | OpenAI.Tool dizisi | Yüklenmiş araç tanımları araç aramasıyla döner. | Yes | |
| type | enum | Öğenin türü. Her zaman tool_search_output.Olası değerler: tool_search_output |
Yes | tool_search_output |
OpenAI.OutputItemType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | output_messagefile_search_callfunction_callfunction_call_outputweb_search_callcomputer_callcomputer_call_outputreasoningtool_search_calltool_search_outputcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_callmcp_list_toolsmcp_approval_requestmcp_approval_responsecustom_tool_callcustom_tool_call_outputtool_approval_request |
OpenAI.OutputItemWebSearchToolCall
Web arama aracı çağrısı
Bir web arama aracı çağrısının sonuçları.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| action | OpenAI.WebSearchActionSearch veya OpenAI.WebSearchActionOpenPage veya OpenAI.WebSearchActionFind | Bu web arama çağrısında gerçekleştirilen belirli eylemi açıklayan bir nesne. Modelin web'i nasıl kullandığına dair detaylar içerir (arama, open_page, find_in_page). |
Yes | |
| kimlik | Dize | Web arama aracının benzersiz kimliği çağrı. | Yes | |
| durum | enum | Web arama aracı çağrısının durumu. Olası değerler: in_progress, searching, completed, failed |
Yes | |
| type | enum | Web arama aracının türü. Her zaman web_search_call.Olası değerler: web_search_call |
Yes |
OpenAI.OutputMessageContent
OpenAI.OutputMessageContent için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
output_text |
OpenAI.OutputMessageContentOutputTextContent |
refusal |
OpenAI.OutputMessageContentRefusalContent |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.OutputMessageContentType | Yes |
OpenAI.OutputMessageContentOutputTextContent
Çıktı metni
Modelden bir metin çıktısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| annotations | OpenAI.Annotation dizisi | Metin çıkışının ek açıklamaları. | Yes | |
| logprobs | OpenAI.LogProb dizisi | Yes | ||
| text | Dize | Modelden metin çıkışı. | Yes | |
| type | enum | Çıkış metninin türü. Her zaman output_text.Olası değerler: output_text |
Yes | output_text |
OpenAI.OutputMessageContentRefusalContent
Refusal
Model tarafından reddedilme.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Ret | Dize | Modelin sunduğu reddetme gerekçesi. | Yes | |
| type | enum | Reddetmenin türü. Her zaman refusal.Olası değerler: refusal |
Yes | Ret |
OpenAI.OutputMessageContentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | output_textrefusal |
OpenAI.Prompt
Bir komut şablonuna ve değişkenlerine referans.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| kimlik | Dize | Kullanılacak istem şablonunun benzersiz tanımlayıcısı. | Yes | |
| değişkenler | OpenAI.ResponsePromptVariables veya null | Hayır | ||
| version | dize veya null | Hayır |
OpenAI.RankerVersionType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | autodefault-2024-11-15 |
OpenAI.RankingOptions
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| hybrid_search | OpenAI.HybridSearchOptions | Hayır | ||
| └─ embedding_weight | number | Karşılıklı sıralama füzyonundaki gömülen ağırlığı. | Yes | |
| └─ text_weight | number | Karşılıklı sıralama birleşimindeki metnin ağırlığı. | Yes | |
| sıralayıcı | OpenAI.RankerVersionType | Hayır | ||
| puan_eşik_değeri | number | Dosya araması için puan eşiği, 0 ile 1 arasında bir sayı. 1'e yakın sayılar yalnızca en uygun sonuçları döndürmeye çalışır, ancak daha az sonuç döndürebilir. | Hayır |
OpenAI.RealtimeMCPError
OpenAI için Ayrımcı.RealtimeMCPError
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
protocol_error |
OpenAI.RealtimeMCPProtocolError |
tool_execution_error |
OpenAI.RealtimeMCPToolExecutionError |
http_error |
OpenAI.RealtimeMCPHTTPErrror |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.RealtimeMcpErrorType | Yes |
OpenAI.RealtimeMCPHTTPErrror
Gerçek zamanlı MCP HTTP hatası
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | integer | Yes | ||
| message | Dize | Yes | ||
| type | enum | Olası değerler: http_error |
Yes |
OpenAI.RealtimeMCPProtocolError
Gerçek zamanlı MCP protokol hatası
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | integer | Yes | ||
| message | Dize | Yes | ||
| type | enum | Olası değerler: protocol_error |
Yes |
OpenAI.RealtimeMCPToolExecutionError
Gerçek zamanlı MCP araç çalıştırma hatası
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| message | Dize | Yes | ||
| type | enum | Olası değerler: tool_execution_error |
Yes |
OpenAI.RealtimeMcpErrorType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | protocol_errortool_execution_errorhttp_error |
OpenAI.Reasoning
Reasoning
Sadece GPT-5 ve O-serisi modelleri Akıl yürütme modelleri için yapılandırma seçenekleri.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| effort | OpenAI.ReasoningEffort | Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltmamuhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir.- Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone.- Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ).- xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir. |
Hayır | |
| generate_summary | dize veya null | Hayır | ||
| summary | dize veya null | Hayır |
OpenAI.ReasoningEffort
Mantıp modelleri için mantık yürütme çabasını kısıtlar.
Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Muhakeme çabasının azaltılması, yanıtta daha hızlı yanıtlar ve daha az belirteç kullanılmasına neden olabilir.
-
gpt-5.1varsayılan olaraknone, bu da akıl yürütme yapmaz. Desteklenen gerekçe değerlerigpt-5.1none,low,medium, vehigh'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir. - Önceki
gpt-5.1tüm modeller varsayılan olarakmediumakıl yürütme çabasına geçer venonedesteklemez. - Model
gpt-5-provarsayılan olarak (ve sadece destekliyor)highakıl yürütme çabasını kullanır. -
xhighsonrası tüm modellergpt-5.1-codex-maxiçin desteklenir.
| Property | Değer |
|---|---|
| Tanım | Akıl yürütmeye yönelik çabayı kısıtlar mantık modelleri. Şu anda desteklenen değerler none, minimal, low, medium, high, ve xhigh'dir. Azaltmamuhakeme çabası daha hızlı yanıtlara ve daha az belirteç kullanılmasına neden olabilir bir yanıtta mantık yürütme. - gpt-5.1 varsayılan olarak noneöğesini kullanır ve mantık yürütmez. Desteklenen gerekçe değerleri gpt-5.1none, low, medium, ve high'dir. Araç çağrıları gpt-5.1'deki tüm akıl yürütme değerleri için desteklenir.- Tüm modeller varsayılan olarak akıl yürütme eforu olmadan gpt-5.1 önce medium ve desteklemeznone.- Model gpt-5-pro varsayılan olarak akıl yürütme eforunu kullanır (ve yalnızca destekler high ).- xhigh , sonrasındaki gpt-5.1-codex-maxtüm modeller için desteklenir. |
| Türü | Dize |
| Değerler | noneminimallowmediumhighxhigh |
OpenAI.ReasoningTextContent
Gerekçe metni
Modelden mantık metni.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modelden gelen mantık metni. | Yes | |
| type | enum | Akıl yürütme metninin türü. Her zaman reasoning_text.Olası değerler: reasoning_text |
Yes | reasoning_text |
OpenAI.Response
Yanıt nesnesi
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arka plan | boole veya null | Hayır | ||
| tamamlanma_tarihi | dize veya null | Hayır | ||
| content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| hata | OpenAI.ResponseError veya null | Yes | ||
| kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| incomplete_details | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| instructions | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| max_output_tokens | tamsayı veya null | Hayır | ||
| max_tool_calls | tamsayı veya null | Hayır | ||
| metadata | OpenAI.Metadata veya null | Hayır | ||
| model | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| Obje | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| output | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| output_text | dize veya null | Hayır | ||
| paralel araç çağrıları | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| previous_response_id | dize veya null | Hayır | ||
| prompt | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| prompt_cache_retention | dize veya null | Hayır | ||
| reasoning | OpenAI.Reasoning veya null | Hayır | ||
| safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| durum | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| sıcaklık | sayı veya null | Hayır | ||
| text | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| tool_choice | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| tools | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| top_logprobs | tamsayı veya null | Hayır | ||
| top_p | sayı veya null | Hayır | ||
| truncation | dize veya null | Hayır | ||
| usage | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| user | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır |
OpenAI.ResponseAudioDeltaEvent
Kısmi bir ses yanıtı olduğunda yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| delta | Dize | Base64 kodlanmış yanıt ses baytlarının bir öbeği. Kısıtlamalar: kodlama: base64 |
Yes | |
| sequence_number | integer | Akış yanıtının bu öbek için bir sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.audio.delta.Olası değerler: response.audio.delta |
Yes |
OpenAI.ResponseAudioDoneEvent
Ses yanıtı tamamlandığında gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| sequence_number | integer | Delta'nın dizi numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.audio.done.Olası değerler: response.audio.done |
Yes |
OpenAI.ResponseAudioTranscriptDeltaEvent
Sesin kısmi bir transkripti olduğunda yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| delta | Dize | Ses yanıtının kısmi transkripti. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.audio.transcript.delta.Olası değerler: response.audio.transcript.delta |
Yes |
OpenAI.ResponseAudioTranscriptDoneEvent
Tam ses transkripti tamamlandığında gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.audio.transcript.done.Olası değerler: response.audio.transcript.done |
Yes |
OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
Kısmi kod parçacığı, kod yorumlayıcı tarafından aktarıldığında yayımlanır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| delta | Dize | Kod yorumlayıcısı tarafından aktarılan kısmi kod parçacığı. | Yes | |
| item_id | Dize | Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Kodun akışa alındığı yanıttaki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.code_interpreter_call_code.delta.Olası değerler: response.code_interpreter_call_code.delta |
Yes |
OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
Kod parçacığı kod yorumlayıcı tarafından sonlandırıldığında tetiklenir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | Dize | Kod yorumlayıcısı tarafından son kod parçacığı çıkışı. | Yes | |
| item_id | Dize | Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Kodun sonlandırıldığı yanıttaki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.code_interpreter_call_code.done.Olası değerler: response.code_interpreter_call_code.done |
Yes |
OpenAI.ResponseCodeInterpreterCallCompletedEvent
Kod yorumlayıcı çağrısı tamamlandığında gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Kod yorumlayıcı çağrısının tamamlandığı yanıttaki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.code_interpreter_call.completed.Olası değerler: response.code_interpreter_call.completed |
Yes |
OpenAI.ResponseCodeInterpreterCallInProgressEvent
Bir kod yorumlayıcı çağrısı sırasında tetiklenir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Kod yorumlayıcı çağrısının devam ettiği yanıttaki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.code_interpreter_call.in_progress.Olası değerler: response.code_interpreter_call.in_progress |
Yes |
OpenAI.ResponseCodeInterpreterCallInterpretingEvent
Kod yorumlayıcısı kod parçacığını etkin bir şekilde yorumladığında yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Kod yorumlayıcı aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Kod yorumlayıcının kodu yorumladığı yanıttaki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Akış olaylarını sıralamak için kullanılan bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.code_interpreter_call.interpreting.Olası değerler: response.code_interpreter_call.interpreting |
Yes |
OpenAI.ResponseCompletedEvent
Model yanıtı tamamlandığında gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ arka plan | boole veya null | Hayır | ||
| └─ completed_at | string veya null (unixTimestamp) | Hayır | ||
| └─ content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| └─ konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| └─ oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| └─ hata | OpenAI.ResponseError veya null | Yes | ||
| └─ kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| └─ eksik_bilgiler | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| └─ yönerge | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| └─ maksimum_çıkış_jetonları | tamsayı veya null | Hayır | ||
| └─ maksimum araç çağrıları | tamsayı veya null | Hayır | ||
| └─ meta veriler | OpenAI.Metadata veya null | Hayır | ||
| └─ modeli | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| └─ nesne | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| └─ çıkış | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| └─ çıktı_metin | dize veya null | Hayır | ||
| └─ paralel_arac_cagrilari | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| └─ önceki_cevap_id | dize veya null | Hayır | ||
| └─ istemi | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| └─ prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| └─ prompt_cache_retention | dize veya null | Hayır | ||
| └─ akıl yürütme | OpenAI.Reasoning veya null | Hayır | ||
| └─ safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| └─ durumu | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| └─ sıcaklık | sayı veya null | Hayır | 1 | |
| └─ metin | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| └─ araç seçimi | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| └─ araçları | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| └─ top_logprobs | tamsayı veya null | Hayır | ||
| └─ top_p | sayı veya null | Hayır | 1 | |
| └─ kısaltma | dize veya null | Hayır | engelli | |
| └─ kullanımı | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| └─ kullanıcı | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.completed.Olası değerler: response.completed |
Yes |
OpenAI.ResponseContentPartAddedEvent
Yeni bir içerik bölümü eklendiğinde gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Eklenen içerik bölümünün dizini. | Yes | |
| item_id | Dize | İçerik bölümünün eklendiği çıkış öğesinin kimliği. | Yes | |
| output_index | integer | İçerik bölümünün eklendiği çıkış öğesinin dizini. | Yes | |
| parça | OpenAI.OutputContent | Yes | ||
| └─ türü | OpenAI.OutputContentType | Yes | ||
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.content_part.added.Olası değerler: response.content_part.added |
Yes |
OpenAI.ResponseContentPartDoneEvent
İçerik bölümü tamamlandığında gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Tamamlanan içerik bölümünün dizini. | Yes | |
| item_id | Dize | İçerik bölümünün eklendiği çıkış öğesinin kimliği. | Yes | |
| output_index | integer | İçerik bölümünün eklendiği çıkış öğesinin dizini. | Yes | |
| parça | OpenAI.OutputContent | Yes | ||
| └─ türü | OpenAI.OutputContentType | Yes | ||
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.content_part.done.Olası değerler: response.content_part.done |
Yes |
OpenAI.ResponseCreatedEvent
Bir yanıt oluşturulduğunda yayılan bir olay.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ arka plan | boole veya null | Hayır | ||
| └─ completed_at | string veya null (unixTimestamp) | Hayır | ||
| └─ content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| └─ konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| └─ oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| └─ hata | OpenAI.ResponseError veya null | Yes | ||
| └─ kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| └─ eksik_bilgiler | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| └─ yönerge | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| └─ maksimum_çıkış_jetonları | tamsayı veya null | Hayır | ||
| └─ maksimum araç çağrıları | tamsayı veya null | Hayır | ||
| └─ meta veriler | OpenAI.Metadata veya null | Hayır | ||
| └─ modeli | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| └─ nesne | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| └─ çıkış | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| └─ çıktı_metin | dize veya null | Hayır | ||
| └─ paralel_arac_cagrilari | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| └─ önceki_cevap_id | dize veya null | Hayır | ||
| └─ istemi | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| └─ prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| └─ prompt_cache_retention | dize veya null | Hayır | ||
| └─ akıl yürütme | OpenAI.Reasoning veya null | Hayır | ||
| └─ safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| └─ durumu | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| └─ sıcaklık | sayı veya null | Hayır | 1 | |
| └─ metin | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| └─ araç seçimi | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| └─ araçları | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| └─ top_logprobs | tamsayı veya null | Hayır | ||
| └─ top_p | sayı veya null | Hayır | 1 | |
| └─ kısaltma | dize veya null | Hayır | engelli | |
| └─ kullanımı | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| └─ kullanıcı | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.created.Olası değerler: response.created |
Yes |
OpenAI.ResponseCustomToolCallInputDeltaEvent
ResponseCustomToolCallInputDelta
Özel bir araç çağrısının girişine delta (kısmi güncelleştirme) temsil eden olay.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| delta | Dize | Özel araç çağrısı için artımlı giriş verileri (delta). | Yes | |
| item_id | Dize | Bu olayla ilişkili API öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Bu deltanın uygulandığı çıkışın dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olay türü tanımlayıcısı. Olası değerler: response.custom_tool_call_input.delta |
Yes |
OpenAI.ResponseCustomToolCallInputDoneEvent
ResponseCustomToolCallInputDone
Özel bir araç çağrısı için girişin tamamlandığını belirten olay.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| input | Dize | Özel araç çağrısı için tam giriş verileri. | Yes | |
| item_id | Dize | Bu olayla ilişkili API öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Bu olayın uygulandığı çıktı indeksi. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olay türü tanımlayıcısı. Olası değerler: response.custom_tool_call_input.done |
Yes |
OpenAI.ResponseError
Model yanıt oluşturamadığında döndürülen bir hata nesnesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | OpenAI.ResponseErrorCode | Yanıtın hata kodu. | Yes | |
| message | Dize | Hatanın insan tarafından okunabilen açıklaması. | Yes |
OpenAI.ResponseErrorCode
Yanıtın hata kodu.
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | server_errorrate_limit_exceededinvalid_promptvector_store_timeoutinvalid_imageinvalid_image_formatinvalid_base64_imageinvalid_image_urlimage_too_largeimage_too_smallimage_parse_errorimage_content_policy_violationinvalid_image_modeimage_file_too_largeunsupported_image_media_typeempty_image_filefailed_to_download_imageimage_file_not_found |
OpenAI.ResponseErrorEvent
Bir hata oluştuğunda yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| code | dize veya null | Yes | ||
| message | Dize | Hata iletisi. | Yes | |
| param | dize veya null | Yes | ||
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman error.Olası değerler: error |
Yes |
OpenAI.ResponseFailedEvent
Yanıt başarısız olduğunda yayılan bir olay.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ arka plan | boole veya null | Hayır | ||
| └─ completed_at | string veya null (unixTimestamp) | Hayır | ||
| └─ content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| └─ konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| └─ oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| └─ hata | OpenAI.ResponseError veya null | Yes | ||
| └─ kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| └─ eksik_bilgiler | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| └─ yönerge | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| └─ maksimum_çıkış_jetonları | tamsayı veya null | Hayır | ||
| └─ maksimum araç çağrıları | tamsayı veya null | Hayır | ||
| └─ meta veriler | OpenAI.Metadata veya null | Hayır | ||
| └─ modeli | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| └─ nesne | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| └─ çıkış | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| └─ çıktı_metin | dize veya null | Hayır | ||
| └─ paralel_arac_cagrilari | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| └─ önceki_cevap_id | dize veya null | Hayır | ||
| └─ istemi | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| └─ prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| └─ prompt_cache_retention | dize veya null | Hayır | ||
| └─ akıl yürütme | OpenAI.Reasoning veya null | Hayır | ||
| └─ safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| └─ durumu | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| └─ sıcaklık | sayı veya null | Hayır | 1 | |
| └─ metin | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| └─ araç seçimi | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| └─ araçları | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| └─ top_logprobs | tamsayı veya null | Hayır | ||
| └─ top_p | sayı veya null | Hayır | 1 | |
| └─ kısaltma | dize veya null | Hayır | engelli | |
| └─ kullanımı | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| └─ kullanıcı | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.failed.Olası değerler: response.failed |
Yes |
OpenAI.ResponseFileSearchCallCompletedEvent
Bir dosya arama çağrısı tamamlandığında (sonuçlar bulundu) yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği. | Yes | |
| output_index | integer | Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.file_search_call.completed.Olası değerler: response.file_search_call.completed |
Yes |
OpenAI.ResponseFileSearchCallInProgressEvent
Bir dosya arama çağrısı başlatıldığında gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği. | Yes | |
| output_index | integer | Dosya arama çağrısının başlatıldığı çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.file_search_call.in_progress.Olası değerler: response.file_search_call.in_progress |
Yes |
OpenAI.ResponseFileSearchCallSearchingEvent
Bir dosya araması sırasında arama yapıldığında tetiklenir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Dosya arama çağrısının başlatıldığı çıkış öğesinin kimliği. | Yes | |
| output_index | integer | Dosya arama çağrısının arama yaptığı çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.file_search_call.searching.Olası değerler: response.file_search_call.searching |
Yes |
OpenAI.YanıtFormatıJsonŞemaŞeması
JSON şeması
JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin.
Tür: nesne
OpenAI.ResponseFunctionCallArgumentsDeltaEvent
Kısmi işlev çağrısı bağımsız değişkenleri delta olduğunda yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| delta | Dize | Fonksiyon çağrısı argümanlarına eklenen delta. | Yes | |
| item_id | Dize | delta işlev çağrısı bağımsız değişkenlerinin eklendiği çıkış öğesinin kimliği. | Yes | |
| output_index | integer | İşlev çağrısı bağımsız değişkenlerinin delta'sının toplandığı çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.function_call_arguments.delta.Olası değerler: response.function_call_arguments.delta |
Yes |
OpenAI.ResponseFunctionCallArgumentsDoneEvent
İşlev çağrısı bağımsız değişkenleri sonlandırıldığında verilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | İşlev çağrısı için argümanlar. | Yes | |
| item_id | Dize | Öğenin kimliği. | Yes | |
| name | Dize | Çağrılan etkinliğin adı. | Yes | |
| output_index | integer | Çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olası değerler: response.function_call_arguments.done |
Yes |
OpenAI.ResponseImageGenCallCompletedEvent
ResponseImageGenCallTamamlandıEtkinlik
Görüntü oluşturma aracı çağrısı tamamlandığında ve son görüntü kullanılabilir olduğunda yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.image_generation_call.completed' şeklinde. Olası değerler: response.image_generation_call.completed |
Yes |
OpenAI.ResponseImageGenCallGeneratingEvent
YanıtGörüntüGenCallOluşturmaOlay
Görüntü oluşturma aracı çağrısı (ara durum) etkin bir şekilde görüntü oluştururken tetiklenir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | İşlenmekte olan görüntü oluşturma öğesinin sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.image_generation_call.generating'. Olası değerler: response.image_generation_call.generating |
Yes |
OpenAI.ResponseImageGenCallInProgressEvent
ResponseImageGenCallInProgressEvent
Görüntü oluşturma aracı çağrısı devam ederken bir bildirim gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | İşlenmekte olan görüntü oluşturma öğesinin sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.image_generation_call.in_progress'. Olası değerler: response.image_generation_call.in_progress |
Yes |
OpenAI.ResponseImageGenCallPartialImageEvent
YanıtGörüntüGenÇağrıKısmiGörüntüOlay
Görüntü oluşturma akışı sırasında kısmi bir görüntü kullanılabilir olduğunda emit edilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | İşlenmekte olan görüntü oluşturma öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| partial_image_b64 | Dize | Base64 ile kodlanmış kısmi görüntü verileri, görüntü olarak işleme için uygundur. | Yes | |
| partial_image_index | integer | Kısmi görüntü için 0 tabanlı dizin (arka uç 1 tabanlıdır, ancak bu kullanıcı için 0 tabanlıdır). | Yes | |
| sequence_number | integer | İşlenmekte olan görüntü oluşturma öğesinin sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.image_generation_call.partial_image'. Olası değerler: response.image_generation_call.partial_image |
Yes |
OpenAI.ResponseInProgressEvent
Yanıt devam ederken gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ arka plan | boole veya null | Hayır | ||
| └─ completed_at | string veya null (unixTimestamp) | Hayır | ||
| └─ content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| └─ konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| └─ oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| └─ hata | OpenAI.ResponseError veya null | Yes | ||
| └─ kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| └─ eksik_bilgiler | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| └─ yönerge | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| └─ maksimum_çıkış_jetonları | tamsayı veya null | Hayır | ||
| └─ maksimum araç çağrıları | tamsayı veya null | Hayır | ||
| └─ meta veriler | OpenAI.Metadata veya null | Hayır | ||
| └─ modeli | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| └─ nesne | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| └─ çıkış | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| └─ çıktı_metin | dize veya null | Hayır | ||
| └─ paralel_arac_cagrilari | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| └─ önceki_cevap_id | dize veya null | Hayır | ||
| └─ istemi | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| └─ prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| └─ prompt_cache_retention | dize veya null | Hayır | ||
| └─ akıl yürütme | OpenAI.Reasoning veya null | Hayır | ||
| └─ safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| └─ durumu | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| └─ sıcaklık | sayı veya null | Hayır | 1 | |
| └─ metin | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| └─ araç seçimi | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| └─ araçları | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| └─ top_logprobs | tamsayı veya null | Hayır | ||
| └─ top_p | sayı veya null | Hayır | 1 | |
| └─ kısaltma | dize veya null | Hayır | engelli | |
| └─ kullanımı | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| └─ kullanıcı | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.in_progress.Olası değerler: response.in_progress |
Yes |
OpenAI.ResponseIncompleteDetails
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| neden | enum | Olası değerler: max_output_tokens, content_filter |
Hayır |
OpenAI.ResponseIncompleteEvent
Yanıt eksik olduğunda yayılan bir olay.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ arka plan | boole veya null | Hayır | ||
| └─ completed_at | string veya null (unixTimestamp) | Hayır | ||
| └─ content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| └─ konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| └─ oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| └─ hata | OpenAI.ResponseError veya null | Yes | ||
| └─ kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| └─ eksik_bilgiler | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| └─ yönerge | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| └─ maksimum_çıkış_jetonları | tamsayı veya null | Hayır | ||
| └─ maksimum araç çağrıları | tamsayı veya null | Hayır | ||
| └─ meta veriler | OpenAI.Metadata veya null | Hayır | ||
| └─ modeli | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| └─ nesne | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| └─ çıkış | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| └─ çıktı_metin | dize veya null | Hayır | ||
| └─ paralel_arac_cagrilari | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| └─ önceki_cevap_id | dize veya null | Hayır | ||
| └─ istemi | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| └─ prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| └─ prompt_cache_retention | dize veya null | Hayır | ||
| └─ akıl yürütme | OpenAI.Reasoning veya null | Hayır | ||
| └─ safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| └─ durumu | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| └─ sıcaklık | sayı veya null | Hayır | 1 | |
| └─ metin | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| └─ araç seçimi | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| └─ araçları | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| └─ top_logprobs | tamsayı veya null | Hayır | ||
| └─ top_p | sayı veya null | Hayır | 1 | |
| └─ kısaltma | dize veya null | Hayır | engelli | |
| └─ kullanımı | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| └─ kullanıcı | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.incomplete.Olası değerler: response.incomplete |
Yes |
OpenAI.ResponseItemList
Yanıt öğelerinin listesi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| data | OpenAI.ItemResource dizisi | Bu yanıtı oluşturmak için kullanılan öğelerin listesi. | Yes | |
| ilk_kimlik | Dize | Listedeki ilk öğenin kimliği. | Yes | |
| daha_fazla | boolean | Kullanılabilir daha fazla öğe olup olmadığı. | Yes | |
| son_kimlik | Dize | Listedeki son öğenin kimliği. | Yes | |
| Obje | enum | Döndürülen nesnenin türü olmalıdır list.Olası değerler: list |
Yes |
OpenAI.ResponseLogProb
Logprob, modelin dizideki belirli bir konumda belirli bir belirteci üretmeye atayan logaritmik olasılıktır. Daha az negatif (daha yüksek) logprob değerleri, bu belirteç seçiminde model güvenilirliğinin daha yüksek olduğunu gösterir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| logprob | number | Bu belirtecin günlük olasılığı. | Yes | |
| token | Dize | Olası bir metin belirteci. | Yes | |
| top_logprobs | OpenAI.ResponseLogProbTopLogprobs dizisi | En olası 20 token'ın günlük olasılıkları. | Hayır |
OpenAI.ResponseLogProbTopLogprobs
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| logprob | number | Hayır | ||
| token | Dize | Hayır |
OpenAI.ResponseMCPCallArgumentsDeltaEvent
ResponseMCPCallArgumentsDeltaEvent
MCP araç çağrısının bağımsız değişkenlerinde delta (kısmi güncelleştirme) olduğunda gerçekleşir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| delta | Dize | MCP araç çağrısı için bağımsız değişkenlere yönelik kısmi güncelleştirmeyi içeren bir JSON dizesi. | Yes | |
| item_id | Dize | İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.mcp_call_arguments.delta'. Olası değerler: response.mcp_call_arguments.delta |
Yes |
OpenAI.ResponseMCPCallArgumentsDoneEvent
ResponseMCPCallArgumentsDoneEvent
Bir MCP araç çağrısı için bağımsız değişkenler sonlandırıldığında oluşur.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| arguments | Dize | MCP araç çağrısı için son haline getirilmiş bağımsız değişkenleri içeren bir JSON dizesi. | Yes | |
| item_id | Dize | İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.mcp_call_arguments.bitti'. Olası değerler: response.mcp_call_arguments.done |
Yes |
OpenAI.ResponseMCPCallCompletedEvent
YanıtMCPCallTamamlandıEtkinlik
BIR MCP araç çağrısı başarıyla tamamlandığında yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Tamamlanan MCP aracı çağrı öğesinin kimliği. | Yes | |
| output_index | integer | Tamamlanan çıktı öğesinin indeksi. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.mcp_call.completed'. Olası değerler: response.mcp_call.completed |
Yes |
OpenAI.ResponseMCPCallFailedEvent
ResponseMCPCallFailedEvent
Bir MCP aracı çağrısının başarısız olması durumunda yayımlanır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Başarısız olan MCP aracı çağrı öğesinin kimliği. | Yes | |
| output_index | integer | Başarısız olan çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. 'sonuç her zaman 'response.mcp_call.failed' olur. Olası değerler: response.mcp_call.failed |
Yes |
OpenAI.ResponseMCPCallInProgressEvent
YanıtMCPCallInProgressEvent
Bir MCP araç çağrısı devam ederken tetiklenir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | İşlenen MCP aracı çağrı öğesinin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.mcp_call.in_progress'. Olası değerler: response.mcp_call.in_progress |
Yes |
OpenAI.ResponseMCPListToolsCompletedEvent
YanıtMCPListAraçlarTamamlandıEtkinlik
Kullanılabilir MCP araçlarının listesi başarıyla alındığında tetiklenir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Bu çıkışı oluşturan MCP aracı çağrı öğesinin kimliği. | Yes | |
| output_index | integer | İşlenen çıktı öğesinin indeksi. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.mcp_list_tools.completed'. Olası değerler: response.mcp_list_tools.completed |
Yes |
OpenAI.ResponseMCPListToolsFailedEvent
ResponseMCPListToolsFailedEvent
Kullanılabilir MCP araçlarını listeleme girişimi başarısız olduğunda ortaya çıkar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Başarısız olan MCP aracı çağrı öğesinin kimliği. | Yes | |
| output_index | integer | Başarısız olan çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.mcp_list_tools.başarısız'. Olası değerler: response.mcp_list_tools.failed |
Yes |
OpenAI.ResponseMCPListToolsInProgressEvent
YanıtMCPListToolsInProgressEvent
Sistem, kullanılabilir MCP araçlarının listesini alırken tetiklenir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | İşlenmekte olan MCP aracı çağrı öğesinin kimliği. | Yes | |
| output_index | integer | İşlenmekte olan çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.mcp_list_tools.in_progress'. Olası değerler: response.mcp_list_tools.in_progress |
Yes |
OpenAI.ResponseOutputItemAddedEvent
Yeni bir çıkış öğesi eklendiğinde gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| öğe | OpenAI.OutputItem | Yes | ||
| └─ türü | OpenAI.OutputItemType | Yes | ||
| output_index | integer | Eklenen çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.output_item.added.Olası değerler: response.output_item.added |
Yes |
OpenAI.ResponseOutputItemDoneEvent
Çıktı öğesi tamamlandı olarak işaretlendiğinde yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| öğe | OpenAI.OutputItem | Yes | ||
| └─ türü | OpenAI.OutputItemType | Yes | ||
| output_index | integer | Bitti olarak işaretlenen çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.output_item.done.Olası değerler: response.output_item.done |
Yes |
OpenAI.ResponseOutputTextAnnotationAddedEvent
YanıtÇıktıMetinAçıklamaEklenEtkinlik
Çıkış metni içeriğine ek açıklama eklendiğinde yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| annotation | OpenAI.Annotation | Çıkış metninin yayılma alanına uygulanan bir ek açıklama. | Yes | |
| └─ türü | OpenAI.AnnotationType | Yes | ||
| annotation_index | integer | İçerik bölümündeki ek açıklamanın dizini. | Yes | |
| content_index | integer | Çıkış öğesi içindeki içerik bölümünün dizini. | Yes | |
| item_id | Dize | Ek açıklamanın eklendiği öğenin benzersiz tanımlayıcısı. | Yes | |
| output_index | integer | Yanıtın çıkış dizisindeki çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.output_text.annotation.added'. Olası değerler: response.output_text.annotation.added |
Yes |
OpenAI.ResponsePromptVariables
İstek Değişkenleri
İsteminizdeki değişkenlerin yerine kullanılacak isteğe bağlı değer haritası. Değiştirme değerleri dizeler veya görüntüler veya dosyalar gibi diğer Yanıt giriş türleri olabilir.
Tür: nesne
OpenAI.ResponseQueuedEvent
ResponseQueuedEvent
Bir yanıt kuyruğa alınıp işlenmeyi beklediğinde gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| response | OpenAI.Response | Yes | ||
| └─ arka plan | boole veya null | Hayır | ||
| └─ completed_at | string veya null (unixTimestamp) | Hayır | ||
| └─ content_filters | AzureContentFilterForResponsesAPI dizisi | RAI'den gelen içerik filtresi sonuçları. | Hayır | |
| └─ konuşma | OpenAI.ConversationReference veya null | Hayır | ||
| └─ oluşturulma_tarihi | tamsayı (unixtime) | Bu Yanıtın oluşturulduğu unix zaman damgası (saniye). | Yes | |
| └─ hata | OpenAI.ResponseError veya null | Yes | ||
| └─ kimlik | Dize | Bu Yanıt için benzersiz tanımlayıcı. | Yes | |
| └─ eksik_bilgiler | OpenAI.ResponseIncompleteDetails veya null | Yes | ||
| └─ yönerge | OpenAI.InputItem veya null dizesi veya dizisi | Yes | ||
| └─ maksimum_çıkış_jetonları | tamsayı veya null | Hayır | ||
| └─ maksimum araç çağrıları | tamsayı veya null | Hayır | ||
| └─ meta veriler | OpenAI.Metadata veya null | Hayır | ||
| └─ modeli | Dize | veya gpt-4ogibi o3 yanıtı oluşturmak için kullanılan model kimliği. OpenAIfarklı özelliklere, performansa sahip çok çeşitli modeller sunar özellikleri ve fiyat noktaları. Model rehberine bakınız seçeneğine gidin ve kullanılabilir modelleri karşılaştırın. |
Hayır | |
| └─ nesne | enum | Bu kaynağın nesne türü - her zaman response olarak ayarlanır.Olası değerler: response |
Yes | |
| └─ çıkış | OpenAI.OutputItem dizisi | Model tarafından oluşturulan içerik öğeleri dizisi. - Dizideki output öğelerin uzunluğu ve sırası bağlıdırmodelin yanıtı üzerinde. - Dizideki output ilk öğeye erişmek yerine vetarafından oluşturulan içeriğe sahip bir assistant ileti olduğunu varsayarsakmodeli dikkate alarak output_text özelliğini kullanmayı düşünebilirsiniz.SDK'larda desteklenir. |
Yes | |
| └─ çıktı_metin | dize veya null | Hayır | ||
| └─ paralel_arac_cagrilari | boolean | Modelin araç çağrılarını paralel olarak çalıştırmasına izin verilip verilmeyeceği. | Yes | True |
| └─ önceki_cevap_id | dize veya null | Hayır | ||
| └─ istemi | OpenAI.Prompt | Bir komut şablonuna ve değişkenlerine referans. |
Hayır | |
| └─ prompt_cache_key | Dize | OpenAI tarafından önbellek isabet hızlarınızı iyileştirmek amacıyla benzer isteklere yönelik yanıtları önbelleğe almak için kullanılır.
user alanını değiştirir. |
Hayır | |
| └─ prompt_cache_retention | dize veya null | Hayır | ||
| └─ akıl yürütme | OpenAI.Reasoning veya null | Hayır | ||
| └─ safety_identifier | Dize | OpenAI'nin kullanım ilkelerini ihlal eden uygulamanızın kullanıcılarını algılamaya yardımcı olmak için kullanılan kararlı tanımlayıcı. Kimlikler, her kullanıcıyı benzersiz şekilde tanımlayan ve maksimum 64 karakter uzunluğunda bir dizi olmalıdır. Bize herhangi bir tanımlayıcı bilgi göndermemek için kullanıcı adını veya e-posta adresini karma olarak kullanmanızı öneririz. Kısıtlamalar: maxUzunluk: 64 |
Hayır | |
| └─ durumu | enum | Yanıt oluşturma durumu.
completed'lerden biri, failedin_progress, cancelled, queued veya incomplete.Olası değerler: completed, failed, in_progress, cancelled, , queued, incomplete |
Hayır | |
| └─ sıcaklık | sayı veya null | Hayır | 1 | |
| └─ metin | OpenAI.ResponseTextParam | Modelden metin yanıtı için yapılandırma seçenekleri. Düz olabilir metin veya yapılandırılmış JSON verileri. Daha fazla bilgi edinin: - Metin girişleri ve çıkışları - Şekillendirilmiş Çıktılar |
Hayır | |
| └─ araç seçimi | OpenAI.ToolChoiceOptions veya OpenAI.ToolChoiceParam | Hayır | ||
| └─ araçları | OpenAI.ToolsArray | Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Siz parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilir.Aşağıdaki araç kategorilerini destekliyoruz: - Yerleşik araçlar: OpenAI tarafından sağlanan ve işlevselliği genişleten araçlar Modelin yetenekleri, örneğin web arama ya da dosya araması. Hakkında daha fazla bilgi edinin yerleşik aletler. - MCP Araçları: Özel MCP sunucuları aracılığıyla üçüncü taraf sistemlerle tümleştirmeler veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar. Hakkında daha fazla bilgi edinin MCP Araçları. - İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenlerle kendi kodunuzu çağırmasını sağlama ve çıkışlarını seçin. Hakkında daha fazla bilgi edinin fonksiyon çağrısı yapıyor. Ayrıca şunları da kullanabilirsiniz: kendi kodunuzu çağırmak için özel araçlar. |
Hayır | |
| └─ top_logprobs | tamsayı veya null | Hayır | ||
| └─ top_p | sayı veya null | Hayır | 1 | |
| └─ kısaltma | dize veya null | Hayır | engelli | |
| └─ kullanımı | OpenAI.ResponseUsage | Giriş belirteçleri, çıkış belirteçleri dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder. çıkış belirteçlerinin ve kullanılan toplam belirteçlerin dökümü. |
Hayır | |
| └─ kullanıcı | dize (kullanım dışı) | Bu alan ve safety_identifierile prompt_cache_key değiştiriliyor. Bunun yerine önbelleğe alma iyileştirmelerini korumak için kullanın prompt_cache_key .Son kullanıcılarınız için kararlı bir tanımlayıcı. Benzer istekleri daha iyi demetleyerek önbellek isabet oranlarını artırmak ve OpenAI'nin kötüye kullanımı algılayıp önlemesine yardımcı olmak için kullanılır. |
Hayır | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman 'response.queued'. Olası değerler: response.queued |
Yes |
OpenAI.ResponseReasoningSummaryPartAddedEvent
Yeni bir akıl yürütme özeti bölümü eklendiğinde yayımlanır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Bu özet bölümün ilişkili olduğu öğenin kimliği. | Yes | |
| output_index | integer | Bu özet bölümünün ilişkili olduğu çıkış öğesinin dizini. | Yes | |
| parça | OpenAI.ResponseReasoningSummaryPartAddedEventPart | Yes | ||
| └─ metin | Dize | Yes | ||
| └─ türü | enum | Olası değerler: summary_text |
Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| summary_index | integer | Akıl yürütme özeti içindeki özet bölümünün dizini. | Yes | |
| type | enum | Olayın türü. Her zaman response.reasoning_summary_part.added.Olası değerler: response.reasoning_summary_part.added |
Yes |
OpenAI.ResponseReasoningSummaryPartAddedEventPart
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Yes | ||
| type | enum | Olası değerler: summary_text |
Yes |
OpenAI.ResponseReasoningSummaryPartDoneEvent
Bir akıl yürütme özeti bölümü tamamlandığında gönderilir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Bu özet bölümün ilişkili olduğu öğenin kimliği. | Yes | |
| output_index | integer | Bu özet bölümünün ilişkili olduğu çıkış öğesinin dizini. | Yes | |
| parça | OpenAI.ResponseReasoningSummaryPartDoneEventPart | Yes | ||
| └─ metin | Dize | Yes | ||
| └─ türü | enum | Olası değerler: summary_text |
Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| summary_index | integer | Akıl yürütme özeti içindeki özet bölümünün dizini. | Yes | |
| type | enum | Olayın türü. Her zaman response.reasoning_summary_part.done.Olası değerler: response.reasoning_summary_part.done |
Yes |
OpenAI.ResponseReasoningSummaryPartDoneEventPart
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Yes | ||
| type | enum | Olası değerler: summary_text |
Yes |
OpenAI.ResponseReasoningSummaryTextDeltaEvent
Bir muhakeme özeti metnine delta eklendiğinde oluşur.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| delta | Dize | Özete eklenen metin deltası. | Yes | |
| item_id | Dize | Bu özet metin deltasının ilişkili olduğu öğenin kimliği. | Yes | |
| output_index | integer | Bu özet metin deltasının bağlı olduğu çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| summary_index | integer | Akıl yürütme özeti içindeki özet bölümünün dizini. | Yes | |
| type | enum | Olayın türü. Her zaman response.reasoning_summary_text.delta.Olası değerler: response.reasoning_summary_text.delta |
Yes |
OpenAI.ResponseReasoningSummaryTextDoneEvent
Bir akıl yürütme özeti metni tamamlandığında yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Bu özet metnin ilişkili olduğu öğenin kimliği. | Yes | |
| output_index | integer | Bu özet metnin ilişkili olduğu çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| summary_index | integer | Akıl yürütme özeti içindeki özet bölümünün dizini. | Yes | |
| text | Dize | Tamamlanan akıl yürütme özetinin tam metni. | Yes | |
| type | enum | Olayın türü. Her zaman response.reasoning_summary_text.done.Olası değerler: response.reasoning_summary_text.done |
Yes |
OpenAI.ResponseReasoningTextDeltaEvent
Bir muhakeme metnine delta eklendiğinde yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Bu deltanın ilişkili olduğu gerekçe oluşturma içeriğinin dizini. | Yes | |
| delta | Dize | Muhakeme içeriğine eklenen metin deltası. | Yes | |
| item_id | Dize | Bu muhakeme metni deltasının ilişkili olduğu öğenin kimliği. | Yes | |
| output_index | integer | Bu metin değişikliğinin ilişkilendirilmesine neden olan çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.reasoning_text.delta.Olası değerler: response.reasoning_text.delta |
Yes |
OpenAI.ResponseReasoningTextDoneEvent
Bir akıl yürütme metni tamamlandığında yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Akıl yürütme içeriği kısmının dizini. | Yes | |
| item_id | Dize | Bu muhakeme metninin ilişkili olduğu öğenin kimliği. | Yes | |
| output_index | integer | Bu akıl yürütme metninin ilişkilendirildiği çıktı öğesinin indeksi. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| text | Dize | Tamamlanmış muhakeme içeriğinin tam metni. | Yes | |
| type | enum | Olayın türü. Her zaman response.reasoning_text.done.Olası değerler: response.reasoning_text.done |
Yes |
OpenAI.ResponseRefusalDeltaEvent
Kısmi bir reddetme metni olduğunda yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Reddetme metninin eklendiği içerik bölümünün dizini. | Yes | |
| delta | Dize | Eklenen ret metni. | Yes | |
| item_id | Dize | Reddetme metninin eklendiği çıkış öğesinin kimliği. | Yes | |
| output_index | integer | Reddetme metninin eklendiği çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.refusal.delta.Olası değerler: response.refusal.delta |
Yes |
OpenAI.ResponseRefusalDoneEvent
Reddeden metin sonlandırıldığında yayılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Red metni kesinleştiren içerik bölümünün dizini. | Yes | |
| item_id | Dize | Sonlandırılan reddetme metninin ait olduğu çıkış öğesinin kimliği. | Yes | |
| output_index | integer | Reddetme metninin sonlandırıldığı çıkış öğesinin dizini. | Yes | |
| Ret | Dize | Kesinleştirilen reddetme metni. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.refusal.done.Olası değerler: response.refusal.done |
Yes |
OpenAI.ResponseStreamEvent
OpenAI.ResponseStreamEvent için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ResponseStreamEventType | Yes |
OpenAI.ResponseStreamEventType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | response.audio.deltaresponse.audio.doneresponse.audio.transcript.deltaresponse.audio.transcript.doneresponse.code_interpreter_call_code.deltaresponse.code_interpreter_call_code.doneresponse.code_interpreter_call.completedresponse.code_interpreter_call.in_progressresponse.code_interpreter_call.interpretingresponse.completedresponse.content_part.addedresponse.content_part.doneresponse.createderrorresponse.file_search_call.completedresponse.file_search_call.in_progressresponse.file_search_call.searchingresponse.function_call_arguments.deltaresponse.function_call_arguments.doneresponse.in_progressresponse.failedresponse.incompleteresponse.output_item.addedresponse.output_item.doneresponse.reasoning_summary_part.addedresponse.reasoning_summary_part.doneresponse.reasoning_summary_text.deltaresponse.reasoning_summary_text.doneresponse.reasoning_text.deltaresponse.reasoning_text.doneresponse.refusal.deltaresponse.refusal.doneresponse.output_text.deltaresponse.output_text.doneresponse.web_search_call.completedresponse.web_search_call.in_progressresponse.web_search_call.searchingresponse.image_generation_call.completedresponse.image_generation_call.generatingresponse.image_generation_call.in_progressresponse.image_generation_call.partial_imageresponse.mcp_call_arguments.deltaresponse.mcp_call_arguments.doneresponse.mcp_call.completedresponse.mcp_call.failedresponse.mcp_call.in_progressresponse.mcp_list_tools.completedresponse.mcp_list_tools.failedresponse.mcp_list_tools.in_progressresponse.output_text.annotation.addedresponse.queuedresponse.custom_tool_call_input.deltaresponse.custom_tool_call_input.done |
OpenAI.ResponseStreamOptions
Akış yanıtları için seçenekler. Bunu yalnızca stream: true ayarladığınızda yapılandırın.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| include_obfuscation | boolean | True olduğunda, akış gizleme etkinleştirilir. Akış gizleme eklemeleri değişiklik olaylarının akışındaki bir obfuscation alana rastgele karakterleryük boyutlarını belirli yan kanal saldırılarına karşı bir azaltma olarak normalleştirin. Bu gizleme alanları varsayılan olarak eklenir, ancak küçük bir miktar eklenir veri akışı için ek yük. Şunu ayarlayabilirsiniz: include_obfuscationarasında ağ bağlantılarına güveniyorsanız bant genişliğini iyileştirmek için false uygulamanızı ve OpenAI API'sini seçin. |
Hayır |
OpenAI.ResponseTextDeltaEvent
İlave bir metin deltası olduğunda oluşur.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Metin deltasının eklendiği içerik bölümünün dizini. | Yes | |
| delta | Dize | Eklenen metin deltası. | Yes | |
| item_id | Dize | Metin deltasının eklendiği çıkış öğesinin kimliği. | Yes | |
| logprobs | OpenAI.ResponseLogProb dizisi | Deltadaki belirteçlerin günlük olasılıkları. | Yes | |
| output_index | integer | Metin deltasının eklendiği çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.output_text.delta.Olası değerler: response.output_text.delta |
Yes |
OpenAI.ResponseTextDoneEvent
Metin içeriği sonlandırıldığında yayınlanır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| content_index | integer | Metin içeriğinin tamamlandığı içerik bölümünün dizini. | Yes | |
| item_id | Dize | Metin içeriğinin sonlandırıldığı çıkış öğesinin kimliği. | Yes | |
| logprobs | OpenAI.ResponseLogProb dizisi | Deltadaki belirteçlerin günlük olasılıkları. | Yes | |
| output_index | integer | Son haline getirilen metin içeriğine ait çıktı öğesinin dizini. | Yes | |
| sequence_number | integer | Bu olayın sıra numarası. | Yes | |
| text | Dize | Son haline getirilmiş metin içeriği. | Yes | |
| type | enum | Olayın türü. Her zaman response.output_text.done.Olası değerler: response.output_text.done |
Yes |
OpenAI.ResponseTextParam
Modelden metin yanıtı için yapılandırma seçenekleri. Düz metin veya yapılandırılmış JSON verileri olabilir. Daha fazla bilgi edinin:
- Metin girişleri ve çıkışları
- Yapısal Çıktılar
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| format | OpenAI.TextResponseFormatConfiguration | Modelin çıkış yapması gereken biçimi belirten bir nesne.{ "type": "json_schema" }'yi yapılandırmak, Yapılandırılmış Çıkışları etkinleştirir.modelin sağlanan JSON şemanızla eşleşmesini sağlar. Daha fazla bilgi için burayı ziyaret edin Varsayılan biçim { "type": "text" } ek seçenek yoktur.gpt-4o ve daha yeni modeller için önerilmez: { "type": "json_object" } ayarı, eski JSON modunu etkinleştirir.modelin oluşturduğu iletinin geçerli JSON olduğundan emin olur. json_schema’ı kullanmaBu özelliği destekleyen modeller için tercih edilir. |
Hayır | |
| Ayrıntı | OpenAI.Verbosity | Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler, daha kısa yanıtlar elde ederken, daha yüksek değerler daha ayrıntılı yanıtlara neden olur. Şu anda desteklenen değerler , lowve medium'tirhigh. |
Hayır |
OpenAI.ResponseUsage
Giriş belirteçleri, çıkış belirteçleri, çıkış belirteçlerinin dökümü ve kullanılan toplam belirteçler dahil olmak üzere belirteç kullanım ayrıntılarını temsil eder.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| input_tokens | integer | Giriş belirteçlerinin sayısı. | Yes | |
| input_tokens_details | OpenAI.ResponseUsageInputTokensDetails | Yes | ||
| └─ önbelleğe alınmış jetonlar | integer | Yes | ||
| output_tokens | integer | Çıkış belirteçlerinin sayısı. | Yes | |
| output_tokens_details | OpenAI.ResponseUsageOutputTokensDetails | Yes | ||
| └─ akıl yürütme_tokenlar | integer | Yes | ||
| total_tokens | integer | Kullanılan toplam belirteç sayısı. | Yes |
OpenAI.ResponseUsageInputTokensDetails
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| cached_tokens | integer | Yes |
OpenAI.ResponseUsageOutputTokensDetails
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| akıl yürütme birimleri | integer | Yes |
OpenAI.ResponseWebSearchCallCompletedEvent
Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği. | Yes | |
| output_index | integer | Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | İşlenmekte olan web arama çağrısının sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.web_search_call.completed.Olası değerler: response.web_search_call.completed |
Yes |
OpenAI.ResponseWebSearchCallInProgressEvent
Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği. | Yes | |
| output_index | integer | Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | İşlenmekte olan web arama çağrısının sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.web_search_call.in_progress.Olası değerler: response.web_search_call.in_progress |
Yes |
OpenAI.ResponseWebSearchCallSearchingEvent
Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| item_id | Dize | Web arama çağrısıyla ilişkili çıkış öğesinin benzersiz kimliği. | Yes | |
| output_index | integer | Web arama çağrısının ilişkili olduğu çıkış öğesinin dizini. | Yes | |
| sequence_number | integer | İşlenmekte olan web arama çağrısının sıra numarası. | Yes | |
| type | enum | Olayın türü. Her zaman response.web_search_call.searching.Olası değerler: response.web_search_call.searching |
Yes |
OpenAI.ScreenshotParam
Screenshot
Ekran görüntüsü alma işlemi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olay türünü belirtir. Ekran görüntüsü eylemi için bu özellik her zaman olarak screenshotayarlanır.Olası değerler: screenshot |
Yes | ekran görüntüsü |
OpenAI.ScrollParam
Scroll
Kaydırma eylemi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| keys | dize dizisi veya null | Hayır | ||
| scroll_x | integer | Yatay kaydırma uzaklığı. | Yes | |
| scroll_y | integer | Dikey kaydırma uzaklığı. | Yes | |
| type | enum | Olay türünü belirtir. Kaydırma eylemi için bu özellik her zaman olarak scrollayarlanır.Olası değerler: scroll |
Yes | Kaydırma |
| x | integer | Kaydırmanın gerçekleştiği x koordinatı. | Yes | |
| y | integer | Kaydırmanın gerçekleştiği y koordinatı. | Yes |
OpenAI.SearchContentType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | textimage |
OpenAI.SearchContextSize
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | lowmediumhigh |
OpenAI.SkillReferenceParam
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| skill_id | Dize | Referans verilen becerinin kimliği. Kısıtlamalar: minLength: 1, maxLength: 64 |
Yes | |
| type | enum | /v1/skills uç noktasıyla oluşturulan bir yeteneğe referans verir. Olası değerler: skill_reference |
Yes | skill_reference |
| version | Dize | İsteğe bağlı yetenek versiyonu. Pozitif tam sayı veya 'latest sayı' kullanın. Varsayılan için çıkar. | Hayır |
OpenAI.SpecificApplyPatchParam
Özel uygulama yaması aracı seçimi
Bir araç çağrısı yürütürken modeli apply_patch aracını çağırmaya zorlar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Çağrılacak araç. Her zaman apply_patch.Olası değerler: apply_patch |
Yes | apply_patch |
OpenAI.SpecificFunctionShellParam
Özel kabuk aleti seçimi
Bir araç çağrısı gerektiğinde modeli kabuk aracını çağırmaya zorlar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Çağrılacak araç. Her zaman shell.Olası değerler: shell |
Yes | Kabuk |
OpenAI.SummaryTextContent
Özet metin
Modelden özet metin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Modelden şimdiye kadar elde edilen mantık çıkarlarının özeti. | Yes | |
| type | enum | Nesnenin türü. Her zaman summary_text.Olası değerler: summary_text |
Yes | summary_text |
OpenAI.TextContent
Metin İçeriği
Metin içeriği.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Yes | ||
| type | enum | Olası değerler: text |
Yes | text |
OpenAI.TextResponseFormatConfiguration
Modelin çıkış yapması gereken biçimi belirten bir nesne.
Yapılandırma { "type": "json_schema" } , modelin sağlanan JSON şemanızla eşleşmesini sağlayan Yapılandırılmış Çıkışlar'ı etkinleştirir. Daha fazla bilgi için burayı ziyaret edin
Varsayılan biçim { "type": "text" } ek seçenek yoktur.
GPT-4o ve daha yeni modeller için önerilmez: Ayarlar, { "type": "json_object" } modelin oluşturduğu mesajın geçerli olmasını sağlayan eski JSON modunu etkinleştirir. Destekleyen modeller için json_schema kullanılması tercih edilir.
OpenAI.TextResponseFormatConfiguration için Ayrıştırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
json_schema |
OpenAI.TextResponseFormatJsonSchema |
text |
OpenAI.TextResponseFormatConfigurationResponseFormatText |
json_object |
OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.TextResponseFormatConfigurationType | Yes |
OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject
JSON nesnesi
JSON nesne yanıt biçimi. JSON yanıtları oluşturmanın eski bir yöntemi.
Bunu destekleyen modeller için kullanılması json_schema önerilir. Modelin, bir sistem veya kullanıcı iletisi olmadan JSON oluşturmayacağını unutmayın.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Tanımlanan yanıt biçiminin türü. Her zaman json_object.Olası değerler: json_object |
Yes |
OpenAI.TextResponseFormatConfigurationResponseFormatText
Metin
Varsayılan yanıt biçimi. Metin yanıtları oluşturmak için kullanılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Tanımlanan yanıt biçiminin türü. Her zaman text.Olası değerler: text |
Yes |
OpenAI.TextResponseFormatConfigurationType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | textjson_schemajson_object |
OpenAI.TextResponseFormatJsonSchema
JSON şeması
JSON Şeması yanıt biçimi. Yapılandırılmış JSON yanıtları oluşturmak için kullanılır.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Açıklama | Dize | Model tarafından kullanılan yanıt biçiminin ne için olduğuna dair bir açıklama. Yanıt formatını nasıl belirleyeceğinizi öğrenin. |
Hayır | |
| name | Dize | Yanıt biçiminin adı. a-z, A-Z, 0-9 veya bunları içermelidir alt çizgi ve tirelerden oluşan, maksimum uzunluk 64 karakterdir. |
Yes | |
| schema | OpenAI.YanıtFormatıJsonŞemaŞeması | JSON Şeması nesnesi olarak tanımlanan yanıt biçimi şeması. JSON şemaları oluşturmayı buradan öğrenin. |
Yes | |
| Kesin | boole veya null | Hayır | ||
| type | enum | Tanımlanan yanıt biçiminin türü. Her zaman json_schema.Olası değerler: json_schema |
Yes |
OpenAI.Tool
Yanıt oluşturmak için kullanılabilecek bir araç.
OpenAI.Tool için Ayırıcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
code_interpreter |
OpenAI.CodeInterpreterTool |
function |
OpenAI.FunctionTool |
file_search |
OpenAI.FileSearchTool |
computer_use_preview |
OpenAI.ComputerUsePreviewTool |
web_search |
OpenAI.WebSearchTool |
mcp |
OpenAI.MCPTool |
image_generation |
OpenAI.ImageGenTool |
local_shell |
OpenAI.LocalShellToolParam |
shell |
OpenAI.FunctionShellToolParam |
custom |
OpenAI.CustomToolParam |
web_search_preview |
OpenAI.WebSearchPreviewTool |
apply_patch |
OpenAI.ApplyPatchToolParam |
computer |
OpenAI.ComputerTool |
namespace |
OpenAI.NamespaceToolParam |
tool_search |
OpenAI.ToolSearchToolParam |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ToolType | Yes |
OpenAI.ToolChoiceAllowed
İzin verilen araçlar
Modelde kullanılabilen araçları önceden tanımlanmış bir kümeyle kısıtlar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| modu | enum | Modelde kullanılabilen araçları önceden tanımlanmış bir kümeyle kısıtlar.auto modelin izin verilen araçlar arasından seçim yapmasına veMesaj. required modelin izin verilen araçlardan birini veya daha fazlasını çağırmasını gerektirir.Olası değerler: auto, required |
Yes | |
| tools | nesne dizisi | Modelin çağırmasına izin verilmesi gereken araç tanımlarının listesi. Yanıtlar API'sinde araç tanımlarının listesi şöyle görünebilir: json<br> [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ]<br> |
Yes | |
| type | enum | İzin verilen araç yapılandırma türü. Her zaman allowed_tools.Olası değerler: allowed_tools |
Yes |
OpenAI.ToolChoiceCodeInterpreter
Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: code_interpreter |
Yes |
OpenAI.ToolChoiceComputer
Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: computer |
Yes |
OpenAI.ToolChoiceComputerUse
Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: computer_use |
Yes |
OpenAI.ToolChoiceComputerUsePreview
Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: computer_use_preview |
Yes |
OpenAI.ToolChoiceCustom
Özel araç
Modeli belirli bir özel aracı çağırmaya zorlamak için bu seçeneği kullanın.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| name | Dize | Çağrılacak özel aracın adı. | Yes | |
| type | enum | Özel araç çağrısı için türü her zaman customşeklindedir.Olası değerler: custom |
Yes |
OpenAI.ToolChoiceFileSearch
Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: file_search |
Yes |
OpenAI.ToolChoiceFunction
Fonksiyon aracı
Modeli belirli bir işlevi çağırmaya zorlamak için bu seçeneği kullanın.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| name | Dize | Çağrılacak işlevin adı. | Yes | |
| type | enum | İşlev çağrısı için türü her zaman functionşeklindedir.Olası değerler: function |
Yes |
OpenAI.ToolChoiceImageGeneration
Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: image_generation |
Yes |
OpenAI.ToolChoiceMCP
MCP aracı
Modeli uzak bir MCP sunucusunda belirli bir aracı çağırmaya zorlamak için bu seçeneği kullanın.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| name | dize veya null | Hayır | ||
| sunucu etiketi | Dize | Kullanılacak MCP sunucusunun etiketi. | Yes | |
| type | enum | MCP araçları için türü her zaman mcpşeklindedir.Olası değerler: mcp |
Yes |
OpenAI.ToolChoiceOptions
Araç seçimi modu
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.
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | noneautorequired |
OpenAI.ToolChoiceParam
Modelin yanıt oluştururken kullanılacak aracı (veya araçları) seçmesi gerekir. Modelin hangi araçları çağırabileceğini belirtmek için tools parametresine bakın.
OpenAI.ToolChoiceParam için Ayrımcı
Bu bileşen, farklı türler arasında ayrım yapmak için özelliğini type kullanır:
| Tür Değeri | Schema |
|---|---|
allowed_tools |
OpenAI.ToolChoiceAllowed |
mcp |
OpenAI.ToolChoiceMCP |
custom |
OpenAI.ToolChoiceCustom |
apply_patch |
OpenAI.SpecificApplyPatchParam |
shell |
OpenAI.SpecificFunctionShellParam |
file_search |
OpenAI.ToolChoiceFileSearch |
web_search_preview |
OpenAI.ToolChoiceWebSearchPreview |
computer_use_preview |
OpenAI.ToolChoiceComputerUsePreview |
web_search_preview_2025_03_11 |
OpenAI.ToolChoiceWebSearchPreview20250311 |
image_generation |
OpenAI.ToolChoiceImageGeneration |
code_interpreter |
OpenAI.ToolChoiceCodeInterpreter |
computer |
OpenAI.ToolChoiceComputer |
computer_use |
OpenAI.ToolChoiceComputerUse |
function |
OpenAI.ToolChoiceFunction |
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | OpenAI.ToolChoiceParamType | Yes |
OpenAI.ToolChoiceParamType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | allowed_toolsfunctionmcpcustomapply_patchshellfile_searchweb_search_previewcomputer_use_previewweb_search_preview_2025_03_11image_generationcode_interpretercomputercomputer_use |
OpenAI.ToolChoiceWebSearchPreview
Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: web_search_preview |
Yes |
OpenAI.ToolChoiceWebSearchPreview20250311
Modelin bir yanıt oluşturmak için yerleşik bir araç kullanması gerektiğini gösterir. Yerleşik araçlar hakkında daha fazla bilgi edinin.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: web_search_preview_2025_03_11 |
Yes |
OpenAI.ToolSearchExecutionType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | serverclient |
OpenAI.ToolSearchToolParam
Araç arama aracı
Geciktirilen araçlar için barındırılan veya BYOT araç arama yapılandırması.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| Açıklama | dize veya null | Hayır | ||
| idam | OpenAI.ToolSearchExecutionType | Hayır | ||
| parameters | OpenAI.EmptyModelParam or null | Hayır | ||
| type | enum | Aracın türü. Her zaman tool_search.Olası değerler: tool_search |
Yes | tool_search |
OpenAI.ToolType
| Property | Değer |
|---|---|
| Türü | Dize |
| Değerler | functionfile_searchcomputercomputer_use_previewweb_searchmcpcode_interpreterimage_generationlocal_shellshellcustomnamespacetool_searchweb_search_previewapply_patch |
OpenAI.ToolsArray
Yanıt oluştururken modelin çağırabileceği bir araç dizisi. Parametresini ayarlayarak tool_choice hangi aracın kullanılacağını belirtebilirsiniz.
Aşağıdaki araç kategorilerini destekliyoruz:
- Yerleşik araçlar: OpenAI tarafından sağlanan ve modelin yeteneklerini genişleten web arama veya dosya araması gibi araçlar. Yerleşik araçlar hakkında daha fazla bilgi edinin.
- MCP Araçları: Özel MCP sunucuları veya Google Drive ve SharePoint gibi önceden tanımlanmış bağlayıcılar aracılığıyla üçüncü taraf sistemlerle tümleştirmeler. MCP Tools hakkında daha fazla bilgi edinin.
- İşlev çağrıları (özel araçlar): Sizin tanımladığınız işlevler, modelin kesin olarak yazılan bağımsız değişkenler ve çıkışlarla kendi kodunuzu çağırmasını sağlar. İşlev çağırma hakkında daha fazla bilgi edinin. Kendi kodunuzu çağırmak için özel araçlar da kullanabilirsiniz.
Dizisi: OpenAI.Tool
OpenAI.TopLogProb
En yüksek log olasılığı
Belirtecin en yüksek logaritmik olasılığı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| bytes | tamsayı dizisi | Yes | ||
| logprob | number | Yes | ||
| token | Dize | Yes |
OpenAI.TypeParam
Türü
Metin yazmak için bir eylem.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| text | Dize | Yazılacak metin. | Yes | |
| type | enum | Olay türünü belirtir. Tür eylemi için bu özellik her zaman olarak typeayarlanır.Olası değerler: type |
Yes | type |
OpenAI.UrlCitationBody
URL alıntısı
Model yanıtı oluşturmak için kullanılan bir web kaynağı alıntısı.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| end_index | integer | İletideki URL alıntısının son karakterinin dizini. | Yes | |
| start_index | integer | İletideki URL alıntısının ilk karakterinin dizini. | Yes | |
| title | Dize | Web kaynağının başlığı. | Yes | |
| type | enum | URL alıntısının türü. Her zaman url_citation.Olası değerler: url_citation |
Yes | url_citation |
| url | dize (uri) | Web kaynağının URL'si. | Yes |
OpenAI.VectorStoreFileAttributes
Bir nesneye eklenebilen 16 anahtar-değer çifti kümesi. Bu, nesne hakkında ek bilgileri yapılandırılmış biçimde depolamak ve API veya pano aracılığıyla nesneleri sorgulamak için yararlı olabilir. Anahtarlar, uzunluğu en fazla 64 karakter olan dizelerdir. Değerler, uzunluğu en fazla 512 karakter, boole veya sayı olan dizelerdir.
Tür: nesne
OpenAI.Verbosity
Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler daha kısa yanıtlar sağlarken, daha yüksek değerler daha fazla sözlü yanıtlar sağlar.
Şu anda desteklenen değerler , lowve medium'tirhigh.
| Property | Değer |
|---|---|
| Tanım | Modelin yanıtının çok fazla olduğunu sınırlar. Daha düşük değerler, daha kısa yanıtlar elde ederken, daha yüksek değerler daha ayrıntılı yanıtlara neden olur. Şu anda desteklenen değerler , lowve medium'tirhigh. |
| Türü | Dize |
| Değerler | lowmediumhigh |
OpenAI.WaitParam
Beklemek
Bir bekleme eylemi.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olay türünü belirtir. Bir bekleme eylemi için bu özellik her zaman olarak waitayarlanır.Olası değerler: wait |
Yes | wait |
OpenAI.WebSearchActionFind
Aksiyon bul
Eylem tipi "find_in_page": Yüklenmiş bir sayfada bir desen arar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| pattern | Dize | Sayfa içinde aranacak desen veya metin. | Yes | |
| type | enum | Eylem türü. Olası değerler: find_in_page |
Yes | |
| url | dize (uri) | Desenin arandığı sayfanın URL'si. | Yes |
OpenAI.WebSearchActionOpenPage
Sayfa aç eylemi
Eylem türü "open_page" - Arama sonuçlarından belirli bir URL'yi açar.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Eylem türü. Olası değerler: open_page |
Yes | |
| url | dize veya null | Modelin açtığı URL | Hayır |
OpenAI.WebSearchActionSearch
Arama eylemi
Eylem türü "arama" - Web araması sorgusu gerçekleştirir.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| queries | dize dizisi | Arama sorguları. | Hayır | |
| soru | dize (kullanım dışı) | [KULLANIM DIŞI] Arama sorgusu. | Yes | |
| Kaynak | OpenAI.WebSearchActionSearchSources dizisi | Aramada kullanılan kaynaklar. | Hayır | |
| type | enum | Eylem türü. Olası değerler: search |
Yes |
OpenAI.WebSearchActionSearchSources
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| type | enum | Olası değerler: url |
Yes | |
| url | dize (uri) | Yes |
OpenAI.WebSearchApproximateLocation
Web araması yaklaşık konum
Kullanıcının yaklaşık konumu.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| city | dize veya null | Hayır | ||
| country | dize veya null | Hayır | ||
| region | dize veya null | Hayır | ||
| timezone | dize veya null | Hayır | ||
| type | enum | Konum yaklaşımının türü. Her zaman approximate.Olası değerler: approximate |
Yes | Yaklaşık |
OpenAI.WebSearchPreviewTool
Web arama önizlemesi
Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| search_content_types | OpenAI.SearchContentType dizisi | Hayır | ||
| arama_bağlam_boyutu | OpenAI.SearchContextSize | Hayır | ||
| type | enum | Web arama aracının türü.
web_search_preview veya web_search_preview_2025_03_11'den biri.Olası değerler: web_search_preview |
Yes | web_search_preview |
| kullanıcı_konumu | OpenAI.ApproximateLocation veya null | Hayır |
OpenAI.WebSearchTool
Web araması
Not: web_search henüz Azure OpenAI aracılığıyla sağlanmaz.
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| filters | OpenAI.WebSearchToolFilters veya null | Hayır | ||
| arama_bağlam_boyutu | enum | Arama için kullanılacak bağlam penceresi alanı miktarına yönelik üst düzey kılavuz.
low, mediumveya high.
medium varsayılan değerdir.Olası değerler: low, medium, high |
Hayır | orta |
| type | enum | Web arama aracının türü.
web_search veya web_search_2025_08_26'den biri.Olası değerler: web_search |
Yes | web araması |
| kullanıcı_konumu | OpenAI.WebSearchApproximateLocation veya null | Hayır |
OpenAI.WebSearchToolFilters
| Name | Türü | Description | Zorunlu | Varsayılan |
|---|---|---|---|---|
| allowed_domains | dize dizisi veya null | Hayır |