Class: Aws::QConnect::Types::QueryAssistantRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[:query_text]

Instance Attribute Summary collapse

Instance Attribute Details

#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.

Returns:

  • (String)


9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return per page.

Returns:

  • (Integer)


9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  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)


9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  include Aws::Structure
end

#override_knowledge_base_search_type ⇒ String

The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.

Returns:

  • (String)


9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  include Aws::Structure
end

#query_condition ⇒ Array<Types::QueryCondition>

Information about how to query content.

Returns:



9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  include Aws::Structure
end

#query_input_data ⇒ Types::QueryInputData

Information about the query.



9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  include Aws::Structure
end

#query_text ⇒ String

The text to search for.

Returns:

  • (String)


9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  include Aws::Structure
end

#session_id ⇒ String

The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

  • (String)


9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 9338

class QueryAssistantRequest < Struct.new(
  :assistant_id,
  :query_text,
  :next_token,
  :max_results,
  :session_id,
  :query_condition,
  :query_input_data,
  :override_knowledge_base_search_type)
  SENSITIVE = [:query_text]
  include Aws::Structure
end