POST
https://api.joinpongo.com/api/v1
/
filter
import { PongoClient } from 'pongo-typescript'
// Install with npm i pongo-typescript

// Replace the key with your actual API key
const pongoClient = new PongoClient("${private_key || 'loading key...'}")

const queries = ["What color are apples?", "Who made the first mobile phone?", "How many hearts do squids have?"]

// pass in the top ~100-200 results from your existing pipeline, passing more results will catch more edge cases but take slightly longer to process
// You can use objects like the first row, or raw text like the other two
const listsOfResults = [
    [
        {text: 'Oranges are normally orange, unlike apples', metadata: {source: 'Fruit documentation'}},
        {text: 'Grapes can be purple or green', metadata: {source: 'Fruit documentation'}},
        {text: 'Apples can be green or red.', metadata: {source: 'Fruit documentation'}},
        {text: "If an apple is brown, it's best not to eat it.", metadata: {source: 'Fruit documentation'}}
    ], // Apples results
    [
        'Apple released the first iPhone on June 29, 2007',
        'The telephone was invented by Alexander Graham Bell in 1876.',
        'The first long-distance telephone call was made in August 1876, between Brantford and Paris, Ontario',
        'The newest iPhone models are the iPhone 15, it was released on September 22, 2023',
        'The first handheld mobile phone was the Motorola DynaTAC 8000X',
        'Martin Cooper, an engineer at Motorola, is credited with inventing the first handheld cellular mobile phone and making the first mobile phone call'
    ], // Mobile phone results
    [
        'Octopuses have three hearts.',
        "A squid's systemic (main) heart has three chambers.",
        'The creature with the most hearts is the earthworm, with 10.',
        'Squids have three hearts- one systemic (main) heart and two branchial hearts'
    ] // squids results
]

for (let i = 0; i < queries.length; i++) {
    // observe=true adds automatic evaluation to queries, you'll get a regular email report and can view / download queries via the dashboard.
    pongoClient.filter({
        docs: listsOfResults[i],
        query: queries[i],
        numResults: 5,
        observe: true,
        logMetadata: {source: 'Pongo Tutorial'}
    }).then(filteredResult => {
        const filteredDocs = filteredResult.data
        console.log(`Top answer to: ${queries[i]}: ${filteredDocs[0].text}\n\n`)
    })
}
[
  {
    "id": "doc-id",
    "text": "Document data",
    "metadata": {},
    "score": 0.9482
  }
]
If you want to observe your pipeline wihtout changing behavior, check out the /observe endpoint

Authorizations

secret
string
header
required

Body

application/json

Response

200 - application/json

Successful response

The response is of type object[].