Skip to main content
POST
/
api
/
search
/
searchSimilarObjectEmbeddingsByText
Search similar object embeddings by text
curl --request POST \
  --url https://api2.rhombussystems.com/api/search/searchSimilarObjectEmbeddingsByText \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "model": "CLIP_512",
  "queryEndTimeMs": 123,
  "queryStartTimeMs": 123,
  "searchText": "<string>",
  "maxNumResults": 123,
  "objectTypeFilter": [
    "MOTION_HUMAN"
  ],
  "queryDeviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "regionFilter": [
    [
      123
    ]
  ],
  "similarityThreshold": 123
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "moderationReason": "<string>",
  "queryAllowed": true,
  "similarEmbeddings": [
    {
      "distance": 123,
      "embedding": {
        "b": 123,
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
        "embedding": [
          123
        ],
        "embeddingId": "<string>",
        "l": 123,
        "model": "CLIP_512",
        "objectId": 123,
        "objectType": "<string>",
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "r": 123,
        "t": 123,
        "thumbnailUri": "<string>",
        "timestamp": 123
      },
      "matchedEmbeddingId": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

​
x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

​
x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for searching similar object embeddings by text.

​
model
enum<string>
required

Object search model to use for embeddings

Available options:
CLIP_512,
UNKNOWN
​
queryEndTimeMs
integer<int64> | null
required

End time in epoch milliseconds. Results returned will have occurred before this time.

​
queryStartTimeMs
integer<int64> | null
required

Start time in epoch milliseconds. Results returned will have occurred after this time.

​
searchText
string | null
required

The search text to find similar objects to. Phrases like "red sedan", "person in yellow shirt", etc.

​
maxNumResults
integer<int32> | null

Optional number of results to return. Setting to larger numbers will increase latency.

​
objectTypeFilter
(enum<string> | null)[] | null

Optional object type filter to narrow results to only vehicles or only humans.

Available options:
MOTION_HUMAN,
MOTION_CAR
​
queryDeviceUuids
(string<DeviceFacetUuid> | null)[] | null

Optional list of device uuids to filter result set on.

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

​
regionFilter
((integer<int32> | null)[] | null)[] | null

Optional region filter to return results only if they overlap with the supplied region. This is a list of perymyriad points defining a polygon. The first and last elements must be the same to make a connected polygon. For example, a triangle should have 4 points defined in this list.

Permyriad point [x, y]

Permyriad point [x, y]

​
similarityThreshold
number<float> | null

Optional threshold applied to filter returned results, set as a float in [0.0, 1.0].

Response

200 - application/json

OK

Response object for searching similar object embeddings.

​
error
boolean | null
​
errorMsg
string | null
​
moderationReason
string | null

Reason for moderation if query is not allowed

​
queryAllowed
boolean | null

Whether the query is allowed

​
similarEmbeddings
object[] | null

List of similar object embedding matches

​
warningMsg
string | null