AzureAISearchIndex Class

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.10

Source:: AzureAISearchIndex.cs

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.

Azure AI Search Index Definition.

public class AzureAISearchIndex : Azure.AI.Projects.DatasetIndex, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.AzureAISearchIndex>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.AzureAISearchIndex>

type AzureAISearchIndex = class
    inherit DatasetIndex
    interface IJsonModel<AzureAISearchIndex>
    interface IPersistableModel<AzureAISearchIndex>

Public Class AzureAISearchIndex
Inherits DatasetIndex
Implements IJsonModel(Of AzureAISearchIndex), IPersistableModel(Of AzureAISearchIndex)

Inheritance: Object

DatasetIndex
AzureAISearchIndex

Implements: IJsonModel<AzureAISearchIndex> IPersistableModel<AzureAISearchIndex> IPersistableModel<T>

Constructors

AzureAISearchIndex(String, String)

Initializes a new instance of AzureAISearchIndex.

Properties

ConnectionName	Name of connection to Azure AI Search.
Description	The asset description text. (Inherited from DatasetIndex)
FieldMapping	Field mapping configuration.
Id	Asset ID, a unique identifier for the asset. (Inherited from DatasetIndex)
IndexName	Name of index in Azure AI Search resource to attach.
Name	The name of the resource. (Inherited from DatasetIndex)
Tags	Tag dictionary. Tags can be added, removed, and updated. (Inherited from DatasetIndex)
Version	The version of the resource. (Inherited from DatasetIndex)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<AzureAISearchIndex>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AzureAISearchIndex>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<DatasetIndex>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from DatasetIndex)
IJsonModel<DatasetIndex>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from DatasetIndex)
IPersistableModel<AzureAISearchIndex>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AzureAISearchIndex>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AzureAISearchIndex>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<DatasetIndex>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from DatasetIndex)
IPersistableModel<DatasetIndex>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from DatasetIndex)
IPersistableModel<DatasetIndex>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from DatasetIndex)

Applies to