Type Alias SuggestedQueriesReqPayload

SuggestedQueriesReqPayload: {
    context?: string | null;
    filters?: ChunkFilter | null;
    is_ecommerce?: boolean | null;
    is_followup?: boolean | null;
    query?: string | null;
    search_type?: SearchMethod | null;
    suggestion_type?: SuggestType | null;
    suggestions_to_create?: number | null;
}

Type declaration

  • Optionalcontext?: string | null

    Context is the context of the query. This can be any string under 15 words and 200 characters. The context will be used to generate the suggested queries. Defaults to None.

  • Optionalfilters?: ChunkFilter | null
  • Optionalis_ecommerce?: boolean | null

    Whether of not the suggested queries are being generated for ecommerce.

  • Optionalis_followup?: boolean | null

    Whether or not the suggested queries are being generated for a followup question. If true, the suggested queries will be generated for a followup question. If false, the suggested queries will be generated for a new question.

  • Optionalquery?: string | null

    The query to base the generated suggested queries off of using RAG. A hybrid search for 10 chunks from your dataset using this query will be performed and the context of the chunks will be used to generate the suggested queries.

  • Optionalsearch_type?: SearchMethod | null
  • Optionalsuggestion_type?: SuggestType | null
  • Optionalsuggestions_to_create?: number | null

    The number of suggested queries to create, defaults to 10

Settings

Member Visibility