Type Alias ApiKeyRequestParams

ApiKeyRequestParams: {
    filters?: ChunkFilter | null;
    highlight_options?: HighlightOptions | null;
    no_result_message?: string | null;
    page_size?: number | null;
    remove_stop_words?: boolean | null;
    score_threshold?: number | null;
    search_type?: SearchMethod | null;
    slim_chunks?: boolean | null;
    typo_options?: TypoOptions | null;
    use_quote_negated_terms?: boolean | null;
}

The default parameters which will be forcibly used when the api key is given on a request. If not provided, the api key will not have default parameters.

Type declaration

  • Optionalfilters?: ChunkFilter | null
  • Optionalhighlight_options?: HighlightOptions | null
  • Optionalno_result_message?: string | null

    Options for handling the response for the llm to return when no results are found

  • Optionalpage_size?: number | null

    Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.

  • Optionalremove_stop_words?: boolean | null

    If true, stop words will be removed. Queries that are entirely stop words will be preserved.

  • Optionalscore_threshold?: number | null

    Set score_threshold to a float to filter out chunks with a score below the threshold.

  • Optionalsearch_type?: SearchMethod | null
  • Optionalslim_chunks?: boolean | null

    Set slim_chunks to true to avoid returning the content and chunk_html of the chunks.

  • Optionaltypo_options?: TypoOptions | null
  • Optionaluse_quote_negated_terms?: boolean | null

    If true, quoted and - prefixed words will be parsed from the queries and used as required and negated words respectively.

Settings

Member Visibility