Class HydeRetriever<V>

A class for retrieving relevant documents based on a given query. It extends the VectorStoreRetriever class and uses a BaseLanguageModel to generate a hypothetical answer to the query, which is then used to retrieve relevant documents.

Example

const retriever = new HydeRetriever({
vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
llm: new ChatOpenAI(),
k: 1,
});
await vectorStore.addDocuments(
[
"My name is John.",
"My name is Bob.",
"My favourite food is pizza.",
"My favourite food is pasta.",
].map((pageContent) => new Document({ pageContent })),
);
const results = await retriever.getRelevantDocuments(
"What is my favourite food?",
);

Type Parameters

Hierarchy

Constructors

Properties

k: number = 4
searchType: string = "similarity"
vectorStore: V
callbacks?: Callbacks
filter?: V["FilterType"]
metadata?: Record<string, unknown>
promptTemplate?: BasePromptTemplate<any, BasePromptValue, any>
tags?: string[]
verbose?: boolean

Methods

  • Parameters

    • documents: Document<Record<string, any>>[]
    • Optional options: AddDocumentOptions

    Returns Promise<void | string[]>

  • Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

    Parameters

    • inputs: string[]

      Array of inputs to each batch call.

    • Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

      Either a single call options object to apply to each batch call or an array for each call.

    • Optional batchOptions: RunnableBatchOptions & {
          returnExceptions?: false;
      }

    Returns Promise<Document<Record<string, any>>[][]>

    An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set

  • Parameters

    Returns Promise<(Error | Document<Record<string, any>>[])[]>

  • Parameters

    Returns Promise<(Error | Document<Record<string, any>>[])[]>

  • Main method used to retrieve relevant documents. It takes a query string and an optional configuration object, and returns a promise that resolves to an array of Document objects. This method handles the retrieval process, including starting and ending callbacks, and error handling.

    Parameters

    • query: string

      The query string to retrieve relevant documents for.

    • Optional config: Callbacks | BaseCallbackConfig

      Optional configuration object for the retrieval process.

    Returns Promise<Document<Record<string, any>>[]>

    A promise that resolves to an array of Document objects.

  • Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.

    Type Parameters

    • NewRunOutput

    Parameters

    • coerceable: RunnableLike<Document<Record<string, any>>[], NewRunOutput>

      A runnable, function, or object whose values are functions or runnables.

    Returns RunnableSequence<string, Exclude<NewRunOutput, Error>>

    A new runnable sequence.

  • Stream output in chunks.

    Parameters

    Returns Promise<IterableReadableStream<Document<Record<string, any>>[]>>

    A readable stream that is also an iterable.

  • Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.

    Parameters

    • input: string
    • Optional options: Partial<BaseCallbackConfig>
    • Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

    Returns AsyncGenerator<RunLogPatch, any, unknown>

  • Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.

    Parameters

    Returns AsyncGenerator<Document<Record<string, any>>[], any, unknown>

Generated using TypeDoc