Class: Aws::BedrockRuntime::Types::InvokeModelRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::BedrockRuntime::Types::InvokeModelRequest
- Defined in:
- gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:body]
Instance Attribute Summary collapse
-
#accept ⇒ String
The desired MIME type of the inference body in the response.
-
#body ⇒ String
The prompt and inference parameters in the format specified in the
contentType
in the header. -
#content_type ⇒ String
The MIME type of the input data in the request.
-
#guardrail_identifier ⇒ String
The unique identifier of the guardrail that you want to use.
-
#guardrail_version ⇒ String
The version number for the guardrail.
-
#model_id ⇒ String
The unique identifier of the model to invoke to run inference.
-
#trace ⇒ String
Specifies whether to enable or disable the Bedrock trace.
Instance Attribute Details
#accept ⇒ String
The desired MIME type of the inference body in the response. The
default value is application/json
.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 115 class InvokeModelRequest < Struct.new( :body, :content_type, :accept, :model_id, :trace, :guardrail_identifier, :guardrail_version) SENSITIVE = [:body] include Aws::Structure end |
#body ⇒ String
The prompt and inference parameters in the format specified in the
contentType
in the header. To see the format and content of the
request and response bodies for different models, refer to
Inference parameters. For more information, see Run
inference in the Bedrock User Guide.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 115 class InvokeModelRequest < Struct.new( :body, :content_type, :accept, :model_id, :trace, :guardrail_identifier, :guardrail_version) SENSITIVE = [:body] include Aws::Structure end |
#content_type ⇒ String
The MIME type of the input data in the request. The default value is
application/json
.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 115 class InvokeModelRequest < Struct.new( :body, :content_type, :accept, :model_id, :trace, :guardrail_identifier, :guardrail_version) SENSITIVE = [:body] include Aws::Structure end |
#guardrail_identifier ⇒ String
The unique identifier of the guardrail that you want to use. If you don't provide a value, no guardrail is applied to the invocation.
An error will be thrown in the following situations.
You don't provide a guardrail identifier but you specify the
amazon-bedrock-guardrailConfig
field in the request body.You enable the guardrail but the
contentType
isn'tapplication/json
.You provide a guardrail identifier, but
guardrailVersion
isn't specified.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 115 class InvokeModelRequest < Struct.new( :body, :content_type, :accept, :model_id, :trace, :guardrail_identifier, :guardrail_version) SENSITIVE = [:body] include Aws::Structure end |
#guardrail_version ⇒ String
The version number for the guardrail. The value can also be DRAFT
.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 115 class InvokeModelRequest < Struct.new( :body, :content_type, :accept, :model_id, :trace, :guardrail_identifier, :guardrail_version) SENSITIVE = [:body] include Aws::Structure end |
#model_id ⇒ String
The unique identifier of the model to invoke to run inference.
The modelId
to provide depends on the type of model 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 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.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 115 class InvokeModelRequest < Struct.new( :body, :content_type, :accept, :model_id, :trace, :guardrail_identifier, :guardrail_version) SENSITIVE = [:body] include Aws::Structure end |
#trace ⇒ String
Specifies whether to enable or disable the Bedrock trace. If enabled, you can see the full Bedrock trace.
115 116 117 118 119 120 121 122 123 124 125 |
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 115 class InvokeModelRequest < Struct.new( :body, :content_type, :accept, :model_id, :trace, :guardrail_identifier, :guardrail_version) SENSITIVE = [:body] include Aws::Structure end |