community[minor]: keywordSearchWithScore on OpenSearchVectorStore

[johnnoG]

Description of the Change

This PR adds a new method keywordSearchWithScore to the OpenSearchVectorStore class. This method performs a keyword search on the OpenSearch index and returns the matched documents along with their scores. This enhancement will allow users to retrieve both documents and their relevance scores from the OpenSearch index, providing more detailed search results.

Relevant Context

The keywordSearchWithScore method:

• Accepts a keyword query, a limit on the number of results, and an optional filter.
• Constructs an OpenSearch query to match documents based on the provided keyword and filter.
• Returns an array of tuples, each containing a document and its corresponding score.

Tests have been added to ensure the method works correctly and handles errors appropriately. Documentation has also been updated to reflect this new functionality.

Example Usage

const results = await vectorStore.keywordSearchWithScore('example query', 10);
results.forEach(([document, score]) => {
  console.log('Document:', document);
  console.log('Score:', score);
});

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
langchainjs-api-refs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 20, 2024 1:13pm
langchainjs-docs	✅ Ready (Inspect)	Visit Preview		Jun 20, 2024 1:13pm

[bracesproul]

lgtm, thank you!

[bracesproul]

Looks like CI Is failing, could you push up a fix @johnnoG