Interface TypesenseConfig

Typesense vector store configuration.

interface TypesenseConfig {
    schemaName: string;
    typesenseClient: default;
    columnNames?: {
        metadataColumnNames?: string[];
        pageContent?: string;
        vector?: string;
    };
    searchParams?: MultiSearchRequestSchema;
    import?<T>(data, collectionName): Promise<void>;
}

Hierarchy (view full)

Properties

schemaName typesenseClient columnNames? searchParams?

Methods

import?

Properties

schemaName

schemaName: string

Typesense schema name in which documents will be stored and searched.

typesenseClient

typesenseClient: default

Typesense client.

Optional columnNames

columnNames?: {
    metadataColumnNames?: string[];
    pageContent?: string;
    vector?: string;
}

Column names.

Type declaration

  • Optional metadataColumnNames?: string[]

    Metadata column names.

    Default

    []
  • Optional pageContent?: string

    Page content column name.

    Default

    'text'
  • Optional vector?: string

    Vector column name.

    Default

    'vec'

Optional searchParams

searchParams?: MultiSearchRequestSchema

Typesense search parameters.

Default

{ q: '*', per_page: 5, query_by: '' }

Methods

Optional import

  • import<T>(data, collectionName): Promise<void>

  • Replace default import function. Default import function will update documents if there is a document with the same id.

    Type Parameters

    • T extends Record<string, unknown> = Record<string, unknown>

    Parameters

    • data: T[]
    • collectionName: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc