google-apis-discoveryengine_v1 0.2.0 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/lib/google/apis/discoveryengine_v1/classes.rb +235 -0
- data/lib/google/apis/discoveryengine_v1/gem_version.rb +3 -3
- data/lib/google/apis/discoveryengine_v1/representations.rb +107 -0
- data/lib/google/apis/discoveryengine_v1/service.rb +154 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b9a4c8f7d5b3f499f35a48792cab0494ddba1484464125171b8ffcc48b5b0eec
|
4
|
+
data.tar.gz: 7be2a275f8b2f4ee889b683297e357ba3258c41ac89059d789b0a983a5c9813f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eda0dee84899edce2a700f54eb393b71211ab98a7784eecc24b62cae0a16de412a204e46c843956e4f380e48db9cd7792317aebe06de9ad9f0bc35ce0e7187bd
|
7
|
+
data.tar.gz: fb7fe67b7fc9dd2fb850d8aacb1349369806c69eee7ac124ef9030da4d8c9b764bf1bc388c82c79517b61e9c7db22defc5447dda72c15fe946bf1c8bcc538c72
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,10 @@
|
|
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
|
+
|
3
8
|
### v0.2.0 (2024-05-05)
|
4
9
|
|
5
10
|
* Regenerated from discovery document revision 20240502
|
@@ -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
|
@@ -9652,6 +9874,19 @@ module Google
|
|
9652
9874
|
end
|
9653
9875
|
end
|
9654
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
|
+
|
9655
9890
|
# The response message for Operations.ListOperations.
|
9656
9891
|
class GoogleLongrunningListOperationsResponse
|
9657
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.
|
19
|
+
GEM_VERSION = "0.3.0"
|
20
20
|
|
21
21
|
# Version of the code generator used to generate this client
|
22
|
-
GENERATOR_VERSION = "0.
|
22
|
+
GENERATOR_VERSION = "0.15.0"
|
23
23
|
|
24
24
|
# Revision of the discovery document this client was generated from
|
25
|
-
REVISION = "
|
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
|
|
@@ -1678,6 +1714,12 @@ module Google
|
|
1678
1714
|
include Google::Apis::Core::JsonObjectSupport
|
1679
1715
|
end
|
1680
1716
|
|
1717
|
+
class GoogleLongrunningCancelOperationRequest
|
1718
|
+
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1719
|
+
|
1720
|
+
include Google::Apis::Core::JsonObjectSupport
|
1721
|
+
end
|
1722
|
+
|
1681
1723
|
class GoogleLongrunningListOperationsResponse
|
1682
1724
|
class Representation < Google::Apis::Core::JsonRepresentation; end
|
1683
1725
|
|
@@ -1860,6 +1902,47 @@ module Google
|
|
1860
1902
|
end
|
1861
1903
|
end
|
1862
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
|
+
|
1863
1946
|
class GoogleCloudDiscoveryengineV1CloudSqlSource
|
1864
1947
|
# @private
|
1865
1948
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2230,6 +2313,16 @@ module Google
|
|
2230
2313
|
end
|
2231
2314
|
end
|
2232
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
|
+
|
2233
2326
|
class GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
|
2234
2327
|
# @private
|
2235
2328
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -2266,6 +2359,14 @@ module Google
|
|
2266
2359
|
end
|
2267
2360
|
end
|
2268
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
|
+
|
2269
2370
|
class GoogleCloudDiscoveryengineV1ImportDocumentsMetadata
|
2270
2371
|
# @private
|
2271
2372
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -4366,6 +4467,12 @@ module Google
|
|
4366
4467
|
end
|
4367
4468
|
end
|
4368
4469
|
|
4470
|
+
class GoogleLongrunningCancelOperationRequest
|
4471
|
+
# @private
|
4472
|
+
class Representation < Google::Apis::Core::JsonRepresentation
|
4473
|
+
end
|
4474
|
+
end
|
4475
|
+
|
4369
4476
|
class GoogleLongrunningListOperationsResponse
|
4370
4477
|
# @private
|
4371
4478
|
class Representation < Google::Apis::Core::JsonRepresentation
|
@@ -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
|
@@ -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.
|
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-05-
|
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.
|
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.
|
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.
|
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: []
|