trieve-search-component
Version:
The easiest way to get up and running in your app using trieve search.
103 lines • 4.2 kB
TypeScript
import { ChunkMetadata, ChunkMetadataStringTagSet, CountChunkQueryResponseBody, CTRType, TrieveSDK } from "trieve-ts-sdk";
import { Chunk, GroupSearchResults, Props, SearchResults } from "./types";
import { ModalProps, ModalTypes, PagefindApi } from "./hooks/modal-context";
export declare const omit: (obj: object | null | undefined, keys: string[]) => {
[k: string]: any;
} | null | undefined;
export declare const searchWithTrieve: ({ trieve, props, query_string, image_url, audioBase64, searchOptions, abortController, tags, type, fingerprint, }: {
trieve: TrieveSDK;
props: ModalProps;
query_string: string;
image_url?: string;
audioBase64?: string;
searchOptions: Props["searchOptions"];
abortController?: AbortController;
tags?: string[];
type?: ModalTypes;
fingerprint?: string;
}) => Promise<SearchResults>;
export declare const groupSearchWithTrieve: ({ trieve, props, query_string, image_url, audioBase64, searchOptions, abortController, tags, type, fingerprint, }: {
props: ModalProps;
trieve: TrieveSDK;
query_string: string;
image_url?: string;
audioBase64?: string;
searchOptions: Props["searchOptions"];
abortController?: AbortController;
tags?: string[];
type?: ModalTypes;
fingerprint?: string;
}) => Promise<GroupSearchResults>;
export declare const countChunks: ({ trieve, query, abortController, tag, searchOptions, }: {
trieve: TrieveSDK;
query: string;
abortController?: AbortController;
tag?: string;
searchOptions?: Props["searchOptions"];
}) => Promise<CountChunkQueryResponseBody>;
export declare const sendCtrData: ({ trieve, type, chunkID, requestID, index, props, fingerprint, }: {
trieve: TrieveSDK;
chunkID: string;
requestID: string;
type: CTRType;
index: number;
props: ModalProps;
fingerprint: string;
}) => Promise<null>;
export declare const trackViews: ({ trieve, type, requestID, items, props, fingerprint, }: {
trieve: TrieveSDK;
requestID: string;
type: CTRType;
items: string[];
props: ModalProps;
fingerprint: string;
}) => Promise<null>;
export declare const getSuggestedQueries: ({ trieve, query, count, abortController, }: {
query?: string;
trieve: TrieveSDK;
count: number;
abortController?: AbortController;
}) => Promise<import("trieve-ts-sdk").SuggestedQueriesResponse>;
export declare const getSuggestedQuestions: ({ trieve, abortController, query, count, groupTrackingId, props: modalProps, prevUserMessages, is_followup, chunks, }: {
trieve: TrieveSDK;
abortController?: AbortController;
query?: string;
count: number;
groupTrackingId?: string | null;
is_followup?: boolean;
prevUserMessages?: string[];
props?: ModalProps;
chunks?: Chunk[] | null;
}) => Promise<import("trieve-ts-sdk").SuggestedQueriesResponse>;
export type SimpleChunk = ChunkMetadata | ChunkMetadataStringTagSet;
export declare const searchWithPagefind: (pagefind: PagefindApi, query: string, datasetId: string, tags?: string[]) => Promise<{
chunk: {
chunk_html: any;
link: any;
metadata: any;
created_at: string;
dataset_id: string;
id: string;
image_urls: any;
location: null;
num_value: null;
tag_set: any;
time_stamp: null;
tracking_id: null;
updated_at: string;
weight: number;
};
highlights: never[];
}[]>;
export declare const groupSearchWithPagefind: (pagefind: PagefindApi, query: string, datasetId: string, tags?: string[]) => Promise<GroupSearchResults>;
export declare const countChunksWithPagefind: (pagefind: PagefindApi, query: string, tags: {
tag: string;
label?: string;
selected?: boolean;
iconClassName?: string;
icon?: () => JSX.Element;
}[]) => Promise<CountChunkQueryResponseBody[]>;
export declare const getPagefindIndex: (trieve: TrieveSDK) => Promise<string>;
export declare const uploadFile: (trieve: TrieveSDK, file_name: string, base64_file: string) => Promise<string>;
export declare const getPresignedUrl: (trieve: TrieveSDK, fileId: string) => Promise<string>;
//# sourceMappingURL=trieve.d.ts.map