POST
/
filter
If you want to observe your pipeline wihtout changing behavior, check out the /observe endpoint

Authorizations

secret
string
header
required

Body

application/json
docs
object
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"

num_results
integer
default:
10

Total number of results returned by the filter

observe
boolean
default:
false

Wether or not to run the observability pipeline on this query

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

public_metadata_field
string
default:
metadata

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

query
string

Query that was initally passed into your pipeline

text_field
string
default:
text

Field to be filtered on, default is "text"

vec_sample_size
integer
default:
25

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

Response

200 - application/json
id
string

Unique identifier for the document.

metadata
object

Metadata associated with the document.

score
number

Relevance score of the document.

text
string

The text content of the document.