Aracılığıyla paylaş


@azure/ai-agents package

Sınıflar

AgentsClient
ToolSet

Tanımları ve kaynaklarıyla bir araç kümesini temsil eder.

ToolUtility

Çeşitli araçlar oluşturmak için yardımcı program sınıfı.

Arabirimler

AISearchIndexResource

Bir AI Arama Dizini kaynağı.

Agent

Modeli çağırabilen ve araçları kullanabilen bir aracıyı temsil eder.

AgentDeletionStatus

Aracı silme işleminin durumu.

AgentErrorDetail

Aracılar API'si tarafından döndürülen hata bilgilerini açıklar.

AgentEventMessage

Sunucu tarafından gönderilen olaylar akışındaki her olayın bir event ve data özelliği vardır: * *

Örnek

  • olay: thread.created
  • veri: {"id": "thread_123", "nesne": "iş parçacığı", ...}
  • Yeni bir nesne oluşturulduğunda, yeni bir duruma geçişte veya yeni bir nesne oluşturulduğunda olayları yayarız
  • parçalar halinde (deltalar) akışa alınır. Örneğin, yeni bir çalıştırmada thread.run.created yayarız
  • oluşturulur, bir çalıştırma tamamlandığında thread.run.completed vb. Aracı seçtiğinde
  • bir çalıştırma sırasında ileti oluşturmak için bir thread.message.created event,
  • thread.message.in_progress olayı, birçok thread.message.delta olayı ve son olarak
  • thread.message.completed olayı.
  • Zaman içinde ek olaylar ekleyebiliriz, bu nedenle bilinmeyen olayları düzgün bir şekilde işlemenizi öneririz
  • yazın.
AgentEventMessageStream

Aracı olay iletisinin akışını temsil eder.

AgentThread

Bir aracıyla ilişkilendirilmiş tek bir iş parçacığı hakkında bilgi.

AgentThreadCreationOptions

Yeni bir aracı iş parçacığı oluşturmak için kullanılan ayrıntılar.

AgentV1Error

Aracılar API'si tarafından döndürülen hata yükü.

AgentsClientOptionalParams

İstemci için isteğe bağlı parametreler.

AgentsNamedToolChoice

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

AgentsResponseFormat

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

AzureAISearchToolDefinition

Aracıyı yapılandırmak için kullanılan Azure AI arama aracının giriş tanımı bilgileri.

AzureAISearchToolResource

azure_ai_search aracı tarafından kullanılan dizin kaynakları kümesi.

AzureFunctionBinding

Depolama kuyruğu adını ve URI'sini tutmaya yönelik yapı.

AzureFunctionDefinition

Azure işlevinin tanımı.

AzureFunctionStorageQueue

Depolama kuyruğu adını ve URI'sini tutmaya yönelik yapı.

AzureFunctionToolDefinition

Aracıyı yapılandırmak için kullanılan azure işlev aracının giriş tanımı bilgileri.

BingGroundingSearchConfiguration

Bing Topraklama için arama yapılandırması

BingGroundingSearchToolParameters

Bing topraklama arama aracı parametreleri.

BingGroundingToolDefinition

Aracıyı yapılandırmak için kullanılan bing topraklama arama aracının giriş tanımı bilgileri.

CodeInterpreterToolDefinition

Aracıyı yapılandırmak için kullanılan kod yorumlayıcı aracının giriş tanımı bilgileri.

CodeInterpreterToolResource

code_interpreter aracı tarafından kullanılan bir kaynak kümesi.

ConnectedAgentDetails

Bir aracıyı diğerine araç olarak bağlama bilgileri

ConnectedAgentToolDefinition

Etki alanına özgü bir alt aracıyı tanımlayan bağlı bir aracı aracı için giriş tanımı bilgileri

CreateAgentOptionalParams

İsteğe bağlı parametreler.

CreateThreadAndRunOptionalParams

İsteğe bağlı parametreler.

DeleteAgentOptionalParams

İsteğe bağlı parametreler.

FileDeletionStatus

Dosya silme işleminden gelen durum yanıtı.

FileInfo

Modeli çağırabilen ve araçları kullanabilen bir aracıyı temsil eder.

FileListResponse

Bir dosya listesi işleminden gelen yanıt verileri.

FileSearchRankingOptions

Dosya arama için derecelendirme seçenekleri.

FileSearchToolCallContent

Dosya arama sonucu içerik nesnesi.

FileSearchToolDefinition

Aracıyı yapılandırmak için kullanılan dosya arama aracının giriş tanımı bilgileri.

FileSearchToolDefinitionDetails

Dosya arama aracı için seçenekler geçersiz kılar.

FileSearchToolResource

file_search aracı tarafından kullanılan bir kaynak kümesi.

FilesDeleteFileOptionalParams

İsteğe bağlı parametreler.

FilesGetFileContentOptionalParams

İsteğe bağlı parametreler.

FilesGetFileOptionalParams

İsteğe bağlı parametreler.

FilesListFilesOptionalParams

İsteğe bağlı parametreler.

FilesOperations

Dosya işlemlerini temsil eden arayüz.

FilesUploadFileOptionalParams

İsteğe bağlı parametreler.

FunctionDefinition

İşlevin giriş tanımı bilgileri.

FunctionName

function aracı kullanılıyorsa kullanılacak işlev adı

FunctionToolDefinition

Aracıyı yapılandırmak için kullanılan işlev aracının giriş tanımı bilgileri.

GetAgentOptionalParams

İsteğe bağlı parametreler.

IncompleteRunDetails

Çalıştırmanın neden tamamlanmamış olduğuna ilişkin ayrıntılar. Çalıştırma tamamlanmamışsa null.

ListAgentsOptionalParams

İsteğe bağlı parametreler.

MessageAttachment

Bu, bir dosyanın hangi araçlara eklendiğini açıklar.

MessageContent

İş parçacığı ileti içeriğinin tek bir öğesinin soyut gösterimi.

MessageDelta

Akış iletisi delta öbeği içinde yazılan 'delta' yükünü temsil eder.

MessageDeltaChunk

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

MessageDeltaContent

Kısmi akışlı ileti içerik yükünün soyut temel gösterimi.

MessageDeltaImageFileContent

Akış iletisi delta öbekleri içindeki akışlı görüntü dosyası içerik bölümünü temsil eder.

MessageDeltaImageFileContentObject

Akış görüntüsü dosyası içeriğindeki 'image_file' yükünü temsil eder.

MessageDeltaTextAnnotation

Akışlı metin içeriği bölümünün metin ek açıklamasının soyut temel gösterimi.

MessageDeltaTextContent

Akış iletisi delta öbekleri içindeki akışlı metin içeriği bölümünü temsil eder.

MessageDeltaTextContentObject

Akış iletisi delta öbekleri içindeki akışlı metin içeriği bölümünün verilerini temsil eder.

MessageDeltaTextFileCitationAnnotation

Akış metni içerik bölümüne uygulanan akışlı dosya alıntısını temsil eder.

MessageDeltaTextFileCitationAnnotationObject

Akış metni içerik bölümüne uygulanan akışlı dosya alıntısının verilerini temsil eder.

MessageDeltaTextFilePathAnnotation

Akış metin içeriği bölümüne uygulanan akışlı dosya yolu ek açıklamasını temsil eder.

MessageDeltaTextFilePathAnnotationObject

Akış metni içerik bölümüne uygulanan akışlı dosya yolu ek açıklamasının verilerini temsil eder.

MessageDeltaTextUrlCitationAnnotation

İleti içinde, iletiyle ilişkilendirilmiş belirli bir URL'ye işaret eden bir alıntı. Aracı, İnternet'te arama yapmak için 'bing_grounding' gibi araçlar kullandığında oluşturulur.

MessageDeltaTextUrlCitationDetails

Metin ileti dizisi içeriğinde kullanılan bir URL alıntısının temsili.

MessageImageFileContent

İş parçacığı iletisindeki görüntü dosyası içeriğinin gösterimi.

MessageImageFileDetails

İş parçacığı ileti içeriğinde gösterildiği gibi bir görüntü başvurusu.

MessageImageFileParam

Bir görüntü dosyası bloğu oluşturulurken dahili olarak yüklenmiş bir görüntü dosyasına nasıl başvurulacağını tanımlar.

MessageImageUrlParam

Bir resim URL'si bloğu oluşturulurken harici bir resim URL'sine nasıl başvurulacağını tanımlar.

MessageIncompleteDetails

Tamamlanmamış duruma giren bir ileti hakkında ek ayrıntı sağlayan bilgiler.

MessageInputContentBlock

İleti oluştururken tek bir içerik bloğu tanımlar. 'type' alanı bunun metin mi, resim dosyası mı yoksa dış resim URL'si mi olduğunu belirler.

MessageInputImageFileBlock

Yeni bir mesajda, dosya kimliğine göre dahili olarak yüklenen bir resme başvuran bir resim dosyası bloğu.

MessageInputImageUrlBlock

Yeni bir mesajda, harici bir resme URL'ye göre başvuran bir resim-URL bloğu.

MessageInputTextBlock

Yeni bir iletide düz metin içeriği içeren bir metin bloğu.

MessageTextAnnotation

Metin yazışması iletisi içeriğine ek açıklamanın soyut gösterimi.

MessageTextContent

İş parçacığı ileti içeriğinin metinsel öğesinin gösterimi.

MessageTextDetails

Aracı iş parçacığı ileti içeriğinin tek bir öğesi için metin ve ilişkili ek açıklamalar.

MessageTextFileCitationAnnotation

aracıyla veya iletiyle ilişkilendirilmiş belirli bir Dosyadan belirli bir alıntıyı işaret eden iletinin içindeki alıntı. Aracı dosyaları aramak için 'file_search' aracını kullandığında oluşturulur.

MessageTextFileCitationDetails

Metin dizisi ileti içeriğinin dosya tabanlı ek açıklamasında kullanılan dosya tabanlı metin alıntısının gösterimi.

MessageTextFilePathAnnotation

İletinin içinde, belirli bir yolda bulunan bir dosyayı işaret eden alıntı.

MessageTextFilePathDetails

İleti görüntüsü içeriği tarafından kullanılan görüntü dosyası kimliğinin kapsüllemesi.

MessageTextUrlCitationAnnotation

İleti içinde, iletiyle ilişkilendirilmiş belirli bir URL'ye işaret eden bir alıntı. Aracı, İnternet'te arama yapmak için 'bing_grounding' gibi araçlar kullandığında oluşturulur.

MessageTextUrlCitationDetails

Metin ileti dizisi içeriğinde kullanılan bir URL alıntısının temsili.

MessagesCreateMessageOptionalParams

İsteğe bağlı parametreler.

MessagesGetMessageOptionalParams

İsteğe bağlı parametreler.

MessagesListMessagesOptionalParams

İsteğe bağlı parametreler.

MessagesOperations

Mesajlar işlemlerini temsil eden arayüz.

MessagesUpdateMessageOptionalParams

İsteğe bağlı parametreler.

OpenApiAnonymousAuthDetails

OpenApi anonim kimlik doğrulaması için güvenlik ayrıntıları

OpenApiAuthDetails

OpenApiFunctionDefinition için kimlik doğrulama ayrıntıları

OpenApiConnectionAuthDetails

OpenApi bağlantı kimlik doğrulaması için güvenlik ayrıntıları

OpenApiConnectionSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

OpenApiFunctionDefinition

Openapi işlevinin giriş tanımı bilgileri.

OpenApiManagedAuthDetails

OpenApi managed_identity kimlik doğrulaması için güvenlik ayrıntıları

OpenApiManagedSecurityScheme

OpenApi managed_identity kimlik doğrulaması için güvenlik şeması

OpenApiToolDefinition

Aracıyı yapılandırmak için kullanılan OpenAPI aracının giriş tanımı bilgileri.

PageSettings

byPage yöntemi için seçenekler

PagedAsyncIterableIterator

Zaman uyumsuz yinelenebilir yinelemeye hem tamamlamaya hem de sayfaya izin veren bir arabirim.

PollingOptions

Yoklama davranışını yapılandırma seçenekleri.

PollingOptionsParams

Yoklama davranışını yapılandıran isteğe bağlı parametreler.

RequiredAction

Aracı iş parçacığı çalıştırmasının devam etmesi için gerekli eylemin soyut gösterimi.

RequiredFunctionToolCall

Bir çalıştırmanın değerlendirilmesine devam etmek için modelin ihtiyaç duyduğu bir işlev aracına istenen çağrının gösterimi.

RequiredFunctionToolCallDetails

İşlevin adını ve bağımsız değişkenlerini içeren, işlev aracını çağıran gerekli bir eylem tarafından sağlanan işlev çağrısının ayrıntılı bilgileri.

RequiredToolCall

Çalıştırmaya devam etmek için modelin ihtiyaç duyduğu bir araç çağırmasının soyut gösterimi.

ResponseFormatJsonSchema

Yanıt formatının amacına ilişkin bir açıklama, modelin bu formatta nasıl yanıt vereceğini belirlemesi için kullanılır.

ResponseFormatJsonSchemaType

Tanımlanan yanıt biçiminin türü: json_schema

RunCompletionUsage

Çalıştırmayla ilgili kullanım istatistikleri. Çalıştırma terminal durumunda değilse (örneğin, null, in_progressvb.) bu değer queued.

RunError

Aracı iş parçacığı çalıştırması tarafından karşılaşılan hatanın ayrıntıları.

RunStep

Aracı iş parçacığı çalıştırmasının tek bir adımı hakkında ayrıntılı bilgi.

RunStepAzureAISearchToolCall

Model tarafından, yürütülen Azure AI aramasını temsil eden tanımlı bir aracın değerlendirilmesinde verilen Azure AI Arama aracına yapılan çağrının kaydı.

RunStepBingGroundingToolCall

Bing topraklama aracına yapılan çağrının, model tarafından tanımlanan bir aracın değerlendirilmesinde verilen ve bing topraklama ile yürütülen aramayı temsil eden kaydı.

RunStepCodeInterpreterImageOutput

Model tarafından yapılan bir araç çağrısına yanıt olarak kod yorumlayıcı aracı tarafından yayılan bir görüntü çıktısının gösterimi.

RunStepCodeInterpreterImageReference

Model tarafından yapılan bir araç çağrısına yanıt olarak kod yorumlayıcı aracı tarafından yayılan görüntü başvurusu.

RunStepCodeInterpreterLogOutput

Model tarafından yapılan bir araç çağrısına yanıt olarak kod yorumlayıcı aracı tarafından yayılan günlük çıktısının gösterimi.

RunStepCodeInterpreterToolCall

Kod yorumlayıcısı tarafından tüketilen ve yayılan girişleri ve çıkışları temsil eden, tanımlı bir aracın değerlendirilmesinde model tarafından verilen bir kod yorumlayıcı aracına yapılan çağrının kaydı.

RunStepCodeInterpreterToolCallDetails

Model tarafından kod yorumlayıcı çağrısı hakkında ayrıntılı bilgiler.

RunStepCodeInterpreterToolCallOutput

Kod yorumlayıcı aracından yayılan çıkışın soyut gösterimi.

RunStepCompletionUsage

Çalıştırma adımıyla ilgili kullanım istatistikleri.

RunStepDelta

Bir akış çalıştırması adımı delta öbekindeki delta yükünü temsil eder.

RunStepDeltaChunk

Akış sırasında bir çalıştırma adımındaki değiştirilmiş alanlar gibi bir çalıştırma adımı deltasını temsil eder.

RunStepDeltaCodeInterpreterDetailItemObject

Akış çalıştırması adımının araç çağrılarındaki Kod Yorumlayıcı aracı çağrı verilerini temsil eder.

RunStepDeltaCodeInterpreterImageOutput

Kod yorumlayıcı aracı oluşturulurken ve bir akış çalıştırması adımının delta aracı çağrıları koleksiyonunda gösterildiği gibi bir görüntü çıkışını temsil eder.

RunStepDeltaCodeInterpreterImageOutputObject

Akış çalıştırması adımının Kod Yorumlayıcı aracı çağrı görüntüsü çıktısının verilerini temsil eder.

RunStepDeltaCodeInterpreterLogOutput

Kod Yorumlayıcı aracı tarafından üretilen ve akış çalıştırması adımının delta aracı çağrıları koleksiyonunda gösterildiği gibi bir günlük çıkışını temsil eder.

RunStepDeltaCodeInterpreterOutput

Akış çalıştırması aracı çağrısının Kod Yorumlayıcı araç çıkışının soyut temel gösterimi.

RunStepDeltaCodeInterpreterToolCall

Bir akış çalıştırması adımının araç çağrısı ayrıntıları içinde Kod Yorumlayıcı araç çağrısını temsil eder.

RunStepDeltaDetail

Akış çalıştırması adımının delta yükündeki tek bir çalıştırma adımı ayrıntı öğesini temsil eder.

RunStepDeltaFileSearchToolCall

Akış çalıştırması adımının araç çağrısı ayrıntıları içinde bir dosya arama aracı çağrısını temsil eder.

RunStepDeltaFunction

Bir akış çalıştırması adımı deltasının işlev aracı çağrısındaki işlev verilerini temsil eder.

RunStepDeltaFunctionToolCall

Akış çalıştırması adımının araç çağrısı ayrıntılarındaki bir işlev aracı çağrısını temsil eder.

RunStepDeltaMessageCreation

Akış çalıştırma adımı deltası içinde ileti oluşturmayı temsil eder.

RunStepDeltaMessageCreationObject

Akış çalıştırma adımı iletisi oluşturma yanıt nesnesi içindeki verileri temsil eder.

RunStepDeltaToolCall

Akış çalıştırma adımının delta araç çağrısı ayrıntılarındaki tek bir araç çağrısının soyut temel gösterimi.

RunStepDeltaToolCallObject

Akış çalıştırma adımının bir parçası olarak araç çağrılarının çağrısını temsil eder.

RunStepDetails

Çalıştırma adımının ayrıntılarının özet gösterimi.

RunStepError

Başarısız çalıştırma adımıyla ilişkili hata bilgileri.

RunStepFileSearchToolCall

Model tarafından, yürütülen dosya aramasını temsil eden, tanımlı bir aracın değerlendirilmesinde verilen bir dosya arama aracına yapılan çağrının kaydı.

RunStepFileSearchToolCallResult

Dosya arama aracı çağrı sonucu.

RunStepFileSearchToolCallResults

Dosya aramasının sonuçları.

RunStepFunctionToolCall

Model tarafından tanımlı bir aracın değerlendirilmesinde verilen ve belirtilen işlev tarafından tüketilen ve yayılan girişleri ve çıkışı temsil eden bir işlev aracı çağrısının kaydı.

RunStepFunctionToolCallDetails

Model tarafından çağrılan işlev hakkında ayrıntılı bilgiler.

RunStepMessageCreationDetails

İleti oluşturma çalıştırma adımıyla ilişkili ayrıntılı bilgiler.

RunStepMessageCreationReference

Çalıştırma adımının bir parçası olarak oluşturulan iletinin ayrıntıları.

RunStepOpenAPIToolCall

Yürütülen OpenAPI işlemlerini temsil eden, tanımlı bir aracın değerlendirilmesinde model tarafından verilen bir OpenAPI aracına yapılan çağrının kaydı.

RunStepToolCall

Mevcut bir çalıştırma için bir çalıştırma adımında kaydedilen ayrıntılı bir araç çağrısının soyut gösterimi.

RunStepToolCallDetails

Çalıştırma adımı çağırma araçlarıyla ilişkili ayrıntılı bilgiler.

RunStepsGetRunStepOptionalParams

İsteğe bağlı parametreler.

RunStepsListRunStepsOptionalParams

İsteğe bağlı parametreler.

RunStepsOperations

RunSteps işlemlerini temsil eden arabirim.

RunsCancelRunOptionalParams

İsteğe bağlı parametreler.

RunsCreateRunOptionalParams

İsteğe bağlı parametreler.

RunsGetRunOptionalParams

İsteğe bağlı parametreler.

RunsListRunsOptionalParams

İsteğe bağlı parametreler.

RunsOperations

Çalıştırma işlemlerini temsil eden arabirim.

RunsSubmitToolOutputsToRunOptionalParams

İsteğe bağlı parametreler.

RunsUpdateRunOptionalParams

İsteğe bağlı parametreler.

SubmitToolOutputsAction

Devam etmek için aracı iş parçacığı çalıştırması için gönderilmesi gereken gerekli araç çağrılarının ayrıntıları.

SubmitToolOutputsDetails

Araç çıkışlarını göndermek için çağrılması gereken araçları açıklayan ayrıntılar.

ThreadDeletionStatus

İş parçacığı silme işleminin durumu.

ThreadMessage

Aracı iş parçacığı içinde tek bir var olan ileti.

ThreadMessageOptions

Bir aracı iş parçacığı içinde, bu iş parçacığının ilk durumu için oluşturulması sırasında sağlanan tek bir ileti.

ThreadRun

Bir aracı iş parçacığının tek bir değerlendirme çalıştırmasını temsil eden veriler.

ThreadsCreateThreadOptionalParams

İsteğe bağlı parametreler.

ThreadsDeleteThreadOptionalParams

İsteğe bağlı parametreler.

ThreadsGetThreadOptionalParams

İsteğe bağlı parametreler.

ThreadsListThreadsOptionalParams

İsteğe bağlı parametreler.

ThreadsOperations

İş parçacığı işlemlerini temsil eden arabirim.

ThreadsUpdateThreadOptionalParams

İsteğe bağlı parametreler.

ToolDefinition

Bir aracının kullanabileceği giriş aracı tanımının soyut gösterimi.

ToolOutput

Bir araç sırasında sağlanan veriler, bekleyen araç çağrılarını çözümlemek ve modelin devam etmesi için gönderimi çıkış olarak verir.

ToolResources

Aracının araçları tarafından kullanılan bir kaynak kümesi. Kaynaklar araç türüne özeldir. Örneğin, code_interpreter araç bir dosya kimlikleri listesi gerektirirken file_search , araç vektör deposu kimliklerinin listesini gerektirir.

TruncationObject

Bir iş parçacığının çalıştırmadan önce nasıl kesileceğini denetler. Çalıştırmanın ilk bağlam penceresini denetlemek için bunu kullanın.

UpdateAgentOptionalParams

İsteğe bağlı parametreler.

VectorStore

Vektör deposu, araç tarafından file_search kullanılabilecek işlenmiş dosya koleksiyonudur.

VectorStoreAutoChunkingStrategyRequest

Varsayılan strateji. Bu strateji şu anda 800 max_chunk_size_tokens ve 400'ün chunk_overlap_tokens kullanır.

VectorStoreAutoChunkingStrategyResponse

Öbekleme stratejisi bilinmediğinde bu döndürülür. Bunun nedeni genellikle dosyanın API'de chunking_strategy kavramı kullanılmadan önce dizine eklenmiş olmasıdır.

VectorStoreChunkingStrategyRequest

Vektör deposu öbekleme stratejisi yapılandırmasının soyut gösterimi.

VectorStoreChunkingStrategyResponse

Vektör deposu öbekleme stratejisi yapılandırmasının soyut gösterimi.

VectorStoreConfiguration

Vektör depolama yapılandırması, kurumsal dosya arama için birden çok dosya kullanılabildiğinde kullanılan veri kaynaklarının listesidir.

VectorStoreConfigurations

Vektör depolama yapılandırmalarının listesini (azure varlık kimlikleri listesi) içeren yapı.

VectorStoreDataSource

Azure varlık URI yolunu içeren yapı ve kurumsal dosya araması için veri kaynağı olarak kullanılan dosyanın varlık türü.

VectorStoreDeletionStatus

Vektör depolarını silmek için yanıt nesnesi.

VectorStoreExpirationPolicy

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

VectorStoreFile

Vektör deposuna eklenmiş bir dosyanın açıklaması.

VectorStoreFileBatch

Vektör deposuna eklenmiş bir dosya grubu.

VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams

İsteğe bağlı parametreler.

VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams

İsteğe bağlı parametreler.

VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams

İsteğe bağlı parametreler.

VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams

İsteğe bağlı parametreler.

VectorStoreFileBatchesOperations

VectorStoreFileBatches işlemlerini temsil eden arabirim.

VectorStoreFileCount

Durumlarına göre gruplandırılmış olarak bu vektör deposu tarafından işlenen veya işlenen dosyaların sayısı.

VectorStoreFileDeletionStatus

Vektör deposu dosya ilişkisini silmek için yanıt nesnesi.

VectorStoreFileError

Bu vektör deposu için bir dosya işlenirken oluşan hatanın ayrıntıları

VectorStoreFilesCreateVectorStoreFileOptionalParams

İsteğe bağlı parametreler.

VectorStoreFilesDeleteVectorStoreFileOptionalParams

İsteğe bağlı parametreler.

VectorStoreFilesGetVectorStoreFileOptionalParams

İsteğe bağlı parametreler.

VectorStoreFilesListVectorStoreFilesOptionalParams

İsteğe bağlı parametreler.

VectorStoreFilesOperations

VectorStoreFiles işlemlerini temsil eden arabirim.

VectorStoreStaticChunkingStrategyOptions

Vektör deposu statik öbekleme stratejisi yapılandırma seçenekleri.

VectorStoreStaticChunkingStrategyRequest

Statik olarak yapılandırılmış bir öbekleme stratejisi.

VectorStoreStaticChunkingStrategyResponse

Statik olarak yapılandırılmış bir öbekleme stratejisi.

VectorStoresCreateVectorStoreOptionalParams

İsteğe bağlı parametreler.

VectorStoresDeleteVectorStoreOptionalParams

İsteğe bağlı parametreler.

VectorStoresGetVectorStoreOptionalParams

İsteğe bağlı parametreler.

VectorStoresListVectorStoresOptionalParams

İsteğe bağlı parametreler.

VectorStoresModifyVectorStoreOptionalParams

İsteğe bağlı parametreler.

VectorStoresOperations

VectorStores işlemlerini temsil eden arabirim.

Tür Diğer Adları

AgentEventStreamData

Aracıdaki bir akış olayı verilerini temsil eder.

AgentRunResponse

Aracı, akış desteğiyle yanıt çalıştırır.

AgentStreamEvent

AgentStreamEvent için Diğer Ad

AgentsNamedToolChoiceType

Araçlar adlı aracılar için kullanılabilir araç türleri.

AgentsResponseFormatMode

Modelin, bir araç çağrısının dönüş biçimini işleyeceği modu temsil eder.

AgentsResponseFormatOption

AgentResponseFormatOption için Diğer Ad

AgentsToolChoiceOption

AgentsToolChoiceOption için Diğer Ad

AgentsToolChoiceOptionMode

Araç seçiminin nasıl kullanılacağını belirtir

AzureAISearchQueryType

Azure AI Search aracı için kullanılabilir sorgu türleri.

ContinuablePage

Bir sonuç sayfasını açıklayan arabirim.

FileContents

İkili dosyanın içeriği için geçerli değerler.

FilePurpose

Bir dosyanın amaçlanan kullanımını gösteren olası değerler.

FileState

Dosyanın durumu.

ImageDetailLevel

Görüntünün ayrıntı düzeyini belirtir. 'Otomatik', 'düşük', 'yüksek' veya bilinmeyen bir gelecek değeri olabilir.

IncompleteDetailsReason

Çalıştırmanın tamamlanmamış olmasının nedeni. Bu, çalıştırma boyunca belirli bir belirteç sınırına ulaşıldığına işaret eder.

ListSortOrder

Yanıt nesnelerinin bir listesini isterken kullanılabilen sıralama seçenekleri.

MessageAttachmentToolDefinition

MessageAttachmentToolDefinition diğer adı

MessageBlockType

İleti içindeki içerik bloğunun türünü belirtir. Metin, bir resim dosyası, harici bir resim URL'si veya bilinmeyen bir gelecek türü olabilir.

MessageContentUnion

MessageContentUnion için Takma Ad

MessageDeltaContentUnion

MessageDeltaContentUnion için Diğer Ad

MessageDeltaTextAnnotationUnion

MessageDeltaTextAnnotationUnion için Diğer Ad

MessageIncompleteDetailsReason

Bir iletinin neden tamamlanmadı olarak işaretlendiğini açıklayan bir dizi neden.

MessageInputContent

MessageInputContent için Diğer Ad

MessageInputContentBlockUnion

MessageInputContentBlockUnion için Diğer Ad

MessageRole

Bir ileti dizisindeki iletilere atfedilen roller için olası değerler.

MessageStatus

Bir iş parçacığı iletisi için olası yürütme durumu değerleri.

MessageTextAnnotationUnion

MessageTextAnnotationUnion için Diğer Ad

OpenApiAuthDetailsUnion

OpenApiAuthDetailsUnion için diğer ad

OpenApiAuthType

OpenApi uç noktası için kimlik doğrulama türü. İzin verilen türler şunlardır:

  • Anonim (kimlik doğrulaması gerekmez)
  • Bağlantı (AI Foundry'de ayarlandığı gibi uç noktaya connection_id gerektirir)
  • Managed_Identity (kimlik tabanlı kimlik doğrulama için hedef kitle gerektirir)
RequiredActionUnion

RequiredActionUnion için Diğer Ad

RequiredToolCallUnion

RequiredToolCallUnion için Diğer Ad

ResponseFormat

Olası API yanıt biçimleri.

RunAdditionalFieldList

Yanıta eklenecek ek alanların listesi.

RunStatus

Bir aracı iş parçacığı çalıştırmasının durumu için olası değerler.

RunStepCodeInterpreterToolCallOutputUnion

RunStepCodeInterpreterToolCallOutputUnion için Diğer Ad

RunStepDeltaCodeInterpreterOutputUnion

RunStepDeltaCodeInterpreterOutputUnion için diğer ad

RunStepDeltaDetailUnion

RunStepDeltaDetailUnion için takma ad

RunStepDeltaToolCallUnion

RunStepDeltaToolCallUnion için diğer ad

RunStepDetailsUnion

RunStepDetailsUnion için takma ad

RunStepErrorCode

Başarısız bir çalıştırma adımına atfedilebilen olası hata kodu değerleri.

RunStepStatus

Bir çalıştırma adımının durumu için olası değerler.

RunStepToolCallUnion

RunStepToolCallUnion için diğer ad

RunStepType

Olası çalıştırma adımı türleri.

ToolDefinitionUnion

ToolDefinitionUnion için Diğer Ad

TruncationStrategy

İş parçacığı için olası kesme stratejileri.

VectorStoreChunkingStrategyRequestType

Parçalama stratejisi türü

VectorStoreChunkingStrategyRequestUnion

VectorStoreChunkingStrategyRequestUnion için Diğer Ad

VectorStoreChunkingStrategyResponseType

Parçalama stratejisi türü

VectorStoreChunkingStrategyResponseUnion

VectorStoreChunkingStrategyResponseUnion için Diğer Ad

VectorStoreExpirationPolicyAnchor

Bu vektör deposunun gün sayısı ile sona erme tarihi arasındaki ilişkiyi açıklar

VectorStoreFileBatchStatus

Vektör deposu dosyası toplu işleminin durumu.

VectorStoreFileErrorCode

Vektör deposu dosyası işleme için hata kodu varyantları

VectorStoreFileStatus

Vektör deposu dosya durumu

VectorStoreFileStatusFilter

Vektör deposu dosyası alma uç noktası için sorgu parametresi filtresi

VectorStoreStatus

Vektör deposu olası durumu

Numaralandırmalar

DoneEvent

Bir akışın başarılı sonunu gösteren terminal olayı.

ErrorEvent

Akış sırasında sunucu tarafı hatasını gösteren terminal olayı.

KnownVersions

Azure Yapay Zeka Aracıları API'si sürümleri

MessageStreamEvent

İleti işlemiyle ilgili akış olayları

RunStepStreamEvent

Adım işlemiyle ilgili akış olaylarını çalıştırma

RunStreamEvent

İşlemle ilgili akış olaylarını çalıştırma

ThreadStreamEvent

İş parçacığı işlemiyle ilgili akış olayları

VectorStoreDataSourceAssetType

Vektör depolama varlığının türü. Varlık türü bir uri_asset olabilir, bu durumda varlık URI kimliğini içermesi gerekir, id_asset durumunda veri kimliğini içermesi gerekir.

connectionToolType

Aracıyı yapılandırmak için kullanılan bağlantı araçları türleri

İşlevler

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Verilen çıkışın belirtilen türde olup olmadığını belirler.

İşlev Ayrıntıları

isOutputOfType<T>(ToolDefinitionUnion | RequiredAction | RequiredToolCall, string)

Verilen çıkışın belirtilen türde olup olmadığını belirler.

function isOutputOfType<T>(output: ToolDefinitionUnion | RequiredAction | RequiredToolCall, type: string): output

Parametreler

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

denetlenecek eylem; RequiredAction, RequiredToolCallveya ToolDefinitionUniontüründe olabilir.

type

string

Eylemin denetlenecek türü.

Döndürülenler

output

Eylemin belirtilen türde olup olmadığını gösteren boole değeri.