Class: Aws::BedrockRuntime::Types::ConverseStreamRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::BedrockRuntime::Types::ConverseStreamRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-bedrockruntime/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#additional_model_request_fields ⇒ Hash, ...
Additional inference parameters that the model supports, beyond the base set of inference parameters that ‘ConverseStream` supports in the `inferenceConfig` field.
-
#additional_model_response_field_paths ⇒ Array<String>
Additional model parameters field paths to return in the response.
-
#guardrail_config ⇒ Types::GuardrailStreamConfiguration
Configuration information for a guardrail that you want to use in the request.
-
#inference_config ⇒ Types::InferenceConfiguration
Inference parameters to pass to the model.
-
#messages ⇒ Array<Types::Message>
The messages that you want to send to the model.
-
#model_id ⇒ String
The ID for the model.
-
#system ⇒ Array<Types::SystemContentBlock>
A system prompt to send to the model.
-
#tool_config ⇒ Types::ToolConfiguration
Configuration information for the tools that the model can use when generating a response.
Instance Attribute Details
#additional_model_request_fields ⇒ Hash, ...
Additional inference parameters that the model supports, beyond the base set of inference parameters that ‘ConverseStream` supports in the `inferenceConfig` field.
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |
#additional_model_response_field_paths ⇒ Array<String>
Additional model parameters field paths to return in the response. ‘ConverseStream` returns the requested fields as a JSON Pointer object in the `additionalModelResponseFields` field. The following is example JSON for `additionalModelResponseFieldPaths`.
‘[ “/stop_sequence” ]`
For information about the JSON Pointer syntax, see the [Internet Engineering Task Force (IETF)] documentation.
‘ConverseStream` rejects an empty JSON Pointer or incorrectly structured JSON Pointer with a `400` error code. if the JSON Pointer is valid, but the requested field is not in the model response, it is ignored by `ConverseStream`.
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |
#guardrail_config ⇒ Types::GuardrailStreamConfiguration
Configuration information for a guardrail that you want to use in the request.
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |
#inference_config ⇒ Types::InferenceConfiguration
Inference parameters to pass to the model. ‘ConverseStream` supports a base set of inference parameters. If you need to pass additional parameters that the model supports, use the `additionalModelRequestFields` request field.
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |
#messages ⇒ Array<Types::Message>
The messages that you want to send to the model.
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |
#model_id ⇒ String
The ID for the model.
The ‘modelId` to provide depends on the type of model or throughput that you use:
-
If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see [Amazon Bedrock base model IDs (on-demand throughput)] in the Amazon Bedrock User Guide.
-
If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see [Supported Regions and models for cross-region inference] in the Amazon Bedrock User Guide.
-
If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see [Run inference using a Provisioned Throughput] in the Amazon Bedrock User Guide.
-
If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see [Use a custom model in Amazon Bedrock] in the Amazon Bedrock User Guide.
The Converse API doesn’t support [imported models].
[1]: docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns [2]: docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html [3]: docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html [4]: docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html [5]: docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |
#system ⇒ Array<Types::SystemContentBlock>
A system prompt to send to the model.
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |
#tool_config ⇒ Types::ToolConfiguration
Configuration information for the tools that the model can use when generating a response.
<note markdown=“1”> This field is only supported by Anthropic Claude 3 models.
</note>
606 607 608 609 610 611 612 613 614 615 616 617 |
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 606 class ConverseStreamRequest < Struct.new( :model_id, :messages, :system, :inference_config, :tool_config, :guardrail_config, :additional_model_request_fields, :additional_model_response_field_paths) SENSITIVE = [] include Aws::Structure end |