ResearchResponse

Response object returned after a research request.

Properties

Property	Required	Type	Description
interactionId	True	String	ID of the current interaction in the conversation.
answer	True	ResearchAnswer	The answer from the research agent.
chunks	True	List[Chunk]	Text chunks used for generating the answer.
paragraphs	True	List[Paragraph]	Article paragraphs from which the chunk texts are taken.
articles	False	List[Article]	Articles to which the paragraphs belong. Returned only when returnArticles is true in the request.
chunkDuplicates	False	List[ChunkDuplicate]	Any duplicates of the source chunks. Returned only when returnDuplicates is true in the request.
paragraphDuplicates	False	List[Paragraph]	Article paragraphs from which duplicate chunks’ text is taken.
articleDuplicates	False	List[ArticleDuplicate]	Any duplicates of the source articles. Returned only when both returnDuplicates and returnArticles are true in the request.
history	False	List[HistoryInteraction]	History of the current conversation in an abbreviated text-only format. Returned only when returnHistory is true in the request.

Note: The chunk and paragraph id fields are only valid within a single API response. They are not global unique identifiers and carry no other meaning. They should only be used to locate chunk and paragraph objects within that response.