OnYourDataEndpointVectorizationSource Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

OnYourDataEndpointVectorizationSource.cs

The details of a a vectorization source, used by Azure OpenAI On Your Data when applying vector search, that is based on a public Azure OpenAI endpoint call for embeddings.

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

type OnYourDataEndpointVectorizationSource = class
    inherit OnYourDataVectorizationSource
    interface IJsonModel<OnYourDataEndpointVectorizationSource>
    interface IPersistableModel<OnYourDataEndpointVectorizationSource>

Public Class OnYourDataEndpointVectorizationSource
Inherits OnYourDataVectorizationSource
Implements IJsonModel(Of OnYourDataEndpointVectorizationSource), IPersistableModel(Of OnYourDataEndpointVectorizationSource)

Inheritance

Object

OnYourDataVectorizationSource

OnYourDataEndpointVectorizationSource

Implements

IJsonModel<OnYourDataEndpointVectorizationSource> IPersistableModel<OnYourDataEndpointVectorizationSource> IPersistableModel<T>

Constructors

OnYourDataEndpointVectorizationSource(Uri, OnYourDataAuthenticationOptions)

Initializes a new instance of OnYourDataEndpointVectorizationSource.

Properties

Authentication

Specifies the authentication options to use when retrieving embeddings from the specified endpoint. Please note OnYourDataAuthenticationOptions 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 OnYourDataAccessTokenAuthenticationOptions, OnYourDataApiKeyAuthenticationOptions, OnYourDataConnectionStringAuthenticationOptions, OnYourDataEncodedApiKeyAuthenticationOptions, OnYourDataKeyAndKeyIdAuthenticationOptions, OnYourDataSystemAssignedManagedIdentityAuthenticationOptions and OnYourDataUserAssignedManagedIdentityAuthenticationOptions.

Endpoint

Specifies the resource endpoint URL from which embeddings should be retrieved. It should be in the format of https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. The api-version query parameter is not allowed.

Explicit Interface Implementations

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