Skip to content

Commit e38cce8

Browse files
npentrelnpentrel
authored
DOCS-2544: Add backlinks to docs (#235)
* DOCS-2544: Add backlinks to docs * Fixes
1 parent 1fe01eb commit e38cce8

File tree

16 files changed

+433
-2
lines changed

16 files changed

+433
-2
lines changed

‎lib/src/app/app.dart

+140
Large diffs are not rendered by default.

‎lib/src/app/billing.dart

+10
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,40 @@ import 'package:viam_sdk/protos/app/billing.dart';
55
/// gRPC client for connecting to Viam's Billing Service
66
///
77
/// All calls must be authenticated.
8+
///
9+
/// For more information, see [Billing Client API](https://docs.viam.com/appendix/apis/billing-client/).
810
class BillingClient {
911
final BillingServiceClient _client;
1012

1113
BillingClient(this._client);
1214

1315
/// Get a detailed breakdown of current month's costs
16+
///
17+
/// For more information, see [Billing Client API](https://docs.viam.com/appendix/apis/billing-client/).
1418
Future<GetCurrentMonthUsageResponse> getCurrentMonthUsage(String orgId) async {
1519
final request = GetCurrentMonthUsageRequest()..orgId = orgId;
1620
return await _client.getCurrentMonthUsage(request);
1721
}
1822

1923
/// Org-level information (like billing email and payment details)
24+
///
25+
/// For more information, see [Billing Client API](https://docs.viam.com/appendix/apis/billing-client/).
2026
Future<GetOrgBillingInformationResponse> getOrgBillingInformation(String orgId) async {
2127
final request = GetOrgBillingInformationRequest()..orgId = orgId;
2228
return await _client.getOrgBillingInformation(request);
2329
}
2430

2531
/// Total outstanding balance and previous invoices
32+
///
33+
/// For more information, see [Billing Client API](https://docs.viam.com/appendix/apis/billing-client/).
2634
Future<GetInvoicesSummaryResponse> getInvoicesSummary(String orgId) async {
2735
final request = GetInvoicesSummaryRequest()..orgId = orgId;
2836
return await _client.getInvoicesSummary(request);
2937
}
3038

3139
/// Download a PDF invoice
40+
///
41+
/// For more information, see [Billing Client API](https://docs.viam.com/appendix/apis/billing-client/).
3242
Stream<List<int>> getInvoicePdf(String orgId, String id) {
3343
final request = GetInvoicePdfRequest()
3444
..id = id

‎lib/src/app/data.dart

+62
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ typedef DatabaseConnection = GetDatabaseConnectionResponse;
1919
/// gRPC client used for retrieving, uploading, and modifying stored data from app.viam.com.
2020
///
2121
/// All calls must be authenticated.
22+
///
23+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
2224
class DataClient {
2325
final DataServiceClient _dataClient;
2426
final DataSyncServiceClient _dataSyncClient;
@@ -43,6 +45,8 @@ class DataClient {
4345

4446
/// Filter and download tabular data. The data will be paginated into pages of `limit` items, and the last ID will be included in
4547
/// the returned response.
48+
///
49+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
4650
Future<TabularDataByFilterResponse> tabularDataByFilter(
4751
{Filter? filter, int? limit, Order? sortOrder, String? last, countOnly = false}) async {
4852
final dataRequest = _makeDataRequest(filter, limit, last, sortOrder);
@@ -54,6 +58,8 @@ class DataClient {
5458

5559
/// Filter and download binary data. The data will be paginated into pages of `limit` items, and the last ID will be included in the
5660
/// returned response.
61+
///
62+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
5763
Future<BinaryDataByFilterResponse> binaryDataByFilter(
5864
{Filter? filter, int? limit, Order? sortOrder, String? last, countOnly = false}) async {
5965
final dataRequest = _makeDataRequest(filter, limit, last, sortOrder);
@@ -64,13 +70,17 @@ class DataClient {
6470
}
6571

6672
/// Retrieve binary data by IDs
73+
///
74+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
6775
Future<List<BinaryData>> binaryDataByIds(List<BinaryID> binaryIds) async {
6876
final request = BinaryDataByIDsRequest()..binaryIds.addAll(binaryIds);
6977
final response = await _dataClient.binaryDataByIDs(request);
7078
return response.data;
7179
}
7280

7381
/// Obtain unified tabular data and metadata, queried with SQL.
82+
///
83+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
7484
Future<List<Map<String, dynamic>>> tabularDataBySql(String organizationId, String query) async {
7585
final request = TabularDataBySQLRequest()
7686
..organizationId = organizationId
@@ -80,6 +90,8 @@ class DataClient {
8090
}
8191

8292
/// Obtain unified tabular data and metadata, queried with MQL.
93+
///
94+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
8395
Future<List<Map<String, dynamic>>> tabularDataByMql(String organizationId, List<Uint8List> query) async {
8496
final request = TabularDataByMQLRequest()
8597
..organizationId = organizationId
@@ -91,6 +103,8 @@ class DataClient {
91103
/// Delete tabular data older than a provided number of days from an organization.
92104
///
93105
/// Returns the number of pieces of data that were deleted.
106+
///
107+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
94108
Future<int> deleteTabularData(String organizationId, int olderThanDays) async {
95109
final request = DeleteTabularDataRequest()
96110
..organizationId = organizationId
@@ -103,6 +117,8 @@ class DataClient {
103117
/// If a [filter] is not provided, all data will be deleted.
104118
///
105119
/// Returns the number of pieces of data that were deleted.
120+
///
121+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
106122
Future<int> deleteBinaryDataByFilter(Filter? filter, {bool includeInternalData = false}) async {
107123
final request = DeleteBinaryDataByFilterRequest()
108124
..includeInternalData = includeInternalData
@@ -114,13 +130,17 @@ class DataClient {
114130
/// Delete binary data based on data ID.
115131
///
116132
/// Returns the number of pieces of data that were deleted.
133+
///
134+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
117135
Future<int> deleteBinaryDataByIds(List<BinaryID> binaryIds) async {
118136
final request = DeleteBinaryDataByIDsRequest()..binaryIds.addAll(binaryIds);
119137
final response = await _dataClient.deleteBinaryDataByIDs(request);
120138
return response.deletedCount.toInt();
121139
}
122140

123141
/// Adds tags to binary data based on IDs.
142+
///
143+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
124144
Future<void> addTagsToBinaryDataByIds(List<String> tags, List<BinaryID> binaryIds) async {
125145
final request = AddTagsToBinaryDataByIDsRequest()
126146
..tags.addAll(tags)
@@ -130,6 +150,8 @@ class DataClient {
130150

131151
/// Adds tags to binary data based on a filter.
132152
/// If no [filter] is provided, all binary data will be tagged.
153+
///
154+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
133155
Future<void> addTagsToBinaryDataByFilter(List<String> tags, Filter? filter) async {
134156
final request = AddTagsToBinaryDataByFilterRequest()
135157
..tags.addAll(tags)
@@ -141,6 +163,8 @@ class DataClient {
141163
/// If a [filter] is not provided, the tags will be removed from all data.
142164
///
143165
/// Returns the number of tags deleted.
166+
///
167+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
144168
Future<int> removeTagsFromBinaryDataByFilter(List<String> tags, Filter? filter) async {
145169
final request = RemoveTagsFromBinaryDataByFilterRequest()
146170
..tags.addAll(tags)
@@ -152,6 +176,8 @@ class DataClient {
152176
/// Remove tags from binary data based on IDs.
153177
///
154178
/// Returns the number of tags deleted.
179+
///
180+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
155181
Future<int> removeTagsFromBinaryDataByIds(List<String> tags, List<BinaryID> binaryIds) async {
156182
final request = RemoveTagsFromBinaryDataByIDsRequest()
157183
..tags.addAll(tags)
@@ -163,6 +189,8 @@ class DataClient {
163189
/// Add a bounding box to an image by ID, with x and y coordinates normalized from 0 to 1.
164190
///
165191
/// Returns the bounding box ID.
192+
///
193+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
166194
Future<String> addBoundingBoxToImageById(
167195
String label, BinaryID binaryId, double xMinNormalized, double yMinNormalized, double xMaxNormalized, double yMaxNormalized) async {
168196
final request = AddBoundingBoxToImageByIDRequest()
@@ -177,6 +205,8 @@ class DataClient {
177205
}
178206

179207
/// Removes a bounding box from an image based on bbox ID and image ID.
208+
///
209+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
180210
Future<void> removeBoundingBoxFromImageById(String bboxId, BinaryID binaryId) async {
181211
final request = RemoveBoundingBoxFromImageByIDRequest()
182212
..bboxId = bboxId
@@ -186,6 +216,8 @@ class DataClient {
186216

187217
/// Returns a list of tags based on a filter.
188218
/// If no [filter] is provided, all tags will be returned.
219+
///
220+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
189221
Future<List<String>> tagsByFilter(Filter? filter) async {
190222
final request = TagsByFilterRequest()..filter = filter ?? Filter();
191223
final response = await _dataClient.tagsByFilter(request);
@@ -194,19 +226,25 @@ class DataClient {
194226

195227
/// Returns a list of bounding box labels based on a filter.
196228
/// If no [filter] is provided, all labels will be returned.
229+
///
230+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
197231
Future<List<String>> boundingBoxLabelsByFilter(Filter? filter) async {
198232
final request = BoundingBoxLabelsByFilterRequest()..filter = filter ?? Filter();
199233
final response = await _dataClient.boundingBoxLabelsByFilter(request);
200234
return response.labels;
201235
}
202236

203237
/// Returns a database connection to access a MongoDB Atlas Data Federation instance.
238+
///
239+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
204240
Future<DatabaseConnection> getDatabaseConnection(String organizationId) async {
205241
final request = GetDatabaseConnectionRequest()..organizationId = organizationId;
206242
return await _dataClient.getDatabaseConnection(request);
207243
}
208244

209245
/// Configures a database user for Viam's MongoDB Atlas Data Federation instance.
246+
///
247+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
210248
Future<void> configureDatabaseUser(String organizationId, String password) async {
211249
final request = ConfigureDatabaseUserRequest()
212250
..password = password
@@ -215,6 +253,8 @@ class DataClient {
215253
}
216254

217255
/// Adds binary data to a dataset based on IDs.
256+
///
257+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
218258
Future<void> addBinaryDataToDatasetByIds(List<BinaryID> binaryIds, String datasetId) async {
219259
final request = AddBinaryDataToDatasetByIDsRequest()
220260
..binaryIds.addAll(binaryIds)
@@ -223,6 +263,8 @@ class DataClient {
223263
}
224264

225265
/// Removes binary data from a dataset based on IDs.
266+
///
267+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
226268
Future<void> removeBinaryDataFromDatasetByIds(List<BinaryID> binaryIds, String datasetId) async {
227269
final request = RemoveBinaryDataFromDatasetByIDsRequest()
228270
..binaryIds.addAll(binaryIds)
@@ -233,6 +275,8 @@ class DataClient {
233275
/// Upload an image to Viam's Data Manager
234276
///
235277
/// If no name is provided, the current timestamp will be used as the filename.
278+
///
279+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
236280
Future<String> uploadImage(ViamImage image, String partId,
237281
{String? fileName,
238282
String? componentType,
@@ -263,6 +307,8 @@ class DataClient {
263307
/// Upload a file from its path to Viam's Data Manager
264308
///
265309
/// The file name can be overridden by providing the [fileName] parameter.
310+
///
311+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
266312
Future<String> uploadFile(String path, String partId,
267313
{String? fileName,
268314
String? componentType,
@@ -307,6 +353,8 @@ class DataClient {
307353
/// Upload binary sensor data to Viam's Data Manager
308354
///
309355
/// Returns the data's file ID.
356+
///
357+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
310358
Future<String> binaryDataCaptureUpload(List<int> binaryData, String partId, String fileExtension,
311359
{String? componentType,
312360
String? componentName,
@@ -349,6 +397,8 @@ class DataClient {
349397
/// Upload tabular sensor data to Viam's Data Manager
350398
///
351399
/// Returns the data's file ID.
400+
///
401+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
352402
Future<String> tabularDataCaptureUpload(List<Map<String, dynamic>> tabularData, String partId,
353403
{String? componentType,
354404
String? componentName,
@@ -392,6 +442,8 @@ class DataClient {
392442
/// Uploads the metadata and contents of streaming binary data
393443
///
394444
/// Returns the data's file ID.
445+
///
446+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
395447
Future<String> streamingDataCaptureUpload(List<int> bytes, String partId, String fileExtension,
396448
{String? componentType,
397449
String? componentName,
@@ -433,6 +485,8 @@ class DataClient {
433485
}
434486

435487
/// Creates a new dataset, returning the new dataset's ID.
488+
///
489+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
436490
Future<String> createDataset(String orgId, String name) async {
437491
final request = CreateDatasetRequest()
438492
..organizationId = orgId
@@ -442,12 +496,16 @@ class DataClient {
442496
}
443497

444498
/// Deletes a dataset.
499+
///
500+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
445501
Future<void> deleteDataset(String id) async {
446502
final request = DeleteDatasetRequest()..id = id;
447503
await _datasetClient.deleteDataset(request);
448504
}
449505

450506
/// Renames a dataset by ID.
507+
///
508+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
451509
Future<void> renameDataset(String id, String name) async {
452510
final request = RenameDatasetRequest()
453511
..id = id
@@ -456,13 +514,17 @@ class DataClient {
456514
}
457515

458516
/// Returns a list of datasets within a given organization.
517+
///
518+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
459519
Future<List<Dataset>> listDatasetsByOrganizationID(String orgId) async {
460520
final request = ListDatasetsByOrganizationIDRequest()..organizationId = orgId;
461521
final response = await _datasetClient.listDatasetsByOrganizationID(request);
462522
return response.datasets;
463523
}
464524

465525
/// Looks up and returns a list of datasets by their IDs.
526+
///
527+
/// For more information, see [Data Client API](https://docs.viam.com/appendix/apis/data-client/).
466528
Future<List<Dataset>> listDatasetsByIDs(List<String> ids) async {
467529
final request = ListDatasetsByIDsRequest()..ids.addAll(ids);
468530
final response = await _datasetClient.listDatasetsByIDs(request);

‎lib/src/app/ml_training.dart

+14
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ import 'package:viam_sdk/protos/app/ml_training.dart';
33
/// gRPC client used for working with ML training jobs.
44
///
55
/// All calls must be authenticated.
6+
///
7+
/// For more information, see [ML Training Client API](https://docs.viam.com/appendix/apis/ml-training-client/).
68
class MLTrainingClient {
79
final MLTrainingServiceClient _mlTrainingClient;
810

@@ -11,6 +13,8 @@ class MLTrainingClient {
1113
/// Submits a training job request.
1214
///
1315
/// Returns the new job's ID.
16+
///
17+
/// For more information, see [ML Training Client API](https://docs.viam.com/appendix/apis/ml-training-client/).
1418
Future<String> submitTrainingJob(
1519
String orgId, String datasetId, String modelName, String modelVersion, ModelType modelType, List<String> tags) async {
1620
final request = SubmitTrainingJobRequest()
@@ -27,6 +31,8 @@ class MLTrainingClient {
2731
/// Submits a custom training job request.
2832
///
2933
/// Returns the new job's ID.
34+
///
35+
/// For more information, see [ML Training Client API](https://docs.viam.com/appendix/apis/ml-training-client/).
3036
Future<String> submitCustomTrainingJob(
3137
String orgId, String datasetId, String modelName, String modelVersion, String registryItemId) async {
3238
final request = SubmitCustomTrainingJobRequest()
@@ -40,6 +46,8 @@ class MLTrainingClient {
4046
}
4147

4248
/// Retrieves a training job by its ID.
49+
///
50+
/// For more information, see [ML Training Client API](https://docs.viam.com/appendix/apis/ml-training-client/).
4351
Future<TrainingJobMetadata> getTrainingJob(String id) async {
4452
final request = GetTrainingJobRequest()..id = id;
4553
final response = await _mlTrainingClient.getTrainingJob(request);
@@ -48,6 +56,8 @@ class MLTrainingClient {
4856

4957
/// Lists training jobs for a given orgarnization ID and training status.
5058
/// if [status] is not provided, all training jobs will be returned.
59+
///
60+
/// For more information, see [ML Training Client API](https://docs.viam.com/appendix/apis/ml-training-client/).
5161
Future<List<TrainingJobMetadata>> listTrainingJobs(String orgId,
5262
{TrainingStatus status = TrainingStatus.TRAINING_STATUS_UNSPECIFIED}) async {
5363
final request = ListTrainingJobsRequest()
@@ -58,12 +68,16 @@ class MLTrainingClient {
5868
}
5969

6070
/// Cancels a training job that has not yet completed.
71+
///
72+
/// For more information, see [ML Training Client API](https://docs.viam.com/appendix/apis/ml-training-client/).
6173
Future<void> cancelTrainingJob(String id) async {
6274
final request = CancelTrainingJobRequest()..id = id;
6375
await _mlTrainingClient.cancelTrainingJob(request);
6476
}
6577

6678
/// Removes a completed training job from the database, whether it has succeeded or failed.
79+
///
80+
/// For more information, see [ML Training Client API](https://docs.viam.com/appendix/apis/ml-training-client/).
6781
Future<void> deleteCompletedTrainingJob(String id) async {
6882
final request = DeleteCompletedTrainingJobRequest()..id = id;
6983
await _mlTrainingClient.deleteCompletedTrainingJob(request);

0 commit comments

Comments
 (0)