Foundation Models Dataset Service API, gRPC: DatasetService.Describe
Returns dataset information by dataset id.
gRPC request
rpc Describe (DescribeDatasetRequest) returns (DescribeDatasetResponse)
DescribeDatasetRequest
{
"dataset_id": "string"
}
|
Field |
Description |
|
dataset_id |
string Required field. ID of the dataset to describe. |
DescribeDatasetResponse
{
"dataset": {
"dataset_id": "string",
"folder_id": "string",
"name": "string",
"description": "string",
"metadata": "string",
"status": "Status",
"task_type": "string",
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp",
"rows": "int64",
"size_bytes": "int64",
"created_by_id": "string",
"labels": "map<string, string>",
"created_by": "string",
"updated_by": "string",
"validation_error": [
{
"error": "string",
"error_description": "string",
"row_numbers": [
"int64"
]
}
],
"allow_data_log": "bool"
}
}
|
Field |
Description |
|
dataset |
Information about the dataset. |
DatasetInfo
Information about the dataset.
|
Field |
Description |
|
dataset_id |
string ID of the dataset. |
|
folder_id |
string Folder ID of the dataset. |
|
name |
string Name of the dataset. |
|
description |
string Description of the dataset. |
|
metadata |
string Metadata of the dataset. |
|
status |
enum Status Status of the dataset.
|
|
task_type |
string Task type of the dataset. |
|
created_at |
Create dataset timestamp. |
|
updated_at |
Update dataset timestamp. |
|
rows |
int64 Number of rows in the dataset. |
|
size_bytes |
int64 Size of the dataset. |
|
created_by_id |
string Deprecated. Use created_by instead |
|
labels |
object (map<string, string>) Labels of the dataset |
|
created_by |
string User ID of the dataset's creator. |
|
updated_by |
string User ID of the dataset's last updater. |
|
validation_error[] |
|
|
allow_data_log |
bool Allow to use the dataset to improve the models quality. Default false. |
ValidationError
Information about dataset validation error.
|
Field |
Description |
|
error |
string Name of the validation error. |
|
error_description |
string Description of the validation error. |
|
row_numbers[] |
int64 Row numbers in which the error occurred. |