You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -265,6 +267,95 @@ curl -X POST "$BASE/v1/chat/completions" \
265
267
!!! note "Unsupported Parameter"
266
268
The `tagSuffix` parameter is not supported in this implementation.
267
269
270
+
### AWS Bedrock System Tools
271
+
272
+
AWS Bedrock system tools are built-in capabilities that foundation models can use directly without requiring you to implement backend integrations. Access any AWS Bedrock system tool by adding the `systemTool_` prefix to its name—this works for current tools and any future system tools AWS releases.
273
+
274
+
**How to Use:**
275
+
276
+
Add system tools to your `tools` array using the `systemTool_` prefix followed by the tool name. System tools don't require parameter definitions—just specify the tool name and the model will handle the rest.
277
+
278
+
As AWS releases new system tools, simply use the same `systemTool_` prefix pattern to access them.
279
+
280
+
#### { style="height: 1.2em; vertical-align: text-bottom;" } Amazon Nova Web Grounding
281
+
282
+
Amazon Nova Web Grounding enables models to search the web for current information, helping answer questions requiring real-time data like news, weather, product availability, or recent events. The model automatically determines when to use web grounding based on the user's query.
283
+
284
+
!!! info "Learn More"
285
+
- [Amazon Nova Web Grounding - User Guide](https://docs.aws.amazon.com/nova/latest/userguide/grounding.html)
286
+
- [Build More Accurate AI Applications with Amazon Nova Web Grounding - Blog Post](https://aws.amazon.com/fr/blogs/aws/build-more-accurate-ai-applications-with-amazon-nova-web-grounding/)
287
+
288
+
**Usage:**
289
+
290
+
```bash
291
+
curl -X POST "$BASE/v1/chat/completions" \
292
+
-H "Authorization: Bearer $OPENAI_API_KEY" \
293
+
-H "Content-Type: application/json" \
294
+
-d '{
295
+
"model": "amazon.nova-premier-v1:0",
296
+
"messages": [
297
+
{
298
+
"role": "user",
299
+
"content": "What are the current AWS Regions and their locations?"
300
+
}
301
+
],
302
+
"tools": [
303
+
{
304
+
"type": "function",
305
+
"function": {
306
+
"name": "systemTool_nova_grounding"
307
+
}
308
+
}
309
+
]
310
+
}'
311
+
```
312
+
313
+
**Response Format:**
314
+
315
+
When using web grounding, the API response includes `annotations` with URL citations in non-streaming mode:
Citations are only available in non-streaming responses. The OpenAI API does not support annotations in streaming mode.
339
+
340
+
**Use Cases:**
341
+
342
+
-**Current Events**: Get up-to-date information about news, weather, stock prices, or sports scores
343
+
-**Dynamic Data**: Query information that changes frequently like AWS service availability or product prices
344
+
-**Verification**: Cross-reference facts with current web sources for improved accuracy
345
+
-**Knowledge Extension**: Supplement model training data with real-time information
346
+
347
+
**Benefits:**
348
+
349
+
-**Zero Integration**: No need to implement or maintain web search APIs
350
+
-**Automatic Invocation**: Models intelligently decide when to use web grounding
351
+
-**Enhanced Accuracy**: Reduce hallucinations with real-time information retrieval
352
+
-**OpenAI-Compatible**: Works seamlessly with standard tool calling patterns
353
+
354
+
!!! warning "Model and Region Compatibility"
355
+
**Model**: Only Amazon Nova Premier (`amazon.nova-premier-v1:0`) supports the `systemTool_nova_grounding` tool.
356
+
357
+
**Region**: Web Grounding is only available in US regions.
358
+
268
359
### Provider-Specific Parameters
269
360
270
361
Unlock advanced model capabilities by passing provider-specific parameters directly in your requests. These parameters are forwarded to AWS Bedrock and allow you to access features unique to each foundation model provider.
|{: style="height:20px;width:20px"} **OpenAI**|`/v1/chat/completions` GPT5.1 API update (`reasoning_effort=none`) ||
139
+
|{: style="height:20px;width:20px"} **AWS**| System tools support with URL citations (`systemTool_*`) |{: style="height:20px;width:20px"} Amazon Bedrock - system tools |
0 commit comments