Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Foundation Models
    • Overview
    • API authentication
        • Overview
          • Overview
          • Describe
          • List
          • Cancel
          • Delete
  • Yandex Cloud ML SDK
  • Compatibility with OpenAI
  • Access management
  • Pricing policy
  • Public materials
  • Release notes

In this article:

  • gRPC request
  • DescribeBatchInferenceRequest
  • DescribeBatchInferenceResponse
  • BatchInferenceTask
  • BatchCompletionRequest
  • CompletionOptions
  • ReasoningOptions
  • JsonSchema
  1. API references
  2. Batch Inference API
  3. gRPC
  4. BatchInference
  5. Describe

Batch Inference Service API, gRPC: BatchInferenceService.Describe

Written by
Yandex Cloud
Updated at April 24, 2025
  • gRPC request
  • DescribeBatchInferenceRequest
  • DescribeBatchInferenceResponse
  • BatchInferenceTask
  • BatchCompletionRequest
  • CompletionOptions
  • ReasoningOptions
  • JsonSchema

Describes a concrete task

gRPC requestgRPC request

rpc Describe (DescribeBatchInferenceRequest) returns (DescribeBatchInferenceResponse)

DescribeBatchInferenceRequestDescribeBatchInferenceRequest

{
  "task_id": "string"
}

Field

Description

task_id

string

Required field. Required task id

DescribeBatchInferenceResponseDescribeBatchInferenceResponse

{
  "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"
  }
}

Field

Description

task

BatchInferenceTask

BatchInferenceTaskBatchInferenceTask

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

BatchCompletionRequestBatchCompletionRequest

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

CompletionOptionsCompletionOptions

Field

Description

temperature

google.protobuf.DoubleValue

max_tokens

google.protobuf.Int64Value

reasoning_options

ReasoningOptions

ReasoningOptionsReasoningOptions

Field

Description

mode

enum ReasoningMode

  • REASONING_MODE_UNSPECIFIED
  • DISABLED
  • ENABLED_HIDDEN

JsonSchemaJsonSchema

Field

Description

schema

google.protobuf.Struct

Was the article helpful?

Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.