Skip to content

Latest commit

 

History

History
209 lines (120 loc) · 3.22 KB

AgentProps.md

File metadata and controls

209 lines (120 loc) · 3.22 KB
Raw

@cdklabs/generative-ai-cdk-constructs • Docs

@cdklabs/generative-ai-cdk-constructs / bedrock / AgentProps

Interface: AgentProps

Properties for a Bedrock Agent.

Properties

actionGroups?

readonly optional actionGroups: AgentActionGroup[]

AgentActionGroup to make available to the agent.

Default

- No AgentActionGroup  is used.

aliasName?

readonly optional aliasName: string

Name of the alias for the agent.

Default

- No alias is created.

description?

readonly optional description: string

A description of the agent.

Default

- No description is provided.

enableUserInput?

readonly optional enableUserInput: boolean

Select whether the agent can prompt additional information from the user when it does not have enough information to respond to an utterance

Default

- False

encryptionKey?

readonly optional encryptionKey: IKey

KMS encryption key to use for the agent.

Default

- An AWS managed key is used.

existingRole?

readonly optional existingRole: Role

The existing IAM Role for the agent with a trust policy that allows the Bedrock service to assume the role.

foundationModel

readonly foundationModel: BedrockFoundationModel

The Bedrock text foundation model for the agent to use.

guardrailConfiguration?

readonly optional guardrailConfiguration: GuardrailConfiguration

Guardrail configuration

Warning: If you provide a guardrail configuration through the constructor, you will need to provide the correct permissions for your agent to access the guardrails. If you want the permissions to be configured on your behalf, use the addGuardrail method.

Default

- No guardrails associated to the agent.

idleSessionTTL?

readonly optional idleSessionTTL: Duration

How long sessions should be kept open for the agent.

Default

- 1 hour

instruction

readonly instruction: string

A narrative instruction to provide the agent as context.

knowledgeBases?

readonly optional knowledgeBases: KnowledgeBase[]

Knowledge Bases to make available to the agent.

Default

- No knowledge base is used.

name?

readonly optional name: string

The name of the agent.

Default

- A name is automatically generated.

promptOverrideConfiguration?

readonly optional promptOverrideConfiguration: PromptOverrideConfiguration

Overrides for the agent.

Default

- No overrides are provided.

shouldPrepareAgent?

readonly optional shouldPrepareAgent: boolean

Whether to prepare the agent for use.

Default

- false

tags?

readonly optional tags: Record<string, string>

OPTIONAL: Tag (KEY-VALUE) bedrock agent resource

Default

- false