Class OpenAIBaseEndpoint

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

public abstract class OpenAIBaseEndpoint

Inheritance

object

OpenAIBaseEndpoint

Derived

AssistantsEndpoint

AudioEndpoint

BatchEndpoint

ChatEndpoint

EmbeddingsEndpoint

FilesEndpoint

FineTuningEndpoint

ImagesEndpoint

ModelsEndpoint

ModerationsEndpoint

RealtimeEndpoint

ConversationsEndpoint

ResponsesEndpoint

ThreadsEndpoint

VectorStoresEndpoint

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OpenAIBaseEndpoint(OpenAIClient)

protected OpenAIBaseEndpoint(OpenAIClient client)

Parameters

client OpenAIClient

Fields

client

protected readonly OpenAIClient client

Field Value

OpenAIClient

Properties

EnableDebug

Enables or disables the logging of all http responses of header and body information for this endpoint.
WARNING! Enabling this in your production build, could potentially leak sensitive information!

public bool EnableDebug { get; set; }

Property Value

bool

IsAzureDeployment

Indicates if the endpoint has an Azure Deployment.

protected virtual bool? IsAzureDeployment { get; }

Property Value

bool?

Remarks

If the endpoint is an Azure deployment, is true. If it is not an Azure deployment, is false. If it is not an Azure supported Endpoint, is null.

Root

The root endpoint address.

protected abstract string Root { get; }

Property Value

string

Methods

DeleteAsync(string, CancellationToken)

protected Task<HttpResponseMessage> DeleteAsync(string uri, CancellationToken cancellationToken)

Parameters

uri string

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

GetAsync(string, CancellationToken)

protected Task<HttpResponseMessage> GetAsync(string uri, CancellationToken cancellationToken)

Parameters

uri string

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

GetStreamAsync(string, CancellationToken)

protected Task<Stream> GetStreamAsync(string uri, CancellationToken cancellationToken)

Parameters

uri string

cancellationToken CancellationToken

Returns

Task<Stream>

GetUrl(string, Dictionary<string, string>)

Gets the full formatted url for the API endpoint.

protected string GetUrl(string endpoint = "", Dictionary<string, string> queryParameters = null)

Parameters

endpoint string

The endpoint url.

queryParameters Dictionary<string, string>

Optional, parameters to add to the endpoint.

Returns

string

GetWebsocketUri(string, Dictionary<string, string>)

protected string GetWebsocketUri(string endpoint = "", Dictionary<string, string> queryParameters = null)

Parameters

endpoint string

queryParameters Dictionary<string, string>

Returns

string

PatchAsync(string, HttpContent, CancellationToken)

protected Task<HttpResponseMessage> PatchAsync(string uri, HttpContent content, CancellationToken cancellationToken)

Parameters

uri string

content HttpContent

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>

PostAsync(string, HttpContent, CancellationToken)

protected Task<HttpResponseMessage> PostAsync(string uri, HttpContent content, CancellationToken cancellationToken)

Parameters

uri string

content HttpContent

cancellationToken CancellationToken

Returns

Task<HttpResponseMessage>