Class: Aws::QConnect::Types::ListModelsRequest

Inherits:

Struct

• Object
• Struct
• Aws::QConnect::Types::ListModelsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-qconnect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ai_prompt_type ⇒ String

  The type of the AI Prompt to filter models by.

• #assistant_id ⇒ String

  The identifier of the Amazon Q in Connect assistant.

• #max_results ⇒ Integer

  The maximum number of results to return per page.

• #model_lifecycle ⇒ String

  The lifecycle status of models to filter by.

• #next_token ⇒ String

  The token for the next set of results.

Instance Attribute Details

#ai_prompt_type ⇒ String

The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 7066

class ListModelsRequest < Struct.new(
  :assistant_id,
  :ai_prompt_type,
  :model_lifecycle,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#assistant_id ⇒ String

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN. The assistant's region determines which models are available.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 7066

class ListModelsRequest < Struct.new(
  :assistant_id,
  :ai_prompt_type,
  :model_lifecycle,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

• (Integer)

# File 'lib/aws-sdk-qconnect/types.rb', line 7066

class ListModelsRequest < Struct.new(
  :assistant_id,
  :ai_prompt_type,
  :model_lifecycle,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#model_lifecycle ⇒ String

The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 7066

class ListModelsRequest < Struct.new(
  :assistant_id,
  :ai_prompt_type,
  :model_lifecycle,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

• (String)

# File 'lib/aws-sdk-qconnect/types.rb', line 7066

class ListModelsRequest < Struct.new(
  :assistant_id,
  :ai_prompt_type,
  :model_lifecycle,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end