LiveSearchMatchResponse
Fields
Section titled “Fields”| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string (uuid) | Yes | |
liveSearchId |
string (uuid) | Yes | |
liveSearchRevision |
integer | Yes | minimum 1.0 |
kind |
LiveSearchKind | Yes | |
streamId |
string (uuid) | Yes | |
streamRevision |
integer | Yes | minimum 1.0 |
recordId |
string | Yes | |
score |
number | Yes | minimum -1.0. maximum 1.0 |
capturedAt |
string (date-time) | Yes | |
emittedAt |
string (date-time) | Yes | |
artifactUri |
string or null | Yes | |
label |
string or null | Yes | |
confidence |
number or null | No | |
box |
SearchBoundingBoxResponse or null | Yes | |
identityId |
string (uuid) or null | Yes | |
sampleId |
string (uuid) or null | Yes |
Additional properties are rejected by this schema.
JSON schema
Section titled “JSON schema”{ "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "liveSearchId": { "type": "string", "format": "uuid", "title": "Livesearchid" }, "liveSearchRevision": { "type": "integer", "minimum": 1.0, "title": "Livesearchrevision" }, "kind": { "$ref": "#/components/schemas/LiveSearchKind" }, "streamId": { "type": "string", "format": "uuid", "title": "Streamid" }, "streamRevision": { "type": "integer", "minimum": 1.0, "title": "Streamrevision" }, "recordId": { "type": "string", "title": "Recordid" }, "score": { "type": "number", "maximum": 1.0, "minimum": -1.0, "title": "Score" }, "capturedAt": { "type": "string", "format": "date-time", "title": "Capturedat" }, "emittedAt": { "type": "string", "format": "date-time", "title": "Emittedat" }, "artifactUri": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Artifacturi" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "confidence": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Confidence" }, "box": { "anyOf": [ { "$ref": "#/components/schemas/SearchBoundingBoxResponse" }, { "type": "null" } ] }, "identityId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Identityid" }, "sampleId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Sampleid" } }, "additionalProperties": false, "type": "object", "required": [ "id", "liveSearchId", "liveSearchRevision", "kind", "streamId", "streamRevision", "recordId", "score", "capturedAt", "emittedAt", "artifactUri", "label", "box", "identityId", "sampleId" ], "title": "LiveSearchMatchResponse"}