Package software.amazon.awssdk.services.bedrock.model

Class GetCustomModelResponse

    • Method Detail

      • modelArn

        public final String modelArn()

        Amazon Resource Name (ARN) associated with this model.

        Returns:
        Amazon Resource Name (ARN) associated with this model.

      • modelName

        public final String modelName()

        Model name associated with this model.

        Returns:
        Model name associated with this model.

      • jobName

        public final String jobName()

        Job name associated with this model.

        Returns:
        Job name associated with this model.

      • jobArn

        public final String jobArn()

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

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

      • baseModelArn

        public final String baseModelArn()

        Amazon Resource Name (ARN) of the base model.

        Returns:
        Amazon Resource Name (ARN) of the base model.

      • modelKmsKeyArn

        public final String modelKmsKeyArn()

        The custom model is encrypted at rest using this key.

        Returns:
        The custom model is encrypted at rest using this key.

      • hasHyperParameters

        public final boolean hasHyperParameters()
        For responses, this returns true if the service returned a value for the HyperParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • hyperParameters

        public final Map<String,​String> hyperParameters()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHyperParameters() method.

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

      • trainingDataConfig

        public final TrainingDataConfig trainingDataConfig()

        Contains information about the training dataset.

        Returns:
        Contains information about the training dataset.

      • validationDataConfig

        public final ValidationDataConfig validationDataConfig()

        Contains information about the validation dataset.

        Returns:
        Contains information about the validation dataset.

      • outputDataConfig

        public final OutputDataConfig outputDataConfig()

        Output data configuration associated with this custom model.

        Returns:
        Output data configuration associated with this custom model.

      • trainingMetrics

        public final TrainingMetrics trainingMetrics()

        Contains training metrics from the job creation.

        Returns:
        Contains training metrics from the job creation.

      • hasValidationMetrics

        public final boolean hasValidationMetrics()
        For responses, this returns true if the service returned a value for the ValidationMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • validationMetrics

        public final List<ValidatorMetric> validationMetrics()

        The validation metrics from the job creation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValidationMetrics() method.

        Returns:
        The validation metrics from the job creation.

      • creationTime

        public final Instant creationTime()

        Creation time of the model.

        Returns:
        Creation time of the model.

      • customizationConfig

        public final CustomizationConfig customizationConfig()

        The customization configuration for the custom model.

        Returns:
        The customization configuration for the custom model.

      • modelStatus

        public final ModelStatus modelStatus()

        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.

        If the service returns an enum value that is not available in the current SDK version, modelStatus will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelStatusAsString().

        Returns:
        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.

        See Also:
        ModelStatus

      • modelStatusAsString

        public final String modelStatusAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, modelStatus will return ModelStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelStatusAsString().

        Returns:
        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.

        See Also:
        ModelStatus

      • failureMessage

        public final String failureMessage()

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

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object