aws.bedrock.AgentPrompt
Explore with Pulumi AI
Resource for managing an AWS Bedrock Agents Prompt.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentPrompt("example", {
name: "MyPrompt",
description: "My prompt description.",
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentPrompt("example",
name="MyPrompt",
description="My prompt description.")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentPrompt(ctx, "example", &bedrock.AgentPromptArgs{
Name: pulumi.String("MyPrompt"),
Description: pulumi.String("My prompt description."),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.AgentPrompt("example", new()
{
Name = "MyPrompt",
Description = "My prompt description.",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentPrompt;
import com.pulumi.aws.bedrock.AgentPromptArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AgentPrompt("example", AgentPromptArgs.builder()
.name("MyPrompt")
.description("My prompt description.")
.build());
}
}
resources:
example:
type: aws:bedrock:AgentPrompt
properties:
name: MyPrompt
description: My prompt description.
With Variants
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.bedrock.AgentPrompt("example", {
name: "MakePlaylist",
description: "My first prompt.",
defaultVariant: "Variant1",
variants: [{
name: "Variant1",
modelId: "amazon.titan-text-express-v1",
inferenceConfiguration: {
text: {
temperature: 0.8,
},
},
templateType: "TEXT",
templateConfiguration: {
text: {
text: "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.",
inputVariables: [
{
name: "genre",
},
{
name: "number",
},
],
},
},
}],
});
import pulumi
import pulumi_aws as aws
example = aws.bedrock.AgentPrompt("example",
name="MakePlaylist",
description="My first prompt.",
default_variant="Variant1",
variants=[{
"name": "Variant1",
"model_id": "amazon.titan-text-express-v1",
"inference_configuration": {
"text": {
"temperature": 0.8,
},
},
"template_type": "TEXT",
"template_configuration": {
"text": {
"text": "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.",
"input_variables": [
{
"name": "genre",
},
{
"name": "number",
},
],
},
},
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/bedrock"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bedrock.NewAgentPrompt(ctx, "example", &bedrock.AgentPromptArgs{
Name: pulumi.String("MakePlaylist"),
Description: pulumi.String("My first prompt."),
DefaultVariant: pulumi.String("Variant1"),
Variants: bedrock.AgentPromptVariantArray{
&bedrock.AgentPromptVariantArgs{
Name: pulumi.String("Variant1"),
ModelId: pulumi.String("amazon.titan-text-express-v1"),
InferenceConfiguration: &bedrock.AgentPromptVariantInferenceConfigurationArgs{
Text: &bedrock.AgentPromptVariantInferenceConfigurationTextArgs{
Temperature: pulumi.Float64(0.8),
},
},
TemplateType: pulumi.String("TEXT"),
TemplateConfiguration: &bedrock.AgentPromptVariantTemplateConfigurationArgs{
Text: &bedrock.AgentPromptVariantTemplateConfigurationTextArgs{
Text: pulumi.String("Make me a {{genre}} playlist consisting of the following number of songs: {{number}}."),
InputVariables: bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArray{
&bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArgs{
Name: pulumi.String("genre"),
},
&bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArgs{
Name: pulumi.String("number"),
},
},
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Bedrock.AgentPrompt("example", new()
{
Name = "MakePlaylist",
Description = "My first prompt.",
DefaultVariant = "Variant1",
Variants = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantArgs
{
Name = "Variant1",
ModelId = "amazon.titan-text-express-v1",
InferenceConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationArgs
{
Text = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationTextArgs
{
Temperature = 0.8,
},
},
TemplateType = "TEXT",
TemplateConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationArgs
{
Text = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextArgs
{
Text = "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.",
InputVariables = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextInputVariableArgs
{
Name = "genre",
},
new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextInputVariableArgs
{
Name = "number",
},
},
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentPrompt;
import com.pulumi.aws.bedrock.AgentPromptArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantInferenceConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantInferenceConfigurationTextArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantTemplateConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantTemplateConfigurationTextArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AgentPrompt("example", AgentPromptArgs.builder()
.name("MakePlaylist")
.description("My first prompt.")
.defaultVariant("Variant1")
.variants(AgentPromptVariantArgs.builder()
.name("Variant1")
.modelId("amazon.titan-text-express-v1")
.inferenceConfiguration(AgentPromptVariantInferenceConfigurationArgs.builder()
.text(AgentPromptVariantInferenceConfigurationTextArgs.builder()
.temperature(0.8)
.build())
.build())
.templateType("TEXT")
.templateConfiguration(AgentPromptVariantTemplateConfigurationArgs.builder()
.text(AgentPromptVariantTemplateConfigurationTextArgs.builder()
.text("Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.")
.inputVariables(
AgentPromptVariantTemplateConfigurationTextInputVariableArgs.builder()
.name("genre")
.build(),
AgentPromptVariantTemplateConfigurationTextInputVariableArgs.builder()
.name("number")
.build())
.build())
.build())
.build())
.build());
}
}
resources:
example:
type: aws:bedrock:AgentPrompt
properties:
name: MakePlaylist
description: My first prompt.
defaultVariant: Variant1
variants:
- name: Variant1
modelId: amazon.titan-text-express-v1
inferenceConfiguration:
text:
temperature: 0.8
templateType: TEXT
templateConfiguration:
text:
text: 'Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.'
inputVariables:
- name: genre
- name: number
Create AgentPrompt Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AgentPrompt(name: string, args?: AgentPromptArgs, opts?: CustomResourceOptions);
@overload
def AgentPrompt(resource_name: str,
args: Optional[AgentPromptArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def AgentPrompt(resource_name: str,
opts: Optional[ResourceOptions] = None,
customer_encryption_key_arn: Optional[str] = None,
default_variant: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
variants: Optional[Sequence[AgentPromptVariantArgs]] = None)
func NewAgentPrompt(ctx *Context, name string, args *AgentPromptArgs, opts ...ResourceOption) (*AgentPrompt, error)
public AgentPrompt(string name, AgentPromptArgs? args = null, CustomResourceOptions? opts = null)
public AgentPrompt(String name, AgentPromptArgs args)
public AgentPrompt(String name, AgentPromptArgs args, CustomResourceOptions options)
type: aws:bedrock:AgentPrompt
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AgentPromptArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AgentPromptArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AgentPromptArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AgentPromptArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AgentPromptArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var agentPromptResource = new Aws.Bedrock.AgentPrompt("agentPromptResource", new()
{
CustomerEncryptionKeyArn = "string",
DefaultVariant = "string",
Description = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
Variants = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantArgs
{
Name = "string",
TemplateType = "string",
AdditionalModelRequestFields = "string",
GenAiResource = new Aws.Bedrock.Inputs.AgentPromptVariantGenAiResourceArgs
{
Agent = new Aws.Bedrock.Inputs.AgentPromptVariantGenAiResourceAgentArgs
{
AgentIdentifier = "string",
},
},
InferenceConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationArgs
{
Text = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationTextArgs
{
MaxTokens = 0,
StopSequences = new[]
{
"string",
},
Temperature = 0,
TopP = 0,
},
},
Metadatas = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantMetadataArgs
{
Key = "string",
Value = "string",
},
},
ModelId = "string",
TemplateConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationArgs
{
Chat = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatArgs
{
InputVariables = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatInputVariableArgs
{
Name = "string",
},
},
Messages = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatMessageArgs
{
Role = "string",
Content = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatMessageContentArgs
{
CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs
{
Type = "string",
},
Text = "string",
},
},
},
Systems = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatSystemArgs
{
CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs
{
Type = "string",
},
Text = "string",
},
},
ToolConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs
{
ToolChoice = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs
{
Any = null,
Auto = null,
Tool = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs
{
Name = "string",
},
},
Tools = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs
{
CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs
{
Type = "string",
},
ToolSpec = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs
{
Name = "string",
Description = "string",
InputSchema = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs
{
Json = "string",
},
},
},
},
},
},
Text = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextArgs
{
Text = "string",
CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextCachePointArgs
{
Type = "string",
},
InputVariables = new[]
{
new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextInputVariableArgs
{
Name = "string",
},
},
},
},
},
},
});
example, err := bedrock.NewAgentPrompt(ctx, "agentPromptResource", &bedrock.AgentPromptArgs{
CustomerEncryptionKeyArn: pulumi.String("string"),
DefaultVariant: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Variants: bedrock.AgentPromptVariantArray{
&bedrock.AgentPromptVariantArgs{
Name: pulumi.String("string"),
TemplateType: pulumi.String("string"),
AdditionalModelRequestFields: pulumi.String("string"),
GenAiResource: &bedrock.AgentPromptVariantGenAiResourceArgs{
Agent: &bedrock.AgentPromptVariantGenAiResourceAgentArgs{
AgentIdentifier: pulumi.String("string"),
},
},
InferenceConfiguration: &bedrock.AgentPromptVariantInferenceConfigurationArgs{
Text: &bedrock.AgentPromptVariantInferenceConfigurationTextArgs{
MaxTokens: pulumi.Int(0),
StopSequences: pulumi.StringArray{
pulumi.String("string"),
},
Temperature: pulumi.Float64(0),
TopP: pulumi.Float64(0),
},
},
Metadatas: bedrock.AgentPromptVariantMetadataArray{
&bedrock.AgentPromptVariantMetadataArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ModelId: pulumi.String("string"),
TemplateConfiguration: &bedrock.AgentPromptVariantTemplateConfigurationArgs{
Chat: &bedrock.AgentPromptVariantTemplateConfigurationChatArgs{
InputVariables: bedrock.AgentPromptVariantTemplateConfigurationChatInputVariableArray{
&bedrock.AgentPromptVariantTemplateConfigurationChatInputVariableArgs{
Name: pulumi.String("string"),
},
},
Messages: bedrock.AgentPromptVariantTemplateConfigurationChatMessageArray{
&bedrock.AgentPromptVariantTemplateConfigurationChatMessageArgs{
Role: pulumi.String("string"),
Content: &bedrock.AgentPromptVariantTemplateConfigurationChatMessageContentArgs{
CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs{
Type: pulumi.String("string"),
},
Text: pulumi.String("string"),
},
},
},
Systems: bedrock.AgentPromptVariantTemplateConfigurationChatSystemArray{
&bedrock.AgentPromptVariantTemplateConfigurationChatSystemArgs{
CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs{
Type: pulumi.String("string"),
},
Text: pulumi.String("string"),
},
},
ToolConfiguration: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs{
ToolChoice: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs{
Any: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAnyArgs{},
Auto: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAutoArgs{},
Tool: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs{
Name: pulumi.String("string"),
},
},
Tools: bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArray{
&bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs{
CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs{
Type: pulumi.String("string"),
},
ToolSpec: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs{
Name: pulumi.String("string"),
Description: pulumi.String("string"),
InputSchema: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs{
Json: pulumi.String("string"),
},
},
},
},
},
},
Text: &bedrock.AgentPromptVariantTemplateConfigurationTextArgs{
Text: pulumi.String("string"),
CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationTextCachePointArgs{
Type: pulumi.String("string"),
},
InputVariables: bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArray{
&bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArgs{
Name: pulumi.String("string"),
},
},
},
},
},
},
})
var agentPromptResource = new AgentPrompt("agentPromptResource", AgentPromptArgs.builder()
.customerEncryptionKeyArn("string")
.defaultVariant("string")
.description("string")
.name("string")
.tags(Map.of("string", "string"))
.variants(AgentPromptVariantArgs.builder()
.name("string")
.templateType("string")
.additionalModelRequestFields("string")
.genAiResource(AgentPromptVariantGenAiResourceArgs.builder()
.agent(AgentPromptVariantGenAiResourceAgentArgs.builder()
.agentIdentifier("string")
.build())
.build())
.inferenceConfiguration(AgentPromptVariantInferenceConfigurationArgs.builder()
.text(AgentPromptVariantInferenceConfigurationTextArgs.builder()
.maxTokens(0)
.stopSequences("string")
.temperature(0.0)
.topP(0.0)
.build())
.build())
.metadatas(AgentPromptVariantMetadataArgs.builder()
.key("string")
.value("string")
.build())
.modelId("string")
.templateConfiguration(AgentPromptVariantTemplateConfigurationArgs.builder()
.chat(AgentPromptVariantTemplateConfigurationChatArgs.builder()
.inputVariables(AgentPromptVariantTemplateConfigurationChatInputVariableArgs.builder()
.name("string")
.build())
.messages(AgentPromptVariantTemplateConfigurationChatMessageArgs.builder()
.role("string")
.content(AgentPromptVariantTemplateConfigurationChatMessageContentArgs.builder()
.cachePoint(AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs.builder()
.type("string")
.build())
.text("string")
.build())
.build())
.systems(AgentPromptVariantTemplateConfigurationChatSystemArgs.builder()
.cachePoint(AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs.builder()
.type("string")
.build())
.text("string")
.build())
.toolConfiguration(AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs.builder()
.toolChoice(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs.builder()
.any(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAnyArgs.builder()
.build())
.auto(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAutoArgs.builder()
.build())
.tool(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs.builder()
.name("string")
.build())
.build())
.tools(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs.builder()
.cachePoint(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs.builder()
.type("string")
.build())
.toolSpec(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs.builder()
.name("string")
.description("string")
.inputSchema(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs.builder()
.json("string")
.build())
.build())
.build())
.build())
.build())
.text(AgentPromptVariantTemplateConfigurationTextArgs.builder()
.text("string")
.cachePoint(AgentPromptVariantTemplateConfigurationTextCachePointArgs.builder()
.type("string")
.build())
.inputVariables(AgentPromptVariantTemplateConfigurationTextInputVariableArgs.builder()
.name("string")
.build())
.build())
.build())
.build())
.build());
agent_prompt_resource = aws.bedrock.AgentPrompt("agentPromptResource",
customer_encryption_key_arn="string",
default_variant="string",
description="string",
name="string",
tags={
"string": "string",
},
variants=[{
"name": "string",
"template_type": "string",
"additional_model_request_fields": "string",
"gen_ai_resource": {
"agent": {
"agent_identifier": "string",
},
},
"inference_configuration": {
"text": {
"max_tokens": 0,
"stop_sequences": ["string"],
"temperature": 0,
"top_p": 0,
},
},
"metadatas": [{
"key": "string",
"value": "string",
}],
"model_id": "string",
"template_configuration": {
"chat": {
"input_variables": [{
"name": "string",
}],
"messages": [{
"role": "string",
"content": {
"cache_point": {
"type": "string",
},
"text": "string",
},
}],
"systems": [{
"cache_point": {
"type": "string",
},
"text": "string",
}],
"tool_configuration": {
"tool_choice": {
"any": {},
"auto": {},
"tool": {
"name": "string",
},
},
"tools": [{
"cache_point": {
"type": "string",
},
"tool_spec": {
"name": "string",
"description": "string",
"input_schema": {
"json": "string",
},
},
}],
},
},
"text": {
"text": "string",
"cache_point": {
"type": "string",
},
"input_variables": [{
"name": "string",
}],
},
},
}])
const agentPromptResource = new aws.bedrock.AgentPrompt("agentPromptResource", {
customerEncryptionKeyArn: "string",
defaultVariant: "string",
description: "string",
name: "string",
tags: {
string: "string",
},
variants: [{
name: "string",
templateType: "string",
additionalModelRequestFields: "string",
genAiResource: {
agent: {
agentIdentifier: "string",
},
},
inferenceConfiguration: {
text: {
maxTokens: 0,
stopSequences: ["string"],
temperature: 0,
topP: 0,
},
},
metadatas: [{
key: "string",
value: "string",
}],
modelId: "string",
templateConfiguration: {
chat: {
inputVariables: [{
name: "string",
}],
messages: [{
role: "string",
content: {
cachePoint: {
type: "string",
},
text: "string",
},
}],
systems: [{
cachePoint: {
type: "string",
},
text: "string",
}],
toolConfiguration: {
toolChoice: {
any: {},
auto: {},
tool: {
name: "string",
},
},
tools: [{
cachePoint: {
type: "string",
},
toolSpec: {
name: "string",
description: "string",
inputSchema: {
json: "string",
},
},
}],
},
},
text: {
text: "string",
cachePoint: {
type: "string",
},
inputVariables: [{
name: "string",
}],
},
},
}],
});
type: aws:bedrock:AgentPrompt
properties:
customerEncryptionKeyArn: string
defaultVariant: string
description: string
name: string
tags:
string: string
variants:
- additionalModelRequestFields: string
genAiResource:
agent:
agentIdentifier: string
inferenceConfiguration:
text:
maxTokens: 0
stopSequences:
- string
temperature: 0
topP: 0
metadatas:
- key: string
value: string
modelId: string
name: string
templateConfiguration:
chat:
inputVariables:
- name: string
messages:
- content:
cachePoint:
type: string
text: string
role: string
systems:
- cachePoint:
type: string
text: string
toolConfiguration:
toolChoice:
any: {}
auto: {}
tool:
name: string
tools:
- cachePoint:
type: string
toolSpec:
description: string
inputSchema:
json: string
name: string
text:
cachePoint:
type: string
inputVariables:
- name: string
text: string
templateType: string
AgentPrompt Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The AgentPrompt resource accepts the following input properties:
- Customer
Encryption stringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- Default
Variant string - Name of the default variant for your prompt.
- Description string
- Description of the prompt.
- Name string
Name of the prompt.
The following arguments are optional:
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Variants
List<Agent
Prompt Variant> - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- Customer
Encryption stringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- Default
Variant string - Name of the default variant for your prompt.
- Description string
- Description of the prompt.
- Name string
Name of the prompt.
The following arguments are optional:
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Variants
[]Agent
Prompt Variant Args - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- customer
Encryption StringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default
Variant String - Name of the default variant for your prompt.
- description String
- Description of the prompt.
- name String
Name of the prompt.
The following arguments are optional:
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - variants
List<Agent
Prompt Variant> - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- customer
Encryption stringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default
Variant string - Name of the default variant for your prompt.
- description string
- Description of the prompt.
- name string
Name of the prompt.
The following arguments are optional:
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - variants
Agent
Prompt Variant[] - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- customer_
encryption_ strkey_ arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default_
variant str - Name of the default variant for your prompt.
- description str
- Description of the prompt.
- name str
Name of the prompt.
The following arguments are optional:
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - variants
Sequence[Agent
Prompt Variant Args] - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- customer
Encryption StringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default
Variant String - Name of the default variant for your prompt.
- description String
- Description of the prompt.
- name String
Name of the prompt.
The following arguments are optional:
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - variants List<Property Map>
- A list of objects, each containing details about a variant of the prompt. See Variant for more information.
Outputs
All input properties are implicitly available as output properties. Additionally, the AgentPrompt resource produces the following output properties:
- Arn string
- Amazon Resource Name (ARN) of the prompt.
- Created
At string - Time at which the prompt was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Updated
At string - Time at which the prompt was last updated.
- Version string
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- Arn string
- Amazon Resource Name (ARN) of the prompt.
- Created
At string - Time at which the prompt was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Updated
At string - Time at which the prompt was last updated.
- Version string
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn String
- Amazon Resource Name (ARN) of the prompt.
- created
At String - Time at which the prompt was created.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated
At String - Time at which the prompt was last updated.
- version String
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn string
- Amazon Resource Name (ARN) of the prompt.
- created
At string - Time at which the prompt was created.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated
At string - Time at which the prompt was last updated.
- version string
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn str
- Amazon Resource Name (ARN) of the prompt.
- created_
at str - Time at which the prompt was created.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated_
at str - Time at which the prompt was last updated.
- version str
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn String
- Amazon Resource Name (ARN) of the prompt.
- created
At String - Time at which the prompt was created.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated
At String - Time at which the prompt was last updated.
- version String
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
Look up Existing AgentPrompt Resource
Get an existing AgentPrompt resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AgentPromptState, opts?: CustomResourceOptions): AgentPrompt
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
created_at: Optional[str] = None,
customer_encryption_key_arn: Optional[str] = None,
default_variant: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
updated_at: Optional[str] = None,
variants: Optional[Sequence[AgentPromptVariantArgs]] = None,
version: Optional[str] = None) -> AgentPrompt
func GetAgentPrompt(ctx *Context, name string, id IDInput, state *AgentPromptState, opts ...ResourceOption) (*AgentPrompt, error)
public static AgentPrompt Get(string name, Input<string> id, AgentPromptState? state, CustomResourceOptions? opts = null)
public static AgentPrompt get(String name, Output<String> id, AgentPromptState state, CustomResourceOptions options)
resources: _: type: aws:bedrock:AgentPrompt get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- Amazon Resource Name (ARN) of the prompt.
- Created
At string - Time at which the prompt was created.
- Customer
Encryption stringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- Default
Variant string - Name of the default variant for your prompt.
- Description string
- Description of the prompt.
- Name string
Name of the prompt.
The following arguments are optional:
- Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Updated
At string - Time at which the prompt was last updated.
- Variants
List<Agent
Prompt Variant> - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- Version string
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- Arn string
- Amazon Resource Name (ARN) of the prompt.
- Created
At string - Time at which the prompt was created.
- Customer
Encryption stringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- Default
Variant string - Name of the default variant for your prompt.
- Description string
- Description of the prompt.
- Name string
Name of the prompt.
The following arguments are optional:
- map[string]string
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Updated
At string - Time at which the prompt was last updated.
- Variants
[]Agent
Prompt Variant Args - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- Version string
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn String
- Amazon Resource Name (ARN) of the prompt.
- created
At String - Time at which the prompt was created.
- customer
Encryption StringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default
Variant String - Name of the default variant for your prompt.
- description String
- Description of the prompt.
- name String
Name of the prompt.
The following arguments are optional:
- Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated
At String - Time at which the prompt was last updated.
- variants
List<Agent
Prompt Variant> - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- version String
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn string
- Amazon Resource Name (ARN) of the prompt.
- created
At string - Time at which the prompt was created.
- customer
Encryption stringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default
Variant string - Name of the default variant for your prompt.
- description string
- Description of the prompt.
- name string
Name of the prompt.
The following arguments are optional:
- {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated
At string - Time at which the prompt was last updated.
- variants
Agent
Prompt Variant[] - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- version string
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn str
- Amazon Resource Name (ARN) of the prompt.
- created_
at str - Time at which the prompt was created.
- customer_
encryption_ strkey_ arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default_
variant str - Name of the default variant for your prompt.
- description str
- Description of the prompt.
- name str
Name of the prompt.
The following arguments are optional:
- Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated_
at str - Time at which the prompt was last updated.
- variants
Sequence[Agent
Prompt Variant Args] - A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- version str
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
- arn String
- Amazon Resource Name (ARN) of the prompt.
- created
At String - Time at which the prompt was created.
- customer
Encryption StringKey Arn - Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
- default
Variant String - Name of the default variant for your prompt.
- description String
- Description of the prompt.
- name String
Name of the prompt.
The following arguments are optional:
- Map<String>
- Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - updated
At String - Time at which the prompt was last updated.
- variants List<Property Map>
- A list of objects, each containing details about a variant of the prompt. See Variant for more information.
- version String
- Version of the prompt. When you create a prompt, the version created is the
DRAFT
version.
Supporting Types
AgentPromptVariant, AgentPromptVariantArgs
- Name string
- Name of the prompt variant.
- Template
Type string - Type of prompt template to use. Valid values:
CHAT
,TEXT
. - Additional
Model stringRequest Fields - Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
- Gen
Ai AgentResource Prompt Variant Gen Ai Resource - Specifies a generative AI resource with which to use the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. See Generative AI Resource for more information. - Inference
Configuration AgentPrompt Variant Inference Configuration - Contains inference configurations for the prompt variant. See Inference Configuration for more information.
- Metadatas
List<Agent
Prompt Variant Metadata> - A list of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See Metadata for more information.
- Model
Id string - Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. - Template
Configuration AgentPrompt Variant Template Configuration - Contains configurations for the prompt template. See Template Configuration for more information.
- Name string
- Name of the prompt variant.
- Template
Type string - Type of prompt template to use. Valid values:
CHAT
,TEXT
. - Additional
Model stringRequest Fields - Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
- Gen
Ai AgentResource Prompt Variant Gen Ai Resource - Specifies a generative AI resource with which to use the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. See Generative AI Resource for more information. - Inference
Configuration AgentPrompt Variant Inference Configuration - Contains inference configurations for the prompt variant. See Inference Configuration for more information.
- Metadatas
[]Agent
Prompt Variant Metadata - A list of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See Metadata for more information.
- Model
Id string - Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. - Template
Configuration AgentPrompt Variant Template Configuration - Contains configurations for the prompt template. See Template Configuration for more information.
- name String
- Name of the prompt variant.
- template
Type String - Type of prompt template to use. Valid values:
CHAT
,TEXT
. - additional
Model StringRequest Fields - Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
- gen
Ai AgentResource Prompt Variant Gen Ai Resource - Specifies a generative AI resource with which to use the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. See Generative AI Resource for more information. - inference
Configuration AgentPrompt Variant Inference Configuration - Contains inference configurations for the prompt variant. See Inference Configuration for more information.
- metadatas
List<Agent
Prompt Variant Metadata> - A list of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See Metadata for more information.
- model
Id String - Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. - template
Configuration AgentPrompt Variant Template Configuration - Contains configurations for the prompt template. See Template Configuration for more information.
- name string
- Name of the prompt variant.
- template
Type string - Type of prompt template to use. Valid values:
CHAT
,TEXT
. - additional
Model stringRequest Fields - Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
- gen
Ai AgentResource Prompt Variant Gen Ai Resource - Specifies a generative AI resource with which to use the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. See Generative AI Resource for more information. - inference
Configuration AgentPrompt Variant Inference Configuration - Contains inference configurations for the prompt variant. See Inference Configuration for more information.
- metadatas
Agent
Prompt Variant Metadata[] - A list of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See Metadata for more information.
- model
Id string - Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. - template
Configuration AgentPrompt Variant Template Configuration - Contains configurations for the prompt template. See Template Configuration for more information.
- name str
- Name of the prompt variant.
- template_
type str - Type of prompt template to use. Valid values:
CHAT
,TEXT
. - additional_
model_ strrequest_ fields - Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
- gen_
ai_ Agentresource Prompt Variant Gen Ai Resource - Specifies a generative AI resource with which to use the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. See Generative AI Resource for more information. - inference_
configuration AgentPrompt Variant Inference Configuration - Contains inference configurations for the prompt variant. See Inference Configuration for more information.
- metadatas
Sequence[Agent
Prompt Variant Metadata] - A list of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See Metadata for more information.
- model_
id str - Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. - template_
configuration AgentPrompt Variant Template Configuration - Contains configurations for the prompt template. See Template Configuration for more information.
- name String
- Name of the prompt variant.
- template
Type String - Type of prompt template to use. Valid values:
CHAT
,TEXT
. - additional
Model StringRequest Fields - Contains model-specific inference configurations that aren’t in the inferenceConfiguration field. To see model-specific inference parameters, see Inference request parameters and response fields for foundation models.
- gen
Ai Property MapResource - Specifies a generative AI resource with which to use the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. See Generative AI Resource for more information. - inference
Configuration Property Map - Contains inference configurations for the prompt variant. See Inference Configuration for more information.
- metadatas List<Property Map>
- A list of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See Metadata for more information.
- model
Id String - Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a
gen_ai_resource
must be defined. - template
Configuration Property Map - Contains configurations for the prompt template. See Template Configuration for more information.
AgentPromptVariantGenAiResource, AgentPromptVariantGenAiResourceArgs
- Agent
Agent
Prompt Variant Gen Ai Resource Agent - Specifies an Amazon Bedrock agent with which to use the prompt. See Agent Configuration for more information.
- Agent
Agent
Prompt Variant Gen Ai Resource Agent - Specifies an Amazon Bedrock agent with which to use the prompt. See Agent Configuration for more information.
- agent
Agent
Prompt Variant Gen Ai Resource Agent - Specifies an Amazon Bedrock agent with which to use the prompt. See Agent Configuration for more information.
- agent
Agent
Prompt Variant Gen Ai Resource Agent - Specifies an Amazon Bedrock agent with which to use the prompt. See Agent Configuration for more information.
- agent
Agent
Prompt Variant Gen Ai Resource Agent - Specifies an Amazon Bedrock agent with which to use the prompt. See Agent Configuration for more information.
- agent Property Map
- Specifies an Amazon Bedrock agent with which to use the prompt. See Agent Configuration for more information.
AgentPromptVariantGenAiResourceAgent, AgentPromptVariantGenAiResourceAgentArgs
- Agent
Identifier string - ARN of the agent with which to use the prompt.
- Agent
Identifier string - ARN of the agent with which to use the prompt.
- agent
Identifier String - ARN of the agent with which to use the prompt.
- agent
Identifier string - ARN of the agent with which to use the prompt.
- agent_
identifier str - ARN of the agent with which to use the prompt.
- agent
Identifier String - ARN of the agent with which to use the prompt.
AgentPromptVariantInferenceConfiguration, AgentPromptVariantInferenceConfigurationArgs
- Text
Agent
Prompt Variant Inference Configuration Text - Contains inference configurations for the prompt variant. See Text Inference Configuration for more information.
- Text
Agent
Prompt Variant Inference Configuration Text - Contains inference configurations for the prompt variant. See Text Inference Configuration for more information.
- text
Agent
Prompt Variant Inference Configuration Text - Contains inference configurations for the prompt variant. See Text Inference Configuration for more information.
- text
Agent
Prompt Variant Inference Configuration Text - Contains inference configurations for the prompt variant. See Text Inference Configuration for more information.
- text
Agent
Prompt Variant Inference Configuration Text - Contains inference configurations for the prompt variant. See Text Inference Configuration for more information.
- text Property Map
- Contains inference configurations for the prompt variant. See Text Inference Configuration for more information.
AgentPromptVariantInferenceConfigurationText, AgentPromptVariantInferenceConfigurationTextArgs
- Max
Tokens int - Maximum number of tokens to return in the response.
- Stop
Sequences List<string> - List of strings that define sequences after which the model will stop generating.
- Temperature double
- Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
- Top
P double - Percentage of most-likely candidates that the model considers for the next token.
- Max
Tokens int - Maximum number of tokens to return in the response.
- Stop
Sequences []string - List of strings that define sequences after which the model will stop generating.
- Temperature float64
- Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
- Top
P float64 - Percentage of most-likely candidates that the model considers for the next token.
- max
Tokens Integer - Maximum number of tokens to return in the response.
- stop
Sequences List<String> - List of strings that define sequences after which the model will stop generating.
- temperature Double
- Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
- top
P Double - Percentage of most-likely candidates that the model considers for the next token.
- max
Tokens number - Maximum number of tokens to return in the response.
- stop
Sequences string[] - List of strings that define sequences after which the model will stop generating.
- temperature number
- Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
- top
P number - Percentage of most-likely candidates that the model considers for the next token.
- max_
tokens int - Maximum number of tokens to return in the response.
- stop_
sequences Sequence[str] - List of strings that define sequences after which the model will stop generating.
- temperature float
- Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
- top_
p float - Percentage of most-likely candidates that the model considers for the next token.
- max
Tokens Number - Maximum number of tokens to return in the response.
- stop
Sequences List<String> - List of strings that define sequences after which the model will stop generating.
- temperature Number
- Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
- top
P Number - Percentage of most-likely candidates that the model considers for the next token.
AgentPromptVariantMetadata, AgentPromptVariantMetadataArgs
AgentPromptVariantTemplateConfiguration, AgentPromptVariantTemplateConfigurationArgs
- Chat
Agent
Prompt Variant Template Configuration Chat - Contains configurations to use the prompt in a conversational format. See Chat Template Configuration for more information.
- Text
Agent
Prompt Variant Template Configuration Text - Contains configurations for the text in a message for a prompt. See Text Template Configuration
- Chat
Agent
Prompt Variant Template Configuration Chat - Contains configurations to use the prompt in a conversational format. See Chat Template Configuration for more information.
- Text
Agent
Prompt Variant Template Configuration Text - Contains configurations for the text in a message for a prompt. See Text Template Configuration
- chat
Agent
Prompt Variant Template Configuration Chat - Contains configurations to use the prompt in a conversational format. See Chat Template Configuration for more information.
- text
Agent
Prompt Variant Template Configuration Text - Contains configurations for the text in a message for a prompt. See Text Template Configuration
- chat
Agent
Prompt Variant Template Configuration Chat - Contains configurations to use the prompt in a conversational format. See Chat Template Configuration for more information.
- text
Agent
Prompt Variant Template Configuration Text - Contains configurations for the text in a message for a prompt. See Text Template Configuration
- chat
Agent
Prompt Variant Template Configuration Chat - Contains configurations to use the prompt in a conversational format. See Chat Template Configuration for more information.
- text
Agent
Prompt Variant Template Configuration Text - Contains configurations for the text in a message for a prompt. See Text Template Configuration
- chat Property Map
- Contains configurations to use the prompt in a conversational format. See Chat Template Configuration for more information.
- text Property Map
- Contains configurations for the text in a message for a prompt. See Text Template Configuration
AgentPromptVariantTemplateConfigurationChat, AgentPromptVariantTemplateConfigurationChatArgs
- Input
Variables List<AgentPrompt Variant Template Configuration Chat Input Variable> - Messages
List<Agent
Prompt Variant Template Configuration Chat Message> - A list of messages in the chat for the prompt. See Message for more information.
- Systems
List<Agent
Prompt Variant Template Configuration Chat System> - A list of system prompts to provide context to the model or to describe how it should behave. See System for more information.
- Tool
Configuration AgentPrompt Variant Template Configuration Chat Tool Configuration - Configuration information for the tools that the model can use when generating a response. See Tool Configuration for more information.
- Input
Variables []AgentPrompt Variant Template Configuration Chat Input Variable - Messages
[]Agent
Prompt Variant Template Configuration Chat Message - A list of messages in the chat for the prompt. See Message for more information.
- Systems
[]Agent
Prompt Variant Template Configuration Chat System - A list of system prompts to provide context to the model or to describe how it should behave. See System for more information.
- Tool
Configuration AgentPrompt Variant Template Configuration Chat Tool Configuration - Configuration information for the tools that the model can use when generating a response. See Tool Configuration for more information.
- input
Variables List<AgentPrompt Variant Template Configuration Chat Input Variable> - messages
List<Agent
Prompt Variant Template Configuration Chat Message> - A list of messages in the chat for the prompt. See Message for more information.
- systems
List<Agent
Prompt Variant Template Configuration Chat System> - A list of system prompts to provide context to the model or to describe how it should behave. See System for more information.
- tool
Configuration AgentPrompt Variant Template Configuration Chat Tool Configuration - Configuration information for the tools that the model can use when generating a response. See Tool Configuration for more information.
- input
Variables AgentPrompt Variant Template Configuration Chat Input Variable[] - messages
Agent
Prompt Variant Template Configuration Chat Message[] - A list of messages in the chat for the prompt. See Message for more information.
- systems
Agent
Prompt Variant Template Configuration Chat System[] - A list of system prompts to provide context to the model or to describe how it should behave. See System for more information.
- tool
Configuration AgentPrompt Variant Template Configuration Chat Tool Configuration - Configuration information for the tools that the model can use when generating a response. See Tool Configuration for more information.
- input_
variables Sequence[AgentPrompt Variant Template Configuration Chat Input Variable] - messages
Sequence[Agent
Prompt Variant Template Configuration Chat Message] - A list of messages in the chat for the prompt. See Message for more information.
- systems
Sequence[Agent
Prompt Variant Template Configuration Chat System] - A list of system prompts to provide context to the model or to describe how it should behave. See System for more information.
- tool_
configuration AgentPrompt Variant Template Configuration Chat Tool Configuration - Configuration information for the tools that the model can use when generating a response. See Tool Configuration for more information.
- input
Variables List<Property Map> - messages List<Property Map>
- A list of messages in the chat for the prompt. See Message for more information.
- systems List<Property Map>
- A list of system prompts to provide context to the model or to describe how it should behave. See System for more information.
- tool
Configuration Property Map - Configuration information for the tools that the model can use when generating a response. See Tool Configuration for more information.
AgentPromptVariantTemplateConfigurationChatInputVariable, AgentPromptVariantTemplateConfigurationChatInputVariableArgs
- Name string
- The name of the variable.
- Name string
- The name of the variable.
- name String
- The name of the variable.
- name string
- The name of the variable.
- name str
- The name of the variable.
- name String
- The name of the variable.
AgentPromptVariantTemplateConfigurationChatMessage, AgentPromptVariantTemplateConfigurationChatMessageArgs
- Role string
- The role that the message belongs to.
- Content
Agent
Prompt Variant Template Configuration Chat Message Content - Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information.
- Role string
- The role that the message belongs to.
- Content
Agent
Prompt Variant Template Configuration Chat Message Content - Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information.
- role String
- The role that the message belongs to.
- content
Agent
Prompt Variant Template Configuration Chat Message Content - Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information.
- role string
- The role that the message belongs to.
- content
Agent
Prompt Variant Template Configuration Chat Message Content - Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information.
- role str
- The role that the message belongs to.
- content
Agent
Prompt Variant Template Configuration Chat Message Content - Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information.
- role String
- The role that the message belongs to.
- content Property Map
- Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information.
AgentPromptVariantTemplateConfigurationChatMessageContent, AgentPromptVariantTemplateConfigurationChatMessageContentArgs
- cache
Point Property Map - text String
AgentPromptVariantTemplateConfigurationChatMessageContentCachePoint, AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type str
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
AgentPromptVariantTemplateConfigurationChatSystem, AgentPromptVariantTemplateConfigurationChatSystemArgs
- Cache
Point AgentPrompt Variant Template Configuration Chat System Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- Text string
- The text in the system prompt.
- Cache
Point AgentPrompt Variant Template Configuration Chat System Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- Text string
- The text in the system prompt.
- cache
Point AgentPrompt Variant Template Configuration Chat System Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- text String
- The text in the system prompt.
- cache
Point AgentPrompt Variant Template Configuration Chat System Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- text string
- The text in the system prompt.
- cache_
point AgentPrompt Variant Template Configuration Chat System Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- text str
- The text in the system prompt.
- cache
Point Property Map - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- text String
- The text in the system prompt.
AgentPromptVariantTemplateConfigurationChatSystemCachePoint, AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type str
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
AgentPromptVariantTemplateConfigurationChatToolConfiguration, AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs
- Tool
Choice AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Choice - Defines which tools the model should request when invoked. See Tool Choice for more information.
- Tools
List<Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool> - A list of tools to pass to a model. See Tool for more information.
- Tool
Choice AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Choice - Defines which tools the model should request when invoked. See Tool Choice for more information.
- Tools
[]Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool - A list of tools to pass to a model. See Tool for more information.
- tool
Choice AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Choice - Defines which tools the model should request when invoked. See Tool Choice for more information.
- tools
List<Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool> - A list of tools to pass to a model. See Tool for more information.
- tool
Choice AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Choice - Defines which tools the model should request when invoked. See Tool Choice for more information.
- tools
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool[] - A list of tools to pass to a model. See Tool for more information.
- tool_
choice AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Choice - Defines which tools the model should request when invoked. See Tool Choice for more information.
- tools
Sequence[Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool] - A list of tools to pass to a model. See Tool for more information.
- tool
Choice Property Map - Defines which tools the model should request when invoked. See Tool Choice for more information.
- tools List<Property Map>
- A list of tools to pass to a model. See Tool for more information.
AgentPromptVariantTemplateConfigurationChatToolConfigurationTool, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs
- Cache
Point AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- Tool
Spec AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec - The specification for the tool. See Tool Specification for more information.
- Cache
Point AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- Tool
Spec AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec - The specification for the tool. See Tool Specification for more information.
- cache
Point AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- tool
Spec AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec - The specification for the tool. See Tool Specification for more information.
- cache
Point AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- tool
Spec AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec - The specification for the tool. See Tool Specification for more information.
- cache_
point AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Cache Point - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- tool_
spec AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec - The specification for the tool. See Tool Specification for more information.
- cache
Point Property Map - Creates a cache checkpoint within a tool designation. See Cache Point for more information.
- tool
Spec Property Map - The specification for the tool. See Tool Specification for more information.
AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePoint, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type str
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoice, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs
- Any
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Any - Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
- Auto
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Auto - Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields.
- Tool
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Tool - Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See Named Tool for more information.
- Any
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Any - Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
- Auto
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Auto - Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields.
- Tool
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Tool - Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See Named Tool for more information.
- any
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Any - Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
- auto
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Auto - Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields.
- tool
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Tool - Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See Named Tool for more information.
- any
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Any - Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
- auto
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Auto - Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields.
- tool
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Tool - Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See Named Tool for more information.
- any
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Any - Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
- auto
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Auto - Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields.
- tool
Agent
Prompt Variant Template Configuration Chat Tool Configuration Tool Choice Tool - Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See Named Tool for more information.
- any Property Map
- Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
- auto Property Map
- Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields.
- tool Property Map
- Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See Named Tool for more information.
AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceTool, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs
- Name string
Name of the prompt.
The following arguments are optional:
- Name string
Name of the prompt.
The following arguments are optional:
- name String
Name of the prompt.
The following arguments are optional:
- name string
Name of the prompt.
The following arguments are optional:
- name str
Name of the prompt.
The following arguments are optional:
- name String
Name of the prompt.
The following arguments are optional:
AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpec, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs
- Name string
Name of the prompt.
The following arguments are optional:
- Description string
- Description of the prompt.
- Input
Schema AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec Input Schema - The input schema of the tool. See Tool Input Schema for more information.
- Name string
Name of the prompt.
The following arguments are optional:
- Description string
- Description of the prompt.
- Input
Schema AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec Input Schema - The input schema of the tool. See Tool Input Schema for more information.
- name String
Name of the prompt.
The following arguments are optional:
- description String
- Description of the prompt.
- input
Schema AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec Input Schema - The input schema of the tool. See Tool Input Schema for more information.
- name string
Name of the prompt.
The following arguments are optional:
- description string
- Description of the prompt.
- input
Schema AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec Input Schema - The input schema of the tool. See Tool Input Schema for more information.
- name str
Name of the prompt.
The following arguments are optional:
- description str
- Description of the prompt.
- input_
schema AgentPrompt Variant Template Configuration Chat Tool Configuration Tool Tool Spec Input Schema - The input schema of the tool. See Tool Input Schema for more information.
- name String
Name of the prompt.
The following arguments are optional:
- description String
- Description of the prompt.
- input
Schema Property Map - The input schema of the tool. See Tool Input Schema for more information.
AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchema, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs
- Json string
- A JSON object defining the input schema for the tool.
- Json string
- A JSON object defining the input schema for the tool.
- json String
- A JSON object defining the input schema for the tool.
- json string
- A JSON object defining the input schema for the tool.
- json str
- A JSON object defining the input schema for the tool.
- json String
- A JSON object defining the input schema for the tool.
AgentPromptVariantTemplateConfigurationText, AgentPromptVariantTemplateConfigurationTextArgs
AgentPromptVariantTemplateConfigurationTextCachePoint, AgentPromptVariantTemplateConfigurationTextCachePointArgs
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- Type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type string
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type str
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
- type String
- Indicates that the CachePointBlock is of the default type. Valid values:
default
.
AgentPromptVariantTemplateConfigurationTextInputVariable, AgentPromptVariantTemplateConfigurationTextInputVariableArgs
- Name string
- The name of the variable.
- Name string
- The name of the variable.
- name String
- The name of the variable.
- name string
- The name of the variable.
- name str
- The name of the variable.
- name String
- The name of the variable.
Import
Using pulumi import
, import Bedrock Agents Prompt using the id
. For example:
$ pulumi import aws:bedrock/agentPrompt:AgentPrompt example 1A2BC3DEFG
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.