# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::Bedrock module Types # The request is denied because of missing access permissions. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AccessDeniedException AWS API Documentation # class AccessDeniedException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Use to specify a automatic model evaluation job. The # `EvaluationDatasetMetricConfig` object is used to specify the prompt # datasets, task type, and metric names. # # @!attribute [rw] dataset_metric_configs # Specifies the required elements for an automatic model evaluation # job. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AutomatedEvaluationConfig AWS API Documentation # class AutomatedEvaluationConfig < Struct.new( :dataset_metric_configs) SENSITIVE = [] include Aws::Structure end # CloudWatch logging configuration. # # @!attribute [rw] log_group_name # The log group name. # @return [String] # # @!attribute [rw] role_arn # The role Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] large_data_delivery_s3_config # S3 configuration for delivering a large amount of data. # @return [Types::S3Config] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CloudWatchConfig AWS API Documentation # class CloudWatchConfig < Struct.new( :log_group_name, :role_arn, :large_data_delivery_s3_config) SENSITIVE = [] include Aws::Structure end # Error occurred because of a conflict while performing an operation. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ConflictException AWS API Documentation # class ConflictException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_name # The name of the model evaluation job. Model evaluation job names # must unique with your AWS account, and your account's AWS region. # @return [String] # # @!attribute [rw] job_description # A description of the model evaluation job. # @return [String] # # @!attribute [rw] client_request_token # A unique, case-sensitive identifier to ensure that the API request # completes no more than one time. If this token matches a previous # request, Amazon Bedrock ignores the request, but does not return an # error. For more information, see [Ensuring idempotency][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM service role that Amazon # Bedrock can assume to perform tasks on your behalf. The service role # must have Amazon Bedrock as the service principal, and provide # access to any Amazon S3 buckets specified in the `EvaluationConfig` # object. To pass this role to Amazon Bedrock, the caller of this API # must have the `iam:PassRole` permission. To learn more about the # required permissions, see [Required permissions][1]. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-security.html # @return [String] # # @!attribute [rw] customer_encryption_key_id # Specify your customer managed key ARN that will be used to encrypt # your model evaluation job. # @return [String] # # @!attribute [rw] job_tags # Tags to attach to the model evaluation job. # @return [Array] # # @!attribute [rw] evaluation_config # Specifies whether the model evaluation job is automatic or uses # human worker. # @return [Types::EvaluationConfig] # # @!attribute [rw] inference_config # Specify the models you want to use in your model evaluation job. # Automatic model evaluation jobs support a single model, and model # evaluation job that use human workers support two models. # @return [Types::EvaluationInferenceConfig] # # @!attribute [rw] output_data_config # An object that defines where the results of model evaluation job # will be saved in Amazon S3. # @return [Types::EvaluationOutputDataConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateEvaluationJobRequest AWS API Documentation # class CreateEvaluationJobRequest < Struct.new( :job_name, :job_description, :client_request_token, :role_arn, :customer_encryption_key_id, :job_tags, :evaluation_config, :inference_config, :output_data_config) SENSITIVE = [:job_description] include Aws::Structure end # @!attribute [rw] job_arn # The ARN of the model evaluation job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateEvaluationJobResponse AWS API Documentation # class CreateEvaluationJobResponse < Struct.new( :job_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name to give the guardrail. # @return [String] # # @!attribute [rw] description # A description of the guardrail. # @return [String] # # @!attribute [rw] topic_policy_config # The topic policies to configure for the guardrail. # @return [Types::GuardrailTopicPolicyConfig] # # @!attribute [rw] content_policy_config # The content filter policies to configure for the guardrail. # @return [Types::GuardrailContentPolicyConfig] # # @!attribute [rw] word_policy_config # The word policy you configure for the guardrail. # @return [Types::GuardrailWordPolicyConfig] # # @!attribute [rw] sensitive_information_policy_config # The sensitive information policy to configure for the guardrail. # @return [Types::GuardrailSensitiveInformationPolicyConfig] # # @!attribute [rw] blocked_input_messaging # The message to return when the guardrail blocks a prompt. # @return [String] # # @!attribute [rw] blocked_outputs_messaging # The message to return when the guardrail blocks a model response. # @return [String] # # @!attribute [rw] kms_key_id # The ARN of the KMS key that you use to encrypt the guardrail. # @return [String] # # @!attribute [rw] tags # The tags that you want to attach to the guardrail. # @return [Array] # # @!attribute [rw] client_request_token # A unique, case-sensitive identifier to ensure that the API request # completes no more than once. If this token matches a previous # request, Amazon Bedrock ignores the request, but does not return an # error. For more information, see [Ensuring idempotency][1] in the # *Amazon S3 User Guide*. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailRequest AWS API Documentation # class CreateGuardrailRequest < Struct.new( :name, :description, :topic_policy_config, :content_policy_config, :word_policy_config, :sensitive_information_policy_config, :blocked_input_messaging, :blocked_outputs_messaging, :kms_key_id, :tags, :client_request_token) SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging] include Aws::Structure end # @!attribute [rw] guardrail_id # The unique identifier of the guardrail that was created. # @return [String] # # @!attribute [rw] guardrail_arn # The ARN of the guardrail that was created. # @return [String] # # @!attribute [rw] version # The version of the guardrail that was created. This value should be # 1. # @return [String] # # @!attribute [rw] created_at # The time at which the guardrail was created. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailResponse AWS API Documentation # class CreateGuardrailResponse < Struct.new( :guardrail_id, :guardrail_arn, :version, :created_at) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] guardrail_identifier # The unique identifier of the guardrail. # @return [String] # # @!attribute [rw] description # A description of the guardrail version. # @return [String] # # @!attribute [rw] client_request_token # A unique, case-sensitive identifier to ensure that the API request # completes no more than once. If this token matches a previous # request, Amazon Bedrock ignores the request, but does not return an # error. For more information, see [Ensuring idempotency][1] in the # *Amazon S3 User Guide*. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailVersionRequest AWS API Documentation # class CreateGuardrailVersionRequest < Struct.new( :guardrail_identifier, :description, :client_request_token) SENSITIVE = [:description] include Aws::Structure end # @!attribute [rw] guardrail_id # The unique identifier of the guardrail. # @return [String] # # @!attribute [rw] version # The number of the version of the guardrail. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateGuardrailVersionResponse AWS API Documentation # class CreateGuardrailVersionResponse < Struct.new( :guardrail_id, :version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_name # A name for the fine-tuning job. # @return [String] # # @!attribute [rw] custom_model_name # A name for the resulting custom model. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of an IAM service role that Amazon # Bedrock can assume to perform tasks on your behalf. For example, # during model training, Amazon Bedrock needs your permission to read # input data from an S3 bucket, write model artifacts to an S3 bucket. # To pass this role to Amazon Bedrock, the caller of this API must # have the `iam:PassRole` permission. # @return [String] # # @!attribute [rw] client_request_token # A unique, case-sensitive identifier to ensure that the API request # completes no more than one time. If this token matches a previous # request, Amazon Bedrock ignores the request, but does not return an # error. For more information, see [Ensuring idempotency][1]. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html # @return [String] # # @!attribute [rw] base_model_identifier # Name of the base model. # @return [String] # # @!attribute [rw] customization_type # The customization type. # @return [String] # # @!attribute [rw] custom_model_kms_key_id # The custom model is encrypted at rest using this key. # @return [String] # # @!attribute [rw] job_tags # Tags to attach to the job. # @return [Array] # # @!attribute [rw] custom_model_tags # Tags to attach to the resulting custom model. # @return [Array] # # @!attribute [rw] training_data_config # Information about the training dataset. # @return [Types::TrainingDataConfig] # # @!attribute [rw] validation_data_config # Information about the validation dataset. # @return [Types::ValidationDataConfig] # # @!attribute [rw] output_data_config # S3 location for the output data. # @return [Types::OutputDataConfig] # # @!attribute [rw] hyper_parameters # Parameters related to tuning the model. For details on the format # for different models, see [Custom model hyperparameters][1]. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html # @return [Hash] # # @!attribute [rw] vpc_config # VPC configuration (optional). Configuration parameters for the # private Virtual Private Cloud (VPC) that contains the resources you # are using for this job. # @return [Types::VpcConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelCustomizationJobRequest AWS API Documentation # class CreateModelCustomizationJobRequest < Struct.new( :job_name, :custom_model_name, :role_arn, :client_request_token, :base_model_identifier, :customization_type, :custom_model_kms_key_id, :job_tags, :custom_model_tags, :training_data_config, :validation_data_config, :output_data_config, :hyper_parameters, :vpc_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_arn # Amazon Resource Name (ARN) of the fine tuning job # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateModelCustomizationJobResponse AWS API Documentation # class CreateModelCustomizationJobResponse < Struct.new( :job_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] client_request_token # A unique, case-sensitive identifier to ensure that the API request # completes no more than one time. If this token matches a previous # request, Amazon Bedrock ignores the request, but does not return an # error. For more information, see [Ensuring idempotency][1] in the # Amazon S3 User Guide. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # # # # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html # @return [String] # # @!attribute [rw] model_units # Number of model units to allocate. A model unit delivers a specific # throughput level for the specified model. The throughput level of a # model unit specifies the total number of input and output tokens # that it can process and generate within a span of one minute. By # default, your account has no model units for purchasing Provisioned # Throughputs with commitment. You must first visit the [Amazon Web # Services support center][1] to request MUs. # # For model unit quotas, see [Provisioned Throughput quotas][2] in the # Amazon Bedrock User Guide. # # For more information about what an MU specifies, contact your Amazon # Web Services account manager. # # # # [1]: https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/quotas.html#prov-thru-quotas # @return [Integer] # # @!attribute [rw] provisioned_model_name # The name for this Provisioned Throughput. # @return [String] # # @!attribute [rw] model_id # The Amazon Resource Name (ARN) or name of the model to associate # with this Provisioned Throughput. For a list of models for which you # can purchase Provisioned Throughput, see [Amazon Bedrock model IDs # for purchasing Provisioned Throughput][1] in the Amazon Bedrock User # Guide. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#prov-throughput-models # @return [String] # # @!attribute [rw] commitment_duration # The commitment duration requested for the Provisioned Throughput. # Billing occurs hourly and is discounted for longer commitment terms. # To request a no-commit Provisioned Throughput, omit this field. # # Custom models support all levels of commitment. To see which base # models support no commitment, see [Supported regions and models for # Provisioned Throughput][1] in the Amazon Bedrock User Guide # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/pt-supported.html # @return [String] # # @!attribute [rw] tags # Tags to associate with this Provisioned Throughput. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateProvisionedModelThroughputRequest AWS API Documentation # class CreateProvisionedModelThroughputRequest < Struct.new( :client_request_token, :model_units, :provisioned_model_name, :model_id, :commitment_duration, :tags) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] provisioned_model_arn # The Amazon Resource Name (ARN) for this Provisioned Throughput. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateProvisionedModelThroughputResponse AWS API Documentation # class CreateProvisionedModelThroughputResponse < Struct.new( :provisioned_model_arn) SENSITIVE = [] include Aws::Structure end # Summary information for a custom model. # # @!attribute [rw] model_arn # The Amazon Resource Name (ARN) of the custom model. # @return [String] # # @!attribute [rw] model_name # The name of the custom model. # @return [String] # # @!attribute [rw] creation_time # Creation time of the model. # @return [Time] # # @!attribute [rw] base_model_arn # The base model Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] base_model_name # The base model name. # @return [String] # # @!attribute [rw] customization_type # Specifies whether to carry out continued pre-training of a model or # whether to fine-tune it. For more information, see [Custom # models][1]. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelSummary AWS API Documentation # class CustomModelSummary < Struct.new( :model_arn, :model_name, :creation_time, :base_model_arn, :base_model_name, :customization_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] model_identifier # Name of the model to delete. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelRequest AWS API Documentation # class DeleteCustomModelRequest < Struct.new( :model_identifier) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelResponse AWS API Documentation # class DeleteCustomModelResponse < Aws::EmptyStructure; end # @!attribute [rw] guardrail_identifier # The unique identifier of the guardrail. # @return [String] # # @!attribute [rw] guardrail_version # The version of the guardrail. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteGuardrailRequest AWS API Documentation # class DeleteGuardrailRequest < Struct.new( :guardrail_identifier, :guardrail_version) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteGuardrailResponse AWS API Documentation # class DeleteGuardrailResponse < Aws::EmptyStructure; end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteModelInvocationLoggingConfigurationRequest AWS API Documentation # class DeleteModelInvocationLoggingConfigurationRequest < Aws::EmptyStructure; end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteModelInvocationLoggingConfigurationResponse AWS API Documentation # class DeleteModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end # @!attribute [rw] provisioned_model_id # The Amazon Resource Name (ARN) or name of the Provisioned # Throughput. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteProvisionedModelThroughputRequest AWS API Documentation # class DeleteProvisionedModelThroughputRequest < Struct.new( :provisioned_model_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteProvisionedModelThroughputResponse AWS API Documentation # class DeleteProvisionedModelThroughputResponse < Aws::EmptyStructure; end # Contains the ARN of the Amazon Bedrock models specified in your model # evaluation job. Each Amazon Bedrock model supports different # `inferenceParams`. To learn more about supported inference parameters # for Amazon Bedrock models, see [Inference parameters for foundation # models][1]. # # The `inferenceParams` are specified using JSON. To successfully insert # JSON as string make sure that all quotations are properly escaped. For # example, `"temperature":"0.25"` key value pair would need to be # formatted as `"temperature":"0.25"` to successfully accepted in # the request. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html # # @!attribute [rw] model_identifier # The ARN of the Amazon Bedrock model specified. # @return [String] # # @!attribute [rw] inference_params # Each Amazon Bedrock support different inference parameters that # change how the model behaves during inference. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationBedrockModel AWS API Documentation # class EvaluationBedrockModel < Struct.new( :model_identifier, :inference_params) SENSITIVE = [:inference_params] include Aws::Structure end # Used to specify either a `AutomatedEvaluationConfig` or # `HumanEvaluationConfig` object. # # @note EvaluationConfig is a union - when making an API calls you must set exactly one of the members. # # @note EvaluationConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationConfig corresponding to the set member. # # @!attribute [rw] automated # Used to specify an automated model evaluation job. See # `AutomatedEvaluationConfig` to view the required parameters. # @return [Types::AutomatedEvaluationConfig] # # @!attribute [rw] human # Used to specify a model evaluation job that uses human workers.See # `HumanEvaluationConfig` to view the required parameters. # @return [Types::HumanEvaluationConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationConfig AWS API Documentation # class EvaluationConfig < Struct.new( :automated, :human, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class Automated < EvaluationConfig; end class Human < EvaluationConfig; end class Unknown < EvaluationConfig; end end # Used to specify the name of a built-in prompt dataset and optionally, # the Amazon S3 bucket where a custom prompt dataset is saved. # # @!attribute [rw] name # Used to specify supported built-in prompt datasets. Valid values are # `Builtin.Bold`, `Builtin.BoolQ`, `Builtin.NaturalQuestions`, # `Builtin.Gigaword`, `Builtin.RealToxicityPrompts`, # `Builtin.TriviaQa`, `Builtin.T-Rex`, # `Builtin.WomensEcommerceClothingReviews` and `Builtin.Wikitext2`. # @return [String] # # @!attribute [rw] dataset_location # For custom prompt datasets, you must specify the location in Amazon # S3 where the prompt dataset is saved. # @return [Types::EvaluationDatasetLocation] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationDataset AWS API Documentation # class EvaluationDataset < Struct.new( :name, :dataset_location) SENSITIVE = [:name] include Aws::Structure end # The location in Amazon S3 where your prompt dataset is stored. # # @note EvaluationDatasetLocation is a union - when making an API calls you must set exactly one of the members. # # @note EvaluationDatasetLocation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationDatasetLocation corresponding to the set member. # # @!attribute [rw] s3_uri # The S3 URI of the S3 bucket specified in the job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationDatasetLocation AWS API Documentation # class EvaluationDatasetLocation < Struct.new( :s3_uri, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class S3Uri < EvaluationDatasetLocation; end class Unknown < EvaluationDatasetLocation; end end # Defines the built-in prompt datasets, built-in metric names and custom # metric names, and the task type. # # @!attribute [rw] task_type # The task type you want the model to carry out. # @return [String] # # @!attribute [rw] dataset # Specifies the prompt dataset. # @return [Types::EvaluationDataset] # # @!attribute [rw] metric_names # The names of the metrics used. For automated model evaluation jobs # valid values are `"Builtin.Accuracy"`, `"Builtin.Robustness"`, and # `"Builtin.Toxicity"`. In human-based model evaluation jobs the array # of strings must match the `name` parameter specified in # `HumanEvaluationCustomMetric`. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationDatasetMetricConfig AWS API Documentation # class EvaluationDatasetMetricConfig < Struct.new( :task_type, :dataset, :metric_names) SENSITIVE = [] include Aws::Structure end # Used to define the models you want used in your model evaluation job. # Automated model evaluation jobs support only a single model. In a # human-based model evaluation job, your annotator can compare the # responses for up to two different models. # # @note EvaluationInferenceConfig is a union - when making an API calls you must set exactly one of the members. # # @note EvaluationInferenceConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationInferenceConfig corresponding to the set member. # # @!attribute [rw] models # Used to specify the models. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationInferenceConfig AWS API Documentation # class EvaluationInferenceConfig < Struct.new( :models, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class Models < EvaluationInferenceConfig; end class Unknown < EvaluationInferenceConfig; end end # Defines the models used in the model evaluation job. # # @note EvaluationModelConfig is a union - when making an API calls you must set exactly one of the members. # # @note EvaluationModelConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationModelConfig corresponding to the set member. # # @!attribute [rw] bedrock_model # Defines the Amazon Bedrock model and inference parameters you want # used. # @return [Types::EvaluationBedrockModel] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationModelConfig AWS API Documentation # class EvaluationModelConfig < Struct.new( :bedrock_model, :unknown) SENSITIVE = [] include Aws::Structure include Aws::Structure::Union class BedrockModel < EvaluationModelConfig; end class Unknown < EvaluationModelConfig; end end # The Amazon S3 location where the results of your model evaluation job # are saved. # # @!attribute [rw] s3_uri # The Amazon S3 URI where the results of model evaluation job are # saved. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationOutputDataConfig AWS API Documentation # class EvaluationOutputDataConfig < Struct.new( :s3_uri) SENSITIVE = [] include Aws::Structure end # A summary of the model evaluation job. # # @!attribute [rw] job_arn # The Amazon Resource Name (ARN) of the model evaluation job. # @return [String] # # @!attribute [rw] job_name # The name of the model evaluation job. # @return [String] # # @!attribute [rw] status # The current status of the model evaluation job. # @return [String] # # @!attribute [rw] creation_time # When the model evaluation job was created. # @return [Time] # # @!attribute [rw] job_type # The type, either human or automatic, of model evaluation job. # @return [String] # # @!attribute [rw] evaluation_task_types # What task type was used in the model evaluation job. # @return [Array] # # @!attribute [rw] model_identifiers # The Amazon Resource Names (ARNs) of the model(s) used in the model # evaluation job. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/EvaluationSummary AWS API Documentation # class EvaluationSummary < Struct.new( :job_arn, :job_name, :status, :creation_time, :job_type, :evaluation_task_types, :model_identifiers) SENSITIVE = [] include Aws::Structure end # Information about a foundation model. # # @!attribute [rw] model_arn # The model Amazon Resource Name (ARN). # @return [String] # # @!attribute [rw] model_id # The model identifier. # @return [String] # # @!attribute [rw] model_name # The model name. # @return [String] # # @!attribute [rw] provider_name # The model's provider name. # @return [String] # # @!attribute [rw] input_modalities # The input modalities that the model supports. # @return [Array] # # @!attribute [rw] output_modalities # The output modalities that the model supports. # @return [Array] # # @!attribute [rw] response_streaming_supported # Indicates whether the model supports streaming. # @return [Boolean] # # @!attribute [rw] customizations_supported # The customization that the model supports. # @return [Array] # # @!attribute [rw] inference_types_supported # The inference types that the model supports. # @return [Array] # # @!attribute [rw] model_lifecycle # Contains details about whether a model version is available or # deprecated # @return [Types::FoundationModelLifecycle] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelDetails AWS API Documentation # class FoundationModelDetails < Struct.new( :model_arn, :model_id, :model_name, :provider_name, :input_modalities, :output_modalities, :response_streaming_supported, :customizations_supported, :inference_types_supported, :model_lifecycle) SENSITIVE = [] include Aws::Structure end # Details about whether a model version is available or deprecated. # # @!attribute [rw] status # Specifies whether a model version is available (`ACTIVE`) or # deprecated (`LEGACY`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelLifecycle AWS API Documentation # class FoundationModelLifecycle < Struct.new( :status) SENSITIVE = [] include Aws::Structure end # Summary information for a foundation model. # # @!attribute [rw] model_arn # The Amazon Resource Name (ARN) of the foundation model. # @return [String] # # @!attribute [rw] model_id # The model ID of the foundation model. # @return [String] # # @!attribute [rw] model_name # The name of the model. # @return [String] # # @!attribute [rw] provider_name # The model's provider name. # @return [String] # # @!attribute [rw] input_modalities # The input modalities that the model supports. # @return [Array] # # @!attribute [rw] output_modalities # The output modalities that the model supports. # @return [Array] # # @!attribute [rw] response_streaming_supported # Indicates whether the model supports streaming. # @return [Boolean] # # @!attribute [rw] customizations_supported # Whether the model supports fine-tuning or continual pre-training. # @return [Array] # # @!attribute [rw] inference_types_supported # The inference types that the model supports. # @return [Array] # # @!attribute [rw] model_lifecycle # Contains details about whether a model version is available or # deprecated. # @return [Types::FoundationModelLifecycle] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FoundationModelSummary AWS API Documentation # class FoundationModelSummary < Struct.new( :model_arn, :model_id, :model_name, :provider_name, :input_modalities, :output_modalities, :response_streaming_supported, :customizations_supported, :inference_types_supported, :model_lifecycle) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] model_identifier # Name or Amazon Resource Name (ARN) of the custom model. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelRequest AWS API Documentation # class GetCustomModelRequest < Struct.new( :model_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] model_arn # Amazon Resource Name (ARN) associated with this model. # @return [String] # # @!attribute [rw] model_name # Model name associated with this model. # @return [String] # # @!attribute [rw] job_name # Job name associated with this model. # @return [String] # # @!attribute [rw] job_arn # Job Amazon Resource Name (ARN) associated with this model. # @return [String] # # @!attribute [rw] base_model_arn # Amazon Resource Name (ARN) of the base model. # @return [String] # # @!attribute [rw] customization_type # The type of model customization. # @return [String] # # @!attribute [rw] model_kms_key_arn # The custom model is encrypted at rest using this key. # @return [String] # # @!attribute [rw] hyper_parameters # Hyperparameter values associated with this model. For details on the # format for different models, see [Custom model hyperparameters][1]. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html # @return [Hash] # # @!attribute [rw] training_data_config # Contains information about the training dataset. # @return [Types::TrainingDataConfig] # # @!attribute [rw] validation_data_config # Contains information about the validation dataset. # @return [Types::ValidationDataConfig] # # @!attribute [rw] output_data_config # Output data configuration associated with this custom model. # @return [Types::OutputDataConfig] # # @!attribute [rw] training_metrics # Contains training metrics from the job creation. # @return [Types::TrainingMetrics] # # @!attribute [rw] validation_metrics # The validation metrics from the job creation. # @return [Array] # # @!attribute [rw] creation_time # Creation time of the model. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelResponse AWS API Documentation # class GetCustomModelResponse < Struct.new( :model_arn, :model_name, :job_name, :job_arn, :base_model_arn, :customization_type, :model_kms_key_arn, :hyper_parameters, :training_data_config, :validation_data_config, :output_data_config, :training_metrics, :validation_metrics, :creation_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_identifier # The Amazon Resource Name (ARN) of the model evaluation job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetEvaluationJobRequest AWS API Documentation # class GetEvaluationJobRequest < Struct.new( :job_identifier) SENSITIVE = [:job_identifier] include Aws::Structure end # @!attribute [rw] job_name # The name of the model evaluation job. # @return [String] # # @!attribute [rw] status # The status of the model evaluation job. # @return [String] # # @!attribute [rw] job_arn # The Amazon Resource Name (ARN) of the model evaluation job. # @return [String] # # @!attribute [rw] job_description # The description of the model evaluation job. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of the IAM service role used in the # model evaluation job. # @return [String] # # @!attribute [rw] customer_encryption_key_id # The Amazon Resource Name (ARN) of the customer managed key specified # when the model evaluation job was created. # @return [String] # # @!attribute [rw] job_type # The type of model evaluation job. # @return [String] # # @!attribute [rw] evaluation_config # Contains details about the type of model evaluation job, the metrics # used, the task type selected, the datasets used, and any custom # metrics you defined. # @return [Types::EvaluationConfig] # # @!attribute [rw] inference_config # Details about the models you specified in your model evaluation job. # @return [Types::EvaluationInferenceConfig] # # @!attribute [rw] output_data_config # Amazon S3 location for where output data is saved. # @return [Types::EvaluationOutputDataConfig] # # @!attribute [rw] creation_time # When the model evaluation job was created. # @return [Time] # # @!attribute [rw] last_modified_time # When the model evaluation job was last modified. # @return [Time] # # @!attribute [rw] failure_messages # An array of strings the specify why the model evaluation job has # failed. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetEvaluationJobResponse AWS API Documentation # class GetEvaluationJobResponse < Struct.new( :job_name, :status, :job_arn, :job_description, :role_arn, :customer_encryption_key_id, :job_type, :evaluation_config, :inference_config, :output_data_config, :creation_time, :last_modified_time, :failure_messages) SENSITIVE = [:job_description] include Aws::Structure end # @!attribute [rw] model_identifier # The model identifier. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelRequest AWS API Documentation # class GetFoundationModelRequest < Struct.new( :model_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] model_details # Information about the foundation model. # @return [Types::FoundationModelDetails] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelResponse AWS API Documentation # class GetFoundationModelResponse < Struct.new( :model_details) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] guardrail_identifier # The unique identifier of the guardrail for which to get details. # @return [String] # # @!attribute [rw] guardrail_version # The version of the guardrail for which to get details. If you don't # specify a version, the response returns details for the `DRAFT` # version. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetGuardrailRequest AWS API Documentation # class GetGuardrailRequest < Struct.new( :guardrail_identifier, :guardrail_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] name # The name of the guardrail. # @return [String] # # @!attribute [rw] description # The description of the guardrail. # @return [String] # # @!attribute [rw] guardrail_id # The unique identifier of the guardrail. # @return [String] # # @!attribute [rw] guardrail_arn # The ARN of the guardrail that was created. # @return [String] # # @!attribute [rw] version # The version of the guardrail. # @return [String] # # @!attribute [rw] status # The status of the guardrail. # @return [String] # # @!attribute [rw] topic_policy # The topic policy that was configured for the guardrail. # @return [Types::GuardrailTopicPolicy] # # @!attribute [rw] content_policy # The content policy that was configured for the guardrail. # @return [Types::GuardrailContentPolicy] # # @!attribute [rw] word_policy # The word policy that was configured for the guardrail. # @return [Types::GuardrailWordPolicy] # # @!attribute [rw] sensitive_information_policy # The sensitive information policy that was configured for the # guardrail. # @return [Types::GuardrailSensitiveInformationPolicy] # # @!attribute [rw] created_at # The date and time at which the guardrail was created. # @return [Time] # # @!attribute [rw] updated_at # The date and time at which the guardrail was updated. # @return [Time] # # @!attribute [rw] status_reasons # Appears if the `status` is `FAILED`. A list of reasons for why the # guardrail failed to be created, updated, versioned, or deleted. # @return [Array] # # @!attribute [rw] failure_recommendations # Appears if the `status` of the guardrail is `FAILED`. A list of # recommendations to carry out before retrying the request. # @return [Array] # # @!attribute [rw] blocked_input_messaging # The message that the guardrail returns when it blocks a prompt. # @return [String] # # @!attribute [rw] blocked_outputs_messaging # The message that the guardrail returns when it blocks a model # response. # @return [String] # # @!attribute [rw] kms_key_arn # The ARN of the KMS key that encrypts the guardrail. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetGuardrailResponse AWS API Documentation # class GetGuardrailResponse < Struct.new( :name, :description, :guardrail_id, :guardrail_arn, :version, :status, :topic_policy, :content_policy, :word_policy, :sensitive_information_policy, :created_at, :updated_at, :status_reasons, :failure_recommendations, :blocked_input_messaging, :blocked_outputs_messaging, :kms_key_arn) SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging] include Aws::Structure end # @!attribute [rw] job_identifier # Identifier for the customization job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCustomizationJobRequest AWS API Documentation # class GetModelCustomizationJobRequest < Struct.new( :job_identifier) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_arn # The Amazon Resource Name (ARN) of the customization job. # @return [String] # # @!attribute [rw] job_name # The name of the customization job. # @return [String] # # @!attribute [rw] output_model_name # The name of the output model. # @return [String] # # @!attribute [rw] output_model_arn # The Amazon Resource Name (ARN) of the output model. # @return [String] # # @!attribute [rw] client_request_token # The token that you specified in the `CreateCustomizationJob` # request. # @return [String] # # @!attribute [rw] role_arn # The Amazon Resource Name (ARN) of the IAM role. # @return [String] # # @!attribute [rw] status # The status of the job. A successful job transitions from in-progress # to completed when the output model is ready to use. If the job # failed, the failure message contains information about why the job # failed. # @return [String] # # @!attribute [rw] failure_message # Information about why the job failed. # @return [String] # # @!attribute [rw] creation_time # Time that the resource was created. # @return [Time] # # @!attribute [rw] last_modified_time # Time that the resource was last modified. # @return [Time] # # @!attribute [rw] end_time # Time that the resource transitioned to terminal state. # @return [Time] # # @!attribute [rw] base_model_arn # Amazon Resource Name (ARN) of the base model. # @return [String] # # @!attribute [rw] hyper_parameters # The hyperparameter values for the job. For details on the format for # different models, see [Custom model hyperparameters][1]. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html # @return [Hash] # # @!attribute [rw] training_data_config # Contains information about the training dataset. # @return [Types::TrainingDataConfig] # # @!attribute [rw] validation_data_config # Contains information about the validation dataset. # @return [Types::ValidationDataConfig] # # @!attribute [rw] output_data_config # Output data configuration # @return [Types::OutputDataConfig] # # @!attribute [rw] customization_type # The type of model customization. # @return [String] # # @!attribute [rw] output_model_kms_key_arn # The custom model is encrypted at rest using this key. # @return [String] # # @!attribute [rw] training_metrics # Contains training metrics from the job creation. # @return [Types::TrainingMetrics] # # @!attribute [rw] validation_metrics # The loss metric for each validator that you provided in the # createjob request. # @return [Array] # # @!attribute [rw] vpc_config # VPC configuration for the custom model job. # @return [Types::VpcConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelCustomizationJobResponse AWS API Documentation # class GetModelCustomizationJobResponse < Struct.new( :job_arn, :job_name, :output_model_name, :output_model_arn, :client_request_token, :role_arn, :status, :failure_message, :creation_time, :last_modified_time, :end_time, :base_model_arn, :hyper_parameters, :training_data_config, :validation_data_config, :output_data_config, :customization_type, :output_model_kms_key_arn, :training_metrics, :validation_metrics, :vpc_config) SENSITIVE = [] include Aws::Structure end # @api private # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationLoggingConfigurationRequest AWS API Documentation # class GetModelInvocationLoggingConfigurationRequest < Aws::EmptyStructure; end # @!attribute [rw] logging_config # The current configuration values. # @return [Types::LoggingConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetModelInvocationLoggingConfigurationResponse AWS API Documentation # class GetModelInvocationLoggingConfigurationResponse < Struct.new( :logging_config) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] provisioned_model_id # The Amazon Resource Name (ARN) or name of the Provisioned # Throughput. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetProvisionedModelThroughputRequest AWS API Documentation # class GetProvisionedModelThroughputRequest < Struct.new( :provisioned_model_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] model_units # The number of model units allocated to this Provisioned Throughput. # @return [Integer] # # @!attribute [rw] desired_model_units # The number of model units that was requested for this Provisioned # Throughput. # @return [Integer] # # @!attribute [rw] provisioned_model_name # The name of the Provisioned Throughput. # @return [String] # # @!attribute [rw] provisioned_model_arn # The Amazon Resource Name (ARN) of the Provisioned Throughput. # @return [String] # # @!attribute [rw] model_arn # The Amazon Resource Name (ARN) of the model associated with this # Provisioned Throughput. # @return [String] # # @!attribute [rw] desired_model_arn # The Amazon Resource Name (ARN) of the model requested to be # associated to this Provisioned Throughput. This value differs from # the `modelArn` if updating hasn't completed. # @return [String] # # @!attribute [rw] foundation_model_arn # The Amazon Resource Name (ARN) of the base model for which the # Provisioned Throughput was created, or of the base model that the # custom model for which the Provisioned Throughput was created was # customized. # @return [String] # # @!attribute [rw] status # The status of the Provisioned Throughput. # @return [String] # # @!attribute [rw] creation_time # The timestamp of the creation time for this Provisioned Throughput. # @return [Time] # # @!attribute [rw] last_modified_time # The timestamp of the last time that this Provisioned Throughput was # modified. # @return [Time] # # @!attribute [rw] failure_message # A failure message for any issues that occurred during creation, # updating, or deletion of the Provisioned Throughput. # @return [String] # # @!attribute [rw] commitment_duration # Commitment duration of the Provisioned Throughput. # @return [String] # # @!attribute [rw] commitment_expiration_time # The timestamp for when the commitment term for the Provisioned # Throughput expires. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetProvisionedModelThroughputResponse AWS API Documentation # class GetProvisionedModelThroughputResponse < Struct.new( :model_units, :desired_model_units, :provisioned_model_name, :provisioned_model_arn, :model_arn, :desired_model_arn, :foundation_model_arn, :status, :creation_time, :last_modified_time, :failure_message, :commitment_duration, :commitment_expiration_time) SENSITIVE = [] include Aws::Structure end # Contains filter strengths for harmful content. Guardrails support the # following content filters to detect and filter harmful user inputs and # FM-generated outputs. # # * **Hate** – Describes language or a statement that discriminates, # criticizes, insults, denounces, or dehumanizes a person or group on # the basis of an identity (such as race, ethnicity, gender, religion, # sexual orientation, ability, and national origin). # # * **Insults** – Describes language or a statement that includes # demeaning, humiliating, mocking, insulting, or belittling language. # This type of language is also labeled as bullying. # # * **Sexual** – Describes language or a statement that indicates sexual # interest, activity, or arousal using direct or indirect references # to body parts, physical traits, or sex. # # * **Violence** – Describes language or a statement that includes # glorification of or threats to inflict physical pain, hurt, or # injury toward a person, group or thing. # # Content filtering depends on the confidence classification of user # inputs and FM responses across each of the four harmful categories. # All input and output statements are classified into one of four # confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. # For example, if a statement is classified as *Hate* with HIGH # confidence, the likelihood of the statement representing hateful # content is high. A single statement can be classified across multiple # categories with varying confidence levels. For example, a single # statement can be classified as *Hate* with HIGH confidence, *Insults* # with LOW confidence, *Sexual* with NONE confidence, and *Violence* # with MEDIUM confidence. # # For more information, see [Guardrails content filters][1]. # # This data type is used in the following API operations: # # * [GetGuardrail response body][2] # # ^ # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax # # @!attribute [rw] type # The harmful category that the content filter is applied to. # @return [String] # # @!attribute [rw] input_strength # The strength of the content filter to apply to prompts. As you # increase the filter strength, the likelihood of filtering harmful # content increases and the probability of seeing harmful content in # your application reduces. # @return [String] # # @!attribute [rw] output_strength # The strength of the content filter to apply to model responses. As # you increase the filter strength, the likelihood of filtering # harmful content increases and the probability of seeing harmful # content in your application reduces. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFilter AWS API Documentation # class GuardrailContentFilter < Struct.new( :type, :input_strength, :output_strength) SENSITIVE = [] include Aws::Structure end # Contains filter strengths for harmful content. Guardrails support the # following content filters to detect and filter harmful user inputs and # FM-generated outputs. # # * **Hate** – Describes language or a statement that discriminates, # criticizes, insults, denounces, or dehumanizes a person or group on # the basis of an identity (such as race, ethnicity, gender, religion, # sexual orientation, ability, and national origin). # # * **Insults** – Describes language or a statement that includes # demeaning, humiliating, mocking, insulting, or belittling language. # This type of language is also labeled as bullying. # # * **Sexual** – Describes language or a statement that indicates sexual # interest, activity, or arousal using direct or indirect references # to body parts, physical traits, or sex. # # * **Violence** – Describes language or a statement that includes # glorification of or threats to inflict physical pain, hurt, or # injury toward a person, group or thing. # # Content filtering depends on the confidence classification of user # inputs and FM responses across each of the four harmful categories. # All input and output statements are classified into one of four # confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. # For example, if a statement is classified as *Hate* with HIGH # confidence, the likelihood of the statement representing hateful # content is high. A single statement can be classified across multiple # categories with varying confidence levels. For example, a single # statement can be classified as *Hate* with HIGH confidence, *Insults* # with LOW confidence, *Sexual* with NONE confidence, and *Violence* # with MEDIUM confidence. # # For more information, see [Guardrails content filters][1]. # # This data type is used in the following API operations: # # * [CreateGuardrail request body][2] # # * [UpdateGuardrail request body][3] # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax # # @!attribute [rw] type # The harmful category that the content filter is applied to. # @return [String] # # @!attribute [rw] input_strength # The strength of the content filter to apply to prompts. As you # increase the filter strength, the likelihood of filtering harmful # content increases and the probability of seeing harmful content in # your application reduces. # @return [String] # # @!attribute [rw] output_strength # The strength of the content filter to apply to model responses. As # you increase the filter strength, the likelihood of filtering # harmful content increases and the probability of seeing harmful # content in your application reduces. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFilterConfig AWS API Documentation # class GuardrailContentFilterConfig < Struct.new( :type, :input_strength, :output_strength) SENSITIVE = [] include Aws::Structure end # Contains details about how to handle harmful content. # # This data type is used in the following API operations: # # * [GetGuardrail response body][1] # # ^ # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax # # @!attribute [rw] filters # Contains the type of the content filter and how strongly it should # apply to prompts and model responses. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicy AWS API Documentation # class GuardrailContentPolicy < Struct.new( :filters) SENSITIVE = [] include Aws::Structure end # Contains details about how to handle harmful content. # # This data type is used in the following API operations: # # * [CreateGuardrail request body][1] # # * [UpdateGuardrail request body][2] # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax # # @!attribute [rw] filters_config # Contains the type of the content filter and how strongly it should # apply to prompts and model responses. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicyConfig AWS API Documentation # class GuardrailContentPolicyConfig < Struct.new( :filters_config) SENSITIVE = [] include Aws::Structure end # The managed word list that was configured for the guardrail. (This is # a list of words that are pre-defined and managed by Guardrails only.) # # @!attribute [rw] type # ManagedWords$type The managed word type that was configured for the # guardrail. (For now, we only offer profanity word list) # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailManagedWords AWS API Documentation # class GuardrailManagedWords < Struct.new( :type) SENSITIVE = [] include Aws::Structure end # The managed word list to configure for the guardrail. # # @!attribute [rw] type # The managed word type to configure for the guardrail. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailManagedWordsConfig AWS API Documentation # class GuardrailManagedWordsConfig < Struct.new( :type) SENSITIVE = [] include Aws::Structure end # The PII entity configured for the guardrail. # # @!attribute [rw] type # The type of PII entity. For example, Social Security Number. # @return [String] # # @!attribute [rw] action # The configured guardrail action when PII entity is detected. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailPiiEntity AWS API Documentation # class GuardrailPiiEntity < Struct.new( :type, :action) SENSITIVE = [] include Aws::Structure end # The PII entity to configure for the guardrail. # # @!attribute [rw] type # Configure guardrail type when the PII entity is detected. # @return [String] # # @!attribute [rw] action # Configure guardrail action when the PII entity is detected. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailPiiEntityConfig AWS API Documentation # class GuardrailPiiEntityConfig < Struct.new( :type, :action) SENSITIVE = [] include Aws::Structure end # The regular expression configured for the guardrail. # # @!attribute [rw] name # The name of the regular expression for the guardrail. # @return [String] # # @!attribute [rw] description # The description of the regular expression for the guardrail. # @return [String] # # @!attribute [rw] pattern # The pattern of the regular expression configured for the guardrail. # @return [String] # # @!attribute [rw] action # The action taken when a match to the regular expression is detected. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailRegex AWS API Documentation # class GuardrailRegex < Struct.new( :name, :description, :pattern, :action) SENSITIVE = [] include Aws::Structure end # The regular expression to configure for the guardrail. # # @!attribute [rw] name # The name of the regular expression to configure for the guardrail. # @return [String] # # @!attribute [rw] description # The description of the regular expression to configure for the # guardrail. # @return [String] # # @!attribute [rw] pattern # The regular expression pattern to configure for the guardrail. # @return [String] # # @!attribute [rw] action # The guardrail action to configure when matching regular expression # is detected. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailRegexConfig AWS API Documentation # class GuardrailRegexConfig < Struct.new( :name, :description, :pattern, :action) SENSITIVE = [] include Aws::Structure end # Contains details about PII entities and regular expressions configured # for the guardrail. # # @!attribute [rw] pii_entities # The list of PII entities configured for the guardrail. # @return [Array] # # @!attribute [rw] regexes # The list of regular expressions configured for the guardrail. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailSensitiveInformationPolicy AWS API Documentation # class GuardrailSensitiveInformationPolicy < Struct.new( :pii_entities, :regexes) SENSITIVE = [] include Aws::Structure end # Contains details about PII entities and regular expressions to # configure for the guardrail. # # @!attribute [rw] pii_entities_config # A list of PII entities to configure to the guardrail. # @return [Array] # # @!attribute [rw] regexes_config # A list of regular expressions to configure to the guardrail. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailSensitiveInformationPolicyConfig AWS API Documentation # class GuardrailSensitiveInformationPolicyConfig < Struct.new( :pii_entities_config, :regexes_config) SENSITIVE = [] include Aws::Structure end # Contains details about a guardrail. # # This data type is used in the following API operations: # # * [ListGuardrails response body][1] # # ^ # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListGuardrails.html#API_ListGuardrails_ResponseSyntax # # @!attribute [rw] id # The unique identifier of the guardrail. # @return [String] # # @!attribute [rw] arn # The ARN of the guardrail. # @return [String] # # @!attribute [rw] status # The status of the guardrail. # @return [String] # # @!attribute [rw] name # The name of the guardrail. # @return [String] # # @!attribute [rw] description # A description of the guardrail. # @return [String] # # @!attribute [rw] version # The version of the guardrail. # @return [String] # # @!attribute [rw] created_at # The date and time at which the guardrail was created. # @return [Time] # # @!attribute [rw] updated_at # The date and time at which the guardrail was last updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailSummary AWS API Documentation # class GuardrailSummary < Struct.new( :id, :arn, :status, :name, :description, :version, :created_at, :updated_at) SENSITIVE = [:name, :description] include Aws::Structure end # Details about topics for the guardrail to identify and deny. # # This data type is used in the following API operations: # # * [GetGuardrail response body][1] # # ^ # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax # # @!attribute [rw] name # The name of the topic to deny. # @return [String] # # @!attribute [rw] definition # A definition of the topic to deny. # @return [String] # # @!attribute [rw] examples # A list of prompts, each of which is an example of a prompt that can # be categorized as belonging to the topic. # @return [Array] # # @!attribute [rw] type # Specifies to deny the topic. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopic AWS API Documentation # class GuardrailTopic < Struct.new( :name, :definition, :examples, :type) SENSITIVE = [:name, :definition] include Aws::Structure end # Details about topics for the guardrail to identify and deny. # # This data type is used in the following API operations: # # * [CreateGuardrail request body][1] # # * [UpdateGuardrail request body][2] # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax # # @!attribute [rw] name # The name of the topic to deny. # @return [String] # # @!attribute [rw] definition # A definition of the topic to deny. # @return [String] # # @!attribute [rw] examples # A list of prompts, each of which is an example of a prompt that can # be categorized as belonging to the topic. # @return [Array] # # @!attribute [rw] type # Specifies to deny the topic. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicConfig AWS API Documentation # class GuardrailTopicConfig < Struct.new( :name, :definition, :examples, :type) SENSITIVE = [:name, :definition] include Aws::Structure end # Contains details about topics that the guardrail should identify and # deny. # # This data type is used in the following API operations: # # * [GetGuardrail response body][1] # # ^ # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetGuardrail.html#API_GetGuardrail_ResponseSyntax # # @!attribute [rw] topics # A list of policies related to topics that the guardrail should deny. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicy AWS API Documentation # class GuardrailTopicPolicy < Struct.new( :topics) SENSITIVE = [] include Aws::Structure end # Contains details about topics that the guardrail should identify and # deny. # # This data type is used in the following API operations: # # * [CreateGuardrail request body][1] # # * [UpdateGuardrail request body][2] # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateGuardrail.html#API_CreateGuardrail_RequestSyntax # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_UpdateGuardrail.html#API_UpdateGuardrail_RequestSyntax # # @!attribute [rw] topics_config # A list of policies related to topics that the guardrail should deny. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicyConfig AWS API Documentation # class GuardrailTopicPolicyConfig < Struct.new( :topics_config) SENSITIVE = [] include Aws::Structure end # A word configured for the guardrail. # # @!attribute [rw] text # Text of the word configured for the guardrail to block. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWord AWS API Documentation # class GuardrailWord < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # A word to configure for the guardrail. # # @!attribute [rw] text # Text of the word configured for the guardrail to block. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWordConfig AWS API Documentation # class GuardrailWordConfig < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # Contains details about the word policy configured for the guardrail. # # @!attribute [rw] words # A list of words configured for the guardrail. # @return [Array] # # @!attribute [rw] managed_word_lists # A list of managed words configured for the guardrail. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWordPolicy AWS API Documentation # class GuardrailWordPolicy < Struct.new( :words, :managed_word_lists) SENSITIVE = [] include Aws::Structure end # Contains details about the word policy to configured for the # guardrail. # # @!attribute [rw] words_config # A list of words to configure for the guardrail. # @return [Array] # # @!attribute [rw] managed_word_lists_config # A list of managed words to configure for the guardrail. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailWordPolicyConfig AWS API Documentation # class GuardrailWordPolicyConfig < Struct.new( :words_config, :managed_word_lists_config) SENSITIVE = [] include Aws::Structure end # Specifies the custom metrics, how tasks will be rated, the flow # definition ARN, and your custom prompt datasets. Model evaluation jobs # use human workers *only* support the use of custom prompt datasets. To # learn more about custom prompt datasets and the required format, see # [Custom prompt datasets][1]. # # When you create custom metrics in `HumanEvaluationCustomMetric` you # must specify the metric's `name`. The list of `names` specified in # the `HumanEvaluationCustomMetric` array, must match the `metricNames` # array of strings specified in `EvaluationDatasetMetricConfig`. For # example, if in the `HumanEvaluationCustomMetric` array your specified # the names `"accuracy", "toxicity", "readability"` as custom metrics # *then* the `metricNames` array would need to look like the following # `["accuracy", "toxicity", "readability"]` in # `EvaluationDatasetMetricConfig`. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-evaluation-prompt-datasets-custom.html # # @!attribute [rw] human_workflow_config # The parameters of the human workflow. # @return [Types::HumanWorkflowConfig] # # @!attribute [rw] custom_metrics # A `HumanEvaluationCustomMetric` object. It contains the names the # metrics, how the metrics are to be evaluated, an optional # description. # @return [Array] # # @!attribute [rw] dataset_metric_configs # Use to specify the metrics, task, and prompt dataset to be used in # your model evaluation job. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/HumanEvaluationConfig AWS API Documentation # class HumanEvaluationConfig < Struct.new( :human_workflow_config, :custom_metrics, :dataset_metric_configs) SENSITIVE = [] include Aws::Structure end # In a model evaluation job that uses human workers you must define the # name of the metric, and how you want that metric rated `ratingMethod`, # and an optional description of the metric. # # @!attribute [rw] name # The name of the metric. Your human evaluators will see this name in # the evaluation UI. # @return [String] # # @!attribute [rw] description # An optional description of the metric. Use this parameter to provide # more details about the metric. # @return [String] # # @!attribute [rw] rating_method # Choose how you want your human workers to evaluation your model. # Valid values for rating methods are `ThumbsUpDown`, # `IndividualLikertScale`,`ComparisonLikertScale`, `ComparisonChoice`, # and `ComparisonRank` # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/HumanEvaluationCustomMetric AWS API Documentation # class HumanEvaluationCustomMetric < Struct.new( :name, :description, :rating_method) SENSITIVE = [:name, :description] include Aws::Structure end # Contains `SageMakerFlowDefinition` object. The object is used to # specify the prompt dataset, task type, rating method and metric names. # # @!attribute [rw] flow_definition_arn # The Amazon Resource Number (ARN) for the flow definition # @return [String] # # @!attribute [rw] instructions # Instructions for the flow definition # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/HumanWorkflowConfig AWS API Documentation # class HumanWorkflowConfig < Struct.new( :flow_definition_arn, :instructions) SENSITIVE = [:instructions] include Aws::Structure end # An internal server error occurred. Retry your request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/InternalServerException AWS API Documentation # class InternalServerException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] creation_time_before # Return custom models created before the specified time. # @return [Time] # # @!attribute [rw] creation_time_after # Return custom models created after the specified time. # @return [Time] # # @!attribute [rw] name_contains # Return custom models only if the job name contains these characters. # @return [String] # # @!attribute [rw] base_model_arn_equals # Return custom models only if the base model Amazon Resource Name # (ARN) matches this parameter. # @return [String] # # @!attribute [rw] foundation_model_arn_equals # Return custom models only if the foundation model Amazon Resource # Name (ARN) matches this parameter. # @return [String] # # @!attribute [rw] max_results # Maximum number of results to return in the response. # @return [Integer] # # @!attribute [rw] next_token # Continuation token from the previous response, for Amazon Bedrock to # list the next set of results. # @return [String] # # @!attribute [rw] sort_by # The field to sort by in the returned list of models. # @return [String] # # @!attribute [rw] sort_order # The sort order of the results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsRequest AWS API Documentation # class ListCustomModelsRequest < Struct.new( :creation_time_before, :creation_time_after, :name_contains, :base_model_arn_equals, :foundation_model_arn_equals, :max_results, :next_token, :sort_by, :sort_order) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # Continuation token for the next request to list the next set of # results. # @return [String] # # @!attribute [rw] model_summaries # Model summaries. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsResponse AWS API Documentation # class ListCustomModelsResponse < Struct.new( :next_token, :model_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] creation_time_after # A filter that includes model evaluation jobs created after the time # specified. # @return [Time] # # @!attribute [rw] creation_time_before # A filter that includes model evaluation jobs created prior to the # time specified. # @return [Time] # # @!attribute [rw] status_equals # Only return jobs where the status condition is met. # @return [String] # # @!attribute [rw] name_contains # Query parameter string for model evaluation job names. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return. # @return [Integer] # # @!attribute [rw] next_token # Continuation token from the previous response, for Amazon Bedrock to # list the next set of results. # @return [String] # # @!attribute [rw] sort_by # Allows you to sort model evaluation jobs by when they were created. # @return [String] # # @!attribute [rw] sort_order # How you want the order of jobs sorted. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListEvaluationJobsRequest AWS API Documentation # class ListEvaluationJobsRequest < Struct.new( :creation_time_after, :creation_time_before, :status_equals, :name_contains, :max_results, :next_token, :sort_by, :sort_order) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # Continuation token from the previous response, for Amazon Bedrock to # list the next set of results. # @return [String] # # @!attribute [rw] job_summaries # A summary of the model evaluation jobs. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListEvaluationJobsResponse AWS API Documentation # class ListEvaluationJobsResponse < Struct.new( :next_token, :job_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] by_provider # Return models belonging to the model provider that you specify. # @return [String] # # @!attribute [rw] by_customization_type # Return models that support the customization type that you specify. # For more information, see [Custom models][1] in the Amazon Bedrock # User Guide. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html # @return [String] # # @!attribute [rw] by_output_modality # Return models that support the output modality that you specify. # @return [String] # # @!attribute [rw] by_inference_type # Return models that support the inference type that you specify. For # more information, see [Provisioned Throughput][1] in the Amazon # Bedrock User Guide. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelsRequest AWS API Documentation # class ListFoundationModelsRequest < Struct.new( :by_provider, :by_customization_type, :by_output_modality, :by_inference_type) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] model_summaries # A list of Amazon Bedrock foundation models. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelsResponse AWS API Documentation # class ListFoundationModelsResponse < Struct.new( :model_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] guardrail_identifier # The unique identifier of the guardrail. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return in the response. # @return [Integer] # # @!attribute [rw] next_token # If there are more results than were returned in the response, the # response returns a `nextToken` that you can send in another # `ListGuardrails` request to see the next batch of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListGuardrailsRequest AWS API Documentation # class ListGuardrailsRequest < Struct.new( :guardrail_identifier, :max_results, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] guardrails # A list of objects, each of which contains details about a guardrail. # @return [Array] # # @!attribute [rw] next_token # If there are more results than were returned in the response, the # response returns a `nextToken` that you can send in another # `ListGuardrails` request to see the next batch of results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListGuardrailsResponse AWS API Documentation # class ListGuardrailsResponse < Struct.new( :guardrails, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] creation_time_after # Return customization jobs created after the specified time. # @return [Time] # # @!attribute [rw] creation_time_before # Return customization jobs created before the specified time. # @return [Time] # # @!attribute [rw] status_equals # Return customization jobs with the specified status. # @return [String] # # @!attribute [rw] name_contains # Return customization jobs only if the job name contains these # characters. # @return [String] # # @!attribute [rw] max_results # Maximum number of results to return in the response. # @return [Integer] # # @!attribute [rw] next_token # Continuation token from the previous response, for Amazon Bedrock to # list the next set of results. # @return [String] # # @!attribute [rw] sort_by # The field to sort by in the returned list of jobs. # @return [String] # # @!attribute [rw] sort_order # The sort order of the results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCustomizationJobsRequest AWS API Documentation # class ListModelCustomizationJobsRequest < Struct.new( :creation_time_after, :creation_time_before, :status_equals, :name_contains, :max_results, :next_token, :sort_by, :sort_order) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # Page continuation token to use in the next request. # @return [String] # # @!attribute [rw] model_customization_job_summaries # Job summaries. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListModelCustomizationJobsResponse AWS API Documentation # class ListModelCustomizationJobsResponse < Struct.new( :next_token, :model_customization_job_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] creation_time_after # A filter that returns Provisioned Throughputs created after the # specified time. # @return [Time] # # @!attribute [rw] creation_time_before # A filter that returns Provisioned Throughputs created before the # specified time. # @return [Time] # # @!attribute [rw] status_equals # A filter that returns Provisioned Throughputs if their statuses # matches the value that you specify. # @return [String] # # @!attribute [rw] model_arn_equals # A filter that returns Provisioned Throughputs whose model Amazon # Resource Name (ARN) is equal to the value that you specify. # @return [String] # # @!attribute [rw] name_contains # A filter that returns Provisioned Throughputs if their name contains # the expression that you specify. # @return [String] # # @!attribute [rw] max_results # THe maximum number of results to return in the response. If there # are more results than the number you specified, the response returns # a `nextToken` value. To see the next batch of results, send the # `nextToken` value in another list request. # @return [Integer] # # @!attribute [rw] next_token # If there are more results than the number you specified in the # `maxResults` field, the response returns a `nextToken` value. To see # the next batch of results, specify the `nextToken` value in this # field. # @return [String] # # @!attribute [rw] sort_by # The field by which to sort the returned list of Provisioned # Throughputs. # @return [String] # # @!attribute [rw] sort_order # The sort order of the results. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListProvisionedModelThroughputsRequest AWS API Documentation # class ListProvisionedModelThroughputsRequest < Struct.new( :creation_time_after, :creation_time_before, :status_equals, :model_arn_equals, :name_contains, :max_results, :next_token, :sort_by, :sort_order) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] next_token # If there are more results than the number you specified in the # `maxResults` field, this value is returned. To see the next batch of # results, include this value in the `nextToken` field in another list # request. # @return [String] # # @!attribute [rw] provisioned_model_summaries # A list of summaries, one for each Provisioned Throughput in the # response. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListProvisionedModelThroughputsResponse AWS API Documentation # class ListProvisionedModelThroughputsResponse < Struct.new( :next_token, :provisioned_model_summaries) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListTagsForResourceRequest AWS API Documentation # class ListTagsForResourceRequest < Struct.new( :resource_arn) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] tags # An array of the tags associated with this resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListTagsForResourceResponse AWS API Documentation # class ListTagsForResourceResponse < Struct.new( :tags) SENSITIVE = [] include Aws::Structure end # Configuration fields for invocation logging. # # @!attribute [rw] cloud_watch_config # CloudWatch logging configuration. # @return [Types::CloudWatchConfig] # # @!attribute [rw] s3_config # S3 configuration for storing log data. # @return [Types::S3Config] # # @!attribute [rw] text_data_delivery_enabled # Set to include text data in the log delivery. # @return [Boolean] # # @!attribute [rw] image_data_delivery_enabled # Set to include image data in the log delivery. # @return [Boolean] # # @!attribute [rw] embedding_data_delivery_enabled # Set to include embeddings data in the log delivery. # @return [Boolean] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LoggingConfig AWS API Documentation # class LoggingConfig < Struct.new( :cloud_watch_config, :s3_config, :text_data_delivery_enabled, :image_data_delivery_enabled, :embedding_data_delivery_enabled) SENSITIVE = [] include Aws::Structure end # Information about one customization job # # @!attribute [rw] job_arn # Amazon Resource Name (ARN) of the customization job. # @return [String] # # @!attribute [rw] base_model_arn # Amazon Resource Name (ARN) of the base model. # @return [String] # # @!attribute [rw] job_name # Name of the customization job. # @return [String] # # @!attribute [rw] status # Status of the customization job. # @return [String] # # @!attribute [rw] last_modified_time # Time that the customization job was last modified. # @return [Time] # # @!attribute [rw] creation_time # Creation time of the custom model. # @return [Time] # # @!attribute [rw] end_time # Time that the customization job ended. # @return [Time] # # @!attribute [rw] custom_model_arn # Amazon Resource Name (ARN) of the custom model. # @return [String] # # @!attribute [rw] custom_model_name # Name of the custom model. # @return [String] # # @!attribute [rw] customization_type # Specifies whether to carry out continued pre-training of a model or # whether to fine-tune it. For more information, see [Custom # models][1]. # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelCustomizationJobSummary AWS API Documentation # class ModelCustomizationJobSummary < Struct.new( :job_arn, :base_model_arn, :job_name, :status, :last_modified_time, :creation_time, :end_time, :custom_model_arn, :custom_model_name, :customization_type) SENSITIVE = [] include Aws::Structure end # S3 Location of the output data. # # @!attribute [rw] s3_uri # The S3 URI where the output data is stored. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/OutputDataConfig AWS API Documentation # class OutputDataConfig < Struct.new( :s3_uri) SENSITIVE = [] include Aws::Structure end # A summary of information about a Provisioned Throughput. # # This data type is used in the following API operations: # # * [ListProvisionedThroughputs response][1] # # ^ # # # # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListProvisionedModelThroughputs.html#API_ListProvisionedModelThroughputs_ResponseSyntax # # @!attribute [rw] provisioned_model_name # The name of the Provisioned Throughput. # @return [String] # # @!attribute [rw] provisioned_model_arn # The Amazon Resource Name (ARN) of the Provisioned Throughput. # @return [String] # # @!attribute [rw] model_arn # The Amazon Resource Name (ARN) of the model associated with the # Provisioned Throughput. # @return [String] # # @!attribute [rw] desired_model_arn # The Amazon Resource Name (ARN) of the model requested to be # associated to this Provisioned Throughput. This value differs from # the `modelArn` if updating hasn't completed. # @return [String] # # @!attribute [rw] foundation_model_arn # The Amazon Resource Name (ARN) of the base model for which the # Provisioned Throughput was created, or of the base model that the # custom model for which the Provisioned Throughput was created was # customized. # @return [String] # # @!attribute [rw] model_units # The number of model units allocated to the Provisioned Throughput. # @return [Integer] # # @!attribute [rw] desired_model_units # The number of model units that was requested to be allocated to the # Provisioned Throughput. # @return [Integer] # # @!attribute [rw] status # The status of the Provisioned Throughput. # @return [String] # # @!attribute [rw] commitment_duration # The duration for which the Provisioned Throughput was committed. # @return [String] # # @!attribute [rw] commitment_expiration_time # The timestamp for when the commitment term of the Provisioned # Throughput expires. # @return [Time] # # @!attribute [rw] creation_time # The time that the Provisioned Throughput was created. # @return [Time] # # @!attribute [rw] last_modified_time # The time that the Provisioned Throughput was last modified. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ProvisionedModelSummary AWS API Documentation # class ProvisionedModelSummary < Struct.new( :provisioned_model_name, :provisioned_model_arn, :model_arn, :desired_model_arn, :foundation_model_arn, :model_units, :desired_model_units, :status, :commitment_duration, :commitment_expiration_time, :creation_time, :last_modified_time) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] logging_config # The logging configuration values to set. # @return [Types::LoggingConfig] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutModelInvocationLoggingConfigurationRequest AWS API Documentation # class PutModelInvocationLoggingConfigurationRequest < Struct.new( :logging_config) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutModelInvocationLoggingConfigurationResponse AWS API Documentation # class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end # The specified resource Amazon Resource Name (ARN) was not found. Check # the Amazon Resource Name (ARN) and try your request again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # S3 configuration for storing log data. # # @!attribute [rw] bucket_name # S3 bucket name. # @return [String] # # @!attribute [rw] key_prefix # S3 prefix. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/S3Config AWS API Documentation # class S3Config < Struct.new( :bucket_name, :key_prefix) SENSITIVE = [] include Aws::Structure end # The number of requests exceeds the service quota. Resubmit your # request later. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ServiceQuotaExceededException AWS API Documentation # class ServiceQuotaExceededException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_identifier # The ARN of the model evaluation job you want to stop. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopEvaluationJobRequest AWS API Documentation # class StopEvaluationJobRequest < Struct.new( :job_identifier) SENSITIVE = [:job_identifier] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopEvaluationJobResponse AWS API Documentation # class StopEvaluationJobResponse < Aws::EmptyStructure; end # @!attribute [rw] job_identifier # Job identifier of the job to stop. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopModelCustomizationJobRequest AWS API Documentation # class StopModelCustomizationJobRequest < Struct.new( :job_identifier) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/StopModelCustomizationJobResponse AWS API Documentation # class StopModelCustomizationJobResponse < Aws::EmptyStructure; end # Definition of the key/value pair for a tag. # # @!attribute [rw] key # Key for the tag. # @return [String] # # @!attribute [rw] value # Value for the tag. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Tag AWS API Documentation # class Tag < Struct.new( :key, :value) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to tag. # @return [String] # # @!attribute [rw] tags # Tags to associate with the resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TagResourceRequest AWS API Documentation # class TagResourceRequest < Struct.new( :resource_arn, :tags) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TagResourceResponse AWS API Documentation # class TagResourceResponse < Aws::EmptyStructure; end # The number of requests exceeds the limit. Resubmit your request later. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ThrottlingException AWS API Documentation # class ThrottlingException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The request contains more tags than can be associated with a resource # (50 tags per resource). The maximum number of tags includes both # existing tags and those included in your current request. # # @!attribute [rw] message # @return [String] # # @!attribute [rw] resource_name # The name of the resource with too many tags. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TooManyTagsException AWS API Documentation # class TooManyTagsException < Struct.new( :message, :resource_name) SENSITIVE = [] include Aws::Structure end # S3 Location of the training data. # # @!attribute [rw] s3_uri # The S3 URI where the training data is stored. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TrainingDataConfig AWS API Documentation # class TrainingDataConfig < Struct.new( :s3_uri) SENSITIVE = [] include Aws::Structure end # Metrics associated with the custom job. # # @!attribute [rw] training_loss # Loss metric associated with the custom job. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TrainingMetrics AWS API Documentation # class TrainingMetrics < Struct.new( :training_loss) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] resource_arn # The Amazon Resource Name (ARN) of the resource to untag. # @return [String] # # @!attribute [rw] tag_keys # Tag keys of the tags to remove from the resource. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UntagResourceRequest AWS API Documentation # class UntagResourceRequest < Struct.new( :resource_arn, :tag_keys) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UntagResourceResponse AWS API Documentation # class UntagResourceResponse < Aws::EmptyStructure; end # @!attribute [rw] guardrail_identifier # The unique identifier of the guardrail # @return [String] # # @!attribute [rw] name # A name for the guardrail. # @return [String] # # @!attribute [rw] description # A description of the guardrail. # @return [String] # # @!attribute [rw] topic_policy_config # The topic policy to configure for the guardrail. # @return [Types::GuardrailTopicPolicyConfig] # # @!attribute [rw] content_policy_config # The content policy to configure for the guardrail. # @return [Types::GuardrailContentPolicyConfig] # # @!attribute [rw] word_policy_config # The word policy to configure for the guardrail. # @return [Types::GuardrailWordPolicyConfig] # # @!attribute [rw] sensitive_information_policy_config # The sensitive information policy to configure for the guardrail. # @return [Types::GuardrailSensitiveInformationPolicyConfig] # # @!attribute [rw] blocked_input_messaging # The message to return when the guardrail blocks a prompt. # @return [String] # # @!attribute [rw] blocked_outputs_messaging # The message to return when the guardrail blocks a model response. # @return [String] # # @!attribute [rw] kms_key_id # The ARN of the KMS key with which to encrypt the guardrail. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateGuardrailRequest AWS API Documentation # class UpdateGuardrailRequest < Struct.new( :guardrail_identifier, :name, :description, :topic_policy_config, :content_policy_config, :word_policy_config, :sensitive_information_policy_config, :blocked_input_messaging, :blocked_outputs_messaging, :kms_key_id) SENSITIVE = [:name, :description, :blocked_input_messaging, :blocked_outputs_messaging] include Aws::Structure end # @!attribute [rw] guardrail_id # The unique identifier of the guardrail # @return [String] # # @!attribute [rw] guardrail_arn # The ARN of the guardrail that was created. # @return [String] # # @!attribute [rw] version # The version of the guardrail. # @return [String] # # @!attribute [rw] updated_at # The date and time at which the guardrail was updated. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateGuardrailResponse AWS API Documentation # class UpdateGuardrailResponse < Struct.new( :guardrail_id, :guardrail_arn, :version, :updated_at) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] provisioned_model_id # The Amazon Resource Name (ARN) or name of the Provisioned Throughput # to update. # @return [String] # # @!attribute [rw] desired_provisioned_model_name # The new name for this Provisioned Throughput. # @return [String] # # @!attribute [rw] desired_model_id # The Amazon Resource Name (ARN) of the new model to associate with # this Provisioned Throughput. You can't specify this field if this # Provisioned Throughput is associated with a base model. # # If this Provisioned Throughput is associated with a custom model, # you can specify one of the following options: # # * The base model from which the custom model was customized. # # * Another custom model that was customized from the same base model # as the custom model. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateProvisionedModelThroughputRequest AWS API Documentation # class UpdateProvisionedModelThroughputRequest < Struct.new( :provisioned_model_id, :desired_provisioned_model_name, :desired_model_id) SENSITIVE = [] include Aws::Structure end # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/UpdateProvisionedModelThroughputResponse AWS API Documentation # class UpdateProvisionedModelThroughputResponse < Aws::EmptyStructure; end # Array of up to 10 validators. # # @!attribute [rw] validators # Information about the validators. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidationDataConfig AWS API Documentation # class ValidationDataConfig < Struct.new( :validators) SENSITIVE = [] include Aws::Structure end # Input validation failed. Check your request parameters and retry the # request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidationException AWS API Documentation # class ValidationException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Information about a validator. # # @!attribute [rw] s3_uri # The S3 URI where the validation data is stored. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Validator AWS API Documentation # class Validator < Struct.new( :s3_uri) SENSITIVE = [] include Aws::Structure end # The metric for the validator. # # @!attribute [rw] validation_loss # The validation loss associated with this validator. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidatorMetric AWS API Documentation # class ValidatorMetric < Struct.new( :validation_loss) SENSITIVE = [] include Aws::Structure end # VPC configuration. # # @!attribute [rw] subnet_ids # VPC configuration subnets. # @return [Array] # # @!attribute [rw] security_group_ids # VPC configuration security group Ids. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VpcConfig AWS API Documentation # class VpcConfig < Struct.new( :subnet_ids, :security_group_ids) SENSITIVE = [] include Aws::Structure end end end