google-cloud-discovery_engine-v1 1.1.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +2 -2
  3. data/lib/google/cloud/discovery_engine/v1/control_service/client.rb +6 -6
  4. data/lib/google/cloud/discovery_engine/v1/control_service/rest/client.rb +6 -6
  5. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +15 -12
  6. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +15 -12
  7. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +2 -2
  8. data/lib/google/cloud/discovery_engine/v1/document_service/paths.rb +25 -0
  9. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +2 -2
  10. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +2 -2
  11. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/client.rb +219 -3
  12. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/paths.rb +85 -0
  13. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb +126 -3
  14. data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb +60 -0
  15. data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb +2 -2
  16. data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb +1 -1
  17. data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb +1 -1
  18. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +2 -2
  19. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +324 -1
  20. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +316 -1
  21. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +76 -0
  22. data/lib/google/cloud/discovery_engine/v1/search_tuning_service/rest/operations.rb +2 -2
  23. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +5 -1
  24. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +5 -1
  25. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +2 -2
  26. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +1 -1
  27. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +1 -1
  28. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +2 -2
  29. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  30. data/lib/google/cloud/discoveryengine/v1/answer_pb.rb +1 -1
  31. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +1 -1
  32. data/lib/google/cloud/discoveryengine/v1/control_pb.rb +1 -1
  33. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +2 -1
  34. data/lib/google/cloud/discoveryengine/v1/custom_tuning_model_pb.rb +1 -1
  35. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +4 -1
  36. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +2 -1
  37. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +1 -1
  38. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_pb.rb +23 -1
  39. data/lib/google/cloud/discoveryengine/v1/grounded_generation_service_services_pb.rb +4 -0
  40. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +5 -1
  41. data/lib/google/cloud/discoveryengine/v1/search_service_services_pb.rb +14 -0
  42. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +1 -1
  43. data/proto_docs/google/api/client.rb +14 -0
  44. data/proto_docs/google/cloud/discoveryengine/v1/answer.rb +18 -2
  45. data/proto_docs/google/cloud/discoveryengine/v1/control.rb +9 -0
  46. data/proto_docs/google/cloud/discoveryengine/v1/control_service.rb +6 -6
  47. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +59 -15
  48. data/proto_docs/google/cloud/discoveryengine/v1/custom_tuning_model.rb +8 -3
  49. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +88 -0
  50. data/proto_docs/google/cloud/discoveryengine/v1/document_processing_config.rb +7 -5
  51. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +19 -0
  52. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +5 -1
  53. data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb +383 -0
  54. data/proto_docs/google/cloud/discoveryengine/v1/project.rb +1 -1
  55. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +1 -1
  56. data/proto_docs/google/cloud/discoveryengine/v1/rank_service.rb +1 -1
  57. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +116 -0
  58. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb +5 -0
  59. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +1 -1
  60. metadata +3 -3
@@ -348,11 +348,14 @@ module Google
348
348
  # Adversarial query classification type.
349
349
  ADVERSARIAL_QUERY = 1
350
350
 
351
- # Non-answer-seeking query classification type.
351
+ # Non-answer-seeking query classification type, for chit chat.
352
352
  NON_ANSWER_SEEKING_QUERY = 2
353
353
 
354
354
  # Jail-breaking query classification type.
355
355
  JAIL_BREAKING_QUERY = 3
356
+
357
+ # Non-answer-seeking query classification type, for no clear intent.
358
+ NON_ANSWER_SEEKING_QUERY_V2 = 4
356
359
  end
357
360
  end
358
361
  end
@@ -380,7 +383,9 @@ module Google
380
383
  # The adversarial query ignored case.
381
384
  ADVERSARIAL_QUERY_IGNORED = 1
382
385
 
383
- # The non-answer seeking query ignored case.
386
+ # The non-answer seeking query ignored case
387
+ #
388
+ # Google skips the answer if the query is chit chat.
384
389
  NON_ANSWER_SEEKING_QUERY_IGNORED = 2
385
390
 
386
391
  # The out-of-domain query ignored case.
@@ -412,6 +417,17 @@ module Google
412
417
  # Google skips the summary if there is a customer policy violation
413
418
  # detected. The policy is defined by the customer.
414
419
  CUSTOMER_POLICY_VIOLATION = 7
420
+
421
+ # The non-answer seeking query ignored case.
422
+ #
423
+ # Google skips the answer if the query doesn't have clear intent.
424
+ NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8
425
+
426
+ # The low-grounded answer case.
427
+ #
428
+ # Google skips the answer if a well grounded answer was unable to be
429
+ # generated.
430
+ LOW_GROUNDED_ANSWER = 9
415
431
  end
416
432
  end
417
433
  end
@@ -26,6 +26,9 @@ module Google
26
26
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Condition::QueryTerm>]
27
27
  # Search only
28
28
  # A list of terms to match the query on.
29
+ # Cannot be set when
30
+ # {::Google::Cloud::DiscoveryEngine::V1::Condition#query_regex Condition.query_regex}
31
+ # is set.
29
32
  #
30
33
  # Maximum of 10 query terms.
31
34
  # @!attribute [rw] active_time_range
@@ -33,6 +36,12 @@ module Google
33
36
  # Range of time(s) specifying when condition is active.
34
37
  #
35
38
  # Maximum of 10 time ranges.
39
+ # @!attribute [rw] query_regex
40
+ # @return [::String]
41
+ # Optional. Query regex to match the whole search query.
42
+ # Cannot be set when
43
+ # {::Google::Cloud::DiscoveryEngine::V1::Condition#query_terms Condition.query_terms}
44
+ # is set. This is currently supporting promotion use case.
36
45
  class Condition
37
46
  include ::Google::Protobuf::MessageExts
38
47
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,9 +25,9 @@ module Google
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
27
  # Required. Full resource name of parent data store. Format:
28
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
28
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
29
29
  # or
30
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
30
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
31
31
  # @!attribute [rw] control
32
32
  # @return [::Google::Cloud::DiscoveryEngine::V1::Control]
33
33
  # Required. The Control to create.
@@ -66,7 +66,7 @@ module Google
66
66
  # @!attribute [rw] name
67
67
  # @return [::String]
68
68
  # Required. The resource name of the Control to delete. Format:
69
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
69
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
70
70
  class DeleteControlRequest
71
71
  include ::Google::Protobuf::MessageExts
72
72
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -76,7 +76,7 @@ module Google
76
76
  # @!attribute [rw] name
77
77
  # @return [::String]
78
78
  # Required. The resource name of the Control to get. Format:
79
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
79
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
80
80
  class GetControlRequest
81
81
  include ::Google::Protobuf::MessageExts
82
82
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -86,9 +86,9 @@ module Google
86
86
  # @!attribute [rw] parent
87
87
  # @return [::String]
88
88
  # Required. The data store resource name. Format:
89
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
89
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
90
90
  # or
91
- # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
91
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
92
92
  # @!attribute [rw] page_size
93
93
  # @return [::Integer]
94
94
  # Optional. Maximum number of results to return. If unspecified, defaults
@@ -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/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
30
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
31
31
  # Use
32
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
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/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
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::V1::Conversation]
@@ -128,7 +128,7 @@ module Google
128
128
  # @!attribute [rw] parent
129
129
  # @return [::String]
130
130
  # Required. Full resource name of parent data store. Format:
131
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
131
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
132
132
  # @!attribute [rw] conversation
133
133
  # @return [::Google::Cloud::DiscoveryEngine::V1::Conversation]
134
134
  # Required. The conversation to create.
@@ -159,7 +159,7 @@ module Google
159
159
  # @!attribute [rw] name
160
160
  # @return [::String]
161
161
  # Required. The resource name of the Conversation to delete. Format:
162
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
162
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
163
163
  class DeleteConversationRequest
164
164
  include ::Google::Protobuf::MessageExts
165
165
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -169,7 +169,7 @@ module Google
169
169
  # @!attribute [rw] name
170
170
  # @return [::String]
171
171
  # Required. The resource name of the Conversation to get. Format:
172
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
172
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
173
173
  class GetConversationRequest
174
174
  include ::Google::Protobuf::MessageExts
175
175
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -179,7 +179,7 @@ module Google
179
179
  # @!attribute [rw] parent
180
180
  # @return [::String]
181
181
  # Required. The data store resource name. Format:
182
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
182
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
183
183
  # @!attribute [rw] page_size
184
184
  # @return [::Integer]
185
185
  # Maximum number of results to return. If unspecified, defaults
@@ -262,7 +262,11 @@ module Google
262
262
  # @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::QueryUnderstandingSpec]
263
263
  # Query understanding specification.
264
264
  # @!attribute [rw] asynchronous_mode
265
+ # @deprecated This field is deprecated and may be removed in the next major version update.
265
266
  # @return [::Boolean]
267
+ # Deprecated: This field is deprecated. Streaming Answer API will be
268
+ # supported.
269
+ #
266
270
  # Asynchronous mode control.
267
271
  #
268
272
  # If enabled, the response will be returned with answer/session resource
@@ -370,6 +374,19 @@ module Google
370
374
  # If this field is set to `false`, all search results are used regardless
371
375
  # of relevance to generate answers. If set to `true` or unset, the behavior
372
376
  # will be determined automatically by the service.
377
+ # @!attribute [rw] ignore_jail_breaking_query
378
+ # @return [::Boolean]
379
+ # Optional. Specifies whether to filter out jail-breaking queries. The
380
+ # default value is `false`.
381
+ #
382
+ # Google employs search-query classification to detect jail-breaking
383
+ # queries. No summary is returned if the search query is classified as a
384
+ # jail-breaking query. A user might add instructions to the query to
385
+ # change the tone, style, language, content of the answer, or ask the
386
+ # model to act as a different entity, e.g. "Reply in the tone of a
387
+ # competing company's CEO". If this field is set to `true`, we skip
388
+ # generating summaries for jail-breaking queries and return fallback
389
+ # messages instead.
373
390
  class AnswerGenerationSpec
374
391
  include ::Google::Protobuf::MessageExts
375
392
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -491,12 +508,18 @@ module Google
491
508
  # Title.
492
509
  # @!attribute [rw] document_contexts
493
510
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::DocumentContext>]
494
- # List of document contexts.
511
+ # List of document contexts. The content will be used for Answer
512
+ # Generation. This is supposed to be the main content of the document
513
+ # that can be long and comprehensive.
495
514
  # @!attribute [rw] extractive_segments
496
515
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveSegment>]
497
516
  # List of extractive segments.
498
517
  # @!attribute [rw] extractive_answers
518
+ # @deprecated This field is deprecated and may be removed in the next major version update.
499
519
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::UnstructuredDocumentInfo::ExtractiveAnswer>]
520
+ # Deprecated: This field is deprecated and will have no effect on
521
+ # the Answer generation.
522
+ # Please use document_contexts and extractive_segments fields.
500
523
  # List of extractive answers.
501
524
  class UnstructuredDocumentInfo
502
525
  include ::Google::Protobuf::MessageExts
@@ -508,7 +531,7 @@ module Google
508
531
  # Page identifier.
509
532
  # @!attribute [rw] content
510
533
  # @return [::String]
511
- # Document content.
534
+ # Document content to be used for answer generation.
512
535
  class DocumentContext
513
536
  include ::Google::Protobuf::MessageExts
514
537
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -516,6 +539,8 @@ module Google
516
539
 
517
540
  # Extractive segment.
518
541
  # [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
542
+ # Answer generation will only use it if document_contexts is empty.
543
+ # This is supposed to be shorter snippets.
519
544
  # @!attribute [rw] page_identifier
520
545
  # @return [::String]
521
546
  # Page identifier.
@@ -548,9 +573,25 @@ module Google
548
573
  # @!attribute [rw] content
549
574
  # @return [::String]
550
575
  # Chunk textual content.
576
+ # @!attribute [rw] document_metadata
577
+ # @return [::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::SearchSpec::SearchResultList::SearchResult::ChunkInfo::DocumentMetadata]
578
+ # Metadata of the document from the current chunk.
551
579
  class ChunkInfo
552
580
  include ::Google::Protobuf::MessageExts
553
581
  extend ::Google::Protobuf::MessageExts::ClassMethods
582
+
583
+ # Document metadata contains the information of the document of the
584
+ # current chunk.
585
+ # @!attribute [rw] uri
586
+ # @return [::String]
587
+ # Uri of the document.
588
+ # @!attribute [rw] title
589
+ # @return [::String]
590
+ # Title of the document.
591
+ class DocumentMetadata
592
+ include ::Google::Protobuf::MessageExts
593
+ extend ::Google::Protobuf::MessageExts::ClassMethods
594
+ end
554
595
  end
555
596
  end
556
597
  end
@@ -583,11 +624,14 @@ module Google
583
624
  # Adversarial query classification type.
584
625
  ADVERSARIAL_QUERY = 1
585
626
 
586
- # Non-answer-seeking query classification type.
627
+ # Non-answer-seeking query classification type, for chit chat.
587
628
  NON_ANSWER_SEEKING_QUERY = 2
588
629
 
589
630
  # Jail-breaking query classification type.
590
631
  JAIL_BREAKING_QUERY = 3
632
+
633
+ # Non-answer-seeking query classification type, for no clear intent.
634
+ NON_ANSWER_SEEKING_QUERY_V2 = 4
591
635
  end
592
636
  end
593
637
 
@@ -647,7 +691,7 @@ module Google
647
691
  # @!attribute [rw] name
648
692
  # @return [::String]
649
693
  # Required. The resource name of the Answer to get. Format:
650
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
694
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
651
695
  class GetAnswerRequest
652
696
  include ::Google::Protobuf::MessageExts
653
697
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -657,7 +701,7 @@ module Google
657
701
  # @!attribute [rw] parent
658
702
  # @return [::String]
659
703
  # Required. Full resource name of parent data store. Format:
660
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
704
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
661
705
  # @!attribute [rw] session
662
706
  # @return [::Google::Cloud::DiscoveryEngine::V1::Session]
663
707
  # Required. The session to create.
@@ -688,7 +732,7 @@ module Google
688
732
  # @!attribute [rw] name
689
733
  # @return [::String]
690
734
  # Required. The resource name of the Session to delete. Format:
691
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
735
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
692
736
  class DeleteSessionRequest
693
737
  include ::Google::Protobuf::MessageExts
694
738
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -698,7 +742,7 @@ module Google
698
742
  # @!attribute [rw] name
699
743
  # @return [::String]
700
744
  # Required. The resource name of the Session to get. Format:
701
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
745
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
702
746
  class GetSessionRequest
703
747
  include ::Google::Protobuf::MessageExts
704
748
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -708,7 +752,7 @@ module Google
708
752
  # @!attribute [rw] parent
709
753
  # @return [::String]
710
754
  # Required. The data store resource name. Format:
711
- # `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
755
+ # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
712
756
  # @!attribute [rw] page_size
713
757
  # @return [::Integer]
714
758
  # 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/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
31
- # model must be an alpha-numerical string with limit of 40 characters.
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
- # Deprecated: 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
@@ -61,6 +61,16 @@ module Google
61
61
  # @return [::Google::Protobuf::Timestamp]
62
62
  # Output only. Timestamp the
63
63
  # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} was created at.
64
+ # @!attribute [r] billing_estimation
65
+ # @return [::Google::Cloud::DiscoveryEngine::V1::DataStore::BillingEstimation]
66
+ # Output only. Data size estimation for billing.
67
+ # @!attribute [rw] workspace_config
68
+ # @return [::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig]
69
+ # Config to store data store type configuration for workspace data. This
70
+ # must be set when
71
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore#content_config DataStore.content_config}
72
+ # is set as
73
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::GOOGLE_WORKSPACE DataStore.ContentConfig.GOOGLE_WORKSPACE}.
64
74
  # @!attribute [rw] document_processing_config
65
75
  # @return [::Google::Cloud::DiscoveryEngine::V1::DocumentProcessingConfig]
66
76
  # Configuration for Document understanding and enrichment.
@@ -84,6 +94,30 @@ module Google
84
94
  include ::Google::Protobuf::MessageExts
85
95
  extend ::Google::Protobuf::MessageExts::ClassMethods
86
96
 
97
+ # Estimation of data size per data store.
98
+ # @!attribute [rw] structured_data_size
99
+ # @return [::Integer]
100
+ # Data size for structured data in terms of bytes.
101
+ # @!attribute [rw] unstructured_data_size
102
+ # @return [::Integer]
103
+ # Data size for unstructured data in terms of bytes.
104
+ # @!attribute [rw] website_data_size
105
+ # @return [::Integer]
106
+ # Data size for websites in terms of bytes.
107
+ # @!attribute [rw] structured_data_update_time
108
+ # @return [::Google::Protobuf::Timestamp]
109
+ # Last updated timestamp for structured data.
110
+ # @!attribute [rw] unstructured_data_update_time
111
+ # @return [::Google::Protobuf::Timestamp]
112
+ # Last updated timestamp for unstructured data.
113
+ # @!attribute [rw] website_data_update_time
114
+ # @return [::Google::Protobuf::Timestamp]
115
+ # Last updated timestamp for websites.
116
+ class BillingEstimation
117
+ include ::Google::Protobuf::MessageExts
118
+ extend ::Google::Protobuf::MessageExts::ClassMethods
119
+ end
120
+
87
121
  # Content config of the data store.
88
122
  module ContentConfig
89
123
  # Default value.
@@ -99,6 +133,60 @@ module Google
99
133
 
100
134
  # The data store is used for public website search.
101
135
  PUBLIC_WEBSITE = 3
136
+
137
+ # The data store is used for workspace search. Details of workspace
138
+ # data store are specified in the
139
+ # {::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig WorkspaceConfig}.
140
+ GOOGLE_WORKSPACE = 4
141
+ end
142
+ end
143
+
144
+ # Config to store data store type configuration for workspace data
145
+ # @!attribute [rw] type
146
+ # @return [::Google::Cloud::DiscoveryEngine::V1::WorkspaceConfig::Type]
147
+ # The Google Workspace data source.
148
+ # @!attribute [rw] dasher_customer_id
149
+ # @return [::String]
150
+ # Obfuscated Dasher customer ID.
151
+ # @!attribute [rw] super_admin_service_account
152
+ # @return [::String]
153
+ # Optional. The super admin service account for the workspace that will be
154
+ # used for access token generation. For now we only use it for Native Google
155
+ # Drive connector data ingestion.
156
+ # @!attribute [rw] super_admin_email_address
157
+ # @return [::String]
158
+ # Optional. The super admin email address for the workspace that will be used
159
+ # for access token generation. For now we only use it for Native Google Drive
160
+ # connector data ingestion.
161
+ class WorkspaceConfig
162
+ include ::Google::Protobuf::MessageExts
163
+ extend ::Google::Protobuf::MessageExts::ClassMethods
164
+
165
+ # Specifies the type of Workspace App supported by this DataStore
166
+ module Type
167
+ # Defaults to an unspecified Workspace type.
168
+ TYPE_UNSPECIFIED = 0
169
+
170
+ # Workspace Data Store contains Drive data
171
+ GOOGLE_DRIVE = 1
172
+
173
+ # Workspace Data Store contains Mail data
174
+ GOOGLE_MAIL = 2
175
+
176
+ # Workspace Data Store contains Sites data
177
+ GOOGLE_SITES = 3
178
+
179
+ # Workspace Data Store contains Calendar data
180
+ GOOGLE_CALENDAR = 4
181
+
182
+ # Workspace Data Store contains Chat data
183
+ GOOGLE_CHAT = 5
184
+
185
+ # Workspace Data Store contains Groups data
186
+ GOOGLE_GROUPS = 6
187
+
188
+ # Workspace Data Store contains Keep data
189
+ GOOGLE_KEEP = 7
102
190
  end
103
191
  end
104
192
  end
@@ -22,11 +22,11 @@ module Google
22
22
  module DiscoveryEngine
23
23
  module V1
24
24
  # A singleton resource of
25
- # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}. It's empty when
26
- # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is created, which
27
- # defaults to digital parser. The first call to
28
- # [DataStoreService.UpdateDocumentProcessingConfig][] method will initialize
29
- # the config.
25
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}. If it's empty when
26
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is created and
27
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is set to
28
+ # {::Google::Cloud::DiscoveryEngine::V1::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,8 @@ 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.
57
59
  # * `xlsx`: Override parsing config for XLSX files, only digital parsing and
58
60
  # layout parsing are supported.
59
61
  class DocumentProcessingConfig
@@ -205,11 +205,26 @@ module Google
205
205
  extend ::Google::Protobuf::MessageExts::ClassMethods
206
206
  end
207
207
 
208
+ # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::Document Document}s by
209
+ # 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
+
208
220
  # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
209
221
  # Currently supports matching by exact URIs.
210
222
  # @!attribute [rw] uris_matcher
211
223
  # @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest::UrisMatcher]
212
224
  # Matcher by exact URIs.
225
+ # @!attribute [rw] fhir_matcher
226
+ # @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest::FhirMatcher]
227
+ # Matcher by FHIR resource names.
213
228
  class Matcher
214
229
  include ::Google::Protobuf::MessageExts
215
230
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -257,6 +272,10 @@ module Google
257
272
  # @return [::String]
258
273
  # If match by URI, the URI of the
259
274
  # {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
275
+ # @!attribute [rw] fhir_resource
276
+ # @return [::String]
277
+ # Format:
278
+ # projects/\\{project}/locations/\\{location}/datasets/\\{dataset}/fhirStores/\\{fhir_store}/fhir/\\{resource_type}/\\{fhir_resource_id}
260
279
  class MatcherValue
261
280
  include ::Google::Protobuf::MessageExts
262
281
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -47,7 +47,7 @@ module Google
47
47
  # characters.
48
48
  #
49
49
  # Format:
50
- # `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
50
+ # `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
51
51
  # engine should be 1-63 characters, and valid characters are
52
52
  # /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
53
53
  # @!attribute [rw] display_name
@@ -93,6 +93,10 @@ module Google
93
93
  # @!attribute [rw] common_config
94
94
  # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig]
95
95
  # Common config spec that specifies the metadata of the engine.
96
+ # @!attribute [rw] disable_analytics
97
+ # @return [::Boolean]
98
+ # Optional. Whether to disable analytics for searches performed on this
99
+ # engine.
96
100
  class Engine
97
101
  include ::Google::Protobuf::MessageExts
98
102
  extend ::Google::Protobuf::MessageExts::ClassMethods