Class: Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

Overview

OneBoxResult is a holder for all results of specific type that we want to display in UI differently.

Defined Under Namespace

Modules: OneBoxType

Instance Attribute Summary collapse

#one_box_type ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType
The type of One Box result.
#search_results ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>
The search results for this One Box.

Instance Attribute Details

#one_box_type ⇒ `::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType`

Returns The type of One Box result.

Returns:

(::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType) —
The type of One Box result.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1726

class OneBoxResult
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of One Box result.
  module OneBoxType
    # Default value. Should not be used.
    ONE_BOX_TYPE_UNSPECIFIED = 0

    # One Box result contains people results.
    PEOPLE = 1

    # One Box result contains organization results.
    ORGANIZATION = 2

    # One Box result contains slack results.
    SLACK = 3

    # One Box result contains Knowledge Graph search responses.
    KNOWLEDGE_GRAPH = 4
  end
end

#search_results ⇒ `::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>`

Returns The search results for this One Box.