Interface AzionRetrieverArgs

Interface for the arguments required to initialize an Azion library.

interface AzionRetrieverArgs {
    callbacks?: Callbacks;
    dbName?: string;
    entityExtractor?: BaseChatModel<BaseChatModelCallOptions, AIMessageChunk>;
    expandedMetadata?: boolean;
    filters?: AzionFilter[];
    ftsK?: number;
    ftsTable?: string;
    maxItemsSearch?: number;
    metadata?: Record<string, unknown>;
    metadataItems?: string[];
    promptEntityExtractor?: string;
    searchType?: "similarity" | "hybrid";
    similarityK?: number;
    tags?: string[];
    vectorTable?: string;
    verbose?: boolean;
}

Hierarchy

  • BaseRetrieverInput
    • AzionRetrieverArgs

Properties

callbacks? dbName? entityExtractor? expandedMetadata? filters? ftsK? ftsTable? maxItemsSearch? metadata? metadataItems? promptEntityExtractor? searchType? similarityK? tags? vectorTable? verbose?

Properties

Optionalcallbacks

callbacks?: Callbacks

OptionaldbName

dbName?: string

The name of the database to search for documents.

OptionalentityExtractor

entityExtractor?: BaseChatModel<BaseChatModelCallOptions, AIMessageChunk>

The chatmodel to extract entities to perform Full text search on the database

OptionalexpandedMetadata

expandedMetadata?: boolean

Whether the metadata is contained in a single column or multiple columns

Optionalfilters

filters?: AzionFilter[]

Filters to apply to the search. Default is an empty array.

OptionalftsK

ftsK?: number

The number of documents retrieved with full text search. Minimum is 1.

OptionalftsTable

ftsTable?: string

Name of the table to perform full text search. Default is 'document_fts'

OptionalmaxItemsSearch

maxItemsSearch?: number

Max items to maintain per searchtype. Default is 3.

Optionalmetadata

metadata?: Record<string, unknown>

OptionalmetadataItems

metadataItems?: string[]

The columns from the tables that metadata must contain

OptionalpromptEntityExtractor

promptEntityExtractor?: string

The prompt to the chatmodel to extract entities to perform Full text search on the database

OptionalsearchType

searchType?: "similarity" | "hybrid"

Search type to perform. Cosine similarity and hybrid (vector + FTS) are currently supported.

OptionalsimilarityK

similarityK?: number

The number of documents retrieved with cosine similarity (vector) search. Minimum is 1.

Optionaltags

tags?: string[]

OptionalvectorTable

vectorTable?: string

Name of the table to perform vector similarity seach. Default is 'documents'

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties