POST
/
filter
curl --request POST \
  --url https://api.joinpongo.com/api/v1/filter \
  --header 'Content-Type: application/json' \
  --header 'secret: <api-key>'
[
  {
    "id": 123,
    "text": "<string>",
    "metadata": {},
    "score": 123
  }
]

Authorizations

secret
string
headerrequired

Body

application/json
query
string

Query that was initally passed into your pipeline

num_results
integer
default: 10

Total number of results returned by the filter

text_field
string
default: text

Field to be filtered on, default is "text"

public_metadata_field
string
default: metadata

Name of the object key to the metadata field of each document being passed in. Default is "metadata"

key_field
string
default: id

Name of the object key to be used as the ID field for each document passed into the scoring system. Default is "id"

vec_sample_size
integer
default: 25

Number of vector results to be passed to the last step of our scoring system

plaintext_sample_size
integer
default: 5

Number of plain text results to be passed to the last step of our at the end of our scoring system

docs
object

Response

200 - application/json
id
integer

Unique identifier for the document.

text
string

The text content of the document.

metadata
object

Metadata associated with the document.

score
number

Relevance score of the document.