AzureCosmosDBFieldMappingOptions Class

Reference

Definition

Namespace:: Azure.AI.OpenAI

Assembly:: Azure.AI.OpenAI.dll

Package:: Azure.AI.OpenAI v1.0.0-beta.17

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

Optional settings to control how fields are processed when using a configured Azure Cosmos DB resource.

public class AzureCosmosDBFieldMappingOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.AzureCosmosDBFieldMappingOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.AzureCosmosDBFieldMappingOptions>

type AzureCosmosDBFieldMappingOptions = class
    interface IJsonModel<AzureCosmosDBFieldMappingOptions>
    interface IPersistableModel<AzureCosmosDBFieldMappingOptions>

Public Class AzureCosmosDBFieldMappingOptions
Implements IJsonModel(Of AzureCosmosDBFieldMappingOptions), IPersistableModel(Of AzureCosmosDBFieldMappingOptions)

Inheritance: Object
AzureCosmosDBFieldMappingOptions

Implements: IJsonModel<AzureCosmosDBFieldMappingOptions> IPersistableModel<AzureCosmosDBFieldMappingOptions> IPersistableModel<T>

Constructors

AzureCosmosDBFieldMappingOptions(IEnumerable<String>, IEnumerable<String>)

Initializes a new instance of AzureCosmosDBFieldMappingOptions.

Properties

ContentFieldNames	The names of index fields that should be treated as content.
ContentFieldSeparator	The separator pattern that content fields should use.
FilepathFieldName	The name of the index field to use as a filepath.
TitleFieldName	The name of the index field to use as a title.
UrlFieldName	The name of the index field to use as a URL.
VectorFieldNames	The names of fields that represent vector data.

Explicit Interface Implementations

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

Applies to