Class OpenAIClient

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

Entry point to the OpenAI API, handling auth and allowing access to the various API endpoints

public sealed class OpenAIClient : IDisposable

Inheritance

object

OpenAIClient

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OpenAIClient(OpenAIAuthentication, OpenAIClientSettings, HttpClient)

Creates a new entry point to the OpenAPI API, handling auth and allowing access to the various API endpoints

public OpenAIClient(OpenAIAuthentication openAIAuthentication = null, OpenAIClientSettings clientSettings = null, HttpClient client = null)

Parameters

openAIAuthentication OpenAIAuthentication

The API authentication information to use for API calls, or null to attempt to use the Default, potentially loading from environment vars or from a config file.

clientSettings OpenAIClientSettings

The API client settings for specifying OpenAI deployments to Azure, a proxy domain, or null to attempt to use the Default, potentially loading from environment vars or from a config file.

client HttpClient

A HttpClient.

Remarks

OpenAIClient implements IDisposable to manage the lifecycle of the resources it uses, including HttpClient. When you initialize OpenAIClient, it will create an internal HttpClient instance if one is not provided. This internal HttpClient is disposed of when OpenAIClient is disposed of. If you provide an external HttpClient instance to OpenAIClient, you are responsible for managing its disposal.

Exceptions

AuthenticationException

Raised when authentication details are missing or invalid.

Properties

AssistantsEndpoint

Build assistants that can call models and use tools to perform tasks.
https://platform.openai.com/docs/api-reference/assistants

public AssistantsEndpoint AssistantsEndpoint { get; }

Property Value

AssistantsEndpoint

AudioEndpoint

Transforms audio into text.
https://platform.openai.com/docs/api-reference/audio

public AudioEndpoint AudioEndpoint { get; }

Property Value

AudioEndpoint

BatchEndpoint

Create large batches of API requests for asynchronous processing. The Batch API returns completions within 24 hours for a 50% discount. https://platform.openai.com/docs/api-reference/batch

public BatchEndpoint BatchEndpoint { get; }

Property Value

BatchEndpoint

ChatEndpoint

Given a chat conversation, the model will return a chat completion response.
https://platform.openai.com/docs/api-reference/chat

public ChatEndpoint ChatEndpoint { get; }

Property Value

ChatEndpoint

EmbeddingsEndpoint

Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
https://platform.openai.com/docs/guides/embeddings

public EmbeddingsEndpoint EmbeddingsEndpoint { get; }

Property Value

EmbeddingsEndpoint

EnableDebug

Enables or disables debugging for all endpoints.

public bool EnableDebug { get; set; }

Property Value

bool

FilesEndpoint

Files are used to upload documents that can be used with features like Assistants, Fine-tuning, and Batch API.
https://platform.openai.com/docs/api-reference/files

public FilesEndpoint FilesEndpoint { get; }

Property Value

FilesEndpoint

FineTuningEndpoint

Manage fine-tuning jobs to tailor a model to your specific training data.
https://platform.openai.com/docs/guides/fine-tuning

public FineTuningEndpoint FineTuningEndpoint { get; }

Property Value

FineTuningEndpoint

ImagesEndPoint

Given a prompt and/or an input image, the model will generate a new image.
https://platform.openai.com/docs/api-reference/images

public ImagesEndpoint ImagesEndPoint { get; }

Property Value

ImagesEndpoint

ModelsEndpoint

List and describe the various models available in the API. You can refer to the Models documentation to understand which models are available for certain endpoints: https://platform.openai.com/docs/models/model-endpoint-compatibility.
https://platform.openai.com/docs/api-reference/models

public ModelsEndpoint ModelsEndpoint { get; }

Property Value

ModelsEndpoint

ModerationsEndpoint

The moderation endpoint is a tool you can use to check whether content complies with OpenAI's content policy. Developers can thus identify content that our content policy prohibits and take action, for instance by filtering it.
https://platform.openai.com/docs/api-reference/moderations

public ModerationsEndpoint ModerationsEndpoint { get; }

Property Value

ModerationsEndpoint

OpenAIAuthentication

The API authentication information to use for API calls

public OpenAIAuthentication OpenAIAuthentication { get; }

Property Value

OpenAIAuthentication

RealtimeEndpoint

public RealtimeEndpoint RealtimeEndpoint { get; }

Property Value

RealtimeEndpoint

ThreadsEndpoint

Create threads that assistants can interact with.
https://platform.openai.com/docs/api-reference/threads

public ThreadsEndpoint ThreadsEndpoint { get; }

Property Value

ThreadsEndpoint

VectorStoresEndpoint

Vector stores are used to store files for use by the file_search tool. https://platform.openai.com/docs/api-reference/vector-stores

public VectorStoresEndpoint VectorStoresEndpoint { get; }

Property Value

VectorStoresEndpoint

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

~OpenAIClient()

protected ~OpenAIClient()