Skip to content

Commit 6a477df

Browse files
docs: sync Core Integrations API reference (anthropic) on Docusaurus (#12051)
Co-authored-by: anakin87 <44616784+anakin87@users.noreply.github.com>
1 parent f28a6ad commit 6a477df

15 files changed

Lines changed: 270 additions & 0 deletions

File tree

docs-website/reference/integrations-api/anthropic.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ __init__(
9292
generation_kwargs: dict[str, Any] | None = None,
9393
ignore_tools_thinking_messages: bool = True,
9494
tools: ToolsType | None = None,
95+
anthropic_server_tools: list[dict[str, Any]] | None = None,
9596
*,
9697
timeout: float | None = None,
9798
max_retries: int | None = None
@@ -131,6 +132,11 @@ Supported generation_kwargs parameters are:
131132
for more details.
132133
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
133134
Each tool should have a unique name.
135+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
136+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
137+
code execution tool, or other provider-managed tools. Refer to the
138+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
139+
for the exact dict format each native tool expects.
134140
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
135141
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
136142
the Anthropic client.
@@ -300,6 +306,7 @@ __init__(
300306
generation_kwargs: dict[str, Any] | None = None,
301307
ignore_tools_thinking_messages: bool = True,
302308
tools: ToolsType | None = None,
309+
anthropic_server_tools: list[dict[str, Any]] | None = None,
303310
timeout: float | None = None,
304311
max_retries: int | None = None,
305312
azure_ad_token_provider: Callable[[], str] | None = None
@@ -340,6 +347,11 @@ Creates an instance of AnthropicFoundryChatGenerator.
340347
for more details.
341348
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
342349
Each tool should have a unique name.
350+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
351+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
352+
code execution tool, or other provider-managed tools. Refer to the
353+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
354+
for the exact dict format each native tool expects.
343355
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
344356
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
345357
the Anthropic client.
@@ -521,6 +533,7 @@ __init__(
521533
generation_kwargs: dict[str, Any] | None = None,
522534
ignore_tools_thinking_messages: bool = True,
523535
tools: ToolsType | None = None,
536+
anthropic_server_tools: list[dict[str, Any]] | None = None,
524537
*,
525538
timeout: float | None = None,
526539
max_retries: int | None = None
@@ -557,6 +570,11 @@ Supported generation_kwargs parameters are:
557570
for more details.
558571
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
559572
Each tool should have a unique name.
573+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
574+
On Vertex AI only the basic web search tool (`{"type": "web_search_20250305"}`) is available:
575+
web search with dynamic filtering, web fetch and code execution are not supported. Refer to the
576+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
577+
for the exact dict format each native tool expects.
560578
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
561579
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
562580
the Anthropic client.

docs-website/reference_versioned_docs/version-2.18/integrations-api/anthropic.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ __init__(
9292
generation_kwargs: dict[str, Any] | None = None,
9393
ignore_tools_thinking_messages: bool = True,
9494
tools: ToolsType | None = None,
95+
anthropic_server_tools: list[dict[str, Any]] | None = None,
9596
*,
9697
timeout: float | None = None,
9798
max_retries: int | None = None
@@ -131,6 +132,11 @@ Supported generation_kwargs parameters are:
131132
for more details.
132133
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
133134
Each tool should have a unique name.
135+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
136+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
137+
code execution tool, or other provider-managed tools. Refer to the
138+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
139+
for the exact dict format each native tool expects.
134140
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
135141
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
136142
the Anthropic client.
@@ -300,6 +306,7 @@ __init__(
300306
generation_kwargs: dict[str, Any] | None = None,
301307
ignore_tools_thinking_messages: bool = True,
302308
tools: ToolsType | None = None,
309+
anthropic_server_tools: list[dict[str, Any]] | None = None,
303310
timeout: float | None = None,
304311
max_retries: int | None = None,
305312
azure_ad_token_provider: Callable[[], str] | None = None
@@ -340,6 +347,11 @@ Creates an instance of AnthropicFoundryChatGenerator.
340347
for more details.
341348
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
342349
Each tool should have a unique name.
350+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
351+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
352+
code execution tool, or other provider-managed tools. Refer to the
353+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
354+
for the exact dict format each native tool expects.
343355
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
344356
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
345357
the Anthropic client.
@@ -521,6 +533,7 @@ __init__(
521533
generation_kwargs: dict[str, Any] | None = None,
522534
ignore_tools_thinking_messages: bool = True,
523535
tools: ToolsType | None = None,
536+
anthropic_server_tools: list[dict[str, Any]] | None = None,
524537
*,
525538
timeout: float | None = None,
526539
max_retries: int | None = None
@@ -557,6 +570,11 @@ Supported generation_kwargs parameters are:
557570
for more details.
558571
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
559572
Each tool should have a unique name.
573+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
574+
On Vertex AI only the basic web search tool (`{"type": "web_search_20250305"}`) is available:
575+
web search with dynamic filtering, web fetch and code execution are not supported. Refer to the
576+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
577+
for the exact dict format each native tool expects.
560578
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
561579
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
562580
the Anthropic client.

docs-website/reference_versioned_docs/version-2.19/integrations-api/anthropic.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ __init__(
9292
generation_kwargs: dict[str, Any] | None = None,
9393
ignore_tools_thinking_messages: bool = True,
9494
tools: ToolsType | None = None,
95+
anthropic_server_tools: list[dict[str, Any]] | None = None,
9596
*,
9697
timeout: float | None = None,
9798
max_retries: int | None = None
@@ -131,6 +132,11 @@ Supported generation_kwargs parameters are:
131132
for more details.
132133
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
133134
Each tool should have a unique name.
135+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
136+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
137+
code execution tool, or other provider-managed tools. Refer to the
138+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
139+
for the exact dict format each native tool expects.
134140
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
135141
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
136142
the Anthropic client.
@@ -300,6 +306,7 @@ __init__(
300306
generation_kwargs: dict[str, Any] | None = None,
301307
ignore_tools_thinking_messages: bool = True,
302308
tools: ToolsType | None = None,
309+
anthropic_server_tools: list[dict[str, Any]] | None = None,
303310
timeout: float | None = None,
304311
max_retries: int | None = None,
305312
azure_ad_token_provider: Callable[[], str] | None = None
@@ -340,6 +347,11 @@ Creates an instance of AnthropicFoundryChatGenerator.
340347
for more details.
341348
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
342349
Each tool should have a unique name.
350+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
351+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
352+
code execution tool, or other provider-managed tools. Refer to the
353+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
354+
for the exact dict format each native tool expects.
343355
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
344356
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
345357
the Anthropic client.
@@ -521,6 +533,7 @@ __init__(
521533
generation_kwargs: dict[str, Any] | None = None,
522534
ignore_tools_thinking_messages: bool = True,
523535
tools: ToolsType | None = None,
536+
anthropic_server_tools: list[dict[str, Any]] | None = None,
524537
*,
525538
timeout: float | None = None,
526539
max_retries: int | None = None
@@ -557,6 +570,11 @@ Supported generation_kwargs parameters are:
557570
for more details.
558571
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
559572
Each tool should have a unique name.
573+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
574+
On Vertex AI only the basic web search tool (`{"type": "web_search_20250305"}`) is available:
575+
web search with dynamic filtering, web fetch and code execution are not supported. Refer to the
576+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
577+
for the exact dict format each native tool expects.
560578
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
561579
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
562580
the Anthropic client.

docs-website/reference_versioned_docs/version-2.20/integrations-api/anthropic.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ __init__(
9292
generation_kwargs: dict[str, Any] | None = None,
9393
ignore_tools_thinking_messages: bool = True,
9494
tools: ToolsType | None = None,
95+
anthropic_server_tools: list[dict[str, Any]] | None = None,
9596
*,
9697
timeout: float | None = None,
9798
max_retries: int | None = None
@@ -131,6 +132,11 @@ Supported generation_kwargs parameters are:
131132
for more details.
132133
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
133134
Each tool should have a unique name.
135+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
136+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
137+
code execution tool, or other provider-managed tools. Refer to the
138+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
139+
for the exact dict format each native tool expects.
134140
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
135141
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
136142
the Anthropic client.
@@ -300,6 +306,7 @@ __init__(
300306
generation_kwargs: dict[str, Any] | None = None,
301307
ignore_tools_thinking_messages: bool = True,
302308
tools: ToolsType | None = None,
309+
anthropic_server_tools: list[dict[str, Any]] | None = None,
303310
timeout: float | None = None,
304311
max_retries: int | None = None,
305312
azure_ad_token_provider: Callable[[], str] | None = None
@@ -340,6 +347,11 @@ Creates an instance of AnthropicFoundryChatGenerator.
340347
for more details.
341348
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
342349
Each tool should have a unique name.
350+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
351+
Use this for native Anthropic tools such as web search (`{"type": "web_search_20250305"}`),
352+
code execution tool, or other provider-managed tools. Refer to the
353+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
354+
for the exact dict format each native tool expects.
343355
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
344356
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
345357
the Anthropic client.
@@ -521,6 +533,7 @@ __init__(
521533
generation_kwargs: dict[str, Any] | None = None,
522534
ignore_tools_thinking_messages: bool = True,
523535
tools: ToolsType | None = None,
536+
anthropic_server_tools: list[dict[str, Any]] | None = None,
524537
*,
525538
timeout: float | None = None,
526539
max_retries: int | None = None
@@ -557,6 +570,11 @@ Supported generation_kwargs parameters are:
557570
for more details.
558571
- **tools** (<code>ToolsType | None</code>) – A list of Tool and/or Toolset objects, or a single Toolset, that the model can use.
559572
Each tool should have a unique name.
573+
- **anthropic_server_tools** (<code>list\[dict\[str, Any\]\] | None</code>) – A list of Anthropic server-side tools passed directly to the API.
574+
On Vertex AI only the basic web search tool (`{"type": "web_search_20250305"}`) is available:
575+
web search with dynamic filtering, web fetch and code execution are not supported. Refer to the
576+
[Anthropic documentation](https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/web-search-tool)
577+
for the exact dict format each native tool expects.
560578
- **timeout** (<code>float | None</code>) – Timeout for Anthropic client calls. If not set, it defaults to the default set by the Anthropic client.
561579
- **max_retries** (<code>int | None</code>) – Maximum number of retries to attempt for failed requests. If not set, it defaults to the default set by
562580
the Anthropic client.

0 commit comments

Comments
 (0)