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

deployedIndexId: string

documentIndexer

documentIndexer: DocumentIndexer<IndexerOptions>

documentRetriever

documentRetriever: DocumentRetriever<RetrieverOptions>

`Optional`embedder

embedder?: EmbedderReference<EmbedderCustomOptions>

`Optional`embedderOptions

embedderOptions?: z.TypeOf<EmbedderCustomOptions>

indexEndpointId

indexEndpointId: string

indexId

indexId: string

publicDomainName

publicDomainName: string