@azure/ai-agents package

Классы

AgentsClient
MCPTool	Средство, которое подключается к серверам протокола Model Context Protocol (MCP). Поддерживает динамическое управление подключениями к серверу MCP и разрешенными инструментами.
OpenApiTool	Инструмент, который извлекает информацию с использованием спецификаций OpenAPI. Этот класс, инициализированный начальным определением API (имя, описание, спецификация, аутентификация), также поддерживает динамическое добавление и удаление дополнительных определений API.
ToolSet	Представляет набор инструментов с их определениями и ресурсами.
ToolUtility	Класс служебной программы для создания различных инструментов.

Интерфейсы

AISearchIndexResource	Ресурс индекса поиска AI.
ActivityFunctionDefinition	Информация об определении действия для функции.
ActivityFunctionParameters	Параметры, используемые для определения функции действия.
Agent	Представляет агент, который может вызывать модель и использовать средства.
AgentDeletionStatus	Состояние операции удаления агента.
AgentErrorDetail	Описывает сведения об ошибках, возвращаемые API агентов.
AgentEventMessage	Каждое событие в потоке событий, отправляемых сервером event , имеет и data свойство: Example event: thread.created data: {"id": "thread_123", "object": "thread", ...} Мы генерируем события при создании нового объекта, переходе к новому состоянию или потоковой передаче в части (разностные). Например, при создании thread.run.created нового запуска, thread.run.completed при завершении выполнения и т. д. Когда агент решает создать сообщение во время прогона, мы отправляем , thread.message.created eventthread.message.in_progress событие, множество thread.message.delta событий и, наконецthread.message.completed, событие. С течением времени мы можем добавлять дополнительные события, поэтому мы рекомендуем правильно обрабатывать неизвестные события в коде.
AgentEventMessageStream	Представляет поток сообщения о событии агента.
AgentThread	Сведения о одном потоке, связанном с агентом.
AgentThreadCreationOptions	Сведения, используемые для создания потока агента.
AgentV1Error	Полезная нагрузка ошибки, возвращенная API агентов.
AgentsClientOptionalParams	Необязательные параметры для клиента.
AgentsNamedToolChoice	Указывает средство, которое должна использовать модель. Используйте для принудительного вызова модели определенного средства.
AgentsResponseFormat	Объект, описывающий ожидаемые выходные данные модели. Если json_object в run разрешено передавать только function тип tools . Если text модель может возвращать текст или любое необходимое значение.
AzureAISearchToolDefinition	Сведения об определении входных данных для средства поиска ИИ Azure, используемого для настройки агента.
AzureAISearchToolResource	Набор ресурсов индекса, используемых средством azure_ai_search.
AzureFunctionBinding	Структура для хранения имени очереди хранилища и URI.
AzureFunctionDefinition	Определение функции Azure.
AzureFunctionStorageQueue	Структура для хранения имени очереди хранилища и URI.
AzureFunctionToolCallDetails	Описание вызова функции Azure. Все поля присутствуют в завершенном шаге выполнения, однако только некоторые поля присутствуют в RunStepDeltaAzureFunctionToolCall.
AzureFunctionToolDefinition	Сведения об определении входных данных для средства функции Azure, используемого для настройки агента.
BingCustomSearchConfiguration	Пользовательская конфигурация поиска Bing.
BingCustomSearchToolDefinition	Входные данные определения для пользовательского средства поиска Bing, используемого для настройки агента.
BingCustomSearchToolParameters	Параметры пользовательского инструмента поиска bing.
BingGroundingSearchConfiguration	Поиск конфигурации для заземления Bing
BingGroundingSearchToolParameters	Параметры инструмента поиска заземления bing.
BingGroundingToolDefinition	Сведения об определении входных данных для средства поиска заземления bing, используемого для настройки агента.
BrowserAutomationToolCallDetails	Сведения о вызове средства автоматизации браузера.
BrowserAutomationToolCallStep	Описывает один шаг выполнения средства автоматизации браузера.
BrowserAutomationToolConnectionParameters	Определение входных параметров для соединения, используемого средством автоматизации браузера.
BrowserAutomationToolDefinition	Входные данные определения для средства автоматизации браузера, используемого для настройки агента.
BrowserAutomationToolParameters	Определение входных параметров для Browser Automation Tool.
CodeInterpreterToolDefinition	Сведения об определении входных данных для средства интерпретатора кода, используемого для настройки агента.
CodeInterpreterToolResource	Набор ресурсов, используемых средством code_interpreter.
ConnectedAgentDetails	Информация о подключении одного агента к другому в качестве инструмента
ConnectedAgentToolDefinition	Входная информация об определении для подключенного агента, который определяет субагента, специфичного для предметной области
CreateAgentOptionalParams	Необязательные параметры.
CreateThreadAndRunOptionalParams	Необязательные параметры.
DeepResearchBingGroundingConnection	Идентификатор ресурса подключения для ресурса заземления Bing .
DeepResearchDetails	Подробная информация об инструменте Deep Research.
DeepResearchToolDefinition	Входная информация об определении для инструмента глубокого исследования, используемого для настройки агента.
DeleteAgentOptionalParams	Необязательные параметры.
FabricDataAgentToolParameters	Параметры инструмента агента данных набора данных.
FileDeletionStatus	Ответ состояния операции удаления файла.
FileInfo	Представляет агент, который может вызывать модель и использовать средства.
FileListResponse	Данные ответа из операции списка файлов.
FileSearchRankingOptions	Параметры ранжирования для поиска файлов.
FileSearchToolCallContent	Объект содержимого результата поиска файла.
FileSearchToolDefinition	Сведения об определении входных данных для средства поиска файлов, используемых для настройки агента.
FileSearchToolDefinitionDetails	Параметры переопределяют средство поиска файлов.
FileSearchToolResource	Набор ресурсов, используемых средством file_search.
FilesDeleteFileOptionalParams	Необязательные параметры.
FilesGetFileContentOptionalParams	Необязательные параметры.
FilesGetFileOptionalParams	Необязательные параметры.
FilesListFilesOptionalParams	Необязательные параметры.
FilesOperations	Интерфейс, представляющий операции с файлами.
FilesUploadFileOptionalParams	Необязательные параметры.
FunctionArgument	Аргумент и описание функции.
FunctionDefinition	Сведения об определении входных данных для функции.
FunctionName	Имя функции, которое будет использоваться, если используется средство function
FunctionToolDefinition	Сведения об определении входных данных для средства функции, используемого для настройки агента.
GetAgentOptionalParams	Необязательные параметры.
IncompleteRunDetails	Сведения о том, почему выполнение является неполным. Будет null, если выполнение не является неполным.
ListAgentsOptionalParams	Необязательные параметры.
MCPApprovalPerTool	Настраиваемый объект утверждения MCP, список инструментов, требующих и не требующих утверждения
MCPToolDefinition	Входная информация об определении для инструмента MCP, который определяет конечную точку сервера MCP
MCPToolList	Объект, содержащий перечень инструментов для согласований.
MCPToolResource	Набор ресурсов, используемых средством mcp.
MessageAttachment	В этом разделе описывается, к каким средствам был присоединен файл.
MessageContent	Абстрактное представление одного элемента содержимого сообщения потока.
MessageDeletionStatus	Состояние операции удаления сообщения потока.
MessageDelta	Представляет типизированные полезные данные delta в блоке разностного сообщения потоковой передачи.
MessageDeltaChunk	Представляет разностную передачу сообщения, т. е. любые измененные поля в сообщении во время потоковой передачи.
MessageDeltaContent	Абстрактное базовое представление частичного потока полезных данных содержимого сообщения.
MessageDeltaImageFileContent	Представляет часть содержимого файла потокового изображения в блоке разностного сообщения потоковой передачи.
MessageDeltaImageFileContentObject	Представляет полезные данные image_file в содержимом файла потокового изображения.
MessageDeltaTextAnnotation	Абстрактное базовое представление заметок текстового содержимого потокового текста.
MessageDeltaTextContent	Представляет потоковое текстовое содержимое в блоке разностного сообщения потоковой передачи.
MessageDeltaTextContentObject	Представляет данные потокового текстового содержимого в блоке разностного сообщения потоковой передачи.
MessageDeltaTextFileCitationAnnotation	Представляет потоковую ссылку на файл, примененную к части содержимого потокового текста.
MessageDeltaTextFileCitationAnnotationObject	Представляет данные потоковой ссылки на файл, применяемые к части потокового текстового содержимого.
MessageDeltaTextFilePathAnnotation	Представляет заметку пути к потоковому файлу, примененную к части содержимого потокового текста.
MessageDeltaTextFilePathAnnotationObject	Представляет данные заметки о потоковом пути к файлу, примененные к части потокового текстового содержимого.
MessageDeltaTextUrlCitationAnnotation	Цитата в сообщении, указывающая на определенный URL-адрес, связанный с сообщением. Создается, когда агент использует такие инструменты, как 'bing_grounding' для поиска в Интернете.
MessageDeltaTextUrlCitationDetails	Представление ссылки на URL-адрес, используемое в содержимом текстового сообщения цепочки.
MessageImageFileContent	Представление содержимого файла изображения в сообщении потока.
MessageImageFileDetails	Ссылка на изображение, представленная в содержимом сообщения потока.
MessageImageFileParam	Определяет, как на внутренне загруженный файл изображения ссылаются при создании блока image-file.
MessageImageUrlParam	Определяет, как ссылаются на внешний URL изображения при создании блока image-URL.
MessageIncompleteDetails	Сведения о предоставлении дополнительных сведений о сообщении, вводя неполное состояние.
MessageInputContentBlock	Определяет один блок содержимого при создании сообщения. Поле "тип" определяет, является ли он текстом, файлом изображения или URL-адресом внешнего изображения и т. д.
MessageInputImageFileBlock	Блок image-file в новом сообщении, ссылающийся на внутренне загруженное изображение по идентификатору файла.
MessageInputImageUrlBlock	Блок image-URL в новом сообщении, ссылающийся на внешнее изображение по URL.
MessageInputTextBlock	Текстовый блок в новом сообщении, содержащий содержимое в виде обычного текста.
MessageTextAnnotation	Абстрактное представление заметки к содержимому сообщения текстового потока.
MessageTextContent	Представление текстового элемента содержимого сообщения потока.
MessageTextDetails	Текст и связанные заметки для одного элемента содержимого сообщения потока агента.
MessageTextFileCitationAnnotation	Ссылка в сообщении, указывающая на определенную цитату из определенного файла, связанного с агентом или сообщением. Создается при использовании агента средства "file_search" для поиска файлов.
MessageTextFileCitationDetails	Представление ссылки на текст на основе файлов, которое используется в заметке на основе файла содержимого текстового потока.
MessageTextFilePathAnnotation	Ссылка в сообщении, указывающая на файл, расположенный по определенному пути.
MessageTextFilePathDetails	Инкапсуляция идентификатора файла изображения, используемого содержимым изображения сообщения.
MessageTextUrlCitationAnnotation	Цитата в сообщении, указывающая на определенный URL-адрес, связанный с сообщением. Создается, когда агент использует такие инструменты, как 'bing_grounding' для поиска в Интернете.
MessageTextUrlCitationDetails	Представление ссылки на URL-адрес, используемое в содержимом текстового сообщения цепочки.
MessagesCreateMessageOptionalParams	Необязательные параметры.
MessagesDeleteOptionalParams	Необязательные параметры.
MessagesGetMessageOptionalParams	Необязательные параметры.
MessagesListMessagesOptionalParams	Необязательные параметры.
MessagesOperations	Интерфейс, представляющий операции с сообщениями.
MessagesUpdateMessageOptionalParams	Необязательные параметры.
MicrosoftFabricToolDefinition	Сведения об определении входных данных для средства Microsoft Fabric, используемого для настройки агента.
OpenApiAnonymousAuthDetails	Сведения о безопасности для анонимной проверки подлинности OpenApi
OpenApiAuthDetails	сведения о проверке подлинности для OpenApiFunctionDefinition
OpenApiConnectionAuthDetails	Сведения о безопасности для проверки подлинности подключения OpenApi
OpenApiConnectionSecurityScheme	Схема безопасности для проверки подлинности OpenApi managed_identity
OpenApiFunctionDefinition	Сведения об определении входных данных для функции openapi.
OpenApiManagedAuthDetails	Сведения о безопасности для проверки подлинности OpenApi managed_identity
OpenApiManagedSecurityScheme	Схема безопасности для проверки подлинности OpenApi managed_identity
OpenApiToolDefinition	Сведения об определении входных данных для средства OpenAPI, используемого для настройки агента.
PageSettings	Параметры метода byPage
PagedAsyncIterableIterator	Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.
PollingOptions	Параметры настройки поведения опроса.
PollingOptionsParams	Необязательные параметры, настраивающие поведение опроса.
RequiredAction	Абстрактное представление требуемого действия для продолжения выполнения потока агента.
RequiredFunctionToolCall	Представление запрошенного вызова средства функции, необходимого модели для продолжения оценки выполнения.
RequiredFunctionToolCallDetails	Подробные сведения о вызове функции, предоставляемые обязательным действием, вызывающим средство функции, которое включает имя и аргументы функции в функцию.
RequiredMcpToolCall	Представление запрошенного вызова к инструменту MCP, необходимого модели для продолжения вычисления выполнения.
RequiredToolCall	Абстрактное представление вызова средства, необходимого модели для продолжения выполнения.
ResponseFormatJsonSchema	Описание формата ответа, которое используется моделью для определения того, как отвечать в этом формате.
ResponseFormatJsonSchemaType	Тип формата ответа, который определяется: json_schema
RunCompletionUsage	Статистика использования, связанная с выполнением. Это значение будет null, если выполнение не находится в состоянии терминала (т. е. in_progress, queuedи т. д.).
RunError	Сведения об ошибке при выполнении потока агента.
RunStep	Подробные сведения о одном шаге запуска потока агента.
RunStepActivityDetails	Подробная информация, связанная с действиями шага выполнения.
RunStepAzureAISearchToolCall	Запись вызова средства поиска ИИ Azure, выданного моделью в оценке определенного инструмента, представляющего выполненный поиск по искусственному интеллекту Azure.
RunStepAzureFunctionToolCall	Запись вызова средства функции Azure.
RunStepBingCustomSearchToolCall	Запись вызова средства пользовательского поиска Bing, выданная моделью при оценке определенного средства, представляющая выполненный поиск с помощью пользовательского поиска Bing.
RunStepBingGroundingToolCall	Запись вызова средства заземления bing, выданного моделью в оценке определенного инструмента, представляющего выполненный поиск с заземлением bing.
RunStepBrowserAutomationToolCall	Запись вызова к средству автоматизации браузера, выполненный Агентом.
RunStepCodeInterpreterImageOutput	Представление выходных данных изображения, создаваемых средством интерпретатора кода в ответ на вызов средства моделью.
RunStepCodeInterpreterImageReference	Ссылка на изображения, выдаваемая средством интерпретатора кода в ответ на вызов средства моделью.
RunStepCodeInterpreterLogOutput	Представление выходных данных журнала, создаваемых средством интерпретатора кода в ответ на вызов средства моделью.
RunStepCodeInterpreterToolCall	Запись вызова средства интерпретатора кода, выданного моделью в оценке определенного инструмента, представляющего входные и выходные данные, потребляемые и создаваемые интерпретатором кода.
RunStepCodeInterpreterToolCallDetails	Подробные сведения о вызове интерпретатора кода моделью.
RunStepCodeInterpreterToolCallOutput	Абстрактное представление выходных данных из средства интерпретатора кода.
RunStepCompletionUsage	Статистика использования, связанная с шагом выполнения.
RunStepConnectedAgent	Подробная информация о вызове подключенного агента.
RunStepConnectedAgentToolCall	Запись звонка подключенному агенту.
RunStepDeepResearchToolCall	Запись вызова к инструменту глубокого исследования, выдаваемая моделью при оценке определенного инструмента, которая представляет выполненные операции глубокого исследования.
RunStepDeepResearchToolCallDetails	Подробная информация о глубоких исследовательских задачах, выполняемых моделью.
RunStepDelta	Представляет разностные полезные данные в блоке разностного шага потоковой передачи.
RunStepDeltaAzureAISearchToolCall	Представляет Поиск Azure AI на этапе выполнения потоковой передачи.
RunStepDeltaAzureFunctionToolCall	Представляет вызов средства функции Azure на шаге выполнения потоковой передачи.
RunStepDeltaBingGroundingToolCall	Представляет вызов средства заземления Bing на шаге выполнения потоковой передачи.
RunStepDeltaChunk	Представляет разностную смену шага выполнения, т. е. любые измененные поля на шаге выполнения во время потоковой передачи.
RunStepDeltaCodeInterpreterDetailItemObject	Представляет данные вызова средства интерпретатора кода в вызовах средства потоковой передачи.
RunStepDeltaCodeInterpreterImageOutput	Представляет выходные данные изображения, как создано средство интерпретатора кода и как представлено в коллекции разностных вызовов шага потоковой передачи.
RunStepDeltaCodeInterpreterImageOutputObject	Представляет данные для вывода выходных данных средства интерпретатора кода для потокового выполнения.
RunStepDeltaCodeInterpreterLogOutput	Представляет выходные данные журнала, созданные средством интерпретатора кода и представленные в коллекции разностных вызовов шага потоковой передачи.
RunStepDeltaCodeInterpreterOutput	Абстрактное базовое представление выходных данных средства интерпретатора кода для выполнения потоковой передачи.
RunStepDeltaCodeInterpreterToolCall	Представляет вызов средства интерпретатора кода в сведениях о вызове средства потоковой передачи.
RunStepDeltaConnectedAgentToolCall	Представляет вызов подключенного агента как часть шага выполнения потоковой передачи.
RunStepDeltaCustomBingGroundingToolCall	Представляет вызов средства пользовательского поиска Bing на шаге выполнения потоковой передачи.
RunStepDeltaDeepResearchToolCall	Представляет собой этап Глубокое исследование на этапе прогона потоковой передачи.
RunStepDeltaDetail	Представляет один элемент сведений о шаге выполнения в разностной полезных данных шага потоковой передачи.
RunStepDeltaFileSearchToolCall	Представляет вызов средства поиска файлов в сведениях о вызове средства потоковой передачи.
RunStepDeltaFunction	Представляет данные функции в вызове средства функции разностного шага потоковой передачи.
RunStepDeltaFunctionToolCall	Представляет вызов средства функции в сведениях о вызове средства потоковой передачи.
RunStepDeltaMCPObject	Представляет собой вызов mcp как часть шага выполнения потоковой передачи.
RunStepDeltaMcpToolCall	Представляет данные функции в вызове MCP шага выполнения потоковой передачи.
RunStepDeltaMessageCreation	Представляет создание сообщения в разностном шаге выполнения потоковой передачи.
RunStepDeltaMessageCreationObject	Представляет данные в объекте ответа на шаг выполнения потоковой передачи.
RunStepDeltaMicrosoftFabricToolCall	Представляет вызов средства Microsoft Fabric на шаге выполнения потоковой передачи.
RunStepDeltaOpenAPIObject	Представляет собой вызов openapi как часть шага выполнения потоковой передачи.
RunStepDeltaOpenAPIToolCall	Представляет вызов средства openapi на шаге выполнения потоковой передачи.
RunStepDeltaSharepointToolCall	Представляет вызов средства SharePoint на шаге выполнения потоковой передачи.
RunStepDeltaToolCall	Абстрактное базовое представление вызова одного средства в разностном вызове шага потоковой передачи.
RunStepDeltaToolCallObject	Представляет вызов вызовов инструментов в рамках шага выполнения потоковой передачи.
RunStepDetails	Абстрактное представление сведений о шаге выполнения.
RunStepDetailsActivity	Представляет собой список действий, связанных с данным шагом.
RunStepError	Сведения об ошибке, связанные с неудачным этапом выполнения.
RunStepFileSearchToolCall	Запись вызова средства поиска файлов, выданная моделью при оценке определенного средства, представляющего выполненный поиск файлов.
RunStepFileSearchToolCallResult	Результат вызова средства поиска файлов.
RunStepFileSearchToolCallResults	Результаты поиска файла.
RunStepFunctionToolCall	Запись вызова средства функции, выданного моделью в оценке определенного инструмента, представляющего входные и выходные данные, потребляемые и создаваемые указанной функцией.
RunStepFunctionToolCallDetails	Подробные сведения о функции, вызываемой моделью.
RunStepMcpToolCall	Запись вызова инструмента MCP, выдаваемая моделью при оценке определенного инструмента, представляющая выполненные действия MCP.
RunStepMessageCreationDetails	Подробные сведения, связанные с шагом запуска создания сообщения.
RunStepMessageCreationReference	Сведения о сообщении, созданном в рамках шага выполнения.
RunStepMicrosoftFabricToolCall	Запись вызова средства Microsoft Fabric, выданного моделью в оценке определенного инструмента, представляющего выполняемые операции Microsoft Fabric.
RunStepOpenAPIToolCall	Запись вызова средства OpenAPI, выдаваемая моделью при оценке определенного средства, которая представляет выполненные операции OpenAPI.
RunStepSharepointToolCall	Запись вызова средства SharePoint, выданного моделью в оценке определенного средства, представляющего выполненные действия SharePoint.
RunStepToolCall	Абстрактное представление подробного вызова средства, записанного в шаге выполнения для существующего запуска.
RunStepToolCallDetails	Подробные сведения, связанные с средствами вызова шага выполнения.
RunStepsGetRunStepOptionalParams	Необязательные параметры.
RunStepsListRunStepsOptionalParams	Необязательные параметры.
RunStepsOperations	Интерфейс, представляющий операции RunSteps.
RunsCancelRunOptionalParams	Необязательные параметры.
RunsCreateRunOptionalParams	Необязательные параметры.
RunsGetRunOptionalParams	Необязательные параметры.
RunsListRunsOptionalParams	Необязательные параметры.
RunsOperations	Интерфейс, представляющий операции Runs.
RunsSubmitToolOutputsToRunOptionalParams	Необязательные параметры.
RunsUpdateRunOptionalParams	Необязательные параметры.
SharepointGroundingToolParameters	Параметры инструмента заземления SharePoint.
SharepointToolDefinition	Сведения об определении входных данных для инструмента SharePoint, используемого для настройки агента.
SubmitToolApprovalAction	Сведения о требуемом утверждении вызова средства, которые необходимо отправить для продолжения выполнения потока агента.
SubmitToolApprovalDetails	Детали с описанием инструментов, которые должны быть одобрены.
SubmitToolOutputsAction	Сведения о необходимых вызовах инструментов, которые должны быть отправлены для запуска потока агента для продолжения.
SubmitToolOutputsDetails	Сведения, описывающие средства, которые должны вызываться для отправки выходных данных средства.
ThreadDeletionStatus	Состояние операции удаления потока.
ThreadMessage	Одно существующее сообщение в потоке агента.
ThreadMessageOptions	Одно сообщение в потоке агента, как указано во время создания этого потока для исходного состояния.
ThreadRun	Данные, представляющие единый запуск оценки потока агента.
ThreadsCreateThreadOptionalParams	Необязательные параметры.
ThreadsDeleteThreadOptionalParams	Необязательные параметры.
ThreadsGetThreadOptionalParams	Необязательные параметры.
ThreadsListThreadsOptionalParams	Необязательные параметры.
ThreadsOperations	Интерфейс, представляющий собой операции Threads.
ThreadsUpdateThreadOptionalParams	Необязательные параметры.
ToolApproval	Данные, предоставленные во время отправки средства, разрешают ожидающие вызовы инструментов и позволяют модели продолжаться.
ToolConnection	Ресурс подключения.
ToolDefinition	Абстрактное представление определения средства ввода, которое может использовать агент.
ToolOutput	Данные, предоставленные во время отправки средства, разрешают ожидающие вызовы инструментов и позволяют модели продолжаться.
ToolResources	Набор ресурсов, используемых средствами агента. Ресурсы относятся к типу инструмента. Например, для code_interpreter средства требуется список идентификаторов файлов, а для file_search этого средства требуется список идентификаторов векторного хранилища.
TruncationObject	Определяет, как поток будет усечен до выполнения. Используйте это для управления начальным окном контекста выполнения.
UpdateAgentOptionalParams	Необязательные параметры.
VectorStore	Векторное хранилище — это коллекция обработанных файлов, которые можно использовать file_search средством.
VectorStoreAutoChunkingStrategyRequest	Стратегия по умолчанию. В настоящее время эта стратегия использует max_chunk_size_tokens 800 и chunk_overlap_tokens 400.
VectorStoreAutoChunkingStrategyResponse	Это возвращается, когда стратегия блокирования неизвестна. Как правило, это связано с тем, что файл был индексирован до того, как в API появилась концепция chunking_strategy.
VectorStoreChunkingStrategyRequest	Абстрактное представление конфигурации стратегии блокирования хранилища векторов.
VectorStoreChunkingStrategyResponse	Абстрактное представление конфигурации стратегии блокирования хранилища векторов.
VectorStoreConfiguration	Конфигурация хранилища векторов — это список источников данных, используемых при использовании нескольких файлов для поиска корпоративных файлов.
VectorStoreConfigurations	Структура, содержащая список конфигураций векторного хранилища, т. е. список идентификаторов активов Azure.
VectorStoreDataSource	Структура, содержащая путь URI ресурса Azure и тип ресурса, используемый в качестве источника данных для поиска корпоративных файлов.
VectorStoreDeletionStatus	Объект ответа для удаления векторного хранилища.
VectorStoreExpirationPolicy	Политика истечения срока действия для хранилища векторов.
VectorStoreFile	Описание файла, присоединенного к хранилищу векторов.
VectorStoreFileBatch	Пакет файлов, присоединенных к хранилищу векторов.
VectorStoreFileBatchesCancelVectorStoreFileBatchOptionalParams	Необязательные параметры.
VectorStoreFileBatchesCreateVectorStoreFileBatchOptionalParams	Необязательные параметры.
VectorStoreFileBatchesGetVectorStoreFileBatchOptionalParams	Необязательные параметры.
VectorStoreFileBatchesListVectorStoreFileBatchFilesOptionalParams	Необязательные параметры.
VectorStoreFileBatchesOperations	Интерфейс, представляющий операции VectorStoreFileBatches.
VectorStoreFileCount	Количество обработанных или обработанных данным векторным хранилищем векторов, сгруппированных по состоянию.
VectorStoreFileDeletionStatus	Объект ответа для удаления связи файлов хранилища векторов.
VectorStoreFileError	Сведения об ошибке, которая, возможно, произошла при обработке файла для этого векторного хранилища
VectorStoreFilesCreateVectorStoreFileOptionalParams	Необязательные параметры.
VectorStoreFilesDeleteVectorStoreFileOptionalParams	Необязательные параметры.
VectorStoreFilesGetVectorStoreFileOptionalParams	Необязательные параметры.
VectorStoreFilesListVectorStoreFilesOptionalParams	Необязательные параметры.
VectorStoreFilesOperations	Интерфейс, представляющий операции VectorStoreFiles.
VectorStoreStaticChunkingStrategyOptions	Параметры настройки стратегии статического фрагментирования хранилища векторов.
VectorStoreStaticChunkingStrategyRequest	Статическая настроенная стратегия блокирования.
VectorStoreStaticChunkingStrategyResponse	Статическая настроенная стратегия блокирования.
VectorStoresCreateVectorStoreOptionalParams	Необязательные параметры.
VectorStoresDeleteVectorStoreOptionalParams	Необязательные параметры.
VectorStoresGetVectorStoreOptionalParams	Необязательные параметры.
VectorStoresListVectorStoresOptionalParams	Необязательные параметры.
VectorStoresModifyVectorStoreOptionalParams	Необязательные параметры.
VectorStoresOperations	Интерфейс, представляющий операции VectorStores.

Псевдонимы типа

AgentEventStreamData	Представляет данные события потока в агенте.
AgentRunResponse	Ответ агента выполняется с поддержкой потоковой передачи.
AgentStreamEvent	Псевдоним для AgentStreamEvent
AgentsNamedToolChoiceType	Доступные типы инструментов для агентов с именем tools.
AgentsResponseFormatMode	Представляет режим, в котором модель будет обрабатывать формат возврата вызова инструмента.
AgentsResponseFormatOption	Псевдоним для AgentsResponseFormatOption
AgentsToolChoiceOption	Псевдоним для AgentsToolChoiceOption
AgentsToolChoiceOptionMode	Указывает, как будет использоваться выбранный инструмент
AzureAISearchQueryType	Доступные типы запросов для средства поиска Azure AI.
ContinuablePage	Интерфейс, описывающий страницу результатов.
FileContents	Допустимые значения для содержимого двоичного файла.
FilePurpose	Возможные значения, обозначающие предполагаемое использование файла.
FileState	Состояние файла.
ImageDetailLevel	Задает уровень детализации изображения. Может быть 'auto', 'low', 'high' или неизвестное будущее значение.
IncompleteDetailsReason	Причина, по которой выполнение является неполным. Это указывает, какой определенный предел маркера был достигнут в течение выполнения.
ListSortOrder	Доступные варианты сортировки при запросе списка объектов ответа.
MCPRequiredApproval	Псевдоним для MCPRequiredApproval
MessageAttachmentToolDefinition	Псевдоним для MessageAttachmentToolDefinition
MessageBlockType	Указывает тип блока содержимого в сообщении. Это может быть текст, файл изображения, внешний URL-адрес изображения или неизвестный будущий тип.
MessageContentUnion	Псевдоним для MessageContentUnion
MessageDeltaContentUnion	Псевдоним для MessageDeltaContentUnion
MessageDeltaTextAnnotationUnion	Псевдоним для MessageDeltaTextAnnotationUnion
MessageIncompleteDetailsReason	Набор причин, объясняющих, почему сообщение помечено как незавершенное.
MessageInputContent	Псевдоним для MessageInputContent
MessageInputContentBlockUnion	Псевдоним для MessageInputContentBlockUnion
MessageRole	Возможные значения ролей, приписываемых сообщениям в цепочке.
MessageStatus	Возможные значения состояния выполнения для сообщения потока.
MessageTextAnnotationUnion	Псевдоним для MessageTextAnnotationUnion
OpenApiAuthDetailsUnion	Псевдоним для OpenApiAuthDetailsUnion
OpenApiAuthType	Тип аутентификации для конечной точки OpenApi. Разрешенные типы: Анонимный (аутентификация не требуется) Подключение (требуется connection_id к конечной точке, как указано в AI Foundry) Managed_Identity (требуется аудитория для аутентификации на основе удостоверений)
RequiredActionUnion	Псевдоним для RequiredActionUnion
RequiredToolCallUnion	Псевдоним для RequiredToolCallUnion
ResponseFormat	Возможные форматы ответов API.
RunAdditionalFieldList	Список дополнительных полей для включения в ответ.
RunStatus	Возможные значения состояния выполнения потока агента.
RunStepCodeInterpreterToolCallOutputUnion	Псевдоним для RunStepCodeInterpreterToolCallOutputUnion
RunStepDeltaCodeInterpreterOutputUnion	Псевдоним для RunStepDeltaCodeInterpreterOutputUnion
RunStepDeltaDetailUnion	Псевдоним для RunStepDeltaDetailUnion
RunStepDeltaToolCallUnion	Псевдоним для RunStepDeltaToolCallUnion
RunStepDetailsUnion	Псевдоним для RunStepDetailsUnion
RunStepErrorCode	Возможные значения кодов ошибок, связанные с неудачным выполнением шага.
RunStepStatus	Возможные значения состояния шага выполнения.
RunStepToolCallUnion	Псевдоним для RunStepToolCallUnion
RunStepType	Возможные типы шагов выполнения.
ToolDefinitionUnion	Псевдоним для ToolDefinitionUnion
TruncationStrategy	Возможные стратегии усечения потока.
VectorStoreChunkingStrategyRequestType	Тип стратегии дробления
VectorStoreChunkingStrategyRequestUnion	Псевдоним для VectorStoreChunkingStrategyRequestUnion
VectorStoreChunkingStrategyResponseType	Тип стратегии дробления
VectorStoreChunkingStrategyResponseUnion	Псевдоним для VectorStoreChunkingStrategyResponseUnion
VectorStoreExpirationPolicyAnchor	Описывает взаимосвязь между днями и истечением срока действия этого векторного хранилища
VectorStoreFileBatchStatus	Состояние пакета файла векторного хранилища.
VectorStoreFileErrorCode	Варианты кодов ошибок для обработки файлов векторного хранилища
VectorStoreFileStatus	Состояние файла векторного хранилища
VectorStoreFileStatusFilter	Фильтр параметров запроса для конечной точки извлечения файла векторного хранилища
VectorStoreStatus	Возможное состояние векторного хранилища

Перечисления

DoneEvent	Событие терминала, указывающее успешный конец потока.
ErrorEvent	Событие терминала, указывающее на ошибку на стороне сервера во время потоковой передачи.
KnownVersions	Версии API агентов Azure AI
MessageStreamEvent	Операции, связанные с потоковой передачей сообщений
RunStepStreamEvent	Выполнение событий потоковой передачи, связанных с шагами
RunStreamEvent	Выполнение событий потоковой передачи, связанных с операцией
ThreadStreamEvent	Операции потока, связанные с событиями потоковой передачи
VectorStoreDataSourceAssetType	Тип ресурса векторного хранилища. Тип актива может быть uri_asset, в этом случае он должен содержать идентификатор URI актива, в случае id_asset он должен содержать идентификатор данных.
connectionToolType	Типы средств подключения, используемых для настройки агента

Функции

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

Определяет, является ли указанный результат указанным типом.

Сведения о функции

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

Определяет, является ли указанный результат указанным типом.

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

Параметры

output

ToolDefinitionUnion | RequiredAction | RequiredToolCall

Действие для проверки, которое может быть типом RequiredAction, RequiredToolCallили ToolDefinitionUnion.

type

string

Тип для проверки действия.

Возвращаемое значение

output

Логическое значение, указывающее, является ли действие указанным типом.