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.
`CreateIndexRequest`	CreateIndexRequest starts a custom index build
`CreateIndexResponse`	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.
`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.
`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
`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.
`Order`	Order specifies the order in which data is returned.
`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.

Package Contents

class viam.proto.app.data.DataServiceBase[source]

Bases: abc.ABC

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

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

Async:

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

class viam.proto.app.data.DataServiceStub(channel: grpclib.client.Channel)[source]

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

class viam.proto.app.data.UnimplementedDataServiceBase[source]

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[source]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]

property 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 = ...)

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

property binary_id: global___BinaryID

HasField(field_name: Literal['binary_id', b'binary_id']) → 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.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.

property filter: global___Filter

property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: Literal['filter', b'filter']) → 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.

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]

property binary_data_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property 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.

property bboxes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BoundingBox]

property 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

property metadata: global___BinaryMetadata

HasField(field_name: Literal['metadata', b'metadata']) → 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

property data_request: global___DataRequest

HasField(field_name: Literal['data_request', b'data_request']) → 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

property 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

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]

property 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

property 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 = ...)

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

property capture_metadata: global___CaptureMetadata

property time_requested: google.protobuf.timestamp_pb2.Timestamp

property time_received: google.protobuf.timestamp_pb2.Timestamp

property annotations: global___Annotations

property dataset_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: Literal['annotations', b'annotations', 'capture_metadata', b'capture_metadata', 'time_received', b'time_received', 'time_requested', b'time_requested']) → 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: Literal['_confidence', b'_confidence', 'confidence', b'confidence']) → 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: Literal['_confidence', b'_confidence']) → Literal['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.

property filter: global___Filter

HasField(field_name: Literal['filter', b'filter']) → 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.

property 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.

property start: google.protobuf.timestamp_pb2.Timestamp

property end: google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: Literal['end', b'end', 'start', b'start']) → 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

property value: google.protobuf.any_pb2.Any

HasField(field_name: Literal['value', b'value']) → 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

property method_parameters: google.protobuf.internal.containers.MessageMap[str, google.protobuf.any_pb2.Any]

property 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: Literal['_confidence', b'_confidence', 'confidence', b'confidence']) → 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: Literal['_confidence', b'_confidence']) → Literal['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.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

property index_spec: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]: index_spec accepts a MongoDB index specification defined in JSON format

HasField(field_name: Literal['_pipeline_name', b'_pipeline_name', 'pipeline_name', b'pipeline_name']) → 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: Literal['_pipeline_name', b'_pipeline_name']) → Literal['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.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

property filter: global___Filter

HasField(field_name: Literal['filter', b'filter']) → 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

property filter: global___Filter

HasField(field_name: Literal['filter', b'filter']) → 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.

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]

property 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: Literal['_pipeline_name', b'_pipeline_name', 'pipeline_name', b'pipeline_name']) → 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: Literal['_pipeline_name', b'_pipeline_name']) → Literal['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.DeleteTabularDataRequest(*, organization_id: str = ..., delete_older_than_days: int = ...)

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.

organization_id: str

delete_older_than_days: int

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.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

property interval: global___CaptureInterval

property additional_parameters: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['_additional_parameters', b'_additional_parameters', 'additional_parameters', b'additional_parameters', 'interval', b'interval']) → 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: Literal['_additional_parameters', b'_additional_parameters']) → Literal['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

property time_captured: google.protobuf.timestamp_pb2.Timestamp

property method_parameters: google.protobuf.struct_pb2.Struct

property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property payload: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['method_parameters', b'method_parameters', 'payload', b'payload', 'time_captured', b'time_captured']) → 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

property location_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property organization_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property mime_type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property interval: global___CaptureInterval

property tags_filter: global___TagsFilter

property 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: Literal['interval', b'interval', 'tags_filter', b'tags_filter']) → 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

property additional_parameters: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['_additional_parameters', b'_additional_parameters', 'additional_parameters', b'additional_parameters']) → 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: Literal['_additional_parameters', b'_additional_parameters']) → Literal['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.

property time_captured: google.protobuf.timestamp_pb2.Timestamp

property time_synced: google.protobuf.timestamp_pb2.Timestamp

property payload: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['payload', b'payload', 'time_captured', b'time_captured', 'time_synced', b'time_synced']) → 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

property index_spec: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]: index_spec defines a MongoDB index in JSON format

HasField(field_name: Literal['_pipeline_name', b'_pipeline_name', 'pipeline_name', b'pipeline_name']) → 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: Literal['_pipeline_name', b'_pipeline_name']) → Literal['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: Literal['_pipeline_name', b'_pipeline_name', 'pipeline_name', b'pipeline_name']) → 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: Literal['_pipeline_name', b'_pipeline_name']) → Literal['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.

property indexes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Index]

class viam.proto.app.data.Order

Bases: _Order

Order specifies the order in which data is returned.

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

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]

property 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

property binary_id: global___BinaryID

HasField(field_name: Literal['binary_id', b'binary_id']) → 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.

property filter: global___Filter

property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: Literal['filter', b'filter']) → 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.

property binary_ids: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___BinaryID]

property binary_data_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property 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

property data: google.protobuf.struct_pb2.Struct

property time_requested: google.protobuf.timestamp_pb2.Timestamp

property time_received: google.protobuf.timestamp_pb2.Timestamp

HasField(field_name: Literal['data', b'data', 'time_received', b'time_received', 'time_requested', b'time_requested']) → 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

property data_request: global___DataRequest

HasField(field_name: Literal['data_request', b'data_request']) → 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

property metadata: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___CaptureMetadata]

property 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

property 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.

property 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: Literal['_data_source', b'_data_source', '_query_prefix_name', b'_query_prefix_name', '_use_recent_data', b'_use_recent_data', 'data_source', b'data_source', 'query_prefix_name', b'query_prefix_name', 'use_recent_data', b'use_recent_data']) → 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: Literal['_data_source', b'_data_source']) → Literal['data_source'] | None

WhichOneof(oneof_group: Literal['_query_prefix_name', b'_query_prefix_name']) → Literal['query_prefix_name'] | None

WhichOneof(oneof_group: Literal['_use_recent_data', b'_use_recent_data']) → Literal['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.

property 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.

property 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: Literal['_pipeline_id', b'_pipeline_id', 'pipeline_id', b'pipeline_id']) → 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: Literal['_pipeline_id', b'_pipeline_id']) → Literal['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.

property filter: global___Filter

HasField(field_name: Literal['filter', b'filter']) → 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.

property 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

property 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 = ...)

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

property binary_id: global___BinaryID

HasField(field_name: Literal['_label', b'_label', '_x_max_normalized', b'_x_max_normalized', '_x_min_normalized', b'_x_min_normalized', '_y_max_normalized', b'_y_max_normalized', '_y_min_normalized', b'_y_min_normalized', 'binary_id', b'binary_id', 'label', b'label', 'x_max_normalized', b'x_max_normalized', 'x_min_normalized', b'x_min_normalized', 'y_max_normalized', b'y_max_normalized', 'y_min_normalized', b'y_min_normalized']) → 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: Literal['_label', b'_label']) → Literal['label'] | None

WhichOneof(oneof_group: Literal['_x_max_normalized', b'_x_max_normalized']) → Literal['x_max_normalized'] | None

WhichOneof(oneof_group: Literal['_x_min_normalized', b'_x_min_normalized']) → Literal['x_min_normalized'] | None

WhichOneof(oneof_group: Literal['_y_max_normalized', b'_y_max_normalized']) → Literal['y_max_normalized'] | None

WhichOneof(oneof_group: Literal['_y_min_normalized', b'_y_min_normalized']) → Literal['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.