Client

bedrockagentruntime

R Documentation

Agents for Amazon Bedrock Runtime

Description

Contains APIs related to model invocation and querying of knowledge bases.

Usage

bedrockagentruntime(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- bedrockagentruntime(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

delete_agent_memory	Deletes memory from the specified memory identifier
generate_query	Generates an SQL query from a natural language query
get_agent_memory	Gets the sessions stored in the memory of the agent
invoke_agent	Sends a prompt for the agent to process and respond to
invoke_flow	Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream
invoke_inline_agent	Invokes an inline Amazon Bedrock agent using the configurations you provide with the request
optimize_prompt	Optimizes a prompt for the task that you specify
rerank	Reranks the relevance of sources based on queries
retrieve	Queries a knowledge base and retrieves information from it
retrieve_and_generate	Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile
retrieve_and_generate_stream	Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format

Examples

## Not run: 
svc <- bedrockagentruntime()
svc$delete_agent_memory(
  Foo = 123
)

## End(Not run)