Batch Inference Service API, gRPC: BatchInferenceService.Describe
Describes a concrete task
gRPC request
rpc Describe (DescribeBatchInferenceRequest) returns (DescribeBatchInferenceResponse)
DescribeBatchInferenceRequest
{
"task_id": "string"
}
Field |
Description |
task_id |
string Required field. Required task id |
DescribeBatchInferenceResponse
{
"task": {
"task_id": "string",
"operation_id": "string",
"folder_id": "string",
"model_uri": "string",
"source_dataset_id": "string",
// Includes only one of the fields `completion_request`
"completion_request": {
"model_uri": "string",
"source_dataset_id": "string",
"completion_options": {
"temperature": "google.protobuf.DoubleValue",
"max_tokens": "google.protobuf.Int64Value",
"reasoning_options": {
"mode": "ReasoningMode"
}
},
"data_logging_enabled": "bool",
// Includes only one of the fields `json_object`, `json_schema`
"json_object": "bool",
"json_schema": {
"schema": "google.protobuf.Struct"
}
// end of the list of possible fields
},
// end of the list of possible fields
"status": "Status",
"result_dataset_id": "string",
"labels": "map<string, string>",
"created_by": "string",
"created_at": "google.protobuf.Timestamp",
"started_at": "google.protobuf.Timestamp",
"finished_at": "google.protobuf.Timestamp",
"errors": {
"status": "google.rpc.Status",
"line_errors": [
{
"line_number": "int64",
"message": "string"
}
],
"batch_errors": [
{
"batch_number": "int64",
"first_line": "int64",
"last_line": "int64",
"message": "string"
}
]
}
}
}
Field |
Description |
task |
BatchInferenceTask
Field |
Description |
task_id |
string |
operation_id |
string |
folder_id |
string |
model_uri |
string |
source_dataset_id |
string |
completion_request |
Includes only one of the fields |
status |
enum Status
|
result_dataset_id |
string |
labels |
object (map<string, string>) |
created_by |
string |
created_at |
|
started_at |
|
finished_at |
|
errors |
BatchCompletionRequest
Field |
Description |
model_uri |
string Required field. |
source_dataset_id |
string Required field. |
completion_options |
|
data_logging_enabled |
bool |
json_object |
bool Includes only one of the fields Unsupported |
json_schema |
Includes only one of the fields Unsupported |
CompletionOptions
Field |
Description |
temperature |
|
max_tokens |
|
reasoning_options |
ReasoningOptions
Field |
Description |
mode |
enum ReasoningMode
|
JsonSchema
Field |
Description |
schema |
ErrorsInfo
Field |
Description |
status |
The error result of the operation in case of failure or cancellation. |
line_errors[] |
Errors by lines |
batch_errors[] |
Errors by batches |
LineError
Field |
Description |
line_number |
int64 |
message |
string |
BatchError
Field |
Description |
batch_number |
int64 |
first_line |
int64 Range of lines in batch |
last_line |
int64 |
message |
string |