Interface DriaRetrieverArgs

Configurations for Dria retriever.

  • contractId: a Dria knowledge's contract ID.
  • apiKey: a Dria API key; if omitted, the retriever will check for DRIA_API_KEY environment variable.

The retrieval can be configured with the following options:

  • topK: number of results to return, max 20. (default: 10)
  • rerank: re-rank the results from most to least semantically relevant to the given search query. (default: true)
  • level: level of detail for the search, must be an integer from 0 to 5 (inclusive). (default: 1)
  • field: CSV field name, only relevant for the CSV files.
interface DriaRetrieverArgs {
    apiKey?: string;
    contractId?: string;
    field?: string;
    level?: number;
    rerank?: boolean;
    topK?: number;
}

Hierarchy (view full)

  • DriaParams
  • Toolkit
  • SearchOptions
    • DriaRetrieverArgs

Properties

apiKey? contractId? field? level? rerank? topK?

Properties

OptionalapiKey

apiKey?: string

OptionalcontractId

contractId?: string

Optionalfield

field?: string

Optionallevel

level?: number

Optionalrerank

rerank?: boolean

OptionaltopK

topK?: number

Settings

Member Visibility

On This Page

Properties