OpenAnima 0.2.0
Middleware for conversational NPCs that interact with the player, the world and each other
Loading...
Searching...
No Matches
Public Member Functions | List of all members
OpenAnima::Provider::RestProvider Class Reference

#include <RestProvider.h>

Inheritance diagram for OpenAnima::Provider::RestProvider:
OpenAnima::Provider::IProvider

Public Member Functions

 RestProvider (RestProviderConfig config, std::shared_ptr< OpenAnima::Http::HttpTransport > transport)
 
OpenAnima::Core::Completion complete (const std::vector< OpenAnima::Core::ChatMessage > &messages, const Call &call) override
 
OpenAnima::Core::Completion complete (const std::vector< OpenAnima::Core::ChatMessage > &messages, const DeltaSink &onDelta)
 
OpenAnima::Core::Completion complete (const std::vector< OpenAnima::Core::ChatMessage > &messages)
 
const RestProviderConfig & config () const noexcept
 
- Public Member Functions inherited from OpenAnima::Provider::IProvider
 IProvider (const IProvider &)=delete
 Providers are used through a pointer, so copying and moving are not offered.
 
IProvider & operator= (const IProvider &)=delete
 
 IProvider (IProvider &&)=delete
 
IProvider & operator= (IProvider &&)=delete
 
OpenAnima::Core::Completion complete (const std::vector< OpenAnima::Core::ChatMessage > &messages, const DeltaSink &onDelta)
 
OpenAnima::Core::Completion complete (const std::vector< OpenAnima::Core::ChatMessage > &messages)
 

Additional Inherited Members

- Protected Member Functions inherited from OpenAnima::Provider::IProvider
 IProvider ()=default
 Only derived classes build a provider.
 

Detailed Description

Provider for the OpenAI chat-completions contract, which is also spoken by local servers such as Ollama, llama.cpp and vLLM.

Constructor & Destructor Documentation

◆ RestProvider()

OpenAnima::Provider::RestProvider::RestProvider ( RestProviderConfig  config,
std::shared_ptr< OpenAnima::Http::HttpTransport >  transport 
)

Creates a provider.

Parameters
configEndpoint, model and generation settings.
transportHTTP boundary used for every call.

Member Function Documentation

◆ complete() [1/3]

OpenAnima::Core::Completion OpenAnima::Provider::RestProvider::complete ( const std::vector< OpenAnima::Core::ChatMessage > &  messages)
inline

Sends a whole conversation and waits for the answer.

Parameters
messagesConversation in chronological order; the last entry is the current turn.
Returns
The assistant answer, its metadata, and why generation stopped.
Exceptions
OpenAnimaErrorsubclasses when the call cannot be completed.

References OpenAnima::Provider::IProvider::complete().

◆ complete() [2/3]

OpenAnima::Core::Completion OpenAnima::Provider::RestProvider::complete ( const std::vector< OpenAnima::Core::ChatMessage > &  messages,
const Call &  call 
)
overridevirtual

Sends a whole conversation and returns the answer.

The same contract as the interface, written out again because the interface has three complete members and a @copydoc cannot say which one counts.

Parameters
messagesConversation in chronological order; the last entry is the current turn.
callWhere the pieces go, and how the call can be abandoned.
Returns
The assistant answer, its metadata, and why generation stopped.
Exceptions
OpenAnimaErrorsubclasses when the call cannot be completed.

Implements OpenAnima::Provider::IProvider.

◆ complete() [3/3]

OpenAnima::Core::Completion OpenAnima::Provider::RestProvider::complete ( const std::vector< OpenAnima::Core::ChatMessage > &  messages,
const DeltaSink &  onDelta 
)
inline

Sends a whole conversation and reports the answer while it is produced.

Parameters
messagesConversation in chronological order; the last entry is the current turn.
onDeltaCalled with every piece of the answer as it arrives, in order.
Returns
The assistant answer, its metadata, and why generation stopped.
Exceptions
OpenAnimaErrorsubclasses when the call cannot be completed.

References OpenAnima::Provider::IProvider::complete().

◆ config()

const RestProviderConfig & OpenAnima::Provider::RestProvider::config ( ) const
inlinenoexcept
Returns
The configuration this provider was created with.

The documentation for this class was generated from the following file: