google-apis-discoveryengine_v1alpha 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_v1alpha/classes.rb +31 -28
- data/lib/google/apis/discoveryengine_v1alpha/gem_version.rb +2 -2
- data/lib/google/apis/discoveryengine_v1alpha/representations.rb +1 -14
- data/lib/google/apis/discoveryengine_v1alpha/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: d6c5904082312a22c49253384956c44bbd873547708692d8504a5ec8b6d0a944
|
4
|
+
data.tar.gz: 8369decd22421913d96fa77323163203647b7618353cbf7b77b62d0026e4c5b6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2157566b775090673e848a5b9599fad7f51866d7d87c31a5c26c012c3e017f8af830ba9ea8bd5fe5e1ecf1c1b7009dba528d8103c99580299fe9efa570a38460
|
7
|
+
data.tar.gz: bfb04bde6314a2a90a81c8de6cc8f55c0bd7c4362d0891319e921b0e32219d7074d36c212bfaec7baf5aac1994b945e952a83896d1a6589e818e30eef7689270
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,13 @@
|
|
1
1
|
# Release history for google-apis-discoveryengine_v1alpha
|
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
|
@@ -642,25 +642,6 @@ module Google
|
|
642
642
|
end
|
643
643
|
end
|
644
644
|
|
645
|
-
# Response message for SiteSearchEngineService.BatchCreateTargetSites method.
|
646
|
-
class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
|
647
|
-
include Google::Apis::Core::Hashable
|
648
|
-
|
649
|
-
# TargetSites created.
|
650
|
-
# Corresponds to the JSON property `targetSites`
|
651
|
-
# @return [Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite>]
|
652
|
-
attr_accessor :target_sites
|
653
|
-
|
654
|
-
def initialize(**args)
|
655
|
-
update!(**args)
|
656
|
-
end
|
657
|
-
|
658
|
-
# Update properties of this object
|
659
|
-
def update!(**args)
|
660
|
-
@target_sites = args[:target_sites] if args.key?(:target_sites)
|
661
|
-
end
|
662
|
-
end
|
663
|
-
|
664
645
|
# BigQuery source import data from.
|
665
646
|
class GoogleCloudDiscoveryengineV1alphaBigQuerySource
|
666
647
|
include Google::Apis::Core::Hashable
|
@@ -2319,11 +2300,16 @@ module Google
|
|
2319
2300
|
# characters. Currently, only filter expressions on the `filter_tags` attribute
|
2320
2301
|
# is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags:
|
2321
2302
|
# ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags:
|
2322
|
-
# ANY("Green"))` If
|
2323
|
-
#
|
2324
|
-
#
|
2325
|
-
#
|
2326
|
-
#
|
2303
|
+
# ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params`
|
2304
|
+
# field, then attribute-based expressions are expected instead of the above
|
2305
|
+
# described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (
|
2306
|
+
# categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es"))
|
2307
|
+
# OR (categories: ANY("Movie")) If your filter blocks all results, the API will
|
2308
|
+
# return generic (unfiltered) popular Documents. If you only want results
|
2309
|
+
# strictly matching the filters, set `strictFiltering` to True in
|
2310
|
+
# RecommendRequest.params to receive empty results instead. Note that the API
|
2311
|
+
# will never return Documents with `storageStatus` of `EXPIRED` or `DELETED`
|
2312
|
+
# regardless of filter choices.
|
2327
2313
|
# Corresponds to the JSON property `filter`
|
2328
2314
|
# @return [String]
|
2329
2315
|
attr_accessor :filter
|
@@ -2348,7 +2334,9 @@ module Google
|
|
2348
2334
|
# recommendation results. * `diversityLevel`: String. Default empty. If set to
|
2349
2335
|
# be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` *
|
2350
2336
|
# `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-
|
2351
|
-
# level control and adjusts recommendation results based on Document category.
|
2337
|
+
# level control and adjusts recommendation results based on Document category. *
|
2338
|
+
# `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `
|
2339
|
+
# filter` field is interpreted according to the new, attribute-based syntax.
|
2352
2340
|
# Corresponds to the JSON property `params`
|
2353
2341
|
# @return [Hash<String,Object>]
|
2354
2342
|
attr_accessor :params
|
@@ -2824,7 +2812,14 @@ module Google
|
|
2824
2812
|
# The filter syntax consists of an expression language for constructing a
|
2825
2813
|
# predicate from one or more fields of the documents being filtered. Filter
|
2826
2814
|
# expression is case-sensitive. If this field is unrecognizable, an `
|
2827
|
-
# INVALID_ARGUMENT` is returned.
|
2815
|
+
# INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by
|
2816
|
+
# mapping the LHS filter key to a key property defined in the Vertex AI Search
|
2817
|
+
# backend -- this mapping is defined by the customer in their schema. For
|
2818
|
+
# example a media customer might have a field 'name' in their schema. In this
|
2819
|
+
# case the filter would look like this: filter --> name:'ANY("king kong")' For
|
2820
|
+
# more information about filtering including syntax and filter operators, see [
|
2821
|
+
# Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-
|
2822
|
+
# metadata)
|
2828
2823
|
# Corresponds to the JSON property `filter`
|
2829
2824
|
# @return [String]
|
2830
2825
|
attr_accessor :filter
|
@@ -2844,8 +2839,9 @@ module Google
|
|
2844
2839
|
|
2845
2840
|
# The order in which documents are returned. Documents can be ordered by a field
|
2846
2841
|
# in an Document object. Leave it unset if ordered by relevance. `order_by`
|
2847
|
-
# expression is case-sensitive.
|
2848
|
-
#
|
2842
|
+
# expression is case-sensitive. For more information on ordering, see [Ordering](
|
2843
|
+
# https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
|
2844
|
+
# unrecognizable, an `INVALID_ARGUMENT` is returned.
|
2849
2845
|
# Corresponds to the JSON property `orderBy`
|
2850
2846
|
# @return [String]
|
2851
2847
|
attr_accessor :order_by
|
@@ -4510,6 +4506,12 @@ module Google
|
|
4510
4506
|
attr_accessor :llm_enabled
|
4511
4507
|
alias_method :llm_enabled?, :llm_enabled
|
4512
4508
|
|
4509
|
+
# Output only. Whether the customer accepted data use terms.
|
4510
|
+
# Corresponds to the JSON property `minimumDataTermAccepted`
|
4511
|
+
# @return [Boolean]
|
4512
|
+
attr_accessor :minimum_data_term_accepted
|
4513
|
+
alias_method :minimum_data_term_accepted?, :minimum_data_term_accepted
|
4514
|
+
|
4513
4515
|
# Immutable. The full resource name of the widget config. Format: `projects/`
|
4514
4516
|
# project`/locations/`location`/collections/`collection_id`/dataStores/`
|
4515
4517
|
# data_store_id`/widgetConfigs/`widget_config_id``. This field must be a UTF-8
|
@@ -4559,6 +4561,7 @@ module Google
|
|
4559
4561
|
@facet_field = args[:facet_field] if args.key?(:facet_field)
|
4560
4562
|
@fields_ui_components_map = args[:fields_ui_components_map] if args.key?(:fields_ui_components_map)
|
4561
4563
|
@llm_enabled = args[:llm_enabled] if args.key?(:llm_enabled)
|
4564
|
+
@minimum_data_term_accepted = args[:minimum_data_term_accepted] if args.key?(:minimum_data_term_accepted)
|
4562
4565
|
@name = args[:name] if args.key?(:name)
|
4563
4566
|
@result_display_type = args[:result_display_type] if args.key?(:result_display_type)
|
4564
4567
|
@solution_type = args[:solution_type] if args.key?(:solution_type)
|
@@ -16,13 +16,13 @@ module Google
|
|
16
16
|
module Apis
|
17
17
|
module DiscoveryengineV1alpha
|
18
18
|
# Version of the google-apis-discoveryengine_v1alpha 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
|
@@ -136,12 +136,6 @@ module Google
|
|
136
136
|
include Google::Apis::Core::JsonObjectSupport
|
137
137
|
end
|
138
138
|
|
139
|
-
class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
|
140
|
-
class Representation < Google::Apis::Core::JsonRepresentation; end
|
141
|
-
|
142
|
-
include Google::Apis::Core::JsonObjectSupport
|
143
|
-
end
|
144
|
-
|
145
139
|
class GoogleCloudDiscoveryengineV1alphaBigQuerySource
|
146
140
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
147
141
|
|
@@ -1001,14 +995,6 @@ module Google
|
|
1001
995
|
end
|
1002
996
|
end
|
1003
997
|
|
1004
|
-
class GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse
|
1005
|
-
# @private
|
1006
|
-
class Representation < Google::Apis::Core::JsonRepresentation
|
1007
|
-
collection :target_sites, as: 'targetSites', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTargetSite::Representation
|
1008
|
-
|
1009
|
-
end
|
1010
|
-
end
|
1011
|
-
|
1012
998
|
class GoogleCloudDiscoveryengineV1alphaBigQuerySource
|
1013
999
|
# @private
|
1014
1000
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -1977,6 +1963,7 @@ module Google
|
|
1977
1963
|
hash :fields_ui_components_map, as: 'fieldsUiComponentsMap', class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField, decorator: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConfigUiComponentField::Representation
|
1978
1964
|
|
1979
1965
|
property :llm_enabled, as: 'llmEnabled'
|
1966
|
+
property :minimum_data_term_accepted, as: 'minimumDataTermAccepted'
|
1980
1967
|
property :name, as: 'name'
|
1981
1968
|
property :result_display_type, as: 'resultDisplayType'
|
1982
1969
|
property :solution_type, as: 'solutionType'
|
@@ -1703,6 +1703,78 @@ module Google
|
|
1703
1703
|
execute_or_queue_command(command, &block)
|
1704
1704
|
end
|
1705
1705
|
|
1706
|
+
# Makes a recommendation, which requires a contextual user event.
|
1707
|
+
# @param [String] serving_config
|
1708
|
+
# Required. Full resource name of the format: `projects/*/locations/global/
|
1709
|
+
# collections/*/dataStores/*/servingConfigs/*` Before you can request
|
1710
|
+
# recommendations from your model, you must create at least one serving config
|
1711
|
+
# for it.
|
1712
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest] google_cloud_discoveryengine_v1alpha_recommend_request_object
|
1713
|
+
# @param [String] fields
|
1714
|
+
# Selector specifying which fields to include in a partial response.
|
1715
|
+
# @param [String] quota_user
|
1716
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1717
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1718
|
+
# @param [Google::Apis::RequestOptions] options
|
1719
|
+
# Request-specific options
|
1720
|
+
#
|
1721
|
+
# @yield [result, err] Result & error if block supplied
|
1722
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse] parsed result object
|
1723
|
+
# @yieldparam err [StandardError] error object if request failed
|
1724
|
+
#
|
1725
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse]
|
1726
|
+
#
|
1727
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1728
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1729
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1730
|
+
def recommend_project_location_collection_engine_serving_config(serving_config, google_cloud_discoveryengine_v1alpha_recommend_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1731
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:recommend', options)
|
1732
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendRequest::Representation
|
1733
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_recommend_request_object
|
1734
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse::Representation
|
1735
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRecommendResponse
|
1736
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1737
|
+
command.query['fields'] = fields unless fields.nil?
|
1738
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1739
|
+
execute_or_queue_command(command, &block)
|
1740
|
+
end
|
1741
|
+
|
1742
|
+
# Performs a search.
|
1743
|
+
# @param [String] serving_config
|
1744
|
+
# Required. The resource name of the Search serving config, such as `projects/*/
|
1745
|
+
# locations/global/collections/default_collection/dataStores/default_data_store/
|
1746
|
+
# servingConfigs/default_serving_config`. This field is used to identify the
|
1747
|
+
# serving configuration name, set of models used to make the search.
|
1748
|
+
# @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest] google_cloud_discoveryengine_v1alpha_search_request_object
|
1749
|
+
# @param [String] fields
|
1750
|
+
# Selector specifying which fields to include in a partial response.
|
1751
|
+
# @param [String] quota_user
|
1752
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1753
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1754
|
+
# @param [Google::Apis::RequestOptions] options
|
1755
|
+
# Request-specific options
|
1756
|
+
#
|
1757
|
+
# @yield [result, err] Result & error if block supplied
|
1758
|
+
# @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse] parsed result object
|
1759
|
+
# @yieldparam err [StandardError] error object if request failed
|
1760
|
+
#
|
1761
|
+
# @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse]
|
1762
|
+
#
|
1763
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1764
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1765
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1766
|
+
def search_project_location_collection_engine_serving_configs(serving_config, google_cloud_discoveryengine_v1alpha_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1767
|
+
command = make_simple_command(:post, 'v1alpha/{+servingConfig}:search', options)
|
1768
|
+
command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequest::Representation
|
1769
|
+
command.request_object = google_cloud_discoveryengine_v1alpha_search_request_object
|
1770
|
+
command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse::Representation
|
1771
|
+
command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponse
|
1772
|
+
command.params['servingConfig'] = serving_config unless serving_config.nil?
|
1773
|
+
command.query['fields'] = fields unless fields.nil?
|
1774
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1775
|
+
execute_or_queue_command(command, &block)
|
1776
|
+
end
|
1777
|
+
|
1706
1778
|
# Gets the latest state of a long-running operation. Clients can use this method
|
1707
1779
|
# to poll the operation result at intervals as recommended by the API service.
|
1708
1780
|
# @param [String] name
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-discoveryengine_v1alpha
|
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-29 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_v1alpha/CHANGELOG.md
|
61
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.
|
61
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.25.0
|
62
62
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
|
63
63
|
post_install_message:
|
64
64
|
rdoc_options: []
|