Type Alias GenerateOffChunksReqPayload

GenerateOffChunksReqPayload: {
    audio_input?: string | null;
    chunk_ids: string[];
    context_options?: ContextOptions | null;
    frequency_penalty?: number | null;
    highlight_results?: boolean | null;
    image_config?: ImageConfig | null;
    image_urls?: string[] | null;
    max_tokens?: number | null;
    metadata?: unknown;
    model?: string | null;
    presence_penalty?: number | null;
    prev_messages: ChatMessageProxy[];
    prompt?: string | null;
    stop_tokens?: string[] | null;
    stream_response?: boolean | null;
    temperature?: number | null;
    user_id?: string | null;
}

Type declaration

  • Optionalaudio_input?: string | null

    Audio input to be used in the chat. This will be used to generate the audio tokens for the model. The default is None.

  • chunk_ids: string[]

    The ids of the chunks to be retrieved and injected into the context window for RAG.

  • Optionalcontext_options?: ContextOptions | null
  • Optionalfrequency_penalty?: number | null

    Frequency penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. Default is 0.7.

  • Optionalhighlight_results?: boolean | null

    Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <mark><b> tags to the chunk_html of the chunks to highlight matching splits.

  • Optionalimage_config?: ImageConfig | null
  • Optionalimage_urls?: string[] | null

    Image URLs to be used in the chat. These will be used to generate the image tokens for the model. The default is None.

  • Optionalmax_tokens?: number | null

    The maximum number of tokens to generate in the chat completion. Default is None.

  • Optionalmetadata?: unknown

    Metadata is any metadata you want to associate w/ the event that is created from this request

  • Optionalmodel?: string | null

    Model to use for the completion. If not specified, the default model configured for the dataset will be used.

  • Optionalpresence_penalty?: number | null

    Presence penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. Default is 0.7.

  • prev_messages: ChatMessageProxy[]

    The previous messages to be placed into the chat history. There must be at least one previous message.

  • Optionalprompt?: string | null

    Prompt will be used to tell the model what to generate in the next message in the chat. The default is 'Respond to the previous instruction and include the doc numbers that you used in square brackets at the end of the sentences that you used the docs for:'. You can also specify an empty string to leave the final message alone such that your user's final message can be used as the prompt. See docs.trieve.ai or contact us for more information.

  • Optionalstop_tokens?: string[] | null

    Stop tokens are up to 4 sequences where the API will stop generating further tokens. Default is None.

  • Optionalstream_response?: boolean | null

    Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true.

  • Optionaltemperature?: number | null

    What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default is 0.5.

  • Optionaluser_id?: string | null

    User ID is the id of the user who is making the request. This is used to track user interactions with the RAG results.

Settings

Member Visibility