Azure.AI.Projects.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 |
|---|---|
| A2ATool |
An agent implementing the A2A protocol. |
| AgentDefinition |
The AgentDefinition. Please note this is the abstract base class. The derived classes available for instantiation are: WorkflowAgentDefinition, HostedAgentDefinition, ContainerApplicationAgentDefinition, and PromptAgentDefinition. |
| AgentInfo |
The AgentInfo. |
| AgentObjectVersions |
The AgentObjectVersions. |
| AgentRecord |
The AgentRecord. |
| AgentReference |
The AgentReference. |
| AgentResponseItem |
Content item used to generate a response. Please note this is the abstract base class. The derived classes available for instantiation are: AgentStructuredOutputsResponseItem, AgentWorkflowActionResponseItem, OAuthConsentRequestResponseItem, LocalShellToolCallAgentResponseItem, LocalShellToolCallOutputAgentResponseItem, and MemorySearchToolCallResponseItem. |
| AgentResponseItemSource |
The AgentResponseItemSource. |
| AgentStructuredOutputsResponseItem |
The AgentStructuredOutputsResponseItem. |
| AgentTool |
The AgentTool. Please note this is the abstract base class. The derived classes available for instantiation are: LocalShellAgentTool, BingGroundingAgentTool, MicrosoftFabricAgentTool, SharepointAgentTool, AzureAISearchAgentTool, OpenAPIAgentTool, BingCustomSearchAgentTool, BrowserAutomationAgentTool, AzureFunctionAgentTool, CaptureStructuredOutputsTool, A2ATool, and MemorySearchTool. |
| AgentVersion |
The AgentVersion. |
| AgentWorkflowActionResponseItem |
The AgentWorkflowActionResponseItem. |
| AzureAIAgentsModelFactory | |
| AzureAIProjectsOpenAIContext |
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 |
| AzureAISearchAgentTool |
The input definition information for an Azure AI search tool as used to configure an agent. |
| AzureAISearchToolIndex |
A AI Search Index resource. |
| AzureAISearchToolOptions |
A set of index resources used by the |
| AzureFunctionAgentTool |
The input definition information for an Azure Function Tool, as used to configure an Agent. |
| AzureFunctionBinding |
The structure for keeping storage queue name and URI. |
| AzureFunctionDefinition |
The definition of Azure function. |
| AzureFunctionDefinitionFunction |
The AzureFunctionDefinitionFunction. |
| AzureFunctionStorageQueue |
The structure for keeping storage queue name and URI. |
| BingCustomSearchAgentTool |
The input definition information for a Bing custom search tool as used to configure an agent. |
| BingCustomSearchConfiguration |
A bing custom search configuration. |
| BingCustomSearchToolParameters |
The bing custom search tool parameters. |
| BingGroundingAgentTool |
The input definition information for a bing grounding search tool as used to configure an agent. |
| BingGroundingSearchConfiguration |
Search configuration for Bing Grounding. |
| BingGroundingSearchToolOptions |
The bing grounding search tool parameters. |
| BrowserAutomationAgentTool |
The input definition information for a Browser Automation Tool, as used to configure an Agent. |
| BrowserAutomationToolConnectionParameters |
Definition of input parameters for the connection used by the Browser Automation Tool. |
| BrowserAutomationToolParameters |
Definition of input parameters for the Browser Automation Tool. |
| CaptureStructuredOutputsTool |
A tool for capturing structured outputs. |
| ChatSummaryMemoryItem |
A memory item containing a summary extracted from conversations. |
| ContainerApplicationAgentDefinition |
The container app agent definition. |
| ContentFilterConfiguration |
Configuration for Responsible AI (RAI) content filtering and safety features. |
| ConversationClientExtensions | |
| ExtraDataDictionary | |
| FabricDataAgentToolOptions |
The fabric data agent tool parameters. |
| HostedAgentDefinition |
The hosted agent definition. |
| ImageBasedHostedAgentDefinition |
The image-based deployment definition for a hosted agent. |
| LocalShellAgentTool |
A tool that allows the model to execute shell commands in a local environment. |
| LocalShellAgentToolExecutionAction |
Execute a shell command on the server. |
| LocalShellToolCallAgentResponseItem |
A tool call to run a command on the local shell. |
| LocalShellToolCallOutputAgentResponseItem |
The output of a local shell tool call. |
| MemoryItem |
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: ChatSummaryMemoryItem. |
| MemorySearchItem |
A retrieved memory item from memory search. |
| MemorySearchTool |
A tool for integrating memories into the agent. |
| MemorySearchToolCallResponseItem |
The MemorySearchToolCallResponseItem. |
| MemorySearchToolOptions |
Memory search options. |
| MicrosoftFabricAgentTool |
The input definition information for a Microsoft Fabric tool as used to configure an agent. |
| OAuthConsentRequestResponseItem |
Request from the service for the user to perform OAuth consent. |
| OpenAIFileExtensions | |
| OpenAIResponseExtension | |
| OpenAIResponseExtensions | |
| OpenAPIAgentTool |
The input definition information for an OpenAPI tool as used to configure an agent. |
| OpenAPIAnonymousAuthenticationDetails |
Security details for OpenApi anonymous authentication. |
| OpenAPIAuthenticationDetails |
authentication details for OpenApiFunctionDefinition Please note this is the abstract base class. The derived classes available for instantiation are: OpenAPIAnonymousAuthenticationDetails, OpenAPIProjectConnectionAuthenticationDetails, and OpenAPIManagedAuthenticationDetails. |
| OpenAPIFunctionDefinition |
The input definition information for an openapi function. |
| OpenAPIFunctionEntry |
The OpenAPIFunctionEntry. |
| OpenAPIManagedAuthenticationDetails |
Security details for OpenApi managed_identity authentication. |
| OpenApiManagedSecurityScheme |
Security scheme for OpenApi managed_identity authentication. |
| OpenAPIProjectConnectionAuthenticationDetails |
Security details for OpenApi project connection authentication. |
| OpenAPIProjectConnectionSecurityScheme |
Security scheme for OpenApi managed_identity authentication. |
| ProjectConversation |
The ProjectConversation. |
| ProjectConversationCreationOptions |
Create a conversation. |
| ProjectConversationsClient | |
| ProjectConversationUpdateOptions |
Update a conversation. |
| ProjectFilesClient | |
| ProjectOpenAIClient | |
| ProjectOpenAIClientOptions | |
| ProjectResponsesClient | |
| ProjectResponsesClientOptions | |
| ProjectsOpenAIModelFactory |
A factory class for creating instances of the models for mocking. |
| ProjectVectorStoresClient | |
| PromptAgentDefinition |
The prompt agent definition. |
| ProtocolVersionRecord |
A record mapping for a single protocol and its version. |
| ResponseCreationOptionsExtensions | |
| ResponseItemExtensions | |
| ResponseToolExtensions | |
| SharepointAgentTool |
The input definition information for a sharepoint tool as used to configure an agent. |
| SharePointGroundingToolOptions |
The sharepoint grounding tool parameters. |
| StructuredInputDefinition |
An structured input that can participate in prompt template substitutions and tool argument binding. |
| StructuredOutputDefinition |
A structured output that can be produced by the agent. |
| ToolProjectConnection |
A project connection resource. |
| WorkflowAgentDefinition |
The workflow agent definition. |
Structs
| Name | Description |
|---|---|
| AgentCommunicationMethod | |
| AgentResponseItemKind | |
| AgentWorkflowActionStatus | |
| AzureAISearchQueryType |
Available query types for Azure AI Search tool. |
| LocalShellAgentToolCallStatus | |
| MemorySearchToolCallStatus | |
