Class DataSourceVectorizer

A representation of a data vectorization source usable as an embedding resource with a data source. Please note this is the abstract base class. The derived classes available for instantiation are:

Inheritance

System.Object

DataSourceVectorizer

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.OpenAI.dll

Syntax

[OpenAI.CodeGenType("AzureChatDataSourceVectorizationSource")]
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.OpenAI.Chat.InternalUnknownAzureChatDataSourceVectorizationSource))]
public abstract class DataSourceVectorizer : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Chat.DataSourceVectorizer>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Chat.DataSourceVectorizer>

Methods

FromDeploymentName(String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceVectorizer FromDeploymentName (string deploymentName);

Parameters

System.String deploymentName

Returns

DataSourceVectorizer

FromEndpoint(Uri, DataSourceAuthentication)

Creates a new data source embedding dependency reference from an authenticated endpoint.

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceVectorizer FromEndpoint (Uri endpoint, Azure.AI.OpenAI.Chat.DataSourceAuthentication authentication);

Parameters

System.Uri endpoint The endpoint to use for vectorization.

DataSourceAuthentication authentication The authentication mechanism to use with the endpoint.

Returns

DataSourceVectorizer

Remarks

Vectorization endpoint authentication only supports api-key- and access-token-based authentication, as created via FromApiKey(String) and FromAccessToken(String), respectively.

FromIntegratedResource()

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceVectorizer FromIntegratedResource ();

Returns

DataSourceVectorizer

FromModelId(String)

Declaration

public static Azure.AI.OpenAI.Chat.DataSourceVectorizer FromModelId (string modelId);

Parameters

System.String modelId

Returns

DataSourceVectorizer

JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.DataSourceVectorizer JsonModelCreateCore (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The JSON reader.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

DataSourceVectorizer

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)

Declaration

protected virtual Azure.AI.OpenAI.Chat.DataSourceVectorizer PersistableModelCreateCore (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The data to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

DataSourceVectorizer

PersistableModelWriteCore(ModelReaderWriterOptions)

Declaration

protected virtual BinaryData PersistableModelWriteCore (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Returns

System.BinaryData

Operators

Explicit(ClientResult to DataSourceVectorizer)

Declaration

public static explicit operator Azure.AI.OpenAI.Chat.DataSourceVectorizer (System.ClientModel.ClientResult result);

Parameters

System.ClientModel.ClientResult result The System.ClientModel.ClientResult to deserialize the DataSourceVectorizer from.

Returns

DataSourceVectorizer

Implicit(DataSourceVectorizer to BinaryContent)

Declaration

public static implicit operator System.ClientModel.BinaryContent (Azure.AI.OpenAI.Chat.DataSourceVectorizer dataSourceVectorizer);

Parameters

DataSourceVectorizer dataSourceVectorizer The DataSourceVectorizer to serialize into System.ClientModel.BinaryContent.

Returns

System.ClientModel.BinaryContent

Explicit Interface Implementations

IJsonModel<DataSourceVectorizer>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration

Azure.AI.OpenAI.Chat.DataSourceVectorizer IJsonModel<DataSourceVectorizer>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

DataSourceVectorizer A T representation of the JSON value.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<DataSourceVectorizer>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration

void IJsonModel<DataSourceVectorizer>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataSourceVectorizer>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.AI.OpenAI.Chat.DataSourceVectorizer IPersistableModel<DataSourceVectorizer>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

DataSourceVectorizer A T representation of the data.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<DataSourceVectorizer>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration

string IPersistableModel<DataSourceVectorizer>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns

System.String The format that the model uses when communicating with the serivce.

IPersistableModel<DataSourceVectorizer>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<DataSourceVectorizer>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

System.BinaryData A binary representation of the written model.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.