[Docs]

[jabari-max]

Description
Describe the issue that you've encountered with our documentation.

Suggested solution
Describe how this issue could be fixed or improved.
Link to page
Add a link to the exact documentation page where the issue occurred.

[hwarang97]

Description

When following the Node.js quickstart guide, the code example for semantic search in step 5 throws a TypeError.

The example code attempts to access the search score via hit.score, but this property appears to be undefined in the response object returned by index.searchRecords. This causes the program to crash when toFixed() is called.

Here is the error log I received when running the exact code from the documentation:

file:///C:/NaverBoostCamp/challenge/day16/pinecone-test.js:100
  console.log(`id: ${hit.id}, score: ${hit.score.toFixed(2)}, category: ${hit.fields.category}, text: ${hit.fields.chunk_text}`);
                                                 ^

TypeError: Cannot read properties of undefined (reading 'toFixed')
    at file:///C:/NaverBoostCamp/challenge/day16/pinecone-test.js:100:50
    at Array.forEach (<anonymous>)
    at file:///C:/NaverBoostCamp/challenge/day16/pinecone-test.js:99:21
    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)

Node.js v24.2.0

Suggested solution

The search score is actually available in the hit._score property. The documentation should be updated to reflect this change.

Changing hit.score to hit._score fixes the issue and the code runs successfully.

Here is the corrected code snippet:

// Print the results
results.result.hits.forEach(hit => {
  console.log(`id: ${hit.id}, score: ${hit._score.toFixed(2)}, category: ${hit.fields.category}, text: ${hit.fields.chunk_text}`);
});

And the successful output after the fix:

id: undefined, score: 0.28, category: history, text: The Pyramids of Giza are among the Seven Wonders of the Ancient World.
id: undefined, score: 0.19, category: history, text: The Taj Mahal is a mausoleum built by Emperor Shah Jahan.
id: undefined, score: 0.18, category: literature, text: Shakespeare wrote many famous plays, including Hamlet and Macbeth.
...

Link to page

https://docs.pinecone.io/guides/get-started/quickstart#5-semantic-search (Specifically the javascript tab)