Class: Aws::QConnect::Types::SearchQuickResponsesRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:attributes]

Instance Attribute Summary collapse

Instance Attribute Details

#attributesHash<String,String>

The user-defined Amazon Connect contact attributes to be resolved when search results are returned.

Returns:

  • (Hash<String,String>)


8710
8711
8712
8713
8714
8715
8716
8717
8718
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8710

class SearchQuickResponsesRequest < Struct.new(
  :knowledge_base_id,
  :search_expression,
  :next_token,
  :max_results,
  :attributes)
  SENSITIVE = [:attributes]
  include Aws::Structure
end

#knowledge_base_idString

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String)


8710
8711
8712
8713
8714
8715
8716
8717
8718
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8710

class SearchQuickResponsesRequest < Struct.new(
  :knowledge_base_id,
  :search_expression,
  :next_token,
  :max_results,
  :attributes)
  SENSITIVE = [:attributes]
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return per page.

Returns:

  • (Integer)


8710
8711
8712
8713
8714
8715
8716
8717
8718
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8710

class SearchQuickResponsesRequest < Struct.new(
  :knowledge_base_id,
  :search_expression,
  :next_token,
  :max_results,
  :attributes)
  SENSITIVE = [:attributes]
  include Aws::Structure
end

#next_tokenString

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)


8710
8711
8712
8713
8714
8715
8716
8717
8718
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8710

class SearchQuickResponsesRequest < Struct.new(
  :knowledge_base_id,
  :search_expression,
  :next_token,
  :max_results,
  :attributes)
  SENSITIVE = [:attributes]
  include Aws::Structure
end

#search_expressionTypes::QuickResponseSearchExpression

The search expression for querying the quick response.



8710
8711
8712
8713
8714
8715
8716
8717
8718
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8710

class SearchQuickResponsesRequest < Struct.new(
  :knowledge_base_id,
  :search_expression,
  :next_token,
  :max_results,
  :attributes)
  SENSITIVE = [:attributes]
  include Aws::Structure
end