Interface SimpleRetrieverOptions<C, R>

Simple retriever options.

interface SimpleRetrieverOptions<C extends z.ZodTypeAny = z.ZodTypeAny, R = any> {
    configSchema?: C;
    content?:
        | string
        | (
            item: R,
        ) =>
            | string
            | (
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text: string;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media: { contentType?: string; url: string };
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
            )[];
    metadata?: string[]
    | (item: R) => undefined | Record<string, any>;
    name: string;
}

Type Parameters

Properties

configSchema? content? metadata? name

Properties

OptionalconfigSchema

configSchema?: C

A Zod schema containing any configuration info available beyond the query.

Optionalcontent

content?:
    | string
    | (
        item: R,
    ) =>
        | string
        | (
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                text: string;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media: { contentType?: string; url: string };
                metadata?: Record<string, unknown>;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
        )[]

Specifies how to extract content from the returned items.

  • If a string, specifies the key of the returned item to extract as content.
  • If a function, allows you to extract content as text or a document part.

Optionalmetadata

metadata?: string[] | (item: R) => undefined | Record<string, any>

Specifies how to extract metadata from the returned items.

  • If an array of strings, specifies list of keys to extract from returned objects.
  • If a function, allows you to use custom behavior to extract metadata from returned items.

name

name: string

The name of the retriever you're creating.

Settings

Member Visibility

On This Page

Properties