Share via


AzureAISearchToolIndex Class

Definition

A AI Search Index resource.

public class AzureAISearchToolIndex : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.OpenAI.AzureAISearchToolIndex>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.OpenAI.AzureAISearchToolIndex>
type AzureAISearchToolIndex = class
    interface IJsonModel<AzureAISearchToolIndex>
    interface IPersistableModel<AzureAISearchToolIndex>
Public Class AzureAISearchToolIndex
Implements IJsonModel(Of AzureAISearchToolIndex), IPersistableModel(Of AzureAISearchToolIndex)
Inheritance
AzureAISearchToolIndex
Implements

Constructors

Name Description
AzureAISearchToolIndex()

Initializes a new instance of AzureAISearchToolIndex.

Properties

Name Description
Filter

filter string for search resource. Learn more here.

IndexAssetId

Index asset id for search resource.

IndexName

The name of an index in an IndexResource attached to this agent.

ProjectConnectionId

An index connection ID in an IndexResource attached to this agent.

QueryType

Type of query in an AIIndexResource attached to this agent.

TopK

Number of documents to retrieve from search and present to the model.

Methods

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

Explicit Interface Implementations

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

Applies to