payload

class besser.agent.platforms.payload.Payload(action, message=None)

Bases: object

Represents a payload object used for encoding and decoding messages between an agent and any other external agent.

static decode(payload_str)

Decode a JSON payload string into a Payload object.

Parameters:

payload_str (str or dict) – A JSON-encoded payload string.

Returns:

A Payload object if the decoding is successful, None otherwise.

Return type:

Payload or None

class besser.agent.platforms.payload.PayloadAction(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Enumeration of the different possible actions embedded into a Payload.

AGENT_REPLY_DF = 'agent_reply_dataframe'

Indicates that the payload’s purpose is to send an agent reply containing a pandas.DataFrame object.

Type:

PayloadAction

AGENT_REPLY_FILE = 'agent_reply_file'

Indicates that the payload’s purpose is to send an agent reply containing a file.File object.

Type:

PayloadAction

AGENT_REPLY_HTML = 'agent_reply_html'

Indicates that the payload’s purpose is to send an agent reply containing a str object in HTML format.

Type:

PayloadAction

AGENT_REPLY_IMAGE = 'agent_reply_image'

Indicates that the payload’s purpose is to send an agent reply containing a file.File object, specifically an image.

Type:

PayloadAction

AGENT_REPLY_LOCATION = 'agent_reply_location'

Indicates that the payload’s purpose is to send an agent reply containing a location, which is a dictionary composed by a latitude and a longitude.

Type:

PayloadAction

AGENT_REPLY_MARKDOWN = 'agent_reply_markdown'

Indicates that the payload’s purpose is to send an agent reply containing a str object in Markdown format.

Type:

PayloadAction

AGENT_REPLY_OPTIONS = 'agent_reply_options'

Indicates that the payload’s purpose is to send an agent reply containing a list of strings, where the user should select 1 of them.

Type:

PayloadAction

AGENT_REPLY_PLOTLY = 'agent_reply_plotly'

Indicates that the payload’s purpose is to send an agent reply containing a plotly.graph_objs.Figure object.

Type:

PayloadAction

AGENT_REPLY_RAG = 'agent_reply_rag'

Indicates that the payload’s purpose is to send an agent reply containing a RAG (Retrieval Augmented Generation) answer, which contains an LLM-generated answer and a set of documents the LLM used as context (see besser.agent.nlp.rag.rag.RAGMessage).

Type:

PayloadAction

AGENT_REPLY_STR = 'agent_reply_str'

Indicates that the payload’s purpose is to send an agent reply containing a str object.

Type:

PayloadAction

RESET = 'reset'

Use the WebSocketPlatform on this agent.

Type:

PayloadAction

USER_FILE = 'user_file'

Indicates that the payload’s purpose is to send a user file.

Type:

PayloadAction

USER_MESSAGE = 'user_message'

Indicates that the payload’s purpose is to send a user message.

Type:

PayloadAction

USER_VOICE = 'user_voice'

Indicates that the payload’s purpose is to send a user audio.

Type:

PayloadAction

class besser.agent.platforms.payload.PayloadEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Bases: JSONEncoder

Encoder for the Payload class.

Example

import json
encoded_payload = json.dumps(payload, cls=PayloadEncoder)

default(obj)

Returns a serializable object for a Payload

Parameters:

obj – the object to serialize

Returns:

the serialized payload

Return type:

dict