Skip to main content
Version: Beta

ExternalAskQuestionInput

description

Input parameters for the externalAskQuestion subscription.

input ExternalAskQuestionInput {
  prompt: String!
  conversationId: String
  mode: AssistantAskQuestionMode
  filters: SearchFilter
  documents: [GenSearchDocumentInput!]
  useWebSearch: Boolean
  useXSearch: Boolean
  artifactMode: AssistantArtifactType
}

Fields​

ExternalAskQuestionInput.prompt ● String! non-null scalar graph-ql-types​

The user's question or prompt text.

ExternalAskQuestionInput.conversationId ● String scalar graph-ql-types​

Conversation ID for follow-up questions within an existing conversation thread.

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

Processing mode controlling depth and speed of response generation.

ExternalAskQuestionInput.filters ● SearchFilter input graph-ql-types​

Optional filters to refine the documents searched. Supports filtering by companies, date range, document types, industries, countries, and more. Cannot be used together with 'documents'.

ExternalAskQuestionInput.documents ● [GenSearchDocumentInput!] list input graph-ql-types​

Specific document IDs to use as context for answering the question. Cannot be used together with 'filters'.

Enable web search for additional context in answer generation. Can be combined with 'filters'. Cannot be used with 'documents'.

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

Enable X (formerly Twitter) social signal search for additional context in answer generation. Mirrors the useWebSearch pattern.

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

Secondary generation mode. Use SLIDE_REPORT to explicitly request slide artifact generation.

Member Of​

externalAskQuestion subscription