Class: Aws::BedrockAgentRuntime::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BedrockAgentRuntime::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb
Overview
An API client for BedrockAgentRuntime. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::BedrockAgentRuntime::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_invocation(params = {}) ⇒ Types::CreateInvocationResponse
Creates a new invocation within a session.
-
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex.
-
#delete_agent_memory(params = {}) ⇒ Struct
Deletes memory from the specified memory identifier.
-
#delete_session(params = {}) ⇒ Struct
Deletes a session that you ended.
-
#end_session(params = {}) ⇒ Types::EndSessionResponse
Ends the session.
-
#generate_query(params = {}) ⇒ Types::GenerateQueryResponse
Generates an SQL query from a natural language query.
-
#get_agent_memory(params = {}) ⇒ Types::GetAgentMemoryResponse
Gets the sessions stored in the memory of the agent.
-
#get_invocation_step(params = {}) ⇒ Types::GetInvocationStepResponse
Retrieves the details of a specific invocation step within an invocation in a session.
-
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves details about a specific session.
-
#invoke_agent(params = {}) ⇒ Types::InvokeAgentResponse
-
#invoke_flow(params = {}) ⇒ Types::InvokeFlowResponse
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(params = {}) ⇒ Types::InvokeInlineAgentResponse
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
-
#list_invocation_steps(params = {}) ⇒ Types::ListInvocationStepsResponse
Lists all invocation steps associated with a session and optionally, an invocation within the session.
-
#list_invocations(params = {}) ⇒ Types::ListInvocationsResponse
Lists all invocations associated with a specific session.
-
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Lists all sessions in your Amazon Web Services account.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all the tags for the resource you specify.
-
#optimize_prompt(params = {}) ⇒ Types::OptimizePromptResponse
Optimizes a prompt for the task that you specify.
-
#put_invocation_step(params = {}) ⇒ Types::PutInvocationStepResponse
Add an invocation step to an invocation in a session.
-
#rerank(params = {}) ⇒ Types::RerankResponse
Reranks the relevance of sources based on queries.
-
#retrieve(params = {}) ⇒ Types::RetrieveResponse
Queries a knowledge base and retrieves information from it.
-
#retrieve_and_generate(params = {}) ⇒ Types::RetrieveAndGenerateResponse
Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or [inference profile][1].
-
#retrieve_and_generate_stream(params = {}) ⇒ Types::RetrieveAndGenerateStreamResponse
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
-
#tag_resource(params = {}) ⇒ Struct
Associate tags with a resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
-
#update_session(params = {}) ⇒ Types::UpdateSessionResponse
Updates the metadata or encryption settings of a session.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
Parameters:
- options (Hash)
Options Hash (options):
-
:plugins
(Array<Seahorse::Client::Plugin>)
— default:
[]]
—
A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.
-
:credentials
(required, Aws::CredentialProvider)
—
Your AWS credentials. This can be an instance of any one of the following classes:
Aws::Credentials
- Used for configuring static, non-refreshing credentials.Aws::SharedCredentials
- Used for loading static credentials from a shared file, such as~/.aws/config
.Aws::AssumeRoleCredentials
- Used when you need to assume a role.Aws::AssumeRoleWebIdentityCredentials
- Used when you need to assume a role after providing credentials via the web.Aws::SSOCredentials
- Used for loading credentials from AWS SSO using an access token generated fromaws login
.Aws::ProcessCredentials
- Used for loading credentials from a process that outputs to stdout.Aws::InstanceProfileCredentials
- Used for loading credentials from an EC2 IMDS on an EC2 instance.Aws::ECSCredentials
- Used for loading credentials from instances running in ECS.Aws::CognitoIdentityCredentials
- Used for loading credentials from the Cognito Identity service.
When
:credentials
are not configured directly, the following locations will be searched for credentials:Aws.config[:credentials]
- The
:access_key_id
,:secret_access_key
,:session_token
, and:account_id
options. - ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
~/.aws/credentials
~/.aws/config
- EC2/ECS IMDS instance profile - When used by default, the timeouts
are very aggressive. Construct and pass an instance of
Aws::InstanceProfileCredentials
orAws::ECSCredentials
to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
-
:region
(required, String)
—
The AWS region to connect to. The configured
:region
is used to determine the service:endpoint
. When not passed, a default:region
is searched for in the following locations:Aws.config[:region]
ENV['AWS_REGION']
ENV['AMAZON_REGION']
ENV['AWS_DEFAULT_REGION']
~/.aws/credentials
~/.aws/config
- :access_key_id (String)
- :account_id (String)
-
:active_endpoint_cache
(Boolean)
— default:
false
—
When set to
true
, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults tofalse
. -
:adaptive_retry_wait_to_fill
(Boolean)
— default:
true
—
Used only in
adaptive
retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise aRetryCapacityNotAvailableError
and will not retry instead of sleeping. -
:client_side_monitoring
(Boolean)
— default:
false
—
When
true
, client-side metrics will be collected for all API requests from this client. -
:client_side_monitoring_client_id
(String)
— default:
""
—
Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.
-
:client_side_monitoring_host
(String)
— default:
"127.0.0.1"
—
Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_port
(Integer)
— default:
31000
—
Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.
-
:client_side_monitoring_publisher
(Aws::ClientSideMonitoring::Publisher)
— default:
Aws::ClientSideMonitoring::Publisher
—
Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.
-
:convert_params
(Boolean)
— default:
true
—
When
true
, an attempt is made to coerce request parameters into the required types. -
:correct_clock_skew
(Boolean)
— default:
true
—
Used only in
standard
and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks. -
:defaults_mode
(String)
— default:
"legacy"
—
See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.
-
:disable_host_prefix_injection
(Boolean)
— default:
false
—
Set to true to disable SDK automatically adding host prefix to default service endpoint when available.
-
:disable_request_compression
(Boolean)
— default:
false
—
When set to 'true' the request body will not be compressed for supported operations.
-
:endpoint
(String, URI::HTTPS, URI::HTTP)
—
Normally you should not configure the
:endpoint
option directly. This is normally constructed from the:region
option. Configuring:endpoint
is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:'http://example.com' 'https://example.com' 'http://example.com:123'
-
:endpoint_cache_max_entries
(Integer)
— default:
1000
—
Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.
-
:endpoint_cache_max_threads
(Integer)
— default:
10
—
Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
-
:endpoint_cache_poll_interval
(Integer)
— default:
60
—
When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.
-
:endpoint_discovery
(Boolean)
— default:
false
—
When set to
true
, endpoint discovery will be enabled for operations when available. -
:event_stream_handler
(Proc)
—
When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
-
:ignore_configured_endpoint_urls
(Boolean)
—
Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.
-
:input_event_stream_handler
(Proc)
—
When an EventStream or Proc object is provided, it can be used for sending events for the event stream.
-
:log_formatter
(Aws::Log::Formatter)
— default:
Aws::Log::Formatter.default
—
The log formatter.
-
:log_level
(Symbol)
— default:
:info
—
The log level to send messages to the
:logger
at. -
:logger
(Logger)
—
The Logger instance to send log messages to. If this option is not set, logging will be disabled.
-
:max_attempts
(Integer)
— default:
3
—
An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in
standard
andadaptive
retry modes. -
:output_event_stream_handler
(Proc)
—
When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
-
:profile
(String)
— default:
"default"
—
Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.
-
:request_checksum_calculation
(String)
— default:
"when_supported"
—
Determines when a checksum will be calculated for request payloads. Values are:
when_supported
- (default) When set, a checksum will be calculated for all request payloads of operations modeled with thehttpChecksum
trait whererequestChecksumRequired
istrue
and/or arequestAlgorithmMember
is modeled.when_required
- When set, a checksum will only be calculated for request payloads of operations modeled with thehttpChecksum
trait whererequestChecksumRequired
istrue
or where arequestAlgorithmMember
is modeled and supplied.
-
:request_min_compression_size_bytes
(Integer)
— default:
10240
—
The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.
-
:response_checksum_validation
(String)
— default:
"when_supported"
—
Determines when checksum validation will be performed on response payloads. Values are:
when_supported
- (default) When set, checksum validation is performed on all response payloads of operations modeled with thehttpChecksum
trait whereresponseAlgorithms
is modeled, except when no modeled checksum algorithms are supported.when_required
- When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and therequestValidationModeMember
member is set toENABLED
.
-
:retry_backoff
(Proc)
—
A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the
legacy
retry mode. -
:retry_base_delay
(Float)
— default:
0.3
—
The base delay in seconds used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_jitter
(Symbol)
— default:
:none
—
A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the
legacy
retry mode.@see https://www.awsarchitectureblog.com/2015/03/backoff.html
-
:retry_limit
(Integer)
— default:
3
—
The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the
legacy
retry mode. -
:retry_max_delay
(Integer)
— default:
0
—
The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the
legacy
retry mode. -
:retry_mode
(String)
— default:
"legacy"
—
Specifies which retry algorithm to use. Values are:
legacy
- The pre-existing retry behavior. This is default value if no retry mode is provided.standard
- A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.adaptive
- An experimental retry mode that includes all the functionality ofstandard
mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.
-
:sdk_ua_app_id
(String)
—
A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
- :secret_access_key (String)
- :session_token (String)
-
:sigv4a_signing_region_set
(Array)
—
A list of regions that should be signed with SigV4a signing. When not passed, a default
:sigv4a_signing_region_set
is searched for in the following locations:Aws.config[:sigv4a_signing_region_set]
ENV['AWS_SIGV4A_SIGNING_REGION_SET']
~/.aws/config
-
:stub_responses
(Boolean)
— default:
false
—
Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.
Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.
-
:telemetry_provider
(Aws::Telemetry::TelemetryProviderBase)
— default:
Aws::Telemetry::NoOpTelemetryProvider
—
Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses
NoOpTelemetryProvider
which will not record or emit any telemetry data. The SDK supports the following telemetry providers:- OpenTelemetry (OTel) - To use the OTel provider, install and require the
opentelemetry-sdk
gem and then, pass in an instance of aAws::Telemetry::OTelProvider
for telemetry provider.
- OpenTelemetry (OTel) - To use the OTel provider, install and require the
-
:token_provider
(Aws::TokenProvider)
—
A Bearer Token Provider. This can be an instance of any one of the following classes:
Aws::StaticTokenProvider
- Used for configuring static, non-refreshing tokens.Aws::SSOTokenProvider
- Used for loading tokens from AWS SSO using an access token generated fromaws login
.
When
:token_provider
is not configured directly, theAws::TokenProviderChain
will be used to search for tokens configured for your profile in shared configuration files. -
:use_dualstack_endpoint
(Boolean)
—
When set to
true
, dualstack enabled endpoints (with.aws
TLD) will be used if available. -
:use_fips_endpoint
(Boolean)
—
When set to
true
, fips compatible endpoints will be used if available. When afips
region is used, the region is normalized and this config is set totrue
. -
:validate_params
(Boolean)
— default:
true
—
When
true
, request parameters are validated before sending the request. -
:endpoint_provider
(Aws::BedrockAgentRuntime::EndpointProvider)
—
The endpoint provider used to resolve endpoints. Any object that responds to
#resolve_endpoint(parameters)
whereparameters
is a Struct similar toAws::BedrockAgentRuntime::EndpointParameters
. -
:http_continue_timeout
(Float)
— default:
1
—
The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to
nil
which disables this behaviour. This value can safely be set per request on the session. -
:http_idle_timeout
(Float)
— default:
5
—
The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.
-
:http_open_timeout
(Float)
— default:
15
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_proxy
(URI::HTTP, String)
—
A proxy to send requests through. Formatted like 'http://proxy.com:123'.
-
:http_read_timeout
(Float)
— default:
60
—
The default number of seconds to wait for response data. This value can safely be set per-request on the session.
-
:http_wire_trace
(Boolean)
— default:
false
—
When
true
, HTTP debug output will be sent to the:logger
. -
:on_chunk_received
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a
content-length
). -
:on_chunk_sent
(Proc)
—
When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.
-
:raise_response_errors
(Boolean)
— default:
true
—
When
true
, response errors are raised. -
:ssl_ca_bundle
(String)
—
Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available. -
:ssl_ca_directory
(String)
—
Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass
:ssl_ca_bundle
or:ssl_ca_directory
the the system default will be used if available. -
:ssl_ca_store
(String)
—
Sets the X509::Store to verify peer certificate.
-
:ssl_cert
(OpenSSL::X509::Certificate)
—
Sets a client certificate when creating http connections.
-
:ssl_key
(OpenSSL::PKey)
—
Sets a client key when creating http connections.
-
:ssl_timeout
(Float)
—
Sets the SSL timeout in seconds
-
:ssl_verify_peer
(Boolean)
— default:
true
—
When
true
, SSL peer certificates are verified when establishing a connection.
478 479 480 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 478 def initialize(*args) super end |
Instance Method Details
#create_invocation(params = {}) ⇒ Types::CreateInvocationResponse
Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_invocation({
description: "InvocationDescription",
invocation_id: "Uuid",
session_identifier: "SessionIdentifier", # required
})
Response structure
Response structure
resp.created_at #=> Time
resp.invocation_id #=> String
resp.session_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:description
(String)
—
A description for the interactions in the invocation. For example, "User asking about weather in Seattle".
-
:invocation_id
(String)
—
A unique identifier for the invocation in UUID format.
-
:session_identifier
(required, String)
—
The unique identifier for the associated session for the invocation. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Types::CreateInvocationResponse)
—
Returns a response object which responds to the following methods:
- #created_at => Time
- #invocation_id => String
- #session_id => String
See Also:
540 541 542 543 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 540 def create_invocation(params = {}, options = {}) req = build_request(:create_invocation, params) req.send_request(options) end |
#create_session(params = {}) ⇒ Types::CreateSessionResponse
Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption.
Related APIs:
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.create_session({
encryption_key_arn: "KmsKeyArn",
session_metadata: {
"SessionMetadataKey" => "SessionMetadataValue",
},
tags: {
"TagKey" => "TagValue",
},
})
Response structure
Response structure
resp.created_at #=> Time
resp.session_arn #=> String
resp.session_id #=> String
resp.session_status #=> String, one of "ACTIVE", "EXPIRED", "ENDED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:encryption_key_arn
(String)
—
The Amazon Resource Name (ARN) of the KMS key to use to encrypt the session data. The user or role creating the session must have permission to use the key. For more information, see Amazon Bedrock session encryption.
-
:session_metadata
(Hash<String,String>)
—
A map of key-value pairs containing attributes to be persisted across the session. For example, the user's ID, their language preference, and the type of device they are using.
-
:tags
(Hash<String,String>)
—
Specify the key-value pairs for the tags that you want to attach to the session.
Returns:
-
(Types::CreateSessionResponse)
—
Returns a response object which responds to the following methods:
- #created_at => Time
- #session_arn => String
- #session_id => String
- #session_status => String
See Also:
635 636 637 638 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 635 def create_session(params = {}, options = {}) req = build_request(:create_session, params) req.send_request(options) end |
#delete_agent_memory(params = {}) ⇒ Struct
Deletes memory from the specified memory identifier.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_agent_memory({
agent_alias_id: "AgentAliasId", # required
agent_id: "AgentId", # required
memory_id: "MemoryId",
session_id: "SessionId",
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_alias_id
(required, String)
—
The unique identifier of an alias of an agent.
-
:agent_id
(required, String)
—
The unique identifier of the agent to which the alias belongs.
-
:memory_id
(String)
—
The unique identifier of the memory.
-
:session_id
(String)
—
The unique session identifier of the memory.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
669 670 671 672 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 669 def delete_agent_memory(params = {}, options = {}) req = build_request(:delete_agent_memory, params) req.send_request(options) end |
#delete_session(params = {}) ⇒ Struct
Deletes a session that you ended. You can't delete a session with an
ACTIVE
status. To delete an active session, you must first end it
with the EndSession API operation. For more information about
sessions, see Store and retrieve conversation history and context
with Amazon Bedrock sessions.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.delete_session({
session_identifier: "SessionIdentifier", # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:session_identifier
(required, String)
—
The unique identifier for the session to be deleted. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
701 702 703 704 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 701 def delete_session(params = {}, options = {}) req = build_request(:delete_session, params) req.send_request(options) end |
#end_session(params = {}) ⇒ Types::EndSessionResponse
Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.end_session({
session_identifier: "SessionIdentifier", # required
})
Response structure
Response structure
resp.session_arn #=> String
resp.session_id #=> String
resp.session_status #=> String, one of "ACTIVE", "EXPIRED", "ENDED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:session_identifier
(required, String)
—
The unique identifier for the session to end. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Types::EndSessionResponse)
—
Returns a response object which responds to the following methods:
- #session_arn => String
- #session_id => String
- #session_status => String
See Also:
742 743 744 745 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 742 def end_session(params = {}, options = {}) req = build_request(:end_session, params) req.send_request(options) end |
#generate_query(params = {}) ⇒ Types::GenerateQueryResponse
Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.generate_query({
query_generation_input: { # required
text: "QueryGenerationInputTextString", # required
type: "TEXT", # required, accepts TEXT
},
transformation_configuration: { # required
mode: "TEXT_TO_SQL", # required, accepts TEXT_TO_SQL
text_to_sql_configuration: {
knowledge_base_configuration: {
knowledge_base_arn: "KnowledgeBaseArn", # required
},
type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE
},
},
})
Response structure
Response structure
resp.queries #=> Array
resp.queries[0].sql #=> String
resp.queries[0].type #=> String, one of "REDSHIFT_SQL"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:query_generation_input
(required, Types::QueryGenerationInput)
—
Specifies information about a natural language query to transform into SQL.
-
:transformation_configuration
(required, Types::TransformationConfiguration)
—
Specifies configurations for transforming the natural language query into SQL.
Returns:
See Also:
795 796 797 798 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 795 def generate_query(params = {}, options = {}) req = build_request(:generate_query, params) req.send_request(options) end |
#get_agent_memory(params = {}) ⇒ Types::GetAgentMemoryResponse
Gets the sessions stored in the memory of the agent.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_agent_memory({
agent_alias_id: "AgentAliasId", # required
agent_id: "AgentId", # required
max_items: 1,
memory_id: "MemoryId", # required
memory_type: "SESSION_SUMMARY", # required, accepts SESSION_SUMMARY
next_token: "NextToken",
})
Response structure
Response structure
resp.memory_contents #=> Array
resp.memory_contents[0].session_summary.memory_id #=> String
resp.memory_contents[0].session_summary.session_expiry_time #=> Time
resp.memory_contents[0].session_summary.session_id #=> String
resp.memory_contents[0].session_summary.session_start_time #=> Time
resp.memory_contents[0].session_summary.summary_text #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_alias_id
(required, String)
—
The unique identifier of an alias of an agent.
-
:agent_id
(required, String)
—
The unique identifier of the agent to which the alias belongs.
-
:max_items
(Integer)
—
The maximum number of items to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results. -
:memory_id
(required, String)
—
The unique identifier of the memory.
-
:memory_type
(required, String)
—
The type of memory.
-
:next_token
(String)
—
If the total number of results is greater than the maxItems value provided in the request, enter the token returned in the
nextToken
field in the response in this field to return the next batch of results.
Returns:
-
(Types::GetAgentMemoryResponse)
—
Returns a response object which responds to the following methods:
- #memory_contents => Array<Types::Memory>
- #next_token => String
See Also:
858 859 860 861 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 858 def get_agent_memory(params = {}, options = {}) req = build_request(:get_agent_memory, params) req.send_request(options) end |
#get_invocation_step(params = {}) ⇒ Types::GetInvocationStepResponse
Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_invocation_step({
invocation_identifier: "InvocationIdentifier", # required
invocation_step_id: "Uuid", # required
session_identifier: "SessionIdentifier", # required
})
Response structure
Response structure
resp.invocation_step.invocation_id #=> String
resp.invocation_step.invocation_step_id #=> String
resp.invocation_step.invocation_step_time #=> Time
resp.invocation_step.payload.content_blocks #=> Array
resp.invocation_step.payload.content_blocks[0].image.format #=> String, one of "png", "jpeg", "gif", "webp"
resp.invocation_step.payload.content_blocks[0].image.source.bytes #=> String
resp.invocation_step.payload.content_blocks[0].image.source.s3_location.uri #=> String
resp.invocation_step.payload.content_blocks[0].text #=> String
resp.invocation_step.session_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:invocation_identifier
(required, String)
—
The unique identifier for the invocation in UUID format.
-
:invocation_step_id
(required, String)
—
The unique identifier (in UUID format) for the specific invocation step to retrieve.
-
:session_identifier
(required, String)
—
The unique identifier for the invocation step's associated session. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Types::GetInvocationStepResponse)
—
Returns a response object which responds to the following methods:
- #invocation_step => Types::InvocationStep
See Also:
912 913 914 915 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 912 def get_invocation_step(params = {}, options = {}) req = build_request(:get_invocation_step, params) req.send_request(options) end |
#get_session(params = {}) ⇒ Types::GetSessionResponse
Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.get_session({
session_identifier: "SessionIdentifier", # required
})
Response structure
Response structure
resp.created_at #=> Time
resp.encryption_key_arn #=> String
resp.last_updated_at #=> Time
resp.session_arn #=> String
resp.session_id #=> String
resp.session_metadata #=> Hash
resp.session_metadata["SessionMetadataKey"] #=> String
resp.session_status #=> String, one of "ACTIVE", "EXPIRED", "ENDED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:session_identifier
(required, String)
—
A unique identifier for the session to retrieve. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Types::GetSessionResponse)
—
Returns a response object which responds to the following methods:
- #created_at => Time
- #encryption_key_arn => String
- #last_updated_at => Time
- #session_arn => String
- #session_id => String
- #session_metadata => Hash<String,String>
- #session_status => String
See Also:
960 961 962 963 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 960 def get_session(params = {}, options = {}) req = build_request(:get_session, params) req.send_request(options) end |
#invoke_agent(params = {}) ⇒ Types::InvokeAgentResponse
Sends a prompt for the agent to process and respond to. Note the following fields for the request:
To continue the same conversation with an agent, use the same
sessionId
value in the request.To activate trace enablement, turn
enableTrace
totrue
. Trace enablement helps you follow the agent's reasoning process that led it to the information it processed, the actions it took, and the final result it yielded. For more information, see Trace enablement.To stream agent responses, make sure that only orchestration prompt is enabled. Agent streaming is not supported for the following steps:
Pre-processing
Post-processing
Agent with 1 Knowledge base and
User Input
not enabled
End a conversation by setting
endSession
totrue
.In the
sessionState
object, 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.
The response contains both chunk and trace attributes.
The final response is returned in the bytes
field of the chunk
object. The InvokeAgent
returns one chunk for the entire
interaction.
The
attribution
object contains citations for parts of the response.If you set
enableTrace
totrue
in the request, you can trace the agent's steps and reasoning process that led it to the response.If the action predicted was configured to return control, the response returns parameters for the action, elicited from the user, in the
returnControl
field.Errors are also surfaced in the response.
Examples:
EventStream Operation Example
EventStream Operation Example
You can process the event once it arrives immediately, or wait until the
full response is complete and iterate through the eventstream enumerator.
To interact with event immediately, you need to register #invoke_agent
with callbacks. Callbacks can be registered for specific events or for all
events, including error events.
Callbacks can be passed into the `:event_stream_handler` option or within a
block statement attached to the #invoke_agent call directly. Hybrid
pattern of both is also supported.
`:event_stream_handler` option takes in either a Proc object or
Aws::BedrockAgentRuntime::EventStreams::ResponseStream object.
Usage pattern a): Callbacks with a block attached to #invoke_agent
Example for registering callbacks for all event types and an error event
client.invoke_agent( # params input# ) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
stream.on_event do |event|
# process all events arrive
puts event.event_type
...
end
end
Usage pattern b): Pass in `:event_stream_handler` for #invoke_agent
1) Create a Aws::BedrockAgentRuntime::EventStreams::ResponseStream object
Example for registering callbacks with specific events
handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_chunk_event do |event|
event # => Aws::BedrockAgentRuntime::Types::chunk
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_files_event do |event|
event # => Aws::BedrockAgentRuntime::Types::files
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_model_not_ready_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_return_control_event do |event|
event # => Aws::BedrockAgentRuntime::Types::returnControl
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_trace_event do |event|
event # => Aws::BedrockAgentRuntime::Types::trace
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.invoke_agent( # params input #, event_stream_handler: handler)
2) Use a Ruby Proc object
Example for registering callbacks with specific events
handler = Proc.new do |stream|
stream.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
stream.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
stream.on_chunk_event do |event|
event # => Aws::BedrockAgentRuntime::Types::chunk
end
stream.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
stream.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
stream.on_files_event do |event|
event # => Aws::BedrockAgentRuntime::Types::files
end
stream.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
stream.on_model_not_ready_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
end
stream.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
stream.on_return_control_event do |event|
event # => Aws::BedrockAgentRuntime::Types::returnControl
end
stream.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
stream.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
stream.on_trace_event do |event|
event # => Aws::BedrockAgentRuntime::Types::trace
end
stream.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
end
client.invoke_agent( # params input #, event_stream_handler: handler)
Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_chunk_event do |event|
event # => Aws::BedrockAgentRuntime::Types::chunk
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_files_event do |event|
event # => Aws::BedrockAgentRuntime::Types::files
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_model_not_ready_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_return_control_event do |event|
event # => Aws::BedrockAgentRuntime::Types::returnControl
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_trace_event do |event|
event # => Aws::BedrockAgentRuntime::Types::trace
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.invoke_agent( # params input #, event_stream_handler: handler) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
end
You can also iterate through events after the response complete.
Events are available at resp.completion # => Enumerator
For parameter input example, please refer to following request syntax
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.invoke_agent({
agent_alias_id: "AgentAliasId", # required
agent_id: "AgentId", # required
bedrock_model_configurations: {
performance_config: {
latency: "standard", # accepts standard, optimized
},
},
enable_trace: false,
end_session: false,
input_text: "InputText",
memory_id: "MemoryId",
session_id: "SessionId", # required
session_state: {
conversation_history: {
messages: [
{
content: [ # required
{
text: "String",
},
],
role: "user", # required, accepts user, assistant
},
],
},
files: [
{
name: "String", # required
source: { # required
byte_content: {
data: "data", # required
media_type: "MimeType", # required
},
s3_location: {
uri: "S3Uri", # required
},
source_type: "S3", # required, accepts S3, BYTE_CONTENT
},
use_case: "CODE_INTERPRETER", # required, accepts CODE_INTERPRETER, CHAT
},
],
invocation_id: "String",
knowledge_base_configurations: [
{
knowledge_base_id: "KnowledgeBaseId", # required
retrieval_configuration: { # required
vector_search_configuration: { # required
filter: {
and_all: [
{
# recursive RetrievalFilter
},
],
equals: {
key: "FilterKey", # required
value: { # required
},
},
greater_than: {
key: "FilterKey", # required
value: { # required
},
},
greater_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
in: {
key: "FilterKey", # required
value: { # required
},
},
less_than: {
key: "FilterKey", # required
value: { # required
},
},
less_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
list_contains: {
key: "FilterKey", # required
value: { # required
},
},
not_equals: {
key: "FilterKey", # required
value: { # required
},
},
not_in: {
key: "FilterKey", # required
value: { # required
},
},
or_all: [
{
# recursive RetrievalFilter
},
],
starts_with: {
key: "FilterKey", # required
value: { # required
},
},
string_contains: {
key: "FilterKey", # required
value: { # required
},
},
},
implicit_filter_configuration: {
metadata_attributes: [ # required
{
description: "MetadataAttributeSchemaDescriptionString", # required
key: "MetadataAttributeSchemaKeyString", # required
type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
},
],
model_arn: "BedrockModelArn", # required
},
number_of_results: 1,
override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
reranking_configuration: {
bedrock_reranking_configuration: {
metadata_configuration: {
selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
selective_mode_configuration: {
fields_to_exclude: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
fields_to_include: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
},
},
model_configuration: { # required
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
model_arn: "BedrockRerankingModelArn", # required
},
number_of_reranked_results: 1,
},
type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
},
},
},
},
],
prompt_session_attributes: {
"String" => "String",
},
return_control_invocation_results: [
{
api_result: {
action_group: "String", # required
agent_id: "String",
api_path: "ApiPath",
confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
http_method: "String",
http_status_code: 1,
response_body: {
"String" => {
body: "String",
},
},
response_state: "FAILURE", # accepts FAILURE, REPROMPT
},
function_result: {
action_group: "String", # required
agent_id: "String",
confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
function: "String",
response_body: {
"String" => {
body: "String",
},
},
response_state: "FAILURE", # accepts FAILURE, REPROMPT
},
},
],
session_attributes: {
"String" => "String",
},
},
source_arn: "AWSResourceARN",
streaming_configurations: {
apply_guardrail_interval: 1,
stream_final_response: false,
},
})
Response structure
Response structure
All events are available at resp.completion:
resp.completion #=> Enumerator
resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :files, :internal_server_exception, :model_not_ready_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
event.message #=> String
For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
event.attribution.citations #=> Array
event.attribution.citations[0].generated_response_part.text_response_part.span.end #=> Integer
event.attribution.citations[0].generated_response_part.text_response_part.span.start #=> Integer
event.attribution.citations[0].generated_response_part.text_response_part.text #=> String
event.attribution.citations[0].retrieved_references #=> Array
event.attribution.citations[0].retrieved_references[0].content.byte_content #=> String
event.attribution.citations[0].retrieved_references[0].content.row #=> Array
event.attribution.citations[0].retrieved_references[0].content.row[0].column_name #=> String
event.attribution.citations[0].retrieved_references[0].content.row[0].column_value #=> String
event.attribution.citations[0].retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.attribution.citations[0].retrieved_references[0].content.text #=> String
event.attribution.citations[0].retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
event.attribution.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
event.attribution.citations[0].retrieved_references[0].location.sql_location.query #=> String
event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
event.bytes #=> String
For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
event.message #=> String
For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :files event available at #on_files_event callback and response eventstream enumerator:
event.files #=> Array
event.files[0].bytes #=> String
event.files[0].name #=> String
event.files[0].type #=> String
For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
event.message #=> String
event.reason #=> String
For :model_not_ready_exception event available at #on_model_not_ready_exception_event callback and response eventstream enumerator:
event.message #=> String
For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
event.message #=> String
For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
event.invocation_id #=> String
event.invocation_inputs #=> Array
event.invocation_inputs[0].api_invocation_input.action_group #=> String
event.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.invocation_inputs[0].api_invocation_input.agent_id #=> String
event.invocation_inputs[0].api_invocation_input.api_path #=> String
event.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
event.invocation_inputs[0].api_invocation_input.http_method #=> String
event.invocation_inputs[0].api_invocation_input.parameters #=> Array
event.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
event.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
event.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
event.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
event.invocation_inputs[0].function_invocation_input.action_group #=> String
event.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.invocation_inputs[0].function_invocation_input.agent_id #=> String
event.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
event.invocation_inputs[0].function_invocation_input.function #=> String
event.invocation_inputs[0].function_invocation_input.parameters #=> Array
event.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
event.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
event.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
event.message #=> String
For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
event.message #=> String
For :trace event available at #on_trace_event callback and response eventstream enumerator:
event.agent_alias_id #=> String
event.agent_id #=> String
event.agent_version #=> String
event.caller_chain #=> Array
event.caller_chain[0].agent_alias_arn #=> String
event.collaborator_name #=> String
event.event_time #=> Time
event.session_id #=> String
event.trace.custom_orchestration_trace.event.text #=> String
event.trace.custom_orchestration_trace.trace_id #=> String
event.trace.failure_trace.failure_reason #=> String
event.trace.failure_trace.trace_id #=> String
event.trace.guardrail_trace.action #=> String, one of "INTERVENED", "NONE"
event.trace.guardrail_trace.input_assessments #=> Array
event.trace.guardrail_trace.input_assessments[0].content_policy.filters #=> Array
event.trace.guardrail_trace.input_assessments[0].content_policy.filters[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].content_policy.filters[0].confidence #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
event.trace.guardrail_trace.input_assessments[0].content_policy.filters[0].type #=> String, one of "INSULTS", "HATE", "SEXUAL", "VIOLENCE", "MISCONDUCT", "PROMPT_ATTACK"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities #=> Array
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes #=> Array
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].name #=> String
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].regex #=> String
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics #=> Array
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics[0].name #=> String
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics[0].type #=> String, one of "DENY"
event.trace.guardrail_trace.input_assessments[0].word_policy.custom_words #=> Array
event.trace.guardrail_trace.input_assessments[0].word_policy.custom_words[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].word_policy.custom_words[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists #=> Array
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists[0].type #=> String, one of "PROFANITY"
event.trace.guardrail_trace.output_assessments #=> Array
event.trace.guardrail_trace.output_assessments[0].content_policy.filters #=> Array
event.trace.guardrail_trace.output_assessments[0].content_policy.filters[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].content_policy.filters[0].confidence #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
event.trace.guardrail_trace.output_assessments[0].content_policy.filters[0].type #=> String, one of "INSULTS", "HATE", "SEXUAL", "VIOLENCE", "MISCONDUCT", "PROMPT_ATTACK"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities #=> Array
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes #=> Array
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].name #=> String
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].regex #=> String
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics #=> Array
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics[0].name #=> String
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics[0].type #=> String, one of "DENY"
event.trace.guardrail_trace.output_assessments[0].word_policy.custom_words #=> Array
event.trace.guardrail_trace.output_assessments[0].word_policy.custom_words[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].word_policy.custom_words[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists #=> Array
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists[0].type #=> String, one of "PROFANITY"
event.trace.guardrail_trace.trace_id #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.action_group_name #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.api_path #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.execution_type #=> String, one of "LAMBDA", "RETURN_CONTROL"
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.function #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.invocation_id #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters #=> Array
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].name #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].type #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].value #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content #=> Hash
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"] #=> Array
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].name #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.verb #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.code #=> String
event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
event.trace.orchestration_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.text #=> String
event.trace.orchestration_trace.invocation_input.trace_id #=> String
event.trace.orchestration_trace.model_invocation_input.foundation_model #=> String
event.trace.orchestration_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.orchestration_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.orchestration_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.orchestration_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.orchestration_trace.model_invocation_input.override_lambda #=> String
event.trace.orchestration_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.orchestration_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.orchestration_trace.model_invocation_input.text #=> String
event.trace.orchestration_trace.model_invocation_input.trace_id #=> String
event.trace.orchestration_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.orchestration_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.orchestration_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.orchestration_trace.model_invocation_output.raw_response.content #=> String
event.trace.orchestration_trace.model_invocation_output.reasoning_content.reasoning_text.signature #=> String
event.trace.orchestration_trace.model_invocation_output.reasoning_content.reasoning_text.text #=> String
event.trace.orchestration_trace.model_invocation_output.reasoning_content.redacted_content #=> String
event.trace.orchestration_trace.model_invocation_output.trace_id #=> String
event.trace.orchestration_trace.observation.action_group_invocation_output.text #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.text #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_error #=> String
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_output #=> String
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.files #=> Array
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.files[0] #=> String
event.trace.orchestration_trace.observation.final_response.text #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
event.trace.orchestration_trace.observation.reprompt_response.text #=> String
event.trace.orchestration_trace.observation.trace_id #=> String
event.trace.orchestration_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
event.trace.orchestration_trace.rationale.text #=> String
event.trace.orchestration_trace.rationale.trace_id #=> String
event.trace.post_processing_trace.model_invocation_input.foundation_model #=> String
event.trace.post_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.post_processing_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.post_processing_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.post_processing_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.post_processing_trace.model_invocation_input.override_lambda #=> String
event.trace.post_processing_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.post_processing_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.post_processing_trace.model_invocation_input.text #=> String
event.trace.post_processing_trace.model_invocation_input.trace_id #=> String
event.trace.post_processing_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.post_processing_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.post_processing_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.post_processing_trace.model_invocation_output.parsed_response.text #=> String
event.trace.post_processing_trace.model_invocation_output.raw_response.content #=> String
event.trace.post_processing_trace.model_invocation_output.reasoning_content.reasoning_text.signature #=> String
event.trace.post_processing_trace.model_invocation_output.reasoning_content.reasoning_text.text #=> String
event.trace.post_processing_trace.model_invocation_output.reasoning_content.redacted_content #=> String
event.trace.post_processing_trace.model_invocation_output.trace_id #=> String
event.trace.pre_processing_trace.model_invocation_input.foundation_model #=> String
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.pre_processing_trace.model_invocation_input.override_lambda #=> String
event.trace.pre_processing_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.pre_processing_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.pre_processing_trace.model_invocation_input.text #=> String
event.trace.pre_processing_trace.model_invocation_input.trace_id #=> String
event.trace.pre_processing_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.pre_processing_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.pre_processing_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.pre_processing_trace.model_invocation_output.parsed_response.is_valid #=> Boolean
event.trace.pre_processing_trace.model_invocation_output.parsed_response.rationale #=> String
event.trace.pre_processing_trace.model_invocation_output.raw_response.content #=> String
event.trace.pre_processing_trace.model_invocation_output.reasoning_content.reasoning_text.signature #=> String
event.trace.pre_processing_trace.model_invocation_output.reasoning_content.reasoning_text.text #=> String
event.trace.pre_processing_trace.model_invocation_output.reasoning_content.redacted_content #=> String
event.trace.pre_processing_trace.model_invocation_output.trace_id #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.action_group_name #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.api_path #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.execution_type #=> String, one of "LAMBDA", "RETURN_CONTROL"
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.function #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.invocation_id #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters #=> Array
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].name #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].type #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].value #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content #=> Hash
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"] #=> Array
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].name #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.verb #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.code #=> String
event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
event.trace.routing_classifier_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.text #=> String
event.trace.routing_classifier_trace.invocation_input.trace_id #=> String
event.trace.routing_classifier_trace.model_invocation_input.foundation_model #=> String
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.routing_classifier_trace.model_invocation_input.override_lambda #=> String
event.trace.routing_classifier_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.routing_classifier_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.routing_classifier_trace.model_invocation_input.text #=> String
event.trace.routing_classifier_trace.model_invocation_input.trace_id #=> String
event.trace.routing_classifier_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.routing_classifier_trace.model_invocation_output.raw_response.content #=> String
event.trace.routing_classifier_trace.model_invocation_output.trace_id #=> String
event.trace.routing_classifier_trace.observation.action_group_invocation_output.text #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.text #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_error #=> String
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_output #=> String
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files #=> Array
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files[0] #=> String
event.trace.routing_classifier_trace.observation.final_response.text #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
event.trace.routing_classifier_trace.observation.reprompt_response.text #=> String
event.trace.routing_classifier_trace.observation.trace_id #=> String
event.trace.routing_classifier_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
event.message #=> String
resp.content_type #=> String
resp.memory_id #=> String
resp.session_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:agent_alias_id
(required, String)
—
The alias of the agent to use.
-
:agent_id
(required, String)
—
The unique identifier of the agent to use.
-
:bedrock_model_configurations
(Types::BedrockModelConfigurations)
—
Model performance settings for the request.
-
:enable_trace
(Boolean)
—
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.
-
:end_session
(Boolean)
—
Specifies whether to end the session with the agent or not.
-
:input_text
(String)
—
The prompt text to send the agent.
If you include returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored. -
:memory_id
(String)
—
The unique identifier of the agent memory.
-
:session_id
(required, String)
—
The unique identifier of the session. Use the same value across requests to continue the same conversation.
-
:session_state
(Types::SessionState)
—
Contains parameters that specify various attributes of the session. For more information, see Control session context.
If you include returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored. -
:source_arn
(String)
—
The ARN of the resource making the request.
-
:streaming_configurations
(Types::StreamingConfigurations)
—
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream
action.
Yields:
- (event_stream_handler)
Returns:
-
(Types::InvokeAgentResponse)
—
Returns a response object which responds to the following methods:
- #completion => Types::ResponseStream
- #content_type => String
- #memory_id => String
- #session_id => String
See Also:
1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 1947 def invoke_agent(params = {}, options = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::ResponseStream then handler when Proc then EventStreams::ResponseStream.new.tap(&handler) when nil then EventStreams::ResponseStream.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::BedrockAgentRuntime::EventStreams::ResponseStream"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:invoke_agent, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(options, &block) end |
#invoke_flow(params = {}) ⇒ Types::InvokeFlowResponse
Invokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
InvokeFlow
.
Examples:
EventStream Operation Example
EventStream Operation Example
You can process the event once it arrives immediately, or wait until the
full response is complete and iterate through the eventstream enumerator.
To interact with event immediately, you need to register #invoke_flow
with callbacks. Callbacks can be registered for specific events or for all
events, including error events.
Callbacks can be passed into the `:event_stream_handler` option or within a
block statement attached to the #invoke_flow call directly. Hybrid
pattern of both is also supported.
`:event_stream_handler` option takes in either a Proc object or
Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream object.
Usage pattern a): Callbacks with a block attached to #invoke_flow
Example for registering callbacks for all event types and an error event
client.invoke_flow( # params input# ) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
stream.on_event do |event|
# process all events arrive
puts event.event_type
...
end
end
Usage pattern b): Pass in `:event_stream_handler` for #invoke_flow
1) Create a Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream object
Example for registering callbacks with specific events
handler = Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_flow_completion_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
end
handler.on_flow_multi_turn_input_request_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
end
handler.on_flow_output_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
end
handler.on_flow_trace_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.invoke_flow( # params input #, event_stream_handler: handler)
2) Use a Ruby Proc object
Example for registering callbacks with specific events
handler = Proc.new do |stream|
stream.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
stream.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
stream.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
stream.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
stream.on_flow_completion_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
end
stream.on_flow_multi_turn_input_request_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
end
stream.on_flow_output_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
end
stream.on_flow_trace_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
end
stream.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
stream.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
stream.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
stream.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
stream.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
end
client.invoke_flow( # params input #, event_stream_handler: handler)
Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_flow_completion_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
end
handler.on_flow_multi_turn_input_request_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
end
handler.on_flow_output_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
end
handler.on_flow_trace_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.invoke_flow( # params input #, event_stream_handler: handler) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
end
You can also iterate through events after the response complete.
Events are available at resp.response_stream # => Enumerator
For parameter input example, please refer to following request syntax
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.invoke_flow({
enable_trace: false,
execution_id: "FlowExecutionId",
flow_alias_identifier: "FlowAliasIdentifier", # required
flow_identifier: "FlowIdentifier", # required
inputs: [ # required
{
content: { # required
document: {
},
},
node_input_name: "NodeInputName",
node_name: "NodeName", # required
node_output_name: "NodeOutputName",
},
],
model_performance_configuration: {
performance_config: {
latency: "standard", # accepts standard, optimized
},
},
})
Response structure
Response structure
resp.execution_id #=> String
All events are available at resp.response_stream:
resp.response_stream #=> Enumerator
resp.response_stream.event_types #=> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :flow_completion_event, :flow_multi_turn_input_request_event, :flow_output_event, :flow_trace_event, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
event.message #=> String
For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
event.message #=> String
For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :flow_completion_event event available at #on_flow_completion_event_event callback and response eventstream enumerator:
event.completion_reason #=> String, one of "SUCCESS", "INPUT_REQUIRED"
For :flow_multi_turn_input_request_event event available at #on_flow_multi_turn_input_request_event_event callback and response eventstream enumerator:
event.node_name #=> String
event.node_type #=> String, one of "FlowInputNode", "FlowOutputNode", "LambdaFunctionNode", "KnowledgeBaseNode", "PromptNode", "ConditionNode", "LexNode"
For :flow_output_event event available at #on_flow_output_event_event callback and response eventstream enumerator:
event.node_name #=> String
event.node_type #=> String, one of "FlowInputNode", "FlowOutputNode", "LambdaFunctionNode", "KnowledgeBaseNode", "PromptNode", "ConditionNode", "LexNode"
For :flow_trace_event event available at #on_flow_trace_event_event callback and response eventstream enumerator:
event.trace.condition_node_result_trace.node_name #=> String
event.trace.condition_node_result_trace.satisfied_conditions #=> Array
event.trace.condition_node_result_trace.satisfied_conditions[0].condition_name #=> String
event.trace.condition_node_result_trace.timestamp #=> Time
event.trace.node_input_trace.fields #=> Array
event.trace.node_input_trace.fields[0].node_input_name #=> String
event.trace.node_input_trace.node_name #=> String
event.trace.node_input_trace.timestamp #=> Time
event.trace.node_output_trace.fields #=> Array
event.trace.node_output_trace.fields[0].node_output_name #=> String
event.trace.node_output_trace.node_name #=> String
event.trace.node_output_trace.timestamp #=> Time
For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
event.message #=> String
event.reason #=> String
For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
event.message #=> String
For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
event.message #=> String
For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
event.message #=> String
For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
event.message #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:enable_trace
(Boolean)
—
Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see Track each step in your prompt flow by viewing its trace in Amazon Bedrock.
-
:execution_id
(String)
—
The unique identifier for the current flow execution. If you don't provide a value, Amazon Bedrock creates the identifier for you.
-
:flow_alias_identifier
(required, String)
—
The unique identifier of the flow alias.
-
:flow_identifier
(required, String)
—
The unique identifier of the flow.
-
:inputs
(required, Array<Types::FlowInput>)
—
A list of objects, each containing information about an input into the flow.
-
:model_performance_configuration
(Types::ModelPerformanceConfiguration)
—
Model performance settings for the request.
Yields:
- (event_stream_handler)
Returns:
-
(Types::InvokeFlowResponse)
—
Returns a response object which responds to the following methods:
- #execution_id => String
- #response_stream => Types::FlowResponseStream
See Also:
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 2299 def invoke_flow(params = {}, options = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::FlowResponseStream then handler when Proc then EventStreams::FlowResponseStream.new.tap(&handler) when nil then EventStreams::FlowResponseStream.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:invoke_flow, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(options, &block) end |
#invoke_inline_agent(params = {}) ⇒ Types::InvokeInlineAgentResponse
Invokes an inline Amazon Bedrock agent using the configurations you provide with the request.
Specify the following fields for security purposes.
(Optional)
customerEncryptionKeyArn
– The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.(Optional)
idleSessionTTLinSeconds
– Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequentInvokeInlineAgent
request begins a new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts.The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
Examples:
EventStream Operation Example
EventStream Operation Example
You can process the event once it arrives immediately, or wait until the
full response is complete and iterate through the eventstream enumerator.
To interact with event immediately, you need to register #invoke_inline_agent
with callbacks. Callbacks can be registered for specific events or for all
events, including error events.
Callbacks can be passed into the `:event_stream_handler` option or within a
block statement attached to the #invoke_inline_agent call directly. Hybrid
pattern of both is also supported.
`:event_stream_handler` option takes in either a Proc object or
Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object.
Usage pattern a): Callbacks with a block attached to #invoke_inline_agent
Example for registering callbacks for all event types and an error event
client.invoke_inline_agent( # params input# ) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
stream.on_event do |event|
# process all events arrive
puts event.event_type
...
end
end
Usage pattern b): Pass in `:event_stream_handler` for #invoke_inline_agent
1) Create a Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object
Example for registering callbacks with specific events
handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_chunk_event do |event|
event # => Aws::BedrockAgentRuntime::Types::chunk
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_files_event do |event|
event # => Aws::BedrockAgentRuntime::Types::files
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_return_control_event do |event|
event # => Aws::BedrockAgentRuntime::Types::returnControl
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_trace_event do |event|
event # => Aws::BedrockAgentRuntime::Types::trace
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.invoke_inline_agent( # params input #, event_stream_handler: handler)
2) Use a Ruby Proc object
Example for registering callbacks with specific events
handler = Proc.new do |stream|
stream.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
stream.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
stream.on_chunk_event do |event|
event # => Aws::BedrockAgentRuntime::Types::chunk
end
stream.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
stream.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
stream.on_files_event do |event|
event # => Aws::BedrockAgentRuntime::Types::files
end
stream.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
stream.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
stream.on_return_control_event do |event|
event # => Aws::BedrockAgentRuntime::Types::returnControl
end
stream.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
stream.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
stream.on_trace_event do |event|
event # => Aws::BedrockAgentRuntime::Types::trace
end
stream.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
end
client.invoke_inline_agent( # params input #, event_stream_handler: handler)
Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_chunk_event do |event|
event # => Aws::BedrockAgentRuntime::Types::chunk
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_files_event do |event|
event # => Aws::BedrockAgentRuntime::Types::files
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_return_control_event do |event|
event # => Aws::BedrockAgentRuntime::Types::returnControl
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_trace_event do |event|
event # => Aws::BedrockAgentRuntime::Types::trace
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.invoke_inline_agent( # params input #, event_stream_handler: handler) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
end
You can also iterate through events after the response complete.
Events are available at resp.completion # => Enumerator
For parameter input example, please refer to following request syntax
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.invoke_inline_agent({
action_groups: [
{
action_group_executor: {
custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
lambda: "LambdaResourceArn",
},
action_group_name: "ResourceName", # required
api_schema: {
payload: "Payload",
s3: {
s3_bucket_name: "S3BucketName",
s3_object_key: "S3ObjectKey",
},
},
description: "ResourceDescription",
function_schema: {
functions: [
{
description: "FunctionDescription",
name: "ResourceName", # required
parameters: {
"ParameterName" => {
description: "ParameterDescription",
required: false,
type: "string", # required, accepts string, number, integer, boolean, array
},
},
require_confirmation: "ENABLED", # accepts ENABLED, DISABLED
},
],
},
parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput, AMAZON.CodeInterpreter
},
],
agent_collaboration: "SUPERVISOR", # accepts SUPERVISOR, SUPERVISOR_ROUTER, DISABLED
bedrock_model_configurations: {
performance_config: {
latency: "standard", # accepts standard, optimized
},
},
collaborator_configurations: [
{
agent_alias_arn: "AgentAliasArn",
collaborator_instruction: "CollaborationInstruction", # required
collaborator_name: "Name", # required
relay_conversation_history: "TO_COLLABORATOR", # accepts TO_COLLABORATOR, DISABLED
},
],
collaborators: [
{
action_groups: [
{
action_group_executor: {
custom_control: "RETURN_CONTROL", # accepts RETURN_CONTROL
lambda: "LambdaResourceArn",
},
action_group_name: "ResourceName", # required
api_schema: {
payload: "Payload",
s3: {
s3_bucket_name: "S3BucketName",
s3_object_key: "S3ObjectKey",
},
},
description: "ResourceDescription",
function_schema: {
functions: [
{
description: "FunctionDescription",
name: "ResourceName", # required
parameters: {
"ParameterName" => {
description: "ParameterDescription",
required: false,
type: "string", # required, accepts string, number, integer, boolean, array
},
},
require_confirmation: "ENABLED", # accepts ENABLED, DISABLED
},
],
},
parent_action_group_signature: "AMAZON.UserInput", # accepts AMAZON.UserInput, AMAZON.CodeInterpreter
},
],
agent_collaboration: "SUPERVISOR", # accepts SUPERVISOR, SUPERVISOR_ROUTER, DISABLED
agent_name: "Name",
collaborator_configurations: [
{
agent_alias_arn: "AgentAliasArn",
collaborator_instruction: "CollaborationInstruction", # required
collaborator_name: "Name", # required
relay_conversation_history: "TO_COLLABORATOR", # accepts TO_COLLABORATOR, DISABLED
},
],
customer_encryption_key_arn: "KmsKeyArn",
foundation_model: "ModelIdentifier", # required
guardrail_configuration: {
guardrail_identifier: "GuardrailIdentifierWithArn", # required
guardrail_version: "GuardrailVersion", # required
},
idle_session_ttl_in_seconds: 1,
instruction: "Instruction", # required
knowledge_bases: [
{
description: "ResourceDescription", # required
knowledge_base_id: "KnowledgeBaseId", # required
retrieval_configuration: {
vector_search_configuration: { # required
filter: {
and_all: [
{
# recursive RetrievalFilter
},
],
equals: {
key: "FilterKey", # required
value: { # required
},
},
greater_than: {
key: "FilterKey", # required
value: { # required
},
},
greater_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
in: {
key: "FilterKey", # required
value: { # required
},
},
less_than: {
key: "FilterKey", # required
value: { # required
},
},
less_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
list_contains: {
key: "FilterKey", # required
value: { # required
},
},
not_equals: {
key: "FilterKey", # required
value: { # required
},
},
not_in: {
key: "FilterKey", # required
value: { # required
},
},
or_all: [
{
# recursive RetrievalFilter
},
],
starts_with: {
key: "FilterKey", # required
value: { # required
},
},
string_contains: {
key: "FilterKey", # required
value: { # required
},
},
},
implicit_filter_configuration: {
metadata_attributes: [ # required
{
description: "MetadataAttributeSchemaDescriptionString", # required
key: "MetadataAttributeSchemaKeyString", # required
type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
},
],
model_arn: "BedrockModelArn", # required
},
number_of_results: 1,
override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
reranking_configuration: {
bedrock_reranking_configuration: {
metadata_configuration: {
selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
selective_mode_configuration: {
fields_to_exclude: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
fields_to_include: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
},
},
model_configuration: { # required
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
model_arn: "BedrockRerankingModelArn", # required
},
number_of_reranked_results: 1,
},
type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
},
},
},
},
],
prompt_override_configuration: {
override_lambda: "LambdaResourceArn",
prompt_configurations: [ # required
{
additional_model_request_fields: {
},
base_prompt_template: "BasePromptTemplate",
foundation_model: "ModelIdentifier",
inference_configuration: {
maximum_length: 1,
stop_sequences: ["String"],
temperature: 1.0,
top_k: 1,
top_p: 1.0,
},
parser_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
prompt_state: "ENABLED", # accepts ENABLED, DISABLED
prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, KNOWLEDGE_BASE_RESPONSE_GENERATION, POST_PROCESSING, ROUTING_CLASSIFIER
},
],
},
},
],
customer_encryption_key_arn: "KmsKeyArn",
enable_trace: false,
end_session: false,
foundation_model: "ModelIdentifier", # required
guardrail_configuration: {
guardrail_identifier: "GuardrailIdentifierWithArn", # required
guardrail_version: "GuardrailVersion", # required
},
idle_session_ttl_in_seconds: 1,
inline_session_state: {
conversation_history: {
messages: [
{
content: [ # required
{
text: "String",
},
],
role: "user", # required, accepts user, assistant
},
],
},
files: [
{
name: "String", # required
source: { # required
byte_content: {
data: "data", # required
media_type: "MimeType", # required
},
s3_location: {
uri: "S3Uri", # required
},
source_type: "S3", # required, accepts S3, BYTE_CONTENT
},
use_case: "CODE_INTERPRETER", # required, accepts CODE_INTERPRETER, CHAT
},
],
invocation_id: "String",
prompt_session_attributes: {
"String" => "String",
},
return_control_invocation_results: [
{
api_result: {
action_group: "String", # required
agent_id: "String",
api_path: "ApiPath",
confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
http_method: "String",
http_status_code: 1,
response_body: {
"String" => {
body: "String",
},
},
response_state: "FAILURE", # accepts FAILURE, REPROMPT
},
function_result: {
action_group: "String", # required
agent_id: "String",
confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
function: "String",
response_body: {
"String" => {
body: "String",
},
},
response_state: "FAILURE", # accepts FAILURE, REPROMPT
},
},
],
session_attributes: {
"String" => "String",
},
},
input_text: "InputText",
instruction: "Instruction", # required
knowledge_bases: [
{
description: "ResourceDescription", # required
knowledge_base_id: "KnowledgeBaseId", # required
retrieval_configuration: {
vector_search_configuration: { # required
filter: {
and_all: [
{
# recursive RetrievalFilter
},
],
equals: {
key: "FilterKey", # required
value: { # required
},
},
greater_than: {
key: "FilterKey", # required
value: { # required
},
},
greater_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
in: {
key: "FilterKey", # required
value: { # required
},
},
less_than: {
key: "FilterKey", # required
value: { # required
},
},
less_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
list_contains: {
key: "FilterKey", # required
value: { # required
},
},
not_equals: {
key: "FilterKey", # required
value: { # required
},
},
not_in: {
key: "FilterKey", # required
value: { # required
},
},
or_all: [
{
# recursive RetrievalFilter
},
],
starts_with: {
key: "FilterKey", # required
value: { # required
},
},
string_contains: {
key: "FilterKey", # required
value: { # required
},
},
},
implicit_filter_configuration: {
metadata_attributes: [ # required
{
description: "MetadataAttributeSchemaDescriptionString", # required
key: "MetadataAttributeSchemaKeyString", # required
type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
},
],
model_arn: "BedrockModelArn", # required
},
number_of_results: 1,
override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
reranking_configuration: {
bedrock_reranking_configuration: {
metadata_configuration: {
selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
selective_mode_configuration: {
fields_to_exclude: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
fields_to_include: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
},
},
model_configuration: { # required
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
model_arn: "BedrockRerankingModelArn", # required
},
number_of_reranked_results: 1,
},
type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
},
},
},
},
],
prompt_override_configuration: {
override_lambda: "LambdaResourceArn",
prompt_configurations: [ # required
{
additional_model_request_fields: {
},
base_prompt_template: "BasePromptTemplate",
foundation_model: "ModelIdentifier",
inference_configuration: {
maximum_length: 1,
stop_sequences: ["String"],
temperature: 1.0,
top_k: 1,
top_p: 1.0,
},
parser_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
prompt_creation_mode: "DEFAULT", # accepts DEFAULT, OVERRIDDEN
prompt_state: "ENABLED", # accepts ENABLED, DISABLED
prompt_type: "PRE_PROCESSING", # accepts PRE_PROCESSING, ORCHESTRATION, KNOWLEDGE_BASE_RESPONSE_GENERATION, POST_PROCESSING, ROUTING_CLASSIFIER
},
],
},
session_id: "SessionId", # required
streaming_configurations: {
apply_guardrail_interval: 1,
stream_final_response: false,
},
})
Response structure
Response structure
All events are available at resp.completion:
resp.completion #=> Enumerator
resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :files, :internal_server_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
event.message #=> String
For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
event.attribution.citations #=> Array
event.attribution.citations[0].generated_response_part.text_response_part.span.end #=> Integer
event.attribution.citations[0].generated_response_part.text_response_part.span.start #=> Integer
event.attribution.citations[0].generated_response_part.text_response_part.text #=> String
event.attribution.citations[0].retrieved_references #=> Array
event.attribution.citations[0].retrieved_references[0].content.byte_content #=> String
event.attribution.citations[0].retrieved_references[0].content.row #=> Array
event.attribution.citations[0].retrieved_references[0].content.row[0].column_name #=> String
event.attribution.citations[0].retrieved_references[0].content.row[0].column_value #=> String
event.attribution.citations[0].retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.attribution.citations[0].retrieved_references[0].content.text #=> String
event.attribution.citations[0].retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
event.attribution.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
event.attribution.citations[0].retrieved_references[0].location.sql_location.query #=> String
event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
event.bytes #=> String
For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
event.message #=> String
For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :files event available at #on_files_event callback and response eventstream enumerator:
event.files #=> Array
event.files[0].bytes #=> String
event.files[0].name #=> String
event.files[0].type #=> String
For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
event.message #=> String
event.reason #=> String
For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
event.message #=> String
For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
event.invocation_id #=> String
event.invocation_inputs #=> Array
event.invocation_inputs[0].api_invocation_input.action_group #=> String
event.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.invocation_inputs[0].api_invocation_input.agent_id #=> String
event.invocation_inputs[0].api_invocation_input.api_path #=> String
event.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
event.invocation_inputs[0].api_invocation_input.http_method #=> String
event.invocation_inputs[0].api_invocation_input.parameters #=> Array
event.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
event.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
event.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
event.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
event.invocation_inputs[0].function_invocation_input.action_group #=> String
event.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.invocation_inputs[0].function_invocation_input.agent_id #=> String
event.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
event.invocation_inputs[0].function_invocation_input.function #=> String
event.invocation_inputs[0].function_invocation_input.parameters #=> Array
event.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
event.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
event.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
event.message #=> String
For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
event.message #=> String
For :trace event available at #on_trace_event callback and response eventstream enumerator:
event.session_id #=> String
event.trace.custom_orchestration_trace.event.text #=> String
event.trace.custom_orchestration_trace.trace_id #=> String
event.trace.failure_trace.failure_reason #=> String
event.trace.failure_trace.trace_id #=> String
event.trace.guardrail_trace.action #=> String, one of "INTERVENED", "NONE"
event.trace.guardrail_trace.input_assessments #=> Array
event.trace.guardrail_trace.input_assessments[0].content_policy.filters #=> Array
event.trace.guardrail_trace.input_assessments[0].content_policy.filters[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].content_policy.filters[0].confidence #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
event.trace.guardrail_trace.input_assessments[0].content_policy.filters[0].type #=> String, one of "INSULTS", "HATE", "SEXUAL", "VIOLENCE", "MISCONDUCT", "PROMPT_ATTACK"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities #=> Array
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.pii_entities[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes #=> Array
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].name #=> String
event.trace.guardrail_trace.input_assessments[0].sensitive_information_policy.regexes[0].regex #=> String
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics #=> Array
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics[0].name #=> String
event.trace.guardrail_trace.input_assessments[0].topic_policy.topics[0].type #=> String, one of "DENY"
event.trace.guardrail_trace.input_assessments[0].word_policy.custom_words #=> Array
event.trace.guardrail_trace.input_assessments[0].word_policy.custom_words[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].word_policy.custom_words[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists #=> Array
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists[0].match #=> String
event.trace.guardrail_trace.input_assessments[0].word_policy.managed_word_lists[0].type #=> String, one of "PROFANITY"
event.trace.guardrail_trace.output_assessments #=> Array
event.trace.guardrail_trace.output_assessments[0].content_policy.filters #=> Array
event.trace.guardrail_trace.output_assessments[0].content_policy.filters[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].content_policy.filters[0].confidence #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH"
event.trace.guardrail_trace.output_assessments[0].content_policy.filters[0].type #=> String, one of "INSULTS", "HATE", "SEXUAL", "VIOLENCE", "MISCONDUCT", "PROMPT_ATTACK"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities #=> Array
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.pii_entities[0].type #=> String, one of "ADDRESS", "AGE", "AWS_ACCESS_KEY", "AWS_SECRET_KEY", "CA_HEALTH_NUMBER", "CA_SOCIAL_INSURANCE_NUMBER", "CREDIT_DEBIT_CARD_CVV", "CREDIT_DEBIT_CARD_EXPIRY", "CREDIT_DEBIT_CARD_NUMBER", "DRIVER_ID", "EMAIL", "INTERNATIONAL_BANK_ACCOUNT_NUMBER", "IP_ADDRESS", "LICENSE_PLATE", "MAC_ADDRESS", "NAME", "PASSWORD", "PHONE", "PIN", "SWIFT_CODE", "UK_NATIONAL_HEALTH_SERVICE_NUMBER", "UK_NATIONAL_INSURANCE_NUMBER", "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER", "URL", "USERNAME", "US_BANK_ACCOUNT_NUMBER", "US_BANK_ROUTING_NUMBER", "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER", "US_PASSPORT_NUMBER", "US_SOCIAL_SECURITY_NUMBER", "VEHICLE_IDENTIFICATION_NUMBER"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes #=> Array
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].action #=> String, one of "BLOCKED", "ANONYMIZED"
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].name #=> String
event.trace.guardrail_trace.output_assessments[0].sensitive_information_policy.regexes[0].regex #=> String
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics #=> Array
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics[0].name #=> String
event.trace.guardrail_trace.output_assessments[0].topic_policy.topics[0].type #=> String, one of "DENY"
event.trace.guardrail_trace.output_assessments[0].word_policy.custom_words #=> Array
event.trace.guardrail_trace.output_assessments[0].word_policy.custom_words[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].word_policy.custom_words[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists #=> Array
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists[0].action #=> String, one of "BLOCKED"
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists[0].match #=> String
event.trace.guardrail_trace.output_assessments[0].word_policy.managed_word_lists[0].type #=> String, one of "PROFANITY"
event.trace.guardrail_trace.trace_id #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.action_group_name #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.api_path #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.execution_type #=> String, one of "LAMBDA", "RETURN_CONTROL"
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.function #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.invocation_id #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters #=> Array
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].name #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].type #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.parameters[0].value #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content #=> Hash
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"] #=> Array
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].name #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
event.trace.orchestration_trace.invocation_input.action_group_invocation_input.verb #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.code #=> String
event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
event.trace.orchestration_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.text #=> String
event.trace.orchestration_trace.invocation_input.trace_id #=> String
event.trace.orchestration_trace.model_invocation_input.foundation_model #=> String
event.trace.orchestration_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.orchestration_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.orchestration_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.orchestration_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.orchestration_trace.model_invocation_input.override_lambda #=> String
event.trace.orchestration_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.orchestration_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.orchestration_trace.model_invocation_input.text #=> String
event.trace.orchestration_trace.model_invocation_input.trace_id #=> String
event.trace.orchestration_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.orchestration_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.orchestration_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.orchestration_trace.model_invocation_output.raw_response.content #=> String
event.trace.orchestration_trace.model_invocation_output.reasoning_content.reasoning_text.signature #=> String
event.trace.orchestration_trace.model_invocation_output.reasoning_content.reasoning_text.text #=> String
event.trace.orchestration_trace.model_invocation_output.reasoning_content.redacted_content #=> String
event.trace.orchestration_trace.model_invocation_output.trace_id #=> String
event.trace.orchestration_trace.observation.action_group_invocation_output.text #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.text #=> String
event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_error #=> String
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_output #=> String
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.files #=> Array
event.trace.orchestration_trace.observation.code_interpreter_invocation_output.files[0] #=> String
event.trace.orchestration_trace.observation.final_response.text #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
event.trace.orchestration_trace.observation.reprompt_response.text #=> String
event.trace.orchestration_trace.observation.trace_id #=> String
event.trace.orchestration_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
event.trace.orchestration_trace.rationale.text #=> String
event.trace.orchestration_trace.rationale.trace_id #=> String
event.trace.post_processing_trace.model_invocation_input.foundation_model #=> String
event.trace.post_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.post_processing_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.post_processing_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.post_processing_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.post_processing_trace.model_invocation_input.override_lambda #=> String
event.trace.post_processing_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.post_processing_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.post_processing_trace.model_invocation_input.text #=> String
event.trace.post_processing_trace.model_invocation_input.trace_id #=> String
event.trace.post_processing_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.post_processing_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.post_processing_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.post_processing_trace.model_invocation_output.parsed_response.text #=> String
event.trace.post_processing_trace.model_invocation_output.raw_response.content #=> String
event.trace.post_processing_trace.model_invocation_output.reasoning_content.reasoning_text.signature #=> String
event.trace.post_processing_trace.model_invocation_output.reasoning_content.reasoning_text.text #=> String
event.trace.post_processing_trace.model_invocation_output.reasoning_content.redacted_content #=> String
event.trace.post_processing_trace.model_invocation_output.trace_id #=> String
event.trace.pre_processing_trace.model_invocation_input.foundation_model #=> String
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.pre_processing_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.pre_processing_trace.model_invocation_input.override_lambda #=> String
event.trace.pre_processing_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.pre_processing_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.pre_processing_trace.model_invocation_input.text #=> String
event.trace.pre_processing_trace.model_invocation_input.trace_id #=> String
event.trace.pre_processing_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.pre_processing_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.pre_processing_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.pre_processing_trace.model_invocation_output.parsed_response.is_valid #=> Boolean
event.trace.pre_processing_trace.model_invocation_output.parsed_response.rationale #=> String
event.trace.pre_processing_trace.model_invocation_output.raw_response.content #=> String
event.trace.pre_processing_trace.model_invocation_output.reasoning_content.reasoning_text.signature #=> String
event.trace.pre_processing_trace.model_invocation_output.reasoning_content.reasoning_text.text #=> String
event.trace.pre_processing_trace.model_invocation_output.reasoning_content.redacted_content #=> String
event.trace.pre_processing_trace.model_invocation_output.trace_id #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.action_group_name #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.api_path #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.execution_type #=> String, one of "LAMBDA", "RETURN_CONTROL"
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.function #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.invocation_id #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters #=> Array
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].name #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].type #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].value #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content #=> Hash
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"] #=> Array
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].name #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.verb #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.code #=> String
event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
event.trace.routing_classifier_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.text #=> String
event.trace.routing_classifier_trace.invocation_input.trace_id #=> String
event.trace.routing_classifier_trace.model_invocation_input.foundation_model #=> String
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.temperature #=> Float
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_k #=> Integer
event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_p #=> Float
event.trace.routing_classifier_trace.model_invocation_input.override_lambda #=> String
event.trace.routing_classifier_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.routing_classifier_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
event.trace.routing_classifier_trace.model_invocation_input.text #=> String
event.trace.routing_classifier_trace.model_invocation_input.trace_id #=> String
event.trace.routing_classifier_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
event.trace.routing_classifier_trace.model_invocation_output.raw_response.content #=> String
event.trace.routing_classifier_trace.model_invocation_output.trace_id #=> String
event.trace.routing_classifier_trace.observation.action_group_invocation_output.text #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.text #=> String
event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_error #=> String
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_output #=> String
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files #=> Array
event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files[0] #=> String
event.trace.routing_classifier_trace.observation.final_response.text #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.byte_content #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row #=> Array
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_name #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].column_value #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.kendra_document_location.uri #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.sql_location.query #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
event.trace.routing_classifier_trace.observation.reprompt_response.text #=> String
event.trace.routing_classifier_trace.observation.trace_id #=> String
event.trace.routing_classifier_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
event.message #=> String
resp.content_type #=> String
resp.session_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:action_groups
(Array<Types::AgentActionGroup>)
—
A list of action groups with each action group defining the action the inline agent needs to carry out.
-
:agent_collaboration
(String)
—
Defines how the inline collaborator agent handles information across multiple collaborator agents to coordinate a final response. The inline collaborator agent can also be the supervisor.
-
:bedrock_model_configurations
(Types::InlineBedrockModelConfigurations)
—
Model settings for the request.
-
:collaborator_configurations
(Array<Types::CollaboratorConfiguration>)
—
Settings for an inline agent collaborator called with InvokeInlineAgent.
-
:collaborators
(Array<Types::Collaborator>)
—
List of collaborator inline agents.
-
:customer_encryption_key_arn
(String)
—
The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to use to encrypt your inline agent.
-
:enable_trace
(Boolean)
—
Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Using trace.
-
:end_session
(Boolean)
—
Specifies whether to end the session with the inline agent or not.
-
:foundation_model
(required, String)
—
The model identifier (ID) of the model to use for orchestration by the inline agent. For example,
meta.llama3-1-70b-instruct-v1:0
. -
:guardrail_configuration
(Types::GuardrailConfigurationWithArn)
—
The guardrails to assign to the inline agent.
-
:idle_session_ttl_in_seconds
(Integer)
—
The number of seconds for which the inline agent should maintain session information. After this time expires, the subsequent
InvokeInlineAgent
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.
-
:inline_session_state
(Types::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 thesessionState
field, theinputText
field will be ignored. -
:input_text
(String)
—
The prompt text to send to the agent.
If you include returnControlInvocationResults
in thesessionState
field, theinputText
field will be ignored. -
:instruction
(required, String)
—
The instructions that tell the inline agent what it should do and how it should interact with users.
-
:knowledge_bases
(Array<Types::KnowledgeBase>)
—
Contains information of the knowledge bases to associate with.
-
:prompt_override_configuration
(Types::PromptOverrideConfiguration)
—
Configurations for advanced prompts used to override the default prompts to enhance the accuracy of the inline agent.
-
:session_id
(required, String)
—
The unique identifier of the session. Use the same value across requests to continue the same conversation.
-
:streaming_configurations
(Types::StreamingConfigurations)
—
Specifies the configurations for streaming.
To use agent streaming, you need permissions to perform the bedrock:InvokeModelWithResponseStream
action.
Yields:
- (event_stream_handler)
Returns:
-
(Types::InvokeInlineAgentResponse)
—
Returns a response object which responds to the following methods:
- #completion => Types::InlineAgentResponseStream
- #content_type => String
- #session_id => String
See Also:
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 3573 def invoke_inline_agent(params = {}, options = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::InlineAgentResponseStream then handler when Proc then EventStreams::InlineAgentResponseStream.new.tap(&handler) when nil then EventStreams::InlineAgentResponseStream.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:invoke_inline_agent, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(options, &block) end |
#list_invocation_steps(params = {}) ⇒ Types::ListInvocationStepsResponse
Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_invocation_steps({
invocation_identifier: "InvocationIdentifier",
max_results: 1,
next_token: "NextToken",
session_identifier: "SessionIdentifier", # required
})
Response structure
Response structure
resp.invocation_step_summaries #=> Array
resp.invocation_step_summaries[0].invocation_id #=> String
resp.invocation_step_summaries[0].invocation_step_id #=> String
resp.invocation_step_summaries[0].invocation_step_time #=> Time
resp.invocation_step_summaries[0].session_id #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:invocation_identifier
(String)
—
The unique identifier (in UUID format) for the invocation to list invocation steps for.
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results. -
:session_identifier
(required, String)
—
The unique identifier for the session associated with the invocation steps. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Types::ListInvocationStepsResponse)
—
Returns a response object which responds to the following methods:
- #invocation_step_summaries => Array<Types::InvocationStepSummary>
- #next_token => String
See Also:
3655 3656 3657 3658 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 3655 def list_invocation_steps(params = {}, options = {}) req = build_request(:list_invocation_steps, params) req.send_request(options) end |
#list_invocations(params = {}) ⇒ Types::ListInvocationsResponse
Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_invocations({
max_results: 1,
next_token: "NextToken",
session_identifier: "SessionIdentifier", # required
})
Response structure
Response structure
resp.invocation_summaries #=> Array
resp.invocation_summaries[0].created_at #=> Time
resp.invocation_summaries[0].invocation_id #=> String
resp.invocation_summaries[0].session_id #=> String
resp.next_token #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results. -
:session_identifier
(required, String)
—
The unique identifier for the session to list invocations for. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Types::ListInvocationsResponse)
—
Returns a response object which responds to the following methods:
- #invocation_summaries => Array<Types::InvocationSummary>
- #next_token => String
See Also:
3712 3713 3714 3715 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 3712 def list_invocations(params = {}, options = {}) req = build_request(:list_invocations, params) req.send_request(options) end |
#list_sessions(params = {}) ⇒ Types::ListSessionsResponse
Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_sessions({
max_results: 1,
next_token: "NextToken",
})
Response structure
Response structure
resp.next_token #=> String
resp.session_summaries #=> Array
resp.session_summaries[0].created_at #=> Time
resp.session_summaries[0].last_updated_at #=> Time
resp.session_summaries[0].session_arn #=> String
resp.session_summaries[0].session_id #=> String
resp.session_summaries[0].session_status #=> String, one of "ACTIVE", "EXPIRED", "ENDED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:max_results
(Integer)
—
The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the
nextToken
field when making another request to return the next batch of results. -
:next_token
(String)
—
If the total number of results is greater than the
maxResults
value provided in the request, enter the token returned in thenextToken
field in the response in this field to return the next batch of results.
Returns:
-
(Types::ListSessionsResponse)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #session_summaries => Array<Types::SessionSummary>
See Also:
3765 3766 3767 3768 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 3765 def list_sessions(params = {}, options = {}) req = build_request(:list_sessions, params) req.send_request(options) end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List all the tags for the resource you specify.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.list_tags_for_resource({
resource_arn: "TaggableResourcesArn", # required
})
Response structure
Response structure
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource for which to list tags.
Returns:
See Also:
3794 3795 3796 3797 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 3794 def list_tags_for_resource(params = {}, options = {}) req = build_request(:list_tags_for_resource, params) req.send_request(options) end |
#optimize_prompt(params = {}) ⇒ Types::OptimizePromptResponse
Optimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide.
Examples:
EventStream Operation Example
EventStream Operation Example
You can process the event once it arrives immediately, or wait until the
full response is complete and iterate through the eventstream enumerator.
To interact with event immediately, you need to register #optimize_prompt
with callbacks. Callbacks can be registered for specific events or for all
events, including error events.
Callbacks can be passed into the `:event_stream_handler` option or within a
block statement attached to the #optimize_prompt call directly. Hybrid
pattern of both is also supported.
`:event_stream_handler` option takes in either a Proc object or
Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object.
Usage pattern a): Callbacks with a block attached to #optimize_prompt
Example for registering callbacks for all event types and an error event
client.optimize_prompt( # params input# ) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
stream.on_event do |event|
# process all events arrive
puts event.event_type
...
end
end
Usage pattern b): Pass in `:event_stream_handler` for #optimize_prompt
1) Create a Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object
Example for registering callbacks with specific events
handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_analyze_prompt_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_optimized_prompt_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.optimize_prompt( # params input #, event_stream_handler: handler)
2) Use a Ruby Proc object
Example for registering callbacks with specific events
handler = Proc.new do |stream|
stream.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
stream.on_analyze_prompt_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
end
stream.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
stream.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
stream.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
stream.on_optimized_prompt_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
end
stream.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
stream.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
end
client.optimize_prompt( # params input #, event_stream_handler: handler)
Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_analyze_prompt_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_optimized_prompt_event_event do |event|
event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.optimize_prompt( # params input #, event_stream_handler: handler) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
end
You can also iterate through events after the response complete.
Events are available at resp.optimized_prompt # => Enumerator
For parameter input example, please refer to following request syntax
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.optimize_prompt({
input: { # required
text_prompt: {
text: "TextPromptTextString", # required
},
},
target_model_id: "OptimizePromptRequestTargetModelIdString", # required
})
Response structure
Response structure
All events are available at resp.optimized_prompt:
resp.optimized_prompt #=> Enumerator
resp.optimized_prompt.event_types #=> [:access_denied_exception, :analyze_prompt_event, :bad_gateway_exception, :dependency_failed_exception, :internal_server_exception, :optimized_prompt_event, :throttling_exception, :validation_exception]
For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
event.message #=> String
For :analyze_prompt_event event available at #on_analyze_prompt_event_event callback and response eventstream enumerator:
event.message #=> String
For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
event.message #=> String
event.reason #=> String
For :optimized_prompt_event event available at #on_optimized_prompt_event_event callback and response eventstream enumerator:
event.optimized_prompt.text_prompt.text #=> String
For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
event.message #=> String
For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
event.message #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:input
(required, Types::InputPrompt)
—
Contains the prompt to optimize.
-
:target_model_id
(required, String)
—
The unique identifier of the model that you want to optimize the prompt for.
Yields:
- (event_stream_handler)
Returns:
-
(Types::OptimizePromptResponse)
—
Returns a response object which responds to the following methods:
- #optimized_prompt => Types::OptimizedPromptStream
See Also:
4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 4013 def optimize_prompt(params = {}, options = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::OptimizedPromptStream then handler when Proc then EventStreams::OptimizedPromptStream.new.tap(&handler) when nil then EventStreams::OptimizedPromptStream.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:optimize_prompt, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(options, &block) end |
#put_invocation_step(params = {}) ⇒ Types::PutInvocationStepResponse
Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Related APIs:
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.put_invocation_step({
invocation_identifier: "InvocationIdentifier", # required
invocation_step_id: "Uuid",
invocation_step_time: Time.now, # required
payload: { # required
content_blocks: [
{
image: {
format: "png", # required, accepts png, jpeg, gif, webp
source: { # required
bytes: "data",
s3_location: {
uri: "S3Uri", # required
},
},
},
text: "BedrockSessionContentBlockTextString",
},
],
},
session_identifier: "SessionIdentifier", # required
})
Response structure
Response structure
resp.invocation_step_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:invocation_identifier
(required, String)
—
The unique identifier (in UUID format) of the invocation to add the invocation step to.
-
:invocation_step_id
(String)
—
The unique identifier of the invocation step in UUID format.
-
:invocation_step_time
(required, Time, DateTime, Date, Integer, String)
—
The timestamp for when the invocation step occurred.
-
:payload
(required, Types::InvocationStepPayload)
—
The payload for the invocation step, including text and images for the interaction.
-
:session_identifier
(required, String)
—
The unique identifier for the session to add the invocation step to. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN).
Returns:
-
(Types::PutInvocationStepResponse)
—
Returns a response object which responds to the following methods:
- #invocation_step_id => String
See Also:
4115 4116 4117 4118 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 4115 def put_invocation_step(params = {}, options = {}) req = build_request(:put_invocation_step, params) req.send_request(options) end |
#rerank(params = {}) ⇒ Types::RerankResponse
Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.rerank({
next_token: "NextToken",
queries: [ # required
{
text_query: { # required
text: "RerankTextDocumentTextString",
},
type: "TEXT", # required, accepts TEXT
},
],
reranking_configuration: { # required
bedrock_reranking_configuration: { # required
model_configuration: { # required
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
model_arn: "BedrockModelArn", # required
},
number_of_results: 1,
},
type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
},
sources: [ # required
{
inline_document_source: { # required
json_document: {
},
text_document: {
text: "RerankTextDocumentTextString",
},
type: "TEXT", # required, accepts TEXT, JSON
},
type: "INLINE", # required, accepts INLINE
},
],
})
Response structure
Response structure
resp.next_token #=> String
resp.results #=> Array
resp.results[0].document.text_document.text #=> String
resp.results[0].document.type #=> String, one of "TEXT", "JSON"
resp.results[0].index #=> Integer
resp.results[0].relevance_score #=> Float
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:next_token
(String)
—
If the total number of results was greater than could fit in a response, a token is returned in the
nextToken
field. You can enter that token in this field to return the next batch of results. -
:queries
(required, Array<Types::RerankQuery>)
—
An array of objects, each of which contains information about a query to submit to the reranker model.
-
:reranking_configuration
(required, Types::RerankingConfiguration)
—
Contains configurations for reranking.
-
:sources
(required, Array<Types::RerankSource>)
—
An array of objects, each of which contains information about the sources to rerank.
Returns:
-
(Types::RerankResponse)
—
Returns a response object which responds to the following methods:
- #next_token => String
- #results => Array<Types::RerankResult>
See Also:
4204 4205 4206 4207 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 4204 def rerank(params = {}, options = {}) req = build_request(:rerank, params) req.send_request(options) end |
#retrieve(params = {}) ⇒ Types::RetrieveResponse
Queries a knowledge base and retrieves information from it.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.retrieve({
guardrail_configuration: {
guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
},
knowledge_base_id: "KnowledgeBaseId", # required
next_token: "NextToken",
retrieval_configuration: {
vector_search_configuration: { # required
filter: {
and_all: [
{
# recursive RetrievalFilter
},
],
equals: {
key: "FilterKey", # required
value: { # required
},
},
greater_than: {
key: "FilterKey", # required
value: { # required
},
},
greater_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
in: {
key: "FilterKey", # required
value: { # required
},
},
less_than: {
key: "FilterKey", # required
value: { # required
},
},
less_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
list_contains: {
key: "FilterKey", # required
value: { # required
},
},
not_equals: {
key: "FilterKey", # required
value: { # required
},
},
not_in: {
key: "FilterKey", # required
value: { # required
},
},
or_all: [
{
# recursive RetrievalFilter
},
],
starts_with: {
key: "FilterKey", # required
value: { # required
},
},
string_contains: {
key: "FilterKey", # required
value: { # required
},
},
},
implicit_filter_configuration: {
metadata_attributes: [ # required
{
description: "MetadataAttributeSchemaDescriptionString", # required
key: "MetadataAttributeSchemaKeyString", # required
type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
},
],
model_arn: "BedrockModelArn", # required
},
number_of_results: 1,
override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
reranking_configuration: {
bedrock_reranking_configuration: {
metadata_configuration: {
selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
selective_mode_configuration: {
fields_to_exclude: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
fields_to_include: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
},
},
model_configuration: { # required
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
model_arn: "BedrockRerankingModelArn", # required
},
number_of_reranked_results: 1,
},
type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
},
},
},
retrieval_query: { # required
text: "KnowledgeBaseQueryTextString", # required
},
})
Response structure
Response structure
resp.guardrail_action #=> String, one of "INTERVENED", "NONE"
resp.next_token #=> String
resp.retrieval_results #=> Array
resp.retrieval_results[0].content.byte_content #=> String
resp.retrieval_results[0].content.row #=> Array
resp.retrieval_results[0].content.row[0].column_name #=> String
resp.retrieval_results[0].content.row[0].column_value #=> String
resp.retrieval_results[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
resp.retrieval_results[0].content.text #=> String
resp.retrieval_results[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
resp.retrieval_results[0].location.confluence_location.url #=> String
resp.retrieval_results[0].location.custom_document_location.id #=> String
resp.retrieval_results[0].location.kendra_document_location.uri #=> String
resp.retrieval_results[0].location.s3_location.uri #=> String
resp.retrieval_results[0].location.salesforce_location.url #=> String
resp.retrieval_results[0].location.share_point_location.url #=> String
resp.retrieval_results[0].location.sql_location.query #=> String
resp.retrieval_results[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
resp.retrieval_results[0].location.web_location.url #=> String
resp.retrieval_results[0].metadata #=> Hash
resp.retrieval_results[0].score #=> Float
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:guardrail_configuration
(Types::GuardrailConfiguration)
—
Guardrail settings.
-
:knowledge_base_id
(required, String)
—
The unique identifier of the knowledge base to query.
-
:next_token
(String)
—
If there are more results than can fit in the response, the response returns a
nextToken
. Use this token in thenextToken
field of another request to retrieve the next batch of results. -
:retrieval_configuration
(Types::KnowledgeBaseRetrievalConfiguration)
—
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
-
:retrieval_query
(required, Types::KnowledgeBaseQuery)
—
Contains the query to send the knowledge base.
Returns:
-
(Types::RetrieveResponse)
—
Returns a response object which responds to the following methods:
- #guardrail_action => String
- #next_token => String
- #retrieval_results => Array<Types::KnowledgeBaseRetrievalResult>
See Also:
4394 4395 4396 4397 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 4394 def retrieve(params = {}, options = {}) req = build_request(:retrieve, params) req.send_request(options) end |
#retrieve_and_generate(params = {}) ⇒ Types::RetrieveAndGenerateResponse
Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.retrieve_and_generate({
input: { # required
text: "RetrieveAndGenerateInputTextString", # required
},
retrieve_and_generate_configuration: {
external_sources_configuration: {
generation_configuration: {
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
guardrail_configuration: {
guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
},
inference_config: {
text_inference_config: {
max_tokens: 1,
stop_sequences: ["RAGStopSequencesMemberString"],
temperature: 1.0,
top_p: 1.0,
},
},
performance_config: {
latency: "standard", # accepts standard, optimized
},
prompt_template: {
text_prompt_template: "TextPromptTemplate",
},
},
model_arn: "BedrockModelArn", # required
sources: [ # required
{
byte_content: {
content_type: "ContentType", # required
data: "data", # required
identifier: "Identifier", # required
},
s3_location: {
uri: "S3Uri", # required
},
source_type: "S3", # required, accepts S3, BYTE_CONTENT
},
],
},
knowledge_base_configuration: {
generation_configuration: {
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
guardrail_configuration: {
guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
},
inference_config: {
text_inference_config: {
max_tokens: 1,
stop_sequences: ["RAGStopSequencesMemberString"],
temperature: 1.0,
top_p: 1.0,
},
},
performance_config: {
latency: "standard", # accepts standard, optimized
},
prompt_template: {
text_prompt_template: "TextPromptTemplate",
},
},
knowledge_base_id: "KnowledgeBaseId", # required
model_arn: "BedrockModelArn", # required
orchestration_configuration: {
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
inference_config: {
text_inference_config: {
max_tokens: 1,
stop_sequences: ["RAGStopSequencesMemberString"],
temperature: 1.0,
top_p: 1.0,
},
},
performance_config: {
latency: "standard", # accepts standard, optimized
},
prompt_template: {
text_prompt_template: "TextPromptTemplate",
},
query_transformation_configuration: {
type: "QUERY_DECOMPOSITION", # required, accepts QUERY_DECOMPOSITION
},
},
retrieval_configuration: {
vector_search_configuration: { # required
filter: {
and_all: [
{
# recursive RetrievalFilter
},
],
equals: {
key: "FilterKey", # required
value: { # required
},
},
greater_than: {
key: "FilterKey", # required
value: { # required
},
},
greater_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
in: {
key: "FilterKey", # required
value: { # required
},
},
less_than: {
key: "FilterKey", # required
value: { # required
},
},
less_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
list_contains: {
key: "FilterKey", # required
value: { # required
},
},
not_equals: {
key: "FilterKey", # required
value: { # required
},
},
not_in: {
key: "FilterKey", # required
value: { # required
},
},
or_all: [
{
# recursive RetrievalFilter
},
],
starts_with: {
key: "FilterKey", # required
value: { # required
},
},
string_contains: {
key: "FilterKey", # required
value: { # required
},
},
},
implicit_filter_configuration: {
metadata_attributes: [ # required
{
description: "MetadataAttributeSchemaDescriptionString", # required
key: "MetadataAttributeSchemaKeyString", # required
type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
},
],
model_arn: "BedrockModelArn", # required
},
number_of_results: 1,
override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
reranking_configuration: {
bedrock_reranking_configuration: {
metadata_configuration: {
selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
selective_mode_configuration: {
fields_to_exclude: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
fields_to_include: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
},
},
model_configuration: { # required
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
model_arn: "BedrockRerankingModelArn", # required
},
number_of_reranked_results: 1,
},
type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
},
},
},
},
type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE, EXTERNAL_SOURCES
},
session_configuration: {
kms_key_arn: "KmsKeyArn", # required
},
session_id: "SessionId",
})
Response structure
Response structure
resp.citations #=> Array
resp.citations[0].generated_response_part.text_response_part.span.end #=> Integer
resp.citations[0].generated_response_part.text_response_part.span.start #=> Integer
resp.citations[0].generated_response_part.text_response_part.text #=> String
resp.citations[0].retrieved_references #=> Array
resp.citations[0].retrieved_references[0].content.byte_content #=> String
resp.citations[0].retrieved_references[0].content.row #=> Array
resp.citations[0].retrieved_references[0].content.row[0].column_name #=> String
resp.citations[0].retrieved_references[0].content.row[0].column_value #=> String
resp.citations[0].retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
resp.citations[0].retrieved_references[0].content.text #=> String
resp.citations[0].retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
resp.citations[0].retrieved_references[0].location.confluence_location.url #=> String
resp.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
resp.citations[0].retrieved_references[0].location.kendra_document_location.uri #=> String
resp.citations[0].retrieved_references[0].location.s3_location.uri #=> String
resp.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
resp.citations[0].retrieved_references[0].location.share_point_location.url #=> String
resp.citations[0].retrieved_references[0].location.sql_location.query #=> String
resp.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
resp.citations[0].retrieved_references[0].location.web_location.url #=> String
resp.citations[0].retrieved_references[0].metadata #=> Hash
resp.guardrail_action #=> String, one of "INTERVENED", "NONE"
resp.output.text #=> String
resp.session_id #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:input
(required, Types::RetrieveAndGenerateInput)
—
Contains the query to be made to the knowledge base.
-
:retrieve_and_generate_configuration
(Types::RetrieveAndGenerateConfiguration)
—
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
-
:session_configuration
(Types::RetrieveAndGenerateSessionConfiguration)
—
Contains details about the session with the knowledge base.
-
:session_id
(String)
—
The unique identifier of the session. When you first make a
RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set thesessionId
yourself.
Returns:
-
(Types::RetrieveAndGenerateResponse)
—
Returns a response object which responds to the following methods:
- #citations => Array<Types::Citation>
- #guardrail_action => String
- #output => Types::RetrieveAndGenerateOutput
- #session_id => String
See Also:
4686 4687 4688 4689 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 4686 def retrieve_and_generate(params = {}, options = {}) req = build_request(:retrieve_and_generate, params) req.send_request(options) end |
#retrieve_and_generate_stream(params = {}) ⇒ Types::RetrieveAndGenerateStreamResponse
Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.
InvokeModelWithResponseStream
.
This operation requires permission for the
bedrock:RetrieveAndGenerate
action.
Examples:
EventStream Operation Example
EventStream Operation Example
You can process the event once it arrives immediately, or wait until the
full response is complete and iterate through the eventstream enumerator.
To interact with event immediately, you need to register #retrieve_and_generate_stream
with callbacks. Callbacks can be registered for specific events or for all
events, including error events.
Callbacks can be passed into the `:event_stream_handler` option or within a
block statement attached to the #retrieve_and_generate_stream call directly. Hybrid
pattern of both is also supported.
`:event_stream_handler` option takes in either a Proc object or
Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object.
Usage pattern a): Callbacks with a block attached to #retrieve_and_generate_stream
Example for registering callbacks for all event types and an error event
client.retrieve_and_generate_stream( # params input# ) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
stream.on_event do |event|
# process all events arrive
puts event.event_type
...
end
end
Usage pattern b): Pass in `:event_stream_handler` for #retrieve_and_generate_stream
1) Create a Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object
Example for registering callbacks with specific events
handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_citation_event do |event|
event # => Aws::BedrockAgentRuntime::Types::citation
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_guardrail_event do |event|
event # => Aws::BedrockAgentRuntime::Types::guardrail
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_output_event do |event|
event # => Aws::BedrockAgentRuntime::Types::output
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler)
2) Use a Ruby Proc object
Example for registering callbacks with specific events
handler = Proc.new do |stream|
stream.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
stream.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
stream.on_citation_event do |event|
event # => Aws::BedrockAgentRuntime::Types::citation
end
stream.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
stream.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
stream.on_guardrail_event do |event|
event # => Aws::BedrockAgentRuntime::Types::guardrail
end
stream.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
stream.on_output_event do |event|
event # => Aws::BedrockAgentRuntime::Types::output
end
stream.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
stream.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
stream.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
stream.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
end
client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler)
Usage pattern c): Hybrid pattern of a) and b)
handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
handler.on_access_denied_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
end
handler.on_bad_gateway_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::badGatewayException
end
handler.on_citation_event do |event|
event # => Aws::BedrockAgentRuntime::Types::citation
end
handler.on_conflict_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::conflictException
end
handler.on_dependency_failed_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
end
handler.on_guardrail_event do |event|
event # => Aws::BedrockAgentRuntime::Types::guardrail
end
handler.on_internal_server_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::internalServerException
end
handler.on_output_event do |event|
event # => Aws::BedrockAgentRuntime::Types::output
end
handler.on_resource_not_found_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
end
handler.on_service_quota_exceeded_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
end
handler.on_throttling_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::throttlingException
end
handler.on_validation_exception_event do |event|
event # => Aws::BedrockAgentRuntime::Types::validationException
end
client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler) do |stream|
stream.on_error_event do |event|
# catch unmodeled error event in the stream
raise event
# => Aws::Errors::EventError
# event.event_type => :error
# event.error_code => String
# event.error_message => String
end
end
You can also iterate through events after the response complete.
Events are available at resp.stream # => Enumerator
For parameter input example, please refer to following request syntax
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.retrieve_and_generate_stream({
input: { # required
text: "RetrieveAndGenerateInputTextString", # required
},
retrieve_and_generate_configuration: {
external_sources_configuration: {
generation_configuration: {
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
guardrail_configuration: {
guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
},
inference_config: {
text_inference_config: {
max_tokens: 1,
stop_sequences: ["RAGStopSequencesMemberString"],
temperature: 1.0,
top_p: 1.0,
},
},
performance_config: {
latency: "standard", # accepts standard, optimized
},
prompt_template: {
text_prompt_template: "TextPromptTemplate",
},
},
model_arn: "BedrockModelArn", # required
sources: [ # required
{
byte_content: {
content_type: "ContentType", # required
data: "data", # required
identifier: "Identifier", # required
},
s3_location: {
uri: "S3Uri", # required
},
source_type: "S3", # required, accepts S3, BYTE_CONTENT
},
],
},
knowledge_base_configuration: {
generation_configuration: {
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
guardrail_configuration: {
guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
},
inference_config: {
text_inference_config: {
max_tokens: 1,
stop_sequences: ["RAGStopSequencesMemberString"],
temperature: 1.0,
top_p: 1.0,
},
},
performance_config: {
latency: "standard", # accepts standard, optimized
},
prompt_template: {
text_prompt_template: "TextPromptTemplate",
},
},
knowledge_base_id: "KnowledgeBaseId", # required
model_arn: "BedrockModelArn", # required
orchestration_configuration: {
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
inference_config: {
text_inference_config: {
max_tokens: 1,
stop_sequences: ["RAGStopSequencesMemberString"],
temperature: 1.0,
top_p: 1.0,
},
},
performance_config: {
latency: "standard", # accepts standard, optimized
},
prompt_template: {
text_prompt_template: "TextPromptTemplate",
},
query_transformation_configuration: {
type: "QUERY_DECOMPOSITION", # required, accepts QUERY_DECOMPOSITION
},
},
retrieval_configuration: {
vector_search_configuration: { # required
filter: {
and_all: [
{
# recursive RetrievalFilter
},
],
equals: {
key: "FilterKey", # required
value: { # required
},
},
greater_than: {
key: "FilterKey", # required
value: { # required
},
},
greater_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
in: {
key: "FilterKey", # required
value: { # required
},
},
less_than: {
key: "FilterKey", # required
value: { # required
},
},
less_than_or_equals: {
key: "FilterKey", # required
value: { # required
},
},
list_contains: {
key: "FilterKey", # required
value: { # required
},
},
not_equals: {
key: "FilterKey", # required
value: { # required
},
},
not_in: {
key: "FilterKey", # required
value: { # required
},
},
or_all: [
{
# recursive RetrievalFilter
},
],
starts_with: {
key: "FilterKey", # required
value: { # required
},
},
string_contains: {
key: "FilterKey", # required
value: { # required
},
},
},
implicit_filter_configuration: {
metadata_attributes: [ # required
{
description: "MetadataAttributeSchemaDescriptionString", # required
key: "MetadataAttributeSchemaKeyString", # required
type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
},
],
model_arn: "BedrockModelArn", # required
},
number_of_results: 1,
override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
reranking_configuration: {
bedrock_reranking_configuration: {
metadata_configuration: {
selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
selective_mode_configuration: {
fields_to_exclude: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
fields_to_include: [
{
field_name: "FieldForRerankingFieldNameString", # required
},
],
},
},
model_configuration: { # required
additional_model_request_fields: {
"AdditionalModelRequestFieldsKey" => {
},
},
model_arn: "BedrockRerankingModelArn", # required
},
number_of_reranked_results: 1,
},
type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
},
},
},
},
type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE, EXTERNAL_SOURCES
},
session_configuration: {
kms_key_arn: "KmsKeyArn", # required
},
session_id: "SessionId",
})
Response structure
Response structure
resp.session_id #=> String
All events are available at resp.stream:
resp.stream #=> Enumerator
resp.stream.event_types #=> [:access_denied_exception, :bad_gateway_exception, :citation, :conflict_exception, :dependency_failed_exception, :guardrail, :internal_server_exception, :output, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
event.message #=> String
For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :citation event available at #on_citation_event callback and response eventstream enumerator:
event.citation.generated_response_part.text_response_part.span.end #=> Integer
event.citation.generated_response_part.text_response_part.span.start #=> Integer
event.citation.generated_response_part.text_response_part.text #=> String
event.citation.retrieved_references #=> Array
event.citation.retrieved_references[0].content.byte_content #=> String
event.citation.retrieved_references[0].content.row #=> Array
event.citation.retrieved_references[0].content.row[0].column_name #=> String
event.citation.retrieved_references[0].content.row[0].column_value #=> String
event.citation.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.citation.retrieved_references[0].content.text #=> String
event.citation.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.citation.retrieved_references[0].location.confluence_location.url #=> String
event.citation.retrieved_references[0].location.custom_document_location.id #=> String
event.citation.retrieved_references[0].location.kendra_document_location.uri #=> String
event.citation.retrieved_references[0].location.s3_location.uri #=> String
event.citation.retrieved_references[0].location.salesforce_location.url #=> String
event.citation.retrieved_references[0].location.share_point_location.url #=> String
event.citation.retrieved_references[0].location.sql_location.query #=> String
event.citation.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.citation.retrieved_references[0].location.web_location.url #=> String
event.citation.retrieved_references[0].metadata #=> Hash
event.generated_response_part.text_response_part.span.end #=> Integer
event.generated_response_part.text_response_part.span.start #=> Integer
event.generated_response_part.text_response_part.text #=> String
event.retrieved_references #=> Array
event.retrieved_references[0].content.byte_content #=> String
event.retrieved_references[0].content.row #=> Array
event.retrieved_references[0].content.row[0].column_name #=> String
event.retrieved_references[0].content.row[0].column_value #=> String
event.retrieved_references[0].content.row[0].type #=> String, one of "BLOB", "BOOLEAN", "DOUBLE", "NULL", "LONG", "STRING"
event.retrieved_references[0].content.text #=> String
event.retrieved_references[0].content.type #=> String, one of "TEXT", "IMAGE", "ROW"
event.retrieved_references[0].location.confluence_location.url #=> String
event.retrieved_references[0].location.custom_document_location.id #=> String
event.retrieved_references[0].location.kendra_document_location.uri #=> String
event.retrieved_references[0].location.s3_location.uri #=> String
event.retrieved_references[0].location.salesforce_location.url #=> String
event.retrieved_references[0].location.share_point_location.url #=> String
event.retrieved_references[0].location.sql_location.query #=> String
event.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM", "KENDRA", "SQL"
event.retrieved_references[0].location.web_location.url #=> String
event.retrieved_references[0].metadata #=> Hash
For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
event.message #=> String
For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
event.message #=> String
event.resource_name #=> String
For :guardrail event available at #on_guardrail_event callback and response eventstream enumerator:
event.action #=> String, one of "INTERVENED", "NONE"
For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
event.message #=> String
event.reason #=> String
For :output event available at #on_output_event callback and response eventstream enumerator:
event.text #=> String
For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
event.message #=> String
For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
event.message #=> String
For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
event.message #=> String
For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
event.message #=> String
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:input
(required, Types::RetrieveAndGenerateInput)
—
Contains the query to be made to the knowledge base.
-
:retrieve_and_generate_configuration
(Types::RetrieveAndGenerateConfiguration)
—
Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.
-
:session_configuration
(Types::RetrieveAndGenerateSessionConfiguration)
—
Contains details about the session with the knowledge base.
-
:session_id
(String)
—
The unique identifier of the session. When you first make a
RetrieveAndGenerate
request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set thesessionId
yourself.
Yields:
- (event_stream_handler)
Returns:
-
(Types::RetrieveAndGenerateStreamResponse)
—
Returns a response object which responds to the following methods:
- #session_id => String
- #stream => Types::RetrieveAndGenerateStreamResponseOutput
See Also:
5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 5219 def retrieve_and_generate_stream(params = {}, options = {}, &block) params = params.dup event_stream_handler = case handler = params.delete(:event_stream_handler) when EventStreams::RetrieveAndGenerateStreamResponseOutput then handler when Proc then EventStreams::RetrieveAndGenerateStreamResponseOutput.new.tap(&handler) when nil then EventStreams::RetrieveAndGenerateStreamResponseOutput.new else msg = "expected :event_stream_handler to be a block or "\ "instance of Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput"\ ", got `#{handler.inspect}` instead" raise ArgumentError, msg end yield(event_stream_handler) if block_given? req = build_request(:retrieve_and_generate_stream, params) req.context[:event_stream_handler] = event_stream_handler req.handlers.add(Aws::Binary::DecodeHandler, priority: 95) req.send_request(options, &block) end |
#tag_resource(params = {}) ⇒ Struct
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.tag_resource({
resource_arn: "TaggableResourcesArn", # required
tags: { # required
"TagKey" => "TagValue",
},
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource to tag.
-
:tags
(required, Hash<String,String>)
—
An object containing key-value pairs that define the tags to attach to the resource.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
5271 5272 5273 5274 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 5271 def tag_resource(params = {}, options = {}) req = build_request(:tag_resource, params) req.send_request(options) end |
#untag_resource(params = {}) ⇒ Struct
Remove tags from a resource.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.untag_resource({
resource_arn: "TaggableResourcesArn", # required
tag_keys: ["TagKey"], # required
})
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:resource_arn
(required, String)
—
The Amazon Resource Name (ARN) of the resource from which to remove tags.
-
:tag_keys
(required, Array<String>)
—
A list of keys of the tags to remove from the resource.
Returns:
-
(Struct)
—
Returns an empty response.
See Also:
5298 5299 5300 5301 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 5298 def untag_resource(params = {}, options = {}) req = build_request(:untag_resource, params) req.send_request(options) end |
#update_session(params = {}) ⇒ Types::UpdateSessionResponse
Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Examples:
Request syntax with placeholder values
Request syntax with placeholder values
resp = client.update_session({
session_identifier: "SessionIdentifier", # required
session_metadata: {
"SessionMetadataKey" => "SessionMetadataValue",
},
})
Response structure
Response structure
resp.created_at #=> Time
resp.last_updated_at #=> Time
resp.session_arn #=> String
resp.session_id #=> String
resp.session_status #=> String, one of "ACTIVE", "EXPIRED", "ENDED"
Parameters:
-
params
(Hash)
(defaults to: {})
—
({})
Options Hash (params):
-
:session_identifier
(required, String)
—
The unique identifier of the session to modify. You can specify either the session's
sessionId
or its Amazon Resource Name (ARN). -
:session_metadata
(Hash<String,String>)
—
A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
Returns:
-
(Types::UpdateSessionResponse)
—
Returns a response object which responds to the following methods:
- #created_at => Time
- #last_updated_at => Time
- #session_arn => String
- #session_id => String
- #session_status => String
See Also:
5349 5350 5351 5352 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/client.rb', line 5349 def update_session(params = {}, options = {}) req = build_request(:update_session, params) req.send_request(options) end |