google-cloud-discovery_engine-v1beta 0.14.2 → 0.16.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/client.rb +155 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/paths.rb +62 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +148 -0
- data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +76 -0
- data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +6 -6
- data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +6 -6
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +18 -13
- data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +18 -13
- data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +109 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/paths.rb +25 -0
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +102 -1
- data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +66 -0
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +3 -3
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +218 -4
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/paths.rb +85 -0
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +125 -4
- data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/service_stub.rb +60 -0
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +410 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +402 -4
- data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +76 -0
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +2 -2
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +324 -1
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/paths.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +303 -1
- data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/service_stub.rb +193 -0
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +18 -1
- data/lib/google/cloud/discoveryengine/v1beta/completion_service_services_pb.rb +2 -0
- data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/data_store_pb.rb +7 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +4 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +11 -1
- data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +24 -1
- data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_services_pb.rb +4 -0
- data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +5 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +6 -1
- data/lib/google/cloud/discoveryengine/v1beta/search_service_services_pb.rb +14 -0
- data/lib/google/cloud/discoveryengine/v1beta/serving_config_pb.rb +2 -2
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +2 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_pb.rb +10 -1
- data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_service_services_pb.rb +7 -0
- data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
- data/proto_docs/google/api/client.rb +20 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +68 -8
- data/proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb +268 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +10 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +6 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +98 -15
- data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +11 -3
- data/proto_docs/google/cloud/discoveryengine/v1beta/data_store.rb +131 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +22 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +9 -5
- data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +123 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +5 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/engine_service.rb +4 -4
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +398 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +10 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +13 -7
- data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/purge_config.rb +39 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +1 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +175 -6
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +17 -0
- data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine_service.rb +147 -1
- data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +13 -1
- metadata +3 -3
@@ -27,9 +27,9 @@ module Google
|
|
27
27
|
# @!attribute [rw] name
|
28
28
|
# @return [::String]
|
29
29
|
# Required. The resource name of the Conversation to get. Format:
|
30
|
-
# `projects/{
|
30
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
|
31
31
|
# Use
|
32
|
-
# `projects/{
|
32
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
|
33
33
|
# to activate auto session mode, which automatically creates a new
|
34
34
|
# conversation inside a ConverseConversation session.
|
35
35
|
# @!attribute [rw] query
|
@@ -38,7 +38,7 @@ module Google
|
|
38
38
|
# @!attribute [rw] serving_config
|
39
39
|
# @return [::String]
|
40
40
|
# The resource name of the Serving Config to use. Format:
|
41
|
-
# `projects/{
|
41
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
|
42
42
|
# If this is not set, the default serving config will be used.
|
43
43
|
# @!attribute [rw] conversation
|
44
44
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
|
@@ -131,7 +131,7 @@ module Google
|
|
131
131
|
# @!attribute [rw] parent
|
132
132
|
# @return [::String]
|
133
133
|
# Required. Full resource name of parent data store. Format:
|
134
|
-
# `projects/{
|
134
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
|
135
135
|
# @!attribute [rw] conversation
|
136
136
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
|
137
137
|
# Required. The conversation to create.
|
@@ -162,7 +162,7 @@ module Google
|
|
162
162
|
# @!attribute [rw] name
|
163
163
|
# @return [::String]
|
164
164
|
# Required. The resource name of the Conversation to delete. Format:
|
165
|
-
# `projects/{
|
165
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
166
166
|
class DeleteConversationRequest
|
167
167
|
include ::Google::Protobuf::MessageExts
|
168
168
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -172,7 +172,7 @@ module Google
|
|
172
172
|
# @!attribute [rw] name
|
173
173
|
# @return [::String]
|
174
174
|
# Required. The resource name of the Conversation to get. Format:
|
175
|
-
# `projects/{
|
175
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
|
176
176
|
class GetConversationRequest
|
177
177
|
include ::Google::Protobuf::MessageExts
|
178
178
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -182,7 +182,7 @@ module Google
|
|
182
182
|
# @!attribute [rw] parent
|
183
183
|
# @return [::String]
|
184
184
|
# Required. The data store resource name. Format:
|
185
|
-
# `projects/{
|
185
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
|
186
186
|
# @!attribute [rw] page_size
|
187
187
|
# @return [::Integer]
|
188
188
|
# Maximum number of results to return. If unspecified, defaults
|
@@ -255,6 +255,9 @@ module Google
|
|
255
255
|
# @!attribute [rw] related_questions_spec
|
256
256
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::RelatedQuestionsSpec]
|
257
257
|
# Related questions specification.
|
258
|
+
# @!attribute [rw] grounding_spec
|
259
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec]
|
260
|
+
# Optional. Grounding specification.
|
258
261
|
# @!attribute [rw] answer_generation_spec
|
259
262
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec]
|
260
263
|
# Answer generation specification.
|
@@ -265,7 +268,11 @@ module Google
|
|
265
268
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::QueryUnderstandingSpec]
|
266
269
|
# Query understanding specification.
|
267
270
|
# @!attribute [rw] asynchronous_mode
|
271
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
268
272
|
# @return [::Boolean]
|
273
|
+
# Deprecated: This field is deprecated. Streaming Answer API will be
|
274
|
+
# supported.
|
275
|
+
#
|
269
276
|
# Asynchronous mode control.
|
270
277
|
#
|
271
278
|
# If enabled, the response will be returned with answer/session resource
|
@@ -328,6 +335,35 @@ module Google
|
|
328
335
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
329
336
|
end
|
330
337
|
|
338
|
+
# Grounding specification.
|
339
|
+
# @!attribute [rw] include_grounding_supports
|
340
|
+
# @return [::Boolean]
|
341
|
+
# Optional. Specifies whether to include grounding_supports in the answer.
|
342
|
+
# The default value is `false`.
|
343
|
+
#
|
344
|
+
# When this field is set to `true`, returned answer will have
|
345
|
+
# `grounding_score` and will contain GroundingSupports for each claim.
|
346
|
+
# @!attribute [rw] filtering_level
|
347
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::GroundingSpec::FilteringLevel]
|
348
|
+
# Optional. Specifies whether to enable the filtering based on grounding
|
349
|
+
# score and at what level.
|
350
|
+
class GroundingSpec
|
351
|
+
include ::Google::Protobuf::MessageExts
|
352
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
353
|
+
|
354
|
+
# Level to filter based on answer grounding.
|
355
|
+
module FilteringLevel
|
356
|
+
# Default is no filter
|
357
|
+
FILTERING_LEVEL_UNSPECIFIED = 0
|
358
|
+
|
359
|
+
# Filter answers based on a low threshold.
|
360
|
+
FILTERING_LEVEL_LOW = 1
|
361
|
+
|
362
|
+
# Filter answers based on a high threshold.
|
363
|
+
FILTERING_LEVEL_HIGH = 2
|
364
|
+
end
|
365
|
+
end
|
366
|
+
|
331
367
|
# Answer generation specification.
|
332
368
|
# @!attribute [rw] model_spec
|
333
369
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::AnswerGenerationSpec::ModelSpec]
|
@@ -373,6 +409,19 @@ module Google
|
|
373
409
|
# If this field is set to `false`, all search results are used regardless
|
374
410
|
# of relevance to generate answers. If set to `true` or unset, the behavior
|
375
411
|
# will be determined automatically by the service.
|
412
|
+
# @!attribute [rw] ignore_jail_breaking_query
|
413
|
+
# @return [::Boolean]
|
414
|
+
# Optional. Specifies whether to filter out jail-breaking queries. The
|
415
|
+
# default value is `false`.
|
416
|
+
#
|
417
|
+
# Google employs search-query classification to detect jail-breaking
|
418
|
+
# queries. No summary is returned if the search query is classified as a
|
419
|
+
# jail-breaking query. A user might add instructions to the query to
|
420
|
+
# change the tone, style, language, content of the answer, or ask the
|
421
|
+
# model to act as a different entity, e.g. "Reply in the tone of a
|
422
|
+
# competing company's CEO". If this field is set to `true`, we skip
|
423
|
+
# generating summaries for jail-breaking queries and return fallback
|
424
|
+
# messages instead.
|
376
425
|
class AnswerGenerationSpec
|
377
426
|
include ::Google::Protobuf::MessageExts
|
378
427
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -459,6 +508,10 @@ module Google
|
|
459
508
|
# configurations for those dataStores. This is only considered for
|
460
509
|
# engines with multiple dataStores use case. For single dataStore within
|
461
510
|
# an engine, they should use the specs at the top level.
|
511
|
+
# @!attribute [rw] natural_language_query_understanding_spec
|
512
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::NaturalLanguageQueryUnderstandingSpec]
|
513
|
+
# Optional. Specification to enable natural language understanding
|
514
|
+
# capabilities for search requests.
|
462
515
|
class SearchParams
|
463
516
|
include ::Google::Protobuf::MessageExts
|
464
517
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -495,12 +548,18 @@ module Google
|
|
495
548
|
# Title.
|
496
549
|
# @!attribute [rw] document_contexts
|
497
550
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::DocumentContext>]
|
498
|
-
# List of document contexts.
|
551
|
+
# List of document contexts. The content will be used for Answer
|
552
|
+
# Generation. This is supposed to be the main content of the document
|
553
|
+
# that can be long and comprehensive.
|
499
554
|
# @!attribute [rw] extractive_segments
|
500
555
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveSegment>]
|
501
556
|
# List of extractive segments.
|
502
557
|
# @!attribute [rw] extractive_answers
|
558
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
503
559
|
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveAnswer>]
|
560
|
+
# Deprecated: This field is deprecated and will have no effect on
|
561
|
+
# the Answer generation.
|
562
|
+
# Please use document_contexts and extractive_segments fields.
|
504
563
|
# List of extractive answers.
|
505
564
|
class UnstructuredDocumentInfo
|
506
565
|
include ::Google::Protobuf::MessageExts
|
@@ -512,7 +571,7 @@ module Google
|
|
512
571
|
# Page identifier.
|
513
572
|
# @!attribute [rw] content
|
514
573
|
# @return [::String]
|
515
|
-
# Document content.
|
574
|
+
# Document content to be used for answer generation.
|
516
575
|
class DocumentContext
|
517
576
|
include ::Google::Protobuf::MessageExts
|
518
577
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -520,6 +579,8 @@ module Google
|
|
520
579
|
|
521
580
|
# Extractive segment.
|
522
581
|
# [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
|
582
|
+
# Answer generation will only use it if document_contexts is empty.
|
583
|
+
# This is supposed to be shorter snippets.
|
523
584
|
# @!attribute [rw] page_identifier
|
524
585
|
# @return [::String]
|
525
586
|
# Page identifier.
|
@@ -552,9 +613,25 @@ module Google
|
|
552
613
|
# @!attribute [rw] content
|
553
614
|
# @return [::String]
|
554
615
|
# Chunk textual content.
|
616
|
+
# @!attribute [rw] document_metadata
|
617
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::ChunkInfo::DocumentMetadata]
|
618
|
+
# Metadata of the document from the current chunk.
|
555
619
|
class ChunkInfo
|
556
620
|
include ::Google::Protobuf::MessageExts
|
557
621
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
622
|
+
|
623
|
+
# Document metadata contains the information of the document of the
|
624
|
+
# current chunk.
|
625
|
+
# @!attribute [rw] uri
|
626
|
+
# @return [::String]
|
627
|
+
# Uri of the document.
|
628
|
+
# @!attribute [rw] title
|
629
|
+
# @return [::String]
|
630
|
+
# Title of the document.
|
631
|
+
class DocumentMetadata
|
632
|
+
include ::Google::Protobuf::MessageExts
|
633
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
634
|
+
end
|
558
635
|
end
|
559
636
|
end
|
560
637
|
end
|
@@ -587,8 +664,14 @@ module Google
|
|
587
664
|
# Adversarial query classification type.
|
588
665
|
ADVERSARIAL_QUERY = 1
|
589
666
|
|
590
|
-
# Non-answer-seeking query classification type.
|
667
|
+
# Non-answer-seeking query classification type, for chit chat.
|
591
668
|
NON_ANSWER_SEEKING_QUERY = 2
|
669
|
+
|
670
|
+
# Jail-breaking query classification type.
|
671
|
+
JAIL_BREAKING_QUERY = 3
|
672
|
+
|
673
|
+
# Non-answer-seeking query classification type, for no clear intent.
|
674
|
+
NON_ANSWER_SEEKING_QUERY_V2 = 4
|
592
675
|
end
|
593
676
|
end
|
594
677
|
|
@@ -648,7 +731,7 @@ module Google
|
|
648
731
|
# @!attribute [rw] name
|
649
732
|
# @return [::String]
|
650
733
|
# Required. The resource name of the Answer to get. Format:
|
651
|
-
# `projects/{
|
734
|
+
# `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
|
652
735
|
class GetAnswerRequest
|
653
736
|
include ::Google::Protobuf::MessageExts
|
654
737
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -658,7 +741,7 @@ module Google
|
|
658
741
|
# @!attribute [rw] parent
|
659
742
|
# @return [::String]
|
660
743
|
# Required. Full resource name of parent data store. Format:
|
661
|
-
# `projects/{
|
744
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
|
662
745
|
# @!attribute [rw] session
|
663
746
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Session]
|
664
747
|
# Required. The session to create.
|
@@ -689,7 +772,7 @@ module Google
|
|
689
772
|
# @!attribute [rw] name
|
690
773
|
# @return [::String]
|
691
774
|
# Required. The resource name of the Session to delete. Format:
|
692
|
-
# `projects/{
|
775
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
|
693
776
|
class DeleteSessionRequest
|
694
777
|
include ::Google::Protobuf::MessageExts
|
695
778
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -699,7 +782,7 @@ module Google
|
|
699
782
|
# @!attribute [rw] name
|
700
783
|
# @return [::String]
|
701
784
|
# Required. The resource name of the Session to get. Format:
|
702
|
-
# `projects/{
|
785
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
|
703
786
|
class GetSessionRequest
|
704
787
|
include ::Google::Protobuf::MessageExts
|
705
788
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -709,7 +792,7 @@ module Google
|
|
709
792
|
# @!attribute [rw] parent
|
710
793
|
# @return [::String]
|
711
794
|
# Required. The data store resource name. Format:
|
712
|
-
# `projects/{
|
795
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
|
713
796
|
# @!attribute [rw] page_size
|
714
797
|
# @return [::Integer]
|
715
798
|
# Maximum number of results to return. If unspecified, defaults
|
@@ -27,8 +27,9 @@ module Google
|
|
27
27
|
# Required. The fully qualified resource name of the model.
|
28
28
|
#
|
29
29
|
# Format:
|
30
|
-
# `projects/{
|
31
|
-
#
|
30
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.
|
31
|
+
#
|
32
|
+
# Model must be an alpha-numerical string with limit of 40 characters.
|
32
33
|
# @!attribute [rw] display_name
|
33
34
|
# @return [::String]
|
34
35
|
# The display name of the model.
|
@@ -41,13 +42,17 @@ module Google
|
|
41
42
|
# @!attribute [rw] create_time
|
42
43
|
# @deprecated This field is deprecated and may be removed in the next major version update.
|
43
44
|
# @return [::Google::Protobuf::Timestamp]
|
44
|
-
# Timestamp the Model was created at.
|
45
|
+
# Deprecated: Timestamp the Model was created at.
|
45
46
|
# @!attribute [rw] training_start_time
|
46
47
|
# @return [::Google::Protobuf::Timestamp]
|
47
48
|
# Timestamp the model training was initiated.
|
48
49
|
# @!attribute [rw] metrics
|
49
50
|
# @return [::Google::Protobuf::Map{::String => ::Float}]
|
50
51
|
# The metrics of the trained model.
|
52
|
+
# @!attribute [rw] error_message
|
53
|
+
# @return [::String]
|
54
|
+
# Currently this is only populated if the model state is
|
55
|
+
# `INPUT_VALIDATION_FAILED`.
|
51
56
|
class CustomTuningModel
|
52
57
|
include ::Google::Protobuf::MessageExts
|
53
58
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -83,6 +88,9 @@ module Google
|
|
83
88
|
|
84
89
|
# The model training finished successfully but metrics did not improve.
|
85
90
|
NO_IMPROVEMENT = 6
|
91
|
+
|
92
|
+
# Input data validation failed. Model training didn't start.
|
93
|
+
INPUT_VALIDATION_FAILED = 7
|
86
94
|
end
|
87
95
|
end
|
88
96
|
end
|
@@ -64,6 +64,19 @@ module Google
|
|
64
64
|
# @!attribute [rw] language_info
|
65
65
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::LanguageInfo]
|
66
66
|
# Language info for DataStore.
|
67
|
+
# @!attribute [rw] natural_language_query_understanding_config
|
68
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig]
|
69
|
+
# Optional. Configuration for Natural Language Query Understanding.
|
70
|
+
# @!attribute [r] billing_estimation
|
71
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DataStore::BillingEstimation]
|
72
|
+
# Output only. Data size estimation for billing.
|
73
|
+
# @!attribute [rw] workspace_config
|
74
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig]
|
75
|
+
# Config to store data store type configuration for workspace data. This
|
76
|
+
# must be set when
|
77
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore#content_config DataStore.content_config}
|
78
|
+
# is set as
|
79
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::GOOGLE_WORKSPACE DataStore.ContentConfig.GOOGLE_WORKSPACE}.
|
67
80
|
# @!attribute [rw] document_processing_config
|
68
81
|
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig]
|
69
82
|
# Configuration for Document understanding and enrichment.
|
@@ -84,10 +97,47 @@ module Google
|
|
84
97
|
# The provided schema will be validated against certain rules on schema.
|
85
98
|
# Learn more from [this
|
86
99
|
# doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
|
100
|
+
# @!attribute [rw] serving_config_data_store
|
101
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ServingConfigDataStore]
|
102
|
+
# Optional. Stores serving config at DataStore level.
|
87
103
|
class DataStore
|
88
104
|
include ::Google::Protobuf::MessageExts
|
89
105
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
90
106
|
|
107
|
+
# Estimation of data size per data store.
|
108
|
+
# @!attribute [rw] structured_data_size
|
109
|
+
# @return [::Integer]
|
110
|
+
# Data size for structured data in terms of bytes.
|
111
|
+
# @!attribute [rw] unstructured_data_size
|
112
|
+
# @return [::Integer]
|
113
|
+
# Data size for unstructured data in terms of bytes.
|
114
|
+
# @!attribute [rw] website_data_size
|
115
|
+
# @return [::Integer]
|
116
|
+
# Data size for websites in terms of bytes.
|
117
|
+
# @!attribute [rw] structured_data_update_time
|
118
|
+
# @return [::Google::Protobuf::Timestamp]
|
119
|
+
# Last updated timestamp for structured data.
|
120
|
+
# @!attribute [rw] unstructured_data_update_time
|
121
|
+
# @return [::Google::Protobuf::Timestamp]
|
122
|
+
# Last updated timestamp for unstructured data.
|
123
|
+
# @!attribute [rw] website_data_update_time
|
124
|
+
# @return [::Google::Protobuf::Timestamp]
|
125
|
+
# Last updated timestamp for websites.
|
126
|
+
class BillingEstimation
|
127
|
+
include ::Google::Protobuf::MessageExts
|
128
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
129
|
+
end
|
130
|
+
|
131
|
+
# Stores information regarding the serving configurations at DataStore level.
|
132
|
+
# @!attribute [rw] disabled_for_serving
|
133
|
+
# @return [::Boolean]
|
134
|
+
# If set true, the DataStore will not be available for serving search
|
135
|
+
# requests.
|
136
|
+
class ServingConfigDataStore
|
137
|
+
include ::Google::Protobuf::MessageExts
|
138
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
139
|
+
end
|
140
|
+
|
91
141
|
# Content config of the data store.
|
92
142
|
module ContentConfig
|
93
143
|
# Default value.
|
@@ -103,6 +153,11 @@ module Google
|
|
103
153
|
|
104
154
|
# The data store is used for public website search.
|
105
155
|
PUBLIC_WEBSITE = 3
|
156
|
+
|
157
|
+
# The data store is used for workspace search. Details of workspace
|
158
|
+
# data store are specified in the
|
159
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig WorkspaceConfig}.
|
160
|
+
GOOGLE_WORKSPACE = 4
|
106
161
|
end
|
107
162
|
end
|
108
163
|
|
@@ -127,6 +182,82 @@ module Google
|
|
127
182
|
include ::Google::Protobuf::MessageExts
|
128
183
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
129
184
|
end
|
185
|
+
|
186
|
+
# Configuration for Natural Language Query Understanding.
|
187
|
+
# @!attribute [rw] mode
|
188
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig::Mode]
|
189
|
+
# Mode of Natural Language Query Understanding. If this field is unset, the
|
190
|
+
# behavior defaults to
|
191
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::NaturalLanguageQueryUnderstandingConfig::Mode::DISABLED NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED}.
|
192
|
+
class NaturalLanguageQueryUnderstandingConfig
|
193
|
+
include ::Google::Protobuf::MessageExts
|
194
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
195
|
+
|
196
|
+
# Mode of Natural Language Query Understanding. When the
|
197
|
+
# NaturalLanguageQueryUnderstandingConfig.Mode is ENABLED, the natural
|
198
|
+
# language understanding capabilities will be enabled for a search request if
|
199
|
+
# the NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition in the
|
200
|
+
# SearchRequest is ENABLED.
|
201
|
+
module Mode
|
202
|
+
# Default value.
|
203
|
+
MODE_UNSPECIFIED = 0
|
204
|
+
|
205
|
+
# Natural Language Query Understanding is disabled.
|
206
|
+
DISABLED = 1
|
207
|
+
|
208
|
+
# Natural Language Query Understanding is enabled.
|
209
|
+
ENABLED = 2
|
210
|
+
end
|
211
|
+
end
|
212
|
+
|
213
|
+
# Config to store data store type configuration for workspace data
|
214
|
+
# @!attribute [rw] type
|
215
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::WorkspaceConfig::Type]
|
216
|
+
# The Google Workspace data source.
|
217
|
+
# @!attribute [rw] dasher_customer_id
|
218
|
+
# @return [::String]
|
219
|
+
# Obfuscated Dasher customer ID.
|
220
|
+
# @!attribute [rw] super_admin_service_account
|
221
|
+
# @return [::String]
|
222
|
+
# Optional. The super admin service account for the workspace that will be
|
223
|
+
# used for access token generation. For now we only use it for Native Google
|
224
|
+
# Drive connector data ingestion.
|
225
|
+
# @!attribute [rw] super_admin_email_address
|
226
|
+
# @return [::String]
|
227
|
+
# Optional. The super admin email address for the workspace that will be used
|
228
|
+
# for access token generation. For now we only use it for Native Google Drive
|
229
|
+
# connector data ingestion.
|
230
|
+
class WorkspaceConfig
|
231
|
+
include ::Google::Protobuf::MessageExts
|
232
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
233
|
+
|
234
|
+
# Specifies the type of Workspace App supported by this DataStore
|
235
|
+
module Type
|
236
|
+
# Defaults to an unspecified Workspace type.
|
237
|
+
TYPE_UNSPECIFIED = 0
|
238
|
+
|
239
|
+
# Workspace Data Store contains Drive data
|
240
|
+
GOOGLE_DRIVE = 1
|
241
|
+
|
242
|
+
# Workspace Data Store contains Mail data
|
243
|
+
GOOGLE_MAIL = 2
|
244
|
+
|
245
|
+
# Workspace Data Store contains Sites data
|
246
|
+
GOOGLE_SITES = 3
|
247
|
+
|
248
|
+
# Workspace Data Store contains Calendar data
|
249
|
+
GOOGLE_CALENDAR = 4
|
250
|
+
|
251
|
+
# Workspace Data Store contains Chat data
|
252
|
+
GOOGLE_CHAT = 5
|
253
|
+
|
254
|
+
# Workspace Data Store contains Groups data
|
255
|
+
GOOGLE_GROUPS = 6
|
256
|
+
|
257
|
+
# Workspace Data Store contains Keep data
|
258
|
+
GOOGLE_KEEP = 7
|
259
|
+
end
|
260
|
+
end
|
130
261
|
end
|
131
262
|
end
|
132
263
|
end
|
@@ -73,6 +73,14 @@ module Google
|
|
73
73
|
#
|
74
74
|
# This field is OUTPUT_ONLY. If this field is not populated, it means the
|
75
75
|
# document has never been indexed.
|
76
|
+
# @!attribute [r] index_status
|
77
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::Document::IndexStatus]
|
78
|
+
# Output only. The index status of the document.
|
79
|
+
#
|
80
|
+
# * If document is indexed successfully, the index_time field is populated.
|
81
|
+
# * Otherwise, if document is not indexed due to errors, the error_samples
|
82
|
+
# field is populated.
|
83
|
+
# * Otherwise, index_status is unset.
|
76
84
|
class Document
|
77
85
|
include ::Google::Protobuf::MessageExts
|
78
86
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -108,6 +116,20 @@ module Google
|
|
108
116
|
include ::Google::Protobuf::MessageExts
|
109
117
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
110
118
|
end
|
119
|
+
|
120
|
+
# Index status of the document.
|
121
|
+
# @!attribute [rw] index_time
|
122
|
+
# @return [::Google::Protobuf::Timestamp]
|
123
|
+
# The time when the document was indexed.
|
124
|
+
# If this field is populated, it means the document has been indexed.
|
125
|
+
# @!attribute [rw] error_samples
|
126
|
+
# @return [::Array<::Google::Rpc::Status>]
|
127
|
+
# A sample of errors encountered while indexing the document.
|
128
|
+
# If this field is populated, the document is not indexed due to errors.
|
129
|
+
class IndexStatus
|
130
|
+
include ::Google::Protobuf::MessageExts
|
131
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
132
|
+
end
|
111
133
|
end
|
112
134
|
end
|
113
135
|
end
|
@@ -22,11 +22,11 @@ module Google
|
|
22
22
|
module DiscoveryEngine
|
23
23
|
module V1beta
|
24
24
|
# A singleton resource of
|
25
|
-
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}.
|
26
|
-
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is created
|
27
|
-
#
|
28
|
-
#
|
29
|
-
# the
|
25
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}. If it's empty
|
26
|
+
# when {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is created
|
27
|
+
# and {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} is set to
|
28
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED},
|
29
|
+
# the default parser will default to digital parser.
|
30
30
|
# @!attribute [rw] name
|
31
31
|
# @return [::String]
|
32
32
|
# The full resource name of the Document Processing Config.
|
@@ -54,6 +54,10 @@ module Google
|
|
54
54
|
# layout parsing are supported.
|
55
55
|
# * `pptx`: Override parsing config for PPTX files, only digital parsing and
|
56
56
|
# layout parsing are supported.
|
57
|
+
# * `xlsm`: Override parsing config for XLSM files, only digital parsing and
|
58
|
+
# layout parsing are supported.
|
59
|
+
# * `xlsx`: Override parsing config for XLSX files, only digital parsing and
|
60
|
+
# layout parsing are supported.
|
57
61
|
class DocumentProcessingConfig
|
58
62
|
include ::Google::Protobuf::MessageExts
|
59
63
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -179,6 +179,129 @@ module Google
|
|
179
179
|
include ::Google::Protobuf::MessageExts
|
180
180
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
181
181
|
end
|
182
|
+
|
183
|
+
# Request message for
|
184
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#batch_get_documents_metadata DocumentService.BatchGetDocumentsMetadata}
|
185
|
+
# method.
|
186
|
+
# @!attribute [rw] parent
|
187
|
+
# @return [::String]
|
188
|
+
# Required. The parent branch resource name, such as
|
189
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
190
|
+
# @!attribute [rw] matcher
|
191
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest::Matcher]
|
192
|
+
# Required. Matcher for the
|
193
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
|
194
|
+
class BatchGetDocumentsMetadataRequest
|
195
|
+
include ::Google::Protobuf::MessageExts
|
196
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
197
|
+
|
198
|
+
# Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
|
199
|
+
# by exact uris.
|
200
|
+
# @!attribute [rw] uris
|
201
|
+
# @return [::Array<::String>]
|
202
|
+
# The exact URIs to match by.
|
203
|
+
class UrisMatcher
|
204
|
+
include ::Google::Protobuf::MessageExts
|
205
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
206
|
+
end
|
207
|
+
|
208
|
+
# Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
|
209
|
+
# by FHIR resource names.
|
210
|
+
# @!attribute [rw] fhir_resources
|
211
|
+
# @return [::Array<::String>]
|
212
|
+
# Required. The FHIR resources to match by.
|
213
|
+
# Format:
|
214
|
+
# projects/\\{project}/locations/\\{location}/datasets/\\{dataset}/fhirStores/\\{fhir_store}/fhir/\\{resource_type}/\\{fhir_resource_id}
|
215
|
+
class FhirMatcher
|
216
|
+
include ::Google::Protobuf::MessageExts
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
+
end
|
219
|
+
|
220
|
+
# Matcher for the {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
|
221
|
+
# Currently supports matching by exact URIs.
|
222
|
+
# @!attribute [rw] uris_matcher
|
223
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest::UrisMatcher]
|
224
|
+
# Matcher by exact URIs.
|
225
|
+
# @!attribute [rw] fhir_matcher
|
226
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest::FhirMatcher]
|
227
|
+
# Matcher by FHIR resource names.
|
228
|
+
class Matcher
|
229
|
+
include ::Google::Protobuf::MessageExts
|
230
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
231
|
+
end
|
232
|
+
end
|
233
|
+
|
234
|
+
# Response message for
|
235
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Client#batch_get_documents_metadata DocumentService.BatchGetDocumentsMetadata}
|
236
|
+
# method.
|
237
|
+
# @!attribute [rw] documents_metadata
|
238
|
+
# @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse::DocumentMetadata>]
|
239
|
+
# The metadata of the
|
240
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s.
|
241
|
+
class BatchGetDocumentsMetadataResponse
|
242
|
+
include ::Google::Protobuf::MessageExts
|
243
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
244
|
+
|
245
|
+
# The metadata of a {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
|
246
|
+
# @!attribute [rw] matcher_value
|
247
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse::DocumentMetadata::MatcherValue]
|
248
|
+
# The value of the matcher that was used to match the
|
249
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
|
250
|
+
# @!attribute [rw] state
|
251
|
+
# @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse::State]
|
252
|
+
# The state of the document.
|
253
|
+
# @!attribute [rw] last_refreshed_time
|
254
|
+
# @return [::Google::Protobuf::Timestamp]
|
255
|
+
# The timestamp of the last time the
|
256
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} was last
|
257
|
+
# indexed.
|
258
|
+
# @!attribute [rw] data_ingestion_source
|
259
|
+
# @return [::String]
|
260
|
+
# The data ingestion source of the
|
261
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
|
262
|
+
#
|
263
|
+
# Allowed values are:
|
264
|
+
#
|
265
|
+
# * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
|
266
|
+
# * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
|
267
|
+
class DocumentMetadata
|
268
|
+
include ::Google::Protobuf::MessageExts
|
269
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
270
|
+
|
271
|
+
# The value of the matcher that was used to match the
|
272
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
|
273
|
+
# @!attribute [rw] uri
|
274
|
+
# @return [::String]
|
275
|
+
# If match by URI, the URI of the
|
276
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
|
277
|
+
# @!attribute [rw] fhir_resource
|
278
|
+
# @return [::String]
|
279
|
+
# Format:
|
280
|
+
# projects/\\{project}/locations/\\{location}/datasets/\\{dataset}/fhirStores/\\{fhir_store}/fhir/\\{resource_type}/\\{fhir_resource_id}
|
281
|
+
class MatcherValue
|
282
|
+
include ::Google::Protobuf::MessageExts
|
283
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
284
|
+
end
|
285
|
+
end
|
286
|
+
|
287
|
+
# The state of the {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}.
|
288
|
+
module State
|
289
|
+
# Should never be set.
|
290
|
+
STATE_UNSPECIFIED = 0
|
291
|
+
|
292
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is indexed.
|
293
|
+
INDEXED = 1
|
294
|
+
|
295
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is not
|
296
|
+
# indexed because its URI is not in the
|
297
|
+
# {::Google::Cloud::DiscoveryEngine::V1beta::TargetSite TargetSite}.
|
298
|
+
NOT_IN_TARGET_SITE = 2
|
299
|
+
|
300
|
+
# The {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is not
|
301
|
+
# indexed.
|
302
|
+
NOT_IN_INDEX = 3
|
303
|
+
end
|
304
|
+
end
|
182
305
|
end
|
183
306
|
end
|
184
307
|
end
|