This page describes items and concepts that are common across all the Voysis query APIs.

Queries

Queries are the entities that are used to organise interactions with a user.

What is a Query?

A query represents an individual interaction your User has with the Voysis AI. Each time they search for something, it will be a new query. Queries may be of different types (audio or text)

Properties

locale: The locale of the query. It is the IEFT Language Tag (for example, en-US)
userId: A 128-bit UUID that uniquely identified a user.This value must be generated by the client and ideally used for the lifetime of that client. This allows Voysis to store audio and retrain the AI so that results improve over time. It is also used to meet data protection requirements.
queryType: This specifies what type of query is being performed. Currently audio and text are the supported values.

Query Context

Queries can have a "context" associated with them. Context allows information to carry through from one query to the next.

For example, your User could submit the following two queries:

"Show me brown coffee tables"
"Show me black ones instead"

The second query on it's own doesn't make much sense. However, Voysis will have returned a context in the response to the first query. If an API client includes this context when submitting the second query then the Voysis AI can use this to determine that your user is now looking for black coffee tables.

Audio Profile Identifier

An audio profile id is a way of uniquely identifying a device and user. This value is used to create user/device specific acoustic model profiles which over time is used to improve the accuracy of the system as the user interacts with the service.

This value must be generated by the client and ideally used for the lifetime of that client. It should be a 128-bit UUID.