pinecone[patch]: Fix document ID not getting set when returned from PineconeStore

[nick-w-nick]

When querying for documents using the PineconeStore via the various search methods, the documents getting returned from Pinecone currently have their id property set to undefined.

This is because id is omitted when the result is converted to a document prior to being returned, as shown below for each query method respectively:

similaritySearchVectorWithScore

langchainjs/libs/langchain-pinecone/src/vectorstores.ts

Lines 424 to 426 in abdcd1f

	if (res.score) {
	result.push([new Document({ metadata, pageContent }), res.score]);
	}

maxMarginalRelevanceSearch

langchainjs/libs/langchain-pinecone/src/vectorstores.ts

Lines 476 to 478 in abdcd1f

	if (res.score) {
	finalResult.push(new Document({ metadata, pageContent }));
	}

This PR adds a new private method named _formatMatches that accepts an array of matches (ScoredPineconeRecord) from the QueryResponse interface. This method performs the same logic that was duplicated across the query methods, just with some added deconstruction safety rails as well as the addition of the id property.

Result from similaritySearchWithScore before this change (same for similaritySearchVectorWithScore):

[
  [
    Document {
      pageContent: 'document text',
      metadata: [Object],
      id: undefined
    },
    0.81118
  ]
]

Result from similaritySearchWithScore after this change (same for similaritySearchVectorWithScore):

[
  [
    Document {
      pageContent: 'document text',
      metadata: [Object],
      id: '91522887-3be3-4937-9ea7-eb235b991a4c'
    },
    0.81118
  ]
]

Result from similaritySearch before this change (same as maxMarginalRelevanceSearch):

[
  [
    Document {
      pageContent: 'document text',
      metadata: [Object],
      id: undefined
    }
  ]
]

Result from similaritySearch after this change (same as maxMarginalRelevanceSearch):

[
  [
    Document {
      pageContent: 'document text',
      metadata: [Object],
      id: '91522887-3be3-4937-9ea7-eb235b991a4c'
    }
  ]
]

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
langchainjs-docs	✅ Ready (Inspect)	Visit Preview		Aug 16, 2024 9:27am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
langchainjs-api-refs	⬜️ Ignored (Inspect)			Aug 16, 2024 9:27am

[bracesproul]

thanks for pushing this up, well needed update! Could you also push up a commit adding a test for this? Thank you!

x

[jacoblee93]

Thank you!