Index Class

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

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

Source:: Index.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.

Index resource Definition Please note Index is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AzureAISearchIndex, CosmosDBIndex and ManagedAzureAISearchIndex.

[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownIndex))]
public abstract class Index : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Index>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Index>

[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.Projects.UnknownIndex))>]
type Index = class
    interface IJsonModel<Index>
    interface IPersistableModel<Index>

Public MustInherit Class Index
Implements IJsonModel(Of Index), IPersistableModel(Of Index)

Inheritance: Object
Index

Derived: Azure.AI.Projects.AzureAISearchIndex

Azure.AI.Projects.CosmosDBIndex

Azure.AI.Projects.ManagedAzureAISearchIndex

Attributes: PersistableModelProxyAttribute

Implements: IJsonModel<Index> IPersistableModel<Index> IPersistableModel<T>

Constructors

Index()

Initializes a new instance of Index.

Properties

Description	The asset description text.
Id	Asset ID, a unique identifier for the asset.
Name	The name of the resource.
Tags	Tag dictionary. Tags can be added, removed, and updated.
Version	The version of the resource.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to

Share via