google-cloud-speech 0.32.0 → 1.2.1

data/lib/google/cloud/speech/v1p1beta1/doc/google/longrunning/operations.rb

@@ -1,93 +0,0 @@
-# Copyright 2018 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.
-
-
-module Google
-  module Longrunning
-    # This resource represents a long-running operation that is the result of a
-    # network API call.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The server-assigned name, which is only unique within the same service that
-    #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
-    # @!attribute [rw] metadata
-    #   @return [Google::Protobuf::Any]
-    #     Service-specific metadata associated with the operation.  It typically
-    #     contains progress information and common metadata such as create time.
-    #     Some services might not provide such metadata.  Any method that returns a
-    #     long-running operation should document the metadata type, if any.
-    # @!attribute [rw] done
-    #   @return [true, false]
-    #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
-    #     available.
-    # @!attribute [rw] error
-    #   @return [Google::Rpc::Status]
-    #     The error result of the operation in case of failure or cancellation.
-    # @!attribute [rw] response
-    #   @return [Google::Protobuf::Any]
-    #     The normal response of the operation in case of success.  If the original
-    #     method returns no data on success, such as `Delete`, the response is
-    #     `google.protobuf.Empty`.  If the original method is standard
-    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
-    #     methods, the response should have the type `XxxResponse`, where `Xxx`
-    #     is the original method name.  For example, if the original method name
-    #     is `TakeSnapshot()`, the inferred response type is
-    #     `TakeSnapshotResponse`.
-    class Operation; end
-
-    # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the operation resource.
-    class GetOperationRequest; end
-
-    # The request message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the operation collection.
-    # @!attribute [rw] filter
-    #   @return [String]
-    #     The standard list filter.
-    # @!attribute [rw] page_size
-    #   @return [Integer]
-    #     The standard list page size.
-    # @!attribute [rw] page_token
-    #   @return [String]
-    #     The standard list page token.
-    class ListOperationsRequest; end
-
-    # The response message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}.
-    # @!attribute [rw] operations
-    #   @return [Array<Google::Longrunning::Operation>]
-    #     A list of operations that matches the specified filter in the request.
-    # @!attribute [rw] next_page_token
-    #   @return [String]
-    #     The standard List next-page token.
-    class ListOperationsResponse; end
-
-    # The request message for {Google::Longrunning::Operations::CancelOperation Operations::CancelOperation}.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the operation resource to be cancelled.
-    class CancelOperationRequest; end
-
-    # The request message for {Google::Longrunning::Operations::DeleteOperation Operations::DeleteOperation}.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The name of the operation resource to be deleted.
-    class DeleteOperationRequest; end
-  end
-end

data/lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/any.rb

@@ -1,130 +0,0 @@
-# Copyright 2018 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.
-
-
-module Google
-  module Protobuf
-    # `Any` contains an arbitrary serialized protocol buffer message along with a
-    # URL that describes the type of the serialized message.
-    #
-    # Protobuf library provides support to pack/unpack Any values in the form
-    # of utility functions or additional generated methods of the Any type.
-    #
-    # Example 1: Pack and unpack a message in C++.
-    #
-    #     Foo foo = ...;
-    #     Any any;
-    #     any.PackFrom(foo);
-    #     ...
-    #     if (any.UnpackTo(&foo)) {
-    #       ...
-    #     }
-    #
-    # Example 2: Pack and unpack a message in Java.
-    #
-    #     Foo foo = ...;
-    #     Any any = Any.pack(foo);
-    #     ...
-    #     if (any.is(Foo.class)) {
-    #       foo = any.unpack(Foo.class);
-    #     }
-    #
-    #  Example 3: Pack and unpack a message in Python.
-    #
-    #     foo = Foo(...)
-    #     any = Any()
-    #     any.Pack(foo)
-    #     ...
-    #     if any.Is(Foo.DESCRIPTOR):
-    #       any.Unpack(foo)
-    #       ...
-    #
-    #  Example 4: Pack and unpack a message in Go
-    #
-    #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
-    #      ...
-    #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
-    #        ...
-    #      }
-    #
-    # The pack methods provided by protobuf library will by default use
-    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
-    # methods only use the fully qualified type name after the last '/'
-    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
-    # name "y.z".
-    #
-    #
-    # = JSON
-    #
-    # The JSON representation of an `Any` value uses the regular
-    # representation of the deserialized, embedded message, with an
-    # additional field `@type` which contains the type URL. Example:
-    #
-    #     package google.profile;
-    #     message Person {
-    #       string first_name = 1;
-    #       string last_name = 2;
-    #     }
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.profile.Person",
-    #       "firstName": <string>,
-    #       "lastName": <string>
-    #     }
-    #
-    # If the embedded message type is well-known and has a custom JSON
-    # representation, that representation will be embedded adding a field
-    # `value` which holds the custom JSON in addition to the `@type`
-    # field. Example (for message {Google::Protobuf::Duration}):
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.protobuf.Duration",
-    #       "value": "1.212s"
-    #     }
-    # @!attribute [rw] type_url
-    #   @return [String]
-    #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
-    #     the fully qualified name of the type (as in
-    #     `path/google.protobuf.Duration`). The name should be in a canonical form
-    #     (e.g., leading "." is not accepted).
-    #
-    #     In practice, teams usually precompile into the binary all types that they
-    #     expect it to use in the context of Any. However, for URLs which use the
-    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
-    #     server that maps type URLs to message definitions as follows:
-    #
-    #     * If no scheme is provided, `https` is assumed.
-    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
-    #       value in binary format, or produce an error.
-    #     * Applications are allowed to cache lookup results based on the
-    #       URL, or have them precompiled into a binary to avoid any
-    #       lookup. Therefore, binary compatibility needs to be preserved
-    #       on changes to types. (Use versioned type names to manage
-    #       breaking changes.)
-    #
-    #     Note: this functionality is not currently available in the official
-    #     protobuf release, and it is not used for type URLs beginning with
-    #     type.googleapis.com.
-    #
-    #     Schemes other than `http`, `https` (or the empty scheme) might be
-    #     used with implementation specific semantics.
-    # @!attribute [rw] value
-    #   @return [String]
-    #     Must be a valid serialized protocol buffer of the above specified type.
-    class Any; end
-  end
-end

data/lib/google/cloud/speech/v1p1beta1/doc/google/protobuf/duration.rb

@@ -1,91 +0,0 @@
-# Copyright 2018 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.
-
-
-module Google
-  module Protobuf
-    # A Duration represents a signed, fixed-length span of time represented
-    # as a count of seconds and fractions of seconds at nanosecond
-    # resolution. It is independent of any calendar and concepts like "day"
-    # or "month". It is related to Timestamp in that the difference between
-    # two Timestamp values is a Duration and it can be added or subtracted
-    # from a Timestamp. Range is approximately +-10,000 years.
-    #
-    # = Examples
-    #
-    # Example 1: Compute Duration from two Timestamps in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Timestamp end = ...;
-    #     Duration duration = ...;
-    #
-    #     duration.seconds = end.seconds - start.seconds;
-    #     duration.nanos = end.nanos - start.nanos;
-    #
-    #     if (duration.seconds < 0 && duration.nanos > 0) {
-    #       duration.seconds += 1;
-    #       duration.nanos -= 1000000000;
-    #     } else if (durations.seconds > 0 && duration.nanos < 0) {
-    #       duration.seconds -= 1;
-    #       duration.nanos += 1000000000;
-    #     }
-    #
-    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
-    #
-    #     Timestamp start = ...;
-    #     Duration duration = ...;
-    #     Timestamp end = ...;
-    #
-    #     end.seconds = start.seconds + duration.seconds;
-    #     end.nanos = start.nanos + duration.nanos;
-    #
-    #     if (end.nanos < 0) {
-    #       end.seconds -= 1;
-    #       end.nanos += 1000000000;
-    #     } else if (end.nanos >= 1000000000) {
-    #       end.seconds += 1;
-    #       end.nanos -= 1000000000;
-    #     }
-    #
-    # Example 3: Compute Duration from datetime.timedelta in Python.
-    #
-    #     td = datetime.timedelta(days=3, minutes=10)
-    #     duration = Duration()
-    #     duration.FromTimedelta(td)
-    #
-    # = JSON Mapping
-    #
-    # In JSON format, the Duration type is encoded as a string rather than an
-    # object, where the string ends in the suffix "s" (indicating seconds) and
-    # is preceded by the number of seconds, with nanoseconds expressed as
-    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
-    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
-    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
-    # microsecond should be expressed in JSON format as "3.000001s".
-    # @!attribute [rw] seconds
-    #   @return [Integer]
-    #     Signed seconds of the span of time. Must be from -315,576,000,000
-    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
-    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-    # @!attribute [rw] nanos
-    #   @return [Integer]
-    #     Signed fractions of a second at nanosecond resolution of the span
-    #     of time. Durations less than one second are represented with a 0
-    #     `seconds` field and a positive or negative `nanos` field. For durations
-    #     of one second or more, a non-zero value for the `nanos` field must be
-    #     of the same sign as the `seconds` field. Must be from -999,999,999
-    #     to +999,999,999 inclusive.
-    class Duration; end
-  end
-end

data/lib/google/cloud/speech/v1p1beta1/doc/google/rpc/status.rb

@@ -1,84 +0,0 @@
-# Copyright 2018 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.
-
-
-module Google
-  module Rpc
-    # The `Status` type defines a logical error model that is suitable for different
-    # programming environments, including REST APIs and RPC APIs. It is used by
-    # [gRPC](https://github.com/grpc). The error model is designed to be:
-    #
-    # * Simple to use and understand for most users
-    # * Flexible enough to meet unexpected needs
-    #
-    # = Overview
-    #
-    # The `Status` message contains three pieces of data: error code, error message,
-    # and error details. The error code should be an enum value of
-    # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
-    # error message should be a developer-facing English message that helps
-    # developers *understand* and *resolve* the error. If a localized user-facing
-    # error message is needed, put the localized message in the error details or
-    # localize it in the client. The optional error details may contain arbitrary
-    # information about the error. There is a predefined set of error detail types
-    # in the package `google.rpc` that can be used for common error conditions.
-    #
-    # = Language mapping
-    #
-    # The `Status` message is the logical representation of the error model, but it
-    # is not necessarily the actual wire format. When the `Status` message is
-    # exposed in different client libraries and different wire protocols, it can be
-    # mapped differently. For example, it will likely be mapped to some exceptions
-    # in Java, but more likely mapped to some error codes in C.
-    #
-    # = Other uses
-    #
-    # The error model and the `Status` message can be used in a variety of
-    # environments, either with or without APIs, to provide a
-    # consistent developer experience across different environments.
-    #
-    # Example uses of this error model include:
-    #
-    # * Partial errors. If a service needs to return partial errors to the client,
-    #   it may embed the `Status` in the normal response to indicate the partial
-    #   errors.
-    #
-    # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a `Status` message for error reporting.
-    #
-    # * Batch operations. If a client uses batch request and batch response, the
-    #   `Status` message should be used directly inside batch response, one for
-    #   each error sub-response.
-    #
-    # * Asynchronous operations. If an API call embeds asynchronous operation
-    #   results in its response, the status of those operations should be
-    #   represented directly using the `Status` message.
-    #
-    # * Logging. If some API errors are stored in logs, the message `Status` could
-    #   be used directly after any stripping needed for security/privacy reasons.
-    # @!attribute [rw] code
-    #   @return [Integer]
-    #     The status code, which should be an enum value of {Google::Rpc::Code}.
-    # @!attribute [rw] message
-    #   @return [String]
-    #     A developer-facing error message, which should be in English. Any
-    #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized by the client.
-    # @!attribute [rw] details
-    #   @return [Array<Google::Protobuf::Any>]
-    #     A list of messages that carry the error details.  There is a common set of
-    #     message types for APIs to use.
-    class Status; end
-  end
-end

data/lib/google/cloud/speech/v1p1beta1/helpers.rb

@@ -1,136 +0,0 @@
-# Copyright 2018 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.
-
-
-require "google/cloud/speech/v1p1beta1/speech_client"
-require "google/cloud/speech/v1p1beta1/stream"
-
-module Google
-  module Cloud
-    module Speech
-      module V1p1beta1
-        class SpeechClient
-          # Performs bidirectional streaming speech recognition: receive results
-          # while sending audio. This method is only available via the gRPC API
-          # (not REST).
-          #
-          # @param [Google::Cloud::Speech::V1p1beta1::StreamingRecognitionConfig,
-          #     Hash] streaming_config
-          #   Provides information to the recognizer that specifies how to
-          #   process the request.
-          #   A hash of the same form as
-          #   +Google::Cloud::Speech::V1p1beta1::StreamingRecognitionConfig+
-          #   can also be provided.
-          # @param [Google::Gax::CallOptions] options
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @return [Google::Cloud::Speech::V1p1beta1::Stream]
-          #   An object that streams the requests and responses.
-          #
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #   stream.wait_until_complete!
-          #
-          #   results = stream.results
-          #   result = results.first.alternatives.first
-          #   result.transcript #=> "how old is the Brooklyn Bridge"
-          #   result.confidence #=> 0.9826789498329163
-          #
-          def streaming_recognize streaming_config, options: nil
-            if streaming_config.is_a?(::Hash) &&
-               streaming_config[:config] &&
-               streaming_config[:config][:encoding]
-              streaming_config[:config][:encoding] =
-                streaming_config[:config][:encoding].upcase
-            end
-            V1p1beta1::Stream.new(
-              streaming_config,
-              proc do |reqs|
-                request_protos = reqs.lazy.map do |req|
-                  Google::Gax.to_proto(
-                    req,
-                    Google::Cloud::Speech::V1p1beta1::StreamingRecognizeRequest
-                  )
-                end
-                @streaming_recognize.call(request_protos, options)
-              end
-            )
-          end
-
-          ##
-          # Gets the latest state of a long-running operation. Clients can use
-          # this method to poll the operation result at intervals as recommended
-          # by the API service.
-          #
-          # @param name [String]
-          #   The name of the operation resource.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @return [Google::Gax::Operation]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #
-          #   op = speech_client.get_operation "-"
-          #
-          #   # Process error operations.
-          #   log_error op.error if op.error?
-          #
-          #   if op.done?
-          #     # Process completed operations.
-          #     log_finished op.response, op.metadata
-          #   else
-          #     # Process pending operations.
-          #     log_pending op.name, op.metadata
-          #   end
-          #
-          def get_operation name, options: nil
-            proto_op = @operations_client.get_operation name, options: options
-
-            Google::Gax::Operation.new(
-              proto_op,
-              @operations_client,
-              Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeResponse,
-              Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeMetadata,
-              call_options: options
-            )
-          end
-        end
-      end
-    end
-  end
-end