Class: Aws::BedrockRuntime::Types::ConverseStreamRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-bedrockruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:prompt_variables, :request_metadata]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_model_request_fields ⇒ Hash, ...

Additional inference parameters that the model supports, beyond the base set of inference parameters that Converse and ConverseStream support in the inferenceConfig field. For more information, see [Model parameters].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html

Returns:

  • (Hash, Array, String, Numeric, Boolean) 


1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#additional_model_response_field_paths ⇒ Array<String>

Additional model parameters field paths to return in the response. Converse and ConverseStream return 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.

Converse and ConverseStream reject 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 Converse.

[1]: datatracker.ietf.org/doc/html/rfc6901

Returns:

  • (Array<String>) 


1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#guardrail_config ⇒ Types::GuardrailStreamConfiguration

Configuration information for a guardrail that you want to use in the request. If you include guardContent blocks in the content field in the messages field, the guardrail operates only on those messages. If you include no guardContent blocks, the guardrail operates on all messages in the request body and in any included prompt resource.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#inference_config ⇒ Types::InferenceConfiguration

Inference parameters to pass to the model. Converse and ConverseStream support a base set of inference parameters. If you need to pass additional parameters that the model supports, use the additionalModelRequestFields request field.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#messages ⇒ Array<Types::Message>

The messages that you want to send to the model.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#model_id ⇒ String

Specifies the model or throughput with which to run inference, or the prompt resource to use in inference. The value depends on the resource 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.

  • To include a prompt that was defined in [Prompt management], specify the ARN of the prompt version to use.

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/prompt-management.html [6]: docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html

Returns:

  • (String) 


1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#performance_config ⇒ Types::PerformanceConfiguration

Model performance settings for the request.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#prompt_variables ⇒ Hash<String,Types::PromptVariableValues>

Contains a map of variables in a prompt from Prompt management to objects containing the values to fill in for them when running model invocation. This field is ignored if you don’t specify a prompt resource in the modelId field.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#request_metadata ⇒ Hash<String,String>

Key-value pairs that you can use to filter invocation logs.

Returns:

  • (Hash<String,String>) 


1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#service_tier ⇒ Types::ServiceTier

Specifies the processing tier configuration used for serving the request.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#system ⇒ Array<Types::SystemContentBlock>

A prompt that provides instructions or context to the model about the task it should perform, or the persona it should adopt during the conversation.

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end

#tool_config ⇒ Types::ToolConfiguration

Configuration information for the tools that the model can use when generating a response.

For information about models that support streaming tool use, see [Supported models and model features].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features

Returns:



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
 
# File 'lib/aws-sdk-bedrockruntime/types.rb', line 1346

class ConverseStreamRequest < Struct.new(
  :model_id,
  :messages,
  :system,
  :inference_config,
  :tool_config,
  :guardrail_config,
  :additional_model_request_fields,
  :prompt_variables,
  :additional_model_response_field_paths,
  :request_metadata,
  :performance_config,
  :service_tier)
  SENSITIVE = [:prompt_variables, :request_metadata]
  include Aws::Structure
end