@effect/ai-anthropic 4.0.0-beta.66 → 4.0.0-beta.68
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AnthropicClient.d.ts +8 -8
- package/dist/AnthropicClient.js +6 -6
- package/dist/AnthropicConfig.d.ts +43 -8
- package/dist/AnthropicConfig.d.ts.map +1 -1
- package/dist/AnthropicConfig.js +28 -4
- package/dist/AnthropicConfig.js.map +1 -1
- package/dist/AnthropicError.d.ts +93 -3
- package/dist/AnthropicError.d.ts.map +1 -1
- package/dist/AnthropicError.js +1 -1
- package/dist/AnthropicLanguageModel.d.ts +181 -10
- package/dist/AnthropicLanguageModel.d.ts.map +1 -1
- package/dist/AnthropicLanguageModel.js +32 -6
- package/dist/AnthropicLanguageModel.js.map +1 -1
- package/dist/AnthropicTelemetry.d.ts +13 -11
- package/dist/AnthropicTelemetry.d.ts.map +1 -1
- package/dist/AnthropicTelemetry.js +3 -3
- package/dist/AnthropicTelemetry.js.map +1 -1
- package/dist/AnthropicTool.d.ts +224 -118
- package/dist/AnthropicTool.d.ts.map +1 -1
- package/dist/AnthropicTool.js +76 -72
- package/dist/AnthropicTool.js.map +1 -1
- package/dist/Generated.d.ts +1 -1
- package/dist/Generated.js +1 -1
- package/dist/index.d.ts +52 -8
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +52 -8
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
- package/src/AnthropicClient.ts +9 -9
- package/src/AnthropicConfig.ts +43 -8
- package/src/AnthropicError.ts +93 -3
- package/src/AnthropicLanguageModel.ts +210 -13
- package/src/AnthropicTelemetry.ts +14 -12
- package/src/AnthropicTool.ts +224 -118
- package/src/Generated.ts +1 -1
- package/src/index.ts +52 -8
package/dist/AnthropicTool.d.ts
CHANGED
|
@@ -4,15 +4,15 @@
|
|
|
4
4
|
* Provides tools that are natively supported by Anthropic's API, including
|
|
5
5
|
* Bash, Code Execution, Computer Use, Memory, and Text Editor functionality.
|
|
6
6
|
*
|
|
7
|
-
* @since
|
|
7
|
+
* @since 4.0.0
|
|
8
8
|
*/
|
|
9
9
|
import * as Schema from "effect/Schema";
|
|
10
10
|
import * as Tool from "effect/unstable/ai/Tool";
|
|
11
11
|
/**
|
|
12
12
|
* Union of all Anthropic provider-defined tools.
|
|
13
13
|
*
|
|
14
|
-
* @since 1.0.0
|
|
15
14
|
* @category models
|
|
15
|
+
* @since 4.0.0
|
|
16
16
|
*/
|
|
17
17
|
export type AnthropicTool = ReturnType<typeof Bash_20241022> | ReturnType<typeof Bash_20250124> | ReturnType<typeof CodeExecution_20250522> | ReturnType<typeof CodeExecution_20250825> | ReturnType<typeof ComputerUse_20241022> | ReturnType<typeof ComputerUse_20250124> | ReturnType<typeof ComputerUse_20251124> | ReturnType<typeof Memory_20250818> | ReturnType<typeof TextEditor_20241022> | ReturnType<typeof TextEditor_20250124> | ReturnType<typeof TextEditor_20250429> | ReturnType<typeof TextEditor_20250728> | ReturnType<typeof ToolSearchRegex_20251119> | ReturnType<typeof ToolSearchBM25_20251119> | ReturnType<typeof WebFetch_20250910> | ReturnType<typeof WebSearch_20250305>;
|
|
18
18
|
/**
|
|
@@ -21,8 +21,8 @@ export type AnthropicTool = ReturnType<typeof Bash_20241022> | ReturnType<typeof
|
|
|
21
21
|
* Allows the model to execute bash commands in a sandboxed environment.
|
|
22
22
|
* Requires the "computer-use-2024-10-22" beta header.
|
|
23
23
|
*
|
|
24
|
-
* @since 1.0.0
|
|
25
24
|
* @category Bash
|
|
25
|
+
* @since 4.0.0
|
|
26
26
|
*/
|
|
27
27
|
export declare const Bash_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
28
28
|
readonly failureMode?: Mode | undefined;
|
|
@@ -42,8 +42,8 @@ export declare const Bash_20241022: <Mode extends Tool.FailureMode | undefined =
|
|
|
42
42
|
* Allows the model to execute bash commands in a sandboxed environment.
|
|
43
43
|
* Requires the "computer-use-2025-01-24" beta header.
|
|
44
44
|
*
|
|
45
|
-
* @since 1.0.0
|
|
46
45
|
* @category Bash
|
|
46
|
+
* @since 4.0.0
|
|
47
47
|
*/
|
|
48
48
|
export declare const Bash_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
49
49
|
readonly failureMode?: Mode | undefined;
|
|
@@ -58,10 +58,10 @@ export declare const Bash_20250124: <Mode extends Tool.FailureMode | undefined =
|
|
|
58
58
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
59
59
|
}, true>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* Schema for a code execution request that asks Anthropic to run source code as a programmatic tool call.
|
|
62
62
|
*
|
|
63
|
-
* @since 1.0.0
|
|
64
63
|
* @category Code Execution
|
|
64
|
+
* @since 4.0.0
|
|
65
65
|
*/
|
|
66
66
|
export declare const CodeExecutionProgrammaticToolCall: Schema.Struct<{
|
|
67
67
|
readonly type: Schema.Literal<"programmatic-tool-call">;
|
|
@@ -71,15 +71,17 @@ export declare const CodeExecutionProgrammaticToolCall: Schema.Struct<{
|
|
|
71
71
|
readonly code: Schema.String;
|
|
72
72
|
}>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
74
|
+
* Input payload for a programmatic code execution tool call, including the source code to execute.
|
|
75
|
+
*
|
|
75
76
|
* @category Code Execution
|
|
77
|
+
* @since 4.0.0
|
|
76
78
|
*/
|
|
77
79
|
export type CodeExecutionProgrammaticToolCall = typeof CodeExecutionProgrammaticToolCall.Type;
|
|
78
80
|
/**
|
|
79
|
-
*
|
|
81
|
+
* Schema for a code execution request that runs a bash command.
|
|
80
82
|
*
|
|
81
|
-
* @since 1.0.0
|
|
82
83
|
* @category Code Execution
|
|
84
|
+
* @since 4.0.0
|
|
83
85
|
*/
|
|
84
86
|
export declare const CodeExecutionBashCommand: Schema.Struct<{
|
|
85
87
|
readonly type: Schema.Literal<"bash_code_execution">;
|
|
@@ -89,15 +91,17 @@ export declare const CodeExecutionBashCommand: Schema.Struct<{
|
|
|
89
91
|
readonly command: Schema.String;
|
|
90
92
|
}>;
|
|
91
93
|
/**
|
|
92
|
-
*
|
|
94
|
+
* Input payload for a bash command executed through Anthropic code execution.
|
|
95
|
+
*
|
|
93
96
|
* @category Code Execution
|
|
97
|
+
* @since 4.0.0
|
|
94
98
|
*/
|
|
95
99
|
export type CodeExecutionBashCommand = typeof CodeExecutionBashCommand.Type;
|
|
96
100
|
/**
|
|
97
101
|
* Text editor view command for code execution.
|
|
98
102
|
*
|
|
99
|
-
* @since 1.0.0
|
|
100
103
|
* @category Code Execution
|
|
104
|
+
* @since 4.0.0
|
|
101
105
|
*/
|
|
102
106
|
export declare const CodeExecutionTextEditorView: Schema.Struct<{
|
|
103
107
|
readonly type: Schema.Literal<"text_editor_code_execution">;
|
|
@@ -108,15 +112,17 @@ export declare const CodeExecutionTextEditorView: Schema.Struct<{
|
|
|
108
112
|
readonly path: Schema.String;
|
|
109
113
|
}>;
|
|
110
114
|
/**
|
|
111
|
-
*
|
|
115
|
+
* Input payload for viewing a file through the text editor code execution tool.
|
|
116
|
+
*
|
|
112
117
|
* @category Code Execution
|
|
118
|
+
* @since 4.0.0
|
|
113
119
|
*/
|
|
114
120
|
export type CodeExecutionTextEditorView = typeof CodeExecutionTextEditorView.Type;
|
|
115
121
|
/**
|
|
116
122
|
* Text editor create command for code execution.
|
|
117
123
|
*
|
|
118
|
-
* @since 1.0.0
|
|
119
124
|
* @category Code Execution
|
|
125
|
+
* @since 4.0.0
|
|
120
126
|
*/
|
|
121
127
|
export declare const CodeExecutionTextEditorCreate: Schema.Struct<{
|
|
122
128
|
readonly type: Schema.Literal<"text_editor_code_execution">;
|
|
@@ -131,15 +137,17 @@ export declare const CodeExecutionTextEditorCreate: Schema.Struct<{
|
|
|
131
137
|
readonly file_text: Schema.optional<Schema.NullOr<Schema.String>>;
|
|
132
138
|
}>;
|
|
133
139
|
/**
|
|
134
|
-
*
|
|
140
|
+
* Input payload for creating a file through the text editor code execution tool, optionally including initial file text.
|
|
141
|
+
*
|
|
135
142
|
* @category Code Execution
|
|
143
|
+
* @since 4.0.0
|
|
136
144
|
*/
|
|
137
145
|
export type CodeExecutionTextEditorCreate = typeof CodeExecutionTextEditorCreate.Type;
|
|
138
146
|
/**
|
|
139
147
|
* Text editor str_replace command for code execution.
|
|
140
148
|
*
|
|
141
|
-
* @since 1.0.0
|
|
142
149
|
* @category Code Execution
|
|
150
|
+
* @since 4.0.0
|
|
143
151
|
*/
|
|
144
152
|
export declare const CodeExecutionTextEditorStrReplace: Schema.Struct<{
|
|
145
153
|
readonly type: Schema.Literal<"text_editor_code_execution">;
|
|
@@ -158,15 +166,17 @@ export declare const CodeExecutionTextEditorStrReplace: Schema.Struct<{
|
|
|
158
166
|
readonly new_str: Schema.String;
|
|
159
167
|
}>;
|
|
160
168
|
/**
|
|
161
|
-
*
|
|
169
|
+
* Input payload for replacing text in a file through the text editor code execution tool.
|
|
170
|
+
*
|
|
162
171
|
* @category Code Execution
|
|
172
|
+
* @since 4.0.0
|
|
163
173
|
*/
|
|
164
174
|
export type CodeExecutionTextEditorStrReplace = typeof CodeExecutionTextEditorStrReplace.Type;
|
|
165
175
|
/**
|
|
166
|
-
*
|
|
176
|
+
* Schema for the 2025-08-25 code execution tool input, containing the code to execute.
|
|
167
177
|
*
|
|
168
|
-
* @since 1.0.0
|
|
169
178
|
* @category Code Execution
|
|
179
|
+
* @since 4.0.0
|
|
170
180
|
*/
|
|
171
181
|
export declare const CodeExecution_20250825_Parameters: Schema.Struct<{
|
|
172
182
|
/**
|
|
@@ -175,8 +185,10 @@ export declare const CodeExecution_20250825_Parameters: Schema.Struct<{
|
|
|
175
185
|
readonly code: Schema.String;
|
|
176
186
|
}>;
|
|
177
187
|
/**
|
|
178
|
-
*
|
|
188
|
+
* Input payload for the 2025-08-25 Anthropic code execution tool.
|
|
189
|
+
*
|
|
179
190
|
* @category Code Execution
|
|
191
|
+
* @since 4.0.0
|
|
180
192
|
*/
|
|
181
193
|
export type CodeExecution_20250825_Parameters = typeof CodeExecution_20250825_Parameters.Type;
|
|
182
194
|
/**
|
|
@@ -186,8 +198,8 @@ export type CodeExecution_20250825_Parameters = typeof CodeExecution_20250825_Pa
|
|
|
186
198
|
* for multiple execution types including programmatic tool calls, bash
|
|
187
199
|
* execution, and text editor operations.
|
|
188
200
|
*
|
|
189
|
-
* @since 1.0.0
|
|
190
201
|
* @category Code Execution
|
|
202
|
+
* @since 4.0.0
|
|
191
203
|
*/
|
|
192
204
|
export declare const CodeExecution_20250522: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.code_execution_20250522", "AnthropicCodeExecution", {
|
|
193
205
|
readonly args: Schema.Void;
|
|
@@ -258,8 +270,8 @@ export declare const CodeExecution_20250522: <Mode extends Tool.FailureMode | un
|
|
|
258
270
|
*
|
|
259
271
|
* Allows the model to execute code in a sandboxed environment.
|
|
260
272
|
*
|
|
261
|
-
* @since 1.0.0
|
|
262
273
|
* @category Code Execution
|
|
274
|
+
* @since 4.0.0
|
|
263
275
|
*/
|
|
264
276
|
export declare const CodeExecution_20250825: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.code_execution_20250825", "AnthropicCodeExecution", {
|
|
265
277
|
readonly args: Schema.Void;
|
|
@@ -321,56 +333,64 @@ export declare const CodeExecution_20250825: <Mode extends Tool.FailureMode | un
|
|
|
321
333
|
/**
|
|
322
334
|
* An `[x, y]` pixel position.
|
|
323
335
|
*
|
|
324
|
-
* @since 1.0.0
|
|
325
336
|
* @category Computer Use
|
|
337
|
+
* @since 4.0.0
|
|
326
338
|
*/
|
|
327
339
|
export declare const Coordinate: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
|
|
328
340
|
/**
|
|
329
|
-
*
|
|
341
|
+
* An `[x, y]` screen coordinate in pixels.
|
|
342
|
+
*
|
|
330
343
|
* @category Computer Use
|
|
344
|
+
* @since 4.0.0
|
|
331
345
|
*/
|
|
332
346
|
export type Coordinate = typeof Coordinate.Type;
|
|
333
347
|
/**
|
|
334
348
|
* A `[x1, y1, x2, y2]` position defining top-left and bottom-right corners.
|
|
335
349
|
*
|
|
336
|
-
* @since 1.0.0
|
|
337
350
|
* @category Computer Use
|
|
351
|
+
* @since 4.0.0
|
|
338
352
|
*/
|
|
339
353
|
export declare const Region: Schema.Tuple<readonly [Schema.Number, Schema.Number, Schema.Number, Schema.Number]>;
|
|
340
354
|
/**
|
|
341
|
-
*
|
|
355
|
+
* An `[x1, y1, x2, y2]` screen region in pixels, from top-left to bottom-right.
|
|
356
|
+
*
|
|
342
357
|
* @category Computer Use
|
|
358
|
+
* @since 4.0.0
|
|
343
359
|
*/
|
|
344
360
|
export type Region = typeof Region.Type;
|
|
345
361
|
/**
|
|
346
362
|
* The direction of the scroll for scroll actions.
|
|
347
363
|
*
|
|
348
|
-
* @since 1.0.0
|
|
349
364
|
* @category Computer Use
|
|
365
|
+
* @since 4.0.0
|
|
350
366
|
*/
|
|
351
367
|
export declare const ScrollDirection: Schema.Literals<readonly ["up", "down", "left", "right"]>;
|
|
352
368
|
/**
|
|
353
|
-
*
|
|
369
|
+
* Direction used by computer-use scroll actions: `"up"`, `"down"`, `"left"`, or `"right"`.
|
|
370
|
+
*
|
|
354
371
|
* @category Computer Use
|
|
372
|
+
* @since 4.0.0
|
|
355
373
|
*/
|
|
356
374
|
export type ScrollDirection = typeof ScrollDirection.Type;
|
|
357
375
|
/**
|
|
358
376
|
* Modifier keys that can be held during click/scroll actions.
|
|
359
377
|
*
|
|
360
|
-
* @since 1.0.0
|
|
361
378
|
* @category Computer Use
|
|
379
|
+
* @since 4.0.0
|
|
362
380
|
*/
|
|
363
381
|
export declare const ModifierKey: Schema.Literals<readonly ["alt", "ctrl", "meta", "shift"]>;
|
|
364
382
|
/**
|
|
365
|
-
*
|
|
383
|
+
* Modifier key that can be held during computer-use click or scroll actions.
|
|
384
|
+
*
|
|
366
385
|
* @category Computer Use
|
|
386
|
+
* @since 4.0.0
|
|
367
387
|
*/
|
|
368
388
|
export type ModifierKey = typeof ModifierKey.Type;
|
|
369
389
|
/**
|
|
370
390
|
* Press a key or key combination (e.g. `"Return"`, `"ctrl+c"`, `"ctrl+s"`).
|
|
371
391
|
*
|
|
372
|
-
* @since 1.0.0
|
|
373
392
|
* @category Computer Use
|
|
393
|
+
* @since 4.0.0
|
|
374
394
|
*/
|
|
375
395
|
export declare const ComputerUseKeyAction: Schema.Struct<{
|
|
376
396
|
readonly action: Schema.Literal<"key">;
|
|
@@ -380,15 +400,17 @@ export declare const ComputerUseKeyAction: Schema.Struct<{
|
|
|
380
400
|
readonly text: Schema.String;
|
|
381
401
|
}>;
|
|
382
402
|
/**
|
|
383
|
-
*
|
|
403
|
+
* Computer-use action payload for pressing a key or key combination.
|
|
404
|
+
*
|
|
384
405
|
* @category Computer Use
|
|
406
|
+
* @since 4.0.0
|
|
385
407
|
*/
|
|
386
408
|
export type ComputerUseKeyAction = typeof ComputerUseKeyAction.Type;
|
|
387
409
|
/**
|
|
388
410
|
* Perform a left click at the current mouse position or the specified coordinates.
|
|
389
411
|
*
|
|
390
|
-
* @since 1.0.0
|
|
391
412
|
* @category Computer Use
|
|
413
|
+
* @since 4.0.0
|
|
392
414
|
*/
|
|
393
415
|
export declare const ComputerUseLeftClickAction: Schema.Struct<{
|
|
394
416
|
readonly action: Schema.Literal<"left_click">;
|
|
@@ -399,15 +421,17 @@ export declare const ComputerUseLeftClickAction: Schema.Struct<{
|
|
|
399
421
|
readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
400
422
|
}>;
|
|
401
423
|
/**
|
|
402
|
-
*
|
|
424
|
+
* Computer-use action payload for performing a left click, optionally at a specific coordinate.
|
|
425
|
+
*
|
|
403
426
|
* @category Computer Use
|
|
427
|
+
* @since 4.0.0
|
|
404
428
|
*/
|
|
405
429
|
export type ComputerUseLeftClickAction = typeof ComputerUseLeftClickAction.Type;
|
|
406
430
|
/**
|
|
407
431
|
* Move the mouse cursor to the specified coordinates.
|
|
408
432
|
*
|
|
409
|
-
* @since 1.0.0
|
|
410
433
|
* @category Computer Use
|
|
434
|
+
* @since 4.0.0
|
|
411
435
|
*/
|
|
412
436
|
export declare const ComputerUseMouseMoveAction: Schema.Struct<{
|
|
413
437
|
readonly action: Schema.Literal<"mouse_move">;
|
|
@@ -417,29 +441,33 @@ export declare const ComputerUseMouseMoveAction: Schema.Struct<{
|
|
|
417
441
|
readonly coordinate: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
|
|
418
442
|
}>;
|
|
419
443
|
/**
|
|
420
|
-
*
|
|
444
|
+
* Computer-use action payload for moving the mouse cursor to a specific coordinate.
|
|
445
|
+
*
|
|
421
446
|
* @category Computer Use
|
|
447
|
+
* @since 4.0.0
|
|
422
448
|
*/
|
|
423
449
|
export type ComputerUseMouseMoveAction = typeof ComputerUseMouseMoveAction.Type;
|
|
424
450
|
/**
|
|
425
451
|
* Capture the current display.
|
|
426
452
|
*
|
|
427
|
-
* @since 1.0.0
|
|
428
453
|
* @category Computer Use
|
|
454
|
+
* @since 4.0.0
|
|
429
455
|
*/
|
|
430
456
|
export declare const ComputerUseScreenshotAction: Schema.Struct<{
|
|
431
457
|
readonly action: Schema.Literal<"screenshot">;
|
|
432
458
|
}>;
|
|
433
459
|
/**
|
|
434
|
-
*
|
|
460
|
+
* Computer-use action payload for capturing the current display.
|
|
461
|
+
*
|
|
435
462
|
* @category Computer Use
|
|
463
|
+
* @since 4.0.0
|
|
436
464
|
*/
|
|
437
465
|
export type ComputerUseScreenshotAction = typeof ComputerUseScreenshotAction.Type;
|
|
438
466
|
/**
|
|
439
467
|
* Type a text string.
|
|
440
468
|
*
|
|
441
|
-
* @since 1.0.0
|
|
442
469
|
* @category Computer Use
|
|
470
|
+
* @since 4.0.0
|
|
443
471
|
*/
|
|
444
472
|
export declare const TypeAction: Schema.Struct<{
|
|
445
473
|
readonly action: Schema.Literal<"type">;
|
|
@@ -449,15 +477,17 @@ export declare const TypeAction: Schema.Struct<{
|
|
|
449
477
|
readonly text: Schema.String;
|
|
450
478
|
}>;
|
|
451
479
|
/**
|
|
452
|
-
*
|
|
480
|
+
* Computer-use action payload for typing a text string.
|
|
481
|
+
*
|
|
453
482
|
* @category Computer Use
|
|
483
|
+
* @since 4.0.0
|
|
454
484
|
*/
|
|
455
485
|
export type TypeAction = typeof TypeAction.Type;
|
|
456
486
|
/**
|
|
457
487
|
* Perform a double click.
|
|
458
488
|
*
|
|
459
|
-
* @since 1.0.0
|
|
460
489
|
* @category Computer Use
|
|
490
|
+
* @since 4.0.0
|
|
461
491
|
*/
|
|
462
492
|
export declare const ComputerUseDoubleClickAction: Schema.Struct<{
|
|
463
493
|
readonly action: Schema.Literal<"double_click">;
|
|
@@ -468,15 +498,17 @@ export declare const ComputerUseDoubleClickAction: Schema.Struct<{
|
|
|
468
498
|
readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
469
499
|
}>;
|
|
470
500
|
/**
|
|
471
|
-
*
|
|
501
|
+
* Computer-use action payload for performing a double click, optionally at a specific coordinate.
|
|
502
|
+
*
|
|
472
503
|
* @category Computer Use
|
|
504
|
+
* @since 4.0.0
|
|
473
505
|
*/
|
|
474
506
|
export type ComputerUseDoubleClickAction = typeof ComputerUseDoubleClickAction.Type;
|
|
475
507
|
/**
|
|
476
|
-
*
|
|
508
|
+
* Hold a key for a specified duration during computer-use execution.
|
|
477
509
|
*
|
|
478
|
-
* @since 1.0.0
|
|
479
510
|
* @category Computer Use
|
|
511
|
+
* @since 4.0.0
|
|
480
512
|
*/
|
|
481
513
|
export declare const ComputerUseHoldKeyAction: Schema.Struct<{
|
|
482
514
|
readonly action: Schema.Literal<"hold_key">;
|
|
@@ -490,15 +522,17 @@ export declare const ComputerUseHoldKeyAction: Schema.Struct<{
|
|
|
490
522
|
readonly duration: Schema.Number;
|
|
491
523
|
}>;
|
|
492
524
|
/**
|
|
493
|
-
*
|
|
525
|
+
* Computer-use action payload for holding a key for a specified duration.
|
|
526
|
+
*
|
|
494
527
|
* @category Computer Use
|
|
528
|
+
* @since 4.0.0
|
|
495
529
|
*/
|
|
496
530
|
export type ComputerUseHoldKeyAction = typeof ComputerUseHoldKeyAction.Type;
|
|
497
531
|
/**
|
|
498
532
|
* Click and drag from start coordinate to end coordinate.
|
|
499
533
|
*
|
|
500
|
-
* @since 1.0.0
|
|
501
534
|
* @category Computer Use
|
|
535
|
+
* @since 4.0.0
|
|
502
536
|
*/
|
|
503
537
|
export declare const ComputerUseLeftClickDragAction: Schema.Struct<{
|
|
504
538
|
readonly action: Schema.Literal<"left_click_drag">;
|
|
@@ -512,8 +546,10 @@ export declare const ComputerUseLeftClickDragAction: Schema.Struct<{
|
|
|
512
546
|
readonly coordinate: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
|
|
513
547
|
}>;
|
|
514
548
|
/**
|
|
515
|
-
*
|
|
549
|
+
* Computer-use action payload for dragging from a start coordinate to an end coordinate.
|
|
550
|
+
*
|
|
516
551
|
* @category Computer Use
|
|
552
|
+
* @since 4.0.0
|
|
517
553
|
*/
|
|
518
554
|
export type ComputerUseLeftClickDragAction = typeof ComputerUseLeftClickDragAction.Type;
|
|
519
555
|
/**
|
|
@@ -521,8 +557,8 @@ export type ComputerUseLeftClickDragAction = typeof ComputerUseLeftClickDragActi
|
|
|
521
557
|
*
|
|
522
558
|
* Used for fine-grained click control.
|
|
523
559
|
*
|
|
524
|
-
* @since 1.0.0
|
|
525
560
|
* @category Computer Use
|
|
561
|
+
* @since 4.0.0
|
|
526
562
|
*/
|
|
527
563
|
export declare const ComputerUseLeftMouseDownAction: Schema.Struct<{
|
|
528
564
|
readonly action: Schema.Literal<"left_mouse_down">;
|
|
@@ -533,8 +569,10 @@ export declare const ComputerUseLeftMouseDownAction: Schema.Struct<{
|
|
|
533
569
|
readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
534
570
|
}>;
|
|
535
571
|
/**
|
|
536
|
-
*
|
|
572
|
+
* Computer-use action payload for pressing and holding the left mouse button, optionally at a specific coordinate.
|
|
573
|
+
*
|
|
537
574
|
* @category Computer Use
|
|
575
|
+
* @since 4.0.0
|
|
538
576
|
*/
|
|
539
577
|
export type ComputerUseLeftMouseDownAction = typeof ComputerUseLeftMouseDownAction.Type;
|
|
540
578
|
/**
|
|
@@ -542,8 +580,8 @@ export type ComputerUseLeftMouseDownAction = typeof ComputerUseLeftMouseDownActi
|
|
|
542
580
|
*
|
|
543
581
|
* Used for fine-grained click control.
|
|
544
582
|
*
|
|
545
|
-
* @since 1.0.0
|
|
546
583
|
* @category Computer Use
|
|
584
|
+
* @since 4.0.0
|
|
547
585
|
*/
|
|
548
586
|
export declare const ComputerUseLeftMouseUpAction: Schema.Struct<{
|
|
549
587
|
readonly action: Schema.Literal<"left_mouse_up">;
|
|
@@ -554,15 +592,17 @@ export declare const ComputerUseLeftMouseUpAction: Schema.Struct<{
|
|
|
554
592
|
readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
555
593
|
}>;
|
|
556
594
|
/**
|
|
557
|
-
*
|
|
595
|
+
* Computer-use action payload for releasing the left mouse button, optionally at a specific coordinate.
|
|
596
|
+
*
|
|
558
597
|
* @category Computer Use
|
|
598
|
+
* @since 4.0.0
|
|
559
599
|
*/
|
|
560
600
|
export type ComputerUseLeftMouseUpAction = typeof ComputerUseLeftMouseUpAction.Type;
|
|
561
601
|
/**
|
|
562
602
|
* Perform a middle click.
|
|
563
603
|
*
|
|
564
|
-
* @since 1.0.0
|
|
565
604
|
* @category Computer Use
|
|
605
|
+
* @since 4.0.0
|
|
566
606
|
*/
|
|
567
607
|
export declare const ComputerUseMiddleClickAction: Schema.Struct<{
|
|
568
608
|
readonly action: Schema.Literal<"middle_click">;
|
|
@@ -573,15 +613,17 @@ export declare const ComputerUseMiddleClickAction: Schema.Struct<{
|
|
|
573
613
|
readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
574
614
|
}>;
|
|
575
615
|
/**
|
|
576
|
-
*
|
|
616
|
+
* Computer-use action payload for performing a middle click, optionally at a specific coordinate.
|
|
617
|
+
*
|
|
577
618
|
* @category Computer Use
|
|
619
|
+
* @since 4.0.0
|
|
578
620
|
*/
|
|
579
621
|
export type ComputerUseMiddleClickAction = typeof ComputerUseMiddleClickAction.Type;
|
|
580
622
|
/**
|
|
581
623
|
* Perform a right click.
|
|
582
624
|
*
|
|
583
|
-
* @since 1.0.0
|
|
584
625
|
* @category Computer Use
|
|
626
|
+
* @since 4.0.0
|
|
585
627
|
*/
|
|
586
628
|
export declare const ComputerUseRightClickAction: Schema.Struct<{
|
|
587
629
|
readonly action: Schema.Literal<"right_click">;
|
|
@@ -592,15 +634,17 @@ export declare const ComputerUseRightClickAction: Schema.Struct<{
|
|
|
592
634
|
readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
593
635
|
}>;
|
|
594
636
|
/**
|
|
595
|
-
*
|
|
637
|
+
* Computer-use action payload for performing a right click, optionally at a specific coordinate.
|
|
638
|
+
*
|
|
596
639
|
* @category Computer Use
|
|
640
|
+
* @since 4.0.0
|
|
597
641
|
*/
|
|
598
642
|
export type ComputerUseRightClickAction = typeof ComputerUseRightClickAction.Type;
|
|
599
643
|
/**
|
|
600
644
|
* Scroll a given amount in a specified direction.
|
|
601
645
|
*
|
|
602
|
-
* @since 1.0.0
|
|
603
646
|
* @category Computer Use
|
|
647
|
+
* @since 4.0.0
|
|
604
648
|
*/
|
|
605
649
|
export declare const ComputerUseScrollAction: Schema.Struct<{
|
|
606
650
|
readonly action: Schema.Literal<"scroll">;
|
|
@@ -619,15 +663,17 @@ export declare const ComputerUseScrollAction: Schema.Struct<{
|
|
|
619
663
|
readonly scroll_amount: Schema.Number;
|
|
620
664
|
}>;
|
|
621
665
|
/**
|
|
622
|
-
*
|
|
666
|
+
* Computer-use action payload for scrolling by a specified amount in a specified direction, optionally from a coordinate.
|
|
667
|
+
*
|
|
623
668
|
* @category Computer Use
|
|
669
|
+
* @since 4.0.0
|
|
624
670
|
*/
|
|
625
671
|
export type ComputerUseScrollAction = typeof ComputerUseScrollAction.Type;
|
|
626
672
|
/**
|
|
627
673
|
* Perform a triple click.
|
|
628
674
|
*
|
|
629
|
-
* @since 1.0.0
|
|
630
675
|
* @category Computer Use
|
|
676
|
+
* @since 4.0.0
|
|
631
677
|
*/
|
|
632
678
|
export declare const ComputerUseTripleClickAction: Schema.Struct<{
|
|
633
679
|
readonly action: Schema.Literal<"triple_click">;
|
|
@@ -638,15 +684,17 @@ export declare const ComputerUseTripleClickAction: Schema.Struct<{
|
|
|
638
684
|
readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
639
685
|
}>;
|
|
640
686
|
/**
|
|
641
|
-
*
|
|
687
|
+
* Computer-use action payload for performing a triple click, optionally at a specific coordinate.
|
|
688
|
+
*
|
|
642
689
|
* @category Computer Use
|
|
690
|
+
* @since 4.0.0
|
|
643
691
|
*/
|
|
644
692
|
export type ComputerUseTripleClickAction = typeof ComputerUseTripleClickAction.Type;
|
|
645
693
|
/**
|
|
646
694
|
* Pause between performing actions.
|
|
647
695
|
*
|
|
648
|
-
* @since 1.0.0
|
|
649
696
|
* @category Computer Use
|
|
697
|
+
* @since 4.0.0
|
|
650
698
|
*/
|
|
651
699
|
export declare const ComputerUseWaitAction: Schema.Struct<{
|
|
652
700
|
readonly action: Schema.Literal<"wait">;
|
|
@@ -656,8 +704,10 @@ export declare const ComputerUseWaitAction: Schema.Struct<{
|
|
|
656
704
|
readonly duration: Schema.Number;
|
|
657
705
|
}>;
|
|
658
706
|
/**
|
|
659
|
-
*
|
|
707
|
+
* Computer-use action payload for pausing for a specified duration.
|
|
708
|
+
*
|
|
660
709
|
* @category Computer Use
|
|
710
|
+
* @since 4.0.0
|
|
661
711
|
*/
|
|
662
712
|
export type ComputerUseWaitAction = typeof ComputerUseWaitAction.Type;
|
|
663
713
|
/**
|
|
@@ -665,8 +715,8 @@ export type ComputerUseWaitAction = typeof ComputerUseWaitAction.Type;
|
|
|
665
715
|
*
|
|
666
716
|
* Requires `enableZoom: true` in the tool definition.
|
|
667
717
|
*
|
|
668
|
-
* @since 1.0.0
|
|
669
718
|
* @category Computer Use
|
|
719
|
+
* @since 4.0.0
|
|
670
720
|
*/
|
|
671
721
|
export declare const ComputerUseZoomAction: Schema.Struct<{
|
|
672
722
|
readonly action: Schema.Literal<"zoom">;
|
|
@@ -677,8 +727,13 @@ export declare const ComputerUseZoomAction: Schema.Struct<{
|
|
|
677
727
|
readonly region: Schema.Tuple<readonly [Schema.Number, Schema.Number, Schema.Number, Schema.Number]>;
|
|
678
728
|
}>;
|
|
679
729
|
/**
|
|
680
|
-
*
|
|
730
|
+
* Computer-use action payload for zooming into a specific screen region.
|
|
731
|
+
*
|
|
732
|
+
* **Notes**
|
|
733
|
+
* The enclosing computer-use tool must be configured with `enableZoom: true`.
|
|
734
|
+
*
|
|
681
735
|
* @category Computer Use
|
|
736
|
+
* @since 4.0.0
|
|
682
737
|
*/
|
|
683
738
|
export type ComputerUseZoomAction = typeof ComputerUseZoomAction.Type;
|
|
684
739
|
/**
|
|
@@ -688,8 +743,8 @@ export type ComputerUseZoomAction = typeof ComputerUseZoomAction.Type;
|
|
|
688
743
|
*
|
|
689
744
|
* Basic actions only: screenshot, left_click, type, key, mouse_move.
|
|
690
745
|
*
|
|
691
|
-
* @since 1.0.0
|
|
692
746
|
* @category Computer Use
|
|
747
|
+
* @since 4.0.0
|
|
693
748
|
*/
|
|
694
749
|
export declare const ComputerUse_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
695
750
|
readonly displayWidthPx: number;
|
|
@@ -754,8 +809,8 @@ export declare const ComputerUse_20241022: <Mode extends Tool.FailureMode | unde
|
|
|
754
809
|
* right_click, middle_click, double_click, triple_click, left_mouse_down,
|
|
755
810
|
* left_mouse_up, hold_key, wait.
|
|
756
811
|
*
|
|
757
|
-
* @since 1.0.0
|
|
758
812
|
* @category Computer Use
|
|
813
|
+
* @since 4.0.0
|
|
759
814
|
*/
|
|
760
815
|
export declare const ComputerUse_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
761
816
|
readonly displayWidthPx: number;
|
|
@@ -902,8 +957,8 @@ export declare const ComputerUse_20250124: <Mode extends Tool.FailureMode | unde
|
|
|
902
957
|
* Includes all actions from computer_20250124 plus the zoom action for
|
|
903
958
|
* detailed screen region inspection. Requires `enableZoom: true` in args.
|
|
904
959
|
*
|
|
905
|
-
* @since 1.0.0
|
|
906
960
|
* @category Computer Use
|
|
961
|
+
* @since 4.0.0
|
|
907
962
|
*/
|
|
908
963
|
export declare const ComputerUse_20251124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
909
964
|
readonly displayWidthPx: number;
|
|
@@ -1054,25 +1109,27 @@ export declare const ComputerUse_20251124: <Mode extends Tool.FailureMode | unde
|
|
|
1054
1109
|
/**
|
|
1055
1110
|
* A `[start, end]` line range for viewing file contents.
|
|
1056
1111
|
*
|
|
1057
|
-
* Lines are 1-indexed. Use -1 for end to read to end of file
|
|
1112
|
+
* Lines are 1-indexed. Use -1 for end to read to end of file:
|
|
1058
1113
|
*
|
|
1059
|
-
*
|
|
1060
|
-
*
|
|
1114
|
+
* - `[1, 50]`: View lines 1-50
|
|
1115
|
+
* - `[100, -1]`: View from line 100 to end of file
|
|
1061
1116
|
*
|
|
1062
|
-
* @since 1.0.0
|
|
1063
1117
|
* @category Memory
|
|
1118
|
+
* @since 4.0.0
|
|
1064
1119
|
*/
|
|
1065
1120
|
export declare const ViewRange: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
|
|
1066
1121
|
/**
|
|
1067
|
-
*
|
|
1122
|
+
* A `[start, end]` 1-indexed line range for viewing file contents, using `-1` as the end value to read through the end of the file.
|
|
1123
|
+
*
|
|
1068
1124
|
* @category Memory
|
|
1125
|
+
* @since 4.0.0
|
|
1069
1126
|
*/
|
|
1070
1127
|
export type ViewRange = typeof ViewRange.Type;
|
|
1071
1128
|
/**
|
|
1072
1129
|
* Creates a new file.
|
|
1073
1130
|
*
|
|
1074
|
-
* @since 1.0.0
|
|
1075
1131
|
* @category Memory
|
|
1132
|
+
* @since 4.0.0
|
|
1076
1133
|
*/
|
|
1077
1134
|
export declare const MemoryCreateCommand: Schema.Struct<{
|
|
1078
1135
|
readonly command: Schema.Literal<"create">;
|
|
@@ -1082,15 +1139,17 @@ export declare const MemoryCreateCommand: Schema.Struct<{
|
|
|
1082
1139
|
readonly path: Schema.String;
|
|
1083
1140
|
}>;
|
|
1084
1141
|
/**
|
|
1085
|
-
*
|
|
1142
|
+
* Memory tool command payload for creating a new file at a path.
|
|
1143
|
+
*
|
|
1086
1144
|
* @category Memory
|
|
1145
|
+
* @since 4.0.0
|
|
1087
1146
|
*/
|
|
1088
1147
|
export type MemoryCreateCommand = typeof MemoryCreateCommand.Type;
|
|
1089
1148
|
/**
|
|
1090
1149
|
* Delete a file or directory.
|
|
1091
1150
|
*
|
|
1092
|
-
* @since 1.0.0
|
|
1093
1151
|
* @category Memory
|
|
1152
|
+
* @since 4.0.0
|
|
1094
1153
|
*/
|
|
1095
1154
|
export declare const MemoryDeleteCommand: Schema.Struct<{
|
|
1096
1155
|
readonly command: Schema.Literal<"delete">;
|
|
@@ -1100,15 +1159,17 @@ export declare const MemoryDeleteCommand: Schema.Struct<{
|
|
|
1100
1159
|
readonly path: Schema.String;
|
|
1101
1160
|
}>;
|
|
1102
1161
|
/**
|
|
1103
|
-
*
|
|
1162
|
+
* Memory tool command payload for deleting a file or directory at a path.
|
|
1163
|
+
*
|
|
1104
1164
|
* @category Memory
|
|
1165
|
+
* @since 4.0.0
|
|
1105
1166
|
*/
|
|
1106
1167
|
export type MemoryDeleteCommand = typeof MemoryDeleteCommand.Type;
|
|
1107
1168
|
/**
|
|
1108
1169
|
* Insert text at a specific line.
|
|
1109
1170
|
*
|
|
1110
|
-
* @since 1.0.0
|
|
1111
1171
|
* @category Memory
|
|
1172
|
+
* @since 4.0.0
|
|
1112
1173
|
*/
|
|
1113
1174
|
export declare const MemoryInsertCommand: Schema.Struct<{
|
|
1114
1175
|
readonly command: Schema.Literal<"insert">;
|
|
@@ -1126,15 +1187,17 @@ export declare const MemoryInsertCommand: Schema.Struct<{
|
|
|
1126
1187
|
readonly insert_text: Schema.String;
|
|
1127
1188
|
}>;
|
|
1128
1189
|
/**
|
|
1129
|
-
*
|
|
1190
|
+
* Memory tool command payload for inserting text at a specific line in a file.
|
|
1191
|
+
*
|
|
1130
1192
|
* @category Memory
|
|
1193
|
+
* @since 4.0.0
|
|
1131
1194
|
*/
|
|
1132
1195
|
export type MemoryInsertCommand = typeof MemoryInsertCommand.Type;
|
|
1133
1196
|
/**
|
|
1134
1197
|
* Rename or move a file or directory.
|
|
1135
1198
|
*
|
|
1136
|
-
* @since 1.0.0
|
|
1137
1199
|
* @category Memory
|
|
1200
|
+
* @since 4.0.0
|
|
1138
1201
|
*/
|
|
1139
1202
|
export declare const MemoryRenameCommand: Schema.Struct<{
|
|
1140
1203
|
readonly command: Schema.Literal<"rename">;
|
|
@@ -1148,15 +1211,17 @@ export declare const MemoryRenameCommand: Schema.Struct<{
|
|
|
1148
1211
|
readonly new_path: Schema.String;
|
|
1149
1212
|
}>;
|
|
1150
1213
|
/**
|
|
1151
|
-
*
|
|
1214
|
+
* Memory tool command payload for renaming or moving a file or directory.
|
|
1215
|
+
*
|
|
1152
1216
|
* @category Memory
|
|
1217
|
+
* @since 4.0.0
|
|
1153
1218
|
*/
|
|
1154
1219
|
export type MemoryRenameCommand = typeof MemoryRenameCommand.Type;
|
|
1155
1220
|
/**
|
|
1156
1221
|
* Replace text in a file.
|
|
1157
1222
|
*
|
|
1158
|
-
* @since 1.0.0
|
|
1159
1223
|
* @category Memory
|
|
1224
|
+
* @since 4.0.0
|
|
1160
1225
|
*/
|
|
1161
1226
|
export declare const MemoryStrReplaceCommand: Schema.Struct<{
|
|
1162
1227
|
readonly command: Schema.Literal<"str_replace">;
|
|
@@ -1174,15 +1239,17 @@ export declare const MemoryStrReplaceCommand: Schema.Struct<{
|
|
|
1174
1239
|
readonly new_str: Schema.String;
|
|
1175
1240
|
}>;
|
|
1176
1241
|
/**
|
|
1177
|
-
*
|
|
1242
|
+
* Memory tool command payload for replacing text in a file.
|
|
1243
|
+
*
|
|
1178
1244
|
* @category Memory
|
|
1245
|
+
* @since 4.0.0
|
|
1179
1246
|
*/
|
|
1180
1247
|
export type MemoryStrReplaceCommand = typeof MemoryStrReplaceCommand.Type;
|
|
1181
1248
|
/**
|
|
1182
1249
|
* Shows directory contents or file contents with optional line ranges.
|
|
1183
1250
|
*
|
|
1184
|
-
* @since 1.0.0
|
|
1185
1251
|
* @category Memory
|
|
1252
|
+
* @since 4.0.0
|
|
1186
1253
|
*/
|
|
1187
1254
|
export declare const MemoryViewCommand: Schema.Struct<{
|
|
1188
1255
|
readonly command: Schema.Literal<"view">;
|
|
@@ -1196,8 +1263,10 @@ export declare const MemoryViewCommand: Schema.Struct<{
|
|
|
1196
1263
|
readonly view_range: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
1197
1264
|
}>;
|
|
1198
1265
|
/**
|
|
1199
|
-
*
|
|
1266
|
+
* Memory tool command payload for viewing a file or directory, optionally with a file line range.
|
|
1267
|
+
*
|
|
1200
1268
|
* @category Memory
|
|
1269
|
+
* @since 4.0.0
|
|
1201
1270
|
*/
|
|
1202
1271
|
export type MemoryViewCommand = typeof MemoryViewCommand.Type;
|
|
1203
1272
|
/**
|
|
@@ -1206,8 +1275,8 @@ export type MemoryViewCommand = typeof MemoryViewCommand.Type;
|
|
|
1206
1275
|
* Provides commands for creating, viewing, editing, renaming, and deleting
|
|
1207
1276
|
* files within the model's memory space.
|
|
1208
1277
|
*
|
|
1209
|
-
* @since 1.0.0
|
|
1210
1278
|
* @category Memory
|
|
1279
|
+
* @since 4.0.0
|
|
1211
1280
|
*/
|
|
1212
1281
|
export declare const Memory_20250818: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.memory_20250818", "AnthropicMemory", {
|
|
1213
1282
|
readonly args: Schema.Void;
|
|
@@ -1282,8 +1351,8 @@ export declare const Memory_20250818: <Mode extends Tool.FailureMode | undefined
|
|
|
1282
1351
|
* When used on a file: Returns the file contents, optionally limited to a line range.
|
|
1283
1352
|
* When used on a directory: Lists all files and subdirectories.
|
|
1284
1353
|
*
|
|
1285
|
-
* @since 1.0.0
|
|
1286
1354
|
* @category Text Editor
|
|
1355
|
+
* @since 4.0.0
|
|
1287
1356
|
*/
|
|
1288
1357
|
export declare const TextEditorViewCommand: Schema.Struct<{
|
|
1289
1358
|
readonly command: Schema.Literal<"view">;
|
|
@@ -1298,8 +1367,10 @@ export declare const TextEditorViewCommand: Schema.Struct<{
|
|
|
1298
1367
|
readonly view_range: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
|
|
1299
1368
|
}>;
|
|
1300
1369
|
/**
|
|
1301
|
-
*
|
|
1370
|
+
* Text editor command payload for viewing file contents or listing directory contents.
|
|
1371
|
+
*
|
|
1302
1372
|
* @category Text Editor
|
|
1373
|
+
* @since 4.0.0
|
|
1303
1374
|
*/
|
|
1304
1375
|
export type TextEditorViewCommand = typeof TextEditorViewCommand.Type;
|
|
1305
1376
|
/**
|
|
@@ -1307,8 +1378,8 @@ export type TextEditorViewCommand = typeof TextEditorViewCommand.Type;
|
|
|
1307
1378
|
*
|
|
1308
1379
|
* Will fail if the file already exists. Parent directories must exist.
|
|
1309
1380
|
*
|
|
1310
|
-
* @since 1.0.0
|
|
1311
1381
|
* @category Text Editor
|
|
1382
|
+
* @since 4.0.0
|
|
1312
1383
|
*/
|
|
1313
1384
|
export declare const TextEditorCreateCommand: Schema.Struct<{
|
|
1314
1385
|
readonly command: Schema.Literal<"create">;
|
|
@@ -1322,8 +1393,13 @@ export declare const TextEditorCreateCommand: Schema.Struct<{
|
|
|
1322
1393
|
readonly file_text: Schema.String;
|
|
1323
1394
|
}>;
|
|
1324
1395
|
/**
|
|
1325
|
-
*
|
|
1396
|
+
* Text editor command payload for creating a new file with the specified content.
|
|
1397
|
+
*
|
|
1398
|
+
* **Notes**
|
|
1399
|
+
* The command fails if the file already exists or if parent directories are missing.
|
|
1400
|
+
*
|
|
1326
1401
|
* @category Text Editor
|
|
1402
|
+
* @since 4.0.0
|
|
1327
1403
|
*/
|
|
1328
1404
|
export type TextEditorCreateCommand = typeof TextEditorCreateCommand.Type;
|
|
1329
1405
|
/**
|
|
@@ -1332,8 +1408,8 @@ export type TextEditorCreateCommand = typeof TextEditorCreateCommand.Type;
|
|
|
1332
1408
|
* The `old_str` must match exactly (including whitespace and indentation)
|
|
1333
1409
|
* and must be unique in the file.
|
|
1334
1410
|
*
|
|
1335
|
-
* @since 1.0.0
|
|
1336
1411
|
* @category Text Editor
|
|
1412
|
+
* @since 4.0.0
|
|
1337
1413
|
*/
|
|
1338
1414
|
export declare const TextEditorStrReplaceCommand: Schema.Struct<{
|
|
1339
1415
|
readonly command: Schema.Literal<"str_replace">;
|
|
@@ -1351,8 +1427,10 @@ export declare const TextEditorStrReplaceCommand: Schema.Struct<{
|
|
|
1351
1427
|
readonly new_str: Schema.String;
|
|
1352
1428
|
}>;
|
|
1353
1429
|
/**
|
|
1354
|
-
*
|
|
1430
|
+
* Text editor command payload for replacing one exact, unique string in a file.
|
|
1431
|
+
*
|
|
1355
1432
|
* @category Text Editor
|
|
1433
|
+
* @since 4.0.0
|
|
1356
1434
|
*/
|
|
1357
1435
|
export type TextEditorStrReplaceCommand = typeof TextEditorStrReplaceCommand.Type;
|
|
1358
1436
|
/**
|
|
@@ -1360,8 +1438,8 @@ export type TextEditorStrReplaceCommand = typeof TextEditorStrReplaceCommand.Typ
|
|
|
1360
1438
|
*
|
|
1361
1439
|
* Inserts the new text AFTER the specified line number.
|
|
1362
1440
|
*
|
|
1363
|
-
* @since 1.0.0
|
|
1364
1441
|
* @category Text Editor
|
|
1442
|
+
* @since 4.0.0
|
|
1365
1443
|
*/
|
|
1366
1444
|
export declare const TextEditorInsertCommand: Schema.Struct<{
|
|
1367
1445
|
readonly command: Schema.Literal<"insert">;
|
|
@@ -1379,8 +1457,10 @@ export declare const TextEditorInsertCommand: Schema.Struct<{
|
|
|
1379
1457
|
readonly new_str: Schema.String;
|
|
1380
1458
|
}>;
|
|
1381
1459
|
/**
|
|
1382
|
-
*
|
|
1460
|
+
* Text editor command payload for inserting text after a specific line number in a file.
|
|
1461
|
+
*
|
|
1383
1462
|
* @category Text Editor
|
|
1463
|
+
* @since 4.0.0
|
|
1384
1464
|
*/
|
|
1385
1465
|
export type TextEditorInsertCommand = typeof TextEditorInsertCommand.Type;
|
|
1386
1466
|
/**
|
|
@@ -1391,8 +1471,8 @@ export type TextEditorInsertCommand = typeof TextEditorInsertCommand.Type;
|
|
|
1391
1471
|
* NOTE: This command is available in text_editor_20241022 and text_editor_20250124,
|
|
1392
1472
|
* but NOT in text_editor_20250728 (Claude 4 models).
|
|
1393
1473
|
*
|
|
1394
|
-
* @since 1.0.0
|
|
1395
1474
|
* @category Text Editor
|
|
1475
|
+
* @since 4.0.0
|
|
1396
1476
|
*/
|
|
1397
1477
|
export declare const TextEditorUndoEditCommand: Schema.Struct<{
|
|
1398
1478
|
readonly command: Schema.Literal<"undo_edit">;
|
|
@@ -1402,8 +1482,13 @@ export declare const TextEditorUndoEditCommand: Schema.Struct<{
|
|
|
1402
1482
|
readonly path: Schema.String;
|
|
1403
1483
|
}>;
|
|
1404
1484
|
/**
|
|
1405
|
-
*
|
|
1485
|
+
* Text editor command payload for undoing the most recent edit to a file.
|
|
1486
|
+
*
|
|
1487
|
+
* **Notes**
|
|
1488
|
+
* Available for `text_editor_20241022` and `text_editor_20250124`, but not for Claude 4 text editor versions.
|
|
1489
|
+
*
|
|
1406
1490
|
* @category Text Editor
|
|
1491
|
+
* @since 4.0.0
|
|
1407
1492
|
*/
|
|
1408
1493
|
export type TextEditorUndoEditCommand = typeof TextEditorUndoEditCommand.Type;
|
|
1409
1494
|
/**
|
|
@@ -1411,8 +1496,8 @@ export type TextEditorUndoEditCommand = typeof TextEditorUndoEditCommand.Type;
|
|
|
1411
1496
|
*
|
|
1412
1497
|
* Requires the "computer-use-2024-10-22" beta header.
|
|
1413
1498
|
*
|
|
1414
|
-
* @since 1.0.0
|
|
1415
1499
|
* @category Text Editor
|
|
1500
|
+
* @since 4.0.0
|
|
1416
1501
|
*/
|
|
1417
1502
|
export declare const TextEditor_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
1418
1503
|
readonly failureMode?: Mode | undefined;
|
|
@@ -1481,8 +1566,11 @@ export declare const TextEditor_20241022: <Mode extends Tool.FailureMode | undef
|
|
|
1481
1566
|
/**
|
|
1482
1567
|
* Text editor tool for Claude Sonnet 3.7 (deprecated model).
|
|
1483
1568
|
*
|
|
1484
|
-
*
|
|
1569
|
+
* **Notes**
|
|
1570
|
+
* Requires the "computer-use-2025-01-24" beta header.
|
|
1571
|
+
*
|
|
1485
1572
|
* @category Text Editor
|
|
1573
|
+
* @since 4.0.0
|
|
1486
1574
|
*/
|
|
1487
1575
|
export declare const TextEditor_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
1488
1576
|
readonly failureMode?: Mode | undefined;
|
|
@@ -1549,12 +1637,13 @@ export declare const TextEditor_20250124: <Mode extends Tool.FailureMode | undef
|
|
|
1549
1637
|
readonly failureMode: Mode extends undefined ? "error" : Mode;
|
|
1550
1638
|
}, true>;
|
|
1551
1639
|
/**
|
|
1552
|
-
* Text editor tool for Claude 4 models
|
|
1640
|
+
* Text editor tool for Claude 4 models using Anthropic's `str_replace_based_edit_tool`.
|
|
1553
1641
|
*
|
|
1554
|
-
*
|
|
1642
|
+
* **Notes**
|
|
1643
|
+
* Requires the "computer-use-2025-01-24" beta header. This version does not support the `undo_edit` command.
|
|
1555
1644
|
*
|
|
1556
|
-
* @since 1.0.0
|
|
1557
1645
|
* @category Text Editor
|
|
1646
|
+
* @since 4.0.0
|
|
1558
1647
|
*/
|
|
1559
1648
|
export declare const TextEditor_20250429: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
1560
1649
|
readonly max_characters?: number | undefined;
|
|
@@ -1626,8 +1715,8 @@ export declare const TextEditor_20250429: <Mode extends Tool.FailureMode | undef
|
|
|
1626
1715
|
*
|
|
1627
1716
|
* NOTE: This version does NOT support the `undo_edit` command.
|
|
1628
1717
|
*
|
|
1629
|
-
* @since 1.0.0
|
|
1630
1718
|
* @category Text Editor
|
|
1719
|
+
* @since 4.0.0
|
|
1631
1720
|
*/
|
|
1632
1721
|
export declare const TextEditor_20250728: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
1633
1722
|
readonly max_characters?: number | undefined;
|
|
@@ -1700,8 +1789,8 @@ export declare const TextEditor_20250728: <Mode extends Tool.FailureMode | undef
|
|
|
1700
1789
|
* Providing location helps return more relevant results for location-dependent
|
|
1701
1790
|
* queries like weather, local businesses, events, etc.
|
|
1702
1791
|
*
|
|
1703
|
-
* @since 1.0.0
|
|
1704
1792
|
* @category Web Search
|
|
1793
|
+
* @since 4.0.0
|
|
1705
1794
|
*/
|
|
1706
1795
|
export declare const WebSearchUserLocation: Schema.Struct<{
|
|
1707
1796
|
/**
|
|
@@ -1728,8 +1817,8 @@ export declare const WebSearchUserLocation: Schema.Struct<{
|
|
|
1728
1817
|
/**
|
|
1729
1818
|
* Configuration arguments for the web search tool.
|
|
1730
1819
|
*
|
|
1731
|
-
* @since 1.0.0
|
|
1732
1820
|
* @category Web Search
|
|
1821
|
+
* @since 4.0.0
|
|
1733
1822
|
*/
|
|
1734
1823
|
export declare const WebSearch_20250305_Args: Schema.Struct<{
|
|
1735
1824
|
/**
|
|
@@ -1775,15 +1864,17 @@ export declare const WebSearch_20250305_Args: Schema.Struct<{
|
|
|
1775
1864
|
}>>;
|
|
1776
1865
|
}>;
|
|
1777
1866
|
/**
|
|
1778
|
-
*
|
|
1867
|
+
* Configuration arguments for the Anthropic web search tool, including usage limits, domain filters, and optional user location.
|
|
1868
|
+
*
|
|
1779
1869
|
* @category Web Search
|
|
1870
|
+
* @since 4.0.0
|
|
1780
1871
|
*/
|
|
1781
1872
|
export type WebSearch_20250305_Args = typeof WebSearch_20250305_Args.Type;
|
|
1782
1873
|
/**
|
|
1783
1874
|
* Input parameters for a web search.
|
|
1784
1875
|
*
|
|
1785
|
-
* @since 1.0.0
|
|
1786
1876
|
* @category Web Search
|
|
1877
|
+
* @since 4.0.0
|
|
1787
1878
|
*/
|
|
1788
1879
|
export declare const WebSearchParameters: Schema.Struct<{
|
|
1789
1880
|
/**
|
|
@@ -1792,8 +1883,13 @@ export declare const WebSearchParameters: Schema.Struct<{
|
|
|
1792
1883
|
readonly query: Schema.String;
|
|
1793
1884
|
}>;
|
|
1794
1885
|
/**
|
|
1795
|
-
*
|
|
1886
|
+
* Type of the parameters Claude supplies when invoking the Anthropic web search tool.
|
|
1887
|
+
*
|
|
1888
|
+
* **Details**
|
|
1889
|
+
* Contains the generated search query used by `WebSearch_20250305`.
|
|
1890
|
+
*
|
|
1796
1891
|
* @category Web Search
|
|
1892
|
+
* @since 4.0.0
|
|
1797
1893
|
*/
|
|
1798
1894
|
export type WebSearchParameters = typeof WebSearchParameters.Type;
|
|
1799
1895
|
/**
|
|
@@ -1804,8 +1900,8 @@ export type WebSearchParameters = typeof WebSearchParameters.Type;
|
|
|
1804
1900
|
*
|
|
1805
1901
|
* Generally available (no beta header required).
|
|
1806
1902
|
*
|
|
1807
|
-
* @since 1.0.0
|
|
1808
1903
|
* @category Web Search
|
|
1904
|
+
* @since 4.0.0
|
|
1809
1905
|
*/
|
|
1810
1906
|
export declare const WebSearch_20250305: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
1811
1907
|
readonly maxUses?: number | undefined;
|
|
@@ -1884,8 +1980,8 @@ export declare const WebSearch_20250305: <Mode extends Tool.FailureMode | undefi
|
|
|
1884
1980
|
/**
|
|
1885
1981
|
* Citation configuration for web fetch.
|
|
1886
1982
|
*
|
|
1887
|
-
* @since 1.0.0
|
|
1888
1983
|
* @category Web Fetch
|
|
1984
|
+
* @since 4.0.0
|
|
1889
1985
|
*/
|
|
1890
1986
|
export declare const WebFetchCitationsConfig: Schema.Struct<{
|
|
1891
1987
|
/**
|
|
@@ -1894,15 +1990,17 @@ export declare const WebFetchCitationsConfig: Schema.Struct<{
|
|
|
1894
1990
|
readonly enabled: Schema.Boolean;
|
|
1895
1991
|
}>;
|
|
1896
1992
|
/**
|
|
1897
|
-
*
|
|
1993
|
+
* Configuration payload for enabling or disabling citations on web fetch results.
|
|
1994
|
+
*
|
|
1898
1995
|
* @category Web Fetch
|
|
1996
|
+
* @since 4.0.0
|
|
1899
1997
|
*/
|
|
1900
1998
|
export type WebFetchCitationsConfig = typeof WebFetchCitationsConfig.Type;
|
|
1901
1999
|
/**
|
|
1902
2000
|
* Configuration arguments for the web fetch tool.
|
|
1903
2001
|
*
|
|
1904
|
-
* @since 1.0.0
|
|
1905
2002
|
* @category Web Fetch
|
|
2003
|
+
* @since 4.0.0
|
|
1906
2004
|
*/
|
|
1907
2005
|
export declare const WebFetch_20250910_Args: Schema.Struct<{
|
|
1908
2006
|
/**
|
|
@@ -1936,15 +2034,17 @@ export declare const WebFetch_20250910_Args: Schema.Struct<{
|
|
|
1936
2034
|
readonly maxContentTokens: Schema.optional<Schema.Number>;
|
|
1937
2035
|
}>;
|
|
1938
2036
|
/**
|
|
1939
|
-
*
|
|
2037
|
+
* Configuration arguments for the Anthropic web fetch tool, including usage limits, domain filters, citation settings, and token limits.
|
|
2038
|
+
*
|
|
1940
2039
|
* @category Web Fetch
|
|
2040
|
+
* @since 4.0.0
|
|
1941
2041
|
*/
|
|
1942
2042
|
export type WebFetch_20250910_Args = typeof WebFetch_20250910_Args.Type;
|
|
1943
2043
|
/**
|
|
1944
2044
|
* Input parameters for a web fetch.
|
|
1945
2045
|
*
|
|
1946
|
-
* @since 1.0.0
|
|
1947
2046
|
* @category Web Fetch
|
|
2047
|
+
* @since 4.0.0
|
|
1948
2048
|
*/
|
|
1949
2049
|
export declare const WebFetchParameters: Schema.Struct<{
|
|
1950
2050
|
/**
|
|
@@ -1954,8 +2054,10 @@ export declare const WebFetchParameters: Schema.Struct<{
|
|
|
1954
2054
|
readonly url: Schema.String;
|
|
1955
2055
|
}>;
|
|
1956
2056
|
/**
|
|
1957
|
-
*
|
|
2057
|
+
* Type of the parameters Claude supplies when invoking the Anthropic web fetch tool.
|
|
2058
|
+
*
|
|
1958
2059
|
* @category Web Fetch
|
|
2060
|
+
* @since 4.0.0
|
|
1959
2061
|
*/
|
|
1960
2062
|
export type WebFetchParameters = typeof WebFetchParameters.Type;
|
|
1961
2063
|
/**
|
|
@@ -1966,8 +2068,8 @@ export type WebFetchParameters = typeof WebFetchParameters.Type;
|
|
|
1966
2068
|
*
|
|
1967
2069
|
* Requires the "web-fetch-2025-09-10" beta header.
|
|
1968
2070
|
*
|
|
1969
|
-
* @since 1.0.0
|
|
1970
2071
|
* @category Web Fetch
|
|
2072
|
+
* @since 4.0.0
|
|
1971
2073
|
*/
|
|
1972
2074
|
export declare const WebFetch_20250910: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
|
|
1973
2075
|
readonly maxUses?: number | undefined;
|
|
@@ -2049,8 +2151,8 @@ export declare const WebFetch_20250910: <Mode extends Tool.FailureMode | undefin
|
|
|
2049
2151
|
* Claude constructs regex patterns using Python's `re.search()` syntax.
|
|
2050
2152
|
* Maximum query length: 200 characters.
|
|
2051
2153
|
*
|
|
2052
|
-
* @since 1.0.0
|
|
2053
2154
|
* @category Tool Search
|
|
2155
|
+
* @since 4.0.0
|
|
2054
2156
|
*/
|
|
2055
2157
|
export declare const ToolSearchRegexParameters: Schema.Struct<{
|
|
2056
2158
|
/**
|
|
@@ -2059,15 +2161,17 @@ export declare const ToolSearchRegexParameters: Schema.Struct<{
|
|
|
2059
2161
|
readonly query: Schema.String;
|
|
2060
2162
|
}>;
|
|
2061
2163
|
/**
|
|
2062
|
-
*
|
|
2164
|
+
* Type of the parameters Claude supplies when invoking regex-based Anthropic tool search.
|
|
2165
|
+
*
|
|
2063
2166
|
* @category Tool Search
|
|
2167
|
+
* @since 4.0.0
|
|
2064
2168
|
*/
|
|
2065
2169
|
export type ToolSearchRegexParameters = typeof ToolSearchRegexParameters.Type;
|
|
2066
2170
|
/**
|
|
2067
2171
|
* Input parameters for BM25/natural language tool search.
|
|
2068
2172
|
*
|
|
2069
|
-
* @since 1.0.0
|
|
2070
2173
|
* @category Tool Search
|
|
2174
|
+
* @since 4.0.0
|
|
2071
2175
|
*/
|
|
2072
2176
|
export declare const ToolSearchBM25Parameters: Schema.Struct<{
|
|
2073
2177
|
/**
|
|
@@ -2076,8 +2180,10 @@ export declare const ToolSearchBM25Parameters: Schema.Struct<{
|
|
|
2076
2180
|
readonly query: Schema.String;
|
|
2077
2181
|
}>;
|
|
2078
2182
|
/**
|
|
2079
|
-
*
|
|
2183
|
+
* Type of the parameters Claude supplies when invoking BM25 natural-language Anthropic tool search.
|
|
2184
|
+
*
|
|
2080
2185
|
* @category Tool Search
|
|
2186
|
+
* @since 4.0.0
|
|
2081
2187
|
*/
|
|
2082
2188
|
export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type;
|
|
2083
2189
|
/**
|
|
@@ -2089,8 +2195,8 @@ export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type;
|
|
|
2089
2195
|
*
|
|
2090
2196
|
* Requires the "advanced-tool-use-2025-11-20" beta header.
|
|
2091
2197
|
*
|
|
2092
|
-
* @since 1.0.0
|
|
2093
2198
|
* @category Tool Search
|
|
2199
|
+
* @since 4.0.0
|
|
2094
2200
|
*/
|
|
2095
2201
|
export declare const ToolSearchRegex_20251119: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.tool_search_tool_regex_20251119", "AnthropicToolSearchRegex", {
|
|
2096
2202
|
readonly args: Schema.Void;
|
|
@@ -2124,8 +2230,8 @@ export declare const ToolSearchRegex_20251119: <Mode extends Tool.FailureMode |
|
|
|
2124
2230
|
*
|
|
2125
2231
|
* Requires the "advanced-tool-use-2025-11-20" beta header.
|
|
2126
2232
|
*
|
|
2127
|
-
* @since 1.0.0
|
|
2128
2233
|
* @category Tool Search
|
|
2234
|
+
* @since 4.0.0
|
|
2129
2235
|
*/
|
|
2130
2236
|
export declare const ToolSearchBM25_20251119: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.tool_search_tool_bm25_20251119", "AnthropicToolSearchBM25", {
|
|
2131
2237
|
readonly args: Schema.Void;
|