NeuralDBRetriever

ThirdAI API Key

NeuralDB instance

Create a NeuralDBRetriever from scratch.

To use, set the THIRDAI_KEY environment variable with your ThirdAI API key, or pass thirdai_key as a named parameter.

Create a NeuralDBRetriever with a base model from a saved checkpoint

To use, set the THIRDAI_KEY environment variable with your ThirdAI API key, or pass thirdai_key as a named parameter.

Validate ThirdAI environment variables.

Inserts files / document sources into the retriever.

The retriever upweights the score of a document for a specific query. This is useful for fine-tuning the retriever to user behavior.

Given a batch of (query, document id) pairs, the retriever upweights the scores of the document for the corresponding queries. This is useful for fine-tuning the retriever to user behavior.

The retriever associates a source phrase with a target phrase. When the retriever sees the source phrase, it will also consider results that are relevant to the target phrase.

Given a batch of (source, target) pairs, the retriever associates each source phrase with the corresponding target phrase.

Saves a NeuralDB instance to disk. Can be loaded into memory by calling NeuralDB.from_checkpoint(path)