Class: Aws::QBusiness::Types::SearchRelevantContentRequest

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::SearchRelevantContentRequest

Defined in:

gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The unique identifier of the Amazon Q Business application to search.

• #attribute_filter ⇒ Types::AttributeFilter

  Enables filtering of responses based on document attributes or metadata fields.

• #content_source ⇒ Types::ContentSource

  The source of content to search in.

• #max_results ⇒ Integer

  The maximum number of results to return.

• #next_token ⇒ String

  The token for the next set of results.

• #query_text ⇒ String

  The text to search for.

Instance Attribute Details

#application_id ⇒ String

The unique identifier of the Amazon Q Business application to search.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8005

class SearchRelevantContentRequest < Struct.new(
  :application_id,
  :query_text,
  :content_source,
  :attribute_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#attribute_filter ⇒ Types::AttributeFilter

Enables filtering of responses based on document attributes or metadata fields.

Returns:

• (Types::AttributeFilter)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8005

class SearchRelevantContentRequest < Struct.new(
  :application_id,
  :query_text,
  :content_source,
  :attribute_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#content_source ⇒ Types::ContentSource

The source of content to search in.

Returns:

• (Types::ContentSource)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8005

class SearchRelevantContentRequest < Struct.new(
  :application_id,
  :query_text,
  :content_source,
  :attribute_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return.

Returns:

• (Integer)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8005

class SearchRelevantContentRequest < Struct.new(
  :application_id,
  :query_text,
  :content_source,
  :attribute_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of results. (You received this token from a previous call.)

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8005

class SearchRelevantContentRequest < Struct.new(
  :application_id,
  :query_text,
  :content_source,
  :attribute_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#query_text ⇒ String

The text to search for.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 8005

class SearchRelevantContentRequest < Struct.new(
  :application_id,
  :query_text,
  :content_source,
  :attribute_filter,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end