google-apis-discoveryengine_v1 0.2.0 → 0.4.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 +9 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +1692 -94
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1/representations.rb +855 -67
- data/lib/google/apis/discoveryengine_v1/service.rb +1033 -68
- metadata +5 -5
@@ -430,14 +430,14 @@ module Google
|
|
430
430
|
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
431
431
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
|
432
432
|
# @param [String] document_id
|
433
|
-
# Required. The ID to use for the Document, which
|
434
|
-
#
|
435
|
-
#
|
436
|
-
#
|
437
|
-
#
|
438
|
-
#
|
439
|
-
#
|
440
|
-
#
|
433
|
+
# Required. The ID to use for the Document, which becomes the final component of
|
434
|
+
# the Document.name. If the caller does not have permission to create the
|
435
|
+
# Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
|
436
|
+
# is returned. This field must be unique among all Documents with the same
|
437
|
+
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
438
|
+
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
439
|
+
# length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
440
|
+
# returned.
|
441
441
|
# @param [String] fields
|
442
442
|
# Selector specifying which fields to include in a partial response.
|
443
443
|
# @param [String] quota_user
|
@@ -539,8 +539,8 @@ module Google
|
|
539
539
|
end
|
540
540
|
|
541
541
|
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
542
|
-
# existing items
|
543
|
-
#
|
542
|
+
# existing items are created. Note: It is possible for a subset of the Documents
|
543
|
+
# to be successfully updated.
|
544
544
|
# @param [String] parent
|
545
545
|
# Required. The parent branch resource name, such as `projects/`project`/
|
546
546
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
@@ -585,8 +585,8 @@ module Google
|
|
585
585
|
# PERMISSION_DENIED` error is returned.
|
586
586
|
# @param [Fixnum] page_size
|
587
587
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
588
|
-
# maximum allowed value is 1000. Values above 1000
|
589
|
-
#
|
588
|
+
# maximum allowed value is 1000. Values above 1000 are set to 1000. If this
|
589
|
+
# field is negative, an `INVALID_ARGUMENT` error is returned.
|
590
590
|
# @param [String] page_token
|
591
591
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
592
592
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
@@ -630,10 +630,10 @@ module Google
|
|
630
630
|
# with a length limit of 1024 characters.
|
631
631
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
|
632
632
|
# @param [Boolean] allow_missing
|
633
|
-
# If set to true
|
633
|
+
# If set to `true` and the Document is not found, a new Document is be created.
|
634
634
|
# @param [String] update_mask
|
635
635
|
# Indicates which fields in the provided imported 'document' to update. If not
|
636
|
-
# set,
|
636
|
+
# set, by default updates all fields.
|
637
637
|
# @param [String] fields
|
638
638
|
# Selector specifying which fields to include in a partial response.
|
639
639
|
# @param [String] quota_user
|
@@ -704,6 +704,46 @@ module Google
|
|
704
704
|
execute_or_queue_command(command, &block)
|
705
705
|
end
|
706
706
|
|
707
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
708
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
709
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
710
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
711
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
712
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
713
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
714
|
+
# corresponding to `Code.CANCELLED`.
|
715
|
+
# @param [String] name
|
716
|
+
# The name of the operation resource to be cancelled.
|
717
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
|
718
|
+
# @param [String] fields
|
719
|
+
# Selector specifying which fields to include in a partial response.
|
720
|
+
# @param [String] quota_user
|
721
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
722
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
723
|
+
# @param [Google::Apis::RequestOptions] options
|
724
|
+
# Request-specific options
|
725
|
+
#
|
726
|
+
# @yield [result, err] Result & error if block supplied
|
727
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
|
728
|
+
# @yieldparam err [StandardError] error object if request failed
|
729
|
+
#
|
730
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
|
731
|
+
#
|
732
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
733
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
734
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
735
|
+
def cancel_project_location_collection_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
736
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
737
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
|
738
|
+
command.request_object = google_longrunning_cancel_operation_request_object
|
739
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
|
740
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
|
741
|
+
command.params['name'] = name unless name.nil?
|
742
|
+
command.query['fields'] = fields unless fields.nil?
|
743
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
744
|
+
execute_or_queue_command(command, &block)
|
745
|
+
end
|
746
|
+
|
707
747
|
# Gets the latest state of a long-running operation. Clients can use this method
|
708
748
|
# to poll the operation result at intervals as recommended by the API service.
|
709
749
|
# @param [String] name
|
@@ -1152,8 +1192,8 @@ module Google
|
|
1152
1192
|
# .
|
1153
1193
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
|
1154
1194
|
# @param [String] schema_id
|
1155
|
-
# Required. The ID to use for the Schema, which
|
1156
|
-
#
|
1195
|
+
# Required. The ID to use for the Schema, which becomes the final component of
|
1196
|
+
# the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
1157
1197
|
# org/html/rfc1034) standard with a length limit of 63 characters.
|
1158
1198
|
# @param [String] fields
|
1159
1199
|
# Selector specifying which fields to include in a partial response.
|
@@ -1256,8 +1296,8 @@ module Google
|
|
1256
1296
|
# .
|
1257
1297
|
# @param [Fixnum] page_size
|
1258
1298
|
# The maximum number of Schemas to return. The service may return fewer than
|
1259
|
-
# this value. If unspecified, at most 100 Schemas
|
1260
|
-
# value is 1000; values above 1000
|
1299
|
+
# this value. If unspecified, at most 100 Schemas are returned. The maximum
|
1300
|
+
# value is 1000; values above 1000 are set to 1000.
|
1261
1301
|
# @param [String] page_token
|
1262
1302
|
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
1263
1303
|
# this to retrieve the subsequent page. When paginating, all other parameters
|
@@ -1300,8 +1340,8 @@ module Google
|
|
1300
1340
|
# limit of 1024 characters.
|
1301
1341
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
|
1302
1342
|
# @param [Boolean] allow_missing
|
1303
|
-
# If set to true, and the Schema is not found, a new Schema
|
1304
|
-
#
|
1343
|
+
# If set to true, and the Schema is not found, a new Schema is created. In this
|
1344
|
+
# situation, `update_mask` is ignored.
|
1305
1345
|
# @param [String] fields
|
1306
1346
|
# Selector specifying which fields to include in a partial response.
|
1307
1347
|
# @param [String] quota_user
|
@@ -1403,16 +1443,54 @@ module Google
|
|
1403
1443
|
execute_or_queue_command(command, &block)
|
1404
1444
|
end
|
1405
1445
|
|
1446
|
+
# Answer query method.
|
1447
|
+
# @param [String] serving_config
|
1448
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
1449
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
1450
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
1451
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
1452
|
+
# field is used to identify the serving configuration name, set of models used
|
1453
|
+
# to make the search.
|
1454
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
|
1455
|
+
# @param [String] fields
|
1456
|
+
# Selector specifying which fields to include in a partial response.
|
1457
|
+
# @param [String] quota_user
|
1458
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1459
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1460
|
+
# @param [Google::Apis::RequestOptions] options
|
1461
|
+
# Request-specific options
|
1462
|
+
#
|
1463
|
+
# @yield [result, err] Result & error if block supplied
|
1464
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
|
1465
|
+
# @yieldparam err [StandardError] error object if request failed
|
1466
|
+
#
|
1467
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
|
1468
|
+
#
|
1469
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1470
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1471
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1472
|
+
def answer_project_location_collection_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1473
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
|
1474
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
|
1475
|
+
command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
|
1476
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
|
1477
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
|
1478
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1479
|
+
command.query['fields'] = fields unless fields.nil?
|
1480
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1481
|
+
execute_or_queue_command(command, &block)
|
1482
|
+
end
|
1483
|
+
|
1406
1484
|
# Makes a recommendation, which requires a contextual user event.
|
1407
1485
|
# @param [String] serving_config
|
1408
1486
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
1409
1487
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
1410
1488
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
1411
|
-
# created along with your recommendation engine creation. The engine ID
|
1412
|
-
#
|
1413
|
-
#
|
1414
|
-
#
|
1415
|
-
#
|
1489
|
+
# created along with your recommendation engine creation. The engine ID is used
|
1490
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
1491
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
1492
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
1493
|
+
# your RecommendationService.Recommend requests.
|
1416
1494
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest] google_cloud_discoveryengine_v1_recommend_request_object
|
1417
1495
|
# @param [String] fields
|
1418
1496
|
# Selector specifying which fields to include in a partial response.
|
@@ -1481,6 +1559,227 @@ module Google
|
|
1481
1559
|
execute_or_queue_command(command, &block)
|
1482
1560
|
end
|
1483
1561
|
|
1562
|
+
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
1563
|
+
# error is returned.
|
1564
|
+
# @param [String] parent
|
1565
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
1566
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
1567
|
+
# data_store_id``
|
1568
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
|
1569
|
+
# @param [String] fields
|
1570
|
+
# Selector specifying which fields to include in a partial response.
|
1571
|
+
# @param [String] quota_user
|
1572
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1573
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1574
|
+
# @param [Google::Apis::RequestOptions] options
|
1575
|
+
# Request-specific options
|
1576
|
+
#
|
1577
|
+
# @yield [result, err] Result & error if block supplied
|
1578
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
1579
|
+
# @yieldparam err [StandardError] error object if request failed
|
1580
|
+
#
|
1581
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
1582
|
+
#
|
1583
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1584
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1585
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1586
|
+
def create_project_location_collection_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1587
|
+
command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
|
1588
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
1589
|
+
command.request_object = google_cloud_discoveryengine_v1_session_object
|
1590
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
1591
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
1592
|
+
command.params['parent'] = parent unless parent.nil?
|
1593
|
+
command.query['fields'] = fields unless fields.nil?
|
1594
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1595
|
+
execute_or_queue_command(command, &block)
|
1596
|
+
end
|
1597
|
+
|
1598
|
+
# Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
|
1599
|
+
# is returned.
|
1600
|
+
# @param [String] name
|
1601
|
+
# Required. The resource name of the Session to delete. Format: `projects/`
|
1602
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
1603
|
+
# data_store_id`/sessions/`session_id``
|
1604
|
+
# @param [String] fields
|
1605
|
+
# Selector specifying which fields to include in a partial response.
|
1606
|
+
# @param [String] quota_user
|
1607
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1608
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1609
|
+
# @param [Google::Apis::RequestOptions] options
|
1610
|
+
# Request-specific options
|
1611
|
+
#
|
1612
|
+
# @yield [result, err] Result & error if block supplied
|
1613
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
|
1614
|
+
# @yieldparam err [StandardError] error object if request failed
|
1615
|
+
#
|
1616
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
|
1617
|
+
#
|
1618
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1619
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1620
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1621
|
+
def delete_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
1622
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
1623
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
|
1624
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
|
1625
|
+
command.params['name'] = name unless name.nil?
|
1626
|
+
command.query['fields'] = fields unless fields.nil?
|
1627
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1628
|
+
execute_or_queue_command(command, &block)
|
1629
|
+
end
|
1630
|
+
|
1631
|
+
# Gets a Session.
|
1632
|
+
# @param [String] name
|
1633
|
+
# Required. The resource name of the Session to get. Format: `projects/`
|
1634
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
1635
|
+
# data_store_id`/sessions/`session_id``
|
1636
|
+
# @param [String] fields
|
1637
|
+
# Selector specifying which fields to include in a partial response.
|
1638
|
+
# @param [String] quota_user
|
1639
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1640
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1641
|
+
# @param [Google::Apis::RequestOptions] options
|
1642
|
+
# Request-specific options
|
1643
|
+
#
|
1644
|
+
# @yield [result, err] Result & error if block supplied
|
1645
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
1646
|
+
# @yieldparam err [StandardError] error object if request failed
|
1647
|
+
#
|
1648
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
1649
|
+
#
|
1650
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1651
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1652
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1653
|
+
def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
1654
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1655
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
1656
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
1657
|
+
command.params['name'] = name unless name.nil?
|
1658
|
+
command.query['fields'] = fields unless fields.nil?
|
1659
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1660
|
+
execute_or_queue_command(command, &block)
|
1661
|
+
end
|
1662
|
+
|
1663
|
+
# Lists all Sessions by their parent DataStore.
|
1664
|
+
# @param [String] parent
|
1665
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
1666
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
1667
|
+
# @param [String] filter
|
1668
|
+
# A filter to apply on the list results. The supported features are:
|
1669
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
1670
|
+
# @param [String] order_by
|
1671
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
1672
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
1673
|
+
# create_time` * `session_name` Example: "update_time desc" "create_time"
|
1674
|
+
# @param [Fixnum] page_size
|
1675
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
1676
|
+
# allowed value is 1000.
|
1677
|
+
# @param [String] page_token
|
1678
|
+
# A page token, received from a previous `ListSessions` call. Provide this to
|
1679
|
+
# retrieve the subsequent page.
|
1680
|
+
# @param [String] fields
|
1681
|
+
# Selector specifying which fields to include in a partial response.
|
1682
|
+
# @param [String] quota_user
|
1683
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1684
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1685
|
+
# @param [Google::Apis::RequestOptions] options
|
1686
|
+
# Request-specific options
|
1687
|
+
#
|
1688
|
+
# @yield [result, err] Result & error if block supplied
|
1689
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse] parsed result object
|
1690
|
+
# @yieldparam err [StandardError] error object if request failed
|
1691
|
+
#
|
1692
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse]
|
1693
|
+
#
|
1694
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1695
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1696
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1697
|
+
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)
|
1698
|
+
command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
|
1699
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
|
1700
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
|
1701
|
+
command.params['parent'] = parent unless parent.nil?
|
1702
|
+
command.query['filter'] = filter unless filter.nil?
|
1703
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
1704
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
1705
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
1706
|
+
command.query['fields'] = fields unless fields.nil?
|
1707
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1708
|
+
execute_or_queue_command(command, &block)
|
1709
|
+
end
|
1710
|
+
|
1711
|
+
# Updates a Session. Session action type cannot be changed. If the Session to
|
1712
|
+
# update does not exist, a NOT_FOUND error is returned.
|
1713
|
+
# @param [String] name
|
1714
|
+
# Immutable. Fully qualified name `projects/`project`/locations/global/
|
1715
|
+
# collections/`collection`/engines/`engine`/sessions/*`
|
1716
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
|
1717
|
+
# @param [String] update_mask
|
1718
|
+
# Indicates which fields in the provided Session to update. The following are
|
1719
|
+
# NOT supported: * Session.name If not set or empty, all supported fields are
|
1720
|
+
# updated.
|
1721
|
+
# @param [String] fields
|
1722
|
+
# Selector specifying which fields to include in a partial response.
|
1723
|
+
# @param [String] quota_user
|
1724
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1725
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1726
|
+
# @param [Google::Apis::RequestOptions] options
|
1727
|
+
# Request-specific options
|
1728
|
+
#
|
1729
|
+
# @yield [result, err] Result & error if block supplied
|
1730
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
1731
|
+
# @yieldparam err [StandardError] error object if request failed
|
1732
|
+
#
|
1733
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
1734
|
+
#
|
1735
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1736
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1737
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1738
|
+
def patch_project_location_collection_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
1739
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
1740
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
1741
|
+
command.request_object = google_cloud_discoveryengine_v1_session_object
|
1742
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
1743
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
1744
|
+
command.params['name'] = name unless name.nil?
|
1745
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
1746
|
+
command.query['fields'] = fields unless fields.nil?
|
1747
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1748
|
+
execute_or_queue_command(command, &block)
|
1749
|
+
end
|
1750
|
+
|
1751
|
+
# Gets a Answer.
|
1752
|
+
# @param [String] name
|
1753
|
+
# Required. The resource name of the Answer to get. Format: `projects/`
|
1754
|
+
# project_number`/locations/`location_id`/collections/`collection`/engines/`
|
1755
|
+
# engine_id`/sessions/`session_id`/answers/`answer_id``
|
1756
|
+
# @param [String] fields
|
1757
|
+
# Selector specifying which fields to include in a partial response.
|
1758
|
+
# @param [String] quota_user
|
1759
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1760
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1761
|
+
# @param [Google::Apis::RequestOptions] options
|
1762
|
+
# Request-specific options
|
1763
|
+
#
|
1764
|
+
# @yield [result, err] Result & error if block supplied
|
1765
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer] parsed result object
|
1766
|
+
# @yieldparam err [StandardError] error object if request failed
|
1767
|
+
#
|
1768
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
|
1769
|
+
#
|
1770
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1771
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1772
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1773
|
+
def get_project_location_collection_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
|
1774
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
1775
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
|
1776
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
|
1777
|
+
command.params['name'] = name unless name.nil?
|
1778
|
+
command.query['fields'] = fields unless fields.nil?
|
1779
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1780
|
+
execute_or_queue_command(command, &block)
|
1781
|
+
end
|
1782
|
+
|
1484
1783
|
# Verify target sites' ownership and validity. This API sends all the target
|
1485
1784
|
# sites under site search engine for verification.
|
1486
1785
|
# @param [String] parent
|
@@ -2144,7 +2443,7 @@ module Google
|
|
2144
2443
|
execute_or_queue_command(command, &block)
|
2145
2444
|
end
|
2146
2445
|
|
2147
|
-
# Bulk import of
|
2446
|
+
# Bulk import of user events. Request processing might be synchronous. Events
|
2148
2447
|
# that already exist are skipped. Use this method for backfilling historical
|
2149
2448
|
# user events. Operation.response is of type ImportResponse. Note that it is
|
2150
2449
|
# possible for a subset of the items to be successfully inserted. Operation.
|
@@ -2706,16 +3005,54 @@ module Google
|
|
2706
3005
|
execute_or_queue_command(command, &block)
|
2707
3006
|
end
|
2708
3007
|
|
3008
|
+
# Answer query method.
|
3009
|
+
# @param [String] serving_config
|
3010
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
3011
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
3012
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
3013
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
3014
|
+
# field is used to identify the serving configuration name, set of models used
|
3015
|
+
# to make the search.
|
3016
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
|
3017
|
+
# @param [String] fields
|
3018
|
+
# Selector specifying which fields to include in a partial response.
|
3019
|
+
# @param [String] quota_user
|
3020
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3021
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3022
|
+
# @param [Google::Apis::RequestOptions] options
|
3023
|
+
# Request-specific options
|
3024
|
+
#
|
3025
|
+
# @yield [result, err] Result & error if block supplied
|
3026
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
|
3027
|
+
# @yieldparam err [StandardError] error object if request failed
|
3028
|
+
#
|
3029
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
|
3030
|
+
#
|
3031
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3032
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3033
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3034
|
+
def answer_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3035
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
|
3036
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
|
3037
|
+
command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
|
3038
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
|
3039
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
|
3040
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
3041
|
+
command.query['fields'] = fields unless fields.nil?
|
3042
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3043
|
+
execute_or_queue_command(command, &block)
|
3044
|
+
end
|
3045
|
+
|
2709
3046
|
# Makes a recommendation, which requires a contextual user event.
|
2710
3047
|
# @param [String] serving_config
|
2711
3048
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
2712
3049
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
2713
3050
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
2714
|
-
# created along with your recommendation engine creation. The engine ID
|
2715
|
-
#
|
2716
|
-
#
|
2717
|
-
#
|
2718
|
-
#
|
3051
|
+
# created along with your recommendation engine creation. The engine ID is used
|
3052
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
3053
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
3054
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
3055
|
+
# your RecommendationService.Recommend requests.
|
2719
3056
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest] google_cloud_discoveryengine_v1_recommend_request_object
|
2720
3057
|
# @param [String] fields
|
2721
3058
|
# Selector specifying which fields to include in a partial response.
|
@@ -2784,10 +3121,13 @@ module Google
|
|
2784
3121
|
execute_or_queue_command(command, &block)
|
2785
3122
|
end
|
2786
3123
|
|
2787
|
-
#
|
2788
|
-
#
|
2789
|
-
# @param [String]
|
2790
|
-
#
|
3124
|
+
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
3125
|
+
# error is returned.
|
3126
|
+
# @param [String] parent
|
3127
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
3128
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3129
|
+
# data_store_id``
|
3130
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
|
2791
3131
|
# @param [String] fields
|
2792
3132
|
# Selector specifying which fields to include in a partial response.
|
2793
3133
|
# @param [String] quota_user
|
@@ -2797,19 +3137,237 @@ module Google
|
|
2797
3137
|
# Request-specific options
|
2798
3138
|
#
|
2799
3139
|
# @yield [result, err] Result & error if block supplied
|
2800
|
-
# @yieldparam result [Google::Apis::DiscoveryengineV1::
|
3140
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
2801
3141
|
# @yieldparam err [StandardError] error object if request failed
|
2802
3142
|
#
|
2803
|
-
# @return [Google::Apis::DiscoveryengineV1::
|
3143
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
2804
3144
|
#
|
2805
3145
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
2806
3146
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
2807
3147
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2808
|
-
def
|
2809
|
-
command = make_simple_command(:
|
2810
|
-
command.
|
2811
|
-
command.
|
2812
|
-
command.
|
3148
|
+
def create_project_location_collection_engine_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
3149
|
+
command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
|
3150
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
3151
|
+
command.request_object = google_cloud_discoveryengine_v1_session_object
|
3152
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
3153
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
3154
|
+
command.params['parent'] = parent unless parent.nil?
|
3155
|
+
command.query['fields'] = fields unless fields.nil?
|
3156
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3157
|
+
execute_or_queue_command(command, &block)
|
3158
|
+
end
|
3159
|
+
|
3160
|
+
# Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
|
3161
|
+
# is returned.
|
3162
|
+
# @param [String] name
|
3163
|
+
# Required. The resource name of the Session to delete. Format: `projects/`
|
3164
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3165
|
+
# data_store_id`/sessions/`session_id``
|
3166
|
+
# @param [String] fields
|
3167
|
+
# Selector specifying which fields to include in a partial response.
|
3168
|
+
# @param [String] quota_user
|
3169
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3170
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3171
|
+
# @param [Google::Apis::RequestOptions] options
|
3172
|
+
# Request-specific options
|
3173
|
+
#
|
3174
|
+
# @yield [result, err] Result & error if block supplied
|
3175
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
|
3176
|
+
# @yieldparam err [StandardError] error object if request failed
|
3177
|
+
#
|
3178
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
|
3179
|
+
#
|
3180
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3181
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3182
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3183
|
+
def delete_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
3184
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
3185
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
|
3186
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
|
3187
|
+
command.params['name'] = name unless name.nil?
|
3188
|
+
command.query['fields'] = fields unless fields.nil?
|
3189
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3190
|
+
execute_or_queue_command(command, &block)
|
3191
|
+
end
|
3192
|
+
|
3193
|
+
# Gets a Session.
|
3194
|
+
# @param [String] name
|
3195
|
+
# Required. The resource name of the Session to get. Format: `projects/`
|
3196
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
3197
|
+
# data_store_id`/sessions/`session_id``
|
3198
|
+
# @param [String] fields
|
3199
|
+
# Selector specifying which fields to include in a partial response.
|
3200
|
+
# @param [String] quota_user
|
3201
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3202
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3203
|
+
# @param [Google::Apis::RequestOptions] options
|
3204
|
+
# Request-specific options
|
3205
|
+
#
|
3206
|
+
# @yield [result, err] Result & error if block supplied
|
3207
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
3208
|
+
# @yieldparam err [StandardError] error object if request failed
|
3209
|
+
#
|
3210
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
3211
|
+
#
|
3212
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3213
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3214
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3215
|
+
def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
3216
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
3217
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
3218
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
3219
|
+
command.params['name'] = name unless name.nil?
|
3220
|
+
command.query['fields'] = fields unless fields.nil?
|
3221
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3222
|
+
execute_or_queue_command(command, &block)
|
3223
|
+
end
|
3224
|
+
|
3225
|
+
# Lists all Sessions by their parent DataStore.
|
3226
|
+
# @param [String] parent
|
3227
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
3228
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
3229
|
+
# @param [String] filter
|
3230
|
+
# A filter to apply on the list results. The supported features are:
|
3231
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
3232
|
+
# @param [String] order_by
|
3233
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
3234
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
3235
|
+
# create_time` * `session_name` Example: "update_time desc" "create_time"
|
3236
|
+
# @param [Fixnum] page_size
|
3237
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
3238
|
+
# allowed value is 1000.
|
3239
|
+
# @param [String] page_token
|
3240
|
+
# A page token, received from a previous `ListSessions` call. Provide this to
|
3241
|
+
# retrieve the subsequent page.
|
3242
|
+
# @param [String] fields
|
3243
|
+
# Selector specifying which fields to include in a partial response.
|
3244
|
+
# @param [String] quota_user
|
3245
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3246
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3247
|
+
# @param [Google::Apis::RequestOptions] options
|
3248
|
+
# Request-specific options
|
3249
|
+
#
|
3250
|
+
# @yield [result, err] Result & error if block supplied
|
3251
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse] parsed result object
|
3252
|
+
# @yieldparam err [StandardError] error object if request failed
|
3253
|
+
#
|
3254
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse]
|
3255
|
+
#
|
3256
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3257
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3258
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3259
|
+
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)
|
3260
|
+
command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
|
3261
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
|
3262
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
|
3263
|
+
command.params['parent'] = parent unless parent.nil?
|
3264
|
+
command.query['filter'] = filter unless filter.nil?
|
3265
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
3266
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
3267
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
3268
|
+
command.query['fields'] = fields unless fields.nil?
|
3269
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3270
|
+
execute_or_queue_command(command, &block)
|
3271
|
+
end
|
3272
|
+
|
3273
|
+
# Updates a Session. Session action type cannot be changed. If the Session to
|
3274
|
+
# update does not exist, a NOT_FOUND error is returned.
|
3275
|
+
# @param [String] name
|
3276
|
+
# Immutable. Fully qualified name `projects/`project`/locations/global/
|
3277
|
+
# collections/`collection`/engines/`engine`/sessions/*`
|
3278
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
|
3279
|
+
# @param [String] update_mask
|
3280
|
+
# Indicates which fields in the provided Session to update. The following are
|
3281
|
+
# NOT supported: * Session.name If not set or empty, all supported fields are
|
3282
|
+
# updated.
|
3283
|
+
# @param [String] fields
|
3284
|
+
# Selector specifying which fields to include in a partial response.
|
3285
|
+
# @param [String] quota_user
|
3286
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3287
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3288
|
+
# @param [Google::Apis::RequestOptions] options
|
3289
|
+
# Request-specific options
|
3290
|
+
#
|
3291
|
+
# @yield [result, err] Result & error if block supplied
|
3292
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
3293
|
+
# @yieldparam err [StandardError] error object if request failed
|
3294
|
+
#
|
3295
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
3296
|
+
#
|
3297
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3298
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3299
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3300
|
+
def patch_project_location_collection_engine_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
3301
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
3302
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
3303
|
+
command.request_object = google_cloud_discoveryengine_v1_session_object
|
3304
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
3305
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
3306
|
+
command.params['name'] = name unless name.nil?
|
3307
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
3308
|
+
command.query['fields'] = fields unless fields.nil?
|
3309
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3310
|
+
execute_or_queue_command(command, &block)
|
3311
|
+
end
|
3312
|
+
|
3313
|
+
# Gets a Answer.
|
3314
|
+
# @param [String] name
|
3315
|
+
# Required. The resource name of the Answer to get. Format: `projects/`
|
3316
|
+
# project_number`/locations/`location_id`/collections/`collection`/engines/`
|
3317
|
+
# engine_id`/sessions/`session_id`/answers/`answer_id``
|
3318
|
+
# @param [String] fields
|
3319
|
+
# Selector specifying which fields to include in a partial response.
|
3320
|
+
# @param [String] quota_user
|
3321
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3322
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3323
|
+
# @param [Google::Apis::RequestOptions] options
|
3324
|
+
# Request-specific options
|
3325
|
+
#
|
3326
|
+
# @yield [result, err] Result & error if block supplied
|
3327
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer] parsed result object
|
3328
|
+
# @yieldparam err [StandardError] error object if request failed
|
3329
|
+
#
|
3330
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
|
3331
|
+
#
|
3332
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3333
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3334
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3335
|
+
def get_project_location_collection_engine_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
|
3336
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
3337
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
|
3338
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
|
3339
|
+
command.params['name'] = name unless name.nil?
|
3340
|
+
command.query['fields'] = fields unless fields.nil?
|
3341
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
3342
|
+
execute_or_queue_command(command, &block)
|
3343
|
+
end
|
3344
|
+
|
3345
|
+
# Gets the latest state of a long-running operation. Clients can use this method
|
3346
|
+
# to poll the operation result at intervals as recommended by the API service.
|
3347
|
+
# @param [String] name
|
3348
|
+
# The name of the operation resource.
|
3349
|
+
# @param [String] fields
|
3350
|
+
# Selector specifying which fields to include in a partial response.
|
3351
|
+
# @param [String] quota_user
|
3352
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
3353
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
3354
|
+
# @param [Google::Apis::RequestOptions] options
|
3355
|
+
# Request-specific options
|
3356
|
+
#
|
3357
|
+
# @yield [result, err] Result & error if block supplied
|
3358
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation] parsed result object
|
3359
|
+
# @yieldparam err [StandardError] error object if request failed
|
3360
|
+
#
|
3361
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation]
|
3362
|
+
#
|
3363
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
3364
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
3365
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
3366
|
+
def get_project_location_collection_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
3367
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
3368
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation::Representation
|
3369
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleLongrunningOperation
|
3370
|
+
command.params['name'] = name unless name.nil?
|
2813
3371
|
command.query['fields'] = fields unless fields.nil?
|
2814
3372
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2815
3373
|
execute_or_queue_command(command, &block)
|
@@ -3163,14 +3721,14 @@ module Google
|
|
3163
3721
|
# location`/collections/`collection`/dataStores/`data_store`/branches/`branch``.
|
3164
3722
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
|
3165
3723
|
# @param [String] document_id
|
3166
|
-
# Required. The ID to use for the Document, which
|
3167
|
-
#
|
3168
|
-
#
|
3169
|
-
#
|
3170
|
-
#
|
3171
|
-
#
|
3172
|
-
#
|
3173
|
-
#
|
3724
|
+
# Required. The ID to use for the Document, which becomes the final component of
|
3725
|
+
# the Document.name. If the caller does not have permission to create the
|
3726
|
+
# Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error
|
3727
|
+
# is returned. This field must be unique among all Documents with the same
|
3728
|
+
# parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must
|
3729
|
+
# conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a
|
3730
|
+
# length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is
|
3731
|
+
# returned.
|
3174
3732
|
# @param [String] fields
|
3175
3733
|
# Selector specifying which fields to include in a partial response.
|
3176
3734
|
# @param [String] quota_user
|
@@ -3272,8 +3830,8 @@ module Google
|
|
3272
3830
|
end
|
3273
3831
|
|
3274
3832
|
# Bulk import of multiple Documents. Request processing may be synchronous. Non-
|
3275
|
-
# existing items
|
3276
|
-
#
|
3833
|
+
# existing items are created. Note: It is possible for a subset of the Documents
|
3834
|
+
# to be successfully updated.
|
3277
3835
|
# @param [String] parent
|
3278
3836
|
# Required. The parent branch resource name, such as `projects/`project`/
|
3279
3837
|
# locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
|
@@ -3318,8 +3876,8 @@ module Google
|
|
3318
3876
|
# PERMISSION_DENIED` error is returned.
|
3319
3877
|
# @param [Fixnum] page_size
|
3320
3878
|
# Maximum number of Documents to return. If unspecified, defaults to 100. The
|
3321
|
-
# maximum allowed value is 1000. Values above 1000
|
3322
|
-
#
|
3879
|
+
# maximum allowed value is 1000. Values above 1000 are set to 1000. If this
|
3880
|
+
# field is negative, an `INVALID_ARGUMENT` error is returned.
|
3323
3881
|
# @param [String] page_token
|
3324
3882
|
# A page token ListDocumentsResponse.next_page_token, received from a previous
|
3325
3883
|
# DocumentService.ListDocuments call. Provide this to retrieve the subsequent
|
@@ -3363,10 +3921,10 @@ module Google
|
|
3363
3921
|
# with a length limit of 1024 characters.
|
3364
3922
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Document] google_cloud_discoveryengine_v1_document_object
|
3365
3923
|
# @param [Boolean] allow_missing
|
3366
|
-
# If set to true
|
3924
|
+
# If set to `true` and the Document is not found, a new Document is be created.
|
3367
3925
|
# @param [String] update_mask
|
3368
3926
|
# Indicates which fields in the provided imported 'document' to update. If not
|
3369
|
-
# set,
|
3927
|
+
# set, by default updates all fields.
|
3370
3928
|
# @param [String] fields
|
3371
3929
|
# Selector specifying which fields to include in a partial response.
|
3372
3930
|
# @param [String] quota_user
|
@@ -3437,6 +3995,46 @@ module Google
|
|
3437
3995
|
execute_or_queue_command(command, &block)
|
3438
3996
|
end
|
3439
3997
|
|
3998
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
3999
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
4000
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
4001
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
4002
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
4003
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
4004
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
4005
|
+
# corresponding to `Code.CANCELLED`.
|
4006
|
+
# @param [String] name
|
4007
|
+
# The name of the operation resource to be cancelled.
|
4008
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
|
4009
|
+
# @param [String] fields
|
4010
|
+
# Selector specifying which fields to include in a partial response.
|
4011
|
+
# @param [String] quota_user
|
4012
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4013
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4014
|
+
# @param [Google::Apis::RequestOptions] options
|
4015
|
+
# Request-specific options
|
4016
|
+
#
|
4017
|
+
# @yield [result, err] Result & error if block supplied
|
4018
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
|
4019
|
+
# @yieldparam err [StandardError] error object if request failed
|
4020
|
+
#
|
4021
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
|
4022
|
+
#
|
4023
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4024
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4025
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4026
|
+
def cancel_project_location_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4027
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
4028
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
|
4029
|
+
command.request_object = google_longrunning_cancel_operation_request_object
|
4030
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
|
4031
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
|
4032
|
+
command.params['name'] = name unless name.nil?
|
4033
|
+
command.query['fields'] = fields unless fields.nil?
|
4034
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4035
|
+
execute_or_queue_command(command, &block)
|
4036
|
+
end
|
4037
|
+
|
3440
4038
|
# Gets the latest state of a long-running operation. Clients can use this method
|
3441
4039
|
# to poll the operation result at intervals as recommended by the API service.
|
3442
4040
|
# @param [String] name
|
@@ -3885,8 +4483,8 @@ module Google
|
|
3885
4483
|
# .
|
3886
4484
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
|
3887
4485
|
# @param [String] schema_id
|
3888
|
-
# Required. The ID to use for the Schema, which
|
3889
|
-
#
|
4486
|
+
# Required. The ID to use for the Schema, which becomes the final component of
|
4487
|
+
# the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.
|
3890
4488
|
# org/html/rfc1034) standard with a length limit of 63 characters.
|
3891
4489
|
# @param [String] fields
|
3892
4490
|
# Selector specifying which fields to include in a partial response.
|
@@ -3989,8 +4587,8 @@ module Google
|
|
3989
4587
|
# .
|
3990
4588
|
# @param [Fixnum] page_size
|
3991
4589
|
# The maximum number of Schemas to return. The service may return fewer than
|
3992
|
-
# this value. If unspecified, at most 100 Schemas
|
3993
|
-
# value is 1000; values above 1000
|
4590
|
+
# this value. If unspecified, at most 100 Schemas are returned. The maximum
|
4591
|
+
# value is 1000; values above 1000 are set to 1000.
|
3994
4592
|
# @param [String] page_token
|
3995
4593
|
# A page token, received from a previous SchemaService.ListSchemas call. Provide
|
3996
4594
|
# this to retrieve the subsequent page. When paginating, all other parameters
|
@@ -4033,8 +4631,8 @@ module Google
|
|
4033
4631
|
# limit of 1024 characters.
|
4034
4632
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Schema] google_cloud_discoveryengine_v1_schema_object
|
4035
4633
|
# @param [Boolean] allow_missing
|
4036
|
-
# If set to true, and the Schema is not found, a new Schema
|
4037
|
-
#
|
4634
|
+
# If set to true, and the Schema is not found, a new Schema is created. In this
|
4635
|
+
# situation, `update_mask` is ignored.
|
4038
4636
|
# @param [String] fields
|
4039
4637
|
# Selector specifying which fields to include in a partial response.
|
4040
4638
|
# @param [String] quota_user
|
@@ -4065,16 +4663,54 @@ module Google
|
|
4065
4663
|
execute_or_queue_command(command, &block)
|
4066
4664
|
end
|
4067
4665
|
|
4666
|
+
# Answer query method.
|
4667
|
+
# @param [String] serving_config
|
4668
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
4669
|
+
# locations/global/collections/default_collection/engines/*/servingConfigs/
|
4670
|
+
# default_serving_config`, or `projects/*/locations/global/collections/
|
4671
|
+
# default_collection/dataStores/*/servingConfigs/default_serving_config`. This
|
4672
|
+
# field is used to identify the serving configuration name, set of models used
|
4673
|
+
# to make the search.
|
4674
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest] google_cloud_discoveryengine_v1_answer_query_request_object
|
4675
|
+
# @param [String] fields
|
4676
|
+
# Selector specifying which fields to include in a partial response.
|
4677
|
+
# @param [String] quota_user
|
4678
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4679
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4680
|
+
# @param [Google::Apis::RequestOptions] options
|
4681
|
+
# Request-specific options
|
4682
|
+
#
|
4683
|
+
# @yield [result, err] Result & error if block supplied
|
4684
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse] parsed result object
|
4685
|
+
# @yieldparam err [StandardError] error object if request failed
|
4686
|
+
#
|
4687
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse]
|
4688
|
+
#
|
4689
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4690
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4691
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4692
|
+
def answer_project_location_data_store_serving_config(serving_config, google_cloud_discoveryengine_v1_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4693
|
+
command = make_simple_command(:post, 'v1/{+servingConfig}:answer', options)
|
4694
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryRequest::Representation
|
4695
|
+
command.request_object = google_cloud_discoveryengine_v1_answer_query_request_object
|
4696
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse::Representation
|
4697
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1AnswerQueryResponse
|
4698
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
4699
|
+
command.query['fields'] = fields unless fields.nil?
|
4700
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4701
|
+
execute_or_queue_command(command, &block)
|
4702
|
+
end
|
4703
|
+
|
4068
4704
|
# Makes a recommendation, which requires a contextual user event.
|
4069
4705
|
# @param [String] serving_config
|
4070
4706
|
# Required. Full resource name of a ServingConfig: `projects/*/locations/global/
|
4071
4707
|
# collections/*/engines/*/servingConfigs/*`, or `projects/*/locations/global/
|
4072
4708
|
# collections/*/dataStores/*/servingConfigs/*` One default serving config is
|
4073
|
-
# created along with your recommendation engine creation. The engine ID
|
4074
|
-
#
|
4075
|
-
#
|
4076
|
-
#
|
4077
|
-
#
|
4709
|
+
# created along with your recommendation engine creation. The engine ID is used
|
4710
|
+
# as the ID of the default serving config. For example, for Engine `projects/*/
|
4711
|
+
# locations/global/collections/*/engines/my-engine`, you can use `projects/*/
|
4712
|
+
# locations/global/collections/*/engines/my-engine/servingConfigs/my-engine` for
|
4713
|
+
# your RecommendationService.Recommend requests.
|
4078
4714
|
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RecommendRequest] google_cloud_discoveryengine_v1_recommend_request_object
|
4079
4715
|
# @param [String] fields
|
4080
4716
|
# Selector specifying which fields to include in a partial response.
|
@@ -4143,6 +4779,227 @@ module Google
|
|
4143
4779
|
execute_or_queue_command(command, &block)
|
4144
4780
|
end
|
4145
4781
|
|
4782
|
+
# Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
|
4783
|
+
# error is returned.
|
4784
|
+
# @param [String] parent
|
4785
|
+
# Required. Full resource name of parent data store. Format: `projects/`
|
4786
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
4787
|
+
# data_store_id``
|
4788
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
|
4789
|
+
# @param [String] fields
|
4790
|
+
# Selector specifying which fields to include in a partial response.
|
4791
|
+
# @param [String] quota_user
|
4792
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4793
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4794
|
+
# @param [Google::Apis::RequestOptions] options
|
4795
|
+
# Request-specific options
|
4796
|
+
#
|
4797
|
+
# @yield [result, err] Result & error if block supplied
|
4798
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
4799
|
+
# @yieldparam err [StandardError] error object if request failed
|
4800
|
+
#
|
4801
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
4802
|
+
#
|
4803
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4804
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4805
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4806
|
+
def create_project_location_data_store_session(parent, google_cloud_discoveryengine_v1_session_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
4807
|
+
command = make_simple_command(:post, 'v1/{+parent}/sessions', options)
|
4808
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
4809
|
+
command.request_object = google_cloud_discoveryengine_v1_session_object
|
4810
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
4811
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
4812
|
+
command.params['parent'] = parent unless parent.nil?
|
4813
|
+
command.query['fields'] = fields unless fields.nil?
|
4814
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4815
|
+
execute_or_queue_command(command, &block)
|
4816
|
+
end
|
4817
|
+
|
4818
|
+
# Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error
|
4819
|
+
# is returned.
|
4820
|
+
# @param [String] name
|
4821
|
+
# Required. The resource name of the Session to delete. Format: `projects/`
|
4822
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
4823
|
+
# data_store_id`/sessions/`session_id``
|
4824
|
+
# @param [String] fields
|
4825
|
+
# Selector specifying which fields to include in a partial response.
|
4826
|
+
# @param [String] quota_user
|
4827
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4828
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4829
|
+
# @param [Google::Apis::RequestOptions] options
|
4830
|
+
# Request-specific options
|
4831
|
+
#
|
4832
|
+
# @yield [result, err] Result & error if block supplied
|
4833
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
|
4834
|
+
# @yieldparam err [StandardError] error object if request failed
|
4835
|
+
#
|
4836
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
|
4837
|
+
#
|
4838
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4839
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4840
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4841
|
+
def delete_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
4842
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
4843
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
|
4844
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
|
4845
|
+
command.params['name'] = name unless name.nil?
|
4846
|
+
command.query['fields'] = fields unless fields.nil?
|
4847
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4848
|
+
execute_or_queue_command(command, &block)
|
4849
|
+
end
|
4850
|
+
|
4851
|
+
# Gets a Session.
|
4852
|
+
# @param [String] name
|
4853
|
+
# Required. The resource name of the Session to get. Format: `projects/`
|
4854
|
+
# project_number`/locations/`location_id`/collections/`collection`/dataStores/`
|
4855
|
+
# data_store_id`/sessions/`session_id``
|
4856
|
+
# @param [String] fields
|
4857
|
+
# Selector specifying which fields to include in a partial response.
|
4858
|
+
# @param [String] quota_user
|
4859
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4860
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4861
|
+
# @param [Google::Apis::RequestOptions] options
|
4862
|
+
# Request-specific options
|
4863
|
+
#
|
4864
|
+
# @yield [result, err] Result & error if block supplied
|
4865
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
4866
|
+
# @yieldparam err [StandardError] error object if request failed
|
4867
|
+
#
|
4868
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
4869
|
+
#
|
4870
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4871
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4872
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4873
|
+
def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
|
4874
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
4875
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
4876
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
4877
|
+
command.params['name'] = name unless name.nil?
|
4878
|
+
command.query['fields'] = fields unless fields.nil?
|
4879
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4880
|
+
execute_or_queue_command(command, &block)
|
4881
|
+
end
|
4882
|
+
|
4883
|
+
# Lists all Sessions by their parent DataStore.
|
4884
|
+
# @param [String] parent
|
4885
|
+
# Required. The data store resource name. Format: `projects/`project_number`/
|
4886
|
+
# locations/`location_id`/collections/`collection`/dataStores/`data_store_id``
|
4887
|
+
# @param [String] filter
|
4888
|
+
# A filter to apply on the list results. The supported features are:
|
4889
|
+
# user_pseudo_id, state. Example: "user_pseudo_id = some_id"
|
4890
|
+
# @param [String] order_by
|
4891
|
+
# A comma-separated list of fields to order by, sorted in ascending order. Use "
|
4892
|
+
# desc" after a field name for descending. Supported fields: * `update_time` * `
|
4893
|
+
# create_time` * `session_name` Example: "update_time desc" "create_time"
|
4894
|
+
# @param [Fixnum] page_size
|
4895
|
+
# Maximum number of results to return. If unspecified, defaults to 50. Max
|
4896
|
+
# allowed value is 1000.
|
4897
|
+
# @param [String] page_token
|
4898
|
+
# A page token, received from a previous `ListSessions` call. Provide this to
|
4899
|
+
# retrieve the subsequent page.
|
4900
|
+
# @param [String] fields
|
4901
|
+
# Selector specifying which fields to include in a partial response.
|
4902
|
+
# @param [String] quota_user
|
4903
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4904
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4905
|
+
# @param [Google::Apis::RequestOptions] options
|
4906
|
+
# Request-specific options
|
4907
|
+
#
|
4908
|
+
# @yield [result, err] Result & error if block supplied
|
4909
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse] parsed result object
|
4910
|
+
# @yieldparam err [StandardError] error object if request failed
|
4911
|
+
#
|
4912
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse]
|
4913
|
+
#
|
4914
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4915
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4916
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4917
|
+
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)
|
4918
|
+
command = make_simple_command(:get, 'v1/{+parent}/sessions', options)
|
4919
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse::Representation
|
4920
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ListSessionsResponse
|
4921
|
+
command.params['parent'] = parent unless parent.nil?
|
4922
|
+
command.query['filter'] = filter unless filter.nil?
|
4923
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
4924
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
4925
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
4926
|
+
command.query['fields'] = fields unless fields.nil?
|
4927
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4928
|
+
execute_or_queue_command(command, &block)
|
4929
|
+
end
|
4930
|
+
|
4931
|
+
# Updates a Session. Session action type cannot be changed. If the Session to
|
4932
|
+
# update does not exist, a NOT_FOUND error is returned.
|
4933
|
+
# @param [String] name
|
4934
|
+
# Immutable. Fully qualified name `projects/`project`/locations/global/
|
4935
|
+
# collections/`collection`/engines/`engine`/sessions/*`
|
4936
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] google_cloud_discoveryengine_v1_session_object
|
4937
|
+
# @param [String] update_mask
|
4938
|
+
# Indicates which fields in the provided Session to update. The following are
|
4939
|
+
# NOT supported: * Session.name If not set or empty, all supported fields are
|
4940
|
+
# updated.
|
4941
|
+
# @param [String] fields
|
4942
|
+
# Selector specifying which fields to include in a partial response.
|
4943
|
+
# @param [String] quota_user
|
4944
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4945
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4946
|
+
# @param [Google::Apis::RequestOptions] options
|
4947
|
+
# Request-specific options
|
4948
|
+
#
|
4949
|
+
# @yield [result, err] Result & error if block supplied
|
4950
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session] parsed result object
|
4951
|
+
# @yieldparam err [StandardError] error object if request failed
|
4952
|
+
#
|
4953
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session]
|
4954
|
+
#
|
4955
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4956
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4957
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4958
|
+
def patch_project_location_data_store_session(name, google_cloud_discoveryengine_v1_session_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
4959
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
4960
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
4961
|
+
command.request_object = google_cloud_discoveryengine_v1_session_object
|
4962
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session::Representation
|
4963
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Session
|
4964
|
+
command.params['name'] = name unless name.nil?
|
4965
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
4966
|
+
command.query['fields'] = fields unless fields.nil?
|
4967
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
4968
|
+
execute_or_queue_command(command, &block)
|
4969
|
+
end
|
4970
|
+
|
4971
|
+
# Gets a Answer.
|
4972
|
+
# @param [String] name
|
4973
|
+
# Required. The resource name of the Answer to get. Format: `projects/`
|
4974
|
+
# project_number`/locations/`location_id`/collections/`collection`/engines/`
|
4975
|
+
# engine_id`/sessions/`session_id`/answers/`answer_id``
|
4976
|
+
# @param [String] fields
|
4977
|
+
# Selector specifying which fields to include in a partial response.
|
4978
|
+
# @param [String] quota_user
|
4979
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
4980
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
4981
|
+
# @param [Google::Apis::RequestOptions] options
|
4982
|
+
# Request-specific options
|
4983
|
+
#
|
4984
|
+
# @yield [result, err] Result & error if block supplied
|
4985
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer] parsed result object
|
4986
|
+
# @yieldparam err [StandardError] error object if request failed
|
4987
|
+
#
|
4988
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer]
|
4989
|
+
#
|
4990
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
4991
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
4992
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
4993
|
+
def get_project_location_data_store_session_answer(name, fields: nil, quota_user: nil, options: nil, &block)
|
4994
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
4995
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer::Representation
|
4996
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1Answer
|
4997
|
+
command.params['name'] = name unless name.nil?
|
4998
|
+
command.query['fields'] = fields unless fields.nil?
|
4999
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5000
|
+
execute_or_queue_command(command, &block)
|
5001
|
+
end
|
5002
|
+
|
4146
5003
|
# Downgrade from advanced site search to basic site search.
|
4147
5004
|
# @param [String] site_search_engine
|
4148
5005
|
# Required. Full resource name of the SiteSearchEngine, such as `projects/`
|
@@ -4583,7 +5440,7 @@ module Google
|
|
4583
5440
|
execute_or_queue_command(command, &block)
|
4584
5441
|
end
|
4585
5442
|
|
4586
|
-
# Bulk import of
|
5443
|
+
# Bulk import of user events. Request processing might be synchronous. Events
|
4587
5444
|
# that already exist are skipped. Use this method for backfilling historical
|
4588
5445
|
# user events. Operation.response is of type ImportResponse. Note that it is
|
4589
5446
|
# possible for a subset of the items to be successfully inserted. Operation.
|
@@ -4659,6 +5516,40 @@ module Google
|
|
4659
5516
|
execute_or_queue_command(command, &block)
|
4660
5517
|
end
|
4661
5518
|
|
5519
|
+
# Performs a grounding check.
|
5520
|
+
# @param [String] grounding_config
|
5521
|
+
# Required. The resource name of the grounding config, such as `projects/*/
|
5522
|
+
# locations/global/groundingConfigs/default_grounding_config`.
|
5523
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingRequest] google_cloud_discoveryengine_v1_check_grounding_request_object
|
5524
|
+
# @param [String] fields
|
5525
|
+
# Selector specifying which fields to include in a partial response.
|
5526
|
+
# @param [String] quota_user
|
5527
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5528
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5529
|
+
# @param [Google::Apis::RequestOptions] options
|
5530
|
+
# Request-specific options
|
5531
|
+
#
|
5532
|
+
# @yield [result, err] Result & error if block supplied
|
5533
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse] parsed result object
|
5534
|
+
# @yieldparam err [StandardError] error object if request failed
|
5535
|
+
#
|
5536
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse]
|
5537
|
+
#
|
5538
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5539
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5540
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5541
|
+
def check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5542
|
+
command = make_simple_command(:post, 'v1/{+groundingConfig}:check', options)
|
5543
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingRequest::Representation
|
5544
|
+
command.request_object = google_cloud_discoveryengine_v1_check_grounding_request_object
|
5545
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse::Representation
|
5546
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse
|
5547
|
+
command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
|
5548
|
+
command.query['fields'] = fields unless fields.nil?
|
5549
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5550
|
+
execute_or_queue_command(command, &block)
|
5551
|
+
end
|
5552
|
+
|
4662
5553
|
# Gets the latest state of a long-running operation. Clients can use this method
|
4663
5554
|
# to poll the operation result at intervals as recommended by the API service.
|
4664
5555
|
# @param [String] name
|
@@ -4730,6 +5621,40 @@ module Google
|
|
4730
5621
|
execute_or_queue_command(command, &block)
|
4731
5622
|
end
|
4732
5623
|
|
5624
|
+
# Ranks a list of text records based on the given input query.
|
5625
|
+
# @param [String] ranking_config
|
5626
|
+
# Required. The resource name of the rank service config, such as `projects/`
|
5627
|
+
# project_num`/locations/`location_id`/rankingConfigs/default_ranking_config`.
|
5628
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankRequest] google_cloud_discoveryengine_v1_rank_request_object
|
5629
|
+
# @param [String] fields
|
5630
|
+
# Selector specifying which fields to include in a partial response.
|
5631
|
+
# @param [String] quota_user
|
5632
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5633
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5634
|
+
# @param [Google::Apis::RequestOptions] options
|
5635
|
+
# Request-specific options
|
5636
|
+
#
|
5637
|
+
# @yield [result, err] Result & error if block supplied
|
5638
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse] parsed result object
|
5639
|
+
# @yieldparam err [StandardError] error object if request failed
|
5640
|
+
#
|
5641
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse]
|
5642
|
+
#
|
5643
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5644
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5645
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5646
|
+
def rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1_rank_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5647
|
+
command = make_simple_command(:post, 'v1/{+rankingConfig}:rank', options)
|
5648
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankRequest::Representation
|
5649
|
+
command.request_object = google_cloud_discoveryengine_v1_rank_request_object
|
5650
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse::Representation
|
5651
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1RankResponse
|
5652
|
+
command.params['rankingConfig'] = ranking_config unless ranking_config.nil?
|
5653
|
+
command.query['fields'] = fields unless fields.nil?
|
5654
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5655
|
+
execute_or_queue_command(command, &block)
|
5656
|
+
end
|
5657
|
+
|
4733
5658
|
# Writes a single user event.
|
4734
5659
|
# @param [String] parent
|
4735
5660
|
# Required. The parent resource name. If the write user event action is applied
|
@@ -4768,6 +5693,46 @@ module Google
|
|
4768
5693
|
execute_or_queue_command(command, &block)
|
4769
5694
|
end
|
4770
5695
|
|
5696
|
+
# Starts asynchronous cancellation on a long-running operation. The server makes
|
5697
|
+
# a best effort to cancel the operation, but success is not guaranteed. If the
|
5698
|
+
# server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
5699
|
+
# Clients can use Operations.GetOperation or other methods to check whether the
|
5700
|
+
# cancellation succeeded or whether the operation completed despite cancellation.
|
5701
|
+
# On successful cancellation, the operation is not deleted; instead, it becomes
|
5702
|
+
# an operation with an Operation.error value with a google.rpc.Status.code of 1,
|
5703
|
+
# corresponding to `Code.CANCELLED`.
|
5704
|
+
# @param [String] name
|
5705
|
+
# The name of the operation resource to be cancelled.
|
5706
|
+
# @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
|
5707
|
+
# @param [String] fields
|
5708
|
+
# Selector specifying which fields to include in a partial response.
|
5709
|
+
# @param [String] quota_user
|
5710
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5711
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5712
|
+
# @param [Google::Apis::RequestOptions] options
|
5713
|
+
# Request-specific options
|
5714
|
+
#
|
5715
|
+
# @yield [result, err] Result & error if block supplied
|
5716
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
|
5717
|
+
# @yieldparam err [StandardError] error object if request failed
|
5718
|
+
#
|
5719
|
+
# @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
|
5720
|
+
#
|
5721
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5722
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5723
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5724
|
+
def cancel_project_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5725
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
5726
|
+
command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
|
5727
|
+
command.request_object = google_longrunning_cancel_operation_request_object
|
5728
|
+
command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
|
5729
|
+
command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
|
5730
|
+
command.params['name'] = name unless name.nil?
|
5731
|
+
command.query['fields'] = fields unless fields.nil?
|
5732
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5733
|
+
execute_or_queue_command(command, &block)
|
5734
|
+
end
|
5735
|
+
|
4771
5736
|
# Gets the latest state of a long-running operation. Clients can use this method
|
4772
5737
|
# to poll the operation result at intervals as recommended by the API service.
|
4773
5738
|
# @param [String] name
|