Documentation
Table of Contents

Class OpenAIProvider

Namespace
IntentSharp.Providers
Assembly
IntentSharp.dll

OpenAI Chat Completions provider. Supports JSON-schema structured output and text-embedding-3 embeddings.

public sealed class OpenAIProvider : HttpProviderBase, IAIProvider, IDisposable
Inheritance
object
OpenAIProvider
Implements
IDisposable
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()
Extension Methods

Constructors

OpenAIProvider(HttpProviderSettings, HttpClient?, ILogger?)

Creates the provider from full settings.

OpenAIProvider(string, string?, HttpClient?, ILogger?)

Creates the provider with an API key and the default settings.

Fields

DefaultEmbeddingModel

The embedding model used unless EmbeddingModel is set.

DefaultModelId

The model used when none is given to the constructor.

Properties

EmbeddingModel

The model EmbedAsync(string, CancellationToken) uses. Default DefaultEmbeddingModel.

Name

Always "OpenAI".

SupportsEmbeddings

Always true.

Methods

Authenticate(HttpRequestMessage)

Adds provider authentication headers to an outgoing request.

CompleteAsync(AIRequest, CancellationToken)

Sends the request to the Chat Completions API and returns the reply. A refusal is returned as the reply's text with IsRefusal set.

EmbedAsync(string, CancellationToken)

Returns the embedding vector of text from EmbeddingModel.