google-apis-discoveryengine_v1 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 06014f8b267e0cb52a91bada1a5e75e6feab3f44fd9987bf770f0c0aaf4b4e0a
4
- data.tar.gz: d59295cbd6c2076df6ff25fb89933058fed654c3e856da2532b80fe754a66f4f
3
+ metadata.gz: b9a4c8f7d5b3f499f35a48792cab0494ddba1484464125171b8ffcc48b5b0eec
4
+ data.tar.gz: 7be2a275f8b2f4ee889b683297e357ba3258c41ac89059d789b0a983a5c9813f
5
5
  SHA512:
6
- metadata.gz: 01b65e3f3b22c5f8638cb6656af12a6edbc3caa774d5f500279583f46fc792541bff02bae648c8fb072d6021b9976aebd0caa773a8757554587ff84a3f1e298c
7
- data.tar.gz: '099d4660b1360d7098b87832aa5063bb747295b598469916940a47bb5edf59f4c831f731ca301545044125fb36e81edf65bd73540863b68ddd53dc97025ac6a1'
6
+ metadata.gz: eda0dee84899edce2a700f54eb393b71211ab98a7784eecc24b62cae0a16de412a204e46c843956e4f380e48db9cd7792317aebe06de9ad9f0bc35ce0e7187bd
7
+ data.tar.gz: fb7fe67b7fc9dd2fb850d8aacb1349369806c69eee7ac124ef9030da4d8c9b764bf1bc388c82c79517b61e9c7db22defc5447dda72c15fe946bf1c8bcc538c72
data/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # Release history for google-apis-discoveryengine_v1
2
2
 
3
+ ### v0.3.0 (2024-05-19)
4
+
5
+ * Regenerated from discovery document revision 20240512
6
+ * Regenerated using generator version 0.15.0
7
+
8
+ ### v0.2.0 (2024-05-05)
9
+
10
+ * Regenerated from discovery document revision 20240502
11
+
3
12
  ### v0.1.0 (2024-04-21)
4
13
 
5
14
  * Regenerated from discovery document revision 20240415
@@ -585,6 +585,162 @@ module Google
585
585
  end
586
586
  end
587
587
 
588
+ # Request message for GroundedGenerationService.CheckGrounding method.
589
+ class GoogleCloudDiscoveryengineV1CheckGroundingRequest
590
+ include Google::Apis::Core::Hashable
591
+
592
+ # Answer candidate to check. Can have a maximum length of 1024 characters.
593
+ # Corresponds to the JSON property `answerCandidate`
594
+ # @return [String]
595
+ attr_accessor :answer_candidate
596
+
597
+ # List of facts for the grounding check. We support up to 200 facts.
598
+ # Corresponds to the JSON property `facts`
599
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundingFact>]
600
+ attr_accessor :facts
601
+
602
+ # Specification for the grounding check.
603
+ # Corresponds to the JSON property `groundingSpec`
604
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingSpec]
605
+ attr_accessor :grounding_spec
606
+
607
+ # The user labels applied to a resource must meet the following requirements: *
608
+ # Each resource can have multiple labels, up to a maximum of 64. * Each label
609
+ # must be a key-value pair. * Keys have a minimum length of 1 character and a
610
+ # maximum length of 63 characters and cannot be empty. Values can be empty and
611
+ # have a maximum length of 63 characters. * Keys and values can contain only
612
+ # lowercase letters, numeric characters, underscores, and dashes. All characters
613
+ # must use UTF-8 encoding, and international characters are allowed. * The key
614
+ # portion of a label must be unique. However, you can use the same key with
615
+ # multiple resources. * Keys must start with a lowercase letter or international
616
+ # character. See [Google Cloud Document](https://cloud.google.com/resource-
617
+ # manager/docs/creating-managing-labels#requirements) for more details.
618
+ # Corresponds to the JSON property `userLabels`
619
+ # @return [Hash<String,String>]
620
+ attr_accessor :user_labels
621
+
622
+ def initialize(**args)
623
+ update!(**args)
624
+ end
625
+
626
+ # Update properties of this object
627
+ def update!(**args)
628
+ @answer_candidate = args[:answer_candidate] if args.key?(:answer_candidate)
629
+ @facts = args[:facts] if args.key?(:facts)
630
+ @grounding_spec = args[:grounding_spec] if args.key?(:grounding_spec)
631
+ @user_labels = args[:user_labels] if args.key?(:user_labels)
632
+ end
633
+ end
634
+
635
+ # Response message for the GroundedGenerationService.CheckGrounding method.
636
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponse
637
+ include Google::Apis::Core::Hashable
638
+
639
+ # List of facts cited across all claims in the answer candidate. These are
640
+ # derived from the facts supplied in the request.
641
+ # Corresponds to the JSON property `citedChunks`
642
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk>]
643
+ attr_accessor :cited_chunks
644
+
645
+ # Claim texts and citation info across all claims in the answer candidate.
646
+ # Corresponds to the JSON property `claims`
647
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim>]
648
+ attr_accessor :claims
649
+
650
+ # The support score for the input answer candidate. Higher the score, higher is
651
+ # the fraction of claims that are supported by the provided facts. This is
652
+ # always set when a response is returned.
653
+ # Corresponds to the JSON property `supportScore`
654
+ # @return [Float]
655
+ attr_accessor :support_score
656
+
657
+ def initialize(**args)
658
+ update!(**args)
659
+ end
660
+
661
+ # Update properties of this object
662
+ def update!(**args)
663
+ @cited_chunks = args[:cited_chunks] if args.key?(:cited_chunks)
664
+ @claims = args[:claims] if args.key?(:claims)
665
+ @support_score = args[:support_score] if args.key?(:support_score)
666
+ end
667
+ end
668
+
669
+ # Text and citation info for a claim in the answer candidate.
670
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
671
+ include Google::Apis::Core::Hashable
672
+
673
+ # A list of indices (into 'cited_chunks') specifying the citations associated
674
+ # with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[
675
+ # 3], cited_chunks[4] are the facts cited supporting for the claim. A citation
676
+ # to a fact indicates that the claim is supported by the fact.
677
+ # Corresponds to the JSON property `citationIndices`
678
+ # @return [Array<Fixnum>]
679
+ attr_accessor :citation_indices
680
+
681
+ # Text for the claim in the answer candidate. Always provided regardless of
682
+ # whether citations or anti-citations are found.
683
+ # Corresponds to the JSON property `claimText`
684
+ # @return [String]
685
+ attr_accessor :claim_text
686
+
687
+ # Position indicating the end of the claim in the answer candidate, exclusive.
688
+ # Corresponds to the JSON property `endPos`
689
+ # @return [Fixnum]
690
+ attr_accessor :end_pos
691
+
692
+ # Indicates that this claim required grounding check. When the system decided
693
+ # this claim doesn't require attribution/grounding check, this field will be set
694
+ # to false. In that case, no grounding check was done for the claim and
695
+ # therefore citation_indices, and anti_citation_indices should not be returned.
696
+ # Corresponds to the JSON property `groundingCheckRequired`
697
+ # @return [Boolean]
698
+ attr_accessor :grounding_check_required
699
+ alias_method :grounding_check_required?, :grounding_check_required
700
+
701
+ # Position indicating the start of the claim in the answer candidate, measured
702
+ # in bytes.
703
+ # Corresponds to the JSON property `startPos`
704
+ # @return [Fixnum]
705
+ attr_accessor :start_pos
706
+
707
+ def initialize(**args)
708
+ update!(**args)
709
+ end
710
+
711
+ # Update properties of this object
712
+ def update!(**args)
713
+ @citation_indices = args[:citation_indices] if args.key?(:citation_indices)
714
+ @claim_text = args[:claim_text] if args.key?(:claim_text)
715
+ @end_pos = args[:end_pos] if args.key?(:end_pos)
716
+ @grounding_check_required = args[:grounding_check_required] if args.key?(:grounding_check_required)
717
+ @start_pos = args[:start_pos] if args.key?(:start_pos)
718
+ end
719
+ end
720
+
721
+ # Specification for the grounding check.
722
+ class GoogleCloudDiscoveryengineV1CheckGroundingSpec
723
+ include Google::Apis::Core::Hashable
724
+
725
+ # The threshold (in [0,1]) used for determining whether a fact must be cited for
726
+ # a claim in the answer candidate. Choosing a higher threshold will lead to
727
+ # fewer but very strong citations, while choosing a lower threshold may lead to
728
+ # more but somewhat weaker citations. If unset, the threshold will default to 0.
729
+ # 6.
730
+ # Corresponds to the JSON property `citationThreshold`
731
+ # @return [Float]
732
+ attr_accessor :citation_threshold
733
+
734
+ def initialize(**args)
735
+ update!(**args)
736
+ end
737
+
738
+ # Update properties of this object
739
+ def update!(**args)
740
+ @citation_threshold = args[:citation_threshold] if args.key?(:citation_threshold)
741
+ end
742
+ end
743
+
588
744
  # Cloud SQL source import data from.
589
745
  class GoogleCloudDiscoveryengineV1CloudSqlSource
590
746
  include Google::Apis::Core::Hashable
@@ -1937,6 +2093,45 @@ module Google
1937
2093
  end
1938
2094
  end
1939
2095
 
2096
+ # Fact Chunk.
2097
+ class GoogleCloudDiscoveryengineV1FactChunk
2098
+ include Google::Apis::Core::Hashable
2099
+
2100
+ # Text content of the fact chunk. Can be at most 10K characters long.
2101
+ # Corresponds to the JSON property `chunkText`
2102
+ # @return [String]
2103
+ attr_accessor :chunk_text
2104
+
2105
+ # The index of this chunk. Currently, only used for the streaming mode.
2106
+ # Corresponds to the JSON property `index`
2107
+ # @return [Fixnum]
2108
+ attr_accessor :index
2109
+
2110
+ # Source from which this fact chunk was retrieved. If it was retrieved from the
2111
+ # GroundingFacts provided in the request then this field will contain the index
2112
+ # of the specific fact from which this chunk was retrieved.
2113
+ # Corresponds to the JSON property `source`
2114
+ # @return [String]
2115
+ attr_accessor :source
2116
+
2117
+ # More fine-grained information for the source reference.
2118
+ # Corresponds to the JSON property `sourceMetadata`
2119
+ # @return [Hash<String,String>]
2120
+ attr_accessor :source_metadata
2121
+
2122
+ def initialize(**args)
2123
+ update!(**args)
2124
+ end
2125
+
2126
+ # Update properties of this object
2127
+ def update!(**args)
2128
+ @chunk_text = args[:chunk_text] if args.key?(:chunk_text)
2129
+ @index = args[:index] if args.key?(:index)
2130
+ @source = args[:source] if args.key?(:source)
2131
+ @source_metadata = args[:source_metadata] if args.key?(:source_metadata)
2132
+ end
2133
+ end
2134
+
1940
2135
  # Response message for SiteSearchEngineService.FetchDomainVerificationStatus
1941
2136
  # method.
1942
2137
  class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
@@ -2084,6 +2279,33 @@ module Google
2084
2279
  end
2085
2280
  end
2086
2281
 
2282
+ # Grounding Fact.
2283
+ class GoogleCloudDiscoveryengineV1GroundingFact
2284
+ include Google::Apis::Core::Hashable
2285
+
2286
+ # Attributes associated with the fact. Common attributes include `source` (
2287
+ # indicating where the fact was sourced from), `author` (indicating the author
2288
+ # of the fact), and so on.
2289
+ # Corresponds to the JSON property `attributes`
2290
+ # @return [Hash<String,String>]
2291
+ attr_accessor :attributes
2292
+
2293
+ # Text content of the fact. Can be at most 10K characters long.
2294
+ # Corresponds to the JSON property `factText`
2295
+ # @return [String]
2296
+ attr_accessor :fact_text
2297
+
2298
+ def initialize(**args)
2299
+ update!(**args)
2300
+ end
2301
+
2302
+ # Update properties of this object
2303
+ def update!(**args)
2304
+ @attributes = args[:attributes] if args.key?(:attributes)
2305
+ @fact_text = args[:fact_text] if args.key?(:fact_text)
2306
+ end
2307
+ end
2308
+
2087
2309
  # Metadata related to the progress of the ImportDocuments operation. This is
2088
2310
  # returned by the google.longrunning.Operation.metadata field.
2089
2311
  class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
@@ -3406,9 +3628,9 @@ module Google
3406
3628
 
3407
3629
  # The order in which documents are returned. Documents can be ordered by a field
3408
3630
  # in an Document object. Leave it unset if ordered by relevance. `order_by`
3409
- # expression is case-sensitive. For more information on ordering, see [Ordering](
3410
- # https://cloud.google.com/retail/docs/filter-and-order#order) If this field is
3411
- # unrecognizable, an `INVALID_ARGUMENT` is returned.
3631
+ # expression is case-sensitive. For more information on ordering for retail
3632
+ # search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#
3633
+ # order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
3412
3634
  # Corresponds to the JSON property `orderBy`
3413
3635
  # @return [String]
3414
3636
  attr_accessor :order_by
@@ -4684,6 +4906,11 @@ module Google
4684
4906
  # @return [String]
4685
4907
  attr_accessor :provided_uri_pattern
4686
4908
 
4909
+ # Output only. Root domain of the provided_uri_pattern.
4910
+ # Corresponds to the JSON property `rootDomainUri`
4911
+ # @return [String]
4912
+ attr_accessor :root_domain_uri
4913
+
4687
4914
  # Verification information for target sites in advanced site search.
4688
4915
  # Corresponds to the JSON property `siteVerificationInfo`
4689
4916
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteVerificationInfo]
@@ -4712,6 +4939,7 @@ module Google
4712
4939
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
4713
4940
  @name = args[:name] if args.key?(:name)
4714
4941
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
4942
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
4715
4943
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
4716
4944
  @type = args[:type] if args.key?(:type)
4717
4945
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -5846,6 +6074,58 @@ module Google
5846
6074
  end
5847
6075
  end
5848
6076
 
6077
+ # Metadata that describes a custom tuned model.
6078
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
6079
+ include Google::Apis::Core::Hashable
6080
+
6081
+ # Timestamp the Model was created at.
6082
+ # Corresponds to the JSON property `createTime`
6083
+ # @return [String]
6084
+ attr_accessor :create_time
6085
+
6086
+ # The display name of the model.
6087
+ # Corresponds to the JSON property `displayName`
6088
+ # @return [String]
6089
+ attr_accessor :display_name
6090
+
6091
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
6092
+ # Corresponds to the JSON property `modelState`
6093
+ # @return [String]
6094
+ attr_accessor :model_state
6095
+
6096
+ #
6097
+ # Corresponds to the JSON property `modelVersion`
6098
+ # @return [Fixnum]
6099
+ attr_accessor :model_version
6100
+
6101
+ # Required. The fully qualified resource name of the model. Format: `projects/`
6102
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
6103
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
6104
+ # numerical string with limit of 40 characters.
6105
+ # Corresponds to the JSON property `name`
6106
+ # @return [String]
6107
+ attr_accessor :name
6108
+
6109
+ # Timestamp the model training was initiated.
6110
+ # Corresponds to the JSON property `trainingStartTime`
6111
+ # @return [String]
6112
+ attr_accessor :training_start_time
6113
+
6114
+ def initialize(**args)
6115
+ update!(**args)
6116
+ end
6117
+
6118
+ # Update properties of this object
6119
+ def update!(**args)
6120
+ @create_time = args[:create_time] if args.key?(:create_time)
6121
+ @display_name = args[:display_name] if args.key?(:display_name)
6122
+ @model_state = args[:model_state] if args.key?(:model_state)
6123
+ @model_version = args[:model_version] if args.key?(:model_version)
6124
+ @name = args[:name] if args.key?(:name)
6125
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
6126
+ end
6127
+ end
6128
+
5849
6129
  # DataStore captures global settings and configs at the DataStore level.
5850
6130
  class GoogleCloudDiscoveryengineV1alphaDataStore
5851
6131
  include Google::Apis::Core::Hashable
@@ -7153,6 +7433,25 @@ module Google
7153
7433
  end
7154
7434
  end
7155
7435
 
7436
+ # Response message for SearchTuningService.ListCustomModels method.
7437
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
7438
+ include Google::Apis::Core::Hashable
7439
+
7440
+ # List of custom tuning models.
7441
+ # Corresponds to the JSON property `models`
7442
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomTuningModel>]
7443
+ attr_accessor :models
7444
+
7445
+ def initialize(**args)
7446
+ update!(**args)
7447
+ end
7448
+
7449
+ # Update properties of this object
7450
+ def update!(**args)
7451
+ @models = args[:models] if args.key?(:models)
7452
+ end
7453
+ end
7454
+
7156
7455
  # Metadata and configurations for a Google Cloud project in the service.
7157
7456
  class GoogleCloudDiscoveryengineV1alphaProject
7158
7457
  include Google::Apis::Core::Hashable
@@ -7787,6 +8086,11 @@ module Google
7787
8086
  # @return [String]
7788
8087
  attr_accessor :provided_uri_pattern
7789
8088
 
8089
+ # Output only. Root domain of the provided_uri_pattern.
8090
+ # Corresponds to the JSON property `rootDomainUri`
8091
+ # @return [String]
8092
+ attr_accessor :root_domain_uri
8093
+
7790
8094
  # Verification information for target sites in advanced site search.
7791
8095
  # Corresponds to the JSON property `siteVerificationInfo`
7792
8096
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo]
@@ -7815,6 +8119,7 @@ module Google
7815
8119
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
7816
8120
  @name = args[:name] if args.key?(:name)
7817
8121
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
8122
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
7818
8123
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
7819
8124
  @type = args[:type] if args.key?(:type)
7820
8125
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -7907,6 +8212,11 @@ module Google
7907
8212
  # @return [Hash<String,Float>]
7908
8213
  attr_accessor :metrics
7909
8214
 
8215
+ # Fully qualified name of the CustomTuningModel.
8216
+ # Corresponds to the JSON property `modelName`
8217
+ # @return [String]
8218
+ attr_accessor :model_name
8219
+
7910
8220
  # The trained model status. Possible values are: * **bad-data**: The training
7911
8221
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
7912
8222
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -7926,6 +8236,7 @@ module Google
7926
8236
  @error_config = args[:error_config] if args.key?(:error_config)
7927
8237
  @error_samples = args[:error_samples] if args.key?(:error_samples)
7928
8238
  @metrics = args[:metrics] if args.key?(:metrics)
8239
+ @model_name = args[:model_name] if args.key?(:model_name)
7929
8240
  @model_status = args[:model_status] if args.key?(:model_status)
7930
8241
  end
7931
8242
  end
@@ -8174,6 +8485,58 @@ module Google
8174
8485
  end
8175
8486
  end
8176
8487
 
8488
+ # Metadata that describes a custom tuned model.
8489
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
8490
+ include Google::Apis::Core::Hashable
8491
+
8492
+ # Timestamp the Model was created at.
8493
+ # Corresponds to the JSON property `createTime`
8494
+ # @return [String]
8495
+ attr_accessor :create_time
8496
+
8497
+ # The display name of the model.
8498
+ # Corresponds to the JSON property `displayName`
8499
+ # @return [String]
8500
+ attr_accessor :display_name
8501
+
8502
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
8503
+ # Corresponds to the JSON property `modelState`
8504
+ # @return [String]
8505
+ attr_accessor :model_state
8506
+
8507
+ #
8508
+ # Corresponds to the JSON property `modelVersion`
8509
+ # @return [Fixnum]
8510
+ attr_accessor :model_version
8511
+
8512
+ # Required. The fully qualified resource name of the model. Format: `projects/`
8513
+ # project_number`/locations/`location`/collections/`collection`/dataStores/`
8514
+ # data_store`/customTuningModels/`custom_tuning_model`` model must be an alpha-
8515
+ # numerical string with limit of 40 characters.
8516
+ # Corresponds to the JSON property `name`
8517
+ # @return [String]
8518
+ attr_accessor :name
8519
+
8520
+ # Timestamp the model training was initiated.
8521
+ # Corresponds to the JSON property `trainingStartTime`
8522
+ # @return [String]
8523
+ attr_accessor :training_start_time
8524
+
8525
+ def initialize(**args)
8526
+ update!(**args)
8527
+ end
8528
+
8529
+ # Update properties of this object
8530
+ def update!(**args)
8531
+ @create_time = args[:create_time] if args.key?(:create_time)
8532
+ @display_name = args[:display_name] if args.key?(:display_name)
8533
+ @model_state = args[:model_state] if args.key?(:model_state)
8534
+ @model_version = args[:model_version] if args.key?(:model_version)
8535
+ @name = args[:name] if args.key?(:name)
8536
+ @training_start_time = args[:training_start_time] if args.key?(:training_start_time)
8537
+ end
8538
+ end
8539
+
8177
8540
  # DataStore captures global settings and configs at the DataStore level.
8178
8541
  class GoogleCloudDiscoveryengineV1betaDataStore
8179
8542
  include Google::Apis::Core::Hashable
@@ -9020,6 +9383,25 @@ module Google
9020
9383
  end
9021
9384
  end
9022
9385
 
9386
+ # Response message for SearchTuningService.ListCustomModels method.
9387
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
9388
+ include Google::Apis::Core::Hashable
9389
+
9390
+ # List of custom tuning models.
9391
+ # Corresponds to the JSON property `models`
9392
+ # @return [Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCustomTuningModel>]
9393
+ attr_accessor :models
9394
+
9395
+ def initialize(**args)
9396
+ update!(**args)
9397
+ end
9398
+
9399
+ # Update properties of this object
9400
+ def update!(**args)
9401
+ @models = args[:models] if args.key?(:models)
9402
+ end
9403
+ end
9404
+
9023
9405
  # Metadata related to the progress of the PurgeDocuments operation. This will be
9024
9406
  # returned by the google.longrunning.Operation.metadata field.
9025
9407
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
@@ -9249,6 +9631,11 @@ module Google
9249
9631
  # @return [String]
9250
9632
  attr_accessor :provided_uri_pattern
9251
9633
 
9634
+ # Output only. Root domain of the provided_uri_pattern.
9635
+ # Corresponds to the JSON property `rootDomainUri`
9636
+ # @return [String]
9637
+ attr_accessor :root_domain_uri
9638
+
9252
9639
  # Verification information for target sites in advanced site search.
9253
9640
  # Corresponds to the JSON property `siteVerificationInfo`
9254
9641
  # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo]
@@ -9277,6 +9664,7 @@ module Google
9277
9664
  @indexing_status = args[:indexing_status] if args.key?(:indexing_status)
9278
9665
  @name = args[:name] if args.key?(:name)
9279
9666
  @provided_uri_pattern = args[:provided_uri_pattern] if args.key?(:provided_uri_pattern)
9667
+ @root_domain_uri = args[:root_domain_uri] if args.key?(:root_domain_uri)
9280
9668
  @site_verification_info = args[:site_verification_info] if args.key?(:site_verification_info)
9281
9669
  @type = args[:type] if args.key?(:type)
9282
9670
  @update_time = args[:update_time] if args.key?(:update_time)
@@ -9369,6 +9757,11 @@ module Google
9369
9757
  # @return [Hash<String,Float>]
9370
9758
  attr_accessor :metrics
9371
9759
 
9760
+ # Fully qualified name of the CustomTuningModel.
9761
+ # Corresponds to the JSON property `modelName`
9762
+ # @return [String]
9763
+ attr_accessor :model_name
9764
+
9372
9765
  # The trained model status. Possible values are: * **bad-data**: The training
9373
9766
  # data quality is bad. * **no-improvement**: Tuning didn't improve performance.
9374
9767
  # Won't deploy. * **in-progress**: Model training job creation is in progress. *
@@ -9388,6 +9781,7 @@ module Google
9388
9781
  @error_config = args[:error_config] if args.key?(:error_config)
9389
9782
  @error_samples = args[:error_samples] if args.key?(:error_samples)
9390
9783
  @metrics = args[:metrics] if args.key?(:metrics)
9784
+ @model_name = args[:model_name] if args.key?(:model_name)
9391
9785
  @model_status = args[:model_status] if args.key?(:model_status)
9392
9786
  end
9393
9787
  end
@@ -9480,6 +9874,19 @@ module Google
9480
9874
  end
9481
9875
  end
9482
9876
 
9877
+ # The request message for Operations.CancelOperation.
9878
+ class GoogleLongrunningCancelOperationRequest
9879
+ include Google::Apis::Core::Hashable
9880
+
9881
+ def initialize(**args)
9882
+ update!(**args)
9883
+ end
9884
+
9885
+ # Update properties of this object
9886
+ def update!(**args)
9887
+ end
9888
+ end
9889
+
9483
9890
  # The response message for Operations.ListOperations.
9484
9891
  class GoogleLongrunningListOperationsResponse
9485
9892
  include Google::Apis::Core::Hashable
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DiscoveryengineV1
18
18
  # Version of the google-apis-discoveryengine_v1 gem
19
- GEM_VERSION = "0.1.0"
19
+ GEM_VERSION = "0.3.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.14.0"
22
+ GENERATOR_VERSION = "0.15.0"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20240415"
25
+ REVISION = "20240512"
26
26
  end
27
27
  end
28
28
  end
@@ -118,6 +118,30 @@ module Google
118
118
  include Google::Apis::Core::JsonObjectSupport
119
119
  end
120
120
 
121
+ class GoogleCloudDiscoveryengineV1CheckGroundingRequest
122
+ class Representation < Google::Apis::Core::JsonRepresentation; end
123
+
124
+ include Google::Apis::Core::JsonObjectSupport
125
+ end
126
+
127
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponse
128
+ class Representation < Google::Apis::Core::JsonRepresentation; end
129
+
130
+ include Google::Apis::Core::JsonObjectSupport
131
+ end
132
+
133
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
134
+ class Representation < Google::Apis::Core::JsonRepresentation; end
135
+
136
+ include Google::Apis::Core::JsonObjectSupport
137
+ end
138
+
139
+ class GoogleCloudDiscoveryengineV1CheckGroundingSpec
140
+ class Representation < Google::Apis::Core::JsonRepresentation; end
141
+
142
+ include Google::Apis::Core::JsonObjectSupport
143
+ end
144
+
121
145
  class GoogleCloudDiscoveryengineV1CloudSqlSource
122
146
  class Representation < Google::Apis::Core::JsonRepresentation; end
123
147
 
@@ -352,6 +376,12 @@ module Google
352
376
  include Google::Apis::Core::JsonObjectSupport
353
377
  end
354
378
 
379
+ class GoogleCloudDiscoveryengineV1FactChunk
380
+ class Representation < Google::Apis::Core::JsonRepresentation; end
381
+
382
+ include Google::Apis::Core::JsonObjectSupport
383
+ end
384
+
355
385
  class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
356
386
  class Representation < Google::Apis::Core::JsonRepresentation; end
357
387
 
@@ -376,6 +406,12 @@ module Google
376
406
  include Google::Apis::Core::JsonObjectSupport
377
407
  end
378
408
 
409
+ class GoogleCloudDiscoveryengineV1GroundingFact
410
+ class Representation < Google::Apis::Core::JsonRepresentation; end
411
+
412
+ include Google::Apis::Core::JsonObjectSupport
413
+ end
414
+
379
415
  class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
380
416
  class Representation < Google::Apis::Core::JsonRepresentation; end
381
417
 
@@ -982,6 +1018,12 @@ module Google
982
1018
  include Google::Apis::Core::JsonObjectSupport
983
1019
  end
984
1020
 
1021
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
1022
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1023
+
1024
+ include Google::Apis::Core::JsonObjectSupport
1025
+ end
1026
+
985
1027
  class GoogleCloudDiscoveryengineV1alphaDataStore
986
1028
  class Representation < Google::Apis::Core::JsonRepresentation; end
987
1029
 
@@ -1210,6 +1252,12 @@ module Google
1210
1252
  include Google::Apis::Core::JsonObjectSupport
1211
1253
  end
1212
1254
 
1255
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
1256
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1257
+
1258
+ include Google::Apis::Core::JsonObjectSupport
1259
+ end
1260
+
1213
1261
  class GoogleCloudDiscoveryengineV1alphaProject
1214
1262
  class Representation < Google::Apis::Core::JsonRepresentation; end
1215
1263
 
@@ -1408,6 +1456,12 @@ module Google
1408
1456
  include Google::Apis::Core::JsonObjectSupport
1409
1457
  end
1410
1458
 
1459
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
1460
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1461
+
1462
+ include Google::Apis::Core::JsonObjectSupport
1463
+ end
1464
+
1411
1465
  class GoogleCloudDiscoveryengineV1betaDataStore
1412
1466
  class Representation < Google::Apis::Core::JsonRepresentation; end
1413
1467
 
@@ -1564,6 +1618,12 @@ module Google
1564
1618
  include Google::Apis::Core::JsonObjectSupport
1565
1619
  end
1566
1620
 
1621
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
1622
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1623
+
1624
+ include Google::Apis::Core::JsonObjectSupport
1625
+ end
1626
+
1567
1627
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
1568
1628
  class Representation < Google::Apis::Core::JsonRepresentation; end
1569
1629
 
@@ -1654,6 +1714,12 @@ module Google
1654
1714
  include Google::Apis::Core::JsonObjectSupport
1655
1715
  end
1656
1716
 
1717
+ class GoogleLongrunningCancelOperationRequest
1718
+ class Representation < Google::Apis::Core::JsonRepresentation; end
1719
+
1720
+ include Google::Apis::Core::JsonObjectSupport
1721
+ end
1722
+
1657
1723
  class GoogleLongrunningListOperationsResponse
1658
1724
  class Representation < Google::Apis::Core::JsonRepresentation; end
1659
1725
 
@@ -1836,6 +1902,47 @@ module Google
1836
1902
  end
1837
1903
  end
1838
1904
 
1905
+ class GoogleCloudDiscoveryengineV1CheckGroundingRequest
1906
+ # @private
1907
+ class Representation < Google::Apis::Core::JsonRepresentation
1908
+ property :answer_candidate, as: 'answerCandidate'
1909
+ collection :facts, as: 'facts', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundingFact, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1GroundingFact::Representation
1910
+
1911
+ property :grounding_spec, as: 'groundingSpec', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingSpec, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingSpec::Representation
1912
+
1913
+ hash :user_labels, as: 'userLabels'
1914
+ end
1915
+ end
1916
+
1917
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponse
1918
+ # @private
1919
+ class Representation < Google::Apis::Core::JsonRepresentation
1920
+ collection :cited_chunks, as: 'citedChunks', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1FactChunk::Representation
1921
+
1922
+ collection :claims, as: 'claims', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim::Representation
1923
+
1924
+ property :support_score, as: 'supportScore'
1925
+ end
1926
+ end
1927
+
1928
+ class GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim
1929
+ # @private
1930
+ class Representation < Google::Apis::Core::JsonRepresentation
1931
+ collection :citation_indices, as: 'citationIndices'
1932
+ property :claim_text, as: 'claimText'
1933
+ property :end_pos, as: 'endPos'
1934
+ property :grounding_check_required, as: 'groundingCheckRequired'
1935
+ property :start_pos, as: 'startPos'
1936
+ end
1937
+ end
1938
+
1939
+ class GoogleCloudDiscoveryengineV1CheckGroundingSpec
1940
+ # @private
1941
+ class Representation < Google::Apis::Core::JsonRepresentation
1942
+ property :citation_threshold, as: 'citationThreshold'
1943
+ end
1944
+ end
1945
+
1839
1946
  class GoogleCloudDiscoveryengineV1CloudSqlSource
1840
1947
  # @private
1841
1948
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2206,6 +2313,16 @@ module Google
2206
2313
  end
2207
2314
  end
2208
2315
 
2316
+ class GoogleCloudDiscoveryengineV1FactChunk
2317
+ # @private
2318
+ class Representation < Google::Apis::Core::JsonRepresentation
2319
+ property :chunk_text, as: 'chunkText'
2320
+ property :index, as: 'index'
2321
+ property :source, as: 'source'
2322
+ hash :source_metadata, as: 'sourceMetadata'
2323
+ end
2324
+ end
2325
+
2209
2326
  class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
2210
2327
  # @private
2211
2328
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2242,6 +2359,14 @@ module Google
2242
2359
  end
2243
2360
  end
2244
2361
 
2362
+ class GoogleCloudDiscoveryengineV1GroundingFact
2363
+ # @private
2364
+ class Representation < Google::Apis::Core::JsonRepresentation
2365
+ hash :attributes, as: 'attributes'
2366
+ property :fact_text, as: 'factText'
2367
+ end
2368
+ end
2369
+
2245
2370
  class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
2246
2371
  # @private
2247
2372
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -2937,6 +3062,7 @@ module Google
2937
3062
  property :indexing_status, as: 'indexingStatus'
2938
3063
  property :name, as: 'name'
2939
3064
  property :provided_uri_pattern, as: 'providedUriPattern'
3065
+ property :root_domain_uri, as: 'rootDomainUri'
2940
3066
  property :site_verification_info, as: 'siteVerificationInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteVerificationInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SiteVerificationInfo::Representation
2941
3067
 
2942
3068
  property :type, as: 'type'
@@ -3264,6 +3390,18 @@ module Google
3264
3390
  end
3265
3391
  end
3266
3392
 
3393
+ class GoogleCloudDiscoveryengineV1alphaCustomTuningModel
3394
+ # @private
3395
+ class Representation < Google::Apis::Core::JsonRepresentation
3396
+ property :create_time, as: 'createTime'
3397
+ property :display_name, as: 'displayName'
3398
+ property :model_state, as: 'modelState'
3399
+ property :model_version, :numeric_string => true, as: 'modelVersion'
3400
+ property :name, as: 'name'
3401
+ property :training_start_time, as: 'trainingStartTime'
3402
+ end
3403
+ end
3404
+
3267
3405
  class GoogleCloudDiscoveryengineV1alphaDataStore
3268
3406
  # @private
3269
3407
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3623,6 +3761,14 @@ module Google
3623
3761
  end
3624
3762
  end
3625
3763
 
3764
+ class GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
3765
+ # @private
3766
+ class Representation < Google::Apis::Core::JsonRepresentation
3767
+ collection :models, as: 'models', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomTuningModel, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaCustomTuningModel::Representation
3768
+
3769
+ end
3770
+ end
3771
+
3626
3772
  class GoogleCloudDiscoveryengineV1alphaProject
3627
3773
  # @private
3628
3774
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -3802,6 +3948,7 @@ module Google
3802
3948
  property :indexing_status, as: 'indexingStatus'
3803
3949
  property :name, as: 'name'
3804
3950
  property :provided_uri_pattern, as: 'providedUriPattern'
3951
+ property :root_domain_uri, as: 'rootDomainUri'
3805
3952
  property :site_verification_info, as: 'siteVerificationInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo::Representation
3806
3953
 
3807
3954
  property :type, as: 'type'
@@ -3840,6 +3987,7 @@ module Google
3840
3987
  collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
3841
3988
 
3842
3989
  hash :metrics, as: 'metrics'
3990
+ property :model_name, as: 'modelName'
3843
3991
  property :model_status, as: 'modelStatus'
3844
3992
  end
3845
3993
  end
@@ -3921,6 +4069,18 @@ module Google
3921
4069
  end
3922
4070
  end
3923
4071
 
4072
+ class GoogleCloudDiscoveryengineV1betaCustomTuningModel
4073
+ # @private
4074
+ class Representation < Google::Apis::Core::JsonRepresentation
4075
+ property :create_time, as: 'createTime'
4076
+ property :display_name, as: 'displayName'
4077
+ property :model_state, as: 'modelState'
4078
+ property :model_version, :numeric_string => true, as: 'modelVersion'
4079
+ property :name, as: 'name'
4080
+ property :training_start_time, as: 'trainingStartTime'
4081
+ end
4082
+ end
4083
+
3924
4084
  class GoogleCloudDiscoveryengineV1betaDataStore
3925
4085
  # @private
3926
4086
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4163,6 +4323,14 @@ module Google
4163
4323
  end
4164
4324
  end
4165
4325
 
4326
+ class GoogleCloudDiscoveryengineV1betaListCustomModelsResponse
4327
+ # @private
4328
+ class Representation < Google::Apis::Core::JsonRepresentation
4329
+ collection :models, as: 'models', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCustomTuningModel, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaCustomTuningModel::Representation
4330
+
4331
+ end
4332
+ end
4333
+
4166
4334
  class GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata
4167
4335
  # @private
4168
4336
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -4226,6 +4394,7 @@ module Google
4226
4394
  property :indexing_status, as: 'indexingStatus'
4227
4395
  property :name, as: 'name'
4228
4396
  property :provided_uri_pattern, as: 'providedUriPattern'
4397
+ property :root_domain_uri, as: 'rootDomainUri'
4229
4398
  property :site_verification_info, as: 'siteVerificationInfo', class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo, decorator: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaSiteVerificationInfo::Representation
4230
4399
 
4231
4400
  property :type, as: 'type'
@@ -4264,6 +4433,7 @@ module Google
4264
4433
  collection :error_samples, as: 'errorSamples', class: Google::Apis::DiscoveryengineV1::GoogleRpcStatus, decorator: Google::Apis::DiscoveryengineV1::GoogleRpcStatus::Representation
4265
4434
 
4266
4435
  hash :metrics, as: 'metrics'
4436
+ property :model_name, as: 'modelName'
4267
4437
  property :model_status, as: 'modelStatus'
4268
4438
  end
4269
4439
  end
@@ -4297,6 +4467,12 @@ module Google
4297
4467
  end
4298
4468
  end
4299
4469
 
4470
+ class GoogleLongrunningCancelOperationRequest
4471
+ # @private
4472
+ class Representation < Google::Apis::Core::JsonRepresentation
4473
+ end
4474
+ end
4475
+
4300
4476
  class GoogleLongrunningListOperationsResponse
4301
4477
  # @private
4302
4478
  class Representation < Google::Apis::Core::JsonRepresentation
@@ -342,7 +342,7 @@ module Google
342
342
  # permission to list DataStores under this location, regardless of whether or
343
343
  # not this data store exists, a PERMISSION_DENIED error is returned.
344
344
  # @param [String] filter
345
- # Filter by solution type. For example: filter = 'solution_type:
345
+ # Filter by solution type . For example: filter = 'solution_type:
346
346
  # SOLUTION_TYPE_SEARCH'
347
347
  # @param [Fixnum] page_size
348
348
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
@@ -704,6 +704,46 @@ module Google
704
704
  execute_or_queue_command(command, &block)
705
705
  end
706
706
 
707
+ # Starts asynchronous cancellation on a long-running operation. The server makes
708
+ # a best effort to cancel the operation, but success is not guaranteed. If the
709
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
710
+ # Clients can use Operations.GetOperation or other methods to check whether the
711
+ # cancellation succeeded or whether the operation completed despite cancellation.
712
+ # On successful cancellation, the operation is not deleted; instead, it becomes
713
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
714
+ # corresponding to `Code.CANCELLED`.
715
+ # @param [String] name
716
+ # The name of the operation resource to be cancelled.
717
+ # @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
718
+ # @param [String] fields
719
+ # Selector specifying which fields to include in a partial response.
720
+ # @param [String] quota_user
721
+ # Available to use for quota purposes for server-side applications. Can be any
722
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
723
+ # @param [Google::Apis::RequestOptions] options
724
+ # Request-specific options
725
+ #
726
+ # @yield [result, err] Result & error if block supplied
727
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
728
+ # @yieldparam err [StandardError] error object if request failed
729
+ #
730
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
731
+ #
732
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
733
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
734
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
735
+ def cancel_project_location_collection_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
736
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
737
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
738
+ command.request_object = google_longrunning_cancel_operation_request_object
739
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
740
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
741
+ command.params['name'] = name unless name.nil?
742
+ command.query['fields'] = fields unless fields.nil?
743
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
744
+ execute_or_queue_command(command, &block)
745
+ end
746
+
707
747
  # Gets the latest state of a long-running operation. Clients can use this method
708
748
  # to poll the operation result at intervals as recommended by the API service.
709
749
  # @param [String] name
@@ -3075,7 +3115,7 @@ module Google
3075
3115
  # permission to list DataStores under this location, regardless of whether or
3076
3116
  # not this data store exists, a PERMISSION_DENIED error is returned.
3077
3117
  # @param [String] filter
3078
- # Filter by solution type. For example: filter = 'solution_type:
3118
+ # Filter by solution type . For example: filter = 'solution_type:
3079
3119
  # SOLUTION_TYPE_SEARCH'
3080
3120
  # @param [Fixnum] page_size
3081
3121
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
@@ -3437,6 +3477,46 @@ module Google
3437
3477
  execute_or_queue_command(command, &block)
3438
3478
  end
3439
3479
 
3480
+ # Starts asynchronous cancellation on a long-running operation. The server makes
3481
+ # a best effort to cancel the operation, but success is not guaranteed. If the
3482
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
3483
+ # Clients can use Operations.GetOperation or other methods to check whether the
3484
+ # cancellation succeeded or whether the operation completed despite cancellation.
3485
+ # On successful cancellation, the operation is not deleted; instead, it becomes
3486
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
3487
+ # corresponding to `Code.CANCELLED`.
3488
+ # @param [String] name
3489
+ # The name of the operation resource to be cancelled.
3490
+ # @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
3491
+ # @param [String] fields
3492
+ # Selector specifying which fields to include in a partial response.
3493
+ # @param [String] quota_user
3494
+ # Available to use for quota purposes for server-side applications. Can be any
3495
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
3496
+ # @param [Google::Apis::RequestOptions] options
3497
+ # Request-specific options
3498
+ #
3499
+ # @yield [result, err] Result & error if block supplied
3500
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
3501
+ # @yieldparam err [StandardError] error object if request failed
3502
+ #
3503
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
3504
+ #
3505
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
3506
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
3507
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
3508
+ def cancel_project_location_data_store_branch_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
3509
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
3510
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
3511
+ command.request_object = google_longrunning_cancel_operation_request_object
3512
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
3513
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
3514
+ command.params['name'] = name unless name.nil?
3515
+ command.query['fields'] = fields unless fields.nil?
3516
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
3517
+ execute_or_queue_command(command, &block)
3518
+ end
3519
+
3440
3520
  # Gets the latest state of a long-running operation. Clients can use this method
3441
3521
  # to poll the operation result at intervals as recommended by the API service.
3442
3522
  # @param [String] name
@@ -4659,6 +4739,40 @@ module Google
4659
4739
  execute_or_queue_command(command, &block)
4660
4740
  end
4661
4741
 
4742
+ # Performs a grounding check.
4743
+ # @param [String] grounding_config
4744
+ # Required. The resource name of the grounding config, such as `projects/*/
4745
+ # locations/global/groundingConfigs/default_grounding_config`.
4746
+ # @param [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingRequest] google_cloud_discoveryengine_v1_check_grounding_request_object
4747
+ # @param [String] fields
4748
+ # Selector specifying which fields to include in a partial response.
4749
+ # @param [String] quota_user
4750
+ # Available to use for quota purposes for server-side applications. Can be any
4751
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4752
+ # @param [Google::Apis::RequestOptions] options
4753
+ # Request-specific options
4754
+ #
4755
+ # @yield [result, err] Result & error if block supplied
4756
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse] parsed result object
4757
+ # @yieldparam err [StandardError] error object if request failed
4758
+ #
4759
+ # @return [Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse]
4760
+ #
4761
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4762
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4763
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4764
+ def check_project_location_grounding_config(grounding_config, google_cloud_discoveryengine_v1_check_grounding_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4765
+ command = make_simple_command(:post, 'v1/{+groundingConfig}:check', options)
4766
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingRequest::Representation
4767
+ command.request_object = google_cloud_discoveryengine_v1_check_grounding_request_object
4768
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse::Representation
4769
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1CheckGroundingResponse
4770
+ command.params['groundingConfig'] = grounding_config unless grounding_config.nil?
4771
+ command.query['fields'] = fields unless fields.nil?
4772
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4773
+ execute_or_queue_command(command, &block)
4774
+ end
4775
+
4662
4776
  # Gets the latest state of a long-running operation. Clients can use this method
4663
4777
  # to poll the operation result at intervals as recommended by the API service.
4664
4778
  # @param [String] name
@@ -4768,6 +4882,46 @@ module Google
4768
4882
  execute_or_queue_command(command, &block)
4769
4883
  end
4770
4884
 
4885
+ # Starts asynchronous cancellation on a long-running operation. The server makes
4886
+ # a best effort to cancel the operation, but success is not guaranteed. If the
4887
+ # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
4888
+ # Clients can use Operations.GetOperation or other methods to check whether the
4889
+ # cancellation succeeded or whether the operation completed despite cancellation.
4890
+ # On successful cancellation, the operation is not deleted; instead, it becomes
4891
+ # an operation with an Operation.error value with a google.rpc.Status.code of 1,
4892
+ # corresponding to `Code.CANCELLED`.
4893
+ # @param [String] name
4894
+ # The name of the operation resource to be cancelled.
4895
+ # @param [Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest] google_longrunning_cancel_operation_request_object
4896
+ # @param [String] fields
4897
+ # Selector specifying which fields to include in a partial response.
4898
+ # @param [String] quota_user
4899
+ # Available to use for quota purposes for server-side applications. Can be any
4900
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4901
+ # @param [Google::Apis::RequestOptions] options
4902
+ # Request-specific options
4903
+ #
4904
+ # @yield [result, err] Result & error if block supplied
4905
+ # @yieldparam result [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty] parsed result object
4906
+ # @yieldparam err [StandardError] error object if request failed
4907
+ #
4908
+ # @return [Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty]
4909
+ #
4910
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4911
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4912
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4913
+ def cancel_project_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
4914
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
4915
+ command.request_representation = Google::Apis::DiscoveryengineV1::GoogleLongrunningCancelOperationRequest::Representation
4916
+ command.request_object = google_longrunning_cancel_operation_request_object
4917
+ command.response_representation = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty::Representation
4918
+ command.response_class = Google::Apis::DiscoveryengineV1::GoogleProtobufEmpty
4919
+ command.params['name'] = name unless name.nil?
4920
+ command.query['fields'] = fields unless fields.nil?
4921
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4922
+ execute_or_queue_command(command, &block)
4923
+ end
4924
+
4771
4925
  # Gets the latest state of a long-running operation. Clients can use this method
4772
4926
  # to poll the operation result at intervals as recommended by the API service.
4773
4927
  # @param [String] name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-21 00:00:00.000000000 Z
11
+ date: 2024-05-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.14.0
19
+ version: 0.15.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.14.0
29
+ version: 0.15.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.1.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1/v0.3.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1
63
63
  post_install_message:
64
64
  rdoc_options: []