Authorizations
Path Parameters
The key of the vocabulary. It can be the wildcard '*' to search in all vocabularies.
Body
Use dot-notation paths (e.g., name
, meta.updatedAt
, address.city
).
To include properties from relationships or adjacent records, request them via traversedProperties
and reference with @
(e.g., @worksAt.*
, @worksAt.@clinic.name
).
Some endpoints require federated paths such as resources.<collectionKey>.<propertyKey>
or relationships.<collectionKey>.<propertyKey>
.
A semantic query is a high-level representation of the user's intent. When specified, it will trigger our query understanding capabilities and generate a query and filter operator that will be applied to the search parameters.
An operator that will be used to search the targeted collections. The matching operator will count as part of the ranking.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
An operator that will be used to filter the targeted collections. The filtering operator excludes results that do not match the specified criteria.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
Properties selector allows to specify which properties should be included or excluded in the search response. System properties are always included and cannot be excluded. Exclude properties has precedence over include properties.
- Option 1
- Option 2
The properties from the relationships or adjacent records that will be returned in the search response. The wildcard '*' can be used in itself or in combination with a prefix
*
will return all traversed properties.@worksAt.*
will return all traversed properties from the relationship 'worksAt'.@worksAt.@clinic.*
will return all traversed properties from an adjacent 'clinic' connected with a 'worksAt' relationship.