google-developers-developer_knowledge-v1 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a185cca272722bd1eb17dd4377c8c3836e9951e7f298ac2bb1c2fcdcca12325a
-  data.tar.gz: 700acb9c35753ba1ad29f15a7b91a884fae665d4e11cc9445ff87f81a215f0c5
+  metadata.gz: ee4729b01d4e0fcdf8e649be0b2147f1eeaa90cd147b7af4427c88e38fab4ad3
+  data.tar.gz: 103d3fbf909989b6aff8c06ec4fcad3cf836be5e2d7d1c90a7654b4d76eada82
 SHA512:
-  metadata.gz: 1605ca2e59e95e4febbcccca6d5afebd2e2c8fb4cce747259f2680fcf966d5c2a0a5addce6756665a3c089b8fa339228bc2b8902296e4b42af21a3c53c11e681
-  data.tar.gz: 69304a15c3be5bbb808c9d3cf57289c2b26375e27644fbaedc2eacd5eb9515af2779a8c8dde67f0916ed74e1aced8e8d9f15963d16c16a5cc313290cf73c0361
+  metadata.gz: c75b827aa790cc49f5b00cf58a5b535992f211c6fa12f91b0fe4903574d9549ac032620e29508672056b4518d4b2226e8d71fb9b1c810ba31051158735595fc8
+  data.tar.gz: cada3ca87b2faca794a7a5583c24495c6f55baf9420547a26e7327dad1993730287ce53cabeba4003a0cdcc26b48887f85514360bd6c8579341dfbf129543e27

data/README.md

@@ -85,7 +85,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 3.0+.
+This library is supported on Ruby 3.2+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/developers/developer_knowledge/v1/developer_knowledge/client.rb

@@ -246,8 +246,7 @@ module Google
             #
             #     If unspecified, at most 5 results will be returned.
             #
-            #     The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT
-            #     error.
+            #     The maximum value is 100; values above 100 will be coerced to 100.
             #   @param page_token [::String]
             #     Optional. Contains a page token, received from a previous
             #     `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
@@ -278,6 +277,10 @@ module Google
             #     TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators.
             #     Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`.
             #
+            #     Note: Field names must be in `snake_case` (e.g., `data_source`). Values on
+            #     the right-hand side of filtering expressions must be string literals
+            #     enclosed in double quotes (e.g., `"docs.cloud.google.com"`).
+            #
             #     You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical
             #     operators. `OR` has higher precedence than `AND`. Use parentheses for
             #     explicit precedence grouping.
@@ -285,11 +288,11 @@ module Google
             #     Examples:
             #
             #     * `data_source = "docs.cloud.google.com" OR data_source =
-            #     "firebase.google.com"`
+            #       "firebase.google.com"`
             #     * `data_source != "firebase.google.com"`
             #     * `update_time < "2024-01-01T00:00:00Z"`
             #     * `update_time >= "2025-01-22T00:00:00Z" AND (data_source =
-            #     "developer.chrome.com" OR data_source = "web.dev")`
+            #       "developer.chrome.com" OR data_source = "web.dev")`
             #     * `uri = "https://docs.cloud.google.com/release-notes"`
             #
             #     The `filter` string must not exceed 500 characters; values longer than 500
@@ -538,6 +541,83 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Answers a query using grounded generation.
+            #
+            # @overload answer_query(request, options = nil)
+            #   Pass arguments to `answer_query` via a request object, either of type
+            #   {::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload answer_query(query: nil)
+            #   Pass arguments to `answer_query` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param query [::String]
+            #     Required. The query to answer.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/developers/developer_knowledge/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new
+            #
+            #   # Call the answer_query method.
+            #   result = client.answer_query request
+            #
+            #   # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.
+            #   p result
+            #
+            def answer_query request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.answer_query.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.answer_query.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.answer_query.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @developer_knowledge_stub.call_rpc :answer_query, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Configuration class for the DeveloperKnowledge API.
             #
@@ -634,6 +714,7 @@ module Google
             #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
             #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
             #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+            #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
             #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
             #       trigger a retry.
             #   @return [::Hash]
@@ -717,6 +798,7 @@ module Google
               #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
               #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
               #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
               #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
               #         trigger a retry.
               #
@@ -736,6 +818,11 @@ module Google
                 # @return [::Gapic::Config::Method]
                 #
                 attr_reader :batch_get_documents
+                ##
+                # RPC-specific configuration for `answer_query`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :answer_query
 
                 # @private
                 def initialize parent_rpcs = nil
@@ -745,6 +832,8 @@ module Google
                   @get_document = ::Gapic::Config::Method.new get_document_config
                   batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
                   @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
+                  answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query
+                  @answer_query = ::Gapic::Config::Method.new answer_query_config
 
                   yield self if block_given?
                 end

data/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/client.rb

@@ -239,8 +239,7 @@ module Google
               #
               #     If unspecified, at most 5 results will be returned.
               #
-              #     The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT
-              #     error.
+              #     The maximum value is 100; values above 100 will be coerced to 100.
               #   @param page_token [::String]
               #     Optional. Contains a page token, received from a previous
               #     `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
@@ -271,6 +270,10 @@ module Google
               #     TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators.
               #     Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`.
               #
+              #     Note: Field names must be in `snake_case` (e.g., `data_source`). Values on
+              #     the right-hand side of filtering expressions must be string literals
+              #     enclosed in double quotes (e.g., `"docs.cloud.google.com"`).
+              #
               #     You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical
               #     operators. `OR` has higher precedence than `AND`. Use parentheses for
               #     explicit precedence grouping.
@@ -278,11 +281,11 @@ module Google
               #     Examples:
               #
               #     * `data_source = "docs.cloud.google.com" OR data_source =
-              #     "firebase.google.com"`
+              #       "firebase.google.com"`
               #     * `data_source != "firebase.google.com"`
               #     * `update_time < "2024-01-01T00:00:00Z"`
               #     * `update_time >= "2025-01-22T00:00:00Z" AND (data_source =
-              #     "developer.chrome.com" OR data_source = "web.dev")`
+              #       "developer.chrome.com" OR data_source = "web.dev")`
               #     * `uri = "https://docs.cloud.google.com/release-notes"`
               #
               #     The `filter` string must not exceed 500 characters; values longer than 500
@@ -526,6 +529,84 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Answers a query using grounded generation.
+              #
+              # @overload answer_query(request, options = nil)
+              #   Pass arguments to `answer_query` via a request object, either of type
+              #   {::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload answer_query(query: nil)
+              #   Pass arguments to `answer_query` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param query [::String]
+              #     Required. The query to answer.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/developers/developer_knowledge/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest.new
+              #
+              #   # Call the answer_query method.
+              #   result = client.answer_query request
+              #
+              #   # The returned object is of type Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.
+              #   p result
+              #
+              def answer_query request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.answer_query.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Developers::DeveloperKnowledge::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.answer_query.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.answer_query.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @developer_knowledge_stub.answer_query request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the DeveloperKnowledge REST API.
               #
@@ -596,6 +677,7 @@ module Google
               #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
               #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
               #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
               #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
               #       trigger a retry.
               #   @return [::Hash]
@@ -668,6 +750,7 @@ module Google
                 #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
                 #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
                 #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
                 #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
                 #         trigger a retry.
                 #
@@ -687,6 +770,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :batch_get_documents
+                  ##
+                  # RPC-specific configuration for `answer_query`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :answer_query
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -696,6 +784,8 @@ module Google
                     @get_document = ::Gapic::Config::Method.new get_document_config
                     batch_get_documents_config = parent_rpcs.batch_get_documents if parent_rpcs.respond_to? :batch_get_documents
                     @batch_get_documents = ::Gapic::Config::Method.new batch_get_documents_config
+                    answer_query_config = parent_rpcs.answer_query if parent_rpcs.respond_to? :answer_query
+                    @answer_query = ::Gapic::Config::Method.new answer_query_config
 
                     yield self if block_given?
                   end

data/lib/google/developers/developer_knowledge/v1/developer_knowledge/rest/service_stub.rb

@@ -193,6 +193,46 @@ module Google
                 end
               end
 
+              ##
+              # Baseline implementation for the answer_query REST call
+              #
+              # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse]
+              #   A result object deserialized from the server's reply
+              def answer_query request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_answer_query_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "answer_query",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
               ##
               # @private
               #
@@ -251,6 +291,26 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the answer_query REST call
+              #
+              # @param request_pb [::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_answer_query_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1:answerQuery",
+                                                          body: "*",
+                                                          matches: []
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

data/lib/google/developers/developer_knowledge/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Developers
     module DeveloperKnowledge
       module V1
-        VERSION = "0.1.0"
+        VERSION = "0.2.1"
       end
     end
   end

data/lib/google/developers/knowledge/v1/developerknowledge_pb.rb

@@ -11,7 +11,7 @@ require 'google/api/resource_pb'
 require 'google/protobuf/timestamp_pb'
 
 
-descriptor_data = "\n7google/developers/knowledge/v1/developerknowledge.proto\x12\x1egoogle.developers.knowledge.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xe0\x02\n\x08\x44ocument\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x10\n\x03uri\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x61ta_source\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x12\n\x05title\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x04view\x18\x08 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x03:Z\xea\x41W\n*developerknowledge.googleapis.com/Document\x12\x14\x64ocuments/{document}*\tdocuments2\x08\x64ocument\"w\n\x1bSearchDocumentChunksRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x04 \x01(\tB\x03\xe0\x41\x01\"|\n\x1cSearchDocumentChunksResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.google.developers.knowledge.v1.DocumentChunk\x12\x1c\n\x0fnext_page_token\x18\x02 \x01(\tB\x03\xe0\x41\x01\"\x97\x01\n\x12GetDocumentRequest\x12@\n\x04name\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"\x9e\x01\n\x18\x42\x61tchGetDocumentsRequest\x12\x41\n\x05names\x18\x01 \x03(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"X\n\x19\x42\x61tchGetDocumentsResponse\x12;\n\tdocuments\x18\x01 \x03(\x0b\x32(.google.developers.knowledge.v1.Document\"\xbb\x01\n\rDocumentChunk\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x03\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12\x0f\n\x02id\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12?\n\x08\x64ocument\x18\x04 \x01(\x0b\x32(.google.developers.knowledge.v1.DocumentB\x03\xe0\x41\x03*y\n\x0c\x44ocumentView\x12\x1d\n\x19\x44OCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\n\x13\x44OCUMENT_VIEW_BASIC\x10\x01\x12\x16\n\x12\x44OCUMENT_VIEW_FULL\x10\x02\x12\x19\n\x15\x44OCUMENT_VIEW_CONTENT\x10\x03\x32\xec\x04\n\x12\x44\x65veloperKnowledge\x12\xbd\x01\n\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1a<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xd3\xe4\x93\x02$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\n\x0bGetDocument\x12\x32.google.developers.knowledge.v1.GetDocumentRequest\x1a(.google.developers.knowledge.v1.Document\"&\xda\x41\x04name\x82\xd3\xe4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xa8\x01\n\x11\x42\x61tchGetDocuments\x12\x38.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1a\x39.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1e\x82\xd3\xe4\x93\x02\x18\x12\x16/v1/documents:batchGet\x1aU\xca\x41!developerknowledge.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x89\x02\n\"com.google.developers.knowledge.v1B\x17\x44\x65veloperKnowledgeProtoP\x01ZGgoogle.golang.org/genproto/googleapis/developers/knowledge/v1;knowledge\xaa\x02\'Google.Developers.DeveloperKnowledge.V1\xca\x02\'Google\\Developers\\DeveloperKnowledge\\V1\xea\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3"
+descriptor_data = "\n7google/developers/knowledge/v1/developerknowledge.proto\x12\x1egoogle.developers.knowledge.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\x83\x03\n\x08\x44ocument\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x08\x12\x10\n\x03uri\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x65scription\x18\x04 \x01(\tB\x03\xe0\x41\x03\x12\x18\n\x0b\x64\x61ta_source\x18\x05 \x01(\tB\x03\xe0\x41\x03\x12\x12\n\x05title\x18\x06 \x01(\tB\x03\xe0\x41\x03\x12\x34\n\x0bupdate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x03\xe0\x41\x03\x12?\n\x04view\x18\x08 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x03\x12!\n\x14\x63ontent_length_bytes\x18\t \x01(\x05\x42\x03\xe0\x41\x03:Z\xea\x41W\n*developerknowledge.googleapis.com/Document\x12\x14\x64ocuments/{document}*\tdocuments2\x08\x64ocument\"w\n\x1bSearchDocumentChunksRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\x12\x16\n\tpage_size\x18\x02 \x01(\x05\x42\x03\xe0\x41\x01\x12\x17\n\npage_token\x18\x03 \x01(\tB\x03\xe0\x41\x01\x12\x13\n\x06\x66ilter\x18\x04 \x01(\tB\x03\xe0\x41\x01\"|\n\x1cSearchDocumentChunksResponse\x12>\n\x07results\x18\x01 \x03(\x0b\x32-.google.developers.knowledge.v1.DocumentChunk\x12\x1c\n\x0fnext_page_token\x18\x02 \x01(\tB\x03\xe0\x41\x01\"\x97\x01\n\x12GetDocumentRequest\x12@\n\x04name\x18\x01 \x01(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"\x9e\x01\n\x18\x42\x61tchGetDocumentsRequest\x12\x41\n\x05names\x18\x01 \x03(\tB2\xe0\x41\x02\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12?\n\x04view\x18\x02 \x01(\x0e\x32,.google.developers.knowledge.v1.DocumentViewB\x03\xe0\x41\x01\"X\n\x19\x42\x61tchGetDocumentsResponse\x12;\n\tdocuments\x18\x01 \x03(\x0b\x32(.google.developers.knowledge.v1.Document\"(\n\x12\x41nswerQueryRequest\x12\x12\n\x05query\x18\x01 \x01(\tB\x03\xe0\x41\x02\"M\n\x13\x41nswerQueryResponse\x12\x36\n\x06\x61nswer\x18\x01 \x01(\x0b\x32&.google.developers.knowledge.v1.Answer\"\xdb\x04\n\x06\x41nswer\x12\x13\n\x0b\x61nswer_text\x18\x01 \x01(\t\x12M\n\tcitations\x18\x02 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.AnswerCitationB\x03\xe0\x41\x03\x12O\n\nreferences\x18\x03 \x03(\x0b\x32\x36.google.developers.knowledge.v1.Answer.AnswerReferenceB\x03\xe0\x41\x03\x1a\x8f\x01\n\x0e\x41nswerCitation\x12\x18\n\x0bstart_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x12\x16\n\tend_index\x18\x02 \x01(\x05\x42\x03\xe0\x41\x03\x12K\n\x07sources\x18\x03 \x03(\x0b\x32\x35.google.developers.knowledge.v1.Answer.CitationSourceB\x03\xe0\x41\x03\x1a.\n\x0e\x43itationSource\x12\x1c\n\x0freference_index\x18\x01 \x01(\x05\x42\x03\xe0\x41\x03\x1ay\n\x0f\x41nswerReference\x12[\n\x12\x64ocument_reference\x18\x01 \x01(\x0b\x32\x38.google.developers.knowledge.v1.Answer.DocumentReferenceB\x03\xe0\x41\x03H\x00\x42\t\n\x07\x63ontent\x1a_\n\x11\x44ocumentReference\x12J\n\x0e\x64ocument_chunk\x18\x01 \x01(\x0b\x32-.google.developers.knowledge.v1.DocumentChunkB\x03\xe0\x41\x03\"\xbb\x01\n\rDocumentChunk\x12\x42\n\x06parent\x18\x01 \x01(\tB2\xe0\x41\x03\xfa\x41,\n*developerknowledge.googleapis.com/Document\x12\x0f\n\x02id\x18\x02 \x01(\tB\x03\xe0\x41\x03\x12\x14\n\x07\x63ontent\x18\x03 \x01(\tB\x03\xe0\x41\x03\x12?\n\x08\x64ocument\x18\x04 \x01(\x0b\x32(.google.developers.knowledge.v1.DocumentB\x03\xe0\x41\x03*y\n\x0c\x44ocumentView\x12\x1d\n\x19\x44OCUMENT_VIEW_UNSPECIFIED\x10\x00\x12\x17\n\x13\x44OCUMENT_VIEW_BASIC\x10\x01\x12\x16\n\x12\x44OCUMENT_VIEW_FULL\x10\x02\x12\x19\n\x15\x44OCUMENT_VIEW_CONTENT\x10\x03\x32\x81\x06\n\x12\x44\x65veloperKnowledge\x12\xbd\x01\n\x14SearchDocumentChunks\x12;.google.developers.knowledge.v1.SearchDocumentChunksRequest\x1a<.google.developers.knowledge.v1.SearchDocumentChunksResponse\"*\x82\xd3\xe4\x93\x02$\x12\"/v1/documents:searchDocumentChunks\x12\x93\x01\n\x0bGetDocument\x12\x32.google.developers.knowledge.v1.GetDocumentRequest\x1a(.google.developers.knowledge.v1.Document\"&\xda\x41\x04name\x82\xd3\xe4\x93\x02\x19\x12\x17/v1/{name=documents/**}\x12\xa8\x01\n\x11\x42\x61tchGetDocuments\x12\x38.google.developers.knowledge.v1.BatchGetDocumentsRequest\x1a\x39.google.developers.knowledge.v1.BatchGetDocumentsResponse\"\x1e\x82\xd3\xe4\x93\x02\x18\x12\x16/v1/documents:batchGet\x12\x92\x01\n\x0b\x41nswerQuery\x12\x32.google.developers.knowledge.v1.AnswerQueryRequest\x1a\x33.google.developers.knowledge.v1.AnswerQueryResponse\"\x1a\x82\xd3\xe4\x93\x02\x14\"\x0f/v1:answerQuery:\x01*\x1aU\xca\x41!developerknowledge.googleapis.com\xd2\x41.https://www.googleapis.com/auth/cloud-platformB\x89\x02\n\"com.google.developers.knowledge.v1B\x17\x44\x65veloperKnowledgeProtoP\x01ZGgoogle.golang.org/genproto/googleapis/developers/knowledge/v1;knowledge\xaa\x02\'Google.Developers.DeveloperKnowledge.V1\xca\x02\'Google\\Developers\\DeveloperKnowledge\\V1\xea\x02*Google::Developers::DeveloperKnowledge::V1b\x06proto3"
 
 pool = ::Google::Protobuf::DescriptorPool.generated_pool
 pool.add_serialized_file(descriptor_data)
@@ -26,6 +26,13 @@ module Google
         GetDocumentRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.GetDocumentRequest").msgclass
         BatchGetDocumentsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.BatchGetDocumentsRequest").msgclass
         BatchGetDocumentsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.BatchGetDocumentsResponse").msgclass
+        AnswerQueryRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.AnswerQueryRequest").msgclass
+        AnswerQueryResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.AnswerQueryResponse").msgclass
+        Answer = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer").msgclass
+        Answer::AnswerCitation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.AnswerCitation").msgclass
+        Answer::CitationSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.CitationSource").msgclass
+        Answer::AnswerReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.AnswerReference").msgclass
+        Answer::DocumentReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.Answer.DocumentReference").msgclass
         DocumentChunk = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.DocumentChunk").msgclass
         DocumentView = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.developers.knowledge.v1.DocumentView").enummodule
       end

data/lib/google/developers/knowledge/v1/developerknowledge_services_pb.rb

@@ -65,6 +65,8 @@ module Google
             rpc :GetDocument, ::Google::Developers::DeveloperKnowledge::V1::GetDocumentRequest, ::Google::Developers::DeveloperKnowledge::V1::Document
             # Retrieves multiple documents, each with its full Markdown content.
             rpc :BatchGetDocuments, ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsRequest, ::Google::Developers::DeveloperKnowledge::V1::BatchGetDocumentsResponse
+            # Answers a query using grounded generation.
+            rpc :AnswerQuery, ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryRequest, ::Google::Developers::DeveloperKnowledge::V1::AnswerQueryResponse
           end
 
           Stub = Service.rpc_stub_class

data/proto_docs/google/developers/knowledge/v1/developerknowledge.rb

@@ -53,6 +53,9 @@ module Google
         #     Output only. Specifies the
         #     {::Google::Developers::DeveloperKnowledge::V1::DocumentView DocumentView} of the
         #     document.
+        # @!attribute [r] content_length_bytes
+        #   @return [::Integer]
+        #     Output only. The length of the `content` field in bytes.
         class Document
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -71,8 +74,7 @@ module Google
         #
         #     If unspecified, at most 5 results will be returned.
         #
-        #     The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT
-        #     error.
+        #     The maximum value is 100; values above 100 will be coerced to 100.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     Optional. Contains a page token, received from a previous
@@ -105,6 +107,10 @@ module Google
         #     TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators.
         #     Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`.
         #
+        #     Note: Field names must be in `snake_case` (e.g., `data_source`). Values on
+        #     the right-hand side of filtering expressions must be string literals
+        #     enclosed in double quotes (e.g., `"docs.cloud.google.com"`).
+        #
         #     You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical
         #     operators. `OR` has higher precedence than `AND`. Use parentheses for
         #     explicit precedence grouping.
@@ -112,11 +118,11 @@ module Google
         #     Examples:
         #
         #     * `data_source = "docs.cloud.google.com" OR data_source =
-        #     "firebase.google.com"`
+        #       "firebase.google.com"`
         #     * `data_source != "firebase.google.com"`
         #     * `update_time < "2024-01-01T00:00:00Z"`
         #     * `update_time >= "2025-01-22T00:00:00Z" AND (data_source =
-        #     "developer.chrome.com" OR data_source = "web.dev")`
+        #       "developer.chrome.com" OR data_source = "web.dev")`
         #     * `uri = "https://docs.cloud.google.com/release-notes"`
         #
         #     The `filter` string must not exceed 500 characters; values longer than 500
@@ -199,6 +205,92 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query DeveloperKnowledge.AnswerQuery}.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     Required. The query to answer.
+        class AnswerQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#answer_query DeveloperKnowledge.AnswerQuery}.
+        # @!attribute [rw] answer
+        #   @return [::Google::Developers::DeveloperKnowledge::V1::Answer]
+        #     The answer to the query.
+        class AnswerQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # An answer to a query.
+        # @!attribute [rw] answer_text
+        #   @return [::String]
+        #     Contains the text of the answer.
+        # @!attribute [r] citations
+        #   @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerCitation>]
+        #     Output only. Contains citations for the answer.
+        # @!attribute [r] references
+        #   @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerReference>]
+        #     Output only. Contains references for the answer.
+        class Answer
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Citation info for a segment.
+          # @!attribute [r] start_index
+          #   @return [::Integer]
+          #     Output only. Indicates the start of the segment, measured in bytes (UTF-8
+          #     unicode), inclusive. If there are multi-byte characters, such as
+          #     non-ASCII characters, the index measurement is longer than the string
+          #     length.
+          # @!attribute [r] end_index
+          #   @return [::Integer]
+          #     Output only. Indicates the end of the segment, measured in bytes (UTF-8
+          #     unicode), exclusive. If there are multi-byte characters, such as
+          #     non-ASCII characters, the index measurement is longer than the string
+          #     length.
+          # @!attribute [r] sources
+          #   @return [::Array<::Google::Developers::DeveloperKnowledge::V1::Answer::CitationSource>]
+          #     Output only. Contains citation sources for the attributed segment.
+          class AnswerCitation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Citation source.
+          # @!attribute [r] reference_index
+          #   @return [::Integer]
+          #     Output only. Contains the index of the
+          #     {::Google::Developers::DeveloperKnowledge::V1::Answer::AnswerReference Answer.AnswerReference}
+          #     in the `references` repeated field.
+          class CitationSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a reference to a source.
+          # @!attribute [r] document_reference
+          #   @return [::Google::Developers::DeveloperKnowledge::V1::Answer::DocumentReference]
+          #     Output only. The reference document.
+          class AnswerReference
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a reference to a document.
+          # @!attribute [r] document_chunk
+          #   @return [::Google::Developers::DeveloperKnowledge::V1::DocumentChunk]
+          #     Output only. Contains the document chunk. The `document_chunk.id` field
+          #     is not set and will be empty.
+          class DocumentReference
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # A DocumentChunk represents a piece of content from a
         # {::Google::Developers::DeveloperKnowledge::V1::Document Document} in the DeveloperKnowledge
         # corpus. To fetch the entire document content, pass the `parent` to
@@ -248,6 +340,7 @@ module Google
           DOCUMENT_VIEW_UNSPECIFIED = 0
 
           # Includes only the basic metadata fields:
+          #
           # - `name`
           # - `uri`
           # - `data_source`
@@ -255,6 +348,7 @@ module Google
           # - `description`
           # - `update_time`
           # - `view`
+          # - `content_length_bytes`
           #
           # This is the default of view for
           # {::Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client#search_document_chunks DeveloperKnowledge.SearchDocumentChunks}.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-developers-developer_knowledge-v1
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Google LLC
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement