AISearchIndexResource Class

Definition

A AI Search Index resource.

public class AISearchIndexResource : System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.AISearchIndexResource>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.AISearchIndexResource>
type AISearchIndexResource = class
    interface IJsonModel<AISearchIndexResource>
    interface IPersistableModel<AISearchIndexResource>
Public Class AISearchIndexResource
Implements IJsonModel(Of AISearchIndexResource), IPersistableModel(Of AISearchIndexResource)
Inheritance
AISearchIndexResource
Implements

Constructors

Name Description
AISearchIndexResource()

Initializes a new instance of AISearchIndexResource.

Properties

Name Description
Description

Optional user-defined description for this tool or configuration.

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.

Name

Optional user-defined name for this tool or configuration.

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<AISearchIndexResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AISearchIndexResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AISearchIndexResource>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AISearchIndexResource>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AISearchIndexResource>.Write(ModelReaderWriterOptions)

Applies to