Class: Aws::QConnect::Types::ModelSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cross_region_status ⇒ String

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.

Returns:

  • (String)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

The display name of the model.

Returns:

  • (String)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#end_of_life_timestamp ⇒ Time

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

Returns:

  • (Time)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#global_resiliency_status ⇒ String

Whether this model is published in every Region of the caller's Amazon Connect Global Resiliency replication group, and so can be referenced by an AI Prompt that replicates. Present only for callers to which global resiliency applies.

Returns:

  • (String)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#legacy_timestamp ⇒ Time

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

Returns:

  • (Time)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#model_id ⇒ String

The identifier of the model.

Returns:

  • (String)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#model_lifecycle ⇒ String

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.

Returns:

  • (String)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#supported_ai_prompt_types ⇒ Array<String>

The list of AI Prompt types that the model supports.

Returns:

  • (Array<String>)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end

#supports_prompt_caching ⇒ Boolean

Whether the model supports prompt caching.

Returns:

  • (Boolean)


8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8431

class ModelSummary < Struct.new(
  :model_id,
  :display_name,
  :cross_region_status,
  :supports_prompt_caching,
  :supported_ai_prompt_types,
  :model_lifecycle,
  :legacy_timestamp,
  :end_of_life_timestamp,
  :global_resiliency_status)
  SENSITIVE = []
  include Aws::Structure
end