SubmitChatOptions
Prop | Type | Description |
---|---|---|
assistantId | string | The assistant ID. |
assistantVersionId | string | The assistant version ID. If not provided, the default version of the assistant will be used. |
systemPrompt | string | The system prompt. |
context | any | Context to use for template variable replacements in the system prompt. Default: |
model | ChatCompletionsModel | The OpenAI model to use. Default: |
policiesOptions | PoliciesOptions | Options for the use of policies. |
retrievalOptions | RetrievalOptions | Options for retrieval. |
outputFormat | 'markdown' | 'slack' | 'html' | The output format of the response. Default: |
jsonOutput | boolean | If true, output the response in JSON format. Default: |
redact | boolean | Remove PII from chat messages. Default: |
temperature | number | The model temperature. Default: |
topP | number | The model top P. Default: |
frequencyPenalty | number | The model frequency penalty. Default: |
presencePenalty | number | The model present penalty. Default: |
maxTokens | number | The max number of tokens to include in the response. Default: |
sectionsMatchCount | number | The number of sections to include in the prompt context. Default: |
sectionsMatchThreshold | number | The similarity threshold between the input question and selected sections. Default: |
threadId | string | Thread ID. Returned with the first, and every subsequent, chat response. Used to continue a thread. |
tools | ChatCompletionTool[] | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. |
toolChoice | ChatCompletionToolChoiceOption | Controls which (if any) function is called by the model. |
doNotInjectContext | boolean | Whether or not to inject context relevant to the query. Default: |
allowFollowUpQuestions | boolean | If true, the bot may encourage the user to ask a follow-up question, for instance to gather additional information. Default: |
excludeFromInsights | boolean | Whether or not to include message in insights. Default: |
signal | AbortSignal | AbortController signal. |
debug | boolean | Enabled debug mode. This will log debug and error information to the console. Default: |
stream | boolean | Disable streaming and return the entire response at once. |