Documentation
Discussions
Start typing to search…

Query Experience

post
https://preview.threekit.com/api/experiences//query

Query an Experience given the Experience's ID or Custom ID.

You can pass a query to perform a semantic search on the Experience's Variants. The search process has the following steps:

  1. Optionally rephrase the query (using the rephrase prompt).
  2. Perform semantic search
  3. Optionally rerank results (using the rerank guidance prompt).
  4. Generate a confidence message for the top result (using the confidence prompt).

Additional request fields:

  • Use count to specify the number of results returned.
  • Provide filters (object) to pre-filter variants before semantic search. All filter properties are combined with logical AND. Note: Because the search process relies on AI (LLMs), results may vary even when using the same query.

Learn more about the filter syntax: Catalog 2.0 AI Discovery

Path Params
required

The Experience's ID or customID

Query Params
uuid
required

Public or Private Threekit authentication token. If using a public token the request must originate for a domain added to the authentication token.

Body Params
string
length ≥ 1

The query to use for semantic search.

filters
array

The filter to use for search. For details on the filter syntax and examples see the endpoint description above.

filters
integer
1 to 50
Defaults to 4

The desired number of results. There can be less results if the filter is too restrictive.

Responses

Updated 6 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 6 months ago