Foundation Models Dataset Service API, gRPC: DatasetService.Validate

Статья создана

Yandex Cloud

Обновлена 9 декабря 2024 г.

gRPC request
ValidateDatasetRequest
yandex.cloud.operation.Operation
ValidateDatasetMetadata
ValidateDatasetResponse
ValidationError

Starts dataset validation process.

gRPC request

rpc Validate (ValidateDatasetRequest) returns (yandex.cloud.operation.Operation)

ValidateDatasetRequest

{
  "dataset_id": "string"
}

Field

Description

dataset_id

string

Required field. ID of the dataset to validate.

yandex.cloud.operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "dataset_id": "string",
    "valid_rows": "int64",
    "processed_rows": "int64"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "dataset_id": "string",
    "is_valid": "bool",
    "errors": [
      {
        "error": "string",
        "error_description": "string",
        "row_numbers": [
          "int64"
        ]
      }
    ]
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	ValidateDatasetMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	ValidateDatasetResponse The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

ValidateDatasetMetadata

Field	Description
dataset_id	string ID of the dataset.
valid_rows	int64 Count of valid rows among currently processed rows in the dataset.
processed_rows	int64 Count of currently processed rows in the dataset.

ValidateDatasetResponse

Field	Description
dataset_id	string ID of the dataset.
is_valid	bool Validity marker.
errors[]	ValidationError A list of the dataset validation errors.

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.

Foundation Models Dataset Service API, gRPC: DatasetService.Validate

gRPC requestgRPC request

ValidateDatasetRequestValidateDatasetRequest

yandex.cloud.operation.Operationyandex.cloud.operation.Operation

ValidateDatasetMetadataValidateDatasetMetadata

ValidateDatasetResponseValidateDatasetResponse

ValidationErrorValidationError