google-apis-discoveryengine_v1beta 0.23.0 → 0.25.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 +8 -0
- data/lib/google/apis/discoveryengine_v1beta/classes.rb +24 -28
- data/lib/google/apis/discoveryengine_v1beta/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1beta/representations.rb +0 -14
- data/lib/google/apis/discoveryengine_v1beta/service.rb +72 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c9103590e0341da5df58fae900ae5432e91e7fa43f91118c8c64015f960a0007
|
4
|
+
data.tar.gz: f8b0f124966244bdd8e2f555c5339551e412974175a16e15875bacb46d25027d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 22f9e9431d89df3e72625efd91e621bb9e2753652e7e50ef1fd68c0b192d017e288d22e20b80828cef5438936f39850b93991cf1be92918bacebf7c722eddd9d
|
7
|
+
data.tar.gz: 7f26b837271a77ad684b02204e4cc53716cee07037925162da6918f6e457a66962a049b2095a66227f3698ff0cfeb2cbdc1ecd72a661788c1a36e9faff505d05
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1beta
|
2
2
|
|
3
|
+
### v0.25.0 (2023-10-22)
|
4
|
+
|
5
|
+
* Regenerated from discovery document revision 20231016
|
6
|
+
|
7
|
+
### v0.24.0 (2023-10-15)
|
8
|
+
|
9
|
+
* Regenerated from discovery document revision 20231003
|
10
|
+
|
3
11
|
### v0.23.0 (2023-10-08)
|
4
12
|
|
5
13
|
* Regenerated from discovery document revision 20230928
|
@@ -622,25 +622,6 @@ module Google
|
|
622
622
|
end
|
623
623
|
end
|
624
624
|
|
625
|
-
# Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
626
|
-
class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
|
627
|
-
include Google::Apis::Core::Hashable
|
628
|
-
|
629
|
-
# TargetSites created.
|
630
|
-
# Corresponds to the JSON property `targetSites`
|
631
|
-
# @return [Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite>]
|
632
|
-
attr_accessor :target_sites
|
633
|
-
|
634
|
-
def initialize(**args)
|
635
|
-
update!(**args)
|
636
|
-
end
|
637
|
-
|
638
|
-
# Update properties of this object
|
639
|
-
def update!(**args)
|
640
|
-
@target_sites = args[:target_sites] if args.key?(:target_sites)
|
641
|
-
end
|
642
|
-
end
|
643
|
-
|
644
625
|
# Metadata for Create Schema LRO.
|
645
626
|
class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
|
646
627
|
include Google::Apis::Core::Hashable
|
@@ -2770,11 +2751,16 @@ module Google
|
|
2770
2751
|
# characters. Currently, only filter expressions on the `filter_tags` attribute
|
2771
2752
|
# is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags:
|
2772
2753
|
# ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
|
2773
|
-
# ANY("Green"))` If
|
2774
|
-
#
|
2775
|
-
#
|
2776
|
-
#
|
2777
|
-
#
|
2754
|
+
# ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params`
|
2755
|
+
# field, then attribute-based expressions are expected instead of the above
|
2756
|
+
# described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
|
2757
|
+
# categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
|
2758
|
+
# OR (categories: ANY("Movie")) If your filter blocks all results, the API will
|
2759
|
+
# return generic (unfiltered) popular Documents. If you only want results
|
2760
|
+
# strictly matching the filters, set `strictFiltering` to True in
|
2761
|
+
# RecommendRequest.params to receive empty results instead. Note that the API
|
2762
|
+
# will never return Documents with `storageStatus` of `EXPIRED` or `DELETED`
|
2763
|
+
# regardless of filter choices.
|
2778
2764
|
# Corresponds to the JSON property `filter`
|
2779
2765
|
# @return [String]
|
2780
2766
|
attr_accessor :filter
|
@@ -2799,7 +2785,9 @@ module Google
|
|
2799
2785
|
# recommendation results. * `diversityLevel`: String. Default empty. If set to
|
2800
2786
|
# be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` *
|
2801
2787
|
# `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-
|
2802
|
-
# level control and adjusts recommendation results based on Document category.
|
2788
|
+
# level control and adjusts recommendation results based on Document category. *
|
2789
|
+
# `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `
|
2790
|
+
# filter` field is interpreted according to the new, attribute-based syntax.
|
2803
2791
|
# Corresponds to the JSON property `params`
|
2804
2792
|
# @return [Hash<String,Object>]
|
2805
2793
|
attr_accessor :params
|
@@ -3111,7 +3099,14 @@ module Google
|
|
3111
3099
|
# The filter syntax consists of an expression language for constructing a
|
3112
3100
|
# predicate from one or more fields of the documents being filtered. Filter
|
3113
3101
|
# expression is case-sensitive. If this field is unrecognizable, an `
|
3114
|
-
# INVALID_ARGUMENT` is returned.
|
3102
|
+
# INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
|
3103
|
+
# mapping the LHS filter key to a key property defined in the Vertex AI Search
|
3104
|
+
# backend -- this mapping is defined by the customer in their schema. For
|
3105
|
+
# example a media customer might have a field 'name' in their schema. In this
|
3106
|
+
# case the filter would look like this: filter --> name:'ANY("king kong")' For
|
3107
|
+
# more information about filtering including syntax and filter operators, see [
|
3108
|
+
# Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
|
3109
|
+
# metadata)
|
3115
3110
|
# Corresponds to the JSON property `filter`
|
3116
3111
|
# @return [String]
|
3117
3112
|
attr_accessor :filter
|
@@ -3131,8 +3126,9 @@ module Google
|
|
3131
3126
|
|
3132
3127
|
# The order in which documents are returned. Documents can be ordered by a field
|
3133
3128
|
# in an Document object. Leave it unset if ordered by relevance. `order_by`
|
3134
|
-
# expression is case-sensitive.
|
3135
|
-
#
|
3129
|
+
# expression is case-sensitive. For more information on ordering, see [Ordering](
|
3130
|
+
# https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
|
3131
|
+
# unrecognizable, an `INVALID_ARGUMENT` is returned.
|
3136
3132
|
# Corresponds to the JSON property `orderBy`
|
3137
3133
|
# @return [String]
|
3138
3134
|
attr_accessor :order_by
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DiscoveryengineV1beta
|
18
18
|
# Version of the google-apis-discoveryengine_v1beta gem
|
19
|
-
GEM_VERSION = "0.
|
19
|
+
GEM_VERSION = "0.25.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
22
|
GENERATOR_VERSION = "0.12.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
25
|
+
REVISION = "20231016"
|
26
26
|
end
|
27
27
|
end
|
28
28
|
end
|
@@ -130,12 +130,6 @@ module Google
|
|
130
130
|
include Google::Apis::Core::JsonObjectSupport
|
131
131
|
end
|
132
132
|
|
133
|
-
class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
|
134
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
135
|
-
|
136
|
-
include Google::Apis::Core::JsonObjectSupport
|
137
|
-
end
|
138
|
-
|
139
133
|
class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
|
140
134
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
141
135
|
|
@@ -898,14 +892,6 @@ module Google
|
|
898
892
|
end
|
899
893
|
end
|
900
894
|
|
901
|
-
class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
|
902
|
-
# @private
|
903
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
904
|
-
collection :target_sites, as: 'targetSites', class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite, decorator: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
|
905
|
-
|
906
|
-
end
|
907
|
-
end
|
908
|
-
|
909
895
|
class GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata
|
910
896
|
# @private
|
911
897
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1490,6 +1490,78 @@ module Google
|
|
1490
1490
|
execute_or_queue_command(command, &block)
|
1491
1491
|
end
|
1492
1492
|
|
1493
|
+
# Makes a recommendation, which requires a contextual user event.
|
1494
|
+
# @param [String] serving_config
|
1495
|
+
# Required. Full resource name of the format: `projects/*/locations/global/
|
1496
|
+
# collections/*/dataStores/*/servingConfigs/*` Before you can request
|
1497
|
+
# recommendations from your model, you must create at least one serving config
|
1498
|
+
# for it.
|
1499
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest] google_cloud_discoveryengine_v1beta_recommend_request_object
|
1500
|
+
# @param [String] fields
|
1501
|
+
# Selector specifying which fields to include in a partial response.
|
1502
|
+
# @param [String] quota_user
|
1503
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1504
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1505
|
+
# @param [Google::Apis::RequestOptions] options
|
1506
|
+
# Request-specific options
|
1507
|
+
#
|
1508
|
+
# @yield [result, err] Result & error if block supplied
|
1509
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse] parsed result object
|
1510
|
+
# @yieldparam err [StandardError] error object if request failed
|
1511
|
+
#
|
1512
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse]
|
1513
|
+
#
|
1514
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1515
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1516
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1517
|
+
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)
|
1518
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:recommend', options)
|
1519
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendRequest::Representation
|
1520
|
+
command.request_object = google_cloud_discoveryengine_v1beta_recommend_request_object
|
1521
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse::Representation
|
1522
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaRecommendResponse
|
1523
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1524
|
+
command.query['fields'] = fields unless fields.nil?
|
1525
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1526
|
+
execute_or_queue_command(command, &block)
|
1527
|
+
end
|
1528
|
+
|
1529
|
+
# Performs a search.
|
1530
|
+
# @param [String] serving_config
|
1531
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
1532
|
+
# locations/global/collections/default_collection/dataStores/default_data_store/
|
1533
|
+
# servingConfigs/default_serving_config`. This field is used to identify the
|
1534
|
+
# serving configuration name, set of models used to make the search.
|
1535
|
+
# @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest] google_cloud_discoveryengine_v1beta_search_request_object
|
1536
|
+
# @param [String] fields
|
1537
|
+
# Selector specifying which fields to include in a partial response.
|
1538
|
+
# @param [String] quota_user
|
1539
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1540
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1541
|
+
# @param [Google::Apis::RequestOptions] options
|
1542
|
+
# Request-specific options
|
1543
|
+
#
|
1544
|
+
# @yield [result, err] Result & error if block supplied
|
1545
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse] parsed result object
|
1546
|
+
# @yieldparam err [StandardError] error object if request failed
|
1547
|
+
#
|
1548
|
+
# @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse]
|
1549
|
+
#
|
1550
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1551
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1552
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1553
|
+
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)
|
1554
|
+
command = make_simple_command(:post, 'v1beta/{+servingConfig}:search', options)
|
1555
|
+
command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchRequest::Representation
|
1556
|
+
command.request_object = google_cloud_discoveryengine_v1beta_search_request_object
|
1557
|
+
command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse::Representation
|
1558
|
+
command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSearchResponse
|
1559
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1560
|
+
command.query['fields'] = fields unless fields.nil?
|
1561
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1562
|
+
execute_or_queue_command(command, &block)
|
1563
|
+
end
|
1564
|
+
|
1493
1565
|
# Gets the latest state of a long-running operation. Clients can use this method
|
1494
1566
|
# to poll the operation result at intervals as recommended by the API service.
|
1495
1567
|
# @param [String] name
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1beta
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.25.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-10-
|
11
|
+
date: 2023-10-22 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: google-apis-core
|
@@ -58,7 +58,7 @@ licenses:
|
|
58
58
|
metadata:
|
59
59
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
60
60
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.25.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|