OpenAI Compatible Chat Provider

Base class for prompt providers.

class smarter.apps.provider.services.text_completion.lib.openai_compatible_chat_provider.OpenAISmarterClient(provider, provider_name, base_url, api_key, default_model, default_system_role='You are a helpful llm_client. When given the opportunity to utilize function calling, you should always do so. This will allow you to provide the best possible responses to the user. If you are unable to provide a response, you should prompt the user for more information. If you are still unable to provide a response, you should inform the user that you are unable to help them at this time.', default_temperature=0.5, default_max_tokens=2048, valid_chat_completion_models=None, add_built_in_tools=False, **kwargs)[source]

Bases: SmarterChatProviderBase

Prompt provider for OpenAI-compatible text completion APIs.

This provider class enables seamless integration with any vendor or service that implements the OpenAI prompt completion API, including both OpenAI and third-party providers that adhere to the same protocol and message formats.

Key Features:

Supports OpenAI’s prompt completion API and compatible alternatives.

Handles message formatting, tool calls, plugin integration, and billing.

Manages multi-step prompt completion workflows, including tool and plugin responses.

Provides hooks for plugin selection, function registration, and error handling.

Usage:

Inherit from this class to implement a prompt provider that communicates with any OpenAI-compatible API endpoint. This class is suitable for use cases where you want to support multiple LLM vendors with a unified interface.

Example:

class MyProvider(OpenAISmarterClient):
    pass

provider = MyProvider()
response = provider.handler(user_profile, prompt, data)

See also

_InternalKeys OpenAIMessageKeys PluginBase ChatCompletion ChatCompletionMessageToolCall

Example usage:

response = provider.handler(
    prompt=chat_instance,
    data=request_data,
    plugins=[plugin1, plugin2],
    functions=[function_definition_1, function_definition_2],
    user_profile=current_user
)

input_text: str | None

iteration: int

max_completion_tokens: int | None

model: str | None

property new_messages: list[dict[str, Any]]

Return a list of messages that are marked as new.

This property filters the internal message list to return only those messages that have the ‘smarter_is_new’ flag set to True.

Returns:: A list of new messages.
Return type:: list[dict[str, Any]]

property openai_messages: list[dict[str, Any]]

Return a sanitized list of messages compatible with OpenAI’s prompt completion API.

This property processes the internal message list, removing Smarter-specific annotations (such as metadata about tool calls and interim completion token charges) to ensure that only valid OpenAI message fields are included. This is essential for avoiding API errors related to unexpected or extraneous fields.

Returns:: A list of dictionaries representing prompt messages, formatted for OpenAI’s API.
Return type:: list[dict[str, Any]]
Raises:: SmarterValueError – If the internal message list is not a list.

Example:

[
    {
        "role": "assistant",
        "content": "Welcome to Smarter!",
        "tool_calls": [
            {
                "id": "call_ABC123",
                "type": "function",
                "function": {
                    "name": "smarter_plugin_0000000045",
                    "arguments": "{"description":"AI"}"
                }
            }
        ]
    },
    {
        "role": "tool",
        "name": "smarter_plugin_0000000045",
        "content": "SqlPlugin stackademy_sql response: ...",
        "tool_call_id": "call_ABC123"
    }
]

Important

OpenAI expects that every assistant message with a tool_calls field is immediately followed by a corresponding tool message for each tool_call_id. Failure to do so will result in an API error.
If you include Smarter-specific fields (such as smarter_is_new) in the message list, OpenAI’s API may reject the request.
On the first iteration, tool call responses are excluded from the message list to comply with OpenAI’s requirements.