Class: Aws::Bedrock::Types::GetCustomModelResponse

Inherits:

Struct

• Object
• Struct
• Aws::Bedrock::Types::GetCustomModelResponse

Includes:

Structure

Defined in:

lib/aws-sdk-bedrock/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #base_model_arn ⇒ String

  Amazon Resource Name (ARN) of the base model.

• #creation_time ⇒ Time

  Creation time of the model.

• #customization_config ⇒ Types::CustomizationConfig

  The customization configuration for the custom model.

• #customization_type ⇒ String

  The type of model customization.

• #failure_message ⇒ String

  A failure message for any issues that occurred when creating the custom model.

• #hyper_parameters ⇒ Hash<String,String>

  Hyperparameter values associated with this model.

• #job_arn ⇒ String

  Job Amazon Resource Name (ARN) associated with this model.

• #job_name ⇒ String

  Job name associated with this model.

• #model_arn ⇒ String

  Amazon Resource Name (ARN) associated with this model.

• #model_kms_key_arn ⇒ String

  The custom model is encrypted at rest using this key.

• #model_name ⇒ String

  Model name associated with this model.

• #model_status ⇒ String

  The current status of the custom model.

• #output_data_config ⇒ Types::OutputDataConfig

  Output data configuration associated with this custom model.

• #training_data_config ⇒ Types::TrainingDataConfig

  Contains information about the training dataset.

• #training_metrics ⇒ Types::TrainingMetrics

  Contains training metrics from the job creation.

• #validation_data_config ⇒ Types::ValidationDataConfig

  Contains information about the validation dataset.

• #validation_metrics ⇒ Array<Types::ValidatorMetric>

  The validation metrics from the job creation.

Instance Attribute Details

#base_model_arn ⇒ String

Amazon Resource Name (ARN) of the base model.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

Creation time of the model.

Returns:

• (Time)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#customization_config ⇒ Types::CustomizationConfig

The customization configuration for the custom model.

Returns:

• (Types::CustomizationConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#customization_type ⇒ String

The type of model customization.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#failure_message ⇒ String

A failure message for any issues that occurred when creating the custom model. This is included for only a failed CreateCustomModel operation.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#hyper_parameters ⇒ Hash<String,String>

Hyperparameter values associated with this model. For details on the format for different models, see [Custom model hyperparameters].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/custom-models-hp.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#job_arn ⇒ String

Job Amazon Resource Name (ARN) associated with this model. For models that you create with the [CreateCustomModel] API operation, this is ‘NULL`.

[1]: docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#job_name ⇒ String

Job name associated with this model.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#model_arn ⇒ String

Amazon Resource Name (ARN) associated with this model.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#model_kms_key_arn ⇒ String

The custom model is encrypted at rest using this key.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#model_name ⇒ String

Model name associated with this model.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#model_status ⇒ String

The current status of the custom model. Possible values include:

• ‘Creating` - The model is being created and validated.

• ‘Active` - The model has been successfully created and is ready for use.

• ‘Failed` - The model creation process failed. Check the `failureMessage` field for details.

Returns:

• (String)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#output_data_config ⇒ Types::OutputDataConfig

Output data configuration associated with this custom model.

Returns:

• (Types::OutputDataConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#training_data_config ⇒ Types::TrainingDataConfig

Contains information about the training dataset.

Returns:

• (Types::TrainingDataConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#training_metrics ⇒ Types::TrainingMetrics

Contains training metrics from the job creation.

Returns:

• (Types::TrainingMetrics)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#validation_data_config ⇒ Types::ValidationDataConfig

Contains information about the validation dataset.

Returns:

• (Types::ValidationDataConfig)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end

#validation_metrics ⇒ Array<Types::ValidatorMetric>

The validation metrics from the job creation.

Returns:

• (Array<Types::ValidatorMetric>)

# File 'lib/aws-sdk-bedrock/types.rb', line 5724

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,
  :customization_config,
  :model_status,
  :failure_message)
  SENSITIVE = []
  include Aws::Structure
end