Skip to main content
Version: v5.3

Non-streaming conversations

Overview​

A non-streaming conversation will just provide simple notifications to let the user know that the AI Service has started and then at the end, that it has concluded or resulted in an error.

How to create a conversation​

To create a non-streaming conversation with a team, do the following:

  1. In the Conversation Javascript object, enter the ID of the Team you want to recruit for the conversation in the property _teamId.
  2. Pass the user's question in the property _input.message.
  3. Submit this Conversation object to the createConversation Javascript API.

As an example, refer to the Conversation object below.

{
_id: "8c7c8cbc-8197-4ddd-a8b8-062e3f0d4474",
_input: {
"message": "filter only dtType Glazing - Exterior"
},
_teamId: "fd0b746e-050b-40b4-bf1b-cc423402176e"
}

Conversation properties​

PropertyTypeRequiredDescription
_idStringOptionalConversation ID to continue an existing conversation
_inputObjectRequiredInput for the conversation.
messageStringRequiredThe text input message content to send to the generative AI.
_teamIdStringNoThe team ID for the conversation