Batch Inference Service API, gRPC: BatchInferenceService.List

Lists tasks in folder

gRPC request

rpc List (ListBatchInferencesRequest) returns (ListBatchInferencesResponse)

ListBatchInferencesRequest

{
          "folder_id": "string",
          "page_size": "int64",
          "page_token": "string",
          "status": "Status"
        }
        

Field

Description

folder_id

string

Required field. Folder ID for which the list of tasks will be provided.

page_size

int64

page_token

string

status

enum Status

Batch inference status for filtering

  • STATUS_UNSPECIFIED
  • CREATED
  • PENDING
  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • CANCELED

ListBatchInferencesResponse

{
          "tasks": [
            {
              "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"
                  }
                ]
              }
            }
          ],
          "next_page_token": "string"
        }
        

Field

Description

tasks[]

BatchInferenceTask

next_page_token

string

BatchInferenceTask

Field

Description

task_id

string

operation_id

string

folder_id

string

model_uri

string

source_dataset_id

string

completion_request

BatchCompletionRequest

Includes only one of the fields completion_request.

status

enum Status

  • STATUS_UNSPECIFIED
  • CREATED
  • PENDING
  • IN_PROGRESS
  • COMPLETED
  • FAILED
  • CANCELED

result_dataset_id

string

labels

object (map<string, string>)

created_by

string

created_at

google.protobuf.Timestamp

started_at

google.protobuf.Timestamp

finished_at

google.protobuf.Timestamp

errors

ErrorsInfo

BatchCompletionRequest

Field

Description

model_uri

string

Required field.

source_dataset_id

string

Required field.

completion_options

CompletionOptions

data_logging_enabled

bool

json_object

bool

Includes only one of the fields json_object, json_schema.

Unsupported

json_schema

JsonSchema

Includes only one of the fields json_object, json_schema.

Unsupported

CompletionOptions

Field

Description

temperature

google.protobuf.DoubleValue

max_tokens

google.protobuf.Int64Value

reasoning_options

ReasoningOptions

ReasoningOptions

Field

Description

mode

enum ReasoningMode

  • REASONING_MODE_UNSPECIFIED
  • DISABLED
  • ENABLED_HIDDEN

JsonSchema

Field

Description

schema

google.protobuf.Struct

ErrorsInfo

Field

Description

status

google.rpc.Status

The error result of the operation in case of failure or cancellation.

line_errors[]

LineError

Errors by lines

batch_errors[]

BatchError

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

Previous
Next