google-apis-discoveryengine_v1alpha 0.42.0 → 0.44.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -741,8 +741,8 @@ module Google
741
741
  class GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig
742
742
  include Google::Apis::Core::Hashable
743
743
 
744
- # Apply additional enhanced OCR processing to a list of document elements.
745
- # Supported values: * `table`: advanced table parsing model.
744
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
745
+ # elements processing, please switch to `layout_parsing_config`.
746
746
  # Corresponds to the JSON property `enhancedDocumentElements`
747
747
  # @return [Array<String>]
748
748
  attr_accessor :enhanced_document_elements
@@ -917,8 +917,8 @@ module Google
917
917
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
918
918
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
919
919
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
920
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
921
- # agent association after Engine is created.
920
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
921
+ # association after Engine is created.
922
922
  # Corresponds to the JSON property `dialogflowAgentToLink`
923
923
  # @return [String]
924
924
  attr_accessor :dialogflow_agent_to_link
@@ -1031,7 +1031,7 @@ module Google
1031
1031
  attr_accessor :search_add_ons
1032
1032
 
1033
1033
  # The search feature tier of this engine. Different tiers might have different
1034
- # pricing. To learn more, please check the pricing documentation. Defaults to
1034
+ # pricing. To learn more, check the pricing documentation. Defaults to
1035
1035
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
1036
1036
  # Corresponds to the JSON property `searchTier`
1037
1037
  # @return [String]
@@ -1068,6 +1068,11 @@ module Google
1068
1068
  # @return [Fixnum]
1069
1069
  attr_accessor :success_count
1070
1070
 
1071
+ # Total count of entries that were processed.
1072
+ # Corresponds to the JSON property `totalCount`
1073
+ # @return [Fixnum]
1074
+ attr_accessor :total_count
1075
+
1071
1076
  # Operation last update time. If the operation is done, this is also the finish
1072
1077
  # time.
1073
1078
  # Corresponds to the JSON property `updateTime`
@@ -1083,6 +1088,7 @@ module Google
1083
1088
  @create_time = args[:create_time] if args.key?(:create_time)
1084
1089
  @failure_count = args[:failure_count] if args.key?(:failure_count)
1085
1090
  @success_count = args[:success_count] if args.key?(:success_count)
1091
+ @total_count = args[:total_count] if args.key?(:total_count)
1086
1092
  @update_time = args[:update_time] if args.key?(:update_time)
1087
1093
  end
1088
1094
  end
@@ -1570,24 +1576,1174 @@ module Google
1570
1576
 
1571
1577
  # Update properties of this object
1572
1578
  def update!(**args)
1573
- @total_required_quota = args[:total_required_quota] if args.key?(:total_required_quota)
1579
+ @total_required_quota = args[:total_required_quota] if args.key?(:total_required_quota)
1580
+ end
1581
+ end
1582
+
1583
+ # Metadata for UpdateSchema LRO.
1584
+ class GoogleCloudDiscoveryengineV1UpdateSchemaMetadata
1585
+ include Google::Apis::Core::Hashable
1586
+
1587
+ # Operation create time.
1588
+ # Corresponds to the JSON property `createTime`
1589
+ # @return [String]
1590
+ attr_accessor :create_time
1591
+
1592
+ # Operation last update time. If the operation is done, this is also the finish
1593
+ # time.
1594
+ # Corresponds to the JSON property `updateTime`
1595
+ # @return [String]
1596
+ attr_accessor :update_time
1597
+
1598
+ def initialize(**args)
1599
+ update!(**args)
1600
+ end
1601
+
1602
+ # Update properties of this object
1603
+ def update!(**args)
1604
+ @create_time = args[:create_time] if args.key?(:create_time)
1605
+ @update_time = args[:update_time] if args.key?(:update_time)
1606
+ end
1607
+ end
1608
+
1609
+ # Metadata related to the progress of the SiteSearchEngineService.
1610
+ # UpdateTargetSite operation. This will be returned by the google.longrunning.
1611
+ # Operation.metadata field.
1612
+ class GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata
1613
+ include Google::Apis::Core::Hashable
1614
+
1615
+ # Operation create time.
1616
+ # Corresponds to the JSON property `createTime`
1617
+ # @return [String]
1618
+ attr_accessor :create_time
1619
+
1620
+ # Operation last update time. If the operation is done, this is also the finish
1621
+ # time.
1622
+ # Corresponds to the JSON property `updateTime`
1623
+ # @return [String]
1624
+ attr_accessor :update_time
1625
+
1626
+ def initialize(**args)
1627
+ update!(**args)
1628
+ end
1629
+
1630
+ # Update properties of this object
1631
+ def update!(**args)
1632
+ @create_time = args[:create_time] if args.key?(:create_time)
1633
+ @update_time = args[:update_time] if args.key?(:update_time)
1634
+ end
1635
+ end
1636
+
1637
+ # Access Control Configuration.
1638
+ class GoogleCloudDiscoveryengineV1alphaAclConfig
1639
+ include Google::Apis::Core::Hashable
1640
+
1641
+ # Identity Provider Config.
1642
+ # Corresponds to the JSON property `idpConfig`
1643
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdpConfig]
1644
+ attr_accessor :idp_config
1645
+
1646
+ # Immutable. The full resource name of the acl configuration. Format: `projects/`
1647
+ # project`/locations/`location`/aclConfig`. This field must be a UTF-8 encoded
1648
+ # string with a length limit of 1024 characters.
1649
+ # Corresponds to the JSON property `name`
1650
+ # @return [String]
1651
+ attr_accessor :name
1652
+
1653
+ def initialize(**args)
1654
+ update!(**args)
1655
+ end
1656
+
1657
+ # Update properties of this object
1658
+ def update!(**args)
1659
+ @idp_config = args[:idp_config] if args.key?(:idp_config)
1660
+ @name = args[:name] if args.key?(:name)
1661
+ end
1662
+ end
1663
+
1664
+ # AdditionalParams message for WidgetService methods for security and privacy
1665
+ # enhancement.
1666
+ class GoogleCloudDiscoveryengineV1alphaAdditionalParams
1667
+ include Google::Apis::Core::Hashable
1668
+
1669
+ # Token that used for non-human user check.
1670
+ # Corresponds to the JSON property `token`
1671
+ # @return [String]
1672
+ attr_accessor :token
1673
+
1674
+ def initialize(**args)
1675
+ update!(**args)
1676
+ end
1677
+
1678
+ # Update properties of this object
1679
+ def update!(**args)
1680
+ @token = args[:token] if args.key?(:token)
1681
+ end
1682
+ end
1683
+
1684
+ # Defines an answer.
1685
+ class GoogleCloudDiscoveryengineV1alphaAnswer
1686
+ include Google::Apis::Core::Hashable
1687
+
1688
+ # Additional answer-skipped reasons. This provides the reason for ignored cases.
1689
+ # If nothing is skipped, this field is not set.
1690
+ # Corresponds to the JSON property `answerSkippedReasons`
1691
+ # @return [Array<String>]
1692
+ attr_accessor :answer_skipped_reasons
1693
+
1694
+ # The textual answer.
1695
+ # Corresponds to the JSON property `answerText`
1696
+ # @return [String]
1697
+ attr_accessor :answer_text
1698
+
1699
+ # Citations.
1700
+ # Corresponds to the JSON property `citations`
1701
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerCitation>]
1702
+ attr_accessor :citations
1703
+
1704
+ # Output only. Answer completed timestamp.
1705
+ # Corresponds to the JSON property `completeTime`
1706
+ # @return [String]
1707
+ attr_accessor :complete_time
1708
+
1709
+ # Output only. Answer creation timestamp.
1710
+ # Corresponds to the JSON property `createTime`
1711
+ # @return [String]
1712
+ attr_accessor :create_time
1713
+
1714
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
1715
+ # collections/`collection`/engines/`engine`/sessions/*/answers/*`
1716
+ # Corresponds to the JSON property `name`
1717
+ # @return [String]
1718
+ attr_accessor :name
1719
+
1720
+ # Query understanding information.
1721
+ # Corresponds to the JSON property `queryUnderstandingInfo`
1722
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo]
1723
+ attr_accessor :query_understanding_info
1724
+
1725
+ # References.
1726
+ # Corresponds to the JSON property `references`
1727
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerReference>]
1728
+ attr_accessor :references
1729
+
1730
+ # Suggested related questions.
1731
+ # Corresponds to the JSON property `relatedQuestions`
1732
+ # @return [Array<String>]
1733
+ attr_accessor :related_questions
1734
+
1735
+ # The state of the answer generation.
1736
+ # Corresponds to the JSON property `state`
1737
+ # @return [String]
1738
+ attr_accessor :state
1739
+
1740
+ # Answer generation steps.
1741
+ # Corresponds to the JSON property `steps`
1742
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStep>]
1743
+ attr_accessor :steps
1744
+
1745
+ def initialize(**args)
1746
+ update!(**args)
1747
+ end
1748
+
1749
+ # Update properties of this object
1750
+ def update!(**args)
1751
+ @answer_skipped_reasons = args[:answer_skipped_reasons] if args.key?(:answer_skipped_reasons)
1752
+ @answer_text = args[:answer_text] if args.key?(:answer_text)
1753
+ @citations = args[:citations] if args.key?(:citations)
1754
+ @complete_time = args[:complete_time] if args.key?(:complete_time)
1755
+ @create_time = args[:create_time] if args.key?(:create_time)
1756
+ @name = args[:name] if args.key?(:name)
1757
+ @query_understanding_info = args[:query_understanding_info] if args.key?(:query_understanding_info)
1758
+ @references = args[:references] if args.key?(:references)
1759
+ @related_questions = args[:related_questions] if args.key?(:related_questions)
1760
+ @state = args[:state] if args.key?(:state)
1761
+ @steps = args[:steps] if args.key?(:steps)
1762
+ end
1763
+ end
1764
+
1765
+ # Citation info for a segment.
1766
+ class GoogleCloudDiscoveryengineV1alphaAnswerCitation
1767
+ include Google::Apis::Core::Hashable
1768
+
1769
+ # End of the attributed segment, exclusive.
1770
+ # Corresponds to the JSON property `endIndex`
1771
+ # @return [Fixnum]
1772
+ attr_accessor :end_index
1773
+
1774
+ # Citation sources for the attributed segment.
1775
+ # Corresponds to the JSON property `sources`
1776
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerCitationSource>]
1777
+ attr_accessor :sources
1778
+
1779
+ # Index indicates the start of the segment, measured in bytes (UTF-8 unicode).
1780
+ # Corresponds to the JSON property `startIndex`
1781
+ # @return [Fixnum]
1782
+ attr_accessor :start_index
1783
+
1784
+ def initialize(**args)
1785
+ update!(**args)
1786
+ end
1787
+
1788
+ # Update properties of this object
1789
+ def update!(**args)
1790
+ @end_index = args[:end_index] if args.key?(:end_index)
1791
+ @sources = args[:sources] if args.key?(:sources)
1792
+ @start_index = args[:start_index] if args.key?(:start_index)
1793
+ end
1794
+ end
1795
+
1796
+ # Citation source.
1797
+ class GoogleCloudDiscoveryengineV1alphaAnswerCitationSource
1798
+ include Google::Apis::Core::Hashable
1799
+
1800
+ # ID of the citation source.
1801
+ # Corresponds to the JSON property `referenceId`
1802
+ # @return [String]
1803
+ attr_accessor :reference_id
1804
+
1805
+ def initialize(**args)
1806
+ update!(**args)
1807
+ end
1808
+
1809
+ # Update properties of this object
1810
+ def update!(**args)
1811
+ @reference_id = args[:reference_id] if args.key?(:reference_id)
1812
+ end
1813
+ end
1814
+
1815
+ # Request message for ConversationalSearchService.AnswerQuery method.
1816
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest
1817
+ include Google::Apis::Core::Hashable
1818
+
1819
+ # Answer generation specification.
1820
+ # Corresponds to the JSON property `answerGenerationSpec`
1821
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec]
1822
+ attr_accessor :answer_generation_spec
1823
+
1824
+ # Asynchronous mode control. If enabled, the response will be returned with
1825
+ # answer/session resource name without final answer. The API users need to do
1826
+ # the polling to get the latest status of answer/session by calling
1827
+ # ConversationalSearchService.GetAnswer or ConversationalSearchService.
1828
+ # GetSession method.
1829
+ # Corresponds to the JSON property `asynchronousMode`
1830
+ # @return [Boolean]
1831
+ attr_accessor :asynchronous_mode
1832
+ alias_method :asynchronous_mode?, :asynchronous_mode
1833
+
1834
+ # Defines a user inputed query.
1835
+ # Corresponds to the JSON property `query`
1836
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaQuery]
1837
+ attr_accessor :query
1838
+
1839
+ # Query understanding specification.
1840
+ # Corresponds to the JSON property `queryUnderstandingSpec`
1841
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec]
1842
+ attr_accessor :query_understanding_spec
1843
+
1844
+ # Related questions specification.
1845
+ # Corresponds to the JSON property `relatedQuestionsSpec`
1846
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec]
1847
+ attr_accessor :related_questions_spec
1848
+
1849
+ # Safety specification.
1850
+ # Corresponds to the JSON property `safetySpec`
1851
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec]
1852
+ attr_accessor :safety_spec
1853
+
1854
+ # Search specification.
1855
+ # Corresponds to the JSON property `searchSpec`
1856
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec]
1857
+ attr_accessor :search_spec
1858
+
1859
+ # The session resource name. Not required. When session field is not set, the
1860
+ # API is in sessionless mode. We support auto session mode: users can use the
1861
+ # wildcard symbol “-” as session id. A new id will be automatically generated
1862
+ # and assigned.
1863
+ # Corresponds to the JSON property `session`
1864
+ # @return [String]
1865
+ attr_accessor :session
1866
+
1867
+ # A unique identifier for tracking visitors. For example, this could be
1868
+ # implemented with an HTTP cookie, which should be able to uniquely identify a
1869
+ # visitor on a single device. This unique identifier should not change if the
1870
+ # visitor logs in or out of the website. This field should NOT have a fixed
1871
+ # value such as `unknown_visitor`. The field must be a UTF-8 encoded string with
1872
+ # a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is
1873
+ # returned.
1874
+ # Corresponds to the JSON property `userPseudoId`
1875
+ # @return [String]
1876
+ attr_accessor :user_pseudo_id
1877
+
1878
+ def initialize(**args)
1879
+ update!(**args)
1880
+ end
1881
+
1882
+ # Update properties of this object
1883
+ def update!(**args)
1884
+ @answer_generation_spec = args[:answer_generation_spec] if args.key?(:answer_generation_spec)
1885
+ @asynchronous_mode = args[:asynchronous_mode] if args.key?(:asynchronous_mode)
1886
+ @query = args[:query] if args.key?(:query)
1887
+ @query_understanding_spec = args[:query_understanding_spec] if args.key?(:query_understanding_spec)
1888
+ @related_questions_spec = args[:related_questions_spec] if args.key?(:related_questions_spec)
1889
+ @safety_spec = args[:safety_spec] if args.key?(:safety_spec)
1890
+ @search_spec = args[:search_spec] if args.key?(:search_spec)
1891
+ @session = args[:session] if args.key?(:session)
1892
+ @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
1893
+ end
1894
+ end
1895
+
1896
+ # Answer generation specification.
1897
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec
1898
+ include Google::Apis::Core::Hashable
1899
+
1900
+ # Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-
1901
+ # editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
1902
+ # Corresponds to the JSON property `answerLanguageCode`
1903
+ # @return [String]
1904
+ attr_accessor :answer_language_code
1905
+
1906
+ # Specifies whether to filter out adversarial queries. The default value is `
1907
+ # false`. Google employs search-query classification to detect adversarial
1908
+ # queries. No answer is returned if the search query is classified as an
1909
+ # adversarial query. For example, a user might ask a question regarding negative
1910
+ # comments about the company or submit a query designed to generate unsafe,
1911
+ # policy-violating output. If this field is set to `true`, we skip generating
1912
+ # answers for adversarial queries and return fallback messages instead.
1913
+ # Corresponds to the JSON property `ignoreAdversarialQuery`
1914
+ # @return [Boolean]
1915
+ attr_accessor :ignore_adversarial_query
1916
+ alias_method :ignore_adversarial_query?, :ignore_adversarial_query
1917
+
1918
+ # Specifies whether to filter out queries that are not answer-seeking. The
1919
+ # default value is `false`. Google employs search-query classification to detect
1920
+ # answer-seeking queries. No answer is returned if the search query is
1921
+ # classified as a non-answer seeking query. If this field is set to `true`, we
1922
+ # skip generating answers for non-answer seeking queries and return fallback
1923
+ # messages instead.
1924
+ # Corresponds to the JSON property `ignoreNonAnswerSeekingQuery`
1925
+ # @return [Boolean]
1926
+ attr_accessor :ignore_non_answer_seeking_query
1927
+ alias_method :ignore_non_answer_seeking_query?, :ignore_non_answer_seeking_query
1928
+
1929
+ # Specifies whether to include citation metadata in the answer. The default
1930
+ # value is `false`.
1931
+ # Corresponds to the JSON property `includeCitations`
1932
+ # @return [Boolean]
1933
+ attr_accessor :include_citations
1934
+ alias_method :include_citations?, :include_citations
1935
+
1936
+ # Answer Generation Model specification.
1937
+ # Corresponds to the JSON property `modelSpec`
1938
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec]
1939
+ attr_accessor :model_spec
1940
+
1941
+ # Answer generation prompt specification.
1942
+ # Corresponds to the JSON property `promptSpec`
1943
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec]
1944
+ attr_accessor :prompt_spec
1945
+
1946
+ def initialize(**args)
1947
+ update!(**args)
1948
+ end
1949
+
1950
+ # Update properties of this object
1951
+ def update!(**args)
1952
+ @answer_language_code = args[:answer_language_code] if args.key?(:answer_language_code)
1953
+ @ignore_adversarial_query = args[:ignore_adversarial_query] if args.key?(:ignore_adversarial_query)
1954
+ @ignore_non_answer_seeking_query = args[:ignore_non_answer_seeking_query] if args.key?(:ignore_non_answer_seeking_query)
1955
+ @include_citations = args[:include_citations] if args.key?(:include_citations)
1956
+ @model_spec = args[:model_spec] if args.key?(:model_spec)
1957
+ @prompt_spec = args[:prompt_spec] if args.key?(:prompt_spec)
1958
+ end
1959
+ end
1960
+
1961
+ # Answer Generation Model specification.
1962
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec
1963
+ include Google::Apis::Core::Hashable
1964
+
1965
+ # Model version. If not set, it will use the default stable model. Allowed
1966
+ # values are: stable, preview.
1967
+ # Corresponds to the JSON property `modelVersion`
1968
+ # @return [String]
1969
+ attr_accessor :model_version
1970
+
1971
+ def initialize(**args)
1972
+ update!(**args)
1973
+ end
1974
+
1975
+ # Update properties of this object
1976
+ def update!(**args)
1977
+ @model_version = args[:model_version] if args.key?(:model_version)
1978
+ end
1979
+ end
1980
+
1981
+ # Answer generation prompt specification.
1982
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec
1983
+ include Google::Apis::Core::Hashable
1984
+
1985
+ # Customized preamble.
1986
+ # Corresponds to the JSON property `preamble`
1987
+ # @return [String]
1988
+ attr_accessor :preamble
1989
+
1990
+ def initialize(**args)
1991
+ update!(**args)
1992
+ end
1993
+
1994
+ # Update properties of this object
1995
+ def update!(**args)
1996
+ @preamble = args[:preamble] if args.key?(:preamble)
1997
+ end
1998
+ end
1999
+
2000
+ # Query understanding specification.
2001
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec
2002
+ include Google::Apis::Core::Hashable
2003
+
2004
+ # Query classification specification.
2005
+ # Corresponds to the JSON property `queryClassificationSpec`
2006
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec]
2007
+ attr_accessor :query_classification_spec
2008
+
2009
+ # Query rephraser specification.
2010
+ # Corresponds to the JSON property `queryRephraserSpec`
2011
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec]
2012
+ attr_accessor :query_rephraser_spec
2013
+
2014
+ def initialize(**args)
2015
+ update!(**args)
2016
+ end
2017
+
2018
+ # Update properties of this object
2019
+ def update!(**args)
2020
+ @query_classification_spec = args[:query_classification_spec] if args.key?(:query_classification_spec)
2021
+ @query_rephraser_spec = args[:query_rephraser_spec] if args.key?(:query_rephraser_spec)
2022
+ end
2023
+ end
2024
+
2025
+ # Query classification specification.
2026
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec
2027
+ include Google::Apis::Core::Hashable
2028
+
2029
+ # Enabled query classification types.
2030
+ # Corresponds to the JSON property `types`
2031
+ # @return [Array<String>]
2032
+ attr_accessor :types
2033
+
2034
+ def initialize(**args)
2035
+ update!(**args)
2036
+ end
2037
+
2038
+ # Update properties of this object
2039
+ def update!(**args)
2040
+ @types = args[:types] if args.key?(:types)
2041
+ end
2042
+ end
2043
+
2044
+ # Query rephraser specification.
2045
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec
2046
+ include Google::Apis::Core::Hashable
2047
+
2048
+ # Disable query rephraser.
2049
+ # Corresponds to the JSON property `disable`
2050
+ # @return [Boolean]
2051
+ attr_accessor :disable
2052
+ alias_method :disable?, :disable
2053
+
2054
+ # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it
2055
+ # will be set to 1 by default.
2056
+ # Corresponds to the JSON property `maxRephraseSteps`
2057
+ # @return [Fixnum]
2058
+ attr_accessor :max_rephrase_steps
2059
+
2060
+ def initialize(**args)
2061
+ update!(**args)
2062
+ end
2063
+
2064
+ # Update properties of this object
2065
+ def update!(**args)
2066
+ @disable = args[:disable] if args.key?(:disable)
2067
+ @max_rephrase_steps = args[:max_rephrase_steps] if args.key?(:max_rephrase_steps)
2068
+ end
2069
+ end
2070
+
2071
+ # Related questions specification.
2072
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec
2073
+ include Google::Apis::Core::Hashable
2074
+
2075
+ # Enable related questions feature if true.
2076
+ # Corresponds to the JSON property `enable`
2077
+ # @return [Boolean]
2078
+ attr_accessor :enable
2079
+ alias_method :enable?, :enable
2080
+
2081
+ def initialize(**args)
2082
+ update!(**args)
2083
+ end
2084
+
2085
+ # Update properties of this object
2086
+ def update!(**args)
2087
+ @enable = args[:enable] if args.key?(:enable)
2088
+ end
2089
+ end
2090
+
2091
+ # Safety specification.
2092
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec
2093
+ include Google::Apis::Core::Hashable
2094
+
2095
+ # Enable the safety filtering on the answer response. It is false by default.
2096
+ # Corresponds to the JSON property `enable`
2097
+ # @return [Boolean]
2098
+ attr_accessor :enable
2099
+ alias_method :enable?, :enable
2100
+
2101
+ def initialize(**args)
2102
+ update!(**args)
2103
+ end
2104
+
2105
+ # Update properties of this object
2106
+ def update!(**args)
2107
+ @enable = args[:enable] if args.key?(:enable)
2108
+ end
2109
+ end
2110
+
2111
+ # Search specification.
2112
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec
2113
+ include Google::Apis::Core::Hashable
2114
+
2115
+ # Search parameters.
2116
+ # Corresponds to the JSON property `searchParams`
2117
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams]
2118
+ attr_accessor :search_params
2119
+
2120
+ # Search result list.
2121
+ # Corresponds to the JSON property `searchResultList`
2122
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList]
2123
+ attr_accessor :search_result_list
2124
+
2125
+ def initialize(**args)
2126
+ update!(**args)
2127
+ end
2128
+
2129
+ # Update properties of this object
2130
+ def update!(**args)
2131
+ @search_params = args[:search_params] if args.key?(:search_params)
2132
+ @search_result_list = args[:search_result_list] if args.key?(:search_result_list)
2133
+ end
2134
+ end
2135
+
2136
+ # Search parameters.
2137
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams
2138
+ include Google::Apis::Core::Hashable
2139
+
2140
+ # Boost specification to boost certain documents.
2141
+ # Corresponds to the JSON property `boostSpec`
2142
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec]
2143
+ attr_accessor :boost_spec
2144
+
2145
+ # Defines custom fine tuning spec.
2146
+ # Corresponds to the JSON property `customFineTuningSpec`
2147
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec]
2148
+ attr_accessor :custom_fine_tuning_spec
2149
+
2150
+ # The filter syntax consists of an expression language for constructing a
2151
+ # predicate from one or more fields of the documents being filtered. Filter
2152
+ # expression is case-sensitive. This will be used to filter search results which
2153
+ # may affect the Answer response. If this field is unrecognizable, an `
2154
+ # INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
2155
+ # mapping the LHS filter key to a key property defined in the Vertex AI Search
2156
+ # backend -- this mapping is defined by the customer in their schema. For
2157
+ # example a media customers might have a field 'name' in their schema. In this
2158
+ # case the filter would look like this: filter --> name:'ANY("king kong")' For
2159
+ # more information about filtering including syntax and filter operators, see [
2160
+ # Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
2161
+ # metadata)
2162
+ # Corresponds to the JSON property `filter`
2163
+ # @return [String]
2164
+ attr_accessor :filter
2165
+
2166
+ # Number of search results to return. The default value is 10.
2167
+ # Corresponds to the JSON property `maxReturnResults`
2168
+ # @return [Fixnum]
2169
+ attr_accessor :max_return_results
2170
+
2171
+ # The order in which documents are returned. Documents can be ordered by a field
2172
+ # in an Document object. Leave it unset if ordered by relevance. `order_by`
2173
+ # expression is case-sensitive. For more information on ordering, see [Ordering](
2174
+ # https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
2175
+ # unrecognizable, an `INVALID_ARGUMENT` is returned.
2176
+ # Corresponds to the JSON property `orderBy`
2177
+ # @return [String]
2178
+ attr_accessor :order_by
2179
+
2180
+ # Specifies the search result mode. If unspecified, the search result mode is
2181
+ # based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.
2182
+ # DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`.
2183
+ # * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](
2184
+ # https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
2185
+ # Corresponds to the JSON property `searchResultMode`
2186
+ # @return [String]
2187
+ attr_accessor :search_result_mode
2188
+
2189
+ def initialize(**args)
2190
+ update!(**args)
2191
+ end
2192
+
2193
+ # Update properties of this object
2194
+ def update!(**args)
2195
+ @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
2196
+ @custom_fine_tuning_spec = args[:custom_fine_tuning_spec] if args.key?(:custom_fine_tuning_spec)
2197
+ @filter = args[:filter] if args.key?(:filter)
2198
+ @max_return_results = args[:max_return_results] if args.key?(:max_return_results)
2199
+ @order_by = args[:order_by] if args.key?(:order_by)
2200
+ @search_result_mode = args[:search_result_mode] if args.key?(:search_result_mode)
2201
+ end
2202
+ end
2203
+
2204
+ # Search result list.
2205
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList
2206
+ include Google::Apis::Core::Hashable
2207
+
2208
+ # Search results.
2209
+ # Corresponds to the JSON property `searchResults`
2210
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult>]
2211
+ attr_accessor :search_results
2212
+
2213
+ def initialize(**args)
2214
+ update!(**args)
2215
+ end
2216
+
2217
+ # Update properties of this object
2218
+ def update!(**args)
2219
+ @search_results = args[:search_results] if args.key?(:search_results)
2220
+ end
2221
+ end
2222
+
2223
+ # Search result.
2224
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult
2225
+ include Google::Apis::Core::Hashable
2226
+
2227
+ # Chunk information.
2228
+ # Corresponds to the JSON property `chunkInfo`
2229
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo]
2230
+ attr_accessor :chunk_info
2231
+
2232
+ # Unstructured document information.
2233
+ # Corresponds to the JSON property `unstructuredDocumentInfo`
2234
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo]
2235
+ attr_accessor :unstructured_document_info
2236
+
2237
+ def initialize(**args)
2238
+ update!(**args)
2239
+ end
2240
+
2241
+ # Update properties of this object
2242
+ def update!(**args)
2243
+ @chunk_info = args[:chunk_info] if args.key?(:chunk_info)
2244
+ @unstructured_document_info = args[:unstructured_document_info] if args.key?(:unstructured_document_info)
2245
+ end
2246
+ end
2247
+
2248
+ # Chunk information.
2249
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo
2250
+ include Google::Apis::Core::Hashable
2251
+
2252
+ # Chunk resource name.
2253
+ # Corresponds to the JSON property `chunk`
2254
+ # @return [String]
2255
+ attr_accessor :chunk
2256
+
2257
+ # Chunk textual content.
2258
+ # Corresponds to the JSON property `content`
2259
+ # @return [String]
2260
+ attr_accessor :content
2261
+
2262
+ def initialize(**args)
2263
+ update!(**args)
2264
+ end
2265
+
2266
+ # Update properties of this object
2267
+ def update!(**args)
2268
+ @chunk = args[:chunk] if args.key?(:chunk)
2269
+ @content = args[:content] if args.key?(:content)
2270
+ end
2271
+ end
2272
+
2273
+ # Unstructured document information.
2274
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo
2275
+ include Google::Apis::Core::Hashable
2276
+
2277
+ # Document resource name.
2278
+ # Corresponds to the JSON property `document`
2279
+ # @return [String]
2280
+ attr_accessor :document
2281
+
2282
+ # List of document contexts.
2283
+ # Corresponds to the JSON property `documentContexts`
2284
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext>]
2285
+ attr_accessor :document_contexts
2286
+
2287
+ # List of extractive answers.
2288
+ # Corresponds to the JSON property `extractiveAnswers`
2289
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer>]
2290
+ attr_accessor :extractive_answers
2291
+
2292
+ # List of extractive segments.
2293
+ # Corresponds to the JSON property `extractiveSegments`
2294
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment>]
2295
+ attr_accessor :extractive_segments
2296
+
2297
+ # Title.
2298
+ # Corresponds to the JSON property `title`
2299
+ # @return [String]
2300
+ attr_accessor :title
2301
+
2302
+ # URI for the document.
2303
+ # Corresponds to the JSON property `uri`
2304
+ # @return [String]
2305
+ attr_accessor :uri
2306
+
2307
+ def initialize(**args)
2308
+ update!(**args)
2309
+ end
2310
+
2311
+ # Update properties of this object
2312
+ def update!(**args)
2313
+ @document = args[:document] if args.key?(:document)
2314
+ @document_contexts = args[:document_contexts] if args.key?(:document_contexts)
2315
+ @extractive_answers = args[:extractive_answers] if args.key?(:extractive_answers)
2316
+ @extractive_segments = args[:extractive_segments] if args.key?(:extractive_segments)
2317
+ @title = args[:title] if args.key?(:title)
2318
+ @uri = args[:uri] if args.key?(:uri)
2319
+ end
2320
+ end
2321
+
2322
+ # Document context.
2323
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext
2324
+ include Google::Apis::Core::Hashable
2325
+
2326
+ # Document content.
2327
+ # Corresponds to the JSON property `content`
2328
+ # @return [String]
2329
+ attr_accessor :content
2330
+
2331
+ # Page identifier.
2332
+ # Corresponds to the JSON property `pageIdentifier`
2333
+ # @return [String]
2334
+ attr_accessor :page_identifier
2335
+
2336
+ def initialize(**args)
2337
+ update!(**args)
2338
+ end
2339
+
2340
+ # Update properties of this object
2341
+ def update!(**args)
2342
+ @content = args[:content] if args.key?(:content)
2343
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
2344
+ end
2345
+ end
2346
+
2347
+ # Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/
2348
+ # docs/snippets#get-answers)
2349
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer
2350
+ include Google::Apis::Core::Hashable
2351
+
2352
+ # Extractive answer content.
2353
+ # Corresponds to the JSON property `content`
2354
+ # @return [String]
2355
+ attr_accessor :content
2356
+
2357
+ # Page identifier.
2358
+ # Corresponds to the JSON property `pageIdentifier`
2359
+ # @return [String]
2360
+ attr_accessor :page_identifier
2361
+
2362
+ def initialize(**args)
2363
+ update!(**args)
2364
+ end
2365
+
2366
+ # Update properties of this object
2367
+ def update!(**args)
2368
+ @content = args[:content] if args.key?(:content)
2369
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
2370
+ end
2371
+ end
2372
+
2373
+ # Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/
2374
+ # docs/snippets#extractive-segments)
2375
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment
2376
+ include Google::Apis::Core::Hashable
2377
+
2378
+ # Extractive segment content.
2379
+ # Corresponds to the JSON property `content`
2380
+ # @return [String]
2381
+ attr_accessor :content
2382
+
2383
+ # Page identifier.
2384
+ # Corresponds to the JSON property `pageIdentifier`
2385
+ # @return [String]
2386
+ attr_accessor :page_identifier
2387
+
2388
+ def initialize(**args)
2389
+ update!(**args)
2390
+ end
2391
+
2392
+ # Update properties of this object
2393
+ def update!(**args)
2394
+ @content = args[:content] if args.key?(:content)
2395
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
2396
+ end
2397
+ end
2398
+
2399
+ # Response message for ConversationalSearchService.AnswerQuery method.
2400
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse
2401
+ include Google::Apis::Core::Hashable
2402
+
2403
+ # Defines an answer.
2404
+ # Corresponds to the JSON property `answer`
2405
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswer]
2406
+ attr_accessor :answer
2407
+
2408
+ # A global unique ID used for logging.
2409
+ # Corresponds to the JSON property `answerQueryToken`
2410
+ # @return [String]
2411
+ attr_accessor :answer_query_token
2412
+
2413
+ # External session proto definition.
2414
+ # Corresponds to the JSON property `session`
2415
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession]
2416
+ attr_accessor :session
2417
+
2418
+ def initialize(**args)
2419
+ update!(**args)
2420
+ end
2421
+
2422
+ # Update properties of this object
2423
+ def update!(**args)
2424
+ @answer = args[:answer] if args.key?(:answer)
2425
+ @answer_query_token = args[:answer_query_token] if args.key?(:answer_query_token)
2426
+ @session = args[:session] if args.key?(:session)
2427
+ end
2428
+ end
2429
+
2430
+ # Query understanding information.
2431
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo
2432
+ include Google::Apis::Core::Hashable
2433
+
2434
+ # Query classification information.
2435
+ # Corresponds to the JSON property `queryClassificationInfo`
2436
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo>]
2437
+ attr_accessor :query_classification_info
2438
+
2439
+ def initialize(**args)
2440
+ update!(**args)
2441
+ end
2442
+
2443
+ # Update properties of this object
2444
+ def update!(**args)
2445
+ @query_classification_info = args[:query_classification_info] if args.key?(:query_classification_info)
2446
+ end
2447
+ end
2448
+
2449
+ # Query classification information.
2450
+ class GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo
2451
+ include Google::Apis::Core::Hashable
2452
+
2453
+ # Classification output.
2454
+ # Corresponds to the JSON property `positive`
2455
+ # @return [Boolean]
2456
+ attr_accessor :positive
2457
+ alias_method :positive?, :positive
2458
+
2459
+ # Query classification type.
2460
+ # Corresponds to the JSON property `type`
2461
+ # @return [String]
2462
+ attr_accessor :type
2463
+
2464
+ def initialize(**args)
2465
+ update!(**args)
2466
+ end
2467
+
2468
+ # Update properties of this object
2469
+ def update!(**args)
2470
+ @positive = args[:positive] if args.key?(:positive)
2471
+ @type = args[:type] if args.key?(:type)
2472
+ end
2473
+ end
2474
+
2475
+ # Reference.
2476
+ class GoogleCloudDiscoveryengineV1alphaAnswerReference
2477
+ include Google::Apis::Core::Hashable
2478
+
2479
+ # Chunk information.
2480
+ # Corresponds to the JSON property `chunkInfo`
2481
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo]
2482
+ attr_accessor :chunk_info
2483
+
2484
+ # Unstructured document information.
2485
+ # Corresponds to the JSON property `unstructuredDocumentInfo`
2486
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo]
2487
+ attr_accessor :unstructured_document_info
2488
+
2489
+ def initialize(**args)
2490
+ update!(**args)
2491
+ end
2492
+
2493
+ # Update properties of this object
2494
+ def update!(**args)
2495
+ @chunk_info = args[:chunk_info] if args.key?(:chunk_info)
2496
+ @unstructured_document_info = args[:unstructured_document_info] if args.key?(:unstructured_document_info)
2497
+ end
2498
+ end
2499
+
2500
+ # Chunk information.
2501
+ class GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo
2502
+ include Google::Apis::Core::Hashable
2503
+
2504
+ # Chunk resource name.
2505
+ # Corresponds to the JSON property `chunk`
2506
+ # @return [String]
2507
+ attr_accessor :chunk
2508
+
2509
+ # Chunk textual content.
2510
+ # Corresponds to the JSON property `content`
2511
+ # @return [String]
2512
+ attr_accessor :content
2513
+
2514
+ # Document metadata.
2515
+ # Corresponds to the JSON property `documentMetadata`
2516
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata]
2517
+ attr_accessor :document_metadata
2518
+
2519
+ # Relevance score.
2520
+ # Corresponds to the JSON property `relevanceScore`
2521
+ # @return [Float]
2522
+ attr_accessor :relevance_score
2523
+
2524
+ def initialize(**args)
2525
+ update!(**args)
2526
+ end
2527
+
2528
+ # Update properties of this object
2529
+ def update!(**args)
2530
+ @chunk = args[:chunk] if args.key?(:chunk)
2531
+ @content = args[:content] if args.key?(:content)
2532
+ @document_metadata = args[:document_metadata] if args.key?(:document_metadata)
2533
+ @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
2534
+ end
2535
+ end
2536
+
2537
+ # Document metadata.
2538
+ class GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata
2539
+ include Google::Apis::Core::Hashable
2540
+
2541
+ # Document resource name.
2542
+ # Corresponds to the JSON property `document`
2543
+ # @return [String]
2544
+ attr_accessor :document
2545
+
2546
+ # Page identifier.
2547
+ # Corresponds to the JSON property `pageIdentifier`
2548
+ # @return [String]
2549
+ attr_accessor :page_identifier
2550
+
2551
+ # Title.
2552
+ # Corresponds to the JSON property `title`
2553
+ # @return [String]
2554
+ attr_accessor :title
2555
+
2556
+ # URI for the document.
2557
+ # Corresponds to the JSON property `uri`
2558
+ # @return [String]
2559
+ attr_accessor :uri
2560
+
2561
+ def initialize(**args)
2562
+ update!(**args)
2563
+ end
2564
+
2565
+ # Update properties of this object
2566
+ def update!(**args)
2567
+ @document = args[:document] if args.key?(:document)
2568
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
2569
+ @title = args[:title] if args.key?(:title)
2570
+ @uri = args[:uri] if args.key?(:uri)
2571
+ end
2572
+ end
2573
+
2574
+ # Unstructured document information.
2575
+ class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo
2576
+ include Google::Apis::Core::Hashable
2577
+
2578
+ # List of cited chunk contents derived from document content.
2579
+ # Corresponds to the JSON property `chunkContents`
2580
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent>]
2581
+ attr_accessor :chunk_contents
2582
+
2583
+ # Document resource name.
2584
+ # Corresponds to the JSON property `document`
2585
+ # @return [String]
2586
+ attr_accessor :document
2587
+
2588
+ # Title.
2589
+ # Corresponds to the JSON property `title`
2590
+ # @return [String]
2591
+ attr_accessor :title
2592
+
2593
+ # URI for the document.
2594
+ # Corresponds to the JSON property `uri`
2595
+ # @return [String]
2596
+ attr_accessor :uri
2597
+
2598
+ def initialize(**args)
2599
+ update!(**args)
2600
+ end
2601
+
2602
+ # Update properties of this object
2603
+ def update!(**args)
2604
+ @chunk_contents = args[:chunk_contents] if args.key?(:chunk_contents)
2605
+ @document = args[:document] if args.key?(:document)
2606
+ @title = args[:title] if args.key?(:title)
2607
+ @uri = args[:uri] if args.key?(:uri)
2608
+ end
2609
+ end
2610
+
2611
+ # Chunk content.
2612
+ class GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent
2613
+ include Google::Apis::Core::Hashable
2614
+
2615
+ # Chunk textual content.
2616
+ # Corresponds to the JSON property `content`
2617
+ # @return [String]
2618
+ attr_accessor :content
2619
+
2620
+ # Page identifier.
2621
+ # Corresponds to the JSON property `pageIdentifier`
2622
+ # @return [String]
2623
+ attr_accessor :page_identifier
2624
+
2625
+ def initialize(**args)
2626
+ update!(**args)
2627
+ end
2628
+
2629
+ # Update properties of this object
2630
+ def update!(**args)
2631
+ @content = args[:content] if args.key?(:content)
2632
+ @page_identifier = args[:page_identifier] if args.key?(:page_identifier)
2633
+ end
2634
+ end
2635
+
2636
+ # Step information.
2637
+ class GoogleCloudDiscoveryengineV1alphaAnswerStep
2638
+ include Google::Apis::Core::Hashable
2639
+
2640
+ # Actions.
2641
+ # Corresponds to the JSON property `actions`
2642
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStepAction>]
2643
+ attr_accessor :actions
2644
+
2645
+ # The description of the step.
2646
+ # Corresponds to the JSON property `description`
2647
+ # @return [String]
2648
+ attr_accessor :description
2649
+
2650
+ # The state of the step.
2651
+ # Corresponds to the JSON property `state`
2652
+ # @return [String]
2653
+ attr_accessor :state
2654
+
2655
+ # The thought of the step.
2656
+ # Corresponds to the JSON property `thought`
2657
+ # @return [String]
2658
+ attr_accessor :thought
2659
+
2660
+ def initialize(**args)
2661
+ update!(**args)
2662
+ end
2663
+
2664
+ # Update properties of this object
2665
+ def update!(**args)
2666
+ @actions = args[:actions] if args.key?(:actions)
2667
+ @description = args[:description] if args.key?(:description)
2668
+ @state = args[:state] if args.key?(:state)
2669
+ @thought = args[:thought] if args.key?(:thought)
2670
+ end
2671
+ end
2672
+
2673
+ # Action.
2674
+ class GoogleCloudDiscoveryengineV1alphaAnswerStepAction
2675
+ include Google::Apis::Core::Hashable
2676
+
2677
+ # Observation.
2678
+ # Corresponds to the JSON property `observation`
2679
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation]
2680
+ attr_accessor :observation
2681
+
2682
+ # Search action.
2683
+ # Corresponds to the JSON property `searchAction`
2684
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction]
2685
+ attr_accessor :search_action
2686
+
2687
+ def initialize(**args)
2688
+ update!(**args)
2689
+ end
2690
+
2691
+ # Update properties of this object
2692
+ def update!(**args)
2693
+ @observation = args[:observation] if args.key?(:observation)
2694
+ @search_action = args[:search_action] if args.key?(:search_action)
2695
+ end
2696
+ end
2697
+
2698
+ # Observation.
2699
+ class GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation
2700
+ include Google::Apis::Core::Hashable
2701
+
2702
+ # Search results observed by the search action, it can be snippets info or chunk
2703
+ # info, depending on the citation type set by the user.
2704
+ # Corresponds to the JSON property `searchResults`
2705
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult>]
2706
+ attr_accessor :search_results
2707
+
2708
+ def initialize(**args)
2709
+ update!(**args)
2710
+ end
2711
+
2712
+ # Update properties of this object
2713
+ def update!(**args)
2714
+ @search_results = args[:search_results] if args.key?(:search_results)
1574
2715
  end
1575
2716
  end
1576
2717
 
1577
- # Metadata for UpdateSchema LRO.
1578
- class GoogleCloudDiscoveryengineV1UpdateSchemaMetadata
2718
+ #
2719
+ class GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult
1579
2720
  include Google::Apis::Core::Hashable
1580
2721
 
1581
- # Operation create time.
1582
- # Corresponds to the JSON property `createTime`
2722
+ # If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk
2723
+ # info.
2724
+ # Corresponds to the JSON property `chunkInfo`
2725
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo>]
2726
+ attr_accessor :chunk_info
2727
+
2728
+ # Document resource name.
2729
+ # Corresponds to the JSON property `document`
1583
2730
  # @return [String]
1584
- attr_accessor :create_time
2731
+ attr_accessor :document
1585
2732
 
1586
- # Operation last update time. If the operation is done, this is also the finish
1587
- # time.
1588
- # Corresponds to the JSON property `updateTime`
2733
+ # If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
2734
+ # Corresponds to the JSON property `snippetInfo`
2735
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo>]
2736
+ attr_accessor :snippet_info
2737
+
2738
+ # Title.
2739
+ # Corresponds to the JSON property `title`
1589
2740
  # @return [String]
1590
- attr_accessor :update_time
2741
+ attr_accessor :title
2742
+
2743
+ # URI for the document.
2744
+ # Corresponds to the JSON property `uri`
2745
+ # @return [String]
2746
+ attr_accessor :uri
1591
2747
 
1592
2748
  def initialize(**args)
1593
2749
  update!(**args)
@@ -1595,27 +2751,32 @@ module Google
1595
2751
 
1596
2752
  # Update properties of this object
1597
2753
  def update!(**args)
1598
- @create_time = args[:create_time] if args.key?(:create_time)
1599
- @update_time = args[:update_time] if args.key?(:update_time)
2754
+ @chunk_info = args[:chunk_info] if args.key?(:chunk_info)
2755
+ @document = args[:document] if args.key?(:document)
2756
+ @snippet_info = args[:snippet_info] if args.key?(:snippet_info)
2757
+ @title = args[:title] if args.key?(:title)
2758
+ @uri = args[:uri] if args.key?(:uri)
1600
2759
  end
1601
2760
  end
1602
2761
 
1603
- # Metadata related to the progress of the SiteSearchEngineService.
1604
- # UpdateTargetSite operation. This will be returned by the google.longrunning.
1605
- # Operation.metadata field.
1606
- class GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata
2762
+ # Chunk information.
2763
+ class GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo
1607
2764
  include Google::Apis::Core::Hashable
1608
2765
 
1609
- # Operation create time.
1610
- # Corresponds to the JSON property `createTime`
2766
+ # Chunk resource name.
2767
+ # Corresponds to the JSON property `chunk`
1611
2768
  # @return [String]
1612
- attr_accessor :create_time
2769
+ attr_accessor :chunk
1613
2770
 
1614
- # Operation last update time. If the operation is done, this is also the finish
1615
- # time.
1616
- # Corresponds to the JSON property `updateTime`
2771
+ # Chunk textual content.
2772
+ # Corresponds to the JSON property `content`
1617
2773
  # @return [String]
1618
- attr_accessor :update_time
2774
+ attr_accessor :content
2775
+
2776
+ # Relevance score.
2777
+ # Corresponds to the JSON property `relevanceScore`
2778
+ # @return [Float]
2779
+ attr_accessor :relevance_score
1619
2780
 
1620
2781
  def initialize(**args)
1621
2782
  update!(**args)
@@ -1623,26 +2784,25 @@ module Google
1623
2784
 
1624
2785
  # Update properties of this object
1625
2786
  def update!(**args)
1626
- @create_time = args[:create_time] if args.key?(:create_time)
1627
- @update_time = args[:update_time] if args.key?(:update_time)
2787
+ @chunk = args[:chunk] if args.key?(:chunk)
2788
+ @content = args[:content] if args.key?(:content)
2789
+ @relevance_score = args[:relevance_score] if args.key?(:relevance_score)
1628
2790
  end
1629
2791
  end
1630
2792
 
1631
- # Access Control Configuration.
1632
- class GoogleCloudDiscoveryengineV1alphaAclConfig
2793
+ # Snippet information.
2794
+ class GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo
1633
2795
  include Google::Apis::Core::Hashable
1634
2796
 
1635
- # Identity Provider Config.
1636
- # Corresponds to the JSON property `idpConfig`
1637
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaIdpConfig]
1638
- attr_accessor :idp_config
2797
+ # Snippet content.
2798
+ # Corresponds to the JSON property `snippet`
2799
+ # @return [String]
2800
+ attr_accessor :snippet
1639
2801
 
1640
- # Immutable. The full resource name of the acl configuration. Format: `projects/`
1641
- # project`/locations/`location`/aclConfig`. This field must be a UTF-8 encoded
1642
- # string with a length limit of 1024 characters.
1643
- # Corresponds to the JSON property `name`
2802
+ # Status of the snippet defined by the search team.
2803
+ # Corresponds to the JSON property `snippetStatus`
1644
2804
  # @return [String]
1645
- attr_accessor :name
2805
+ attr_accessor :snippet_status
1646
2806
 
1647
2807
  def initialize(**args)
1648
2808
  update!(**args)
@@ -1650,20 +2810,19 @@ module Google
1650
2810
 
1651
2811
  # Update properties of this object
1652
2812
  def update!(**args)
1653
- @idp_config = args[:idp_config] if args.key?(:idp_config)
1654
- @name = args[:name] if args.key?(:name)
2813
+ @snippet = args[:snippet] if args.key?(:snippet)
2814
+ @snippet_status = args[:snippet_status] if args.key?(:snippet_status)
1655
2815
  end
1656
2816
  end
1657
2817
 
1658
- # AdditionalParams message for WidgetService methods for security and privacy
1659
- # enhancement.
1660
- class GoogleCloudDiscoveryengineV1alphaAdditionalParams
2818
+ # Search action.
2819
+ class GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction
1661
2820
  include Google::Apis::Core::Hashable
1662
2821
 
1663
- # Token that used for non-human user check.
1664
- # Corresponds to the JSON property `token`
2822
+ # The query to search.
2823
+ # Corresponds to the JSON property `query`
1665
2824
  # @return [String]
1666
- attr_accessor :token
2825
+ attr_accessor :query
1667
2826
 
1668
2827
  def initialize(**args)
1669
2828
  update!(**args)
@@ -1671,7 +2830,7 @@ module Google
1671
2830
 
1672
2831
  # Update properties of this object
1673
2832
  def update!(**args)
1674
- @token = args[:token] if args.key?(:token)
2833
+ @query = args[:query] if args.key?(:query)
1675
2834
  end
1676
2835
  end
1677
2836
 
@@ -1765,7 +2924,7 @@ module Google
1765
2924
  # row. Each document must have a valid Document.id and one of Document.json_data
1766
2925
  # or Document.struct_data. * `custom`: One custom data per row in arbitrary
1767
2926
  # format that conforms to the defined Schema of the data store. This can only be
1768
- # used by Gen App Builder.
2927
+ # used by the GENERIC Data Store vertical.
1769
2928
  # Corresponds to the JSON property `dataSchema`
1770
2929
  # @return [String]
1771
2930
  attr_accessor :data_schema
@@ -1834,8 +2993,8 @@ module Google
1834
2993
  # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily>]
1835
2994
  attr_accessor :families
1836
2995
 
1837
- # The field name used for saving row key value in the UCS document. The name has
1838
- # to match a-zA-Z0-9*
2996
+ # The field name used for saving row key value in the document. The name has to
2997
+ # match the pattern `a-zA-Z0-9*`.
1839
2998
  # Corresponds to the JSON property `keyFieldName`
1840
2999
  # @return [String]
1841
3000
  attr_accessor :key_field_name
@@ -1851,37 +3010,37 @@ module Google
1851
3010
  end
1852
3011
  end
1853
3012
 
1854
- #
3013
+ # The column of the Bigtable.
1855
3014
  class GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn
1856
3015
  include Google::Apis::Core::Hashable
1857
3016
 
1858
- # Optional. The encoding mode of the values when the type is not STRING.
1859
- # Acceptable encoding values are: TEXT - indicates values are alphanumeric text
1860
- # strings. BINARY - indicates values are encoded using HBase Bytes.toBytes
1861
- # family of functions. This can be overridden for a specific column by listing
1862
- # that column in 'columns' and specifying an encoding for it.
3017
+ # The encoding mode of the values when the type is not `STRING`. Acceptable
3018
+ # encoding values are: * `TEXT`: indicates values are alphanumeric text strings.
3019
+ # * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of
3020
+ # functions. This can be overridden for a specific column by listing that column
3021
+ # in `columns` and specifying an encoding for it.
1863
3022
  # Corresponds to the JSON property `encoding`
1864
3023
  # @return [String]
1865
3024
  attr_accessor :encoding
1866
3025
 
1867
- # The field name to use for this column in the UCS document. The name has to
1868
- # match a-zA-Z0-9* If not set, we will parse it from the qualifier bytes with
1869
- # best effort. However, field name collisions could happen, where parsing
1870
- # behavior is undefined.
3026
+ # The field name to use for this column in the document. The name has to match
3027
+ # the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes
3028
+ # with best effort. However, due to different naming patterns, field name
3029
+ # collisions could happen, where parsing behavior is undefined.
1871
3030
  # Corresponds to the JSON property `fieldName`
1872
3031
  # @return [String]
1873
3032
  attr_accessor :field_name
1874
3033
 
1875
- # Required. Qualifier of the column. If cannot decode with utf-8, store a base-
1876
- # 64 encoded string.
3034
+ # Required. Qualifier of the column. If it cannot be decoded with utf-8, use a
3035
+ # base-64 encoded string instead.
1877
3036
  # Corresponds to the JSON property `qualifier`
1878
3037
  # NOTE: Values are automatically base64 encoded/decoded in the client library.
1879
3038
  # @return [String]
1880
3039
  attr_accessor :qualifier
1881
3040
 
1882
- # Optional. The type of values in this column family. The values are expected to
1883
- # be encoded using HBase Bytes.toBytes function when the encoding value is set
1884
- # to BINARY.
3041
+ # The type of values in this column family. The values are expected to be
3042
+ # encoded using `HBase Bytes.toBytes` function when the encoding value is set to
3043
+ # `BINARY`.
1885
3044
  # Corresponds to the JSON property `type`
1886
3045
  # @return [String]
1887
3046
  attr_accessor :type
@@ -1899,7 +3058,7 @@ module Google
1899
3058
  end
1900
3059
  end
1901
3060
 
1902
- #
3061
+ # The column family of the Bigtable.
1903
3062
  class GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily
1904
3063
  include Google::Apis::Core::Hashable
1905
3064
 
@@ -1909,26 +3068,26 @@ module Google
1909
3068
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn>]
1910
3069
  attr_accessor :columns
1911
3070
 
1912
- # Optional. The encoding mode of the values when the type is not STRING.
1913
- # Acceptable encoding values are: TEXT - indicates values are alphanumeric text
1914
- # strings. BINARY - indicates values are encoded using HBase Bytes.toBytes
1915
- # family of functions. This can be overridden for a specific column by listing
1916
- # that column in 'columns' and specifying an encoding for it.
3071
+ # The encoding mode of the values when the type is not STRING. Acceptable
3072
+ # encoding values are: * `TEXT`: indicates values are alphanumeric text strings.
3073
+ # * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of
3074
+ # functions. This can be overridden for a specific column by listing that column
3075
+ # in `columns` and specifying an encoding for it.
1917
3076
  # Corresponds to the JSON property `encoding`
1918
3077
  # @return [String]
1919
3078
  attr_accessor :encoding
1920
3079
 
1921
- # The field name to use for this column family in the UCS document. The name has
1922
- # to match a-zA-Z0-9* If not set, we will parse it from the family name with
1923
- # best effort. However, due to difference naming pattern, there could be field
1924
- # name collisions, where parsing behavior is undefined.
3080
+ # The field name to use for this column family in the document. The name has to
3081
+ # match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name
3082
+ # with best effort. However, due to different naming patterns, field name
3083
+ # collisions could happen, where parsing behavior is undefined.
1925
3084
  # Corresponds to the JSON property `fieldName`
1926
3085
  # @return [String]
1927
3086
  attr_accessor :field_name
1928
3087
 
1929
- # Optional. The type of values in this column family. The values are expected to
1930
- # be encoded using HBase Bytes.toBytes function when the encoding value is set
1931
- # to BINARY.
3088
+ # The type of values in this column family. The values are expected to be
3089
+ # encoded using `HBase Bytes.toBytes` function when the encoding value is set to
3090
+ # `BINARY`.
1932
3091
  # Corresponds to the JSON property `type`
1933
3092
  # @return [String]
1934
3093
  attr_accessor :type
@@ -1946,7 +3105,7 @@ module Google
1946
3105
  end
1947
3106
  end
1948
3107
 
1949
- # The Cloud Bigtable source for importing data
3108
+ # The Cloud Bigtable source for importing data.
1950
3109
  class GoogleCloudDiscoveryengineV1alphaBigtableSource
1951
3110
  include Google::Apis::Core::Hashable
1952
3111
 
@@ -1955,19 +3114,18 @@ module Google
1955
3114
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableOptions]
1956
3115
  attr_accessor :bigtable_options
1957
3116
 
1958
- # Required. The instance ID of the Cloud Bigtable that needs to be exported.
3117
+ # Required. The instance ID of the Cloud Bigtable that needs to be imported.
1959
3118
  # Corresponds to the JSON property `instanceId`
1960
3119
  # @return [String]
1961
3120
  attr_accessor :instance_id
1962
3121
 
1963
- # The project ID (can be project # or ID) that the Bigtable source is in with a
1964
- # length limit of 128 characters. If not specified, inherits the project ID from
1965
- # the parent request.
3122
+ # The project ID that the Bigtable source is in with a length limit of 128
3123
+ # characters. If not specified, inherits the project ID from the parent request.
1966
3124
  # Corresponds to the JSON property `projectId`
1967
3125
  # @return [String]
1968
3126
  attr_accessor :project_id
1969
3127
 
1970
- # Required. The table ID of the Cloud Bigtable that needs to be exported.
3128
+ # Required. The table ID of the Cloud Bigtable that needs to be imported.
1971
3129
  # Corresponds to the JSON property `tableId`
1972
3130
  # @return [String]
1973
3131
  attr_accessor :table_id
@@ -1985,6 +3143,136 @@ module Google
1985
3143
  end
1986
3144
  end
1987
3145
 
3146
+ # Request message for GroundedGenerationService.CheckGrounding method.
3147
+ class GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest
3148
+ include Google::Apis::Core::Hashable
3149
+
3150
+ # Answer candidate to check.
3151
+ # Corresponds to the JSON property `answerCandidate`
3152
+ # @return [String]
3153
+ attr_accessor :answer_candidate
3154
+
3155
+ # List of facts for the grounding check. We support up to 200 facts.
3156
+ # Corresponds to the JSON property `facts`
3157
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaGroundingFact>]
3158
+ attr_accessor :facts
3159
+
3160
+ # Specification for the grounding check.
3161
+ # Corresponds to the JSON property `groundingSpec`
3162
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec]
3163
+ attr_accessor :grounding_spec
3164
+
3165
+ def initialize(**args)
3166
+ update!(**args)
3167
+ end
3168
+
3169
+ # Update properties of this object
3170
+ def update!(**args)
3171
+ @answer_candidate = args[:answer_candidate] if args.key?(:answer_candidate)
3172
+ @facts = args[:facts] if args.key?(:facts)
3173
+ @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
3174
+ end
3175
+ end
3176
+
3177
+ # Response message for the GroundedGenerationService.CheckGrounding method.
3178
+ class GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse
3179
+ include Google::Apis::Core::Hashable
3180
+
3181
+ # List of facts cited across all claims in the answer candidate. These are
3182
+ # derived from the facts supplied in the request.
3183
+ # Corresponds to the JSON property `citedChunks`
3184
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFactChunk>]
3185
+ attr_accessor :cited_chunks
3186
+
3187
+ # Claim texts and citation info across all claims in the answer candidate.
3188
+ # Corresponds to the JSON property `claims`
3189
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim>]
3190
+ attr_accessor :claims
3191
+
3192
+ # The support score for the input answer candidate. Higher the score, higher is
3193
+ # the fraction of claims that are supported by the provided facts. This is
3194
+ # always set when a response is returned.
3195
+ # Corresponds to the JSON property `supportScore`
3196
+ # @return [Float]
3197
+ attr_accessor :support_score
3198
+
3199
+ def initialize(**args)
3200
+ update!(**args)
3201
+ end
3202
+
3203
+ # Update properties of this object
3204
+ def update!(**args)
3205
+ @cited_chunks = args[:cited_chunks] if args.key?(:cited_chunks)
3206
+ @claims = args[:claims] if args.key?(:claims)
3207
+ @support_score = args[:support_score] if args.key?(:support_score)
3208
+ end
3209
+ end
3210
+
3211
+ # Text and citation info for a claim in the answer candidate.
3212
+ class GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim
3213
+ include Google::Apis::Core::Hashable
3214
+
3215
+ # A list of indices (into 'cited_chunks') specifying the citations associated
3216
+ # with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[
3217
+ # 3], cited_chunks[4] are the facts cited supporting for the claim. A citation
3218
+ # to a fact indicates that the claim is supported by the fact.
3219
+ # Corresponds to the JSON property `citationIndices`
3220
+ # @return [Array<Fixnum>]
3221
+ attr_accessor :citation_indices
3222
+
3223
+ # Text for the claim in the answer candidate. Always provided regardless of
3224
+ # whether citations or anti-citations are found.
3225
+ # Corresponds to the JSON property `claimText`
3226
+ # @return [String]
3227
+ attr_accessor :claim_text
3228
+
3229
+ # Position indicating the end of the claim in the answer candidate, exclusive.
3230
+ # Corresponds to the JSON property `endPos`
3231
+ # @return [Fixnum]
3232
+ attr_accessor :end_pos
3233
+
3234
+ # Position indicating the start of the claim in the answer candidate, measured
3235
+ # in bytes.
3236
+ # Corresponds to the JSON property `startPos`
3237
+ # @return [Fixnum]
3238
+ attr_accessor :start_pos
3239
+
3240
+ def initialize(**args)
3241
+ update!(**args)
3242
+ end
3243
+
3244
+ # Update properties of this object
3245
+ def update!(**args)
3246
+ @citation_indices = args[:citation_indices] if args.key?(:citation_indices)
3247
+ @claim_text = args[:claim_text] if args.key?(:claim_text)
3248
+ @end_pos = args[:end_pos] if args.key?(:end_pos)
3249
+ @start_pos = args[:start_pos] if args.key?(:start_pos)
3250
+ end
3251
+ end
3252
+
3253
+ # Specification for the grounding check.
3254
+ class GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec
3255
+ include Google::Apis::Core::Hashable
3256
+
3257
+ # The threshold (in [0,1]) used for determining whether a fact must be cited for
3258
+ # a claim in the answer candidate. Choosing a higher threshold will lead to
3259
+ # fewer but very strong citations, while choosing a lower threshold may lead to
3260
+ # more but somewhat weaker citations. If unset, the threshold will default to 0.
3261
+ # 6.
3262
+ # Corresponds to the JSON property `citationThreshold`
3263
+ # @return [Float]
3264
+ attr_accessor :citation_threshold
3265
+
3266
+ def initialize(**args)
3267
+ update!(**args)
3268
+ end
3269
+
3270
+ # Update properties of this object
3271
+ def update!(**args)
3272
+ @citation_threshold = args[:citation_threshold] if args.key?(:citation_threshold)
3273
+ end
3274
+ end
3275
+
1988
3276
  # Chunk captures all raw metadata information of items to be recommended or
1989
3277
  # searched in the chunk mode.
1990
3278
  class GoogleCloudDiscoveryengineV1alphaChunk
@@ -2013,7 +3301,7 @@ module Google
2013
3301
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata]
2014
3302
  attr_accessor :document_metadata
2015
3303
 
2016
- # Unique chunk id of the current chunk.
3304
+ # Unique chunk ID of the current chunk.
2017
3305
  # Corresponds to the JSON property `id`
2018
3306
  # @return [String]
2019
3307
  attr_accessor :id
@@ -2082,6 +3370,12 @@ module Google
2082
3370
  class GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata
2083
3371
  include Google::Apis::Core::Hashable
2084
3372
 
3373
+ # Data representation. The structured JSON data for the document. It should
3374
+ # conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
3375
+ # Corresponds to the JSON property `structData`
3376
+ # @return [Hash<String,Object>]
3377
+ attr_accessor :struct_data
3378
+
2085
3379
  # Title of the document.
2086
3380
  # Corresponds to the JSON property `title`
2087
3381
  # @return [String]
@@ -2098,6 +3392,7 @@ module Google
2098
3392
 
2099
3393
  # Update properties of this object
2100
3394
  def update!(**args)
3395
+ @struct_data = args[:struct_data] if args.key?(:struct_data)
2101
3396
  @title = args[:title] if args.key?(:title)
2102
3397
  @uri = args[:uri] if args.key?(:uri)
2103
3398
  end
@@ -2138,11 +3433,11 @@ module Google
2138
3433
  # @return [String]
2139
3434
  attr_accessor :database_id
2140
3435
 
2141
- # Optional. Intermediate Cloud Storage directory used for the import with a
2142
- # length limit of 2,000 characters. Can be specified if one wants to have the
2143
- # Cloud SQL export to a specific Cloud Storage directory. Please ensure that the
2144
- # Cloud SQL service account has the necessary GCS Storage Admin permissions to
2145
- # access the specified GCS directory.
3436
+ # Intermediate Cloud Storage directory used for the import with a length limit
3437
+ # of 2,000 characters. Can be specified if one wants to have the Cloud SQL
3438
+ # export to a specific Cloud Storage directory. Ensure that the Cloud SQL
3439
+ # service account has the necessary Cloud Storage Admin permissions to access
3440
+ # the specified Cloud Storage directory.
2146
3441
  # Corresponds to the JSON property `gcsStagingDir`
2147
3442
  # @return [String]
2148
3443
  attr_accessor :gcs_staging_dir
@@ -2153,16 +3448,15 @@ module Google
2153
3448
  # @return [String]
2154
3449
  attr_accessor :instance_id
2155
3450
 
2156
- # Optional. Option for serverless export. Enabling this option will incur
2157
- # additional cost. More info: https://cloud.google.com/sql/pricing#serverless
3451
+ # Option for serverless export. Enabling this option will incur additional cost.
3452
+ # More info can be found [here](https://cloud.google.com/sql/pricing#serverless).
2158
3453
  # Corresponds to the JSON property `offload`
2159
3454
  # @return [Boolean]
2160
3455
  attr_accessor :offload
2161
3456
  alias_method :offload?, :offload
2162
3457
 
2163
- # Optional. The project ID (can be project # or ID) that the Cloud SQL source is
2164
- # in with a length limit of 128 characters. If not specified, inherits the
2165
- # project ID from the parent request.
3458
+ # The project ID that the Cloud SQL source is in with a length limit of 128
3459
+ # characters. If not specified, inherits the project ID from the parent request.
2166
3460
  # Corresponds to the JSON property `projectId`
2167
3461
  # @return [String]
2168
3462
  attr_accessor :project_id
@@ -2350,9 +3644,9 @@ module Google
2350
3644
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversationMessage>]
2351
3645
  attr_accessor :messages
2352
3646
 
2353
- # Immutable. Fully qualified name `project/*/locations/global/collections/`
2354
- # collection`/dataStore/*/conversations/*` or `project/*/locations/global/
2355
- # collections/`collection`/engines/*/conversations/*`.
3647
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
3648
+ # collections/`collection`/dataStore/*/conversations/*` or `projects/`project`/
3649
+ # locations/global/collections/`collection`/engines/*/conversations/*`.
2356
3650
  # Corresponds to the JSON property `name`
2357
3651
  # @return [String]
2358
3652
  attr_accessor :name
@@ -3405,8 +4699,8 @@ module Google
3405
4699
  class GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig
3406
4700
  include Google::Apis::Core::Hashable
3407
4701
 
3408
- # Apply additional enhanced OCR processing to a list of document elements.
3409
- # Supported values: * `table`: advanced table parsing model.
4702
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
4703
+ # elements processing, please switch to `layout_parsing_config`.
3410
4704
  # Corresponds to the JSON property `enhancedDocumentElements`
3411
4705
  # @return [Array<String>]
3412
4706
  attr_accessor :enhanced_document_elements
@@ -3650,8 +4944,8 @@ module Google
3650
4944
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
3651
4945
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
3652
4946
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
3653
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
3654
- # agent association after Engine is created.
4947
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
4948
+ # association after Engine is created.
3655
4949
  # Corresponds to the JSON property `dialogflowAgentToLink`
3656
4950
  # @return [String]
3657
4951
  attr_accessor :dialogflow_agent_to_link
@@ -3886,7 +5180,7 @@ module Google
3886
5180
  attr_accessor :search_add_ons
3887
5181
 
3888
5182
  # The search feature tier of this engine. Different tiers might have different
3889
- # pricing. To learn more, please check the pricing documentation. Defaults to
5183
+ # pricing. To learn more, check the pricing documentation. Defaults to
3890
5184
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
3891
5185
  # Corresponds to the JSON property `searchTier`
3892
5186
  # @return [String]
@@ -4070,6 +5364,39 @@ module Google
4070
5364
  end
4071
5365
  end
4072
5366
 
5367
+ # Fact Chunk.
5368
+ class GoogleCloudDiscoveryengineV1alphaFactChunk
5369
+ include Google::Apis::Core::Hashable
5370
+
5371
+ # Text content of the fact chunk. Can be at most 10K characters long.
5372
+ # Corresponds to the JSON property `chunkText`
5373
+ # @return [String]
5374
+ attr_accessor :chunk_text
5375
+
5376
+ # Source from which this fact chunk was retrieved. If it was retrieved from the
5377
+ # GroundingFacts provided in the request then this field will contain the index
5378
+ # of the specific fact from which this chunk was retrieved.
5379
+ # Corresponds to the JSON property `source`
5380
+ # @return [String]
5381
+ attr_accessor :source
5382
+
5383
+ # More fine-grained information for the source reference.
5384
+ # Corresponds to the JSON property `sourceMetadata`
5385
+ # @return [Hash<String,String>]
5386
+ attr_accessor :source_metadata
5387
+
5388
+ def initialize(**args)
5389
+ update!(**args)
5390
+ end
5391
+
5392
+ # Update properties of this object
5393
+ def update!(**args)
5394
+ @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
5395
+ @source = args[:source] if args.key?(:source)
5396
+ @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
5397
+ end
5398
+ end
5399
+
4073
5400
  # Response message for SiteSearchEngineService.FetchDomainVerificationStatus
4074
5401
  # method.
4075
5402
  class GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse
@@ -4138,6 +5465,15 @@ module Google
4138
5465
  class GoogleCloudDiscoveryengineV1alphaFieldConfig
4139
5466
  include Google::Apis::Core::Hashable
4140
5467
 
5468
+ # If this field is set, only the corresponding source will be indexed for this
5469
+ # field. Otherwise, the values from different sources are merged. Assuming a
5470
+ # page with `` in meta tag, and `` in page map: if this enum is set to METATAGS,
5471
+ # we will only index ``; if this enum is not set, we will merge them and index ``
5472
+ # .
5473
+ # Corresponds to the JSON property `advancedSiteSearchDataSources`
5474
+ # @return [Array<String>]
5475
+ attr_accessor :advanced_site_search_data_sources
5476
+
4141
5477
  # If completable_option is COMPLETABLE_ENABLED, field values are directly used
4142
5478
  # and returned as suggestions for Autocomplete in CompletionService.
4143
5479
  # CompleteQuery. If completable_option is unset, the server behavior defaults to
@@ -4238,6 +5574,7 @@ module Google
4238
5574
 
4239
5575
  # Update properties of this object
4240
5576
  def update!(**args)
5577
+ @advanced_site_search_data_sources = args[:advanced_site_search_data_sources] if args.key?(:advanced_site_search_data_sources)
4241
5578
  @completable_option = args[:completable_option] if args.key?(:completable_option)
4242
5579
  @dynamic_facetable_option = args[:dynamic_facetable_option] if args.key?(:dynamic_facetable_option)
4243
5580
  @field_path = args[:field_path] if args.key?(:field_path)
@@ -4255,7 +5592,7 @@ module Google
4255
5592
  include Google::Apis::Core::Hashable
4256
5593
 
4257
5594
  # Required. The Firestore collection to copy the data from with a length limit
4258
- # of 1500 characters.
5595
+ # of 1,500 characters.
4259
5596
  # Corresponds to the JSON property `collectionId`
4260
5597
  # @return [String]
4261
5598
  attr_accessor :collection_id
@@ -4266,18 +5603,17 @@ module Google
4266
5603
  # @return [String]
4267
5604
  attr_accessor :database_id
4268
5605
 
4269
- # Optional. Intermediate Cloud Storage directory used for the import with a
4270
- # length limit of 2,000 characters. Can be specified if one wants to have the
4271
- # Firestore export to a specific Cloud Storage directory. Please ensure that the
4272
- # Firestore service account has the necessary GCS Storage Admin permissions to
4273
- # access the specified GCS directory.
5606
+ # Intermediate Cloud Storage directory used for the import with a length limit
5607
+ # of 2,000 characters. Can be specified if one wants to have the Firestore
5608
+ # export to a specific Cloud Storage directory. Ensure that the Firestore
5609
+ # service account has the necessary Cloud Storage Admin permissions to access
5610
+ # the specified Cloud Storage directory.
4274
5611
  # Corresponds to the JSON property `gcsStagingDir`
4275
5612
  # @return [String]
4276
5613
  attr_accessor :gcs_staging_dir
4277
5614
 
4278
- # Optional. The project ID (can be project # or ID) that the Cloud SQL source is
4279
- # in with a length limit of 128 characters. If not specified, inherits the
4280
- # project ID from the parent request.
5615
+ # The project ID that the Cloud SQL source is in with a length limit of 128
5616
+ # characters. If not specified, inherits the project ID from the parent request.
4281
5617
  # Corresponds to the JSON property `projectId`
4282
5618
  # @return [String]
4283
5619
  attr_accessor :project_id
@@ -4305,11 +5641,11 @@ module Google
4305
5641
  # PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID
4306
5642
  # set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`:
4307
5643
  # One custom data JSON per row in arbitrary format that conforms to the defined
4308
- # Schema of the data store. This can only be used by Gen App Builder. * `csv`: A
4309
- # CSV file with header conforming to the defined Schema of the data store. Each
4310
- # entry after the header is imported as a Document. This can only be used by Gen
4311
- # App Builder. Supported values for user even imports: * `user_event` (default):
4312
- # One JSON UserEvent per line.
5644
+ # Schema of the data store. This can only be used by the GENERIC Data Store
5645
+ # vertical. * `csv`: A CSV file with header conforming to the defined Schema of
5646
+ # the data store. Each entry after the header is imported as a Document. This
5647
+ # can only be used by the GENERIC Data Store vertical. Supported values for user
5648
+ # even imports: * `user_event` (default): One JSON UserEvent per line.
4313
5649
  # Corresponds to the JSON property `dataSchema`
4314
5650
  # @return [String]
4315
5651
  attr_accessor :data_schema
@@ -4335,15 +5671,21 @@ module Google
4335
5671
  end
4336
5672
  end
4337
5673
 
4338
- # Grounding configuration.
4339
- class GoogleCloudDiscoveryengineV1alphaGroundingConfig
5674
+ # Grounding Fact.
5675
+ class GoogleCloudDiscoveryengineV1alphaGroundingFact
4340
5676
  include Google::Apis::Core::Hashable
4341
5677
 
4342
- # Required. Name of the GroundingConfig, of the form `projects/`project`/
4343
- # locations/`location`/groundingConfig`.
4344
- # Corresponds to the JSON property `name`
5678
+ # Attributes associated with the fact. Common attributes include `source` (
5679
+ # indicating where the fact was sourced from), `author` (indicating the author
5680
+ # of the fact), and so on.
5681
+ # Corresponds to the JSON property `attributes`
5682
+ # @return [Hash<String,String>]
5683
+ attr_accessor :attributes
5684
+
5685
+ # Text content of the fact. Can be at most 10K characters long.
5686
+ # Corresponds to the JSON property `factText`
4345
5687
  # @return [String]
4346
- attr_accessor :name
5688
+ attr_accessor :fact_text
4347
5689
 
4348
5690
  def initialize(**args)
4349
5691
  update!(**args)
@@ -4351,7 +5693,8 @@ module Google
4351
5693
 
4352
5694
  # Update properties of this object
4353
5695
  def update!(**args)
4354
- @name = args[:name] if args.key?(:name)
5696
+ @attributes = args[:attributes] if args.key?(:attributes)
5697
+ @fact_text = args[:fact_text] if args.key?(:fact_text)
4355
5698
  end
4356
5699
  end
4357
5700
 
@@ -4434,66 +5777,6 @@ module Google
4434
5777
  end
4435
5778
  end
4436
5779
 
4437
- # Metadata related to the progress of the ImportCompletionSuggestions operation.
4438
- # This will be returned by the google.longrunning.Operation.metadata field.
4439
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata
4440
- include Google::Apis::Core::Hashable
4441
-
4442
- # Operation create time.
4443
- # Corresponds to the JSON property `createTime`
4444
- # @return [String]
4445
- attr_accessor :create_time
4446
-
4447
- # Operation last update time. If the operation is done, this is also the finish
4448
- # time.
4449
- # Corresponds to the JSON property `updateTime`
4450
- # @return [String]
4451
- attr_accessor :update_time
4452
-
4453
- def initialize(**args)
4454
- update!(**args)
4455
- end
4456
-
4457
- # Update properties of this object
4458
- def update!(**args)
4459
- @create_time = args[:create_time] if args.key?(:create_time)
4460
- @update_time = args[:update_time] if args.key?(:update_time)
4461
- end
4462
- end
4463
-
4464
- # Response of the CompletionService.ImportCompletionSuggestions method. If the
4465
- # long running operation is done, this message is returned by the google.
4466
- # longrunning.Operations.response field if the operation is successful.
4467
- class GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse
4468
- include Google::Apis::Core::Hashable
4469
-
4470
- # A sample of errors encountered while processing the request.
4471
- # Corresponds to the JSON property `errorSamples`
4472
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleRpcStatus>]
4473
- attr_accessor :error_samples
4474
-
4475
- # Count of CompletionSuggestions that failed to be imported.
4476
- # Corresponds to the JSON property `failureCount`
4477
- # @return [Fixnum]
4478
- attr_accessor :failure_count
4479
-
4480
- # Count of CompletionSuggestions successfully imported.
4481
- # Corresponds to the JSON property `successCount`
4482
- # @return [Fixnum]
4483
- attr_accessor :success_count
4484
-
4485
- def initialize(**args)
4486
- update!(**args)
4487
- end
4488
-
4489
- # Update properties of this object
4490
- def update!(**args)
4491
- @error_samples = args[:error_samples] if args.key?(:error_samples)
4492
- @failure_count = args[:failure_count] if args.key?(:failure_count)
4493
- @success_count = args[:success_count] if args.key?(:success_count)
4494
- end
4495
- end
4496
-
4497
5780
  # Metadata related to the progress of the ImportDocuments operation. This is
4498
5781
  # returned by the google.longrunning.Operation.metadata field.
4499
5782
  class GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata
@@ -4514,6 +5797,11 @@ module Google
4514
5797
  # @return [Fixnum]
4515
5798
  attr_accessor :success_count
4516
5799
 
5800
+ # Total count of entries that were processed.
5801
+ # Corresponds to the JSON property `totalCount`
5802
+ # @return [Fixnum]
5803
+ attr_accessor :total_count
5804
+
4517
5805
  # Operation last update time. If the operation is done, this is also the finish
4518
5806
  # time.
4519
5807
  # Corresponds to the JSON property `updateTime`
@@ -4529,6 +5817,7 @@ module Google
4529
5817
  @create_time = args[:create_time] if args.key?(:create_time)
4530
5818
  @failure_count = args[:failure_count] if args.key?(:failure_count)
4531
5819
  @success_count = args[:success_count] if args.key?(:success_count)
5820
+ @total_count = args[:total_count] if args.key?(:total_count)
4532
5821
  @update_time = args[:update_time] if args.key?(:update_time)
4533
5822
  end
4534
5823
  end
@@ -4546,7 +5835,7 @@ module Google
4546
5835
  # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
4547
5836
  # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
4548
5837
  # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
4549
- # SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource
5838
+ # SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
4550
5839
  # Corresponds to the JSON property `autoGenerateIds`
4551
5840
  # @return [Boolean]
4552
5841
  attr_accessor :auto_generate_ids
@@ -4557,7 +5846,7 @@ module Google
4557
5846
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigQuerySource]
4558
5847
  attr_accessor :bigquery_source
4559
5848
 
4560
- # The Cloud Bigtable source for importing data
5849
+ # The Cloud Bigtable source for importing data.
4561
5850
  # Corresponds to the JSON property `bigtableSource`
4562
5851
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaBigtableSource]
4563
5852
  attr_accessor :bigtable_source
@@ -4601,7 +5890,7 @@ module Google
4601
5890
  # GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an
4602
5891
  # INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema
4603
5892
  # must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. *
4604
- # SpannerSource * CloudSqlSource * FirestoreSource * BigtableSource
5893
+ # SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.
4605
5894
  # Corresponds to the JSON property `idField`
4606
5895
  # @return [String]
4607
5896
  attr_accessor :id_field
@@ -4622,6 +5911,12 @@ module Google
4622
5911
  # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSpannerSource]
4623
5912
  attr_accessor :spanner_source
4624
5913
 
5914
+ # Indicates which fields in the provided imported documents to update. If not
5915
+ # set, the default is to update all fields.
5916
+ # Corresponds to the JSON property `updateMask`
5917
+ # @return [String]
5918
+ attr_accessor :update_mask
5919
+
4625
5920
  def initialize(**args)
4626
5921
  update!(**args)
4627
5922
  end
@@ -4640,6 +5935,7 @@ module Google
4640
5935
  @inline_source = args[:inline_source] if args.key?(:inline_source)
4641
5936
  @reconciliation_mode = args[:reconciliation_mode] if args.key?(:reconciliation_mode)
4642
5937
  @spanner_source = args[:spanner_source] if args.key?(:spanner_source)
5938
+ @update_mask = args[:update_mask] if args.key?(:update_mask)
4643
5939
  end
4644
5940
  end
4645
5941
 
@@ -5135,12 +6431,37 @@ module Google
5135
6431
  # Update properties of this object
5136
6432
  def update!(**args)
5137
6433
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5138
- @schemas = args[:schemas] if args.key?(:schemas)
6434
+ @schemas = args[:schemas] if args.key?(:schemas)
6435
+ end
6436
+ end
6437
+
6438
+ # Response for ListServingConfigs method.
6439
+ class GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
6440
+ include Google::Apis::Core::Hashable
6441
+
6442
+ # Pagination token, if not returned indicates the last page.
6443
+ # Corresponds to the JSON property `nextPageToken`
6444
+ # @return [String]
6445
+ attr_accessor :next_page_token
6446
+
6447
+ # All the ServingConfigs for a given dataStore.
6448
+ # Corresponds to the JSON property `servingConfigs`
6449
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig>]
6450
+ attr_accessor :serving_configs
6451
+
6452
+ def initialize(**args)
6453
+ update!(**args)
6454
+ end
6455
+
6456
+ # Update properties of this object
6457
+ def update!(**args)
6458
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
6459
+ @serving_configs = args[:serving_configs] if args.key?(:serving_configs)
5139
6460
  end
5140
6461
  end
5141
6462
 
5142
- # Response for ListServingConfigs method.
5143
- class GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse
6463
+ # Response for ListSessions method.
6464
+ class GoogleCloudDiscoveryengineV1alphaListSessionsResponse
5144
6465
  include Google::Apis::Core::Hashable
5145
6466
 
5146
6467
  # Pagination token, if not returned indicates the last page.
@@ -5148,10 +6469,10 @@ module Google
5148
6469
  # @return [String]
5149
6470
  attr_accessor :next_page_token
5150
6471
 
5151
- # All the ServingConfigs for a given dataStore.
5152
- # Corresponds to the JSON property `servingConfigs`
5153
- # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaServingConfig>]
5154
- attr_accessor :serving_configs
6472
+ # All the Sessions for a given data store.
6473
+ # Corresponds to the JSON property `sessions`
6474
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSession>]
6475
+ attr_accessor :sessions
5155
6476
 
5156
6477
  def initialize(**args)
5157
6478
  update!(**args)
@@ -5160,7 +6481,7 @@ module Google
5160
6481
  # Update properties of this object
5161
6482
  def update!(**args)
5162
6483
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
5163
- @serving_configs = args[:serving_configs] if args.key?(:serving_configs)
6484
+ @sessions = args[:sessions] if args.key?(:sessions)
5164
6485
  end
5165
6486
  end
5166
6487
 
@@ -5271,12 +6592,12 @@ module Google
5271
6592
 
5272
6593
  # The most specific category associated with a category page. To represent full
5273
6594
  # path of category, use '>' sign to separate different hierarchies. If '>' is
5274
- # part of the category name, please replace it with other character(s). Category
5275
- # pages include special pages such as sales or promotions. For instance, a
5276
- # special sale page may have the category hierarchy: `"pageCategory" : "Sales >
5277
- # 2017 Black Friday Deals"`. Required for `view-category-page` events. Other
5278
- # event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error
5279
- # is returned.
6595
+ # part of the category name, replace it with other character(s). Category pages
6596
+ # include special pages such as sales or promotions. For instance, a special
6597
+ # sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017
6598
+ # Black Friday Deals"`. Required for `view-category-page` events. Other event
6599
+ # types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is
6600
+ # returned.
5280
6601
  # Corresponds to the JSON property `pageCategory`
5281
6602
  # @return [String]
5282
6603
  attr_accessor :page_category
@@ -5430,6 +6751,138 @@ module Google
5430
6751
  end
5431
6752
  end
5432
6753
 
6754
+ # Metadata and configurations for a Google Cloud project in the service.
6755
+ class GoogleCloudDiscoveryengineV1alphaProject
6756
+ include Google::Apis::Core::Hashable
6757
+
6758
+ # Output only. The timestamp when this project is created.
6759
+ # Corresponds to the JSON property `createTime`
6760
+ # @return [String]
6761
+ attr_accessor :create_time
6762
+
6763
+ # Output only. Full resource name of the project, for example `projects/`
6764
+ # project_number``. Note that when making requests, project number and project
6765
+ # id are both acceptable, but the server will always respond in project number.
6766
+ # Corresponds to the JSON property `name`
6767
+ # @return [String]
6768
+ attr_accessor :name
6769
+
6770
+ # Output only. The timestamp when this project is successfully provisioned.
6771
+ # Empty value means this project is still provisioning and is not ready for use.
6772
+ # Corresponds to the JSON property `provisionCompletionTime`
6773
+ # @return [String]
6774
+ attr_accessor :provision_completion_time
6775
+
6776
+ # Output only. A map of terms of services. The key is the `id` of ServiceTerms.
6777
+ # Corresponds to the JSON property `serviceTermsMap`
6778
+ # @return [Hash<String,Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProjectServiceTerms>]
6779
+ attr_accessor :service_terms_map
6780
+
6781
+ def initialize(**args)
6782
+ update!(**args)
6783
+ end
6784
+
6785
+ # Update properties of this object
6786
+ def update!(**args)
6787
+ @create_time = args[:create_time] if args.key?(:create_time)
6788
+ @name = args[:name] if args.key?(:name)
6789
+ @provision_completion_time = args[:provision_completion_time] if args.key?(:provision_completion_time)
6790
+ @service_terms_map = args[:service_terms_map] if args.key?(:service_terms_map)
6791
+ end
6792
+ end
6793
+
6794
+ # Metadata about the terms of service.
6795
+ class GoogleCloudDiscoveryengineV1alphaProjectServiceTerms
6796
+ include Google::Apis::Core::Hashable
6797
+
6798
+ # The last time when the project agreed to the terms of service.
6799
+ # Corresponds to the JSON property `acceptTime`
6800
+ # @return [String]
6801
+ attr_accessor :accept_time
6802
+
6803
+ # The last time when the project declined or revoked the agreement to terms of
6804
+ # service.
6805
+ # Corresponds to the JSON property `declineTime`
6806
+ # @return [String]
6807
+ attr_accessor :decline_time
6808
+
6809
+ # The unique identifier of this terms of service. Available terms: * `
6810
+ # GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-
6811
+ # use-terms). When using this as `id`, the acceptable version to provide is `
6812
+ # 2022-11-23`.
6813
+ # Corresponds to the JSON property `id`
6814
+ # @return [String]
6815
+ attr_accessor :id
6816
+
6817
+ # Whether the project has accepted/rejected the service terms or it is still
6818
+ # pending.
6819
+ # Corresponds to the JSON property `state`
6820
+ # @return [String]
6821
+ attr_accessor :state
6822
+
6823
+ # The version string of the terms of service. For acceptable values, see the
6824
+ # comments for id above.
6825
+ # Corresponds to the JSON property `version`
6826
+ # @return [String]
6827
+ attr_accessor :version
6828
+
6829
+ def initialize(**args)
6830
+ update!(**args)
6831
+ end
6832
+
6833
+ # Update properties of this object
6834
+ def update!(**args)
6835
+ @accept_time = args[:accept_time] if args.key?(:accept_time)
6836
+ @decline_time = args[:decline_time] if args.key?(:decline_time)
6837
+ @id = args[:id] if args.key?(:id)
6838
+ @state = args[:state] if args.key?(:state)
6839
+ @version = args[:version] if args.key?(:version)
6840
+ end
6841
+ end
6842
+
6843
+ # Metadata associated with a project provision operation.
6844
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata
6845
+ include Google::Apis::Core::Hashable
6846
+
6847
+ def initialize(**args)
6848
+ update!(**args)
6849
+ end
6850
+
6851
+ # Update properties of this object
6852
+ def update!(**args)
6853
+ end
6854
+ end
6855
+
6856
+ # Request for ProjectService.ProvisionProject method.
6857
+ class GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest
6858
+ include Google::Apis::Core::Hashable
6859
+
6860
+ # Required. Set to `true` to specify that caller has read and would like to give
6861
+ # consent to the [Terms for data use](https://cloud.google.com/retail/data-use-
6862
+ # terms).
6863
+ # Corresponds to the JSON property `acceptDataUseTerms`
6864
+ # @return [Boolean]
6865
+ attr_accessor :accept_data_use_terms
6866
+ alias_method :accept_data_use_terms?, :accept_data_use_terms
6867
+
6868
+ # Required. The version of the [Terms for data use](https://cloud.google.com/
6869
+ # retail/data-use-terms) that caller has read and would like to give consent to.
6870
+ # Acceptable version is `2022-11-23`, and this may change over time.
6871
+ # Corresponds to the JSON property `dataUseTermsVersion`
6872
+ # @return [String]
6873
+ attr_accessor :data_use_terms_version
6874
+
6875
+ def initialize(**args)
6876
+ update!(**args)
6877
+ end
6878
+
6879
+ # Update properties of this object
6880
+ def update!(**args)
6881
+ @accept_data_use_terms = args[:accept_data_use_terms] if args.key?(:accept_data_use_terms)
6882
+ @data_use_terms_version = args[:data_use_terms_version] if args.key?(:data_use_terms_version)
6883
+ end
6884
+ end
6885
+
5433
6886
  # Metadata related to the progress of the PurgeDocuments operation. This will be
5434
6887
  # returned by the google.longrunning.Operation.metadata field.
5435
6888
  class GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata
@@ -5730,6 +7183,31 @@ module Google
5730
7183
  end
5731
7184
  end
5732
7185
 
7186
+ # Defines a user inputed query.
7187
+ class GoogleCloudDiscoveryengineV1alphaQuery
7188
+ include Google::Apis::Core::Hashable
7189
+
7190
+ # Unique Id for the query.
7191
+ # Corresponds to the JSON property `queryId`
7192
+ # @return [String]
7193
+ attr_accessor :query_id
7194
+
7195
+ # Plain text.
7196
+ # Corresponds to the JSON property `text`
7197
+ # @return [String]
7198
+ attr_accessor :text
7199
+
7200
+ def initialize(**args)
7201
+ update!(**args)
7202
+ end
7203
+
7204
+ # Update properties of this object
7205
+ def update!(**args)
7206
+ @query_id = args[:query_id] if args.key?(:query_id)
7207
+ @text = args[:text] if args.key?(:text)
7208
+ end
7209
+ end
7210
+
5733
7211
  # Request message for RankService.Rank method.
5734
7212
  class GoogleCloudDiscoveryengineV1alphaRankRequest
5735
7213
  include Google::Apis::Core::Hashable
@@ -5753,7 +7231,7 @@ module Google
5753
7231
  # @return [String]
5754
7232
  attr_accessor :query
5755
7233
 
5756
- # Required. A list of records to rank.
7234
+ # Required. A list of records to rank. At most 200 records to rank.
5757
7235
  # Corresponds to the JSON property `records`
5758
7236
  # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankingRecord>]
5759
7237
  attr_accessor :records
@@ -6233,6 +7711,41 @@ module Google
6233
7711
  end
6234
7712
  end
6235
7713
 
7714
+ # Request for ReportConsentChange method.
7715
+ class GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest
7716
+ include Google::Apis::Core::Hashable
7717
+
7718
+ # Required. Whether customer decides to accept or decline service term. At this
7719
+ # moment, only accept action is supported.
7720
+ # Corresponds to the JSON property `consentChangeAction`
7721
+ # @return [String]
7722
+ attr_accessor :consent_change_action
7723
+
7724
+ # Required. The unique identifier of the terms of service to update. Available
7725
+ # term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/
7726
+ # retail/data-use-terms). When using this service term id, the acceptable
7727
+ # service_term_version to provide is `2022-11-23`.
7728
+ # Corresponds to the JSON property `serviceTermId`
7729
+ # @return [String]
7730
+ attr_accessor :service_term_id
7731
+
7732
+ # Required. The version string of the terms of service to update.
7733
+ # Corresponds to the JSON property `serviceTermVersion`
7734
+ # @return [String]
7735
+ attr_accessor :service_term_version
7736
+
7737
+ def initialize(**args)
7738
+ update!(**args)
7739
+ end
7740
+
7741
+ # Update properties of this object
7742
+ def update!(**args)
7743
+ @consent_change_action = args[:consent_change_action] if args.key?(:consent_change_action)
7744
+ @service_term_id = args[:service_term_id] if args.key?(:service_term_id)
7745
+ @service_term_version = args[:service_term_version] if args.key?(:service_term_version)
7746
+ end
7747
+ end
7748
+
6236
7749
  # Request for resuming training of an engine.
6237
7750
  class GoogleCloudDiscoveryengineV1alphaResumeEngineRequest
6238
7751
  include Google::Apis::Core::Hashable
@@ -6425,9 +7938,11 @@ module Google
6425
7938
  # @return [String]
6426
7939
  attr_accessor :order_by
6427
7940
 
6428
- # Maximum number of Documents to return. If unspecified, defaults to a
6429
- # reasonable value. The maximum allowed value is 100. Values above 100 are
6430
- # coerced to 100. If this field is negative, an `INVALID_ARGUMENT` is returned.
7941
+ # Maximum number of Documents to return. The maximum allowed value depends on
7942
+ # the data type. Values above the maximum value are coerced to the maximum value.
7943
+ # * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with
7944
+ # advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `
7945
+ # 100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
6431
7946
  # Corresponds to the JSON property `pageSize`
6432
7947
  # @return [Fixnum]
6433
7948
  attr_accessor :page_size
@@ -6606,6 +8121,13 @@ module Google
6606
8121
  # @return [Float]
6607
8122
  attr_accessor :boost
6608
8123
 
8124
+ # Specification for custom ranking based on customer specified attribute value.
8125
+ # It provides more controls for customized ranking than the simple (condition,
8126
+ # boost) combination above.
8127
+ # Corresponds to the JSON property `boostControlSpec`
8128
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec]
8129
+ attr_accessor :boost_control_spec
8130
+
6609
8131
  # An expression which specifies a boost condition. The syntax and supported
6610
8132
  # fields are the same as a filter expression. See SearchRequest.filter for
6611
8133
  # detail syntax and limitations. Examples: * To boost documents with document ID
@@ -6622,10 +8144,88 @@ module Google
6622
8144
  # Update properties of this object
6623
8145
  def update!(**args)
6624
8146
  @boost = args[:boost] if args.key?(:boost)
8147
+ @boost_control_spec = args[:boost_control_spec] if args.key?(:boost_control_spec)
6625
8148
  @condition = args[:condition] if args.key?(:condition)
6626
8149
  end
6627
8150
  end
6628
8151
 
8152
+ # Specification for custom ranking based on customer specified attribute value.
8153
+ # It provides more controls for customized ranking than the simple (condition,
8154
+ # boost) combination above.
8155
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec
8156
+ include Google::Apis::Core::Hashable
8157
+
8158
+ # The attribute type to be used to determine the boost amount. The attribute
8159
+ # value can be derived from the field value of the specified field_name. In the
8160
+ # case of numerical it is straightforward i.e. attribute_value =
8161
+ # numerical_field_value. In the case of freshness however, attribute_value = (
8162
+ # time.now() - datetime_field_value).
8163
+ # Corresponds to the JSON property `attributeType`
8164
+ # @return [String]
8165
+ attr_accessor :attribute_type
8166
+
8167
+ # The control points used to define the curve. The monotonic function (defined
8168
+ # through the interpolation_type above) passes through the control points listed
8169
+ # here.
8170
+ # Corresponds to the JSON property `controlPoints`
8171
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint>]
8172
+ attr_accessor :control_points
8173
+
8174
+ # The name of the field whose value will be used to determine the boost amount.
8175
+ # Corresponds to the JSON property `fieldName`
8176
+ # @return [String]
8177
+ attr_accessor :field_name
8178
+
8179
+ # The interpolation type to be applied to connect the control points listed
8180
+ # below.
8181
+ # Corresponds to the JSON property `interpolationType`
8182
+ # @return [String]
8183
+ attr_accessor :interpolation_type
8184
+
8185
+ def initialize(**args)
8186
+ update!(**args)
8187
+ end
8188
+
8189
+ # Update properties of this object
8190
+ def update!(**args)
8191
+ @attribute_type = args[:attribute_type] if args.key?(:attribute_type)
8192
+ @control_points = args[:control_points] if args.key?(:control_points)
8193
+ @field_name = args[:field_name] if args.key?(:field_name)
8194
+ @interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
8195
+ end
8196
+ end
8197
+
8198
+ # The control points used to define the curve. The curve defined through these
8199
+ # control points can only be monotonically increasing or decreasing(constant
8200
+ # values are acceptable).
8201
+ class GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint
8202
+ include Google::Apis::Core::Hashable
8203
+
8204
+ # Can be one of: 1. The numerical field value. 2. The duration spec for
8205
+ # freshness: The value must be formatted as an XSD `dayTimeDuration` value (a
8206
+ # restricted subset of an ISO 8601 duration value). The pattern for this is: `
8207
+ # nDnM]`.
8208
+ # Corresponds to the JSON property `attributeValue`
8209
+ # @return [String]
8210
+ attr_accessor :attribute_value
8211
+
8212
+ # The value between -1 to 1 by which to boost the score if the attribute_value
8213
+ # evaluates to the value specified above.
8214
+ # Corresponds to the JSON property `boostAmount`
8215
+ # @return [Float]
8216
+ attr_accessor :boost_amount
8217
+
8218
+ def initialize(**args)
8219
+ update!(**args)
8220
+ end
8221
+
8222
+ # Update properties of this object
8223
+ def update!(**args)
8224
+ @attribute_value = args[:attribute_value] if args.key?(:attribute_value)
8225
+ @boost_amount = args[:boost_amount] if args.key?(:boost_amount)
8226
+ end
8227
+ end
8228
+
6629
8229
  # A specification for configuring the behavior of content search.
6630
8230
  class GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec
6631
8231
  include Google::Apis::Core::Hashable
@@ -6744,8 +8344,8 @@ module Google
6744
8344
 
6745
8345
  # Specifies whether to return the confidence score from the extractive segments
6746
8346
  # in each search result. This feature is available only for new or allowlisted
6747
- # data stores. To allowlist your data store, please contact your Customer
6748
- # Engineer. The default value is `false`.
8347
+ # data stores. To allowlist your data store, contact your Customer Engineer. The
8348
+ # default value is `false`.
6749
8349
  # Corresponds to the JSON property `returnExtractiveSegmentScore`
6750
8350
  # @return [Boolean]
6751
8351
  attr_accessor :return_extractive_segment_score
@@ -6864,13 +8464,15 @@ module Google
6864
8464
 
6865
8465
  # The number of top results to generate the summary from. If the number of
6866
8466
  # results returned is less than `summaryResultCount`, the summary is generated
6867
- # from all of the results. At most 10 results can be used to generate a summary.
8467
+ # from all of the results. At most 10 results for documents mode, or 50 for
8468
+ # chunks mode, can be used to generate a summary. The chunks mode is used when
8469
+ # SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
6868
8470
  # Corresponds to the JSON property `summaryResultCount`
6869
8471
  # @return [Fixnum]
6870
8472
  attr_accessor :summary_result_count
6871
8473
 
6872
8474
  # If true, answer will be generated from most relevant chunks from top search
6873
- # results. This feature will improve summary quality. Please note that with this
8475
+ # results. This feature will improve summary quality. Note that with this
6874
8476
  # feature enabled, not all top search results will be referenced and included in
6875
8477
  # the reference list, so the citation source index only points to the search
6876
8478
  # results listed in the reference list.
@@ -8024,6 +9626,81 @@ module Google
8024
9626
  end
8025
9627
  end
8026
9628
 
9629
+ # External session proto definition.
9630
+ class GoogleCloudDiscoveryengineV1alphaSession
9631
+ include Google::Apis::Core::Hashable
9632
+
9633
+ # Output only. The time the session finished.
9634
+ # Corresponds to the JSON property `endTime`
9635
+ # @return [String]
9636
+ attr_accessor :end_time
9637
+
9638
+ # Immutable. Fully qualified name `projects/`project`/locations/global/
9639
+ # collections/`collection`/engines/`engine`/sessions/*`
9640
+ # Corresponds to the JSON property `name`
9641
+ # @return [String]
9642
+ attr_accessor :name
9643
+
9644
+ # Output only. The time the session started.
9645
+ # Corresponds to the JSON property `startTime`
9646
+ # @return [String]
9647
+ attr_accessor :start_time
9648
+
9649
+ # The state of the session.
9650
+ # Corresponds to the JSON property `state`
9651
+ # @return [String]
9652
+ attr_accessor :state
9653
+
9654
+ # Turns.
9655
+ # Corresponds to the JSON property `turns`
9656
+ # @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSessionTurn>]
9657
+ attr_accessor :turns
9658
+
9659
+ # A unique identifier for tracking users.
9660
+ # Corresponds to the JSON property `userPseudoId`
9661
+ # @return [String]
9662
+ attr_accessor :user_pseudo_id
9663
+
9664
+ def initialize(**args)
9665
+ update!(**args)
9666
+ end
9667
+
9668
+ # Update properties of this object
9669
+ def update!(**args)
9670
+ @end_time = args[:end_time] if args.key?(:end_time)
9671
+ @name = args[:name] if args.key?(:name)
9672
+ @start_time = args[:start_time] if args.key?(:start_time)
9673
+ @state = args[:state] if args.key?(:state)
9674
+ @turns = args[:turns] if args.key?(:turns)
9675
+ @user_pseudo_id = args[:user_pseudo_id] if args.key?(:user_pseudo_id)
9676
+ end
9677
+ end
9678
+
9679
+ # Represents a turn, including a query from the user and a answer from service.
9680
+ class GoogleCloudDiscoveryengineV1alphaSessionTurn
9681
+ include Google::Apis::Core::Hashable
9682
+
9683
+ # The resource name of the answer to the user query.
9684
+ # Corresponds to the JSON property `answer`
9685
+ # @return [String]
9686
+ attr_accessor :answer
9687
+
9688
+ # Defines a user inputed query.
9689
+ # Corresponds to the JSON property `query`
9690
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaQuery]
9691
+ attr_accessor :query
9692
+
9693
+ def initialize(**args)
9694
+ update!(**args)
9695
+ end
9696
+
9697
+ # Update properties of this object
9698
+ def update!(**args)
9699
+ @answer = args[:answer] if args.key?(:answer)
9700
+ @query = args[:query] if args.key?(:query)
9701
+ end
9702
+ end
9703
+
8027
9704
  # SiteSearchEngine captures DataStore level site search persisting
8028
9705
  # configurations. It is a singleton value per data store.
8029
9706
  class GoogleCloudDiscoveryengineV1alphaSiteSearchEngine
@@ -8079,9 +9756,9 @@ module Google
8079
9756
  # @return [String]
8080
9757
  attr_accessor :database_id
8081
9758
 
8082
- # Optional. Whether to apply data boost on Spanner export. Enabling this option
8083
- # will incur additional cost. More info: https://cloud.google.com/spanner/docs/
8084
- # databoost/databoost-overview#billing_and_quotas
9759
+ # Whether to apply data boost on Spanner export. Enabling this option will incur
9760
+ # additional cost. More info can be found [here](https://cloud.google.com/
9761
+ # spanner/docs/databoost/databoost-overview#billing_and_quotas).
8085
9762
  # Corresponds to the JSON property `enableDataBoost`
8086
9763
  # @return [Boolean]
8087
9764
  attr_accessor :enable_data_boost
@@ -8417,8 +10094,10 @@ module Google
8417
10094
 
8418
10095
  # The trained model status. Possible values are: * **bad-data**: The training
8419
10096
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
8420
- # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
8421
- # The model is ready for serving.
10097
+ # Won't deploy. * **in-progress**: Model training job creation is in progress. *
10098
+ # **training**: Model is actively training. * **evaluating**: The model is
10099
+ # evaluating trained metrics. * **indexing**: The model trained metrics are
10100
+ # indexing. * **ready**: The model is ready for serving.
8422
10101
  # Corresponds to the JSON property `modelStatus`
8423
10102
  # @return [String]
8424
10103
  attr_accessor :model_status
@@ -9891,8 +11570,8 @@ module Google
9891
11570
  class GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig
9892
11571
  include Google::Apis::Core::Hashable
9893
11572
 
9894
- # Apply additional enhanced OCR processing to a list of document elements.
9895
- # Supported values: * `table`: advanced table parsing model.
11573
+ # [DEPRECATED] This field is deprecated. To use the additional enhanced document
11574
+ # elements processing, please switch to `layout_parsing_config`.
9896
11575
  # Corresponds to the JSON property `enhancedDocumentElements`
9897
11576
  # @return [Array<String>]
9898
11577
  attr_accessor :enhanced_document_elements
@@ -10067,8 +11746,8 @@ module Google
10067
11746
  # projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are
10068
11747
  # one-time consumed by and passed to Dialogflow service. It means they cannot be
10069
11748
  # retrieved using EngineService.GetEngine or EngineService.ListEngines API after
10070
- # engine creation. Please use ChatEngineMetadata.dialogflow_agent for actual
10071
- # agent association after Engine is created.
11749
+ # engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent
11750
+ # association after Engine is created.
10072
11751
  # Corresponds to the JSON property `dialogflowAgentToLink`
10073
11752
  # @return [String]
10074
11753
  attr_accessor :dialogflow_agent_to_link
@@ -10181,7 +11860,7 @@ module Google
10181
11860
  attr_accessor :search_add_ons
10182
11861
 
10183
11862
  # The search feature tier of this engine. Different tiers might have different
10184
- # pricing. To learn more, please check the pricing documentation. Defaults to
11863
+ # pricing. To learn more, check the pricing documentation. Defaults to
10185
11864
  # SearchTier.SEARCH_TIER_STANDARD if not specified.
10186
11865
  # Corresponds to the JSON property `searchTier`
10187
11866
  # @return [String]
@@ -10198,26 +11877,6 @@ module Google
10198
11877
  end
10199
11878
  end
10200
11879
 
10201
- # Grounding configuration.
10202
- class GoogleCloudDiscoveryengineV1betaGroundingConfig
10203
- include Google::Apis::Core::Hashable
10204
-
10205
- # Required. Name of the GroundingConfig, of the form `projects/`project`/
10206
- # locations/`location`/groundingConfig`.
10207
- # Corresponds to the JSON property `name`
10208
- # @return [String]
10209
- attr_accessor :name
10210
-
10211
- def initialize(**args)
10212
- update!(**args)
10213
- end
10214
-
10215
- # Update properties of this object
10216
- def update!(**args)
10217
- @name = args[:name] if args.key?(:name)
10218
- end
10219
- end
10220
-
10221
11880
  # Metadata related to the progress of the ImportDocuments operation. This is
10222
11881
  # returned by the google.longrunning.Operation.metadata field.
10223
11882
  class GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata
@@ -10238,6 +11897,11 @@ module Google
10238
11897
  # @return [Fixnum]
10239
11898
  attr_accessor :success_count
10240
11899
 
11900
+ # Total count of entries that were processed.
11901
+ # Corresponds to the JSON property `totalCount`
11902
+ # @return [Fixnum]
11903
+ attr_accessor :total_count
11904
+
10241
11905
  # Operation last update time. If the operation is done, this is also the finish
10242
11906
  # time.
10243
11907
  # Corresponds to the JSON property `updateTime`
@@ -10253,6 +11917,7 @@ module Google
10253
11917
  @create_time = args[:create_time] if args.key?(:create_time)
10254
11918
  @failure_count = args[:failure_count] if args.key?(:failure_count)
10255
11919
  @success_count = args[:success_count] if args.key?(:success_count)
11920
+ @total_count = args[:total_count] if args.key?(:total_count)
10256
11921
  @update_time = args[:update_time] if args.key?(:update_time)
10257
11922
  end
10258
11923
  end
@@ -10793,8 +12458,10 @@ module Google
10793
12458
 
10794
12459
  # The trained model status. Possible values are: * **bad-data**: The training
10795
12460
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
10796
- # Won't deploy. * **in-progress**: Model training is in progress. * **ready**:
10797
- # The model is ready for serving.
12461
+ # Won't deploy. * **in-progress**: Model training job creation is in progress. *
12462
+ # **training**: Model is actively training. * **evaluating**: The model is
12463
+ # evaluating trained metrics. * **indexing**: The model trained metrics are
12464
+ # indexing. * **ready**: The model is ready for serving.
10798
12465
  # Corresponds to the JSON property `modelStatus`
10799
12466
  # @return [String]
10800
12467
  attr_accessor :model_status
@@ -10833,6 +12500,19 @@ module Google
10833
12500
  end
10834
12501
  end
10835
12502
 
12503
+ # Response associated with a tune operation.
12504
+ class GoogleCloudDiscoveryengineV1betaTuneEngineResponse
12505
+ include Google::Apis::Core::Hashable
12506
+
12507
+ def initialize(**args)
12508
+ update!(**args)
12509
+ end
12510
+
12511
+ # Update properties of this object
12512
+ def update!(**args)
12513
+ end
12514
+ end
12515
+
10836
12516
  # Metadata for UpdateSchema LRO.
10837
12517
  class GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata
10838
12518
  include Google::Apis::Core::Hashable