AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ConnectWisdomService::Types::GetRecommendationsRequest

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

Overview

Note:

When making an API call, you may pass GetRecommendationsRequest data as a hash:

{
  assistant_id: "UuidOrArn", # required
  max_results: 1,
  session_id: "UuidOrArn", # required
  wait_time_seconds: 1,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#assistant_idString

The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 1296

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return per page.

Returns:

  • (Integer)


1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 1296

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#session_idString

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String)


1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 1296

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end

#wait_time_secondsInteger

The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

Returns:

  • (Integer)


1296
1297
1298
1299
1300
1301
1302
1303
# File 'gems/aws-sdk-connectwisdomservice/lib/aws-sdk-connectwisdomservice/types.rb', line 1296

class GetRecommendationsRequest < Struct.new(
  :assistant_id,
  :max_results,
  :session_id,
  :wait_time_seconds)
  SENSITIVE = []
  include Aws::Structure
end