Class: Aws::Kendra::Types::SubmitFeedbackRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

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

{
  index_id: "IndexId", # required
  query_id: "QueryId", # required
  click_feedback_items: [
    {
      result_id: "ResultId", # required
      click_time: Time.now, # required
    },
  ],
  relevance_feedback_items: [
    {
      result_id: "ResultId", # required
      relevance_value: "RELEVANT", # required, accepts RELEVANT, NOT_RELEVANT
    },
  ],
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#click_feedback_items ⇒ Array<Types::ClickFeedback>

Tells Amazon Kendra that a particular search result link was chosen by the user.

Returns:


6013
6014
6015
6016
6017
6018
6019
6020
 
# File 'lib/aws-sdk-kendra/types.rb', line 6013

class SubmitFeedbackRequest < Struct.new(
  :index_id,
  :query_id,
  :click_feedback_items,
  :relevance_feedback_items)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index that was queried.

Returns:

  • (String) 

6013
6014
6015
6016
6017
6018
6019
6020
 
# File 'lib/aws-sdk-kendra/types.rb', line 6013

class SubmitFeedbackRequest < Struct.new(
  :index_id,
  :query_id,
  :click_feedback_items,
  :relevance_feedback_items)
  SENSITIVE = []
  include Aws::Structure
end

#query_id ⇒ String

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the operation.

Returns:

  • (String) 

6013
6014
6015
6016
6017
6018
6019
6020
 
# File 'lib/aws-sdk-kendra/types.rb', line 6013

class SubmitFeedbackRequest < Struct.new(
  :index_id,
  :query_id,
  :click_feedback_items,
  :relevance_feedback_items)
  SENSITIVE = []
  include Aws::Structure
end

#relevance_feedback_items ⇒ Array<Types::RelevanceFeedback>

Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

Returns:


6013
6014
6015
6016
6017
6018
6019
6020
 
# File 'lib/aws-sdk-kendra/types.rb', line 6013

class SubmitFeedbackRequest < Struct.new(
  :index_id,
  :query_id,
  :click_feedback_items,
  :relevance_feedback_items)
  SENSITIVE = []
  include Aws::Structure
end