Skip to main content

Interact with the Chat Application

This endpoint allows users to interact with a Chat Application based on a knowledge base or application.

Request Body REQUIRED
question string REQUIRED

The question to be searched.

sessionId string

The session ID for the chat.

modelName string

The name of the model to use for generating the response.

temperature number

The temperature value for response randomness. Must be a float between 0.0 and 1.0.

maxTokens integer

The maximum number of tokens in the response. Must be an integer between 0 and 2000.

Responses
200

Chat API Response

Schema OPTIONAL
status integer OPTIONAL

The HTTP status code.

message string OPTIONAL

A message describing the response.

data object OPTIONAL
text string OPTIONAL

The text response.

sourceDocuments object[] OPTIONAL
pageContent string OPTIONAL

The content of the source document page.

metadata object OPTIONAL
loc.lines.from integer OPTIONAL

Start line number of content in source document.

loc.lines.to integer OPTIONAL

End line number of content in source document.

reference_url string OPTIONAL

URL of the reference source document.

source string OPTIONAL

Source of the content.

sessionId string OPTIONAL

The session ID for the chat.

history array[] OPTIONAL
400

Knowledge Base validation error

Schema OPTIONAL
status number
message string
errors undefined[]
500

Server Error

Schema OPTIONAL
message string