AzureAISearchTool Class

Definition

Namespace:

Azure.AI.Extensions.OpenAI

Assembly:

Azure.AI.Extensions.OpenAI.dll

Package:

Azure.AI.Extensions.OpenAI v3.0.0-beta.3

Source:

AzureAISearchTool.cs

The input definition information for an Azure AI search tool as used to configure an agent.

public class AzureAISearchTool : OpenAI.Responses.ResponseTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.AzureAISearchTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.AzureAISearchTool>

type AzureAISearchTool = class
    inherit ResponseTool
    interface IJsonModel<AzureAISearchTool>
    interface IPersistableModel<AzureAISearchTool>

Public Class AzureAISearchTool
Inherits ResponseTool
Implements IJsonModel(Of AzureAISearchTool), IPersistableModel(Of AzureAISearchTool)

Inheritance

OpenAI.Responses.ResponseTool

AzureAISearchTool

Implements

IJsonModel<AzureAISearchTool> IPersistableModel<AzureAISearchTool> IPersistableModel<T>

Constructors

Name	Description
AzureAISearchTool(AzureAISearchToolOptions)	Initializes a new instance of AzureAISearchTool.

Properties

Name	Description
AzureAISearch	The azure ai search index resource.
Description	Deprecated. This property is deprecated and will be removed in a future version.
Name	Deprecated. This property is deprecated and will be removed in a future version.
ToolConfigs	Deprecated. This property is deprecated and will be removed in a future version.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<AzureAISearchTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AzureAISearchTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AzureAISearchTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AzureAISearchTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AzureAISearchTool>.Write(ModelReaderWriterOptions)