bedrockagentruntime_invoke_inline_agent: Invokes an inline Amazon Bedrock agent using the...

View source: R/bedrockagentruntime_operations.R

bedrockagentruntime_invoke_inline_agentR Documentation

Invokes an inline Amazon Bedrock agent using the configurations you provide with the request

Description

Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.

See https://www.paws-r-sdk.com/docs/bedrockagentruntime_invoke_inline_agent/ for full documentation.

Usage

bedrockagentruntime_invoke_inline_agent(
  actionGroups = NULL,
  bedrockModelConfigurations = NULL,
  customerEncryptionKeyArn = NULL,
  enableTrace = NULL,
  endSession = NULL,
  foundationModel,
  guardrailConfiguration = NULL,
  idleSessionTTLInSeconds = NULL,
  inlineSessionState = NULL,
  inputText = NULL,
  instruction,
  knowledgeBases = NULL,
  promptOverrideConfiguration = NULL,
  sessionId,
  streamingConfigurations = NULL
)

Arguments

actionGroups

A list of action groups with each action group defining the action the inline agent needs to carry out.

bedrockModelConfigurations

Model settings for the request.

customerEncryptionKeyArn

The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.

enableTrace

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.

 </p>
endSession

Specifies whether to end the session with the inline agent or not.

foundationModel

[required] The model identifier (ID) of the model to use for orchestration by the inline agent. For example, ⁠meta.llama3-1-70b-instruct-v1:0⁠.

guardrailConfiguration

The guardrails to assign to the inline agent.

idleSessionTTLInSeconds

The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent invoke_inline_agent request begins a new session.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and the data provided before the timeout is deleted.

inlineSessionState

Parameters that specify the various attributes of a sessions. You can include attributes for the session or prompt or, if you configured an action group to return control, results from invocation of the action group. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

inputText

The prompt text to send to the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

instruction

[required] The instructions that tell the inline agent what it should do and how it should interact with users.

knowledgeBases

Contains information of the knowledge bases to associate with.

promptOverrideConfiguration

Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.

sessionId

[required] The unique identifier of the session. Use the same value across requests to continue the same conversation.

streamingConfigurations

Specifies the configurations for streaming.

To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream action.


paws.machine.learning documentation built on April 3, 2025, 8:41 p.m.