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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb

Overview

Response message for SearchService.Search method.

Defined Under Namespace

Classes: Facet, GeoSearchDebugInfo, GuidedSearchResult, NaturalLanguageQueryUnderstandingInfo, OneBoxResult, QueryExpansionInfo, SearchResult, SessionInfo, Summary

Instance Attribute Summary collapse

Instance Attribute Details

#applied_controls::Array<::String>

Returns Controls applied as part of the Control service.

Returns:

  • (::Array<::String>)

    Controls applied as part of the Control service.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#attribution_token::String

Returns A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.

Returns:

  • (::String)

    A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. This also helps to identify a request during the customer support scenarios.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#corrected_query::String

Returns Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.

Returns:

  • (::String)

    Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#facets::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet>

Returns Results of facets requested by user.

Returns:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#geo_search_debug_info::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#guided_search_result::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult

Returns Guided search result.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#natural_language_query_understanding_info::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo

Returns Natural language query understanding information for the returned results.

Returns:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#next_page_token::String

Returns A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Returns:

  • (::String)

    A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#one_box_results::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult>

Returns A list of One Box results. There can be multiple One Box results of different types.

Returns:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#query_expansion_info::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo

Returns Query expansion information for the returned results.

Returns:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#redirect_uri::String

Returns The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.

Returns:

  • (::String)

    The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#results::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>

Returns A list of matched documents. The order represents the ranking.

Returns:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#session_info::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SessionInfo

Returns Session information.

Only set if SearchRequest.session is provided. See its description for more details.

Returns:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#summary::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary

Returns A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set.

Returns:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end

#total_size::Integer

The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.

Returns:

  • (::Integer)

    The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 1238

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

  # Represents the search results.
  # @!attribute [rw] id
  #   @return [::String]
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id} of the
  #     searched {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
  # @!attribute [rw] document
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
  #     The document data snippet in the search response. Only fields that are
  #     marked as `retrievable` are populated.
  # @!attribute [rw] chunk
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
  #     The chunk data in the search response if the
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
  #     is set to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
  # @!attribute [rw] model_scores
  #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
  #     Google provided available scores.
  class SearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::DoubleList]
    class ModelScoresEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # A facet result.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key for this facet. For example, `"colors"` or `"price"`. It matches
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
  # @!attribute [rw] values
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
  #     The facet values for this field.
  # @!attribute [rw] dynamic_facet
  #   @return [::Boolean]
  #     Whether the facet is dynamically generated.
  class Facet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # A facet value which contains value names and their count.
    # @!attribute [rw] value
    #   @return [::String]
    #     Text value of a facet, such as "Black" for facet "colors".
    # @!attribute [rw] interval
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Interval]
    #     Interval value for a facet, such as [10, 20) for facet "price". It
    #     matches
    #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#intervals SearchRequest.FacetSpec.FacetKey.intervals}.
    # @!attribute [rw] count
    #   @return [::Integer]
    #     Number of items that have this facet value.
    class FacetValue
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Guided search result. The guided search helps user to refine the search
  # results and narrow down to the real needs from a broaded search results.
  # @!attribute [rw] refinement_attributes
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GuidedSearchResult::RefinementAttribute>]
  #     A list of ranked refinement attributes.
  # @!attribute [rw] follow_up_questions
  #   @return [::Array<::String>]
  #     Suggested follow-up questions.
  class GuidedSearchResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Useful attribute for search result refinements.
    # @!attribute [rw] attribute_key
    #   @return [::String]
    #     Attribute key used to refine the results. For example, `"movie_type"`.
    # @!attribute [rw] attribute_value
    #   @return [::String]
    #     Attribute value used to refine the results. For example, `"drama"`.
    class RefinementAttribute
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Summary of the top N search results specified by the summary spec.
  # @!attribute [rw] summary_text
  #   @return [::String]
  #     The summary content.
  # @!attribute [rw] summary_skipped_reasons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummarySkippedReason>]
  #     Additional summary-skipped reasons. This provides the reason for ignored
  #     cases. If nothing is skipped, this field is not set.
  # @!attribute [rw] safety_attributes
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SafetyAttributes]
  #     A collection of Safety Attribute categories and their associated
  #     confidence scores.
  # @!attribute [rw] summary_with_metadata
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::SummaryWithMetadata]
  #     Summary with metadata information.
  class Summary
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety Attribute categories and their associated confidence scores.
    # @!attribute [rw] categories
    #   @return [::Array<::String>]
    #     The display names of Safety Attribute categories associated with the
    #     generated content. Order matches the Scores.
    # @!attribute [rw] scores
    #   @return [::Array<::Float>]
    #     The confidence scores of the each category, higher
    #     value means higher confidence. Order matches the Categories.
    class SafetyAttributes
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation metadata.
    # @!attribute [rw] citations
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Citation>]
    #     Citations for segments.
    class CitationMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation info for a segment.
    # @!attribute [rw] start_index
    #   @return [::Integer]
    #     Index indicates the start of the segment, measured in bytes/unicode.
    # @!attribute [rw] end_index
    #   @return [::Integer]
    #     End of the attributed segment, exclusive.
    # @!attribute [rw] sources
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationSource>]
    #     Citation sources for the attributed segment.
    class Citation
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Citation source.
    # @!attribute [rw] reference_index
    #   @return [::Integer]
    #     Document reference index from SummaryWithMetadata.references.
    #     It is 0-indexed and the value will be zero if the reference_index is
    #     not set explicitly.
    class CitationSource
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Document reference.
    # @!attribute [rw] title
    #   @return [::String]
    #     Title of the document.
    # @!attribute [rw] document
    #   @return [::String]
    #     Required.
    #     {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name} of
    #     the document. Full resource name of the referenced document, in the
    #     format
    #     `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
    # @!attribute [rw] uri
    #   @return [::String]
    #     Cloud Storage or HTTP uri for the document.
    # @!attribute [rw] chunk_contents
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
    #     List of cited chunk contents derived from document content.
    class Reference
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Chunk content.
      # @!attribute [rw] content
      #   @return [::String]
      #     Chunk textual content.
      # @!attribute [rw] page_identifier
      #   @return [::String]
      #     Page identifier.
      class ChunkContent
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end

    # Summary with metadata information.
    # @!attribute [rw] summary
    #   @return [::String]
    #     Summary text with no citation information.
    # @!attribute [rw] citation_metadata
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::CitationMetadata]
    #     Citation metadata for given summary.
    # @!attribute [rw] references
    #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference>]
    #     Document References.
    class SummaryWithMetadata
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # An Enum for summary-skipped reasons.
    module SummarySkippedReason
      # Default value. The summary skipped reason is not specified.
      SUMMARY_SKIPPED_REASON_UNSPECIFIED = 0

      # The adversarial query ignored case.
      #
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
      # is set to `true`.
      ADVERSARIAL_QUERY_IGNORED = 1

      # The non-summary seeking query ignored case.
      #
      # Google skips the summary if the query is chit chat.
      # Only used when
      # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED = 2

      # The out-of-domain query ignored case.
      #
      # Google skips the summary if there are no high-relevance search results.
      # For example, the data store contains facts about company A but the
      # user query is asking questions about company B.
      OUT_OF_DOMAIN_QUERY_IGNORED = 3

      # The potential policy violation case.
      #
      # Google skips the summary if there is a potential policy violation
      # detected. This includes content that may be violent or toxic.
      POTENTIAL_POLICY_VIOLATION = 4

      # The LLM addon not enabled case.
      #
      # Google skips the summary if the LLM addon is not enabled.
      LLM_ADDON_NOT_ENABLED = 5

      # The no relevant content case.
      #
      # Google skips the summary if there is no relevant content in the
      # retrieved search results.
      NO_RELEVANT_CONTENT = 6

      # The jail-breaking query ignored case.
      #
      # For example, "Reply in the tone of a competing company's CEO".
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
      # is set to `true`.
      JAIL_BREAKING_QUERY_IGNORED = 7

      # The customer policy violation case.
      #
      # Google skips the summary if there is a customer policy violation
      # detected. The policy is defined by the customer.
      CUSTOMER_POLICY_VIOLATION = 8

      # The non-answer seeking query ignored case.
      #
      # Google skips the summary if the query doesn't have clear intent.
      # Only used when
      # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query]
      # is set to `true`.
      NON_SUMMARY_SEEKING_QUERY_IGNORED_V2 = 9
    end
  end

  # Debug information specifically related to forward geocoding issues arising
  # from Geolocation Search.
  # @!attribute [rw] original_address_query
  #   @return [::String]
  #     The address from which forward geocoding ingestion produced issues.
  # @!attribute [rw] error_message
  #   @return [::String]
  #     The error produced.
  class GeoSearchDebugInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing query expansion including whether expansion has
  # occurred.
  # @!attribute [rw] expanded_query
  #   @return [::Boolean]
  #     Bool describing whether query expansion has occurred.
  # @!attribute [rw] pinned_result_count
  #   @return [::Integer]
  #     Number of pinned results. This field will only be set when expansion
  #     happens and
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec#pin_unexpanded_results SearchRequest.QueryExpansionSpec.pin_unexpanded_results}
  #     is set to true.
  class QueryExpansionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Information describing what natural language understanding was
  # done on the input query.
  # @!attribute [rw] extracted_filters
  #   @return [::String]
  #     The filters that were extracted from the input query.
  # @!attribute [rw] rewritten_query
  #   @return [::String]
  #     Rewritten input query minus the extracted filters.
  # @!attribute [rw] structured_extracted_filter
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter]
  #     The filters that were extracted from the input query represented in a
  #     structured form.
  class NaturalLanguageQueryUnderstandingInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The filters that were extracted from the input query represented in a
    # structured form.
    # @!attribute [rw] expression
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression]
    #     The expression denoting the filter that was extracted from the input
    #     query in a structured form. It can be a simple expression denoting a
    #     single string, numerical or geolocation constraint or a compound
    #     expression which is a combination of multiple expressions connected
    #     using logical (OR and AND) operators.
    class StructuredExtractedFilter
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Constraint expression of a string field.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the string field as defined in the schema.
      # @!attribute [rw] values
      #   @return [::Array<::String>]
      #     Values of the string field. The record will only be returned if the
      #     field value matches one of the values specified here.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class StringConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Constraint expression of a number field. Example: price < 100.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Name of the numerical field as defined in the schema.
      # @!attribute [rw] comparison
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint::Comparison]
      #     The comparison operation performed between the field value and the
      #     value specified in the constraint.
      # @!attribute [rw] value
      #   @return [::Float]
      #     The value specified in the numerical constraint.
      # @!attribute [rw] query_segment
      #   @return [::String]
      #     Identifies the keywords within the search query that match a filter.
      class NumberConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The comparison operation that was performed.
        module Comparison
          # Undefined comparison operator.
          COMPARISON_UNSPECIFIED = 0

          # Denotes equality `=` operator.
          EQUALS = 1

          # Denotes less than or equal to `<=` operator.
          LESS_THAN_EQUALS = 2

          # Denotes less than `<` operator.
          LESS_THAN = 3

          # Denotes greater than or equal to `>=` operator.
          GREATER_THAN_EQUALS = 4

          # Denotes greater than `>` operator.
          GREATER_THAN = 5
        end
      end

      # Constraint of a geolocation field.
      # Name of the geolocation field as defined in the schema.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     The name of the geolocation field as defined in the schema.
      # @!attribute [rw] address
      #   @return [::String]
      #     The reference address that was inferred from the input query. The
      #     proximity of the reference address to the geolocation field will be
      #     used to filter the results.
      # @!attribute [rw] latitude
      #   @return [::Float]
      #     The latitude of the geolocation inferred from the input query.
      # @!attribute [rw] longitude
      #   @return [::Float]
      #     The longitude of the geolocation inferred from the input query.
      # @!attribute [rw] radius_in_meters
      #   @return [::Float]
      #     The radius in meters around the address. The record is returned if
      #     the location of the geolocation field is within the radius.
      class GeolocationConstraint
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `And` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ANDed together.
      class AndExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # Logical `Or` operator.
      # @!attribute [rw] expressions
      #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::Expression>]
      #     The expressions that were ORed together.
      class OrExpression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end

      # The expression denoting the filter that was extracted from the input
      # query.
      # @!attribute [rw] string_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::StringConstraint]
      #     String constraint expression.
      # @!attribute [rw] number_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::NumberConstraint]
      #     Numerical constraint expression.
      # @!attribute [rw] geolocation_constraint
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::GeolocationConstraint]
      #     Geolocation constraint expression.
      # @!attribute [rw] and_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::AndExpression]
      #     Logical "And" compound operator connecting multiple expressions.
      # @!attribute [rw] or_expr
      #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::NaturalLanguageQueryUnderstandingInfo::StructuredExtractedFilter::OrExpression]
      #     Logical "Or" compound operator connecting multiple expressions.
      class Expression
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods
      end
    end
  end

  # Information about the session.
  # @!attribute [rw] name
  #   @return [::String]
  #     Name of the session.
  #     If the auto-session mode is used (when
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#session SearchRequest.session}
  #     ends with "-"), this field holds the newly generated session name.
  # @!attribute [rw] query_id
  #   @return [::String]
  #     Query ID that corresponds to this search API call.
  #     One session can have multiple turns, each with a unique query ID.
  #
  #     By specifying the session name and this query ID in the Answer API call,
  #     the answer generation happens in the context of the search results from
  #     this search call.
  class SessionInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # OneBoxResult is a holder for all results of specific type that we want
  # to display in UI differently.
  # @!attribute [rw] one_box_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::OneBoxResult::OneBoxType]
  #     The type of One Box result.
  # @!attribute [rw] search_results
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::SearchResult>]
  #     The search results for this One Box.
  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
end