aws-sdk-bedrockagentruntime 1.17.0 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abaf68544e2dbfc17ee7113c041a308342648320ed87eb3159f0cb178f8e4771
-  data.tar.gz: 0c080ff885d0d86175b51b5bcf5599497564241885e2693d68706e319c176b38
+  metadata.gz: 4de9ca3c5127253c57eb94d02e58989d86b335ba558936058c0cee2d27c1632c
+  data.tar.gz: 00d90ec2f0c4024ce81d85442d5a093755e9f01f92ad0ab69af2d1673603d91d
 SHA512:
-  metadata.gz: 3b6aeefa2b03de9bc4e66b951bab384938eab5bb61ba636c18d7e0f74baf450c1dec25edf5c6019f74ab06cc9d74f101c78155368e98be0a93acb8737552436b
-  data.tar.gz: a754f7b176330235954dd25d4cc12ae87fdbd244a5cc33a9c87557fc4953188bb85fbb08499029c6d804f86f0b5fca09fce4c5f903e2e18a9023245414b8b4f1
+  metadata.gz: a9b085b888c48e7c57ae1d9acd0420000c847dff4557ff53a0299d930c4a2b415d124543142d231fadd6e2c17e7871b86e7462329c1c1d61228549472482a181
+  data.tar.gz: fa22b45e9f41bd00fff6766f4541a8745df0e9ac668fd72b8b576820df97d794f2f12ca68bd948ee2e247795664df35e8cd9f589cde8b7c1aa7aeebc187d1cd0

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.18.0 (2024-08-06)
+------------------
+
+* Feature - Introduce model invocation output traces for orchestration traces, which contain the model's raw response and usage.
+
 1.17.0 (2024-07-18)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.17.0
+1.18.0

data/lib/aws-sdk-bedrockagentruntime/client.rb

@@ -1123,6 +1123,10 @@ module Aws::BedrockAgentRuntime
     #   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"
+    #   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.trace_id #=> String
     #   event.trace.orchestration_trace.observation.action_group_invocation_output.text #=> String
     #   event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_error #=> String
     #   event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_output #=> String
@@ -1214,6 +1218,11 @@ module Aws::BedrockAgentRuntime
     # error is returned. For more information, see [Test a flow in Amazon
     # Bedrock][1] in the Amazon Bedrock User Guide.
     #
+    # <note markdown="1"> The CLI doesn't support streaming operations in Amazon Bedrock,
+    # including `InvokeFlow`.
+    #
+    #  </note>
+    #
     #
     #
     # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-test.html
@@ -1854,7 +1863,7 @@ module Aws::BedrockAgentRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-bedrockagentruntime'
-      context[:gem_version] = '1.17.0'
+      context[:gem_version] = '1.18.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-bedrockagentruntime/client_api.rb

@@ -165,6 +165,7 @@ module Aws::BedrockAgentRuntime
     MemoryId = Shapes::StringShape.new(name: 'MemoryId')
     MemorySessionSummary = Shapes::StructureShape.new(name: 'MemorySessionSummary')
     MemoryType = Shapes::StringShape.new(name: 'MemoryType')
+    Metadata = Shapes::StructureShape.new(name: 'Metadata')
     MimeType = Shapes::StringShape.new(name: 'MimeType')
     ModelInvocationInput = Shapes::StructureShape.new(name: 'ModelInvocationInput')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
@@ -174,6 +175,7 @@ module Aws::BedrockAgentRuntime
     NonBlankString = Shapes::StringShape.new(name: 'NonBlankString')
     Observation = Shapes::StructureShape.new(name: 'Observation')
     OrchestrationConfiguration = Shapes::StructureShape.new(name: 'OrchestrationConfiguration')
+    OrchestrationModelInvocationOutput = Shapes::StructureShape.new(name: 'OrchestrationModelInvocationOutput')
     OrchestrationTrace = Shapes::UnionShape.new(name: 'OrchestrationTrace')
     OutputFile = Shapes::StructureShape.new(name: 'OutputFile')
     OutputFiles = Shapes::ListShape.new(name: 'OutputFiles')
@@ -200,6 +202,7 @@ module Aws::BedrockAgentRuntime
     RAGStopSequencesMemberString = Shapes::StringShape.new(name: 'RAGStopSequencesMemberString')
     Rationale = Shapes::StructureShape.new(name: 'Rationale')
     RationaleString = Shapes::StringShape.new(name: 'RationaleString')
+    RawResponse = Shapes::StructureShape.new(name: 'RawResponse')
     RepromptResponse = Shapes::StructureShape.new(name: 'RepromptResponse')
     RequestBody = Shapes::StructureShape.new(name: 'RequestBody')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
@@ -260,6 +263,7 @@ module Aws::BedrockAgentRuntime
     TraceKnowledgeBaseId = Shapes::StringShape.new(name: 'TraceKnowledgeBaseId')
     TracePart = Shapes::StructureShape.new(name: 'TracePart')
     Type = Shapes::StringShape.new(name: 'Type')
+    Usage = Shapes::StructureShape.new(name: 'Usage')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
     Verb = Shapes::StringShape.new(name: 'Verb')
 
@@ -681,6 +685,9 @@ module Aws::BedrockAgentRuntime
     MemorySessionSummary.add_member(:summary_text, Shapes::ShapeRef.new(shape: SummaryText, location_name: "summaryText"))
     MemorySessionSummary.struct_class = Types::MemorySessionSummary
 
+    Metadata.add_member(:usage, Shapes::ShapeRef.new(shape: Usage, location_name: "usage"))
+    Metadata.struct_class = Types::Metadata
+
     ModelInvocationInput.add_member(:inference_configuration, Shapes::ShapeRef.new(shape: InferenceConfiguration, location_name: "inferenceConfiguration"))
     ModelInvocationInput.add_member(:override_lambda, Shapes::ShapeRef.new(shape: LambdaArn, location_name: "overrideLambda"))
     ModelInvocationInput.add_member(:parser_mode, Shapes::ShapeRef.new(shape: CreationMode, location_name: "parserMode"))
@@ -702,13 +709,20 @@ module Aws::BedrockAgentRuntime
     OrchestrationConfiguration.add_member(:query_transformation_configuration, Shapes::ShapeRef.new(shape: QueryTransformationConfiguration, required: true, location_name: "queryTransformationConfiguration"))
     OrchestrationConfiguration.struct_class = Types::OrchestrationConfiguration
 
+    OrchestrationModelInvocationOutput.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "metadata"))
+    OrchestrationModelInvocationOutput.add_member(:raw_response, Shapes::ShapeRef.new(shape: RawResponse, location_name: "rawResponse"))
+    OrchestrationModelInvocationOutput.add_member(:trace_id, Shapes::ShapeRef.new(shape: TraceId, location_name: "traceId"))
+    OrchestrationModelInvocationOutput.struct_class = Types::OrchestrationModelInvocationOutput
+
     OrchestrationTrace.add_member(:invocation_input, Shapes::ShapeRef.new(shape: InvocationInput, location_name: "invocationInput"))
     OrchestrationTrace.add_member(:model_invocation_input, Shapes::ShapeRef.new(shape: ModelInvocationInput, location_name: "modelInvocationInput"))
+    OrchestrationTrace.add_member(:model_invocation_output, Shapes::ShapeRef.new(shape: OrchestrationModelInvocationOutput, location_name: "modelInvocationOutput"))
     OrchestrationTrace.add_member(:observation, Shapes::ShapeRef.new(shape: Observation, location_name: "observation"))
     OrchestrationTrace.add_member(:rationale, Shapes::ShapeRef.new(shape: Rationale, location_name: "rationale"))
     OrchestrationTrace.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
     OrchestrationTrace.add_member_subclass(:invocation_input, Types::OrchestrationTrace::InvocationInput)
     OrchestrationTrace.add_member_subclass(:model_invocation_input, Types::OrchestrationTrace::ModelInvocationInput)
+    OrchestrationTrace.add_member_subclass(:model_invocation_output, Types::OrchestrationTrace::ModelInvocationOutput)
     OrchestrationTrace.add_member_subclass(:observation, Types::OrchestrationTrace::Observation)
     OrchestrationTrace.add_member_subclass(:rationale, Types::OrchestrationTrace::Rationale)
     OrchestrationTrace.add_member_subclass(:unknown, Types::OrchestrationTrace::Unknown)
@@ -783,6 +797,9 @@ module Aws::BedrockAgentRuntime
     Rationale.add_member(:trace_id, Shapes::ShapeRef.new(shape: TraceId, location_name: "traceId"))
     Rationale.struct_class = Types::Rationale
 
+    RawResponse.add_member(:content, Shapes::ShapeRef.new(shape: String, location_name: "content"))
+    RawResponse.struct_class = Types::RawResponse
+
     RepromptResponse.add_member(:source, Shapes::ShapeRef.new(shape: Source, location_name: "source"))
     RepromptResponse.add_member(:text, Shapes::ShapeRef.new(shape: String, location_name: "text"))
     RepromptResponse.struct_class = Types::RepromptResponse
@@ -981,6 +998,10 @@ module Aws::BedrockAgentRuntime
     TracePart.add_member(:trace, Shapes::ShapeRef.new(shape: Trace, location_name: "trace"))
     TracePart.struct_class = Types::TracePart
 
+    Usage.add_member(:input_tokens, Shapes::ShapeRef.new(shape: Integer, location_name: "inputTokens"))
+    Usage.add_member(:output_tokens, Shapes::ShapeRef.new(shape: Integer, location_name: "outputTokens"))
+    Usage.struct_class = Types::Usage
+
     ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
     ValidationException.struct_class = Types::ValidationException
 

data/lib/aws-sdk-bedrockagentruntime/types.rb

@@ -738,8 +738,8 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
-    # Contains information about an input into the flow and what to do with
-    # it.
+    # Contains information about an input into the prompt flow and where to
+    # send it.
     #
     # This data type is used in the following API operations:
     #
@@ -752,15 +752,16 @@ module Aws::BedrockAgentRuntime
     # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax
     #
     # @!attribute [rw] content
-    #   Contains information about an input into the flow.
+    #   Contains information about an input into the prompt flow.
     #   @return [Types::FlowInputContent]
     #
     # @!attribute [rw] node_name
-    #   A name for the input of the flow input node.
+    #   The name of the flow input node that begins the prompt flow.
     #   @return [String]
     #
     # @!attribute [rw] node_output_name
-    #   A name for the output of the flow input node.
+    #   The name of the output from the flow input node that begins the
+    #   prompt flow.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowInput AWS API Documentation
@@ -788,7 +789,7 @@ module Aws::BedrockAgentRuntime
     # @note FlowInputContent is a union - when making an API calls you must set exactly one of the members.
     #
     # @!attribute [rw] document
-    #   The input for the flow input node.
+    #   The input to send to the prompt flow input node.
     #   @return [Hash,Array,String,Numeric,Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowInputContent AWS API Documentation
@@ -804,7 +805,8 @@ module Aws::BedrockAgentRuntime
       class Unknown < FlowInputContent; end
     end
 
-    # Contains information about the output node.
+    # Contains information about the content in an output from prompt flow
+    # invocation.
     #
     # This data type is used in the following API operations:
     #
@@ -819,7 +821,7 @@ module Aws::BedrockAgentRuntime
     # @note FlowOutputContent is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowOutputContent corresponding to the set member.
     #
     # @!attribute [rw] document
-    #   A name for the output of the flow.
+    #   The content in the output.
     #   @return [Hash,Array,String,Numeric,Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowOutputContent AWS API Documentation
@@ -835,7 +837,7 @@ module Aws::BedrockAgentRuntime
       class Unknown < FlowOutputContent; end
     end
 
-    # Contains information about an output from flow invoction.
+    # Contains information about an output from prompt flow invoction.
     #
     # This data type is used in the following API operations:
     #
@@ -848,15 +850,15 @@ module Aws::BedrockAgentRuntime
     # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax
     #
     # @!attribute [rw] content
-    #   The output of the node.
+    #   The content in the output.
     #   @return [Types::FlowOutputContent]
     #
     # @!attribute [rw] node_name
-    #   The name of the node to which input was provided.
+    #   The name of the flow output node that the output is from.
     #   @return [String]
     #
     # @!attribute [rw] node_type
-    #   The type of node to which input was provided.
+    #   The type of the node that the output is from.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FlowOutputEvent AWS API Documentation
@@ -1472,7 +1474,7 @@ module Aws::BedrockAgentRuntime
     #   the following token at each point of generation. The value that you
     #   set for `Top P` determines the number of most-likely candidates from
     #   which the model chooses the next token in the sequence. For example,
-    #   if you set `topP` to 80, the model only selects the next token from
+    #   if you set `topP` to 0.8, the model only selects the next token from
     #   the top 80% of the probability distribution of next tokens.
     #   @return [Float]
     #
@@ -2103,6 +2105,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Provides details of the foundation model.
+    #
+    # @!attribute [rw] usage
+    #   Contains details of the foundation model usage.
+    #   @return [Types::Usage]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Metadata AWS API Documentation
+    #
+    class Metadata < Struct.new(
+      :usage)
+      SENSITIVE = [:usage]
+      include Aws::Structure
+    end
+
     # The input for the pre-processing step.
     #
     # * The `type` matches the agent step.
@@ -2256,6 +2272,31 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # The foundation model output from the orchestration step.
+    #
+    # @!attribute [rw] metadata
+    #   Contains information about the foundation model output.
+    #   @return [Types::Metadata]
+    #
+    # @!attribute [rw] raw_response
+    #   Contains details of the raw response from the foundation model
+    #   output.
+    #   @return [Types::RawResponse]
+    #
+    # @!attribute [rw] trace_id
+    #   The unique identifier of the trace.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OrchestrationModelInvocationOutput AWS API Documentation
+    #
+    class OrchestrationModelInvocationOutput < Struct.new(
+      :metadata,
+      :raw_response,
+      :trace_id)
+      SENSITIVE = [:metadata, :raw_response]
+      include Aws::Structure
+    end
+
     # Details about the orchestration step, in which the agent determines
     # the order in which actions are executed and which knowledge bases are
     # retrieved.
@@ -2283,6 +2324,11 @@ module Aws::BedrockAgentRuntime
     #   [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html
     #   @return [Types::ModelInvocationInput]
     #
+    # @!attribute [rw] model_invocation_output
+    #   Contains information pertaining to the output from the foundation
+    #   model that is being invoked.
+    #   @return [Types::OrchestrationModelInvocationOutput]
+    #
     # @!attribute [rw] observation
     #   Details about the observation (the output of the action group Lambda
     #   or knowledge base) made by the agent.
@@ -2299,15 +2345,17 @@ module Aws::BedrockAgentRuntime
     class OrchestrationTrace < Struct.new(
       :invocation_input,
       :model_invocation_input,
+      :model_invocation_output,
       :observation,
       :rationale,
       :unknown)
-      SENSITIVE = [:invocation_input, :model_invocation_input, :observation, :rationale]
+      SENSITIVE = [:invocation_input, :model_invocation_input, :model_invocation_output, :observation, :rationale]
       include Aws::Structure
       include Aws::Structure::Union
 
       class InvocationInput < OrchestrationTrace; end
       class ModelInvocationInput < OrchestrationTrace; end
+      class ModelInvocationOutput < OrchestrationTrace; end
       class Observation < OrchestrationTrace; end
       class Rationale < OrchestrationTrace; end
       class Unknown < OrchestrationTrace; end
@@ -2632,6 +2680,20 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains the raw output from the foundation model.
+    #
+    # @!attribute [rw] content
+    #   The foundation model's raw output content.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RawResponse AWS API Documentation
+    #
+    class RawResponse < Struct.new(
+      :content)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains details about the agent's response to reprompt the input.
     #
     # @!attribute [rw] source
@@ -3715,6 +3777,27 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Contains information of the usage of the foundation model.
+    #
+    # @!attribute [rw] input_tokens
+    #   Contains information about the input tokens from the foundation
+    #   model usage.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] output_tokens
+    #   Contains information about the output tokens from the foundation
+    #   model usage.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Usage AWS API Documentation
+    #
+    class Usage < Struct.new(
+      :input_tokens,
+      :output_tokens)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Input validation failed. Check your request parameters and retry the
     # request.
     #

data/lib/aws-sdk-bedrockagentruntime.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-bedrockagentruntime/event_streams'
 # @!group service
 module Aws::BedrockAgentRuntime
 
-  GEM_VERSION = '1.17.0'
+  GEM_VERSION = '1.18.0'
 
 end

data/sig/types.rbs

@@ -534,6 +534,11 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: []
     end
 
+    class Metadata
+      attr_accessor usage: Types::Usage
+      SENSITIVE: [:usage]
+    end
+
     class ModelInvocationInput
       attr_accessor inference_configuration: Types::InferenceConfiguration
       attr_accessor override_lambda: ::String
@@ -561,18 +566,28 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: []
     end
 
+    class OrchestrationModelInvocationOutput
+      attr_accessor metadata: Types::Metadata
+      attr_accessor raw_response: Types::RawResponse
+      attr_accessor trace_id: ::String
+      SENSITIVE: [:metadata, :raw_response]
+    end
+
     class OrchestrationTrace
       attr_accessor invocation_input: Types::InvocationInput
       attr_accessor model_invocation_input: Types::ModelInvocationInput
+      attr_accessor model_invocation_output: Types::OrchestrationModelInvocationOutput
       attr_accessor observation: Types::Observation
       attr_accessor rationale: Types::Rationale
       attr_accessor unknown: untyped
-      SENSITIVE: [:invocation_input, :model_invocation_input, :observation, :rationale]
+      SENSITIVE: [:invocation_input, :model_invocation_input, :model_invocation_output, :observation, :rationale]
 
       class InvocationInput < OrchestrationTrace
       end
       class ModelInvocationInput < OrchestrationTrace
       end
+      class ModelInvocationOutput < OrchestrationTrace
+      end
       class Observation < OrchestrationTrace
       end
       class Rationale < OrchestrationTrace
@@ -674,6 +689,11 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: [:text]
     end
 
+    class RawResponse
+      attr_accessor content: ::String
+      SENSITIVE: []
+    end
+
     class RepromptResponse
       attr_accessor source: ("ACTION_GROUP" | "KNOWLEDGE_BASE" | "PARSER")
       attr_accessor text: ::String
@@ -929,6 +949,12 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: [:trace]
     end
 
+    class Usage
+      attr_accessor input_tokens: ::Integer
+      attr_accessor output_tokens: ::Integer
+      SENSITIVE: []
+    end
+
     class ValidationException
       attr_accessor message: ::String
       attr_accessor event_type: untyped

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagentruntime
 version: !ruby/object:Gem::Version
-  version: 1.17.0
+  version: 1.18.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core