Member Junction
    Preparing search index...

    Type Alias VectorizeEntityParams

    type VectorizeEntityParams = {
        CurrentUser?: UserInfo;
        entityDocumentID?: string;
        entityID: string;
        listBatchCount?: number;
        listID?: string;
        OnProgress?: (update: VectorizeProgressUpdate) => void;
        options?: VectorizeEntityOptions;
        StartingOffset?: number;
        UpsertBatchCount?: number;
        VectorizeBatchCount?: number;
    }
    Index

    Properties

    CurrentUser? entityDocumentID? entityID listBatchCount? listID? OnProgress? options? StartingOffset? UpsertBatchCount? VectorizeBatchCount?

    Properties

    CurrentUser?: UserInfo

    The UserInfo object to use

    entityDocumentID?: string
    entityID: string
    listBatchCount?: number

    The number of records to fetch from the list at a time. Defaults to 50.

    listID?: string

    If defined, all records within the given list will be vectorized instead of all records within the entity. Note that the list's EntityID field must equal the entityID parameter.

    OnProgress?: (update: VectorizeProgressUpdate) => void

    Optional callback invoked during vectorization with progress updates. Called after each batch is upserted to the vector database.

    options?: VectorizeEntityOptions
    StartingOffset?: number

    The number of records to skip before starting to fetch records from the list.

    UpsertBatchCount?: number

    The number of records to upsert to the vector database at a time. Defaults to 50.

    VectorizeBatchCount?: number

    The number of records to vectorize at a time. Defaults to 50.

    Settings

    Member Visibility

    On This Page

    Properties