@azure/ai-projects package

Классы

AIProjectClient

получает клиент OpenAI с опциональными опциями клиента OpenAI

Интерфейсы

@azure/ai-projects.Index
A2APreviewTool

Агент, реализующий протокол A2A.

AIProjectClientOptionalParams

Необязательные параметры для клиента.

AISearchIndexResource

Ресурс индекса поиска AI.

Agent

Агент интерфейса модели

AgentBlueprintReference

интерфейс модели AgentBlueprintReference

AgentCard

Интерфейс модели AgentCard

AgentCardSkill

интерфейс модели AgentCardSkill

AgentClusterInsightRequest

Анализ набора результатов оценки операторов

AgentClusterInsightResult

Выводы из кластерного анализа агентов.

AgentDefinition

Интерфейс базового определения для агентов. Содержит тип агента и необязательную конфигурацию RAI.

AgentEndpoint

интерфейс модели AgentEndpoint

AgentEndpointAuthorizationScheme

model interface AgentEndpointAuthorizationScheme

AgentIdentity

AgentIdentity интерфейса модели

AgentSessionResource

Сессия агента, обеспечивающая долгоживущую вычислительную песочницу для размещенных вызовов агентов.

AgentTaxonomyInput

Конфигурация входных данных для таксономии оценки, если тип ввода — agent.

AgentVersion

Представляет определенную версию агента. Включает метаданные, управление версиями, время создания и определение агента.

AgenticIdentityPreviewCredentials

Определение учетных данных удостоверения агента

AgentsCreateAgentFromManifestOptionalParams

Необязательные параметры.

AgentsCreateAgentVersionFromManifestOptionalParams

Необязательные параметры.

AgentsCreateOptionalParams

Необязательные параметры.

AgentsCreateVersionOptionalParams

Необязательные параметры.

AgentsDeleteOptionalParams

Необязательные параметры.

AgentsDeleteVersionOptionalParams

Необязательные параметры.

AgentsGetOptionalParams

Необязательные параметры.

AgentsGetVersionOptionalParams

Необязательные параметры.

AgentsListOptionalParams

Необязательные параметры.

AgentsListVersionsOptionalParams

Необязательные параметры.

AgentsOperations

Интерфейс, представляющий операции агентов.

AgentsUpdateAgentFromManifestOptionalParams

Необязательные параметры.

AgentsUpdateOptionalParams

Необязательные параметры.

ApiErrorResponse

Ответ об ошибке при сбоях API.

ApiKeyCredentials

Определение учетных данных ключа API

ApplyPatchToolParam

Позволяет ассистенту создавать, удалять или обновлять файлы с помощью унифицированных дифференциальностей.

ApproximateLocation

интерфейс модели ApproximateLocation

AutoCodeInterpreterToolParam

Настройка контейнера интерпретатора кода. При необходимости укажите идентификаторы файлов для запуска кода.

AzureAIAgentTarget

Представляет цель, указывающую агент AI Azure.

AzureAIModelTarget

Представляет цель, указывающую модель Azure AI для операций, требующих выбора модели.

AzureAISearchIndex

Поиск с использованием ИИ Azure Index Definition

AzureAISearchTool

Входная информация о определении для инструмента поиска Azure AI, используемого для настройки агента.

AzureAISearchToolResource

Набор ресурсов индекса, используемых средством azure_ai_search.

AzureAgentConfig

Параметры конфигурации для endpoint агента метода getOpenAIClient. В основном используется для размещённых агентов.

AzureFunctionBinding

Структура хранения имени очереди storage и URI.

AzureFunctionDefinition

Определение функции Azure.

AzureFunctionStorageQueue

Структура хранения имени очереди storage и URI.

AzureFunctionTool

Входная информация о определении для инструмента функции Azure, используемая для настройки агента.

AzureOpenAIModelConfiguration

Azure OpenAI model configuration. Версия API будет выбрана сервисом для запроса модели.

BaseCredentials

Базовый класс для учетных данных подключения

BetaAgentsCreateSessionOptionalParams

Необязательные параметры.

BetaAgentsDeleteSessionFileOptionalParams

Необязательные параметры.

BetaAgentsDeleteSessionOptionalParams

Необязательные параметры.

BetaAgentsDownloadSessionFileOptionalParams

Необязательные параметры.

BetaAgentsGetSessionOptionalParams

Необязательные параметры.

BetaAgentsListSessionFilesOptionalParams

Необязательные параметры.

BetaAgentsListSessionsOptionalParams

Необязательные параметры.

BetaAgentsOperations

Интерфейс, представляющий операции BetaAgents.

BetaAgentsPatchAgentObjectOptionalParams

Необязательные параметры.

BetaAgentsUploadSessionFileOptionalParams

Необязательные параметры.

BetaEvaluationTaxonomiesCreateOptionalParams

Необязательные параметры.

BetaEvaluationTaxonomiesDeleteOptionalParams

Необязательные параметры.

BetaEvaluationTaxonomiesGetOptionalParams

Необязательные параметры.

BetaEvaluationTaxonomiesListOptionalParams

Необязательные параметры.

BetaEvaluationTaxonomiesOperations

Интерфейс, представляющий операции BetaEvaluationTaxonomies.

BetaEvaluationTaxonomiesUpdateOptionalParams

Необязательные параметры.

BetaEvaluatorsCreateVersionOptionalParams

Необязательные параметры.

BetaEvaluatorsDeleteVersionOptionalParams

Необязательные параметры.

BetaEvaluatorsGetVersionOptionalParams

Необязательные параметры.

BetaEvaluatorsListOptionalParams

Необязательные параметры.

BetaEvaluatorsListVersionsOptionalParams

Необязательные параметры.

BetaEvaluatorsOperations

Интерфейс, представляющий операции BetaEvaluators.

BetaEvaluatorsUpdateVersionOptionalParams

Необязательные параметры.

BetaInsightsGenerateOptionalParams

Необязательные параметры.

BetaInsightsGetOptionalParams

Необязательные параметры.

BetaInsightsListOptionalParams

Необязательные параметры.

BetaInsightsOperations

Интерфейс, представляющий операции BetaInsights.

BetaMemoryStoresCreateOptionalParams

Необязательные параметры.

BetaMemoryStoresDeleteOptionalParams

Необязательные параметры.

BetaMemoryStoresDeleteScopeOptionalParams

Необязательные параметры.

BetaMemoryStoresGetOptionalParams

Необязательные параметры.

BetaMemoryStoresGetUpdateResultOptionalParams

Необязательные параметры.

BetaMemoryStoresListOptionalParams

Необязательные параметры.

BetaMemoryStoresOperations

Интерфейс, представляющий операции BetaMemoryStores.

BetaMemoryStoresSearchMemoriesOptionalParams

Необязательные параметры.

BetaMemoryStoresUpdateMemoriesOptionalParams

Необязательные параметры.

BetaMemoryStoresUpdateOptionalParams

Необязательные параметры.

BetaOperations

Интерфейс, представляющий бета-операции.

BetaRedTeamsCreateOptionalParams

Необязательные параметры.

BetaRedTeamsGetOptionalParams

Необязательные параметры.

BetaRedTeamsListOptionalParams

Необязательные параметры.

BetaRedTeamsOperations

Интерфейс, представляющий операции BetaRedTeams.

BetaSchedulesCreateOrUpdateOptionalParams

Необязательные параметры.

BetaSchedulesDeleteOptionalParams

Необязательные параметры.

BetaSchedulesGetOptionalParams

Необязательные параметры.

BetaSchedulesGetRunOptionalParams

Необязательные параметры.

BetaSchedulesListOptionalParams

Необязательные параметры.

BetaSchedulesListRunsOptionalParams

Необязательные параметры.

BetaSchedulesOperations

Интерфейс, представляющий операции BetaSchedules.

BetaSkillsCreateOptionalParams

Необязательные параметры.

BetaSkillsDeleteOptionalParams

Необязательные параметры.

BetaSkillsDownloadOptionalParams

Необязательные параметры.

BetaSkillsGetOptionalParams

Необязательные параметры.

BetaSkillsListOptionalParams

Необязательные параметры.

BetaSkillsOperations

Интерфейс, представляющий операции BetaSkills.

BetaSkillsUpdateOptionalParams

Необязательные параметры.

BetaToolboxesCreateVersionOptionalParams

Необязательные параметры.

BetaToolboxesDeleteOptionalParams

Необязательные параметры.

BetaToolboxesDeleteVersionOptionalParams

Необязательные параметры.

BetaToolboxesGetOptionalParams

Необязательные параметры.

BetaToolboxesGetVersionOptionalParams

Необязательные параметры.

BetaToolboxesListOptionalParams

Необязательные параметры.

BetaToolboxesListVersionsOptionalParams

Необязательные параметры.

BetaToolboxesOperations

Интерфейс, представляющий операции BetaToolboxes.

BetaToolboxesUpdateOptionalParams

Необязательные параметры.

BingCustomSearchConfiguration

Конфигурация пользовательского поиска bing.

BingCustomSearchPreviewTool

Сведения об определении входных данных для Bing пользовательского средства поиска, используемого для настройки агента.

BingCustomSearchToolParameters

Параметры пользовательского средства поиска bing.

BingGroundingSearchConfiguration

Настройка поиска для Bing Заземления

BingGroundingSearchToolParameters

Параметры средства поиска bing заземления.

BingGroundingTool

Сведения об определении входных данных для средства поиска bing приземления, используемого для настройки агента.

BlobReference

Сведения о ссылке на BLOB-объекты.

BotServiceAuthorizationScheme

model interface BotServiceAuthorizationScheme

BotServiceRbacAuthorizationScheme

model interface BotServiceRbacAuthorizationScheme

BrowserAutomationPreviewTool

Входные данные определения для средства автоматизации браузера, используемого для настройки агента.

BrowserAutomationToolConnectionParameters

Определение входных параметров для соединения, используемого средством автоматизации браузера.

BrowserAutomationToolParameters

Определение входных параметров для Browser Automation Tool.

CaptureStructuredOutputsTool

Инструмент для фиксации структурированных выходных данных

ChartCoordinate

Координаты для диаграммы анализа.

ChatSummaryMemoryItem

Элемент памяти, содержащий сводку, извлеченную из бесед.

ClusterInsightResult

Выводы из кластерного анализа.

ClusterTokenUsage

Использование токенов для кластерного анализа

CodeBasedEvaluatorDefinition

Определение оценщика на основе кода с использованием кода Python

CodeConfiguration

Конфигурация развертывания на основе кода для размещённого агента.

CodeInterpreterTool

Инструмент, который запускает код на Python, помогающий сгенерировать ответ на запрос.

ComparisonFilter

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

CompoundFilter

Объединение нескольких фильтров с помощью and или or.

ComputerTool

Средство управления виртуальным компьютером. Узнайте больше о компьютерном инструменте.

ComputerUsePreviewTool

Средство управления виртуальным компьютером. Узнайте больше о компьютерном инструменте.

Connection

Ответ из списка и операции получения соединений

ConnectionsGetDefaultOptionalParams

Опциональные параметры для getDefault.

ConnectionsGetOptionalParams

Необязательные параметры.

ConnectionsGetWithCredentialsOptionalParams

Необязательные параметры.

ConnectionsListOptionalParams

Необязательные параметры.

ConnectionsOperations

Интерфейс, представляющий операции Connections.

ContainerAutoParam

интерфейс модели ContainerAutoParam

ContainerConfiguration

Конфигурация развертывания на основе контейнера для размещённого агента.

ContainerNetworkPolicyAllowlistParam

model interface ContainerNetworkPolicyAllowlistParam

ContainerNetworkPolicyDisabledParam

Model interface ContainerNetworkPolicyDisabledParam

ContainerNetworkPolicyDomainSecretParam

model interface ContainerNetworkPolicyDomainSecretParam

ContainerNetworkPolicyParam

Политика доступа к сети для контейнера.

ContainerSkill

интерфейс модели ContainerSkill

ContinuousEvaluationRuleAction

Действие правила оценки для непрерывной оценки.

CosmosDBIndex

Определение индекса векторного хранилища CosmosDB

CreateFromPackageOptionalParams

Необязательные параметры.

CronTrigger

Триггер на основе cron.

CustomCredential

Определение пользовательских учетных данных

CustomGrammarFormatParam

Грамматика, определяемая пользователем.

CustomTextFormatParam

Неограниченный свободный текст.

CustomToolParam

Пользовательский инструмент, который обрабатывает вводные данные в заданном формате. Дополнительные сведения о средствах custom

CustomToolParamFormat

Формат ввода для пользовательского инструмента. По умолчанию текст без ограничений.

DailyRecurrenceSchedule

Ежедневный график повторения.

DatasetCredential

Представляет ссылку на большой двоичный объект для использования

DatasetUploadOptions

Варианты загрузки наборов данных

DatasetVersion

Определение DatasetVersion

DatasetsCreateOrUpdateOptionalParams

Необязательные параметры.

DatasetsDeleteOptionalParams

Необязательные параметры.

DatasetsGetCredentialsOptionalParams

Необязательные параметры.

DatasetsGetOptionalParams

Необязательные параметры.

DatasetsListOptionalParams

Необязательные параметры.

DatasetsListVersionsOptionalParams

Необязательные параметры.

DatasetsOperations

Интерфейс, представляющий операции с наборами данных.

DatasetsPendingUploadOptionalParams

Необязательные параметры.

DeleteAgentResponse

Удаленный объект агента

DeleteAgentVersionResponse

Удаленная версия агента Object

DeleteMemoryStoreResponse

интерфейс модели DeleteMemoryStoreResponse

DeleteSkillResponse

Удалённый навык Объект

Deployment

Определение развертывания модели

DeploymentsGetOptionalParams

Необязательные параметры.

DeploymentsListOptionalParams

Необязательные параметры.

DeploymentsOperations

Интерфейс, представляющий операции развертывания.

EmbeddingConfiguration

Встраивание класса конфигурации

EmptyModelParam

Интерфейс модели EmptyModelParam

EntraAuthorizationScheme

интерфейс модели EntraAuthorizationScheme

EntraIDCredentials

Entra ID определение учетных данных

EntraIsolationKeySource

Интерфейс модели EntraIsolationKeySource

ErrorModel

интерфейс модели ErrorModel

EvalResult

Результат оценки.

EvalRunResultCompareItem

Сравнение метрик лечения с исходным уровнем.

EvalRunResultComparison

Результаты сравнения результатов лечения с исходным уровнем.

EvalRunResultSummary

Сводная статистика метрики в прогоне оценки.

EvaluationComparisonInsightRequest

Запрос на сравнение оценок

EvaluationComparisonInsightResult

Выводы из сравнения оценок.

EvaluationResultSample

Образец из результата оценки.

EvaluationRule

Модель правила оценки.

EvaluationRuleAction

Модель действия по оценке.

EvaluationRuleFilter

Модель фильтра оценки.

EvaluationRulesCreateOrUpdateOptionalParams

Необязательные параметры.

EvaluationRulesDeleteOptionalParams

Необязательные параметры.

EvaluationRulesGetOptionalParams

Необязательные параметры.

EvaluationRulesListOptionalParams

Необязательные параметры.

EvaluationRulesOperations

Интерфейс, представляющий операции EvaluationRules.

EvaluationRunClusterInsightRequest

Выводы о наборе результатов оценки

EvaluationRunClusterInsightResult

Выводы, полученные в ходе оценки, запускают кластерный анализ.

EvaluationScheduleTask

Задание на оценку расписания.

EvaluationTaxonomy

Определение таксономии оценки

EvaluationTaxonomyInput

Входная конфигурация для таксономии оценки.

EvaluatorDefinition

Конфигурация базового оценщика с дискриминатором

EvaluatorMetric

Метрика Evaluator

EvaluatorVersion

Определение оценщика

FabricDataAgentToolParameters

Параметры инструмента агента данных набора данных.

FieldMapping

Класс конфигурации сопоставления полей

FileDatasetVersion

Определение FileDatasetVersion

FileSearchTool

Средство, которое ищет соответствующее содержимое из отправленных файлов. Узнайте больше о средстве поиска файлов.

FixedRatioVersionSelectionRule

model interface FixedRatioVersionSelectionRule

FolderDatasetVersion

Определение FileDatasetVersion

FunctionShellToolParam

Инструмент, позволяющий модели выполнять команды оболочки.

FunctionShellToolParamEnvironment

Model interface FunctionShellToolParamEnvironment

FunctionShellToolParamEnvironmentContainerReferenceParam

model interface FunctionShellToolParamEnvironmentContainerReferenceParam

FunctionShellToolParamEnvironmentLocalEnvironmentParam

model interface functionShellToolParamEnvironmentLocalEnvironmentParam

FunctionTool

Определяет функцию в собственном коде, которую модель может вызвать. Дополнительные сведения о вызове функции.

FunctionToolParam

Model interface FunctionToolParam

HeaderIsolationKeySource

интерфейс модели HeaderIsolationKeySource

HostedAgentDefinition

Определение размещенного агента.

HourlyRecurrenceSchedule

Почасовой график повторения.

HumanEvaluationPreviewRuleAction

Действие правила оценки для оценки человека.

HybridSearchOptions

интерфейс модели HybridSearchOptions

ImageGenTool

Инструмент, который генерирует изображения с использованием моделей GPT.

ImageGenToolInputImageMask

интерфейс модели ImageGenToolInputImageMask

IndexesCreateOrUpdateOptionalParams

Необязательные параметры.

IndexesDeleteOptionalParams

Необязательные параметры.

IndexesGetOptionalParams

Необязательные параметры.

IndexesListOptionalParams

Необязательные параметры.

IndexesListVersionsOptionalParams

Необязательные параметры.

IndexesOperations

Интерфейс, представляющий операции с индексами.

InlineSkillParam

интерфейс модели InlineSkillParam

InlineSkillSourceParam

Полезная нагрузка для встроенного навыка

Insight

Тело ответа для аналитики кластера.

InsightCluster

Кластер образцов анализа.

InsightModelConfiguration

Конфигурация модели, используемой при создании аналитических сведений.

InsightRequest

Запрос аналитического отчета.

InsightResult

Результат инсайтов.

InsightSample

Образец из анализа.

InsightScheduleTask

Задача анализа для расписания.

InsightSummary

Сводка кластерного анализа ошибок.

InsightsMetadata

Метаданные об инсайтах.

IsolationKeySource

Интерфейс модели IsolationKeySource

LocalShellToolParam

Средство, позволяющее модели выполнять команды оболочки в локальной среде.

LocalSkillParam

интерфейс модели LocalSkillParam

MCPTool

Предоставьте модели доступ к дополнительным инструментам через удаленные серверы протокола контекста модели (MCP). Learn больше о MCP.

MCPToolFilter

Объект фильтра, указывающий, какие инструменты разрешены.

MCPToolRequireApproval

интерфейс модели MCPToolRequireApproval

ManagedAgentIdentityBlueprintReference

model interface ManagedAgentIdentityBlueprintReference

ManagedAzureAISearchIndex

Managed Поиск с использованием ИИ Azure Index Definition

MemoryItem

Один элемент памяти, хранящийся в хранилище памяти и содержащий содержимое и метаданные.

MemoryOperation

Представляет собой одну операцию памяти (создание, обновление или удаление), выполненную над элементом памяти.

MemorySearchItem

Извлеченный элемент памяти из поиска в памяти.

MemorySearchOptions

Варианты поиска в памяти.

MemorySearchPreviewTool

Инструмент для интеграции воспоминаний в агент.

MemoryStore

Хранилище памяти, которое может хранить и извлекать воспоминания пользователя.

MemoryStoreDefaultDefinition

Реализация хранилища памяти по умолчанию.

MemoryStoreDefaultOptions

Конфигурации хранилища памяти по умолчанию.

MemoryStoreDefinition

Базовое определение для конфигураций хранилища памяти.

MemoryStoreDeleteScopeResponse

Реакция на удаление воспоминаний из области видимости.

MemoryStoreOperationUsage

Статистика использования операции с хранилищем памяти.

MemoryStoreSearchResponse

Реакция на поиск в памяти.

MemoryStoreUpdateCompletedResult

Результат обновления памяти.

MemoryStoreUpdateResponse

Предоставляет состояние операции обновления хранилища памяти.

MicrosoftFabricPreviewTool

Информация о определении ввода инструмента Microsoft Fabric, используемая для настройки агента.

ModelDeployment

Определение развертывания модели

ModelDeploymentSku

Сведения о номере SKU

ModelSamplingParams

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

MonthlyRecurrenceSchedule

Ежемесячный график повторения.

NamespaceToolParam

Группы функционируют/пользовательские инструменты в общем пространстве имён.

NoAuthenticationCredentials

Учетные данные, не требующие аутентификации

OneTimeTrigger

Одноразовый спусковой крючок.

OpenAIClientOptionsWithAzureAgent

Расширенные опции клиента OpenAI с включением конфигурации конечных точек Azure Agent.

OpenApiAnonymousAuthDetails

Сведения о безопасности для анонимной проверки подлинности OpenApi

OpenApiAuthDetails

сведения о проверке подлинности для OpenApiFunctionDefinition

OpenApiFunctionDefinition

Сведения об определении входных данных для функции openapi.

OpenApiManagedAuthDetails

Сведения о безопасности для проверки подлинности OpenApi managed_identity

OpenApiManagedSecurityScheme

Схема безопасности для проверки подлинности OpenApi managed_identity

OpenApiProjectConnectionAuthDetails

Сведения о безопасности для проверки подлинности подключения OpenApi project

OpenApiProjectConnectionSecurityScheme

Схема безопасности для проверки подлинности OpenApi managed_identity

OpenApiTool

Сведения об определении входных данных для средства OpenAPI, используемого для настройки агента.

PageSettings

Интерфейс, отслеживающий параметры для итерации страниц

PagedAsyncIterableIterator

Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам.

PendingUploadRequest

Представляет запрос на ожидающую загрузку.

PendingUploadResponse

Представляет ответ на ожидающий запрос на загрузку

PromptAgentDefinition

Определение агента запроса

PromptAgentDefinitionTextOptions

Параметры конфигурации для текстового ответа модели. Можно использовать обычный текст или структурированные данные JSON.

PromptBasedEvaluatorDefinition

Оценщик на основе подсказок

ProtocolVersionRecord

Сопоставление записей для одного протокола и его версии.

RaiConfig

Конфигурация для фильтрации содержимого и функций безопасности Responsible AI (RAI).

RankingOptions

Интерфейс модели RankingOptions

Reasoning

Только модели GPT-5 и O-Series Опции конфигурации моделей рассуждения.

RecurrenceSchedule

Модель графика повторения.

RecurrenceTrigger

Триггер на основе рецидива.

RedTeam

Красная команда.

ResponseUsageInputTokensDetails

model interface ResponseUsageInputTokensDetails

ResponseUsageOutputTokensDetails

model interface ResponseUsageOutputTokensDetails

SASTokenCredentials

Определение учетных данных подписанного URL-адреса (SAS)

SasCredential

Определение учетных данных SAS

Schedule

Модель расписания.

ScheduleRun

Модель прогона по расписанию.

ScheduleTask

Модель задачи планирования.

SessionDirectoryEntry

Одна запись в списке каталога.

SessionDirectoryListResponse

Ответ от размещения каталога в песочнице сессии.

SessionFileWriteResponse

Ответ при загрузке файла в песочницу сессии.

SharepointGroundingToolParameters

Параметры инструмента заземления SharePoint.

SharepointPreviewTool

Сведения об определении входных данных для инструмента SharePoint, используемого для настройки агента.

SkillObject

Объект навыка.

SkillReferenceParam

Интерфейс модели SkillReferenceParam

SpecificApplyPatchParam

Заставляет модель вызывать средство apply_patch при выполнении вызова средства.

SpecificFunctionShellParam

Заставляет модель вызывать средство оболочки при необходимости вызова средства.

StructuredInputDefinition

Структурированные входные данные, которые могут участвовать в подстановках шаблонов и привязке аргументов инструмента.

StructuredOutputDefinition

Структурированные выходные данные, которые можно создать агентом.

Target

Базовый класс для целей с поддержкой дискриминаторов.

TargetConfig

Абстрактный класс для целевой конфигурации.

TaxonomyCategory

Определение категории таксономии.

TaxonomySubCategory

Определение подкатегории таксономии.

TelemetryOperations

Интерфейс, представляющий операции телеметрии

TextResponseFormat

Объект, указывающий формат, который должен выводить модель. Настройка { "type": "json_schema" } включает структурированные выходные данные, что гарантирует, что модель будет соответствовать предоставленной схеме JSON. Дополнительные сведения см. в руководстве по структурированным выходным данным. Формат по умолчанию — это { "type": "text" } без дополнительных параметров. Не рекомендуется для GPT-4o и более новых моделей:* Настройка для { "type": "json_object" } включения старого режима JSON, который гарантирует, что сообщение, которое генерирует модель, является действительным JSON. Использование json_schema предпочтительнее для моделей, поддерживающих его.

TextResponseFormatConfiguration
TextResponseFormatConfigurationResponseFormatJsonObject
TextResponseFormatConfigurationResponseFormatText
TextResponseFormatJsonObject

Формат отклика объекта JSON. Старый метод создания ответов JSON. Рекомендуется использовать json_schema для моделей, поддерживающих его. Обратите внимание, что модель не будет создавать JSON без системного или пользовательского сообщения, которое дает ей соответствующую команду.

TextResponseFormatJsonSchema

Формат ответа схемы JSON. Используется для создания структурированных ответов JSON. Дополнительные сведения о структурированных выходных данных.

TextResponseFormatText

Формат ответа по умолчанию. Используется для создания текстовых ответов.

Tool

Средство, которое можно использовать для создания ответа.

ToolChoiceAllowed

Ограничивает средства, доступные для модели, предварительно определенным набором.

ToolChoiceCodeInterpreter

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolChoiceComputer

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolChoiceComputerUse

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolChoiceComputerUsePreview

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolChoiceCustom

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

ToolChoiceFileSearch

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolChoiceFunction

Используйте этот параметр, чтобы принудительно вызвать определенную функцию.

ToolChoiceImageGeneration

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolChoiceMCP

Используйте этот параметр, чтобы принудительно вызвать определенное средство на удаленном сервере MCP.

ToolChoiceParam

Как модель должна выбрать средство (или инструменты), которое следует использовать при создании ответа. Просмотрите tools параметр, чтобы узнать, как указать, какие средства модель может вызывать.

ToolChoiceWebSearchPreview

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolChoiceWebSearchPreview20250311

Указывает, что модель должна использовать встроенное средство для создания ответа. Learn больше о встроенных средствах.

ToolDescription

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

ToolProjectConnection

Ресурс подключения project.

ToolSearchToolParam

Размещенная или BYOT конфигурация поиска инструментов для отложенных инструментов.

ToolboxObject

Набор инструментов, который хранит многоразовые определения инструментов для агентов.

ToolboxPolicies

Конфигурация политики для набора инструментов, включая безопасность контента и другие настройки управления.

ToolboxVersionObject

Определённая версия ящика инструментов.

Trigger

Базовая модель для триггера расписания.

UpdateToolboxRequest

Обновление интерфейса моделиToolboxЗапрос

UserProfileMemoryItem

Элемент памяти, содержащий информацию профиля пользователя, извлеченную из бесед, такую как предпочтения, интересы и личные данные.

VersionIndicator

Индикатор версии, определяющий, какая версия агента поддерживает сессию.

VersionRefIndicator

Индикатор версий, который ссылается на конкретную версию агента по названию.

VersionSelectionRule

интерфейс модели VersionSelectionRule

VersionSelector

интерфейс модели VersionSelector

WebSearchApproximateLocation

Приблизительное местоположение пользователя.

WebSearchConfiguration

Конфигурация поиска в Интернете для bing пользовательского поиска

WebSearchPreviewTool

Этот инструмент ищет в интернете релевантные результаты для ответа. Дополнительные сведения о средстве поиска web.

WebSearchTool

Ищите в Интернете источники, связанные с этим заданием. Дополнительные сведения о средстве поиска web.

WebSearchToolFilters

Интерфейс моделей WebSearchToolFilters

WeeklyRecurrenceSchedule

Еженедельный график повторения.

WorkIQPreviewTool

Серверный инструмент WorkIQ.

WorkIQPreviewToolParameters

Параметры инструмента WorkIQ.

WorkflowAgentDefinition

Определение агента рабочего процесса.

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

AgentBlueprintReferenceType

Тип агентаBlueprintReferenceType

AgentBlueprintReferenceUnion

Псевдоним для AgentBlueprintReferenceUnion

AgentDefinitionOptInKeys

Функция ключей opt-in для операций определения агентов, поддерживающих хостированные или рабочие процессы агентов.

AgentDefinitionUnion

Тип Union для всех типов определений агентов. Поддерживает рабочие процессы, размещенные приложения, контейнерные приложения и агенты подсказок.

AgentEndpointAuthorizationSchemeType

Тип агентаEndpointAuthorizationSchemeType

AgentEndpointAuthorizationSchemeUnion

Alias for AgentEndpointAuthorizationSchemeUnion

AgentEndpointProtocol

Тип AgentEndpointProtocol

AgentKind

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

AgentProtocol

Тип AgentProtocol (Тип AgentProtocol)

AgentSessionStatus

Статус сессии агента.

AgentType

Тип агентаТип

AttackStrategy

Стратегии атак.

AzureAISearchQueryType

Доступные типы запросов для инструмента Поиск с использованием ИИ Azure.

BaseCredentialsUnion

Псевдоним для BaseCredentialsUnion

BetaAgentsDownloadSessionFileResponse
BetaSkillsDownloadResponse
ComparisonFilterValueItems

Alias for ComparisonFilterValueItems

ComputerEnvironment

Тип компьютерной среды

ConnectionType

Тип (или категория) подключения

ContainerMemoryLimit

Тип ContainerMemoryLimit

ContainerNetworkPolicyParamType

Тип контейнераNetworkPolicyParamType

ContainerNetworkPolicyParamUnion

Alias for ContainerNetworkPolicyParamUnion

ContainerSkillType

Тип контейнераНавыкТип

ContainerSkillUnion

Псевдоним ContainerSkillUnion

ContinuablePage

Интерфейс, описывающий страницу результатов.

CredentialType

Тип учетных данных, используемых подключением

CustomToolParamFormatType

Тип CustomToolParamFormatType

CustomToolParamFormatUnion

Alias for CustomToolParamFormatUnion

DatasetType

Перечисление для определения типа данных.

DatasetVersionUnion

Псевдоним для DatasetVersionUnion

DayOfWeek

Дни недели для графика повторения.

DeploymentType

Тип развертыванияТип

DeploymentUnion

Псевдоним для DeploymentUnion

EvaluationRuleActionType

Тип действия по оценке.

EvaluationRuleActionUnion

Псевдоним для EvaluationRuleActionUnion

EvaluationRuleEventType

Тип события правила оценки.

EvaluationTaxonomyInputType

Тип входных данных таксономии оценки.

EvaluationTaxonomyInputUnion

Псевдоним для EvaluationTaxonomyInputUnion

EvaluatorCategory

Категория оценщика

EvaluatorDefinitionType

Тип определения оценщика

EvaluatorDefinitionUnion

Псевдоним для EvaluatorDefinitionUnion

EvaluatorMetricDirection

Направление метрики, указывающее, является ли более высокое значение лучше, более низкое значение лучше или нейтральным

EvaluatorMetricType

Тип оценщика

EvaluatorType

Тип оценщика

Filters

Псевдоним для фильтров

FoundryFeaturesOptInKeys

Тип FoundryFeaturesOptInKeys

FunctionShellToolParamEnvironmentType

Тип функцииShellToolParamEnvironmentType

FunctionShellToolParamEnvironmentUnion

Alias for FunctionShellToolParamEnvironmentUnion

GrammarSyntax

Тип грамматикиСинтаксис

ImageGenAction

Тип ImageGenAction

IndexType

Тип IndexType

IndexUnion

Псевдоним для IndexUnion

InputFidelity

Контролируйте усилия модели для соответствия стилю и особенностям, в частности, чертам лица, на входных изображениях. Этот параметр поддерживается только для gpt-image-1 и gpt-image-1.5 более поздних моделей, не поддерживаемых для gpt-image-1-mini. Поддерживает high и low. По умолчанию — low.

InsightRequestUnion

Псевдоним для InsightRequestUnion

InsightResultUnion

Псевдоним для InsightResultUnion

InsightSampleUnion

Псевдоним для InsightSampleUnion

InsightType

Запрос инсайтов.

IsolationKeySourceKind

Тип изоляцииKeySourceKind

IsolationKeySourceUnion

Псевдоним для IsolationKeySourceUnion

MemoryItemKind

Вид элемента памяти.

MemoryItemUnion

Псевдоним для MemoryItemUnion

MemoryOperationKind

Вид операций с памятью.

MemoryStoreDefinitionUnion

Псевдоним для MemoryStoreDefinitionUnion

MemoryStoreKind

Тип используемой реализации хранилища памяти.

MemoryStoreType

Тип MemoryStoreType

MemoryStoreUpdateStatus

Состояние операции обновления хранилища памяти.

OpenApiAuthDetailsUnion

Псевдоним для OpenApiAuthDetailsUnion

OpenApiAuthType

Тип аутентификации для конечной точки OpenApi. Допустимые типы:

  • Анонимный (аутентификация не требуется)
  • Project Соединение (требует project_connection_id для конечной точки, как это установлено в AI Foundry)
  • Managed_Identity (требуется аудитория для аутентификации на основе удостоверений)
OperationState

Перечисление, описывающее разрешенные состояния операций.

PageOrder

Тип порядка страниц

PendingUploadType

Тип ожидающей загрузки.

RankerVersionType

Тип RankerVersionType

ReasoningEffort

Ограничивает усилия, направленные на модели рассуждений. В настоящее время поддерживаемые значения — none, minimal, lowmediumhigh, , и xhigh. Сокращение усилий на рассуждение может привести к более быстрым ответам и меньшему количеству токенов, используемых при рассуждениях в ответе.

  • gpt-5.1 по умолчанию — none, что не выполняет рассуждение. Поддерживаемые значения рассуждения для gpt-5.1 — , nonelow, medium, и high. Вызовы инструментов поддерживаются для всех значений причин в gpt-5.1.
  • Все модели до gpt-5.1 стандартного использования medium усилия рассуждения и не поддерживают none.
  • gpt-5-pro Модель по умолчанию использует (и поддерживает только) high усилия по рассуждениям.
  • xhigh поддерживается для всех моделей после gpt-5.1-codex-max.
RecurrenceScheduleUnion

Псевдоним для RecurrenceScheduleUnion

RecurrenceType

Тип рецидива.

RiskCategory

Категория риска для цели атаки.

SampleType

Тип пробы, используемой при анализе.

ScheduleProvisioningStatus

Состояние подготовки расписания.

ScheduleTaskType

Тип задачи.

ScheduleTaskUnion

Псевдоним для ScheduleTaskUnion

SearchContentType

Тип поискаКонтентТип

SearchContextSize

Тип поискаКонтекстРазмер

TargetConfigUnion

Псевдоним для TargetConfigUnion

TargetUnion

Псевдоним для TargetUnion

TextResponseFormatConfigurationType

Тип текстаОтветФорматКонфигурацияТип

TextResponseFormatConfigurationUnion
TextResponseFormatUnion

Псевдоним для TextResponseFormatUnion

ToolChoiceParamType

Тип инструментаParamType

ToolChoiceParamUnion

Псевдоним для ToolChoiceParamUnion

ToolSearchExecutionType

Тип ToolSearchExecutionType

ToolType

Тип ToolType

ToolUnion

Псевдоним для ToolUnion

TreatmentEffectType

Тип эффекта лечения.

TriggerType

Тип спускового крючка.

TriggerUnion

Псевдоним для TriggerUnion

VersionIndicatorType

Тип индикатора версии, используемого для определения версии агента, поддерживающей сессию.

VersionIndicatorUnion

Alias for VersionIndicatorUnion

VersionSelectionRuleUnion

Псевдоним для VersionSelectionRuleUnion

VersionSelectorType

Тип VersionSelectorType

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

KnownApiVersions

Версии API Майкрософт Foundry

Переменные

RestError

Настраиваемый тип ошибки для неудачных запросов конвейера.

Сведения об переменной

RestError

Настраиваемый тип ошибки для неудачных запросов конвейера.

RestError: RestErrorConstructor

Тип