POST
/
v1
/
semantic-search

​
Description

Search semantically similar records from a dataset. Read the dataset documentation to get started.

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
query
string
required

Query string to search semantically similar records

​
datasetId
string
required

Dataset ID to search from.

​
limit
integer
default: 10

Maximum number of results to return. Defaults to 10.

Required range: x > 0
​
threshold
number
default: 0

Minimum semantic similarity score threshold for the results. Defaults to 0.0.

Required range: 0 < x < 1

Response

200 - application/json
​
results
object[]
required

List of semantic search results, ordered by score in descending order

Pipeline Run