Azure.AI.Extensions.OpenAI Namespace

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Classes

Name	Description
A2AToolCall	An A2A (Agent-to-Agent) tool call.
A2AToolCallOutput	The output of an A2A (Agent-to-Agent) tool call.
AgentReference	The AgentReference.
AgentResponseItem	The AgentResponseItem. Please note this is the abstract base class. The derived classes available for instantiation are: AgentStructuredOutputsResponseItem, AgentWorkflowPreviewActionResponseItem, OAuthConsentRequestResponseItem, BingGroundingToolCall, BingGroundingToolCallOutput, SharepointGroundingToolCall, SharepointGroundingToolCallOutput, AzureAISearchToolCall, AzureAISearchToolCallOutput, BingCustomSearchToolCall, BingCustomSearchToolCallOutput, OpenApiToolCall, OpenApiToolCallOutput, BrowserAutomationToolCall, BrowserAutomationToolCallOutput, FabricDataAgentToolCall, FabricDataAgentToolCallOutput, AzureFunctionToolCall, AzureFunctionToolCallOutput, A2AToolCall, A2AToolCallOutput, MemorySearchToolCall, MemoryCommandToolCall, MemoryCommandToolCallOutput, OutputItemFunctionToolCallOutput, OutputItemComputerToolCallOutput, OutputItemToolSearchCall, OutputItemToolSearchOutput, OutputItemLocalShellToolCallOutput, OutputItemMcpApprovalResponseResource, and OutputItemCustomToolCallOutputResource.
AgentStructuredOutputsResponseItem	The AgentStructuredOutputsResponseItem.
AgentWorkflowPreviewActionResponseItem	The AgentWorkflowPreviewActionResponseItem.
AzureAIExtensions	The class containing various extension methods.
AzureAIExtensionsOpenAIContext	Context class which will be filled in by the System.ClientModel.SourceGeneration. For more information https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/System.ClientModel/src/docs/ModelReaderWriterContext.md
AzureAISearchToolCall	An Azure AI Search tool call.
AzureAISearchToolCallOutput	The output of an Azure AI Search tool call.
AzureFunctionToolCall	An Azure Function tool call.
AzureFunctionToolCallOutput	The output of an Azure Function tool call.
BingCustomSearchToolCall	A Bing custom search tool call.
BingCustomSearchToolCallOutput	The output of a Bing custom search tool call.
BingGroundingToolCall	A Bing grounding tool call.
BingGroundingToolCallOutput	The output of a Bing grounding tool call.
BrowserAutomationToolCall	A browser automation tool call.
BrowserAutomationToolCallOutput	The output of a browser automation tool call.
ChatSummaryMemoryItem	A memory item containing a summary extracted from conversations.
ComputerCallSafetyCheckParam	A pending safety check for the computer call.
ComputerScreenshotImage	A computer screenshot image used with the computer use tool.
ContainerSkill	The ContainerSkill. Please note this is the abstract base class. The derived classes available for instantiation are: ResponsesSkillReferenceParam and ResponsesInlineSkillParam.
ContentFilterConfiguration
CustomGrammarFormatParam	Grammar format.
ExtensionsOpenAIModelFactory	A factory class for creating instances of the models for mocking.
FabricDataAgentToolCall	A Fabric data agent tool call.
FabricDataAgentToolCallOutput	The output of a Fabric data agent tool call.
LocalSkillParam	The LocalSkillParam.
MemoryCommandToolCall	A memory command tool call.
MemoryCommandToolCallOutput	The output of a memory command tool call.
MemoryOutputItem	A single memory item stored in the memory store, containing content and metadata. Please note this is the abstract base class. The derived classes available for instantiation are: UserProfileMemoryItem, ChatSummaryMemoryItem, and ProceduralMemoryItem.
MemorySearchToolCall	A memory search tool call.
MemorySearchToolCallResponseItem	The MemorySearchToolCallResponseItem.
MemoryToolSearchItem	A retrieved memory item from memory search.
OAuthConsentRequestResponseItem	Request from the service for the user to perform OAuth consent.
OpenApiToolCall	An OpenAPI tool call.
OpenApiToolCallOutput	The output of an OpenAPI tool call.
OutputItemComputerToolCallOutput	Computer tool call output.
OutputItemCustomToolCallOutputResource	ResponseCustomToolCallOutputItem.
OutputItemFunctionToolCallOutput	Function tool call output.
OutputItemLocalShellToolCallOutput	Local shell call output.
OutputItemMcpApprovalResponseResource	MCP approval response.
OutputItemToolSearchCall	The OutputItemToolSearchCall.
OutputItemToolSearchOutput	The OutputItemToolSearchOutput.
ProceduralMemoryItem	A memory item containing a procedure extracted from conversations.
ProjectConversation	The ProjectConversation.
ProjectConversationCreationOptions	The ProjectConversationCreationOptions.
ProjectConversationsClient
ProjectConversationUpdateOptions	The ProjectConversationUpdateOptions.
ProjectFilesClient
ProjectOpenAIClient
ProjectOpenAIClientOptions
ProjectOpenAIClientSettings	Represents the settings used to configure a ProjectOpenAIClient that can be loaded from an IConfigurationSection.
ProjectResponsesClient
ProjectResponsesClientOptions
ProjectVectorStoresClient
ResponsesA2APreviewTool	An agent implementing the A2A protocol.
ResponsesAISearchIndexResource	A AI Search Index resource.
ResponsesAutoCodeInterpreterToolParam	Automatic Code Interpreter Tool Parameters.
ResponsesAzureAISearchTool	The input definition information for an Azure AI search tool as used to configure an agent.
ResponsesAzureAISearchToolOptions
ResponsesAzureAISearchToolResource	A set of index resources used by the `azure_ai_search` tool.
ResponsesAzureFunctionBinding	The structure for keeping storage queue name and URI.
ResponsesAzureFunctionDefinition	The definition of Azure function.
ResponsesAzureFunctionDefinitionFunction	The ResponsesAzureFunctionDefinitionFunction.
ResponsesAzureFunctionStorageQueue	The structure for keeping storage queue name and URI.
ResponsesAzureFunctionTool	The input definition information for an Azure Function Tool, as used to configure an Agent.
ResponsesBingCustomSearchConfiguration	A bing custom search configuration.
ResponsesBingCustomSearchPreviewTool	The input definition information for a Bing custom search tool as used to configure an agent.
ResponsesBingCustomSearchToolParameters	The bing custom search tool parameters.
ResponsesBingGroundingSearchConfiguration	Search configuration for Bing Grounding.
ResponsesBingGroundingSearchToolParameters	The bing grounding search tool parameters.
ResponsesBingGroundingTool	The input definition information for a bing grounding search tool as used to configure an agent.
ResponsesBrowserAutomationPreviewTool	The input definition information for a Browser Automation Tool, as used to configure an Agent.
ResponsesBrowserAutomationToolConnectionParameters	Definition of input parameters for the connection used by the Browser Automation Tool.
ResponsesBrowserAutomationToolParameters	Definition of input parameters for the Browser Automation Tool.
ResponsesCaptureStructuredOutputsTool	A tool for capturing structured outputs.
ResponsesComputerTool	Computer.
ResponsesContainerAutoParam	The ResponsesContainerAutoParam.
ResponsesContainerNetworkPolicyAllowlistParam	The ResponsesContainerNetworkPolicyAllowlistParam.
ResponsesContainerNetworkPolicyDisabledParam	The ResponsesContainerNetworkPolicyDisabledParam.
ResponsesContainerNetworkPolicyDomainSecretParam	The ResponsesContainerNetworkPolicyDomainSecretParam.
ResponsesContainerNetworkPolicyParam	Network access policy for the container. Please note this is the abstract base class. The derived classes available for instantiation are: ResponsesContainerNetworkPolicyDisabledParam and ResponsesContainerNetworkPolicyAllowlistParam.
ResponsesCustomTextFormatParam	Text format.
ResponsesCustomToolParam	Custom tool.
ResponsesCustomToolParamFormat	The input format for the custom tool. Default is unconstrained text. Please note this is the abstract base class. The derived classes available for instantiation are: ResponsesCustomTextFormatParam and CustomGrammarFormatParam.
ResponsesEmptyModelParam	The ResponsesEmptyModelParam.
ResponsesFabricDataAgentToolOptions	The fabric data agent tool parameters.
ResponsesFabricIQPreviewTool	A FabricIQ server-side tool.
ResponsesFunctionShellToolParam	Shell tool.
ResponsesFunctionShellToolParamEnvironment	The ResponsesFunctionShellToolParamEnvironment. Please note this is the abstract base class. The derived classes available for instantiation are: ResponsesFunctionShellToolParamEnvironmentLocalEnvironmentParam, ResponsesFunctionShellToolParamEnvironmentContainerReferenceParam, and ResponsesContainerAutoParam.
ResponsesFunctionShellToolParamEnvironmentContainerReferenceParam	The ResponsesFunctionShellToolParamEnvironmentContainerReferenceParam.
ResponsesFunctionShellToolParamEnvironmentLocalEnvironmentParam	The ResponsesFunctionShellToolParamEnvironmentLocalEnvironmentParam.
ResponsesFunctionToolParam	The ResponsesFunctionToolParam.
ResponsesInlineSkillParam	The ResponsesInlineSkillParam.
ResponsesInlineSkillSourceParam	Inline skill payload.
ResponsesLocalShellToolParam	Local shell tool.
ResponsesMCPToolFilter	MCP tool filter.
ResponsesMCPToolRequireApproval	The ResponsesMCPToolRequireApproval.
ResponsesMemorySearchOptions	Memory search options.
ResponsesMemorySearchPreviewTool	A tool for integrating memories into the agent.
ResponsesMicrosoftFabricPreviewTool	The input definition information for a Microsoft Fabric tool as used to configure an agent.
ResponsesNamespaceToolParam	Namespace.
ResponsesOpenApiAnonymousAuthDetails	Security details for OpenApi anonymous authentication.
ResponsesOpenApiAuthDetails	authentication details for OpenApiFunctionDefinition Please note this is the abstract base class. The derived classes available for instantiation are: ResponsesOpenApiAnonymousAuthDetails, ResponsesOpenApiProjectConnectionAuthDetails, and ResponsesOpenApiManagedAuthDetails.
ResponsesOpenApiFunctionDefinition	The input definition information for an openapi function.
ResponsesOpenApiFunctionDefinitionFunction	The ResponsesOpenApiFunctionDefinitionFunction.
ResponsesOpenApiManagedAuthDetails	Security details for OpenApi managed_identity authentication.
ResponsesOpenApiManagedSecurityScheme	Security scheme for OpenApi managed_identity authentication.
ResponsesOpenApiProjectConnectionAuthDetails	Security details for OpenApi project connection authentication.
ResponsesOpenApiProjectConnectionSecurityScheme	Security scheme for OpenApi managed_identity authentication.
ResponsesOpenApiTool	The input definition information for an OpenAPI tool as used to configure an agent.
ResponsesSharepointGroundingToolParameters	The sharepoint grounding tool parameters.
ResponsesSharepointPreviewTool	The input definition information for a sharepoint tool as used to configure an agent.
ResponsesSkillReferenceParam	The ResponsesSkillReferenceParam.
ResponsesStructuredOutputDefinition	A structured output that can be produced by the agent.
ResponsesTool	A tool that can be used to generate a response. Please note this is the abstract base class. The derived classes available for instantiation are: ResponsesBingGroundingTool, ResponsesMicrosoftFabricPreviewTool, ResponsesSharepointPreviewTool, ResponsesAzureAISearchTool, ResponsesOpenApiTool, ResponsesBingCustomSearchPreviewTool, ResponsesBrowserAutomationPreviewTool, ResponsesAzureFunctionTool, ResponsesCaptureStructuredOutputsTool, ResponsesA2APreviewTool, ResponsesWorkIQPreviewTool, ResponsesFabricIQPreviewTool, ResponsesMemorySearchPreviewTool, ResponsesToolboxSearchPreviewTool, ResponsesWebSearchTool, ResponsesLocalShellToolParam, ResponsesFunctionShellToolParam, ResponsesCustomToolParam, ResponsesComputerTool, ResponsesNamespaceToolParam, and ResponsesToolSearchToolParam.
ResponsesToolboxSearchPreviewTool	A tool for searching over the agent's toolbox. When present, deferred tools are hidden from `tools/list` and only discoverable via `search_tools` queries at runtime.
ResponsesToolProjectConnection	A project connection resource.
ResponsesToolSearchToolParam	Tool search tool.
ResponsesWebSearchApproximateLocation	Web search approximate location.
ResponsesWebSearchConfiguration	A web search configuration for bing custom search.
ResponsesWebSearchTool	Web search.
ResponsesWorkIQPreviewTool	A WorkIQ server-side tool.
SharepointGroundingToolCall	A SharePoint grounding tool call.
SharepointGroundingToolCallOutput	The output of a SharePoint grounding tool call.
ToolConfig	Per-tool configuration that controls tool visibility and search behavior.
UserProfileMemoryItem	A memory item specifically containing user profile information extracted from conversations, such as preferences, interests, and personal details.
WebSearchToolFilters	The WebSearchToolFilters.

Structs

Name	Description
AgentResponseItemKind
AgentWorkflowPreviewActionStatus
MemorySearchToolCallStatus
ResponsesAzureAISearchQueryType	Available query types for Azure AI Search tool.

Enums

Name	Description
ItemFieldComputerToolCallOutputStatus
ItemFieldFunctionToolCallOutputStatus
ItemLocalShellToolCallOutputStatus
ResponsesContainerMemoryLimit	The memory limit for code interpreter container.
ResponsesFunctionCallOutputStatus
ResponsesFunctionCallStatus
ResponsesGrammarSyntax
ResponsesToolSearchExecutionType
ResponsesWebSearchToolSearchContextSize
ToolCallStatus	The status of a tool call.

Feedback

Was this page helpful?