google-cloud-discovery_engine-v1beta 0.12.0 → 0.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +824 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +250 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +770 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +1106 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +306 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/evaluation_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/rest.rb +3 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +1035 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +809 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/paths.rb +73 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +967 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +1106 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +426 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest.rb +54 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_service.rb +57 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +911 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/paths.rb +69 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +850 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +366 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest.rb +53 -0
- data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service.rb +56 -0
- data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +10 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +10 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +14 -0
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta.rb +3 -0
- data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +50 -0
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +56 -0
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_services_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_pb.rb +49 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_services_pb.rb +63 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_pb.rb +47 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +57 -0
- data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_services_pb.rb +59 -0
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +5 -1
- data/proto_docs/google/api/client.rb +14 -10
- data/proto_docs/google/api/resource.rb +7 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +119 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +10 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +43 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +223 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +194 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +85 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb +82 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_service.rb +179 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set.rb +57 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set_service.rb +186 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +69 -8
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +11 -5
- metadata +44 -2
@@ -0,0 +1,179 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Request message for
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#get_sample_query SampleQueryService.GetSampleQuery}
|
26
|
+
# method.
|
27
|
+
# @!attribute [rw] name
|
28
|
+
# @return [::String]
|
29
|
+
# Required. Full resource name of
|
30
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, such as
|
31
|
+
# `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
|
32
|
+
#
|
33
|
+
# If the caller does not have permission to access the
|
34
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
|
35
|
+
# of whether or not it exists, a PERMISSION_DENIED error is returned.
|
36
|
+
#
|
37
|
+
# If the requested
|
38
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} does not
|
39
|
+
# exist, a NOT_FOUND error is returned.
|
40
|
+
class GetSampleQueryRequest
|
41
|
+
include ::Google::Protobuf::MessageExts
|
42
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
43
|
+
end
|
44
|
+
|
45
|
+
# Request message for
|
46
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
|
47
|
+
# method.
|
48
|
+
# @!attribute [rw] parent
|
49
|
+
# @return [::String]
|
50
|
+
# Required. The parent sample query set resource name, such as
|
51
|
+
# `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
|
52
|
+
#
|
53
|
+
# If the caller does not have permission to list
|
54
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s under this
|
55
|
+
# sample query set, regardless of whether or not this sample query set
|
56
|
+
# exists, a `PERMISSION_DENIED` error is returned.
|
57
|
+
# @!attribute [rw] page_size
|
58
|
+
# @return [::Integer]
|
59
|
+
# Maximum number of
|
60
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s to return.
|
61
|
+
# If unspecified, defaults to 100. The maximum allowed value is 1000. Values
|
62
|
+
# above 1000 will be coerced to 1000.
|
63
|
+
#
|
64
|
+
# If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
65
|
+
# @!attribute [rw] page_token
|
66
|
+
# @return [::String]
|
67
|
+
# A page token
|
68
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQueriesResponse#next_page_token ListSampleQueriesResponse.next_page_token},
|
69
|
+
# received from a previous
|
70
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
|
71
|
+
# call. Provide this to retrieve the subsequent page.
|
72
|
+
#
|
73
|
+
# When paginating, all other parameters provided to
|
74
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
|
75
|
+
# must match the call that provided the page token. Otherwise, an
|
76
|
+
# `INVALID_ARGUMENT` error is returned.
|
77
|
+
class ListSampleQueriesRequest
|
78
|
+
include ::Google::Protobuf::MessageExts
|
79
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
80
|
+
end
|
81
|
+
|
82
|
+
# Response message for
|
83
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
|
84
|
+
# method.
|
85
|
+
# @!attribute [rw] sample_queries
|
86
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery>]
|
87
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s.
|
88
|
+
# @!attribute [rw] next_page_token
|
89
|
+
# @return [::String]
|
90
|
+
# A token that can be sent as
|
91
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQueriesRequest#page_token ListSampleQueriesRequest.page_token}
|
92
|
+
# to retrieve the next page. If this field is omitted, there are no
|
93
|
+
# subsequent pages.
|
94
|
+
class ListSampleQueriesResponse
|
95
|
+
include ::Google::Protobuf::MessageExts
|
96
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
97
|
+
end
|
98
|
+
|
99
|
+
# Request message for
|
100
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#create_sample_query SampleQueryService.CreateSampleQuery}
|
101
|
+
# method.
|
102
|
+
# @!attribute [rw] parent
|
103
|
+
# @return [::String]
|
104
|
+
# Required. The parent resource name, such as
|
105
|
+
# `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
|
106
|
+
# @!attribute [rw] sample_query
|
107
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery]
|
108
|
+
# Required. The
|
109
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to create.
|
110
|
+
# @!attribute [rw] sample_query_id
|
111
|
+
# @return [::String]
|
112
|
+
# Required. The ID to use for the
|
113
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, which will
|
114
|
+
# become the final component of the
|
115
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery#name SampleQuery.name}.
|
116
|
+
#
|
117
|
+
# If the caller does not have permission to create the
|
118
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
|
119
|
+
# of whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
120
|
+
#
|
121
|
+
# This field must be unique among all
|
122
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s with the
|
123
|
+
# same
|
124
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQueryRequest#parent parent}.
|
125
|
+
# Otherwise, an `ALREADY_EXISTS` error is returned.
|
126
|
+
#
|
127
|
+
# This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
128
|
+
# standard with a length limit of 63 characters. Otherwise, an
|
129
|
+
# `INVALID_ARGUMENT` error is returned.
|
130
|
+
class CreateSampleQueryRequest
|
131
|
+
include ::Google::Protobuf::MessageExts
|
132
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
133
|
+
end
|
134
|
+
|
135
|
+
# Request message for
|
136
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#update_sample_query SampleQueryService.UpdateSampleQuery}
|
137
|
+
# method.
|
138
|
+
# @!attribute [rw] sample_query
|
139
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery]
|
140
|
+
# Required. The simple query to update.
|
141
|
+
#
|
142
|
+
# If the caller does not have permission to update the
|
143
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
|
144
|
+
# of whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
145
|
+
#
|
146
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to
|
147
|
+
# update does not exist a `NOT_FOUND` error is returned.
|
148
|
+
# @!attribute [rw] update_mask
|
149
|
+
# @return [::Google::Protobuf::FieldMask]
|
150
|
+
# Indicates which fields in the provided imported 'simple query' to update.
|
151
|
+
# If not set, will by default update all fields.
|
152
|
+
class UpdateSampleQueryRequest
|
153
|
+
include ::Google::Protobuf::MessageExts
|
154
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
155
|
+
end
|
156
|
+
|
157
|
+
# Request message for
|
158
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#delete_sample_query SampleQueryService.DeleteSampleQuery}
|
159
|
+
# method.
|
160
|
+
# @!attribute [rw] name
|
161
|
+
# @return [::String]
|
162
|
+
# Required. Full resource name of
|
163
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, such as
|
164
|
+
# `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
|
165
|
+
#
|
166
|
+
# If the caller does not have permission to delete the
|
167
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
|
168
|
+
# of whether or not it exists, a `PERMISSION_DENIED` error is returned.
|
169
|
+
#
|
170
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to
|
171
|
+
# delete does not exist, a `NOT_FOUND` error is returned.
|
172
|
+
class DeleteSampleQueryRequest
|
173
|
+
include ::Google::Protobuf::MessageExts
|
174
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
175
|
+
end
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
@@ -0,0 +1,57 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# A SampleQuerySet is the parent resource of SampleQuery, and contains the
|
25
|
+
# configurations shared by all SampleQuery under it.
|
26
|
+
# @!attribute [rw] name
|
27
|
+
# @return [::String]
|
28
|
+
# Identifier. The full resource name of the
|
29
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, in
|
30
|
+
# the format of
|
31
|
+
# `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
|
32
|
+
#
|
33
|
+
# This field must be a UTF-8 encoded string with a length limit of 1024
|
34
|
+
# characters.
|
35
|
+
# @!attribute [rw] display_name
|
36
|
+
# @return [::String]
|
37
|
+
# Required. The sample query set display name.
|
38
|
+
#
|
39
|
+
# This field must be a UTF-8 encoded string with a length limit of 128
|
40
|
+
# characters.
|
41
|
+
# @!attribute [r] create_time
|
42
|
+
# @return [::Google::Protobuf::Timestamp]
|
43
|
+
# Output only. Timestamp the
|
44
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} was
|
45
|
+
# created at.
|
46
|
+
# @!attribute [rw] description
|
47
|
+
# @return [::String]
|
48
|
+
# The description of the
|
49
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}.
|
50
|
+
class SampleQuerySet
|
51
|
+
include ::Google::Protobuf::MessageExts
|
52
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
@@ -0,0 +1,186 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2024 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module DiscoveryEngine
|
23
|
+
module V1beta
|
24
|
+
# Request message for
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#get_sample_query_set SampleQuerySetService.GetSampleQuerySet}
|
26
|
+
# method.
|
27
|
+
# @!attribute [rw] name
|
28
|
+
# @return [::String]
|
29
|
+
# Required. Full resource name of
|
30
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, such
|
31
|
+
# as
|
32
|
+
# `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
|
33
|
+
#
|
34
|
+
# If the caller does not have permission to access the
|
35
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
|
36
|
+
# regardless of whether or not it exists, a PERMISSION_DENIED error is
|
37
|
+
# returned.
|
38
|
+
#
|
39
|
+
# If the requested
|
40
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} does
|
41
|
+
# not exist, a NOT_FOUND error is returned.
|
42
|
+
class GetSampleQuerySetRequest
|
43
|
+
include ::Google::Protobuf::MessageExts
|
44
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
45
|
+
end
|
46
|
+
|
47
|
+
# Request message for
|
48
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
|
49
|
+
# method.
|
50
|
+
# @!attribute [rw] parent
|
51
|
+
# @return [::String]
|
52
|
+
# Required. The parent location resource name, such as
|
53
|
+
# `projects/{project}/locations/{location}`.
|
54
|
+
#
|
55
|
+
# If the caller does not have permission to list
|
56
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s under
|
57
|
+
# this location, regardless of whether or not this location exists, a
|
58
|
+
# `PERMISSION_DENIED` error is returned.
|
59
|
+
# @!attribute [rw] page_size
|
60
|
+
# @return [::Integer]
|
61
|
+
# Maximum number of
|
62
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s to
|
63
|
+
# return. If unspecified, defaults to 100. The maximum allowed value is 1000.
|
64
|
+
# Values above 1000 will be coerced to 1000.
|
65
|
+
#
|
66
|
+
# If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
67
|
+
# @!attribute [rw] page_token
|
68
|
+
# @return [::String]
|
69
|
+
# A page token
|
70
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsResponse#next_page_token ListSampleQuerySetsResponse.next_page_token},
|
71
|
+
# received from a previous
|
72
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
|
73
|
+
# call. Provide this to retrieve the subsequent page.
|
74
|
+
#
|
75
|
+
# When paginating, all other parameters provided to
|
76
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
|
77
|
+
# must match the call that provided the page token. Otherwise, an
|
78
|
+
# `INVALID_ARGUMENT` error is returned.
|
79
|
+
class ListSampleQuerySetsRequest
|
80
|
+
include ::Google::Protobuf::MessageExts
|
81
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
82
|
+
end
|
83
|
+
|
84
|
+
# Response message for
|
85
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#list_sample_query_sets SampleQuerySetService.ListSampleQuerySets}
|
86
|
+
# method.
|
87
|
+
# @!attribute [rw] sample_query_sets
|
88
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet>]
|
89
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s.
|
90
|
+
# @!attribute [rw] next_page_token
|
91
|
+
# @return [::String]
|
92
|
+
# A token that can be sent as
|
93
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQuerySetsRequest#page_token ListSampleQuerySetsRequest.page_token}
|
94
|
+
# to retrieve the next page. If this field is omitted, there are no
|
95
|
+
# subsequent pages.
|
96
|
+
class ListSampleQuerySetsResponse
|
97
|
+
include ::Google::Protobuf::MessageExts
|
98
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
99
|
+
end
|
100
|
+
|
101
|
+
# Request message for
|
102
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#create_sample_query_set SampleQuerySetService.CreateSampleQuerySet}
|
103
|
+
# method.
|
104
|
+
# @!attribute [rw] parent
|
105
|
+
# @return [::String]
|
106
|
+
# Required. The parent resource name, such as
|
107
|
+
# `projects/{project}/locations/{location}`.
|
108
|
+
# @!attribute [rw] sample_query_set
|
109
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
110
|
+
# Required. The
|
111
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} to
|
112
|
+
# create.
|
113
|
+
# @!attribute [rw] sample_query_set_id
|
114
|
+
# @return [::String]
|
115
|
+
# Required. The ID to use for the
|
116
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, which
|
117
|
+
# will become the final component of the
|
118
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet#name SampleQuerySet.name}.
|
119
|
+
#
|
120
|
+
# If the caller does not have permission to create the
|
121
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
|
122
|
+
# regardless of whether or not it exists, a `PERMISSION_DENIED` error is
|
123
|
+
# returned.
|
124
|
+
#
|
125
|
+
# This field must be unique among all
|
126
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}s with
|
127
|
+
# the same
|
128
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQuerySetRequest#parent parent}.
|
129
|
+
# Otherwise, an `ALREADY_EXISTS` error is returned.
|
130
|
+
#
|
131
|
+
# This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
132
|
+
# standard with a length limit of 63 characters. Otherwise, an
|
133
|
+
# `INVALID_ARGUMENT` error is returned.
|
134
|
+
class CreateSampleQuerySetRequest
|
135
|
+
include ::Google::Protobuf::MessageExts
|
136
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
137
|
+
end
|
138
|
+
|
139
|
+
# Request message for
|
140
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#update_sample_query_set SampleQuerySetService.UpdateSampleQuerySet}
|
141
|
+
# method.
|
142
|
+
# @!attribute [rw] sample_query_set
|
143
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet]
|
144
|
+
# Required. The sample query set to update.
|
145
|
+
#
|
146
|
+
# If the caller does not have permission to update the
|
147
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
|
148
|
+
# regardless of whether or not it exists, a `PERMISSION_DENIED` error is
|
149
|
+
# returned.
|
150
|
+
#
|
151
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
|
152
|
+
# to update does not exist a `NOT_FOUND` error is returned.
|
153
|
+
# @!attribute [rw] update_mask
|
154
|
+
# @return [::Google::Protobuf::FieldMask]
|
155
|
+
# Indicates which fields in the provided imported 'sample query set' to
|
156
|
+
# update. If not set, will by default update all fields.
|
157
|
+
class UpdateSampleQuerySetRequest
|
158
|
+
include ::Google::Protobuf::MessageExts
|
159
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
160
|
+
end
|
161
|
+
|
162
|
+
# Request message for
|
163
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySetService::Client#delete_sample_query_set SampleQuerySetService.DeleteSampleQuerySet}
|
164
|
+
# method.
|
165
|
+
# @!attribute [rw] name
|
166
|
+
# @return [::String]
|
167
|
+
# Required. Full resource name of
|
168
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, such
|
169
|
+
# as
|
170
|
+
# `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
|
171
|
+
#
|
172
|
+
# If the caller does not have permission to delete the
|
173
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet},
|
174
|
+
# regardless of whether or not it exists, a `PERMISSION_DENIED` error is
|
175
|
+
# returned.
|
176
|
+
#
|
177
|
+
# If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
|
178
|
+
# to delete does not exist, a `NOT_FOUND` error is returned.
|
179
|
+
class DeleteSampleQuerySetRequest
|
180
|
+
include ::Google::Protobuf::MessageExts
|
181
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
182
|
+
end
|
183
|
+
end
|
184
|
+
end
|
185
|
+
end
|
186
|
+
end
|
@@ -203,20 +203,26 @@ module Google
|
|
203
203
|
# documents. This overrides
|
204
204
|
# {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#ranking_expression ServingConfig.ranking_expression}.
|
205
205
|
# The ranking expression is a single function or multiple functions that are
|
206
|
-
#
|
206
|
+
# joined by "+".
|
207
|
+
#
|
207
208
|
# * ranking_expression = function, { " + ", function };
|
209
|
+
#
|
208
210
|
# Supported functions:
|
211
|
+
#
|
209
212
|
# * double * relevance_score
|
210
213
|
# * double * dotProduct(embedding_field_path)
|
214
|
+
#
|
211
215
|
# Function variables:
|
212
|
-
#
|
216
|
+
#
|
217
|
+
# * `relevance_score`: pre-defined keywords, used for measure relevance
|
213
218
|
# between query and document.
|
214
|
-
# `embedding_field_path`: the document embedding field
|
219
|
+
# * `embedding_field_path`: the document embedding field
|
215
220
|
# used with query embedding vector.
|
216
|
-
# `dotProduct`: embedding function between embedding_field_path and query
|
221
|
+
# * `dotProduct`: embedding function between embedding_field_path and query
|
217
222
|
# embedding vector.
|
218
223
|
#
|
219
224
|
# Example ranking expression:
|
225
|
+
#
|
220
226
|
# If document has an embedding field doc_embedding, the ranking expression
|
221
227
|
# could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
222
228
|
# @!attribute [rw] safe_search
|
@@ -257,8 +263,8 @@ module Google
|
|
257
263
|
end
|
258
264
|
|
259
265
|
# A struct to define data stores to filter on in a search call and
|
260
|
-
# configurations for those data stores.
|
261
|
-
#
|
266
|
+
# configurations for those data stores. Otherwise, an `INVALID_ARGUMENT`
|
267
|
+
# error is returned.
|
262
268
|
# @!attribute [rw] data_store
|
263
269
|
# @return [::String]
|
264
270
|
# Required. Full resource name of
|
@@ -278,6 +284,9 @@ module Google
|
|
278
284
|
# Maximum facet values that are returned for this facet. If
|
279
285
|
# unspecified, defaults to 20. The maximum allowed value is 300. Values
|
280
286
|
# above 300 are coerced to 300.
|
287
|
+
# For aggregation in healthcare search, when the [FacetKey.key] is
|
288
|
+
# "healthcare_aggregation_key", the limit will be overridden to
|
289
|
+
# 10,000 internally, regardless of the value set here.
|
281
290
|
#
|
282
291
|
# If this field is negative, an `INVALID_ARGUMENT` is returned.
|
283
292
|
# @!attribute [rw] excluded_filter_keys
|
@@ -615,6 +624,17 @@ module Google
|
|
615
624
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec]
|
616
625
|
# If there is no extractive_content_spec provided, there will be no
|
617
626
|
# extractive answer in the search response.
|
627
|
+
# @!attribute [rw] search_result_mode
|
628
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode]
|
629
|
+
# Specifies the search result mode. If unspecified, the
|
630
|
+
# search result mode defaults to `DOCUMENTS`.
|
631
|
+
# @!attribute [rw] chunk_spec
|
632
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::ChunkSpec]
|
633
|
+
# Specifies the chunk spec to be returned from the search response.
|
634
|
+
# Only available if the
|
635
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
|
636
|
+
# is set to
|
637
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
|
618
638
|
class ContentSearchSpec
|
619
639
|
include ::Google::Protobuf::MessageExts
|
620
640
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -651,8 +671,9 @@ module Google
|
|
651
671
|
#
|
652
672
|
# At most 10 results for documents mode, or 50 for chunks mode, can be
|
653
673
|
# used to generate a summary. The chunks mode is used when
|
654
|
-
#
|
655
|
-
#
|
674
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
|
675
|
+
# is set to
|
676
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
|
656
677
|
# @!attribute [rw] include_citations
|
657
678
|
# @return [::Boolean]
|
658
679
|
# Specifies whether to include citations in the summary. The default
|
@@ -809,6 +830,40 @@ module Google
|
|
809
830
|
include ::Google::Protobuf::MessageExts
|
810
831
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
811
832
|
end
|
833
|
+
|
834
|
+
# Specifies the chunk spec to be returned from the search response.
|
835
|
+
# Only available if the
|
836
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
|
837
|
+
# is set to
|
838
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}
|
839
|
+
# @!attribute [rw] num_previous_chunks
|
840
|
+
# @return [::Integer]
|
841
|
+
# The number of previous chunks to be returned of the current chunk. The
|
842
|
+
# maximum allowed value is 3.
|
843
|
+
# If not specified, no previous chunks will be returned.
|
844
|
+
# @!attribute [rw] num_next_chunks
|
845
|
+
# @return [::Integer]
|
846
|
+
# The number of next chunks to be returned of the current chunk. The
|
847
|
+
# maximum allowed value is 3.
|
848
|
+
# If not specified, no next chunks will be returned.
|
849
|
+
class ChunkSpec
|
850
|
+
include ::Google::Protobuf::MessageExts
|
851
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
852
|
+
end
|
853
|
+
|
854
|
+
# Specifies the search result mode. If unspecified, the
|
855
|
+
# search result mode defaults to `DOCUMENTS`.
|
856
|
+
module SearchResultMode
|
857
|
+
# Default value.
|
858
|
+
SEARCH_RESULT_MODE_UNSPECIFIED = 0
|
859
|
+
|
860
|
+
# Returns documents in the search result.
|
861
|
+
DOCUMENTS = 1
|
862
|
+
|
863
|
+
# Returns chunks in the search result. Only available if the
|
864
|
+
# [DataStore.DocumentProcessingConfig.chunking_config][] is specified.
|
865
|
+
CHUNKS = 2
|
866
|
+
end
|
812
867
|
end
|
813
868
|
|
814
869
|
# The specification that uses customized query embedding vector to do
|
@@ -924,6 +979,12 @@ module Google
|
|
924
979
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
|
925
980
|
# The document data snippet in the search response. Only fields that are
|
926
981
|
# marked as `retrievable` are populated.
|
982
|
+
# @!attribute [rw] chunk
|
983
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Chunk]
|
984
|
+
# The chunk data in the search response if the
|
985
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec#search_result_mode SearchRequest.ContentSearchSpec.search_result_mode}
|
986
|
+
# is set to
|
987
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SearchResultMode::CHUNKS CHUNKS}.
|
927
988
|
# @!attribute [rw] model_scores
|
928
989
|
# @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
|
929
990
|
# Google provided available scores.
|
@@ -93,21 +93,27 @@ module Google
|
|
93
93
|
#
|
94
94
|
# The ranking expression is a single function or multiple functions that are
|
95
95
|
# joined by "+".
|
96
|
+
#
|
96
97
|
# * ranking_expression = function, { " + ", function };
|
98
|
+
#
|
97
99
|
# Supported functions:
|
100
|
+
#
|
98
101
|
# * double * relevance_score
|
99
102
|
# * double * dotProduct(embedding_field_path)
|
103
|
+
#
|
100
104
|
# Function variables:
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
105
|
+
#
|
106
|
+
# * `relevance_score`: pre-defined keywords, used for measure relevance
|
107
|
+
# between query and document.
|
108
|
+
# * `embedding_field_path`: the document embedding field
|
104
109
|
# used with query embedding vector.
|
105
|
-
# dotProduct
|
110
|
+
# * `dotProduct`: embedding function between embedding_field_path and query
|
106
111
|
# embedding vector.
|
107
112
|
#
|
108
113
|
# Example ranking expression:
|
114
|
+
#
|
109
115
|
# If document has an embedding field doc_embedding, the ranking expression
|
110
|
-
# could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)
|
116
|
+
# could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
|
111
117
|
# @!attribute [r] create_time
|
112
118
|
# @return [::Google::Protobuf::Timestamp]
|
113
119
|
# Output only. ServingConfig created timestamp.
|