blab_chatbot_deepage.deepage_settings_format#

Defines the expected format of the configuration file.

Module Contents#

Classes#

DeepageSettings

Settings that are specific to the DEEPAGÉ client.

BlabDeepageClientSettings

An extension of BlabBotClientSettings including DEEPAGÉ-specific settings.

class DeepageSettings#

Bases: TypedDict

Settings that are specific to the DEEPAGÉ client.

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

GREETING_TEXT: str#

Text sent in the first message.

ES_INDEX_NAME: str#

Name of the Elasticsearch index to be used

CSV_DOCUMENT_PATH: str#

Path to the document file

MODEL_PATH: str#

Path to the model directory

MAX_INPUT_LENGTH: int#

Maximum truncation length

MAX_TARGET_LENGTH: int#

Maximum target length

K_RETRIEVAL: int#

The number of documents that the retriever should find

class BlabDeepageClientSettings#

Bases: blab_chatbot_bot_client.settings_format.BlabWebSocketBotClientSettings, Protocol

An extension of BlabBotClientSettings including DEEPAGÉ-specific settings.

DEEPAGE_SETTINGS: DeepageSettings#

Settings for DEEPAGÉ