OnYourDataEncodedApiKeyAuthenticationOptions Class

Definition

Namespace:

Azure.AI.OpenAI

Assembly:

Azure.AI.OpenAI.dll

Package:

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

Source:

OnYourDataEncodedApiKeyAuthenticationOptions.cs

The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key.

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

type OnYourDataEncodedApiKeyAuthenticationOptions = class
    inherit OnYourDataAuthenticationOptions
    interface IJsonModel<OnYourDataEncodedApiKeyAuthenticationOptions>
    interface IPersistableModel<OnYourDataEncodedApiKeyAuthenticationOptions>

Public Class OnYourDataEncodedApiKeyAuthenticationOptions
Inherits OnYourDataAuthenticationOptions
Implements IJsonModel(Of OnYourDataEncodedApiKeyAuthenticationOptions), IPersistableModel(Of OnYourDataEncodedApiKeyAuthenticationOptions)

Inheritance

Object

OnYourDataAuthenticationOptions

OnYourDataEncodedApiKeyAuthenticationOptions

Implements

IJsonModel<OnYourDataEncodedApiKeyAuthenticationOptions> IPersistableModel<OnYourDataEncodedApiKeyAuthenticationOptions> IPersistableModel<T>

Constructors

OnYourDataEncodedApiKeyAuthenticationOptions(String)

Initializes a new instance of OnYourDataEncodedApiKeyAuthenticationOptions.

Properties

EncodedApiKey

The encoded API key to use for authentication.

Explicit Interface Implementations

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