ibm_watson 2.1.3 → 2.2.0

data/lib/ibm_watson/natural_language_classifier_v1.rb

@@ -1,267 +0,0 @@
-# frozen_string_literal: true
-
-# (C) Copyright IBM Corp. 2018, 2020.
-#
-# 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.
-#
-# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
-#
-# On 9 August 2021, IBM announced the deprecation of IBM Watson™ Natural Language
-# Classifier. As of 9 September 2021, you cannot create new instances. However, existing
-# instances are supported until 8 August 2022. The service will no longer be available on
-# 8 August 2022.<br/><br/>As an alternative, consider migrating to IBM Watson Natural
-# Language Understanding. For more information, see [Migrating to Natural Language
-# Understanding](https://cloud.ibm.com/docs/natural-language-classifier?topic=natural-language-classifier-migrating).
-# {: deprecated}
-#
-# Natural Language Classifier uses machine learning algorithms to return the top matching
-# predefined classes for short text input. You create and train a classifier to connect
-# predefined classes to example texts so that the service can apply those classes to new
-# inputs.
-
-require "concurrent"
-require "erb"
-require "json"
-require "ibm_cloud_sdk_core"
-require_relative "./common.rb"
-
-module IBMWatson
-  ##
-  # The Natural Language Classifier V1 service.
-  class NaturalLanguageClassifierV1 < IBMCloudSdkCore::BaseService
-    include Concurrent::Async
-    DEFAULT_SERVICE_NAME = "natural_language_classifier"
-    DEFAULT_SERVICE_URL = "https://api.us-south.natural-language-classifier.watson.cloud.ibm.com"
-    ##
-    # @!method initialize(args)
-    # Construct a new client for the Natural Language Classifier service.
-    #
-    # @param args [Hash] The args to initialize with
-    # @option args service_url [String] The base service URL to use when contacting the service.
-    #   The base service_url may differ between IBM Cloud regions.
-    # @option args authenticator [Object] The Authenticator instance to be configured for this service.
-    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
-    #   any external configuration, if applicable.
-    def initialize(args = {})
-      warn "On 9 August 2021, IBM announced the deprecation of the Natural Language Classifier service. The service will no longer be available from 8 August 2022. As of 9 September 2021, you will not be able to create new instances. Existing instances will be supported until 8 August 2022. Any instance that still exists on that date will be deleted. For more information, see https://github.com/watson-developer-cloud/ruby-sdk#natural-language-classifier-deprecation."
-      @__async_initialized__ = false
-      defaults = {}
-      defaults[:service_url] = DEFAULT_SERVICE_URL
-      defaults[:service_name] = DEFAULT_SERVICE_NAME
-      defaults[:authenticator] = nil
-      user_service_url = args[:service_url] unless args[:service_url].nil?
-      args = defaults.merge(args)
-      args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
-      super
-      @service_url = user_service_url unless user_service_url.nil?
-    end
-
-    #########################
-    # Classify text
-    #########################
-
-    ##
-    # @!method classify(classifier_id:, text:)
-    # Classify a phrase.
-    # Returns label information for the input. The status must be `Available` before you
-    #   can use the classifier to classify text.
-    # @param classifier_id [String] Classifier ID to use.
-    # @param text [String] The submitted phrase. The maximum length is 2048 characters.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def classify(classifier_id:, text:)
-      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
-
-      raise ArgumentError.new("text must be provided") if text.nil?
-
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "classify")
-      headers.merge!(sdk_headers)
-
-      data = {
-        "text" => text
-      }
-
-      method_url = "/v1/classifiers/%s/classify" % [ERB::Util.url_encode(classifier_id)]
-
-      response = request(
-        method: "POST",
-        url: method_url,
-        headers: headers,
-        json: data,
-        accept_json: true
-      )
-      response
-    end
-
-    ##
-    # @!method classify_collection(classifier_id:, collection:)
-    # Classify multiple phrases.
-    # Returns label information for multiple phrases. The status must be `Available`
-    #   before you can use the classifier to classify text.
-    #
-    #   Note that classifying Japanese texts is a beta feature.
-    # @param classifier_id [String] Classifier ID to use.
-    # @param collection [Array[ClassifyInput]] The submitted phrases.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def classify_collection(classifier_id:, collection:)
-      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
-
-      raise ArgumentError.new("collection must be provided") if collection.nil?
-
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "classify_collection")
-      headers.merge!(sdk_headers)
-
-      data = {
-        "collection" => collection
-      }
-
-      method_url = "/v1/classifiers/%s/classify_collection" % [ERB::Util.url_encode(classifier_id)]
-
-      response = request(
-        method: "POST",
-        url: method_url,
-        headers: headers,
-        json: data,
-        accept_json: true
-      )
-      response
-    end
-    #########################
-    # Manage classifiers
-    #########################
-
-    ##
-    # @!method create_classifier(training_metadata:, training_data:)
-    # Create classifier.
-    # Sends data to create and train a classifier and returns information about the new
-    #   classifier.
-    # @param training_metadata [File] Metadata in JSON format. The metadata identifies the language of the data, and an
-    #   optional name to identify the classifier. Specify the language with the 2-letter
-    #   primary language code as assigned in ISO standard 639.
-    #
-    #   Supported languages are English (`en`), Arabic (`ar`), French (`fr`), German,
-    #   (`de`), Italian (`it`), Japanese (`ja`), Korean (`ko`), Brazilian Portuguese
-    #   (`pt`), and Spanish (`es`).
-    # @param training_data [File] Training data in CSV format. Each text value must have at least one class. The
-    #   data can include up to 3,000 classes and 20,000 records. For details, see [Data
-    #   preparation](https://cloud.ibm.com/docs/natural-language-classifier?topic=natural-language-classifier-using-your-data).
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def create_classifier(training_metadata:, training_data:)
-      raise ArgumentError.new("training_metadata must be provided") if training_metadata.nil?
-
-      raise ArgumentError.new("training_data must be provided") if training_data.nil?
-
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "create_classifier")
-      headers.merge!(sdk_headers)
-
-      form_data = {}
-
-      unless training_metadata.instance_of?(StringIO) || training_metadata.instance_of?(File)
-        training_metadata = training_metadata.respond_to?(:to_json) ? StringIO.new(training_metadata.to_json) : StringIO.new(training_metadata)
-      end
-      form_data[:training_metadata] = HTTP::FormData::File.new(training_metadata, content_type: "application/json", filename: training_metadata.respond_to?(:path) ? training_metadata.path : nil)
-
-      unless training_data.instance_of?(StringIO) || training_data.instance_of?(File)
-        training_data = training_data.respond_to?(:to_json) ? StringIO.new(training_data.to_json) : StringIO.new(training_data)
-      end
-      form_data[:training_data] = HTTP::FormData::File.new(training_data, content_type: "text/csv", filename: training_data.respond_to?(:path) ? training_data.path : nil)
-
-      method_url = "/v1/classifiers"
-
-      response = request(
-        method: "POST",
-        url: method_url,
-        headers: headers,
-        form: form_data,
-        accept_json: true
-      )
-      response
-    end
-
-    ##
-    # @!method list_classifiers
-    # List classifiers.
-    # Returns an empty array if no classifiers are available.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def list_classifiers
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "list_classifiers")
-      headers.merge!(sdk_headers)
-
-      method_url = "/v1/classifiers"
-
-      response = request(
-        method: "GET",
-        url: method_url,
-        headers: headers,
-        accept_json: true
-      )
-      response
-    end
-
-    ##
-    # @!method get_classifier(classifier_id:)
-    # Get information about a classifier.
-    # Returns status and other information about a classifier.
-    # @param classifier_id [String] Classifier ID to query.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def get_classifier(classifier_id:)
-      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
-
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "get_classifier")
-      headers.merge!(sdk_headers)
-
-      method_url = "/v1/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
-
-      response = request(
-        method: "GET",
-        url: method_url,
-        headers: headers,
-        accept_json: true
-      )
-      response
-    end
-
-    ##
-    # @!method delete_classifier(classifier_id:)
-    # Delete classifier.
-    # @param classifier_id [String] Classifier ID to delete.
-    # @return [nil]
-    def delete_classifier(classifier_id:)
-      raise ArgumentError.new("classifier_id must be provided") if classifier_id.nil?
-
-      headers = {
-      }
-      sdk_headers = Common.new.get_sdk_headers("natural_language_classifier", "V1", "delete_classifier")
-      headers.merge!(sdk_headers)
-
-      method_url = "/v1/classifiers/%s" % [ERB::Util.url_encode(classifier_id)]
-
-      request(
-        method: "DELETE",
-        url: method_url,
-        headers: headers,
-        accept_json: true
-      )
-      nil
-    end
-  end
-end

data/lib/ibm_watson/personality_insights_v3.rb

@@ -1,223 +0,0 @@
-# frozen_string_literal: true
-
-# (C) Copyright IBM Corp. 2018, 2020.
-#
-# 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.
-#
-# IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025
-#
-# IBM Watson™ Personality Insights is discontinued. Existing instances are
-# supported until 1 December 2021, but as of 1 December 2020, you cannot create new
-# instances. Any instance that exists on 1 December 2021 will be deleted.<br/><br/>No
-# direct replacement exists for Personality Insights. However, you can consider using [IBM
-# Watson&trade; Natural Language
-# Understanding](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-about)
-# on IBM Cloud&reg; as part of a replacement analytic workflow for your Personality
-# Insights use cases. You can use Natural Language Understanding to extract data and
-# insights from text, such as keywords, categories, sentiment, emotion, and syntax. For
-# more information about the personality models in Personality Insights, see [The science
-# behind the
-# service](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-science).
-# {: deprecated}
-#
-# The IBM Watson Personality Insights service enables applications to derive insights from
-# social media, enterprise data, or other digital communications. The service uses
-# linguistic analytics to infer individuals' intrinsic personality characteristics,
-# including Big Five, Needs, and Values, from digital communications such as email, text
-# messages, tweets, and forum posts.
-#
-# The service can automatically infer, from potentially noisy social media, portraits of
-# individuals that reflect their personality characteristics. The service can infer
-# consumption preferences based on the results of its analysis and, for JSON content that
-# is timestamped, can report temporal behavior.
-# * For information about the meaning of the models that the service uses to describe
-# personality characteristics, see [Personality
-# models](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-models#models).
-# * For information about the meaning of the consumption preferences, see [Consumption
-# preferences](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-preferences#preferences).
-#
-#
-# **Note:** Request logging is disabled for the Personality Insights service. Regardless
-# of whether you set the `X-Watson-Learning-Opt-Out` request header, the service does not
-# log or retain data from requests and responses.
-
-require "concurrent"
-require "erb"
-require "json"
-require "ibm_cloud_sdk_core"
-require_relative "./common.rb"
-
-module IBMWatson
-  ##
-  # The Personality Insights V3 service.
-  class PersonalityInsightsV3 < IBMCloudSdkCore::BaseService
-    include Concurrent::Async
-    DEFAULT_SERVICE_NAME = "personality_insights"
-    DEFAULT_SERVICE_URL = "https://api.us-south.personality-insights.watson.cloud.ibm.com"
-    attr_accessor :version
-    ##
-    # @!method initialize(args)
-    # Construct a new client for the Personality Insights service.
-    #
-    # @param args [Hash] The args to initialize with
-    # @option args version [String] Release date of the version of the API you want to use. Specify dates in
-    #   YYYY-MM-DD format. The current version is `2017-10-13`.
-    # @option args service_url [String] The base service URL to use when contacting the service.
-    #   The base service_url may differ between IBM Cloud regions.
-    # @option args authenticator [Object] The Authenticator instance to be configured for this service.
-    # @option args service_name [String] The name of the service to configure. Will be used as the key to load
-    #   any external configuration, if applicable.
-    def initialize(args = {})
-      warn "On 1 December 2021, Personality Insights will no longer be available. For more information, see https://github.com/watson-developer-cloud/ruby-sdk/tree/master#personality-insights-deprecation."
-      @__async_initialized__ = false
-      defaults = {}
-      defaults[:service_url] = DEFAULT_SERVICE_URL
-      defaults[:service_name] = DEFAULT_SERVICE_NAME
-      defaults[:authenticator] = nil
-      defaults[:version] = nil
-      user_service_url = args[:service_url] unless args[:service_url].nil?
-      args = defaults.merge(args)
-      @version = args[:version]
-      raise ArgumentError.new("version must be provided") if @version.nil?
-
-      args[:authenticator] = IBMCloudSdkCore::ConfigBasedAuthenticatorFactory.new.get_authenticator(service_name: args[:service_name]) if args[:authenticator].nil?
-      super
-      @service_url = user_service_url unless user_service_url.nil?
-    end
-
-    #########################
-    # Methods
-    #########################
-
-    ##
-    # @!method profile(content:, accept:, content_type: nil, content_language: nil, accept_language: nil, raw_scores: nil, csv_headers: nil, consumption_preferences: nil)
-    # Get profile.
-    # Generates a personality profile for the author of the input text. The service
-    #   accepts a maximum of 20 MB of input content, but it requires much less text to
-    #   produce an accurate profile. The service can analyze text in Arabic, English,
-    #   Japanese, Korean, or Spanish. It can return its results in a variety of languages.
-    #
-    #
-    #   **See also:**
-    #   * [Requesting a
-    #   profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#input)
-    #   * [Providing sufficient
-    #   input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#sufficient)
-    #
-    #
-    #   ### Content types
-    #
-    #    You can provide input content as plain text (`text/plain`), HTML (`text/html`),
-    #   or JSON (`application/json`) by specifying the **Content-Type** parameter. The
-    #   default is `text/plain`.
-    #   * Per the JSON specification, the default character encoding for JSON content is
-    #   effectively always UTF-8.
-    #   * Per the HTTP specification, the default encoding for plain text and HTML is
-    #   ISO-8859-1 (effectively, the ASCII character set).
-    #
-    #   When specifying a content type of plain text or HTML, include the `charset`
-    #   parameter to indicate the character encoding of the input text; for example,
-    #   `Content-Type: text/plain;charset=utf-8`.
-    #
-    #   **See also:** [Specifying request and response
-    #   formats](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#formats)
-    #
-    #
-    #   ### Accept types
-    #
-    #    You must request a response as JSON (`application/json`) or comma-separated
-    #   values (`text/csv`) by specifying the **Accept** parameter. CSV output includes a
-    #   fixed number of columns. Set the **csv_headers** parameter to `true` to request
-    #   optional column headers for CSV output.
-    #
-    #   **See also:**
-    #   * [Understanding a JSON
-    #   profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-output#output)
-    #   * [Understanding a CSV
-    #   profile](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-outputCSV#outputCSV).
-    # @param content [Content] A maximum of 20 MB of content to analyze, though the service requires much less
-    #   text; for more information, see [Providing sufficient
-    #   input](https://cloud.ibm.com/docs/personality-insights?topic=personality-insights-input#sufficient).
-    #   For JSON input, provide an object of type `Content`.
-    # @param accept [String] The type of the response. For more information, see **Accept types** in the method
-    #   description.
-    # @param content_type [String] The type of the input. For more information, see **Content types** in the method
-    #   description.
-    # @param content_language [String] The language of the input text for the request: Arabic, English, Japanese, Korean,
-    #   or Spanish. Regional variants are treated as their parent language; for example,
-    #   `en-US` is interpreted as `en`.
-    #
-    #   The effect of the **Content-Language** parameter depends on the **Content-Type**
-    #   parameter. When **Content-Type** is `text/plain` or `text/html`,
-    #   **Content-Language** is the only way to specify the language. When
-    #   **Content-Type** is `application/json`, **Content-Language** overrides a language
-    #   specified with the `language` parameter of a `ContentItem` object, and content
-    #   items that specify a different language are ignored; omit this parameter to base
-    #   the language on the specification of the content items. You can specify any
-    #   combination of languages for **Content-Language** and **Accept-Language**.
-    # @param accept_language [String] The desired language of the response. For two-character arguments, regional
-    #   variants are treated as their parent language; for example, `en-US` is interpreted
-    #   as `en`. You can specify any combination of languages for the input and response
-    #   content.
-    # @param raw_scores [Boolean] Indicates whether a raw score in addition to a normalized percentile is returned
-    #   for each characteristic; raw scores are not compared with a sample population. By
-    #   default, only normalized percentiles are returned.
-    # @param csv_headers [Boolean] Indicates whether column labels are returned with a CSV response. By default, no
-    #   column labels are returned. Applies only when the response type is CSV
-    #   (`text/csv`).
-    # @param consumption_preferences [Boolean] Indicates whether consumption preferences are returned with the results. By
-    #   default, no consumption preferences are returned.
-    # @return [IBMCloudSdkCore::DetailedResponse] A `IBMCloudSdkCore::DetailedResponse` object representing the response.
-    def profile(content:, accept:, content_type: nil, content_language: nil, accept_language: nil, raw_scores: nil, csv_headers: nil, consumption_preferences: nil)
-      raise ArgumentError.new("version must be provided") if version.nil?
-
-      raise ArgumentError.new("content must be provided") if content.nil?
-
-      raise ArgumentError.new("accept must be provided") if accept.nil?
-
-      headers = {
-        "Accept" => accept,
-        "Content-Type" => content_type,
-        "Content-Language" => content_language,
-        "Accept-Language" => accept_language
-      }
-      sdk_headers = Common.new.get_sdk_headers("personality_insights", "V3", "profile")
-      headers.merge!(sdk_headers)
-
-      params = {
-        "version" => @version,
-        "raw_scores" => raw_scores,
-        "csv_headers" => csv_headers,
-        "consumption_preferences" => consumption_preferences
-      }
-
-      if content_type.start_with?("application/json") && content.instance_of?(Hash)
-        data = content.to_json
-      else
-        data = content
-      end
-
-      method_url = "/v3/profile"
-
-      response = request(
-        method: "POST",
-        url: method_url,
-        headers: headers,
-        params: params,
-        data: data,
-        accept_json: true
-      )
-      response
-    end
-  end
-end