Class ModelSummary

java.lang.Object
software.amazon.awssdk.services.qconnect.model.ModelSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ModelSummary.Builder,ModelSummary>
@Generated("software.amazon.awssdk:codegen") public final class ModelSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ModelSummary.Builder,ModelSummary>

The summary of a model available to an Amazon Q in Connect assistant.

See Also:

  • Method Details

    • modelId

      public final String modelId()

      The identifier of the model.

      Returns:
      The identifier of the model.

    • displayName

      public final String displayName()

      The display name of the model.

      Returns:
      The display name of the model.

    • crossRegionStatus

      public final CrossRegionStatus crossRegionStatus()

      The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference.

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

      Returns:
      The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference.
      See Also:

    • crossRegionStatusAsString

      public final String crossRegionStatusAsString()

      The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference.

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

      Returns:
      The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference.
      See Also:

    • supportsPromptCaching

      public final Boolean supportsPromptCaching()

      Whether the model supports prompt caching.

      Returns:
      Whether the model supports prompt caching.

    • supportedAIPromptTypes

      public final List<AIPromptType> supportedAIPromptTypes()

      The list of AI Prompt types that the model supports.

      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 hasSupportedAIPromptTypes() method.

      Returns:
      The list of AI Prompt types that the model supports.

    • hasSupportedAIPromptTypes

      public final boolean hasSupportedAIPromptTypes()
      For responses, this returns true if the service returned a value for the SupportedAIPromptTypes 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.

    • supportedAIPromptTypesAsStrings

      public final List<String> supportedAIPromptTypesAsStrings()

      The list of AI Prompt types that the model supports.

      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 hasSupportedAIPromptTypes() method.

      Returns:
      The list of AI Prompt types that the model supports.

    • modelLifecycle

      public final ModelLifecycle modelLifecycle()

      The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated.

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

      Returns:
      The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated.
      See Also:

    • modelLifecycleAsString

      public final String modelLifecycleAsString()

      The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated.

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

      Returns:
      The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated.
      See Also:

    • legacyTimestamp

      public final Instant legacyTimestamp()

      The timestamp when the model lifecycle will transition from ACTIVE to LEGACY.

      Returns:
      The timestamp when the model lifecycle will transition from ACTIVE to LEGACY.

    • endOfLifeTimestamp

      public final Instant endOfLifeTimestamp()

      The timestamp when the model will reach end of life and no longer be available for use.

      Returns:
      The timestamp when the model will reach end of life and no longer be available for use.

    • toBuilder

      public ModelSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ModelSummary.Builder,ModelSummary>
      Returns:
      a builder for type T

    • builder

      public static ModelSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ModelSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.