Sign in

v4

latestOpenAPI 3.1.0MIT2026-08-04193459793.6 KB
RL

Sample

Submits a sample operation that will asynchronously generate text completions with logprobs.

post/rl/training-sessions/{session_id}/operations/sample

Path parameters

session_idstring required

Training session ID

Request body

num_samplesinteger

Number of completions to generate per prompt

prompt_logprobsboolean

When true, also compute teacher-forced log-probabilities for the model input tokens and return them in SampleResult.prompt_logprobs.

topk_prompt_logprobsinteger

Number of most likely alternative tokens to return per model input token in SampleResult.topk_prompt_logprobs. 0 disables top-k prompt log-probabilities. Maximum 20.

Example request

{
  "model_inputs": [
    {
      "chunks": [
        {
          "encoded_text": {
            "tokens": [
              123,
              456,
              789
            ]
          }
        }
      ]
    }
  ],
  "sampling_params": {
    "max_tokens": 512,
    "temperature": 1,
    "top_p": 1,
    "top_k": -1,
    "stop": [
      "\n",
      "END"
    ]
  },
  "num_samples": 1
}

Response

idstring required

Operation ID

status'TRAINING_OPERATION_STATUS_UNSPECIFIED' | 'TRAINING_OPERATION_STATUS_PENDING' | 'TRAINING_OPERATION_STATUS_RUNNING' | 'TRAINING_OPERATION_STATUS_COMPLETED' | 'TRAINING_OPERATION_STATUS_FAILED' required

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "output": {
    "results": [
      {
        "sequences": [
          {
            "tokens": [
              "123",
              "456",
              "789"
            ],
            "logprobs": [
              -0.5,
              -1.2,
              -0.3
            ],
            "prompt_cache_hit_tokens": 1024
          }
        ],
        "prompt_logprobs": [
          0,
          -0.5,
          -1.2
        ],
        "topk_prompt_logprobs": [
          {
            "token_ids": [
              123,
              456
            ],
            "logprobs": [
              -0.5,
              -2.1
            ]
          }
        ],
        "policy_segments": [
          {
            "version": 5
          }
        ]
      }
    ]
  },
  "error": {
    "message": "Operation timed out"
  }
}