viam.proto.app.data

@generated by Viam. Do not edit manually!

Classes

DataServiceBase	Helper class that provides a standard way to create an ABC using
DataServiceStub
UnimplementedDataServiceBase	Helper class that provides a standard way to create an ABC using
AddBinaryDataToDatasetByIDsRequest	AddBinaryDataToDatasetByIDsRequest adds the binary data with the given binary IDs to a dataset with dataset_id.
AddBinaryDataToDatasetByIDsResponse	Abstract base class for protocol messages.
AddBoundingBoxToImageByIDRequest	AddBoundingBoxToImageByIDRequest specifies the binary ID to which a bounding box
AddBoundingBoxToImageByIDResponse	AddBoundingBoxToImageByIDResponse returns the bounding box ID of the successfully added bounding box.
AddTagsToBinaryDataByFilterRequest	AddTagsToBinaryDataByFilterRequest requests adding all specified tags to each of the files when a filter is provided.
AddTagsToBinaryDataByFilterResponse	Abstract base class for protocol messages.
AddTagsToBinaryDataByIDsRequest	AddTagsToBinaryDataByIDsRequest requests adding all specified tags to each of the files when binary ids are provided.
AddTagsToBinaryDataByIDsResponse	Abstract base class for protocol messages.
Annotations	Annotations are data annotations used for machine learning.
BinaryData	BinaryData contains data and metadata associated with binary data.
BinaryDataByFilterRequest	BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data when a filter is provided.
BinaryDataByFilterResponse	BinaryDataByFilterResponse provides the data and metadata of binary (image + file) data when a filter is provided.
BinaryDataByIDsRequest	BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data by binary ids.
BinaryDataByIDsResponse	BinaryDataByIDsResponse provides the data and metadata of binary (image + file) data when a filter is provided.
BinaryID	BinaryID is the unique identifier for a file that one can request to be retrieved or modified.
BinaryMetadata	BinaryMetadata is the metadata associated with binary data.
BoundingBox	BoundingBox represents a labeled bounding box on an image.
BoundingBoxLabelsByFilterRequest	BoundingBoxLabelsByFilterRequest requests all the labels of the bounding boxes from files from a given filter.
BoundingBoxLabelsByFilterResponse	BoundingBoxLabelsByFilterRequest returns all the labels of the bounding boxes from files from a given filter.
CaptureInterval	CaptureInterval describes the start and end time of the capture in this file.
CaptureMetadata	CaptureMetadata contains information on the settings used for the data capture.
Classification	Classification represents a confidence score with a label.
ConfigureDatabaseUserRequest	ConfigureDatabaseUserRequest accepts a Viam organization ID and a password for the database user
ConfigureDatabaseUserResponse	Abstract base class for protocol messages.
CreateBinaryDataSignedURLRequest	Abstract base class for protocol messages.
CreateBinaryDataSignedURLResponse	Abstract base class for protocol messages.
CreateIndexRequest	CreateIndexRequest starts a custom index build
CreateIndexResponse	Abstract base class for protocol messages.
CreateSavedQueryRequest	CreateSavedQueryRequest saves a mql query.
CreateSavedQueryResponse	Abstract base class for protocol messages.
DataRequest	DataRequest encapsulates the filter for the data, a limit on the maximum results returned,
DeleteBinaryDataByFilterRequest	DeleteBinaryDataByFilterRequest deletes the data and metadata of binary data when a filter is provided.
DeleteBinaryDataByFilterResponse	DeleteBinaryDataByFilterResponse returns the number of binary files deleted when a filter is provided.
DeleteBinaryDataByIDsRequest	DeleteBinaryDataByIDsRequest deletes the data and metadata of binary data when binary ids are provided.
DeleteBinaryDataByIDsResponse	DeleteBinaryDataByIDsResponse returns the number of binary files deleted when binary ids are provided.
DeleteIndexRequest	DeleteIndexRequest drops the specified custom index from a collection
DeleteIndexResponse	Abstract base class for protocol messages.
DeleteSavedQueryRequest	DeleteSavedQuery deletes a saved query based on the given id.
DeleteSavedQueryResponse	Abstract base class for protocol messages.
DeleteTabularDataRequest	DeleteTabularDataRequest deletes the data from the organization that is older than delete_older_than_days
DeleteTabularDataResponse	DeleteBinaryDataResponse returns the number of tabular datapoints deleted.
DeleteTabularFilter	TabularFilter filters tabular data. All fields are optional; omitted fields are treated as unconstrained.
ExportTabularDataRequest	ExportTabularDataRequest requests tabular data from the specified data source.
ExportTabularDataResponse	ExportTabularDataResponse provides unified tabular data and metadata for a single data point from the specified data source.
Filter	Filter defines the fields over which we can filter data using a logic AND.
GetDatabaseConnectionRequest	GetDatabaseConnectionRequest requests the database connection hostname.
GetDatabaseConnectionResponse	GetDatabaseConnectionResponse returns the database connection hostname endpoint. It also returns
GetLatestTabularDataRequest	GetLatestTabularDataRequest requests the most recent tabular data captured from the specified data source.
GetLatestTabularDataResponse	GetLatestTabularDataResponse provides the data, time synced, and time captured of the most recent tabular data captured
GetSavedQueryRequest	GetSavedQuery retrieves a saved query by id.
GetSavedQueryResponse	Abstract base class for protocol messages.
Index	Abstract base class for protocol messages.
IndexableCollection	IndexableCollection specifies the types of collections available for custom indexes
IndexCreator	IndexCreator specifies the entity that originally created the index
ListIndexesRequest	ListIndexesRequest returns all the indexes for a given collection
ListIndexesResponse	Abstract base class for protocol messages.
ListSavedQueriesRequest	ListSavedQueries lists saved queries for a given organization.
ListSavedQueriesResponse	Abstract base class for protocol messages.
Order	Order specifies the order in which data is returned.
Query	Abstract base class for protocol messages.
RemoveBinaryDataFromDatasetByIDsRequest	RemoveBinaryDataFromDatasetByIDsRequest removes the specified binary IDs from a dataset with dataset_id.
RemoveBinaryDataFromDatasetByIDsResponse	Abstract base class for protocol messages.
RemoveBoundingBoxFromImageByIDRequest	RemoveBoundingBoxFromImageByIDRequest removes the bounding box with specified bounding box ID for the file represented by the binary ID.
RemoveBoundingBoxFromImageByIDResponse	Abstract base class for protocol messages.
RemoveTagsFromBinaryDataByFilterRequest	RemoveTagsFromBinaryDataByFilterRequest requests removing the given tags value from each file when a filter is provided.
RemoveTagsFromBinaryDataByFilterResponse	RemoveTagsFromBinaryDataByFilterResponse returns the number of binary files which had tags removed.
RemoveTagsFromBinaryDataByIDsRequest	RemoveTagsFromBinaryDataByIDsRequest requests removing the given tags value from each file when binary ids are provided.
RemoveTagsFromBinaryDataByIDsResponse	RemoveTagsFromBinaryDataByIDsResponse returns the number of binary files which had tags removed
TabularData	TabularData contains data and metadata associated with tabular data.
TabularDataByFilterRequest	TabularDataByFilterRequest requests tabular data based on filter values.
TabularDataByFilterResponse	TabularDataByFilterResponse provides the data and metadata of tabular data.
TabularDataByMQLRequest	TabularDataByMQLRequest requests tabular data using an MQL query.
TabularDataByMQLResponse	TabularDataByMQLResponse provides unified tabular data and metadata, queried with MQL.
TabularDataBySQLRequest	TabularDataBySQLRequest requests tabular data using a SQL query.
TabularDataBySQLResponse	TabularDataBySQLResponse provides unified tabular data and metadata, queried with SQL.
TabularDataSource	TabularDataSource specifies the data source for user queries to execute on.
TabularDataSourceType	TabularDataSourceType specifies the data source type for TabularDataByMQL queries.
TagsByFilterRequest	TagsByFilterRequest requests the unique tags from data based on given filter.
TagsByFilterResponse	TagsByFilterResponse returns the unique tags from data based on given filter.
TagsFilter	TagsFilter defines the type of filtering and, if applicable, over which tags to perform a logical OR.
TagsFilterType	TagsFilterType specifies how data can be filtered based on tags.
UpdateBoundingBoxRequest	UpdateBoundingBoxRequest updates the bounding box with specified bounding box ID for the file represented by the binary ID.
UpdateBoundingBoxResponse	Abstract base class for protocol messages.
UpdateSavedQueryRequest	UpdateSavedQuery updates the saved query with the given id.
UpdateSavedQueryResponse	Abstract base class for protocol messages.

Package Contents

class viam.proto.app.data.DataServiceBase

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstractmethod TabularDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.TabularDataByFilterRequest, app.data.v1.data_pb2.TabularDataByFilterResponse]) → None

Async:

abstractmethod TabularDataBySQL(stream: grpclib.server.Stream[app.data.v1.data_pb2.TabularDataBySQLRequest, app.data.v1.data_pb2.TabularDataBySQLResponse]) → None

Async:

abstractmethod TabularDataByMQL(stream: grpclib.server.Stream[app.data.v1.data_pb2.TabularDataByMQLRequest, app.data.v1.data_pb2.TabularDataByMQLResponse]) → None

Async:

abstractmethod ExportTabularData(stream: grpclib.server.Stream[app.data.v1.data_pb2.ExportTabularDataRequest, app.data.v1.data_pb2.ExportTabularDataResponse]) → None

Async:

abstractmethod GetLatestTabularData(stream: grpclib.server.Stream[app.data.v1.data_pb2.GetLatestTabularDataRequest, app.data.v1.data_pb2.GetLatestTabularDataResponse]) → None

Async:

abstractmethod BinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.BinaryDataByFilterRequest, app.data.v1.data_pb2.BinaryDataByFilterResponse]) → None

Async:

abstractmethod BinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.BinaryDataByIDsRequest, app.data.v1.data_pb2.BinaryDataByIDsResponse]) → None

Async:

abstractmethod DeleteTabularData(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteTabularDataRequest, app.data.v1.data_pb2.DeleteTabularDataResponse]) → None

Async:

abstractmethod DeleteBinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteBinaryDataByFilterRequest, app.data.v1.data_pb2.DeleteBinaryDataByFilterResponse]) → None

Async:

abstractmethod DeleteBinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteBinaryDataByIDsRequest, app.data.v1.data_pb2.DeleteBinaryDataByIDsResponse]) → None

Async:

abstractmethod AddTagsToBinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddTagsToBinaryDataByIDsRequest, app.data.v1.data_pb2.AddTagsToBinaryDataByIDsResponse]) → None

Async:

abstractmethod AddTagsToBinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddTagsToBinaryDataByFilterRequest, app.data.v1.data_pb2.AddTagsToBinaryDataByFilterResponse]) → None

Async:

abstractmethod RemoveTagsFromBinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveTagsFromBinaryDataByIDsRequest, app.data.v1.data_pb2.RemoveTagsFromBinaryDataByIDsResponse]) → None

Async:

abstractmethod RemoveTagsFromBinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveTagsFromBinaryDataByFilterRequest, app.data.v1.data_pb2.RemoveTagsFromBinaryDataByFilterResponse]) → None

Async:

abstractmethod TagsByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.TagsByFilterRequest, app.data.v1.data_pb2.TagsByFilterResponse]) → None

Async:

abstractmethod AddBoundingBoxToImageByID(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddBoundingBoxToImageByIDRequest, app.data.v1.data_pb2.AddBoundingBoxToImageByIDResponse]) → None

Async:

abstractmethod RemoveBoundingBoxFromImageByID(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveBoundingBoxFromImageByIDRequest, app.data.v1.data_pb2.RemoveBoundingBoxFromImageByIDResponse]) → None

Async:

abstractmethod BoundingBoxLabelsByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.BoundingBoxLabelsByFilterRequest, app.data.v1.data_pb2.BoundingBoxLabelsByFilterResponse]) → None

Async:

abstractmethod UpdateBoundingBox(stream: grpclib.server.Stream[app.data.v1.data_pb2.UpdateBoundingBoxRequest, app.data.v1.data_pb2.UpdateBoundingBoxResponse]) → None

Async:

abstractmethod GetDatabaseConnection(stream: grpclib.server.Stream[app.data.v1.data_pb2.GetDatabaseConnectionRequest, app.data.v1.data_pb2.GetDatabaseConnectionResponse]) → None

Async:

abstractmethod ConfigureDatabaseUser(stream: grpclib.server.Stream[app.data.v1.data_pb2.ConfigureDatabaseUserRequest, app.data.v1.data_pb2.ConfigureDatabaseUserResponse]) → None

Async:

abstractmethod AddBinaryDataToDatasetByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddBinaryDataToDatasetByIDsRequest, app.data.v1.data_pb2.AddBinaryDataToDatasetByIDsResponse]) → None

Async:

abstractmethod RemoveBinaryDataFromDatasetByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveBinaryDataFromDatasetByIDsRequest, app.data.v1.data_pb2.RemoveBinaryDataFromDatasetByIDsResponse]) → None

Async:

abstractmethod CreateIndex(stream: grpclib.server.Stream[app.data.v1.data_pb2.CreateIndexRequest, app.data.v1.data_pb2.CreateIndexResponse]) → None

Async:

abstractmethod ListIndexes(stream: grpclib.server.Stream[app.data.v1.data_pb2.ListIndexesRequest, app.data.v1.data_pb2.ListIndexesResponse]) → None

Async:

abstractmethod DeleteIndex(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteIndexRequest, app.data.v1.data_pb2.DeleteIndexResponse]) → None

Async:

abstractmethod CreateSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.CreateSavedQueryRequest, app.data.v1.data_pb2.CreateSavedQueryResponse]) → None

Async:

abstractmethod UpdateSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.UpdateSavedQueryRequest, app.data.v1.data_pb2.UpdateSavedQueryResponse]) → None

Async:

abstractmethod GetSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.GetSavedQueryRequest, app.data.v1.data_pb2.GetSavedQueryResponse]) → None

Async:

abstractmethod DeleteSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteSavedQueryRequest, app.data.v1.data_pb2.DeleteSavedQueryResponse]) → None

Async:

abstractmethod ListSavedQueries(stream: grpclib.server.Stream[app.data.v1.data_pb2.ListSavedQueriesRequest, app.data.v1.data_pb2.ListSavedQueriesResponse]) → None

Async:

abstractmethod CreateBinaryDataSignedURL(stream: grpclib.server.Stream[app.data.v1.data_pb2.CreateBinaryDataSignedURLRequest, app.data.v1.data_pb2.CreateBinaryDataSignedURLResponse]) → None

Async:

__mapping__() → Dict[str, grpclib.const.Handler]

class viam.proto.app.data.DataServiceStub(channel: grpclib.client.Channel)

TabularDataByFilter

TabularDataBySQL

TabularDataByMQL

ExportTabularData

GetLatestTabularData

BinaryDataByFilter

BinaryDataByIDs

DeleteTabularData

DeleteBinaryDataByFilter

DeleteBinaryDataByIDs

AddTagsToBinaryDataByIDs

AddTagsToBinaryDataByFilter

RemoveTagsFromBinaryDataByIDs

RemoveTagsFromBinaryDataByFilter

TagsByFilter

AddBoundingBoxToImageByID

RemoveBoundingBoxFromImageByID

BoundingBoxLabelsByFilter

UpdateBoundingBox

GetDatabaseConnection

ConfigureDatabaseUser

AddBinaryDataToDatasetByIDs

RemoveBinaryDataFromDatasetByIDs

CreateIndex

ListIndexes

DeleteIndex

CreateSavedQuery

UpdateSavedQuery

GetSavedQuery

DeleteSavedQuery

ListSavedQueries

CreateBinaryDataSignedURL

class viam.proto.app.data.UnimplementedDataServiceBase

Bases: DataServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async TabularDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.TabularDataByFilterRequest, app.data.v1.data_pb2.TabularDataByFilterResponse]) → None

async TabularDataBySQL(stream: grpclib.server.Stream[app.data.v1.data_pb2.TabularDataBySQLRequest, app.data.v1.data_pb2.TabularDataBySQLResponse]) → None

async TabularDataByMQL(stream: grpclib.server.Stream[app.data.v1.data_pb2.TabularDataByMQLRequest, app.data.v1.data_pb2.TabularDataByMQLResponse]) → None

async ExportTabularData(stream: grpclib.server.Stream[app.data.v1.data_pb2.ExportTabularDataRequest, app.data.v1.data_pb2.ExportTabularDataResponse]) → None

async GetLatestTabularData(stream: grpclib.server.Stream[app.data.v1.data_pb2.GetLatestTabularDataRequest, app.data.v1.data_pb2.GetLatestTabularDataResponse]) → None

async BinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.BinaryDataByFilterRequest, app.data.v1.data_pb2.BinaryDataByFilterResponse]) → None

async BinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.BinaryDataByIDsRequest, app.data.v1.data_pb2.BinaryDataByIDsResponse]) → None

async DeleteTabularData(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteTabularDataRequest, app.data.v1.data_pb2.DeleteTabularDataResponse]) → None

async DeleteBinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteBinaryDataByFilterRequest, app.data.v1.data_pb2.DeleteBinaryDataByFilterResponse]) → None

async DeleteBinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteBinaryDataByIDsRequest, app.data.v1.data_pb2.DeleteBinaryDataByIDsResponse]) → None

async AddTagsToBinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddTagsToBinaryDataByIDsRequest, app.data.v1.data_pb2.AddTagsToBinaryDataByIDsResponse]) → None

async AddTagsToBinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddTagsToBinaryDataByFilterRequest, app.data.v1.data_pb2.AddTagsToBinaryDataByFilterResponse]) → None

async RemoveTagsFromBinaryDataByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveTagsFromBinaryDataByIDsRequest, app.data.v1.data_pb2.RemoveTagsFromBinaryDataByIDsResponse]) → None

async RemoveTagsFromBinaryDataByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveTagsFromBinaryDataByFilterRequest, app.data.v1.data_pb2.RemoveTagsFromBinaryDataByFilterResponse]) → None

async TagsByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.TagsByFilterRequest, app.data.v1.data_pb2.TagsByFilterResponse]) → None

async AddBoundingBoxToImageByID(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddBoundingBoxToImageByIDRequest, app.data.v1.data_pb2.AddBoundingBoxToImageByIDResponse]) → None

async RemoveBoundingBoxFromImageByID(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveBoundingBoxFromImageByIDRequest, app.data.v1.data_pb2.RemoveBoundingBoxFromImageByIDResponse]) → None

async BoundingBoxLabelsByFilter(stream: grpclib.server.Stream[app.data.v1.data_pb2.BoundingBoxLabelsByFilterRequest, app.data.v1.data_pb2.BoundingBoxLabelsByFilterResponse]) → None

async UpdateBoundingBox(stream: grpclib.server.Stream[app.data.v1.data_pb2.UpdateBoundingBoxRequest, app.data.v1.data_pb2.UpdateBoundingBoxResponse]) → None

async GetDatabaseConnection(stream: grpclib.server.Stream[app.data.v1.data_pb2.GetDatabaseConnectionRequest, app.data.v1.data_pb2.GetDatabaseConnectionResponse]) → None

async ConfigureDatabaseUser(stream: grpclib.server.Stream[app.data.v1.data_pb2.ConfigureDatabaseUserRequest, app.data.v1.data_pb2.ConfigureDatabaseUserResponse]) → None

async AddBinaryDataToDatasetByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.AddBinaryDataToDatasetByIDsRequest, app.data.v1.data_pb2.AddBinaryDataToDatasetByIDsResponse]) → None

async RemoveBinaryDataFromDatasetByIDs(stream: grpclib.server.Stream[app.data.v1.data_pb2.RemoveBinaryDataFromDatasetByIDsRequest, app.data.v1.data_pb2.RemoveBinaryDataFromDatasetByIDsResponse]) → None

async CreateIndex(stream: grpclib.server.Stream[app.data.v1.data_pb2.CreateIndexRequest, app.data.v1.data_pb2.CreateIndexResponse]) → None

async ListIndexes(stream: grpclib.server.Stream[app.data.v1.data_pb2.ListIndexesRequest, app.data.v1.data_pb2.ListIndexesResponse]) → None

async DeleteIndex(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteIndexRequest, app.data.v1.data_pb2.DeleteIndexResponse]) → None

async CreateSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.CreateSavedQueryRequest, app.data.v1.data_pb2.CreateSavedQueryResponse]) → None

async UpdateSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.UpdateSavedQueryRequest, app.data.v1.data_pb2.UpdateSavedQueryResponse]) → None

async GetSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.GetSavedQueryRequest, app.data.v1.data_pb2.GetSavedQueryResponse]) → None

async DeleteSavedQuery(stream: grpclib.server.Stream[app.data.v1.data_pb2.DeleteSavedQueryRequest, app.data.v1.data_pb2.DeleteSavedQueryResponse]) → None

async ListSavedQueries(stream: grpclib.server.Stream[app.data.v1.data_pb2.ListSavedQueriesRequest, app.data.v1.data_pb2.ListSavedQueriesResponse]) → None

async CreateBinaryDataSignedURL(stream: grpclib.server.Stream[app.data.v1.data_pb2.CreateBinaryDataSignedURLRequest, app.data.v1.data_pb2.CreateBinaryDataSignedURLResponse]) → None

class viam.proto.app.data.AddBinaryDataToDatasetByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ..., dataset_id: str = ...)

Bases: google.protobuf.message.Message

AddBinaryDataToDatasetByIDsRequest adds the binary data with the given binary IDs to a dataset with dataset_id.

dataset_id: str

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.AddBinaryDataToDatasetByIDsResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.AddBoundingBoxToImageByIDRequest(*, binary_id: Global___BinaryID | None = ..., binary_data_id: str = ..., label: str = ..., x_min_normalized: float = ..., y_min_normalized: float = ..., x_max_normalized: float = ..., y_max_normalized: float = ..., confidence: float | None = ...)

Bases: google.protobuf.message.Message

AddBoundingBoxToImageByIDRequest specifies the binary ID to which a bounding box with the associated label and position in normalized coordinates will be added.

binary_data_id: str

label: str

x_min_normalized: float

y_min_normalized: float

x_max_normalized: float

y_max_normalized: float

confidence: float

binary_id() → Global___BinaryID

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__confidence) → _WhichOneofReturnType__confidence | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.AddBoundingBoxToImageByIDResponse(*, bbox_id: str = ...)

Bases: google.protobuf.message.Message

AddBoundingBoxToImageByIDResponse returns the bounding box ID of the successfully added bounding box.

bbox_id: str

class viam.proto.app.data.AddTagsToBinaryDataByFilterRequest(*, filter: Global___Filter | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

AddTagsToBinaryDataByFilterRequest requests adding all specified tags to each of the files when a filter is provided.

filter() → Global___Filter

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.AddTagsToBinaryDataByFilterResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.AddTagsToBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

AddTagsToBinaryDataByIDsRequest requests adding all specified tags to each of the files when binary ids are provided.

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.AddTagsToBinaryDataByIDsResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.Annotations(*, bboxes: collections.abc.Iterable[Global___BoundingBox] | None = ..., classifications: collections.abc.Iterable[Global___Classification] | None = ...)

Bases: google.protobuf.message.Message

Annotations are data annotations used for machine learning.

bboxes() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BoundingBox]

classifications() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Classification]

class viam.proto.app.data.BinaryData(*, binary: bytes = ..., metadata: Global___BinaryMetadata | None = ...)

Bases: google.protobuf.message.Message

BinaryData contains data and metadata associated with binary data.

binary: bytes

metadata() → Global___BinaryMetadata

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.BinaryDataByFilterRequest(*, data_request: Global___DataRequest | None = ..., include_binary: bool = ..., count_only: bool = ..., include_internal_data: bool = ...)

Bases: google.protobuf.message.Message

BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data when a filter is provided.

include_binary: bool

count_only: bool

include_internal_data: bool

data_request() → Global___DataRequest

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.BinaryDataByFilterResponse(*, data: collections.abc.Iterable[Global___BinaryData] | None = ..., count: int = ..., last: str = ..., total_size_bytes: int = ...)

Bases: google.protobuf.message.Message

BinaryDataByFilterResponse provides the data and metadata of binary (image + file) data when a filter is provided.

count: int

last: str

total_size_bytes: int

data() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryData]

class viam.proto.app.data.BinaryDataByIDsRequest(*, include_binary: bool = ..., binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

BinaryDataByFilterRequest requests the data and metadata of binary (image + file) data by binary ids.

include_binary: bool

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.BinaryDataByIDsResponse(*, data: collections.abc.Iterable[Global___BinaryData] | None = ..., count: int = ...)

Bases: google.protobuf.message.Message

BinaryDataByIDsResponse provides the data and metadata of binary (image + file) data when a filter is provided.

count: int

data() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryData]

class viam.proto.app.data.BinaryID(*, file_id: str = ..., organization_id: str = ..., location_id: str = ...)

Bases: google.protobuf.message.Message

BinaryID is the unique identifier for a file that one can request to be retrieved or modified.

file_id: str

organization_id: str

location_id: str

class viam.proto.app.data.BinaryMetadata(*, id: str = ..., capture_metadata: Global___CaptureMetadata | None = ..., time_requested: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_received: google.protobuf.timestamp_pb2.Timestamp | None = ..., file_name: str = ..., file_ext: str = ..., uri: str = ..., annotations: Global___Annotations | None = ..., dataset_ids: collections.abc.Iterable[str] | None = ..., binary_data_id: str = ..., file_size_bytes: int = ...)

Bases: google.protobuf.message.Message

BinaryMetadata is the metadata associated with binary data.

id() → str

file_name: str

file_ext: str

uri: str

binary_data_id: str

file_size_bytes: int

capture_metadata() → Global___CaptureMetadata

time_requested() → google.protobuf.timestamp_pb2.Timestamp

time_received() → google.protobuf.timestamp_pb2.Timestamp

annotations() → Global___Annotations

dataset_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.BoundingBox(*, id: str = ..., label: str = ..., x_min_normalized: float = ..., y_min_normalized: float = ..., x_max_normalized: float = ..., y_max_normalized: float = ..., confidence: float | None = ...)

Bases: google.protobuf.message.Message

BoundingBox represents a labeled bounding box on an image. x and y values are normalized ratios between 0 and 1.

id: str

label: str

x_min_normalized: float

y_min_normalized: float

x_max_normalized: float

y_max_normalized: float

confidence: float

confidence is an optional range from 0 - 1

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__confidence) → _WhichOneofReturnType__confidence | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.BoundingBoxLabelsByFilterRequest(*, filter: Global___Filter | None = ...)

Bases: google.protobuf.message.Message

BoundingBoxLabelsByFilterRequest requests all the labels of the bounding boxes from files from a given filter.

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.BoundingBoxLabelsByFilterResponse(*, labels: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

BoundingBoxLabelsByFilterRequest returns all the labels of the bounding boxes from files from a given filter.

labels() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.CaptureInterval(*, start: google.protobuf.timestamp_pb2.Timestamp | None = ..., end: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

CaptureInterval describes the start and end time of the capture in this file.

start() → google.protobuf.timestamp_pb2.Timestamp

end() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.CaptureMetadata(*, organization_id: str = ..., location_id: str = ..., robot_name: str = ..., robot_id: str = ..., part_name: str = ..., part_id: str = ..., component_type: str = ..., component_name: str = ..., method_name: str = ..., method_parameters: collections.abc.Mapping[str, google.protobuf.any_pb2.Any] | None = ..., tags: collections.abc.Iterable[str] | None = ..., mime_type: str = ...)

Bases: google.protobuf.message.Message

CaptureMetadata contains information on the settings used for the data capture.

class MethodParametersEntry(*, key: str = ..., value: google.protobuf.any_pb2.Any | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str

value() → google.protobuf.any_pb2.Any

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

organization_id: str

location_id: str

robot_name: str

robot_id: str

part_name: str

part_id: str

component_type: str

component_name: str

method_name: str

mime_type: str

method_parameters() → google.protobuf.internal.containers.MessageMap[str, google.protobuf.any_pb2.Any]

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.Classification(*, id: str = ..., label: str = ..., confidence: float | None = ...)

Bases: google.protobuf.message.Message

Classification represents a confidence score with a label.

id: str

label: str

confidence: float

confidence is an optional range from 0 - 1

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__confidence) → _WhichOneofReturnType__confidence | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.ConfigureDatabaseUserRequest(*, organization_id: str = ..., password: str = ...)

Bases: google.protobuf.message.Message

ConfigureDatabaseUserRequest accepts a Viam organization ID and a password for the database user being configured. Viam uses gRPC over TLS, so the entire request will be encrypted while in flight, including the password.

organization_id: str

password: str

class viam.proto.app.data.ConfigureDatabaseUserResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.CreateBinaryDataSignedURLRequest(*, binary_data_id: str = ..., expiration_minutes: int | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

binary_data_id: str

The binary data ID of the file to create a signed URL for.

expiration_minutes: int

Expiration time in minutes. Defaults to 15 minutes if not specified. Maximum allowed is 10080 minutes (7 days).

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__expiration_minutes) → _WhichOneofReturnType__expiration_minutes | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.CreateBinaryDataSignedURLResponse(*, signed_url: str = ..., expires_at: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

signed_url: str

The signed URL for the binary data file.

expires_at() → google.protobuf.timestamp_pb2.Timestamp

Expiration time of the signed URL token.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.CreateIndexRequest(*, organization_id: str = ..., collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ..., index_spec: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

CreateIndexRequest starts a custom index build

organization_id: str

collection_type: Global___IndexableCollection

pipeline_name: str

index_spec() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

index_spec accepts a MongoDB index specification defined in JSON format

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.CreateIndexResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.CreateSavedQueryRequest(*, organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

CreateSavedQueryRequest saves a mql query.

organization_id: str

name: str

mql_binary() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

class viam.proto.app.data.CreateSavedQueryResponse(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

class viam.proto.app.data.DataRequest(*, filter: Global___Filter | None = ..., limit: int = ..., last: str = ..., sort_order: Global___Order = ...)

Bases: google.protobuf.message.Message

DataRequest encapsulates the filter for the data, a limit on the maximum results returned, a last string associated with the last returned document, and the sorting order by time. last is returned in the responses TabularDataByFilterResponse and BinaryDataByFilterResponse from the API calls TabularDataByFilter and BinaryDataByFilter, respectively. We can then use the last string from the previous API calls in the subsequent request to get the next set of ordered documents.

limit: int

last: str

sort_order: Global___Order

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.DeleteBinaryDataByFilterRequest(*, filter: Global___Filter | None = ..., include_internal_data: bool = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByFilterRequest deletes the data and metadata of binary data when a filter is provided.

include_internal_data: bool

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.DeleteBinaryDataByFilterResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByFilterResponse returns the number of binary files deleted when a filter is provided.

deleted_count: int

class viam.proto.app.data.DeleteBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByIDsRequest deletes the data and metadata of binary data when binary ids are provided.

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.DeleteBinaryDataByIDsResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataByIDsResponse returns the number of binary files deleted when binary ids are provided.

deleted_count: int

class viam.proto.app.data.DeleteIndexRequest(*, organization_id: str = ..., collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ..., index_name: str = ...)

Bases: google.protobuf.message.Message

DeleteIndexRequest drops the specified custom index from a collection

organization_id: str

collection_type: Global___IndexableCollection

pipeline_name: str

index_name: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.DeleteIndexResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.DeleteSavedQueryRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

DeleteSavedQuery deletes a saved query based on the given id.

id: str

class viam.proto.app.data.DeleteSavedQueryResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.DeleteTabularDataRequest(*, organization_id: str = ..., delete_older_than_days: int = ..., filter: Global___DeleteTabularFilter | None = ...)

Bases: google.protobuf.message.Message

DeleteTabularDataRequest deletes the data from the organization that is older than delete_older_than_days in UTC time. For example, if delete_older_than_days=1 and the request is made at 1AM EST on March 11 (March 11 5AM UTC), this deletes all data captured through March 10 11:59:59PM UTC. If the request is at 10PM EST on March 11 (March 12 2AM UTC), this deletes all data captured through March 11 11:59:59PM UTC. If delete_older_than_days is 0, all existing data is deleted. If no filter is provided, data will be deleted based on organization_id.

organization_id: str

delete_older_than_days: int

filter() → Global___DeleteTabularFilter

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__filter) → _WhichOneofReturnType__filter | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.DeleteTabularDataResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

DeleteBinaryDataResponse returns the number of tabular datapoints deleted.

deleted_count: int

class viam.proto.app.data.DeleteTabularFilter(*, location_ids: collections.abc.Iterable[str] | None = ..., robot_id: str = ..., part_id: str = ..., component_type: str = ..., component_name: str = ..., method: str = ..., tags_filter: Global___TagsFilter | None = ...)

Bases: google.protobuf.message.Message

TabularFilter filters tabular data. All fields are optional; omitted fields are treated as unconstrained.

robot_id: str

part_id: str

component_type: str

component_name: str

method: str

location_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

tags_filter() → Global___TagsFilter

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.ExportTabularDataRequest(*, part_id: str = ..., resource_name: str = ..., resource_subtype: str = ..., method_name: str = ..., interval: Global___CaptureInterval | None = ..., additional_parameters: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

ExportTabularDataRequest requests tabular data from the specified data source.

part_id: str

resource_name: str

resource_subtype: str

method_name: str

interval() → Global___CaptureInterval

additional_parameters() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__additional_parameters) → _WhichOneofReturnType__additional_parameters | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.ExportTabularDataResponse(*, part_id: str = ..., resource_name: str = ..., resource_subtype: str = ..., method_name: str = ..., time_captured: google.protobuf.timestamp_pb2.Timestamp | None = ..., organization_id: str = ..., location_id: str = ..., robot_name: str = ..., robot_id: str = ..., part_name: str = ..., method_parameters: google.protobuf.struct_pb2.Struct | None = ..., tags: collections.abc.Iterable[str] | None = ..., payload: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

ExportTabularDataResponse provides unified tabular data and metadata for a single data point from the specified data source.

part_id: str

resource_name: str

resource_subtype: str

method_name: str

organization_id: str

location_id: str

robot_name: str

robot_id: str

part_name: str

time_captured() → google.protobuf.timestamp_pb2.Timestamp

method_parameters() → google.protobuf.struct_pb2.Struct

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

payload() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.Filter(*, component_name: str = ..., component_type: str = ..., method: str = ..., robot_name: str = ..., robot_id: str = ..., part_name: str = ..., part_id: str = ..., location_ids: collections.abc.Iterable[str] | None = ..., organization_ids: collections.abc.Iterable[str] | None = ..., mime_type: collections.abc.Iterable[str] | None = ..., interval: Global___CaptureInterval | None = ..., tags_filter: Global___TagsFilter | None = ..., bbox_labels: collections.abc.Iterable[str] | None = ..., dataset_id: str = ...)

Bases: google.protobuf.message.Message

Filter defines the fields over which we can filter data using a logic AND. For example, if component_type and robot_id are specified, only data from that robot_id of type component_type is returned. However, we logical OR over the specified tags and bounding box labels, such that if component_type, robot_id, tagA, tagB are specified, we return data from that robot_id of type component_type with tagA or tagB.

component_name: str

component_type: str

method: str

robot_name: str

robot_id: str

part_name: str

part_id: str

dataset_id: str

location_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

organization_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

mime_type() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

interval() → Global___CaptureInterval

tags_filter() → Global___TagsFilter

bbox_labels() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

bbox_labels are used to match documents with the specified bounding box labels (using logical OR).

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.GetDatabaseConnectionRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

GetDatabaseConnectionRequest requests the database connection hostname.

organization_id: str

class viam.proto.app.data.GetDatabaseConnectionResponse(*, hostname: str = ..., mongodb_uri: str = ..., has_database_user: bool = ...)

Bases: google.protobuf.message.Message

GetDatabaseConnectionResponse returns the database connection hostname endpoint. It also returns a URI that can be used to connect to the database instance through MongoDB clients, as well as information on whether the Viam organization has a database user configured.

hostname: str

mongodb_uri: str

has_database_user: bool

class viam.proto.app.data.GetLatestTabularDataRequest(*, part_id: str = ..., resource_name: str = ..., method_name: str = ..., resource_subtype: str = ..., additional_parameters: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

GetLatestTabularDataRequest requests the most recent tabular data captured from the specified data source.

part_id: str

resource_name: str

method_name: str

resource_subtype: str

additional_parameters() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__additional_parameters) → _WhichOneofReturnType__additional_parameters | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.GetLatestTabularDataResponse(*, time_captured: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_synced: google.protobuf.timestamp_pb2.Timestamp | None = ..., payload: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

GetLatestTabularDataResponse provides the data, time synced, and time captured of the most recent tabular data captured from the requested data source, as long as it was synced within the last year.

time_captured() → google.protobuf.timestamp_pb2.Timestamp

time_synced() → google.protobuf.timestamp_pb2.Timestamp

payload() → google.protobuf.struct_pb2.Struct

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.GetSavedQueryRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

GetSavedQuery retrieves a saved query by id.

id: str

class viam.proto.app.data.GetSavedQueryResponse(*, saved_query: Global___Query | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

saved_query() → Global___Query

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.Index(*, collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ..., index_name: str = ..., index_spec: collections.abc.Iterable[bytes] | None = ..., created_by: Global___IndexCreator = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

collection_type: Global___IndexableCollection

pipeline_name: str

index_name: str

created_by: Global___IndexCreator

index_spec() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

index_spec defines a MongoDB index in JSON format

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.IndexableCollection

Bases: _IndexableCollection

IndexableCollection specifies the types of collections available for custom indexes

class viam.proto.app.data.IndexCreator

Bases: _IndexCreator

IndexCreator specifies the entity that originally created the index

class viam.proto.app.data.ListIndexesRequest(*, organization_id: str = ..., collection_type: Global___IndexableCollection = ..., pipeline_name: str | None = ...)

Bases: google.protobuf.message.Message

ListIndexesRequest returns all the indexes for a given collection

organization_id: str

collection_type: Global___IndexableCollection

pipeline_name: str

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__pipeline_name) → _WhichOneofReturnType__pipeline_name | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.ListIndexesResponse(*, indexes: collections.abc.Iterable[Global___Index] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

indexes() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Index]

class viam.proto.app.data.ListSavedQueriesRequest(*, organization_id: str = ..., limit: int = ...)

Bases: google.protobuf.message.Message

ListSavedQueries lists saved queries for a given organization.

organization_id: str

limit: int

class viam.proto.app.data.ListSavedQueriesResponse(*, queries: collections.abc.Iterable[Global___Query] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

queries() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Query]

class viam.proto.app.data.Order

Bases: _Order

Order specifies the order in which data is returned.

class viam.proto.app.data.Query(*, id: str = ..., organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., updated_at: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

organization_id: str

name: str

mql_binary() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

created_on() → google.protobuf.timestamp_pb2.Timestamp

updated_at() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.RemoveBinaryDataFromDatasetByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ..., dataset_id: str = ...)

Bases: google.protobuf.message.Message

RemoveBinaryDataFromDatasetByIDsRequest removes the specified binary IDs from a dataset with dataset_id.

dataset_id: str

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.RemoveBinaryDataFromDatasetByIDsResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.RemoveBoundingBoxFromImageByIDRequest(*, binary_id: Global___BinaryID | None = ..., binary_data_id: str = ..., bbox_id: str = ...)

Bases: google.protobuf.message.Message

RemoveBoundingBoxFromImageByIDRequest removes the bounding box with specified bounding box ID for the file represented by the binary ID.

binary_data_id: str

bbox_id: str

binary_id() → Global___BinaryID

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.RemoveBoundingBoxFromImageByIDResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.RemoveTagsFromBinaryDataByFilterRequest(*, filter: Global___Filter | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByFilterRequest requests removing the given tags value from each file when a filter is provided.

filter() → Global___Filter

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.RemoveTagsFromBinaryDataByFilterResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByFilterResponse returns the number of binary files which had tags removed.

deleted_count: int

class viam.proto.app.data.RemoveTagsFromBinaryDataByIDsRequest(*, binary_ids: collections.abc.Iterable[Global___BinaryID] | None = ..., binary_data_ids: collections.abc.Iterable[str] | None = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByIDsRequest requests removing the given tags value from each file when binary ids are provided.

binary_ids() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___BinaryID]

binary_data_ids() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.RemoveTagsFromBinaryDataByIDsResponse(*, deleted_count: int = ...)

Bases: google.protobuf.message.Message

RemoveTagsFromBinaryDataByIDsResponse returns the number of binary files which had tags removed

deleted_count: int

class viam.proto.app.data.TabularData(*, data: google.protobuf.struct_pb2.Struct | None = ..., metadata_index: int = ..., time_requested: google.protobuf.timestamp_pb2.Timestamp | None = ..., time_received: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

TabularData contains data and metadata associated with tabular data.

metadata_index: int

data() → google.protobuf.struct_pb2.Struct

time_requested() → google.protobuf.timestamp_pb2.Timestamp

time_received() → google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.TabularDataByFilterRequest(*, data_request: Global___DataRequest | None = ..., count_only: bool = ..., include_internal_data: bool = ...)

Bases: google.protobuf.message.Message

TabularDataByFilterRequest requests tabular data based on filter values.

count_only: bool

include_internal_data: bool

data_request() → Global___DataRequest

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.TabularDataByFilterResponse(*, metadata: collections.abc.Iterable[Global___CaptureMetadata] | None = ..., data: collections.abc.Iterable[Global___TabularData] | None = ..., count: int = ..., last: str = ..., total_size_bytes: int = ...)

Bases: google.protobuf.message.Message

TabularDataByFilterResponse provides the data and metadata of tabular data.

count: int

last: str

total_size_bytes: int

metadata() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___CaptureMetadata]

data() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___TabularData]

class viam.proto.app.data.TabularDataByMQLRequest(*, organization_id: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., use_recent_data: bool | None = ..., data_source: Global___TabularDataSource | None = ..., query_prefix_name: str | None = ...)

Bases: google.protobuf.message.Message

TabularDataByMQLRequest requests tabular data using an MQL query.

organization_id: str

use_recent_data: bool

Deprecated, please use TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE instead.

query_prefix_name: str

query_prefix_name is an optional field that can be used to specify a saved query to run

mql_binary() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

mql_binary accepts a MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline. The pipeline is run on the “sensorData.readings” namespace, which holds the Viam organization’s tabular data.

data_source() → Global___TabularDataSource

data_source is an optional field that can be used to specify the data source for the query. If not specified, the query will run on “standard” storage.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__data_source) → _WhichOneofReturnType__data_source | None

WhichOneof(oneof_group: _WhichOneofArgType__query_prefix_name) → _WhichOneofReturnType__query_prefix_name | None

WhichOneof(oneof_group: _WhichOneofArgType__use_recent_data) → _WhichOneofReturnType__use_recent_data | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.TabularDataByMQLResponse(*, raw_data: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

TabularDataByMQLResponse provides unified tabular data and metadata, queried with MQL.

raw_data() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

class viam.proto.app.data.TabularDataBySQLRequest(*, organization_id: str = ..., sql_query: str = ...)

Bases: google.protobuf.message.Message

TabularDataBySQLRequest requests tabular data using a SQL query.

organization_id: str

sql_query: str

sql_query accepts any valid SQL SELECT statement. Tabular data is held in a database called “sensorData” and a table called readings, so queries should select from “readings” or “sensorData.readings”.

class viam.proto.app.data.TabularDataBySQLResponse(*, raw_data: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

TabularDataBySQLResponse provides unified tabular data and metadata, queried with SQL.

raw_data() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

class viam.proto.app.data.TabularDataSource(*, type: Global___TabularDataSourceType = ..., pipeline_id: str | None = ...)

Bases: google.protobuf.message.Message

TabularDataSource specifies the data source for user queries to execute on.

type: Global___TabularDataSourceType

pipeline_id: str

pipeline_id is the ID of the pipeline to query. Required when using TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK.

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__pipeline_id) → _WhichOneofReturnType__pipeline_id | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.TabularDataSourceType

Bases: _TabularDataSourceType

TabularDataSourceType specifies the data source type for TabularDataByMQL queries.

class viam.proto.app.data.TagsByFilterRequest(*, filter: Global___Filter | None = ...)

Bases: google.protobuf.message.Message

TagsByFilterRequest requests the unique tags from data based on given filter.

filter() → Global___Filter

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

class viam.proto.app.data.TagsByFilterResponse(*, tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

TagsByFilterResponse returns the unique tags from data based on given filter.

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.app.data.TagsFilter(*, type: Global___TagsFilterType = ..., tags: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

TagsFilter defines the type of filtering and, if applicable, over which tags to perform a logical OR.

type: Global___TagsFilterType

tags() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

Tags are used to match documents if type is UNSPECIFIED or MATCH_BY_OR.

class viam.proto.app.data.TagsFilterType

Bases: _TagsFilterType

TagsFilterType specifies how data can be filtered based on tags.

class viam.proto.app.data.UpdateBoundingBoxRequest(*, binary_id: Global___BinaryID | None = ..., binary_data_id: str = ..., bbox_id: str = ..., label: str | None = ..., x_min_normalized: float | None = ..., y_min_normalized: float | None = ..., x_max_normalized: float | None = ..., y_max_normalized: float | None = ..., confidence: float | None = ...)

Bases: google.protobuf.message.Message

UpdateBoundingBoxRequest updates the bounding box with specified bounding box ID for the file represented by the binary ID.

binary_data_id: str

bbox_id: str

label: str

x_min_normalized: float

y_min_normalized: float

x_max_normalized: float

y_max_normalized: float

confidence: float

binary_id() → Global___BinaryID

HasField(field_name: _HasFieldArgType) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:

field_name (str) – The name of the field to check for presence.

Returns:

Whether a value has been set for the named field.

Return type:

bool

Raises:

ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: _WhichOneofArgType__confidence) → _WhichOneofReturnType__confidence | None

WhichOneof(oneof_group: _WhichOneofArgType__label) → _WhichOneofReturnType__label | None

WhichOneof(oneof_group: _WhichOneofArgType__x_max_normalized) → _WhichOneofReturnType__x_max_normalized | None

WhichOneof(oneof_group: _WhichOneofArgType__x_min_normalized) → _WhichOneofReturnType__x_min_normalized | None

WhichOneof(oneof_group: _WhichOneofArgType__y_max_normalized) → _WhichOneofReturnType__y_max_normalized | None

WhichOneof(oneof_group: _WhichOneofArgType__y_min_normalized) → _WhichOneofReturnType__y_min_normalized | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:

oneof_group (str) – the name of the oneof group to check.

Returns:

The name of the group that is set, or None.

Return type:

str or None

Raises:

ValueError – no group with the given name exists

class viam.proto.app.data.UpdateBoundingBoxResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.app.data.UpdateSavedQueryRequest(*, id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ...)

Bases: google.protobuf.message.Message

UpdateSavedQuery updates the saved query with the given id.

id: str

name: str

mql_binary() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

class viam.proto.app.data.UpdateSavedQueryResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.