blab_chatbot_openai.openai_settings_format

A module that defines the expected format of the configuration file.

See the file settings_openai_TEMPLATE.py for a template.

Module Contents

Classes

OpenAICompletionCreateArgs	Contains arguments used to create an instance of Completion/ChatCompletion.
OpenAISettings	Contains parameters related to the OpenAI service.
BlabOpenAIClientSettings	A protocol that should be implemented by the configuration file.

class OpenAICompletionCreateArgs

Bases: TypedDict

Contains arguments used to create an instance of Completion/ChatCompletion.

The field “prompt” or “messages” is included automatically and should not be in the settings file.

See the documentation: https://platform.openai.com/docs/api-reference/completions/create?lang=python and https://platform.openai.com/docs/api-reference/chat/create?lang=python

Initialize self. See help(type(self)) for accurate signature.

model: str

max_tokens: int

temperature: float

top_p: float

n: int

stream: bool

logprobs: int

stop: str | list[str]

presence_penalty: float

frequency_penalty: float

best_of: int

logit_bias: dict[str, float]

user: str

class OpenAISettings

Bases: TypedDict

Contains parameters related to the OpenAI service.

Initialize self. See help(type(self)) for accurate signature.

API_KEY: str

OpenAI API key

COMPLETION_CREATE_ARGS: OpenAICompletionCreateArgs

Arguments to create the completion instance

COMPLETION_CLASS: Literal[openai.Completion, openai.ChatCompletion]

openai.ChatCompletion or openai.Completion, depending on the model

HISTORY_SIZE: int

Number of previous messages to send to the server (only for ChatCompletion)

class BlabOpenAIClientSettings

Bases: blab_chatbot_bot_client.settings_format.BlabWebSocketBotClientSettings, Protocol

A protocol that should be implemented by the configuration file.

It extends the parent protocol (BlabBotClientSettings) with the inclusion of the OPENAI_SETTINGS field.

OPENAI_SETTINGS: OpenAISettings

OpenAI-specific settings