google-apis-discoveryengine_v1beta 0.41.0 → 0.42.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +3453 -1296
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +1698 -642
- data/lib/google/apis/discoveryengine_v1beta/service.rb +838 -27
- metadata +3 -3
@@ -1434,6 +1434,44 @@ module Google
|
|
1434
1434
|
execute_or_queue_command(command, &block)
|
1435
1435
|
end
|
1436
1436
|
|
1437
|
+
# Answer query method.
|
1438
|
+
# @param [String] serving_config
|
1439
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
1440
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
1441
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
1442
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
1443
|
+
# field is used to identify the serving configuration name, set of models used
|
1444
|
+
# to make the search.
|
1445
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest] google_cloud_discoveryengine_v1beta_answer_query_request_object
|
1446
|
+
# @param [String] fields
|
1447
|
+
# Selector specifying which fields to include in a partial response.
|
1448
|
+
# @param [String] quota_user
|
1449
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1450
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1451
|
+
# @param [Google::Apis::RequestOptions] options
|
1452
|
+
# Request-specific options
|
1453
|
+
#
|
1454
|
+
# @yield [result, err] Result & error if block supplied
|
1455
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse] parsed result object
|
1456
|
+
# @yieldparam err [StandardError] error object if request failed
|
1457
|
+
#
|
1458
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse]
|
1459
|
+
#
|
1460
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1461
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1462
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1463
|
+
def answer_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1beta_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1464
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:answer', options)
|
1465
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest::Representation
|
1466
|
+
command.request_object = google_cloud_discoveryengine_v1beta_answer_query_request_object
|
1467
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse::Representation
|
1468
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse
|
1469
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1470
|
+
command.query['fields'] = fields unless fields.nil?
|
1471
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1472
|
+
execute_or_queue_command(command, &block)
|
1473
|
+
end
|
1474
|
+
|
1437
1475
|
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
1438
1476
|
# exist.
|
1439
1477
|
# @param [String] name
|
@@ -1625,6 +1663,227 @@ module Google
|
|
1625
1663
|
execute_or_queue_command(command, &block)
|
1626
1664
|
end
|
1627
1665
|
|
1666
|
+
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
1667
|
+
# error is returned.
|
1668
|
+
# @param [String] parent
|
1669
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
1670
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
1671
|
+
# data_store_id``
|
1672
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
|
1673
|
+
# @param [String] fields
|
1674
|
+
# Selector specifying which fields to include in a partial response.
|
1675
|
+
# @param [String] quota_user
|
1676
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1677
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1678
|
+
# @param [Google::Apis::RequestOptions] options
|
1679
|
+
# Request-specific options
|
1680
|
+
#
|
1681
|
+
# @yield [result, err] Result & error if block supplied
|
1682
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
1683
|
+
# @yieldparam err [StandardError] error object if request failed
|
1684
|
+
#
|
1685
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
1686
|
+
#
|
1687
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1688
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1689
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1690
|
+
def create_project_location_collection_data_store_session(parent, google_cloud_discoveryengine_v1beta_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1691
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/sessions', options)
|
1692
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
1693
|
+
command.request_object = google_cloud_discoveryengine_v1beta_session_object
|
1694
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
1695
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
1696
|
+
command.params['parent'] = parent unless parent.nil?
|
1697
|
+
command.query['fields'] = fields unless fields.nil?
|
1698
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1699
|
+
execute_or_queue_command(command, &block)
|
1700
|
+
end
|
1701
|
+
|
1702
|
+
# Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
|
1703
|
+
# is returned.
|
1704
|
+
# @param [String] name
|
1705
|
+
# Required. The resource name of the Session to delete. Format: `projects/`
|
1706
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
1707
|
+
# data_store_id`/sessions/`session_id``
|
1708
|
+
# @param [String] fields
|
1709
|
+
# Selector specifying which fields to include in a partial response.
|
1710
|
+
# @param [String] quota_user
|
1711
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1712
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1713
|
+
# @param [Google::Apis::RequestOptions] options
|
1714
|
+
# Request-specific options
|
1715
|
+
#
|
1716
|
+
# @yield [result, err] Result & error if block supplied
|
1717
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
1718
|
+
# @yieldparam err [StandardError] error object if request failed
|
1719
|
+
#
|
1720
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
1721
|
+
#
|
1722
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1723
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1724
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1725
|
+
def delete_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
1726
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
1727
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
1728
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
1729
|
+
command.params['name'] = name unless name.nil?
|
1730
|
+
command.query['fields'] = fields unless fields.nil?
|
1731
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1732
|
+
execute_or_queue_command(command, &block)
|
1733
|
+
end
|
1734
|
+
|
1735
|
+
# Gets a Session.
|
1736
|
+
# @param [String] name
|
1737
|
+
# Required. The resource name of the Session to get. Format: `projects/`
|
1738
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
1739
|
+
# data_store_id`/sessions/`session_id``
|
1740
|
+
# @param [String] fields
|
1741
|
+
# Selector specifying which fields to include in a partial response.
|
1742
|
+
# @param [String] quota_user
|
1743
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1744
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1745
|
+
# @param [Google::Apis::RequestOptions] options
|
1746
|
+
# Request-specific options
|
1747
|
+
#
|
1748
|
+
# @yield [result, err] Result & error if block supplied
|
1749
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
1750
|
+
# @yieldparam err [StandardError] error object if request failed
|
1751
|
+
#
|
1752
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
1753
|
+
#
|
1754
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1755
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1756
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1757
|
+
def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
1758
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
1759
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
1760
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
1761
|
+
command.params['name'] = name unless name.nil?
|
1762
|
+
command.query['fields'] = fields unless fields.nil?
|
1763
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1764
|
+
execute_or_queue_command(command, &block)
|
1765
|
+
end
|
1766
|
+
|
1767
|
+
# Lists all Sessions by their parent DataStore.
|
1768
|
+
# @param [String] parent
|
1769
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
1770
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
1771
|
+
# @param [String] filter
|
1772
|
+
# A filter to apply on the list results. The supported features are:
|
1773
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
1774
|
+
# @param [String] order_by
|
1775
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
1776
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
1777
|
+
# create_time` * `session_name` Example: "update_time desc" "create_time"
|
1778
|
+
# @param [Fixnum] page_size
|
1779
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
1780
|
+
# allowed value is 1000.
|
1781
|
+
# @param [String] page_token
|
1782
|
+
# A page token, received from a previous `ListSessions` call. Provide this to
|
1783
|
+
# retrieve the subsequent page.
|
1784
|
+
# @param [String] fields
|
1785
|
+
# Selector specifying which fields to include in a partial response.
|
1786
|
+
# @param [String] quota_user
|
1787
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1788
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1789
|
+
# @param [Google::Apis::RequestOptions] options
|
1790
|
+
# Request-specific options
|
1791
|
+
#
|
1792
|
+
# @yield [result, err] Result & error if block supplied
|
1793
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse] parsed result object
|
1794
|
+
# @yieldparam err [StandardError] error object if request failed
|
1795
|
+
#
|
1796
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse]
|
1797
|
+
#
|
1798
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1799
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1800
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1801
|
+
def list_project_location_collection_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1802
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/sessions', options)
|
1803
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse::Representation
|
1804
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse
|
1805
|
+
command.params['parent'] = parent unless parent.nil?
|
1806
|
+
command.query['filter'] = filter unless filter.nil?
|
1807
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1808
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1809
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1810
|
+
command.query['fields'] = fields unless fields.nil?
|
1811
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1812
|
+
execute_or_queue_command(command, &block)
|
1813
|
+
end
|
1814
|
+
|
1815
|
+
# Updates a Session. Session action type cannot be changed. If the Session to
|
1816
|
+
# update does not exist, a NOT_FOUND error is returned.
|
1817
|
+
# @param [String] name
|
1818
|
+
# Immutable. Fully qualified name `project/*/locations/global/collections/`
|
1819
|
+
# collection`/engines/`engine`/sessions/*`
|
1820
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
|
1821
|
+
# @param [String] update_mask
|
1822
|
+
# Indicates which fields in the provided Session to update. The following are
|
1823
|
+
# NOT supported: * Session.name If not set or empty, all supported fields are
|
1824
|
+
# updated.
|
1825
|
+
# @param [String] fields
|
1826
|
+
# Selector specifying which fields to include in a partial response.
|
1827
|
+
# @param [String] quota_user
|
1828
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1829
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1830
|
+
# @param [Google::Apis::RequestOptions] options
|
1831
|
+
# Request-specific options
|
1832
|
+
#
|
1833
|
+
# @yield [result, err] Result & error if block supplied
|
1834
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
1835
|
+
# @yieldparam err [StandardError] error object if request failed
|
1836
|
+
#
|
1837
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
1838
|
+
#
|
1839
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1840
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1841
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1842
|
+
def patch_project_location_collection_data_store_session(name, google_cloud_discoveryengine_v1beta_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1843
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
1844
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
1845
|
+
command.request_object = google_cloud_discoveryengine_v1beta_session_object
|
1846
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
1847
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
1848
|
+
command.params['name'] = name unless name.nil?
|
1849
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1850
|
+
command.query['fields'] = fields unless fields.nil?
|
1851
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1852
|
+
execute_or_queue_command(command, &block)
|
1853
|
+
end
|
1854
|
+
|
1855
|
+
# Gets a Answer.
|
1856
|
+
# @param [String] name
|
1857
|
+
# Required. The resource name of the Answer to get. Format: `projects/`
|
1858
|
+
# project_number`/locations/`location_id`/collections/`collection`/engines/`
|
1859
|
+
# engine_id`/sessions/`session_id`/answers/`answer_id``
|
1860
|
+
# @param [String] fields
|
1861
|
+
# Selector specifying which fields to include in a partial response.
|
1862
|
+
# @param [String] quota_user
|
1863
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1864
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1865
|
+
# @param [Google::Apis::RequestOptions] options
|
1866
|
+
# Request-specific options
|
1867
|
+
#
|
1868
|
+
# @yield [result, err] Result & error if block supplied
|
1869
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer] parsed result object
|
1870
|
+
# @yieldparam err [StandardError] error object if request failed
|
1871
|
+
#
|
1872
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer]
|
1873
|
+
#
|
1874
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1875
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1876
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1877
|
+
def get_project_location_collection_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
|
1878
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
1879
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer::Representation
|
1880
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer
|
1881
|
+
command.params['name'] = name unless name.nil?
|
1882
|
+
command.query['fields'] = fields unless fields.nil?
|
1883
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1884
|
+
execute_or_queue_command(command, &block)
|
1885
|
+
end
|
1886
|
+
|
1628
1887
|
# Verify target sites' ownership and validity. This API sends all the target
|
1629
1888
|
# sites under site search engine for verification.
|
1630
1889
|
# @param [String] parent
|
@@ -2952,6 +3211,44 @@ module Google
|
|
2952
3211
|
execute_or_queue_command(command, &block)
|
2953
3212
|
end
|
2954
3213
|
|
3214
|
+
# Answer query method.
|
3215
|
+
# @param [String] serving_config
|
3216
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
3217
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
3218
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
3219
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
3220
|
+
# field is used to identify the serving configuration name, set of models used
|
3221
|
+
# to make the search.
|
3222
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest] google_cloud_discoveryengine_v1beta_answer_query_request_object
|
3223
|
+
# @param [String] fields
|
3224
|
+
# Selector specifying which fields to include in a partial response.
|
3225
|
+
# @param [String] quota_user
|
3226
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3227
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3228
|
+
# @param [Google::Apis::RequestOptions] options
|
3229
|
+
# Request-specific options
|
3230
|
+
#
|
3231
|
+
# @yield [result, err] Result & error if block supplied
|
3232
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse] parsed result object
|
3233
|
+
# @yieldparam err [StandardError] error object if request failed
|
3234
|
+
#
|
3235
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse]
|
3236
|
+
#
|
3237
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3238
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3239
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3240
|
+
def answer_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1beta_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3241
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:answer', options)
|
3242
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest::Representation
|
3243
|
+
command.request_object = google_cloud_discoveryengine_v1beta_answer_query_request_object
|
3244
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse::Representation
|
3245
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse
|
3246
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3247
|
+
command.query['fields'] = fields unless fields.nil?
|
3248
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3249
|
+
execute_or_queue_command(command, &block)
|
3250
|
+
end
|
3251
|
+
|
2955
3252
|
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
2956
3253
|
# exist.
|
2957
3254
|
# @param [String] name
|
@@ -3085,35 +3382,258 @@ module Google
|
|
3085
3382
|
# Request-specific options
|
3086
3383
|
#
|
3087
3384
|
# @yield [result, err] Result & error if block supplied
|
3088
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
|
3385
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
|
3386
|
+
# @yieldparam err [StandardError] error object if request failed
|
3387
|
+
#
|
3388
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
|
3389
|
+
#
|
3390
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3391
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3392
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3393
|
+
def recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1beta_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3394
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
|
3395
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
|
3396
|
+
command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
|
3397
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
|
3398
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
|
3399
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3400
|
+
command.query['fields'] = fields unless fields.nil?
|
3401
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3402
|
+
execute_or_queue_command(command, &block)
|
3403
|
+
end
|
3404
|
+
|
3405
|
+
# Performs a search.
|
3406
|
+
# @param [String] serving_config
|
3407
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
3408
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
3409
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
3410
|
+
# default_collection/dataStores/default_data_store/servingConfigs/
|
3411
|
+
# default_serving_config`. This field is used to identify the serving
|
3412
|
+
# configuration name, set of models used to make the search.
|
3413
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
3414
|
+
# @param [String] fields
|
3415
|
+
# Selector specifying which fields to include in a partial response.
|
3416
|
+
# @param [String] quota_user
|
3417
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3418
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3419
|
+
# @param [Google::Apis::RequestOptions] options
|
3420
|
+
# Request-specific options
|
3421
|
+
#
|
3422
|
+
# @yield [result, err] Result & error if block supplied
|
3423
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
|
3424
|
+
# @yieldparam err [StandardError] error object if request failed
|
3425
|
+
#
|
3426
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
|
3427
|
+
#
|
3428
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3429
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3430
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3431
|
+
def search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1beta_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3432
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:search', options)
|
3433
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
|
3434
|
+
command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
|
3435
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
|
3436
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
|
3437
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3438
|
+
command.query['fields'] = fields unless fields.nil?
|
3439
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3440
|
+
execute_or_queue_command(command, &block)
|
3441
|
+
end
|
3442
|
+
|
3443
|
+
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
3444
|
+
# error is returned.
|
3445
|
+
# @param [String] parent
|
3446
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
3447
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3448
|
+
# data_store_id``
|
3449
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
|
3450
|
+
# @param [String] fields
|
3451
|
+
# Selector specifying which fields to include in a partial response.
|
3452
|
+
# @param [String] quota_user
|
3453
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3454
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3455
|
+
# @param [Google::Apis::RequestOptions] options
|
3456
|
+
# Request-specific options
|
3457
|
+
#
|
3458
|
+
# @yield [result, err] Result & error if block supplied
|
3459
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
3460
|
+
# @yieldparam err [StandardError] error object if request failed
|
3461
|
+
#
|
3462
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
3463
|
+
#
|
3464
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3465
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3466
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3467
|
+
def create_project_location_collection_engine_session(parent, google_cloud_discoveryengine_v1beta_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3468
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/sessions', options)
|
3469
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
3470
|
+
command.request_object = google_cloud_discoveryengine_v1beta_session_object
|
3471
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
3472
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
3473
|
+
command.params['parent'] = parent unless parent.nil?
|
3474
|
+
command.query['fields'] = fields unless fields.nil?
|
3475
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3476
|
+
execute_or_queue_command(command, &block)
|
3477
|
+
end
|
3478
|
+
|
3479
|
+
# Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
|
3480
|
+
# is returned.
|
3481
|
+
# @param [String] name
|
3482
|
+
# Required. The resource name of the Session to delete. Format: `projects/`
|
3483
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3484
|
+
# data_store_id`/sessions/`session_id``
|
3485
|
+
# @param [String] fields
|
3486
|
+
# Selector specifying which fields to include in a partial response.
|
3487
|
+
# @param [String] quota_user
|
3488
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3489
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3490
|
+
# @param [Google::Apis::RequestOptions] options
|
3491
|
+
# Request-specific options
|
3492
|
+
#
|
3493
|
+
# @yield [result, err] Result & error if block supplied
|
3494
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
3495
|
+
# @yieldparam err [StandardError] error object if request failed
|
3496
|
+
#
|
3497
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
3498
|
+
#
|
3499
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3500
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3501
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3502
|
+
def delete_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
3503
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
3504
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
3505
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
3506
|
+
command.params['name'] = name unless name.nil?
|
3507
|
+
command.query['fields'] = fields unless fields.nil?
|
3508
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3509
|
+
execute_or_queue_command(command, &block)
|
3510
|
+
end
|
3511
|
+
|
3512
|
+
# Gets a Session.
|
3513
|
+
# @param [String] name
|
3514
|
+
# Required. The resource name of the Session to get. Format: `projects/`
|
3515
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3516
|
+
# data_store_id`/sessions/`session_id``
|
3517
|
+
# @param [String] fields
|
3518
|
+
# Selector specifying which fields to include in a partial response.
|
3519
|
+
# @param [String] quota_user
|
3520
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3521
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3522
|
+
# @param [Google::Apis::RequestOptions] options
|
3523
|
+
# Request-specific options
|
3524
|
+
#
|
3525
|
+
# @yield [result, err] Result & error if block supplied
|
3526
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
3527
|
+
# @yieldparam err [StandardError] error object if request failed
|
3528
|
+
#
|
3529
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
3530
|
+
#
|
3531
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3532
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3533
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3534
|
+
def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
3535
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3536
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
3537
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
3538
|
+
command.params['name'] = name unless name.nil?
|
3539
|
+
command.query['fields'] = fields unless fields.nil?
|
3540
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3541
|
+
execute_or_queue_command(command, &block)
|
3542
|
+
end
|
3543
|
+
|
3544
|
+
# Lists all Sessions by their parent DataStore.
|
3545
|
+
# @param [String] parent
|
3546
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
3547
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
3548
|
+
# @param [String] filter
|
3549
|
+
# A filter to apply on the list results. The supported features are:
|
3550
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
3551
|
+
# @param [String] order_by
|
3552
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
3553
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
3554
|
+
# create_time` * `session_name` Example: "update_time desc" "create_time"
|
3555
|
+
# @param [Fixnum] page_size
|
3556
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
3557
|
+
# allowed value is 1000.
|
3558
|
+
# @param [String] page_token
|
3559
|
+
# A page token, received from a previous `ListSessions` call. Provide this to
|
3560
|
+
# retrieve the subsequent page.
|
3561
|
+
# @param [String] fields
|
3562
|
+
# Selector specifying which fields to include in a partial response.
|
3563
|
+
# @param [String] quota_user
|
3564
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3565
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3566
|
+
# @param [Google::Apis::RequestOptions] options
|
3567
|
+
# Request-specific options
|
3568
|
+
#
|
3569
|
+
# @yield [result, err] Result & error if block supplied
|
3570
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse] parsed result object
|
3571
|
+
# @yieldparam err [StandardError] error object if request failed
|
3572
|
+
#
|
3573
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse]
|
3574
|
+
#
|
3575
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3576
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3577
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3578
|
+
def list_project_location_collection_engine_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3579
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/sessions', options)
|
3580
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse::Representation
|
3581
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse
|
3582
|
+
command.params['parent'] = parent unless parent.nil?
|
3583
|
+
command.query['filter'] = filter unless filter.nil?
|
3584
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
3585
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3586
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3587
|
+
command.query['fields'] = fields unless fields.nil?
|
3588
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3589
|
+
execute_or_queue_command(command, &block)
|
3590
|
+
end
|
3591
|
+
|
3592
|
+
# Updates a Session. Session action type cannot be changed. If the Session to
|
3593
|
+
# update does not exist, a NOT_FOUND error is returned.
|
3594
|
+
# @param [String] name
|
3595
|
+
# Immutable. Fully qualified name `project/*/locations/global/collections/`
|
3596
|
+
# collection`/engines/`engine`/sessions/*`
|
3597
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
|
3598
|
+
# @param [String] update_mask
|
3599
|
+
# Indicates which fields in the provided Session to update. The following are
|
3600
|
+
# NOT supported: * Session.name If not set or empty, all supported fields are
|
3601
|
+
# updated.
|
3602
|
+
# @param [String] fields
|
3603
|
+
# Selector specifying which fields to include in a partial response.
|
3604
|
+
# @param [String] quota_user
|
3605
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3606
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3607
|
+
# @param [Google::Apis::RequestOptions] options
|
3608
|
+
# Request-specific options
|
3609
|
+
#
|
3610
|
+
# @yield [result, err] Result & error if block supplied
|
3611
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
3089
3612
|
# @yieldparam err [StandardError] error object if request failed
|
3090
3613
|
#
|
3091
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3614
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
3092
3615
|
#
|
3093
3616
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3094
3617
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3095
3618
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3096
|
-
def
|
3097
|
-
command = make_simple_command(:
|
3098
|
-
command.request_representation = Google::Apis::DiscoveryengineV1beta::
|
3099
|
-
command.request_object =
|
3100
|
-
command.response_representation = Google::Apis::DiscoveryengineV1beta::
|
3101
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::
|
3102
|
-
command.params['
|
3619
|
+
def patch_project_location_collection_engine_session(name, google_cloud_discoveryengine_v1beta_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3620
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
3621
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
3622
|
+
command.request_object = google_cloud_discoveryengine_v1beta_session_object
|
3623
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
3624
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
3625
|
+
command.params['name'] = name unless name.nil?
|
3626
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3103
3627
|
command.query['fields'] = fields unless fields.nil?
|
3104
3628
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3105
3629
|
execute_or_queue_command(command, &block)
|
3106
3630
|
end
|
3107
3631
|
|
3108
|
-
#
|
3109
|
-
# @param [String]
|
3110
|
-
# Required. The resource name of the
|
3111
|
-
# locations
|
3112
|
-
#
|
3113
|
-
# default_collection/dataStores/default_data_store/servingConfigs/
|
3114
|
-
# default_serving_config`. This field is used to identify the serving
|
3115
|
-
# configuration name, set of models used to make the search.
|
3116
|
-
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
3632
|
+
# Gets a Answer.
|
3633
|
+
# @param [String] name
|
3634
|
+
# Required. The resource name of the Answer to get. Format: `projects/`
|
3635
|
+
# project_number`/locations/`location_id`/collections/`collection`/engines/`
|
3636
|
+
# engine_id`/sessions/`session_id`/answers/`answer_id``
|
3117
3637
|
# @param [String] fields
|
3118
3638
|
# Selector specifying which fields to include in a partial response.
|
3119
3639
|
# @param [String] quota_user
|
@@ -3123,21 +3643,19 @@ module Google
|
|
3123
3643
|
# Request-specific options
|
3124
3644
|
#
|
3125
3645
|
# @yield [result, err] Result & error if block supplied
|
3126
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::
|
3646
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer] parsed result object
|
3127
3647
|
# @yieldparam err [StandardError] error object if request failed
|
3128
3648
|
#
|
3129
|
-
# @return [Google::Apis::DiscoveryengineV1beta::
|
3649
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer]
|
3130
3650
|
#
|
3131
3651
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3132
3652
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3133
3653
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3134
|
-
def
|
3135
|
-
command = make_simple_command(:
|
3136
|
-
command.
|
3137
|
-
command.
|
3138
|
-
command.
|
3139
|
-
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
|
3140
|
-
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3654
|
+
def get_project_location_collection_engine_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
|
3655
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
3656
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer::Representation
|
3657
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer
|
3658
|
+
command.params['name'] = name unless name.nil?
|
3141
3659
|
command.query['fields'] = fields unless fields.nil?
|
3142
3660
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3143
3661
|
execute_or_queue_command(command, &block)
|
@@ -4420,6 +4938,44 @@ module Google
|
|
4420
4938
|
execute_or_queue_command(command, &block)
|
4421
4939
|
end
|
4422
4940
|
|
4941
|
+
# Answer query method.
|
4942
|
+
# @param [String] serving_config
|
4943
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
4944
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
4945
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
4946
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
4947
|
+
# field is used to identify the serving configuration name, set of models used
|
4948
|
+
# to make the search.
|
4949
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest] google_cloud_discoveryengine_v1beta_answer_query_request_object
|
4950
|
+
# @param [String] fields
|
4951
|
+
# Selector specifying which fields to include in a partial response.
|
4952
|
+
# @param [String] quota_user
|
4953
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4954
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4955
|
+
# @param [Google::Apis::RequestOptions] options
|
4956
|
+
# Request-specific options
|
4957
|
+
#
|
4958
|
+
# @yield [result, err] Result & error if block supplied
|
4959
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse] parsed result object
|
4960
|
+
# @yieldparam err [StandardError] error object if request failed
|
4961
|
+
#
|
4962
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse]
|
4963
|
+
#
|
4964
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4965
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4966
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4967
|
+
def answer_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1beta_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4968
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:answer', options)
|
4969
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest::Representation
|
4970
|
+
command.request_object = google_cloud_discoveryengine_v1beta_answer_query_request_object
|
4971
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse::Representation
|
4972
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse
|
4973
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
4974
|
+
command.query['fields'] = fields unless fields.nil?
|
4975
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4976
|
+
execute_or_queue_command(command, &block)
|
4977
|
+
end
|
4978
|
+
|
4423
4979
|
# Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not
|
4424
4980
|
# exist.
|
4425
4981
|
# @param [String] name
|
@@ -4611,6 +5167,227 @@ module Google
|
|
4611
5167
|
execute_or_queue_command(command, &block)
|
4612
5168
|
end
|
4613
5169
|
|
5170
|
+
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
5171
|
+
# error is returned.
|
5172
|
+
# @param [String] parent
|
5173
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
5174
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
5175
|
+
# data_store_id``
|
5176
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
|
5177
|
+
# @param [String] fields
|
5178
|
+
# Selector specifying which fields to include in a partial response.
|
5179
|
+
# @param [String] quota_user
|
5180
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5181
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5182
|
+
# @param [Google::Apis::RequestOptions] options
|
5183
|
+
# Request-specific options
|
5184
|
+
#
|
5185
|
+
# @yield [result, err] Result & error if block supplied
|
5186
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
5187
|
+
# @yieldparam err [StandardError] error object if request failed
|
5188
|
+
#
|
5189
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
5190
|
+
#
|
5191
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5192
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5193
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5194
|
+
def create_project_location_data_store_session(parent, google_cloud_discoveryengine_v1beta_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5195
|
+
command = make_simple_command(:post, 'v1beta/{+parent}/sessions', options)
|
5196
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
5197
|
+
command.request_object = google_cloud_discoveryengine_v1beta_session_object
|
5198
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
5199
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
5200
|
+
command.params['parent'] = parent unless parent.nil?
|
5201
|
+
command.query['fields'] = fields unless fields.nil?
|
5202
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5203
|
+
execute_or_queue_command(command, &block)
|
5204
|
+
end
|
5205
|
+
|
5206
|
+
# Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
|
5207
|
+
# is returned.
|
5208
|
+
# @param [String] name
|
5209
|
+
# Required. The resource name of the Session to delete. Format: `projects/`
|
5210
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
5211
|
+
# data_store_id`/sessions/`session_id``
|
5212
|
+
# @param [String] fields
|
5213
|
+
# Selector specifying which fields to include in a partial response.
|
5214
|
+
# @param [String] quota_user
|
5215
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5216
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5217
|
+
# @param [Google::Apis::RequestOptions] options
|
5218
|
+
# Request-specific options
|
5219
|
+
#
|
5220
|
+
# @yield [result, err] Result & error if block supplied
|
5221
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty] parsed result object
|
5222
|
+
# @yieldparam err [StandardError] error object if request failed
|
5223
|
+
#
|
5224
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty]
|
5225
|
+
#
|
5226
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5227
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5228
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5229
|
+
def delete_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
5230
|
+
command = make_simple_command(:delete, 'v1beta/{+name}', options)
|
5231
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty::Representation
|
5232
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleProtobufEmpty
|
5233
|
+
command.params['name'] = name unless name.nil?
|
5234
|
+
command.query['fields'] = fields unless fields.nil?
|
5235
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5236
|
+
execute_or_queue_command(command, &block)
|
5237
|
+
end
|
5238
|
+
|
5239
|
+
# Gets a Session.
|
5240
|
+
# @param [String] name
|
5241
|
+
# Required. The resource name of the Session to get. Format: `projects/`
|
5242
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
5243
|
+
# data_store_id`/sessions/`session_id``
|
5244
|
+
# @param [String] fields
|
5245
|
+
# Selector specifying which fields to include in a partial response.
|
5246
|
+
# @param [String] quota_user
|
5247
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5248
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5249
|
+
# @param [Google::Apis::RequestOptions] options
|
5250
|
+
# Request-specific options
|
5251
|
+
#
|
5252
|
+
# @yield [result, err] Result & error if block supplied
|
5253
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
5254
|
+
# @yieldparam err [StandardError] error object if request failed
|
5255
|
+
#
|
5256
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
5257
|
+
#
|
5258
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5259
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5260
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5261
|
+
def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
5262
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
5263
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
5264
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
5265
|
+
command.params['name'] = name unless name.nil?
|
5266
|
+
command.query['fields'] = fields unless fields.nil?
|
5267
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5268
|
+
execute_or_queue_command(command, &block)
|
5269
|
+
end
|
5270
|
+
|
5271
|
+
# Lists all Sessions by their parent DataStore.
|
5272
|
+
# @param [String] parent
|
5273
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
5274
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
5275
|
+
# @param [String] filter
|
5276
|
+
# A filter to apply on the list results. The supported features are:
|
5277
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
5278
|
+
# @param [String] order_by
|
5279
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
5280
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
5281
|
+
# create_time` * `session_name` Example: "update_time desc" "create_time"
|
5282
|
+
# @param [Fixnum] page_size
|
5283
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
5284
|
+
# allowed value is 1000.
|
5285
|
+
# @param [String] page_token
|
5286
|
+
# A page token, received from a previous `ListSessions` call. Provide this to
|
5287
|
+
# retrieve the subsequent page.
|
5288
|
+
# @param [String] fields
|
5289
|
+
# Selector specifying which fields to include in a partial response.
|
5290
|
+
# @param [String] quota_user
|
5291
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5292
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5293
|
+
# @param [Google::Apis::RequestOptions] options
|
5294
|
+
# Request-specific options
|
5295
|
+
#
|
5296
|
+
# @yield [result, err] Result & error if block supplied
|
5297
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse] parsed result object
|
5298
|
+
# @yieldparam err [StandardError] error object if request failed
|
5299
|
+
#
|
5300
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse]
|
5301
|
+
#
|
5302
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5303
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5304
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5305
|
+
def list_project_location_data_store_sessions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5306
|
+
command = make_simple_command(:get, 'v1beta/{+parent}/sessions', options)
|
5307
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse::Representation
|
5308
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaListSessionsResponse
|
5309
|
+
command.params['parent'] = parent unless parent.nil?
|
5310
|
+
command.query['filter'] = filter unless filter.nil?
|
5311
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
5312
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
5313
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
5314
|
+
command.query['fields'] = fields unless fields.nil?
|
5315
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5316
|
+
execute_or_queue_command(command, &block)
|
5317
|
+
end
|
5318
|
+
|
5319
|
+
# Updates a Session. Session action type cannot be changed. If the Session to
|
5320
|
+
# update does not exist, a NOT_FOUND error is returned.
|
5321
|
+
# @param [String] name
|
5322
|
+
# Immutable. Fully qualified name `project/*/locations/global/collections/`
|
5323
|
+
# collection`/engines/`engine`/sessions/*`
|
5324
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] google_cloud_discoveryengine_v1beta_session_object
|
5325
|
+
# @param [String] update_mask
|
5326
|
+
# Indicates which fields in the provided Session to update. The following are
|
5327
|
+
# NOT supported: * Session.name If not set or empty, all supported fields are
|
5328
|
+
# updated.
|
5329
|
+
# @param [String] fields
|
5330
|
+
# Selector specifying which fields to include in a partial response.
|
5331
|
+
# @param [String] quota_user
|
5332
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5333
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5334
|
+
# @param [Google::Apis::RequestOptions] options
|
5335
|
+
# Request-specific options
|
5336
|
+
#
|
5337
|
+
# @yield [result, err] Result & error if block supplied
|
5338
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession] parsed result object
|
5339
|
+
# @yieldparam err [StandardError] error object if request failed
|
5340
|
+
#
|
5341
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession]
|
5342
|
+
#
|
5343
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5344
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5345
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5346
|
+
def patch_project_location_data_store_session(name, google_cloud_discoveryengine_v1beta_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5347
|
+
command = make_simple_command(:patch, 'v1beta/{+name}', options)
|
5348
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
5349
|
+
command.request_object = google_cloud_discoveryengine_v1beta_session_object
|
5350
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
|
5351
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
|
5352
|
+
command.params['name'] = name unless name.nil?
|
5353
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
5354
|
+
command.query['fields'] = fields unless fields.nil?
|
5355
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5356
|
+
execute_or_queue_command(command, &block)
|
5357
|
+
end
|
5358
|
+
|
5359
|
+
# Gets a Answer.
|
5360
|
+
# @param [String] name
|
5361
|
+
# Required. The resource name of the Answer to get. Format: `projects/`
|
5362
|
+
# project_number`/locations/`location_id`/collections/`collection`/engines/`
|
5363
|
+
# engine_id`/sessions/`session_id`/answers/`answer_id``
|
5364
|
+
# @param [String] fields
|
5365
|
+
# Selector specifying which fields to include in a partial response.
|
5366
|
+
# @param [String] quota_user
|
5367
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5368
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5369
|
+
# @param [Google::Apis::RequestOptions] options
|
5370
|
+
# Request-specific options
|
5371
|
+
#
|
5372
|
+
# @yield [result, err] Result & error if block supplied
|
5373
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer] parsed result object
|
5374
|
+
# @yieldparam err [StandardError] error object if request failed
|
5375
|
+
#
|
5376
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer]
|
5377
|
+
#
|
5378
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5379
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5380
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5381
|
+
def get_project_location_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
|
5382
|
+
command = make_simple_command(:get, 'v1beta/{+name}', options)
|
5383
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer::Representation
|
5384
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswer
|
5385
|
+
command.params['name'] = name unless name.nil?
|
5386
|
+
command.query['fields'] = fields unless fields.nil?
|
5387
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5388
|
+
execute_or_queue_command(command, &block)
|
5389
|
+
end
|
5390
|
+
|
4614
5391
|
# Downgrade from advanced site search to basic site search.
|
4615
5392
|
# @param [String] site_search_engine
|
4616
5393
|
# Required. Full resource name of the SiteSearchEngine, such as `projects/`
|
@@ -5123,6 +5900,40 @@ module Google
|
|
5123
5900
|
execute_or_queue_command(command, &block)
|
5124
5901
|
end
|
5125
5902
|
|
5903
|
+
# Performs a grounding check.
|
5904
|
+
# @param [String] grounding_config
|
5905
|
+
# Required. The resource name of the grounding config, such as `projects/*/
|
5906
|
+
# locations/global/groundingConfigs/default_grounding_config`.
|
5907
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingRequest] google_cloud_discoveryengine_v1beta_check_grounding_request_object
|
5908
|
+
# @param [String] fields
|
5909
|
+
# Selector specifying which fields to include in a partial response.
|
5910
|
+
# @param [String] quota_user
|
5911
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5912
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5913
|
+
# @param [Google::Apis::RequestOptions] options
|
5914
|
+
# Request-specific options
|
5915
|
+
#
|
5916
|
+
# @yield [result, err] Result & error if block supplied
|
5917
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse] parsed result object
|
5918
|
+
# @yieldparam err [StandardError] error object if request failed
|
5919
|
+
#
|
5920
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse]
|
5921
|
+
#
|
5922
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5923
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5924
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5925
|
+
def check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1beta_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5926
|
+
command = make_simple_command(:post, 'v1beta/{+groundingConfig}:check', options)
|
5927
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingRequest::Representation
|
5928
|
+
command.request_object = google_cloud_discoveryengine_v1beta_check_grounding_request_object
|
5929
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse::Representation
|
5930
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCheckGroundingResponse
|
5931
|
+
command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
|
5932
|
+
command.query['fields'] = fields unless fields.nil?
|
5933
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5934
|
+
execute_or_queue_command(command, &block)
|
5935
|
+
end
|
5936
|
+
|
5126
5937
|
# Gets the latest state of a long-running operation. Clients can use this method
|
5127
5938
|
# to poll the operation result at intervals as recommended by the API service.
|
5128
5939
|
# @param [String] name
|