Class: Anthropic::Models::Beta::Messages::BatchCreateParams::Request

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/messages/batch_create_params.rb

Defined Under Namespace

Classes: Params

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(custom_id:, params:) ⇒ void

Some parameter documentations has been truncated, see Anthropic::Models::Beta::Messages::BatchCreateParams::Request for more details.

Parameters:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/anthropic/models/beta/messages/batch_create_params.rb', line 36

class Request < Anthropic::Internal::Type::BaseModel
  # @!attribute custom_id
  #   Developer-provided ID created for each request in a Message Batch. Useful for
  #   matching results to requests, as results may be given out of request order.
  #
  #   Must be unique for each request within the Message Batch.
  #
  #   @return [String]
  required :custom_id, String

  # @!attribute params
  #   Messages API creation parameters for the individual request.
  #
  #   See the [Messages API reference](https://docs.claude.com/en/api/messages) for
  #   full documentation on available parameters.
  #
  #   @return [Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params]
  required :params, -> { Anthropic::Beta::Messages::BatchCreateParams::Request::Params }

  # @!method initialize(custom_id:, params:)
  #   Some parameter documentations has been truncated, see
  #   {Anthropic::Models::Beta::Messages::BatchCreateParams::Request} for more
  #   details.
  #
  #   @param custom_id [String] Developer-provided ID created for each request in a Message Batch. Useful for ma
  #
  #   @param params [Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params] Messages API creation parameters for the individual request.

  # @see Anthropic::Models::Beta::Messages::BatchCreateParams::Request#params
  class Params < Anthropic::Internal::Type::BaseModel
    # @!attribute max_tokens
    #   The maximum number of tokens to generate before stopping.
    #
    #   Note that our models may stop _before_ reaching this maximum. This parameter
    #   only specifies the absolute maximum number of tokens to generate.
    #
    #   Different models have different maximum values for this parameter. See
    #   [models](https://docs.claude.com/en/docs/models-overview) for details.
    #
    #   @return [Integer]
    required :max_tokens, Integer

    # @!attribute messages
    #   Input messages.
    #
    #   Our models are trained to operate on alternating `user` and `assistant`
    #   conversational turns. When creating a new `Message`, you specify the prior
    #   conversational turns with the `messages` parameter, and the model then generates
    #   the next `Message` in the conversation. Consecutive `user` or `assistant` turns
    #   in your request will be combined into a single turn.
    #
    #   Each input message must be an object with a `role` and `content`. You can
    #   specify a single `user`-role message, or you can include multiple `user` and
    #   `assistant` messages.
    #
    #   If the final message uses the `assistant` role, the response content will
    #   continue immediately from the content in that message. This can be used to
    #   constrain part of the model's response.
    #
    #   Example with a single `user` message:
    #
    #   ```json
    #   [{ "role": "user", "content": "Hello, Claude" }]
    #   ```
    #
    #   Example with multiple conversational turns:
    #
    #   ```json
    #   [
    #     { "role": "user", "content": "Hello there." },
    #     { "role": "assistant", "content": "Hi, I'm Claude. How can I help you?" },
    #     { "role": "user", "content": "Can you explain LLMs in plain English?" }
    #   ]
    #   ```
    #
    #   Example with a partially-filled response from Claude:
    #
    #   ```json
    #   [
    #     {
    #       "role": "user",
    #       "content": "What's the Greek name for Sun? (A) Sol (B) Helios (C) Sun"
    #     },
    #     { "role": "assistant", "content": "The best answer is (" }
    #   ]
    #   ```
    #
    #   Each input message `content` may be either a single `string` or an array of
    #   content blocks, where each block has a specific `type`. Using a `string` for
    #   `content` is shorthand for an array of one content block of type `"text"`. The
    #   following input messages are equivalent:
    #
    #   ```json
    #   { "role": "user", "content": "Hello, Claude" }
    #   ```
    #
    #   ```json
    #   { "role": "user", "content": [{ "type": "text", "text": "Hello, Claude" }] }
    #   ```
    #
    #   See [input examples](https://docs.claude.com/en/api/messages-examples).
    #
    #   Note that if you want to include a
    #   [system prompt](https://docs.claude.com/en/docs/system-prompts), you can use the
    #   top-level `system` parameter — there is no `"system"` role for input messages in
    #   the Messages API.
    #
    #   There is a limit of 100,000 messages in a single request.
    #
    #   @return [Array<Anthropic::Models::Beta::BetaMessageParam>]
    required :messages, -> { Anthropic::Internal::Type::ArrayOf[Anthropic::Beta::BetaMessageParam] }

    # @!attribute model
    #   The model that will complete your prompt.\n\nSee
    #   [models](https://docs.anthropic.com/en/docs/models-overview) for additional
    #   details and options.
    #
    #   @return [Symbol, String, Anthropic::Models::Model]
    required :model, union: -> { Anthropic::Model }

    # @!attribute container
    #   Container identifier for reuse across requests.
    #
    #   @return [Anthropic::Models::Beta::BetaContainerParams, String, nil]
    optional :container,
             union: -> { Anthropic::Beta::Messages::BatchCreateParams::Request::Params::Container },
             nil?: true

    # @!attribute context_management
    #   Context management configuration.
    #
    #   This allows you to control how Claude manages context across multiple requests,
    #   such as whether to clear function results or not.
    #
    #   @return [Anthropic::Models::Beta::BetaContextManagementConfig, nil]
    optional :context_management, -> { Anthropic::Beta::BetaContextManagementConfig }, nil?: true

    # @!attribute mcp_servers
    #   MCP servers to be utilized in this request
    #
    #   @return [Array<Anthropic::Models::Beta::BetaRequestMCPServerURLDefinition>, nil]
    optional :mcp_servers,
             -> { Anthropic::Internal::Type::ArrayOf[Anthropic::Beta::BetaRequestMCPServerURLDefinition] }

    # @!attribute metadata
    #   An object describing metadata about the request.
    #
    #   @return [Anthropic::Models::Beta::BetaMetadata, nil]
    optional :metadata, -> { Anthropic::Beta::BetaMetadata }

    # @!attribute output_config
    #   Configuration options for the model's output. Controls aspects like how much
    #   effort the model puts into its response.
    #
    #   @return [Anthropic::Models::Beta::BetaOutputConfig, nil]
    optional :output_config, -> { Anthropic::Beta::BetaOutputConfig }

    # @!attribute output_format
    #   A schema to specify Claude's output format in responses.
    #
    #   @return [Anthropic::Models::Beta::BetaJSONOutputFormat, nil]
    optional :output_format, -> { Anthropic::Beta::BetaJSONOutputFormat }, nil?: true

    # @!attribute service_tier
    #   Determines whether to use priority capacity (if available) or standard capacity
    #   for this request.
    #
    #   Anthropic offers different levels of service for your API requests. See
    #   [service-tiers](https://docs.claude.com/en/api/service-tiers) for details.
    #
    #   @return [Symbol, Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params::ServiceTier, nil]
    optional :service_tier,
             enum: -> { Anthropic::Beta::Messages::BatchCreateParams::Request::Params::ServiceTier }

    # @!attribute stop_sequences
    #   Custom text sequences that will cause the model to stop generating.
    #
    #   Our models will normally stop when they have naturally completed their turn,
    #   which will result in a response `stop_reason` of `"end_turn"`.
    #
    #   If you want the model to stop generating when it encounters custom strings of
    #   text, you can use the `stop_sequences` parameter. If the model encounters one of
    #   the custom sequences, the response `stop_reason` value will be `"stop_sequence"`
    #   and the response `stop_sequence` value will contain the matched stop sequence.
    #
    #   @return [Array<String>, nil]
    optional :stop_sequences, Anthropic::Internal::Type::ArrayOf[String]

    # @!attribute stream
    #   Whether to incrementally stream the response using server-sent events.
    #
    #   See [streaming](https://docs.claude.com/en/api/messages-streaming) for details.
    #
    #   @return [Boolean, nil]
    optional :stream, Anthropic::Internal::Type::Boolean

    # @!attribute system_
    #   System prompt.
    #
    #   A system prompt is a way of providing context and instructions to Claude, such
    #   as specifying a particular goal or role. See our
    #   [guide to system prompts](https://docs.claude.com/en/docs/system-prompts).
    #
    #   @return [String, Array<Anthropic::Models::Beta::BetaTextBlockParam>, nil]
    optional :system_,
             union: -> { Anthropic::Beta::Messages::BatchCreateParams::Request::Params::System },
             api_name: :system

    # @!attribute temperature
    #   Amount of randomness injected into the response.
    #
    #   Defaults to `1.0`. Ranges from `0.0` to `1.0`. Use `temperature` closer to `0.0`
    #   for analytical / multiple choice, and closer to `1.0` for creative and
    #   generative tasks.
    #
    #   Note that even with `temperature` of `0.0`, the results will not be fully
    #   deterministic.
    #
    #   @return [Float, nil]
    optional :temperature, Float

    # @!attribute thinking
    #   Configuration for enabling Claude's extended thinking.
    #
    #   When enabled, responses include `thinking` content blocks showing Claude's
    #   thinking process before the final answer. Requires a minimum budget of 1,024
    #   tokens and counts towards your `max_tokens` limit.
    #
    #   See
    #   [extended thinking](https://docs.claude.com/en/docs/build-with-claude/extended-thinking)
    #   for details.
    #
    #   @return [Anthropic::Models::Beta::BetaThinkingConfigEnabled, Anthropic::Models::Beta::BetaThinkingConfigDisabled, nil]
    optional :thinking, union: -> { Anthropic::Beta::BetaThinkingConfigParam }

    # @!attribute tool_choice
    #   How the model should use the provided tools. The model can use a specific tool,
    #   any available tool, decide by itself, or not use tools at all.
    #
    #   @return [Anthropic::Models::Beta::BetaToolChoiceAuto, Anthropic::Models::Beta::BetaToolChoiceAny, Anthropic::Models::Beta::BetaToolChoiceTool, Anthropic::Models::Beta::BetaToolChoiceNone, nil]
    optional :tool_choice, union: -> { Anthropic::Beta::BetaToolChoice }

    # @!attribute tools
    #   Definitions of tools that the model may use.
    #
    #   If you include `tools` in your API request, the model may return `tool_use`
    #   content blocks that represent the model's use of those tools. You can then run
    #   those tools using the tool input generated by the model and then optionally
    #   return results back to the model using `tool_result` content blocks.
    #
    #   There are two types of tools: **client tools** and **server tools**. The
    #   behavior described below applies to client tools. For
    #   [server tools](https://docs.claude.com/en/docs/agents-and-tools/tool-use/overview#server-tools),
    #   see their individual documentation as each has its own behavior (e.g., the
    #   [web search tool](https://docs.claude.com/en/docs/agents-and-tools/tool-use/web-search-tool)).
    #
    #   Each tool definition includes:
    #
    #   - `name`: Name of the tool.
    #   - `description`: Optional, but strongly-recommended description of the tool.
    #   - `input_schema`: [JSON schema](https://json-schema.org/draft/2020-12) for the
    #     tool `input` shape that the model will produce in `tool_use` output content
    #     blocks.
    #
    #   For example, if you defined `tools` as:
    #
    #   ```json
    #   [
    #     {
    #       "name": "get_stock_price",
    #       "description": "Get the current stock price for a given ticker symbol.",
    #       "input_schema": {
    #         "type": "object",
    #         "properties": {
    #           "ticker": {
    #             "type": "string",
    #             "description": "The stock ticker symbol, e.g. AAPL for Apple Inc."
    #           }
    #         },
    #         "required": ["ticker"]
    #       }
    #     }
    #   ]
    #   ```
    #
    #   And then asked the model "What's the S&P 500 at today?", the model might produce
    #   `tool_use` content blocks in the response like this:
    #
    #   ```json
    #   [
    #     {
    #       "type": "tool_use",
    #       "id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
    #       "name": "get_stock_price",
    #       "input": { "ticker": "^GSPC" }
    #     }
    #   ]
    #   ```
    #
    #   You might then run your `get_stock_price` tool with `{"ticker": "^GSPC"}` as an
    #   input, and return the following back to the model in a subsequent `user`
    #   message:
    #
    #   ```json
    #   [
    #     {
    #       "type": "tool_result",
    #       "tool_use_id": "toolu_01D7FLrfh4GYq7yT1ULFeyMV",
    #       "content": "259.75 USD"
    #     }
    #   ]
    #   ```
    #
    #   Tools can be used for workflows that include running client-side tools and
    #   functions, or more generally whenever you want the model to produce a particular
    #   JSON structure of output.
    #
    #   See our [guide](https://docs.claude.com/en/docs/tool-use) for more details.
    #
    #   @return [Array<Anthropic::Models::Beta::BetaTool, Anthropic::Models::Beta::BetaToolBash20241022, Anthropic::Models::Beta::BetaToolBash20250124, Anthropic::Models::Beta::BetaCodeExecutionTool20250522, Anthropic::Models::Beta::BetaCodeExecutionTool20250825, Anthropic::Models::Beta::BetaToolComputerUse20241022, Anthropic::Models::Beta::BetaMemoryTool20250818, Anthropic::Models::Beta::BetaToolComputerUse20250124, Anthropic::Models::Beta::BetaToolTextEditor20241022, Anthropic::Models::Beta::BetaToolComputerUse20251124, Anthropic::Models::Beta::BetaToolTextEditor20250124, Anthropic::Models::Beta::BetaToolTextEditor20250429, Anthropic::Models::Beta::BetaToolTextEditor20250728, Anthropic::Models::Beta::BetaWebSearchTool20250305, Anthropic::Models::Beta::BetaWebFetchTool20250910, Anthropic::Models::Beta::BetaToolSearchToolBm25_20251119, Anthropic::Models::Beta::BetaToolSearchToolRegex20251119, Anthropic::Models::Beta::BetaMCPToolset>, nil]
    optional :tools, -> { Anthropic::Internal::Type::ArrayOf[union: Anthropic::Beta::BetaToolUnion] }

    # @!attribute top_k
    #   Only sample from the top K options for each subsequent token.
    #
    #   Used to remove "long tail" low probability responses.
    #   [Learn more technical details here](https://towardsdatascience.com/how-to-sample-from-language-models-682bceb97277).
    #
    #   Recommended for advanced use cases only. You usually only need to use
    #   `temperature`.
    #
    #   @return [Integer, nil]
    optional :top_k, Integer

    # @!attribute top_p
    #   Use nucleus sampling.
    #
    #   In nucleus sampling, we compute the cumulative distribution over all the options
    #   for each subsequent token in decreasing probability order and cut it off once it
    #   reaches a particular probability specified by `top_p`. You should either alter
    #   `temperature` or `top_p`, but not both.
    #
    #   Recommended for advanced use cases only. You usually only need to use
    #   `temperature`.
    #
    #   @return [Float, nil]
    optional :top_p, Float

    # @!method initialize(max_tokens:, messages:, model:, container: nil, context_management: nil, mcp_servers: nil, metadata: nil, output_config: nil, output_format: nil, service_tier: nil, stop_sequences: nil, stream: nil, system_: nil, temperature: nil, thinking: nil, tool_choice: nil, tools: nil, top_k: nil, top_p: nil)
    #   Some parameter documentations has been truncated, see
    #   {Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params} for more
    #   details.
    #
    #   Messages API creation parameters for the individual request.
    #
    #   See the [Messages API reference](https://docs.claude.com/en/api/messages) for
    #   full documentation on available parameters.
    #
    #   @param max_tokens [Integer] The maximum number of tokens to generate before stopping.
    #
    #   @param messages [Array<Anthropic::Models::Beta::BetaMessageParam>] Input messages.
    #
    #   @param model [Symbol, String, Anthropic::Models::Model] The model that will complete your prompt.\n\nSee [models](https://docs.anthropic
    #
    #   @param container [Anthropic::Models::Beta::BetaContainerParams, String, nil] Container identifier for reuse across requests.
    #
    #   @param context_management [Anthropic::Models::Beta::BetaContextManagementConfig, nil] Context management configuration.
    #
    #   @param mcp_servers [Array<Anthropic::Models::Beta::BetaRequestMCPServerURLDefinition>] MCP servers to be utilized in this request
    #
    #   @param metadata [Anthropic::Models::Beta::BetaMetadata] An object describing metadata about the request.
    #
    #   @param output_config [Anthropic::Models::Beta::BetaOutputConfig] Configuration options for the model's output. Controls aspects like how much eff
    #
    #   @param output_format [Anthropic::Models::Beta::BetaJSONOutputFormat, nil]
    #
    #   @param service_tier [Symbol, Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params::ServiceTier] Determines whether to use priority capacity (if available) or standard capacity
    #
    #   @param stop_sequences [Array<String>] Custom text sequences that will cause the model to stop generating.
    #
    #   @param stream [Boolean] Whether to incrementally stream the response using server-sent events.
    #
    #   @param system_ [String, Array<Anthropic::Models::Beta::BetaTextBlockParam>] System prompt.
    #
    #   @param temperature [Float] Amount of randomness injected into the response.
    #
    #   @param thinking [Anthropic::Models::Beta::BetaThinkingConfigEnabled, Anthropic::Models::Beta::BetaThinkingConfigDisabled] Configuration for enabling Claude's extended thinking.
    #
    #   @param tool_choice [Anthropic::Models::Beta::BetaToolChoiceAuto, Anthropic::Models::Beta::BetaToolChoiceAny, Anthropic::Models::Beta::BetaToolChoiceTool, Anthropic::Models::Beta::BetaToolChoiceNone] How the model should use the provided tools. The model can use a specific tool,
    #
    #   @param tools [Array<Anthropic::Models::Beta::BetaTool, Anthropic::Models::Beta::BetaToolBash20241022, Anthropic::Models::Beta::BetaToolBash20250124, Anthropic::Models::Beta::BetaCodeExecutionTool20250522, Anthropic::Models::Beta::BetaCodeExecutionTool20250825, Anthropic::Models::Beta::BetaToolComputerUse20241022, Anthropic::Models::Beta::BetaMemoryTool20250818, Anthropic::Models::Beta::BetaToolComputerUse20250124, Anthropic::Models::Beta::BetaToolTextEditor20241022, Anthropic::Models::Beta::BetaToolComputerUse20251124, Anthropic::Models::Beta::BetaToolTextEditor20250124, Anthropic::Models::Beta::BetaToolTextEditor20250429, Anthropic::Models::Beta::BetaToolTextEditor20250728, Anthropic::Models::Beta::BetaWebSearchTool20250305, Anthropic::Models::Beta::BetaWebFetchTool20250910, Anthropic::Models::Beta::BetaToolSearchToolBm25_20251119, Anthropic::Models::Beta::BetaToolSearchToolRegex20251119, Anthropic::Models::Beta::BetaMCPToolset>] Definitions of tools that the model may use.
    #
    #   @param top_k [Integer] Only sample from the top K options for each subsequent token.
    #
    #   @param top_p [Float] Use nucleus sampling.

    # Container identifier for reuse across requests.
    #
    # @see Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params#container
    module Container
      extend Anthropic::Internal::Type::Union

      # Container parameters with skills to be loaded.
      variant -> { Anthropic::Beta::BetaContainerParams }

      variant String

      # @!method self.variants
      #   @return [Array(Anthropic::Models::Beta::BetaContainerParams, String)]
    end

    # Determines whether to use priority capacity (if available) or standard capacity
    # for this request.
    #
    # Anthropic offers different levels of service for your API requests. See
    # [service-tiers](https://docs.claude.com/en/api/service-tiers) for details.
    #
    # @see Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params#service_tier
    module ServiceTier
      extend Anthropic::Internal::Type::Enum

      AUTO = :auto
      STANDARD_ONLY = :standard_only

      # @!method self.values
      #   @return [Array<Symbol>]
    end

    # System prompt.
    #
    # A system prompt is a way of providing context and instructions to Claude, such
    # as specifying a particular goal or role. See our
    # [guide to system prompts](https://docs.claude.com/en/docs/system-prompts).
    #
    # @see Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params#system_
    module System
      extend Anthropic::Internal::Type::Union

      variant String

      variant -> { Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params::System::BetaTextBlockParamArray }

      # @!method self.variants
      #   @return [Array(String, Array<Anthropic::Models::Beta::BetaTextBlockParam>)]

      # @type [Anthropic::Internal::Type::Converter]
      BetaTextBlockParamArray = Anthropic::Internal::Type::ArrayOf[-> {
        Anthropic::Beta::BetaTextBlockParam
      }]
    end
  end
end

Instance Attribute Details

#custom_id ⇒ String

Developer-provided ID created for each request in a Message Batch. Useful for matching results to requests, as results may be given out of request order.

Must be unique for each request within the Message Batch.

Returns:

  • (String) 


44
 
# File 'lib/anthropic/models/beta/messages/batch_create_params.rb', line 44

required :custom_id, String

#params ⇒ Anthropic::Models::Beta::Messages::BatchCreateParams::Request::Params

Messages API creation parameters for the individual request.

See the Messages API reference for full documentation on available parameters.

Returns:



53
 
# File 'lib/anthropic/models/beta/messages/batch_create_params.rb', line 53

required :params, -> { Anthropic::Beta::Messages::BatchCreateParams::Request::Params }