abacusai.deployment_conversation_event

Module Contents

Classes

DeploymentConversationEvent

A single deployment conversation message.

class abacusai.deployment_conversation_event.DeploymentConversationEvent(client, role=None, text=None, timestamp=None, messageIndex=None, regenerateAttempt=None, modelVersion=None, searchResults=None, isUseful=None, feedback=None, feedbackType=None, docInfos=None, keywordArguments=None, attachments=None, chatType=None, agentResponse=None, error=None)

Bases: abacusai.return_class.AbstractApiClass

A single deployment conversation message.

Parameters:
  • client (ApiClient) – An authenticated API Client instance

  • role (str) – The role of the message sender

  • text (str) – The text of the message

  • timestamp (str) – The timestamp at which the message was sent

  • messageIndex (int) – The index of the message in the conversation

  • regenerateAttempt (int) – The sequence number of regeneration. Not regenerated if 0.

  • modelVersion (str) – The model instance id associated with the message.

  • searchResults (dict) – The search results for the message.

  • isUseful (bool) – Whether this message was marked as useful or not

  • feedback (str) – The feedback provided for the message

  • feedbackType (str) – The type of feedback provided for the message

  • docInfos (list) – A list of information on the documents associated with the message

  • keywordArguments (dict) – User message only. A dictionary of keyword arguments used to generate response.

  • attachments (list) – A list of attachments associated with the message.

  • chatType (str) – The type of chat llm that was run for the message.

  • agentResponse (dict) – Response from the agent. Only for conversation with agents.

  • error (str) – The error message in case of an error.

__repr__()

Return repr(self).

to_dict()

Get a dict representation of the parameters in this class

Returns:

The dict value representation of the class parameters

Return type:

dict