Message Type Glossary

Most of the requests & responses have a messageType field which tells the type of message that object is. This page lists all the message types used along with their brief description for reference. A link to the message type description on this page will be available in the whole API Docs wherever that particular message type is being used.

PING

Ping Message

Describes that a message is of type ping. This could either be used in request or response. PingRequest & PingResponse have message type PING.

Q_MLT

More Like This Query

Describes that a message is of type MoreLikeThisQuery. This message is used to query for more segments which are like the segment provided in the object.

Q_NESEG

Neighboring Segment Query

Describes that a message is of type NeighboringSegmentQuery. This message is used to query for more segments which are neighbors of the segment provided in the object.

Q_TEMPORAL

Temporal Query Message Describes that a message is of type TemporalQuery. This message is used to temporally chain queries of the type SimilarityQuery.

Q_SIM

Similarity Query Message

Describes that a message is of type SimilarityQuery. This message is used to query for similar segments provided data.

QR_END

Query Result End

Marks the ending of the query results. In WebSocket queries, when multiples messages forms an entire result then the QueryEnd object with message type QR_END marks the end of result messages.

QR_ERROR

Query Result Error

Describes error in similarity query results. In WebSocket similarity query, when an error occurs, QueryError object with message type QR_ERROR is received.

QR_METADATA

Query Result Metadata

Describes that a message is of type MetadataQueryResult. It contains details about object's metadata.

QR_OBJECT

Query Result Object

Describes that a message is of type ObjectQueryResult. It contains details about the objects.

QR_SEGMENT

Query Result Segment

Describes that a message is of type SegmentQueryResult. It contains details about the segments.

QR_SIMILARITY

Query Result Similarity

Describes that a message is of type SimilarityQueryResult. It contains details about the segments matched value.

QR_START

Query Result Start

Marks the starting of the query results. In WebSocket queries, when multiples messages forms an entire result then the QueryStart object with message type QR_START marks the start of result messages.

SESSION_START

Session Start

Describes that a message is of type StartSessionMessage. It contains details about the credentials and used to start a session.