google-cloud-dataqna-v1alpha 0.1.0

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/credentials.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module DataQnA
+      module V1alpha
+        module AutoSuggestionService
+          # Credentials for the AutoSuggestionService API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "BIGQUERY_DATAQNA_CREDENTIALS",
+              "BIGQUERY_DATAQNA_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "BIGQUERY_DATAQNA_CREDENTIALS_JSON",
+              "BIGQUERY_DATAQNA_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service/paths.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DataQnA
+      module V1alpha
+        module AutoSuggestionService
+          # Path helper methods for the AutoSuggestionService API.
+          module Paths
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [::String]
+            def location_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service_pb.rb

@@ -0,0 +1,56 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/dataqna/v1alpha/auto_suggestion_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/dataqna/v1alpha/annotated_string_pb'
+require 'google/api/client_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/dataqna/v1alpha/auto_suggestion_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.dataqna.v1alpha.SuggestQueriesRequest" do
+      optional :parent, :string, 1
+      repeated :scopes, :string, 2
+      optional :query, :string, 3
+      repeated :suggestion_types, :enum, 4, "google.cloud.dataqna.v1alpha.SuggestionType"
+    end
+    add_message "google.cloud.dataqna.v1alpha.Suggestion" do
+      optional :suggestion_info, :message, 1, "google.cloud.dataqna.v1alpha.SuggestionInfo"
+      optional :ranking_score, :double, 2
+      optional :suggestion_type, :enum, 3, "google.cloud.dataqna.v1alpha.SuggestionType"
+    end
+    add_message "google.cloud.dataqna.v1alpha.SuggestionInfo" do
+      optional :annotated_suggestion, :message, 1, "google.cloud.dataqna.v1alpha.AnnotatedString"
+      repeated :query_matches, :message, 2, "google.cloud.dataqna.v1alpha.SuggestionInfo.MatchInfo"
+    end
+    add_message "google.cloud.dataqna.v1alpha.SuggestionInfo.MatchInfo" do
+      optional :start_char_index, :int32, 1
+      optional :length, :int32, 2
+    end
+    add_message "google.cloud.dataqna.v1alpha.SuggestQueriesResponse" do
+      repeated :suggestions, :message, 1, "google.cloud.dataqna.v1alpha.Suggestion"
+    end
+    add_enum "google.cloud.dataqna.v1alpha.SuggestionType" do
+      value :SUGGESTION_TYPE_UNSPECIFIED, 0
+      value :ENTITY, 1
+      value :TEMPLATE, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module DataQnA
+      module V1alpha
+        SuggestQueriesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.SuggestQueriesRequest").msgclass
+        Suggestion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.Suggestion").msgclass
+        SuggestionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.SuggestionInfo").msgclass
+        SuggestionInfo::MatchInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.SuggestionInfo.MatchInfo").msgclass
+        SuggestQueriesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.SuggestQueriesResponse").msgclass
+        SuggestionType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.SuggestionType").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/dataqna/v1alpha/auto_suggestion_service_services_pb.rb

@@ -0,0 +1,111 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/dataqna/v1alpha/auto_suggestion_service.proto for package 'Google.Cloud.DataQnA.V1alpha'
+# Original file comments:
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'grpc'
+require 'google/cloud/dataqna/v1alpha/auto_suggestion_service_pb'
+
+module Google
+  module Cloud
+    module DataQnA
+      module V1alpha
+        module AutoSuggestionService
+          # This stateless API provides automatic suggestions for natural language
+          # queries for the data sources in the provided project and location.
+          #
+          # The service provides a resourceless operation `suggestQueries` that can be
+          # called to get a list of suggestions for a given incomplete query and scope
+          # (or list of scopes) under which the query is to be interpreted.
+          #
+          # There are two types of suggestions, ENTITY for single entity suggestions
+          # and TEMPLATE for full sentences. By default, both types are returned.
+          #
+          # Example Request:
+          # ```
+          # GetSuggestions({
+          #   parent: "locations/us/projects/my-project"
+          #   scopes:
+          #   "//bigquery.googleapis.com/projects/my-project/datasets/my-dataset/tables/my-table"
+          #   query: "top it"
+          # })
+          # ```
+          #
+          # The service will retrieve information based on the given scope(s) and give
+          # suggestions based on that (e.g. "top item" for "top it" if "item" is a known
+          # dimension for the provided scope).
+          # ```
+          # suggestions {
+          #   suggestion_info {
+          #     annotated_suggestion {
+          #       text_formatted: "top item by sum of usd_revenue_net"
+          #       markups {
+          #         type: DIMENSION
+          #         start_char_index: 4
+          #         length: 4
+          #       }
+          #       markups {
+          #         type: METRIC
+          #         start_char_index: 19
+          #         length: 15
+          #       }
+          #     }
+          #     query_matches {
+          #       start_char_index: 0
+          #       length: 6
+          #     }
+          #   }
+          #   suggestion_type: TEMPLATE
+          #   ranking_score: 0.9
+          # }
+          # suggestions {
+          #   suggestion_info {
+          #     annotated_suggestion {
+          #       text_formatted: "item"
+          #       markups {
+          #         type: DIMENSION
+          #         start_char_index: 4
+          #         length: 2
+          #       }
+          #     }
+          #     query_matches {
+          #       start_char_index: 0
+          #       length: 6
+          #     }
+          #   }
+          #   suggestion_type: ENTITY
+          #   ranking_score: 0.8
+          # }
+          # ```
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.dataqna.v1alpha.AutoSuggestionService'
+
+            # Gets a list of suggestions based on a prefix string.
+            # AutoSuggestion tolerance should be less than 1 second.
+            rpc :SuggestQueries, ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesRequest, ::Google::Cloud::DataQnA::V1alpha::SuggestQueriesResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/dataqna/v1alpha/question_pb.rb

@@ -0,0 +1,155 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/dataqna/v1alpha/question.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/dataqna/v1alpha/annotated_string_pb'
+require 'google/protobuf/any_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/rpc/status_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/dataqna/v1alpha/question.proto", :syntax => :proto3) do
+    add_message "google.cloud.dataqna.v1alpha.Question" do
+      optional :name, :string, 1
+      repeated :scopes, :string, 2
+      optional :query, :string, 3
+      repeated :data_source_annotations, :string, 4
+      optional :interpret_error, :message, 5, "google.cloud.dataqna.v1alpha.InterpretError"
+      repeated :interpretations, :message, 6, "google.cloud.dataqna.v1alpha.Interpretation"
+      optional :create_time, :message, 7, "google.protobuf.Timestamp"
+      optional :user_email, :string, 8
+      optional :debug_flags, :message, 9, "google.cloud.dataqna.v1alpha.DebugFlags"
+      optional :debug_info, :message, 10, "google.protobuf.Any"
+    end
+    add_message "google.cloud.dataqna.v1alpha.InterpretError" do
+      optional :message, :string, 1
+      optional :code, :enum, 2, "google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorCode"
+      optional :details, :message, 3, "google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorDetails"
+    end
+    add_message "google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorDetails" do
+      optional :unsupported_details, :message, 1, "google.cloud.dataqna.v1alpha.InterpretError.InterpretUnsupportedDetails"
+      optional :incomplete_query_details, :message, 2, "google.cloud.dataqna.v1alpha.InterpretError.InterpretIncompleteQueryDetails"
+      optional :ambiguity_details, :message, 3, "google.cloud.dataqna.v1alpha.InterpretError.InterpretAmbiguityDetails"
+    end
+    add_message "google.cloud.dataqna.v1alpha.InterpretError.InterpretUnsupportedDetails" do
+      repeated :operators, :string, 1
+      repeated :intent, :string, 2
+    end
+    add_message "google.cloud.dataqna.v1alpha.InterpretError.InterpretIncompleteQueryDetails" do
+      repeated :entities, :enum, 1, "google.cloud.dataqna.v1alpha.InterpretEntity"
+    end
+    add_message "google.cloud.dataqna.v1alpha.InterpretError.InterpretAmbiguityDetails" do
+    end
+    add_enum "google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorCode" do
+      value :INTERPRET_ERROR_CODE_UNSPECIFIED, 0
+      value :INVALID_QUERY, 1
+      value :FAILED_TO_UNDERSTAND, 2
+      value :FAILED_TO_ANSWER, 3
+    end
+    add_message "google.cloud.dataqna.v1alpha.ExecutionInfo" do
+      optional :job_creation_status, :message, 1, "google.rpc.Status"
+      optional :job_execution_state, :enum, 2, "google.cloud.dataqna.v1alpha.ExecutionInfo.JobExecutionState"
+      optional :create_time, :message, 3, "google.protobuf.Timestamp"
+      optional :bigquery_job, :message, 4, "google.cloud.dataqna.v1alpha.BigQueryJob"
+    end
+    add_enum "google.cloud.dataqna.v1alpha.ExecutionInfo.JobExecutionState" do
+      value :JOB_EXECUTION_STATE_UNSPECIFIED, 0
+      value :NOT_EXECUTED, 1
+      value :RUNNING, 2
+      value :SUCCEEDED, 3
+      value :FAILED, 4
+    end
+    add_message "google.cloud.dataqna.v1alpha.BigQueryJob" do
+      optional :job_id, :string, 1
+      optional :project_id, :string, 2
+      optional :location, :string, 3
+    end
+    add_message "google.cloud.dataqna.v1alpha.Interpretation" do
+      repeated :data_sources, :string, 1
+      optional :confidence, :double, 2
+      repeated :unused_phrases, :string, 3
+      optional :human_readable, :message, 4, "google.cloud.dataqna.v1alpha.HumanReadable"
+      optional :interpretation_structure, :message, 5, "google.cloud.dataqna.v1alpha.InterpretationStructure"
+      optional :data_query, :message, 6, "google.cloud.dataqna.v1alpha.DataQuery"
+      optional :execution_info, :message, 7, "google.cloud.dataqna.v1alpha.ExecutionInfo"
+    end
+    add_message "google.cloud.dataqna.v1alpha.DataQuery" do
+      optional :sql, :string, 1
+    end
+    add_message "google.cloud.dataqna.v1alpha.HumanReadable" do
+      optional :generated_interpretation, :message, 1, "google.cloud.dataqna.v1alpha.AnnotatedString"
+      optional :original_question, :message, 2, "google.cloud.dataqna.v1alpha.AnnotatedString"
+    end
+    add_message "google.cloud.dataqna.v1alpha.InterpretationStructure" do
+      repeated :visualization_types, :enum, 1, "google.cloud.dataqna.v1alpha.InterpretationStructure.VisualizationType"
+      repeated :column_info, :message, 2, "google.cloud.dataqna.v1alpha.InterpretationStructure.ColumnInfo"
+    end
+    add_message "google.cloud.dataqna.v1alpha.InterpretationStructure.ColumnInfo" do
+      optional :output_alias, :string, 1
+      optional :display_name, :string, 2
+    end
+    add_enum "google.cloud.dataqna.v1alpha.InterpretationStructure.VisualizationType" do
+      value :VISUALIZATION_TYPE_UNSPECIFIED, 0
+      value :TABLE, 1
+      value :BAR_CHART, 2
+      value :COLUMN_CHART, 3
+      value :TIMELINE, 4
+      value :SCATTER_PLOT, 5
+      value :PIE_CHART, 6
+      value :LINE_CHART, 7
+      value :AREA_CHART, 8
+      value :COMBO_CHART, 9
+      value :HISTOGRAM, 10
+      value :GENERIC_CHART, 11
+      value :CHART_NOT_UNDERSTOOD, 12
+    end
+    add_message "google.cloud.dataqna.v1alpha.DebugFlags" do
+      optional :include_va_query, :bool, 1
+      optional :include_nested_va_query, :bool, 2
+      optional :include_human_interpretation, :bool, 3
+      optional :include_aqua_debug_response, :bool, 4
+      optional :time_override, :int64, 5
+      optional :is_internal_google_user, :bool, 6
+      optional :ignore_cache, :bool, 7
+      optional :include_search_entities_rpc, :bool, 8
+      optional :include_list_column_annotations_rpc, :bool, 9
+      optional :include_virtual_analyst_entities, :bool, 10
+      optional :include_table_list, :bool, 11
+      optional :include_domain_list, :bool, 12
+    end
+    add_enum "google.cloud.dataqna.v1alpha.InterpretEntity" do
+      value :INTERPRET_ENTITY_UNSPECIFIED, 0
+      value :DIMENSION, 1
+      value :METRIC, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module DataQnA
+      module V1alpha
+        Question = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.Question").msgclass
+        InterpretError = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretError").msgclass
+        InterpretError::InterpretErrorDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorDetails").msgclass
+        InterpretError::InterpretUnsupportedDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretError.InterpretUnsupportedDetails").msgclass
+        InterpretError::InterpretIncompleteQueryDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretError.InterpretIncompleteQueryDetails").msgclass
+        InterpretError::InterpretAmbiguityDetails = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretError.InterpretAmbiguityDetails").msgclass
+        InterpretError::InterpretErrorCode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretError.InterpretErrorCode").enummodule
+        ExecutionInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.ExecutionInfo").msgclass
+        ExecutionInfo::JobExecutionState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.ExecutionInfo.JobExecutionState").enummodule
+        BigQueryJob = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.BigQueryJob").msgclass
+        Interpretation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.Interpretation").msgclass
+        DataQuery = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.DataQuery").msgclass
+        HumanReadable = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.HumanReadable").msgclass
+        InterpretationStructure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretationStructure").msgclass
+        InterpretationStructure::ColumnInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretationStructure.ColumnInfo").msgclass
+        InterpretationStructure::VisualizationType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretationStructure.VisualizationType").enummodule
+        DebugFlags = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.DebugFlags").msgclass
+        InterpretEntity = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.dataqna.v1alpha.InterpretEntity").enummodule
+      end
+    end
+  end
+end

data/lib/google/cloud/dataqna/v1alpha/question_service.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/dataqna/v1alpha/version"
+
+require "google/cloud/dataqna/v1alpha/question_service/credentials"
+require "google/cloud/dataqna/v1alpha/question_service/paths"
+require "google/cloud/dataqna/v1alpha/question_service/client"
+
+module Google
+  module Cloud
+    module DataQnA
+      module V1alpha
+        ##
+        # Service to interpret natural language queries.
+        # The service allows to create `Question` resources that are interpreted and
+        # are filled with one or more interpretations if the question could be
+        # interpreted. Once a `Question` resource is created and has at least one
+        # interpretation, an interpretation can be chosen for execution, which
+        # triggers a query to the backend (for BigQuery, it will create a job).
+        # Upon successful execution of that interpretation, backend specific
+        # information will be returned so that the client can retrieve the results
+        # from the backend.
+        #
+        # The `Question` resources are named `projects/*/locations/*/questions/*`.
+        #
+        # The `Question` resource has a singletion sub-resource `UserFeedback` named
+        # `projects/*/locations/*/questions/*/userFeedback`, which allows access to
+        # user feedback.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/dataqna/v1alpha/question_service"
+        #     client = ::Google::Cloud::DataQnA::V1alpha::QuestionService::Client.new
+        #
+        module QuestionService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "question_service", "helpers.rb"
+require "google/cloud/dataqna/v1alpha/question_service/helpers" if ::File.file? helper_path