Skip to main content
Version: Beta

AssistantConversationMessageRequest

type AssistantConversationMessageRequest {
  id: String!
  question: String!
  questionMarkdown: String
  documents: [Document!]
  selectedFilters: DocumentFilterFormat
  useWebSearch: Boolean
  useXSearch: Boolean
  mode: AssistantAskQuestionMode
  context: [AssistantRequestContext!]
  useContextSearchMode: Boolean
  useUserDefaultSources: Boolean
  artifactMode: AssistantArtifactType
  artifactId: String
  slideTemplateId: String
}

Fields​

AssistantConversationMessageRequest.id ● String! non-null scalar graph-ql-types​

The id of the request. Combination of message_id and post-fix @exposed

AssistantConversationMessageRequest.question ● String! non-null scalar graph-ql-types​

The user asked question of the request. @exposed

AssistantConversationMessageRequest.questionMarkdown ● String scalar graph-ql-types​

Markdown version of the user's question. Supports bold, italics, lists, etc. @exposed

AssistantConversationMessageRequest.documents ● [Document!] list object graph-ql-types​

Documents that are used to generate the response. @exposed

AssistantConversationMessageRequest.selectedFilters ● DocumentFilterFormat object graph-ql-types​

Filters applied on top of the initial request filters. @exposed

Use web search in answer generation. This can be used for now only with deep research mode. @exposed

AssistantConversationMessageRequest.useXSearch ● Boolean scalar graph-ql-types​

Use X (formerly Twitter) social signal search in answer generation. Mirrors the useWebSearch pattern - true means the x_search tool was enabled for this request and the FE should reflect the toggle as on. @exposed

AssistantConversationMessageRequest.mode ● AssistantAskQuestionMode enum graph-ql-types​

Mode of the request generation. @exposed

AssistantConversationMessageRequest.context ● [AssistantRequestContext!] list union graph-ql-types​

Context items attached to the request (documents, folders, etc.) @exposed

AssistantConversationMessageRequest.useContextSearchMode ● Boolean scalar graph-ql-types​

If turned on the context goes outside of the passed context parameters, otherwise limits context to the passed context parameters. @exposed

AssistantConversationMessageRequest.useUserDefaultSources ● Boolean scalar graph-ql-types​

Whether user default sources toggle was enabled for this request. @exposed

AssistantConversationMessageRequest.artifactMode ● AssistantArtifactType enum graph-ql-types​

Artifact mode of the request generation. @exposed

AssistantConversationMessageRequest.artifactId ● String scalar graph-ql-types​

ID of the artifact this message is associated with (e.g. grid ID for GEN_GRID follow-ups). @exposed

AssistantConversationMessageRequest.slideTemplateId ● String scalar graph-ql-types​

ID of the slide template this message is associated with. Only for SLIDE_REPORT type message @exposed

Member Of​

AssistantConversationMessage object