Genkit JS API reference
    Preparing search index...

    Interface VectorSearchOptions<EmbedderCustomOptions, IndexerOptions, RetrieverOptions>

    interface VectorSearchOptions<
        EmbedderCustomOptions extends z.ZodTypeAny,
        IndexerOptions extends {},
        RetrieverOptions extends { k?: number },
    > {
        deployedIndexId: string;
        documentIndexer: DocumentIndexer<IndexerOptions>;
        documentRetriever: DocumentRetriever<RetrieverOptions>;
        embedder?: EmbedderReference<EmbedderCustomOptions>;
        embedderOptions?: z.TypeOf<EmbedderCustomOptions>;
        indexEndpointId: string;
        indexId: string;
        publicDomainName: string;
    }

    Type Parameters

    • EmbedderCustomOptions extends z.ZodTypeAny
    • IndexerOptions extends {}
    • RetrieverOptions extends { k?: number }
    Index

    Properties

    deployedIndexId documentIndexer documentRetriever embedder? embedderOptions? indexEndpointId indexId publicDomainName

    Properties

    deployedIndexId: string
    documentIndexer: DocumentIndexer<IndexerOptions>
    documentRetriever: DocumentRetriever<RetrieverOptions>
    embedder?: EmbedderReference<EmbedderCustomOptions>
    embedderOptions?: z.TypeOf<EmbedderCustomOptions>
    indexEndpointId: string
    indexId: string
    publicDomainName: string

    Settings

    Member Visibility

    On This Page

    Properties