Click or drag to resize

AIProvider Class

Base class for AI chat providers: holds the common connection and generation parameters and the factory methods to create a provider from a configuration.
Inheritance Hierarchy

Namespace: Seal.AI
Assembly: SealLibrary (in SealLibrary.dll) Version: 10.0.1.0+a44cd3a7f03c2bf3cdbd971a878c679e40bed08a
Syntax
C#
Copy
public abstract class AIProvider : IAIProvider

The AIProvider type exposes the following members.

Constructors
 NameDescription
Protected methodAIProviderInitializes a new instance of the AIProvider class
Top
Properties
 NameDescription
Public propertyGUIDUnique identifier for this provider instance.
Public propertyLastUsage Token usage of the last API call (input/output tokens, one call). Zeroes when the API did not report usage information.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodStatic memberGetAIProvider Creates, initialises, and returns a provider for the given providerType.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodStatic memberGetProvider Resolves a provider configuration by name, creates it, and returns it. Pass null or empty to use the default provider (set via DefaultProviderGUID).
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodHandleChat Sends messages to the AI and returns the agent reply. The reply is automatically appended to messages.
Public methodHandleChatWithTools Sends messages together with available tools to the AI. If the model decides to invoke one or more tools the descriptors are placed in toolCalls and the method returns Empty; the agent message (with embedded tool-call data) is appended to messages automatically so the conversation can be continued after the caller executes the tools. If the model produces a text reply the reply is appended to messages and returned.
Protected methodInitialize Configures the provider with the endpoint URL, API key, model name, and generation parameters. Called internally by GetAIProvider(ProviderType, String, String, String, Single, Int32, Single) immediately after construction.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodSetLastUsage Records the token usage of the API call that just completed.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Protected field_apiKeyAPI key used to authenticate against the provider.
Protected field_endpointResource endpoint URL of the provider API.
Protected field_maxTokensMaximum number of tokens to generate (0 = provider default).
Protected field_modelName of the model to use (e.g. gpt-4o, claude-3-5-sonnet-20241022, llama3).
Protected field_temperatureSampling temperature (0.0 = default, deterministic).
Protected field_topPNucleus sampling probability (1.0 = default, disabled).
Top
See Also