The response object
A response is Jockey’s reply to a request, generated by reasoning over the content in a knowledge store.
The object is composed of the following fields:
id: A string representing the unique identifier of the response.knowledge_store_id: A string representing the unique identifier of the knowledge store the response was generated against.session_id: A string representing the session identifier for the conversation. Pass it in subsequent requests to continue the multi-turn conversation.type: A string representing the object type. The value is alwaysresponse.status: A string representing the status of the response. See the Response statuses section for the meaning of each value.output: An array of output items. By default, only the final message is included. To also receive function call items, setincludeto["intermediate_outputs"]in the request.usage: An object containing token usage statistics, withinput_tokensandoutput_tokensfields.created_at: A string representing the date and time, in the RFC 3339 format, when the response was created.
Response statuses
The status field of a response has one of the following values:
in_progress: The response is being generated.completed: The response has been generated successfully.incomplete: The response was truncated when it reached the token limit. The output may be incomplete.failed: The response generation has failed.