generated/google/apis/language_v1beta1/classes.rb in google-api-client-0.10.3 vs generated/google/apis/language_v1beta1/classes.rb in google-api-client-0.11.0

- old
+ new

@@ -20,10 +20,146 @@ module Google module Apis module LanguageV1beta1 + # Represents a mention for an entity in the text. Currently, proper noun + # mentions are supported. + class EntityMention + include Google::Apis::Core::Hashable + + # Represents an output piece of text. + # Corresponds to the JSON property `text` + # @return [Google::Apis::LanguageV1beta1::TextSpan] + attr_accessor :text + + # The type of the entity mention. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text = args[:text] if args.key?(:text) + @type = args[:type] if args.key?(:type) + end + end + + # All available features for sentiment, syntax, and semantic analysis. + # Setting each one to true will enable that specific analysis for the input. + class Features + include Google::Apis::Core::Hashable + + # Extract syntax information. + # Corresponds to the JSON property `extractSyntax` + # @return [Boolean] + attr_accessor :extract_syntax + alias_method :extract_syntax?, :extract_syntax + + # Extract document-level sentiment. + # Corresponds to the JSON property `extractDocumentSentiment` + # @return [Boolean] + attr_accessor :extract_document_sentiment + alias_method :extract_document_sentiment?, :extract_document_sentiment + + # Extract entities. + # Corresponds to the JSON property `extractEntities` + # @return [Boolean] + attr_accessor :extract_entities + alias_method :extract_entities?, :extract_entities + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @extract_syntax = args[:extract_syntax] if args.key?(:extract_syntax) + @extract_document_sentiment = args[:extract_document_sentiment] if args.key?(:extract_document_sentiment) + @extract_entities = args[:extract_entities] if args.key?(:extract_entities) + end + end + + # ################################################################ # + # Represents the input to API methods. + class Document + include Google::Apis::Core::Hashable + + # The language of the document (if not specified, the language is + # automatically detected). Both ISO and BCP-47 language codes are + # accepted.<br> + # **Current Language Restrictions:** + # * Only English, Spanish, and Japanese textual content are supported. + # If the language (either specified by the caller or automatically detected) + # is not supported by the called API method, an `INVALID_ARGUMENT` error + # is returned. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + + # Required. If the type is not set or is `TYPE_UNSPECIFIED`, + # returns an `INVALID_ARGUMENT` error. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + # The content of the input in string format. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # The Google Cloud Storage URI where the file content is located. + # This URI must be of the form: gs://bucket_name/object_name. For more + # details, see https://cloud.google.com/storage/docs/reference-uris. + # NOTE: Cloud Storage object versioning is not supported. + # Corresponds to the JSON property `gcsContentUri` + # @return [String] + attr_accessor :gcs_content_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @language = args[:language] if args.key?(:language) + @type = args[:type] if args.key?(:type) + @content = args[:content] if args.key?(:content) + @gcs_content_uri = args[:gcs_content_uri] if args.key?(:gcs_content_uri) + end + end + + # Represents a sentence in the input document. + class Sentence + include Google::Apis::Core::Hashable + + # Represents the feeling associated with the entire text or entities in + # the text. + # Corresponds to the JSON property `sentiment` + # @return [Google::Apis::LanguageV1beta1::Sentiment] + attr_accessor :sentiment + + # Represents an output piece of text. + # Corresponds to the JSON property `text` + # @return [Google::Apis::LanguageV1beta1::TextSpan] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sentiment = args[:sentiment] if args.key?(:sentiment) + @text = args[:text] if args.key?(:text) + end + end + # The entity analysis request message. class AnalyzeEntitiesRequest include Google::Apis::Core::Hashable # The encoding type used by the API to calculate offsets. @@ -87,10 +223,25 @@ # Represents part of speech information for a token. class PartOfSpeech include Google::Apis::Core::Hashable + # The grammatical case. + # Corresponds to the JSON property `case` + # @return [String] + attr_accessor :case + + # The grammatical tense. + # Corresponds to the JSON property `tense` + # @return [String] + attr_accessor :tense + + # The grammatical reciprocity. + # Corresponds to the JSON property `reciprocity` + # @return [String] + attr_accessor :reciprocity + # The grammatical form. # Corresponds to the JSON property `form` # @return [String] attr_accessor :form @@ -132,76 +283,67 @@ # The grammatical properness. # Corresponds to the JSON property `proper` # @return [String] attr_accessor :proper - # The grammatical case. - # Corresponds to the JSON property `case` - # @return [String] - attr_accessor :case - - # The grammatical tense. - # Corresponds to the JSON property `tense` - # @return [String] - attr_accessor :tense - - # The grammatical reciprocity. - # Corresponds to the JSON property `reciprocity` - # @return [String] - attr_accessor :reciprocity - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @case = args[:case] if args.key?(:case) + @tense = args[:tense] if args.key?(:tense) + @reciprocity = args[:reciprocity] if args.key?(:reciprocity) @form = args[:form] if args.key?(:form) @number = args[:number] if args.key?(:number) @voice = args[:voice] if args.key?(:voice) @aspect = args[:aspect] if args.key?(:aspect) @mood = args[:mood] if args.key?(:mood) @tag = args[:tag] if args.key?(:tag) @gender = args[:gender] if args.key?(:gender) @person = args[:person] if args.key?(:person) @proper = args[:proper] if args.key?(:proper) - @case = args[:case] if args.key?(:case) - @tense = args[:tense] if args.key?(:tense) - @reciprocity = args[:reciprocity] if args.key?(:reciprocity) end end # The syntax analysis request message. class AnalyzeSyntaxRequest include Google::Apis::Core::Hashable + # The encoding type used by the API to calculate offsets. + # Corresponds to the JSON property `encodingType` + # @return [String] + attr_accessor :encoding_type + # ################################################################ # # Represents the input to API methods. # Corresponds to the JSON property `document` # @return [Google::Apis::LanguageV1beta1::Document] attr_accessor :document - # The encoding type used by the API to calculate offsets. - # Corresponds to the JSON property `encodingType` - # @return [String] - attr_accessor :encoding_type - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) + @document = args[:document] if args.key?(:document) end end # The sentiment analysis response message. class AnalyzeSentimentResponse include Google::Apis::Core::Hashable + # The language of the text, which will be the same as the language specified + # in the request or, if not specified, the automatically-detected language. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + # The sentiment for all the sentences in the document. # Corresponds to the JSON property `sentences` # @return [Array<Google::Apis::LanguageV1beta1::Sentence>] attr_accessor :sentences @@ -209,52 +351,79 @@ # the text. # Corresponds to the JSON property `documentSentiment` # @return [Google::Apis::LanguageV1beta1::Sentiment] attr_accessor :document_sentiment - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # Corresponds to the JSON property `language` - # @return [String] - attr_accessor :language - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @language = args[:language] if args.key?(:language) @sentences = args[:sentences] if args.key?(:sentences) @document_sentiment = args[:document_sentiment] if args.key?(:document_sentiment) - @language = args[:language] if args.key?(:language) end end # The entity analysis response message. class AnalyzeEntitiesResponse include Google::Apis::Core::Hashable + # The language of the text, which will be the same as the language specified + # in the request or, if not specified, the automatically-detected language. + # See Document.language field for more details. + # Corresponds to the JSON property `language` + # @return [String] + attr_accessor :language + # The recognized entities in the input document. # Corresponds to the JSON property `entities` # @return [Array<Google::Apis::LanguageV1beta1::Entity>] attr_accessor :entities + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @language = args[:language] if args.key?(:language) + @entities = args[:entities] if args.key?(:entities) + end + end + + # The syntax analysis response message. + class AnalyzeSyntaxResponse + include Google::Apis::Core::Hashable + # The language of the text, which will be the same as the language specified # in the request or, if not specified, the automatically-detected language. # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language + # Sentences in the input document. + # Corresponds to the JSON property `sentences` + # @return [Array<Google::Apis::LanguageV1beta1::Sentence>] + attr_accessor :sentences + + # Tokens, along with their syntactic information, in the input document. + # Corresponds to the JSON property `tokens` + # @return [Array<Google::Apis::LanguageV1beta1::Token>] + attr_accessor :tokens + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @entities = args[:entities] if args.key?(:entities) @language = args[:language] if args.key?(:language) + @sentences = args[:sentences] if args.key?(:sentences) + @tokens = args[:tokens] if args.key?(:tokens) end end # Represents a phrase in the text that is a known entity, such as # a person, an organization, or location. The API associates information, such @@ -306,43 +475,10 @@ @metadata = args[:metadata] if args.key?(:metadata) @salience = args[:salience] if args.key?(:salience) end end - # The syntax analysis response message. - class AnalyzeSyntaxResponse - include Google::Apis::Core::Hashable - - # The language of the text, which will be the same as the language specified - # in the request or, if not specified, the automatically-detected language. - # See Document.language field for more details. - # Corresponds to the JSON property `language` - # @return [String] - attr_accessor :language - - # Sentences in the input document. - # Corresponds to the JSON property `sentences` - # @return [Array<Google::Apis::LanguageV1beta1::Sentence>] - attr_accessor :sentences - - # Tokens, along with their syntactic information, in the input document. - # Corresponds to the JSON property `tokens` - # @return [Array<Google::Apis::LanguageV1beta1::Token>] - attr_accessor :tokens - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @language = args[:language] if args.key?(:language) - @sentences = args[:sentences] if args.key?(:sentences) - @tokens = args[:tokens] if args.key?(:tokens) - end - end - # The request message for the text annotation API, which can perform multiple # analysis types (sentiment, entities, and syntax) in one call. class AnnotateTextRequest include Google::Apis::Core::Hashable @@ -377,23 +513,10 @@ # The text annotations response message. class AnnotateTextResponse include Google::Apis::Core::Hashable - # Sentences in the input document. Populated if the user enables - # AnnotateTextRequest.Features.extract_syntax. - # Corresponds to the JSON property `sentences` - # @return [Array<Google::Apis::LanguageV1beta1::Sentence>] - attr_accessor :sentences - - # Tokens, along with their syntactic information, in the input document. - # Populated if the user enables - # AnnotateTextRequest.Features.extract_syntax. - # Corresponds to the JSON property `tokens` - # @return [Array<Google::Apis::LanguageV1beta1::Token>] - attr_accessor :tokens - # Entities, along with their semantic information, in the input document. # Populated if the user enables # AnnotateTextRequest.Features.extract_entities. # Corresponds to the JSON property `entities` # @return [Array<Google::Apis::LanguageV1beta1::Entity>] @@ -410,84 +533,128 @@ # See Document.language field for more details. # Corresponds to the JSON property `language` # @return [String] attr_accessor :language + # Sentences in the input document. Populated if the user enables + # AnnotateTextRequest.Features.extract_syntax. + # Corresponds to the JSON property `sentences` + # @return [Array<Google::Apis::LanguageV1beta1::Sentence>] + attr_accessor :sentences + + # Tokens, along with their syntactic information, in the input document. + # Populated if the user enables + # AnnotateTextRequest.Features.extract_syntax. + # Corresponds to the JSON property `tokens` + # @return [Array<Google::Apis::LanguageV1beta1::Token>] + attr_accessor :tokens + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @sentences = args[:sentences] if args.key?(:sentences) - @tokens = args[:tokens] if args.key?(:tokens) @entities = args[:entities] if args.key?(:entities) @document_sentiment = args[:document_sentiment] if args.key?(:document_sentiment) @language = args[:language] if args.key?(:language) + @sentences = args[:sentences] if args.key?(:sentences) + @tokens = args[:tokens] if args.key?(:tokens) end end # The sentiment analysis request message. class AnalyzeSentimentRequest include Google::Apis::Core::Hashable - # ################################################################ # - # Represents the input to API methods. - # Corresponds to the JSON property `document` - # @return [Google::Apis::LanguageV1beta1::Document] - attr_accessor :document - # The encoding type used by the API to calculate sentence offsets for the # sentence sentiment. # Corresponds to the JSON property `encodingType` # @return [String] attr_accessor :encoding_type + # ################################################################ # + # Represents the input to API methods. + # Corresponds to the JSON property `document` + # @return [Google::Apis::LanguageV1beta1::Document] + attr_accessor :document + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @document = args[:document] if args.key?(:document) @encoding_type = args[:encoding_type] if args.key?(:encoding_type) + @document = args[:document] if args.key?(:document) end end # Represents dependency parse tree information for a token. class DependencyEdge include Google::Apis::Core::Hashable + # The parse label for the token. + # Corresponds to the JSON property `label` + # @return [String] + attr_accessor :label + # Represents the head of this token in the dependency tree. # This is the index of the token which has an arc going to this token. # The index is the position of the token in the array of tokens returned # by the API method. If this token is a root token, then the # `head_token_index` is its own index. # Corresponds to the JSON property `headTokenIndex` # @return [Fixnum] attr_accessor :head_token_index - # The parse label for the token. - # Corresponds to the JSON property `label` + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @label = args[:label] if args.key?(:label) + @head_token_index = args[:head_token_index] if args.key?(:head_token_index) + end + end + + # Represents an output piece of text. + class TextSpan + include Google::Apis::Core::Hashable + + # The API calculates the beginning offset of the content in the original + # document according to the EncodingType specified in the API request. + # Corresponds to the JSON property `beginOffset` + # @return [Fixnum] + attr_accessor :begin_offset + + # The content of the output text. + # Corresponds to the JSON property `content` # @return [String] - attr_accessor :label + attr_accessor :content def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @head_token_index = args[:head_token_index] if args.key?(:head_token_index) - @label = args[:label] if args.key?(:label) + @begin_offset = args[:begin_offset] if args.key?(:begin_offset) + @content = args[:content] if args.key?(:content) end end # Represents the smallest syntactic building block of the text. class Token include Google::Apis::Core::Hashable + # Represents part of speech information for a token. + # Corresponds to the JSON property `partOfSpeech` + # @return [Google::Apis::LanguageV1beta1::PartOfSpeech] + attr_accessor :part_of_speech + # Represents an output piece of text. # Corresponds to the JSON property `text` # @return [Google::Apis::LanguageV1beta1::TextSpan] attr_accessor :text @@ -499,54 +666,23 @@ # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token. # Corresponds to the JSON property `lemma` # @return [String] attr_accessor :lemma - # Represents part of speech information for a token. - # Corresponds to the JSON property `partOfSpeech` - # @return [Google::Apis::LanguageV1beta1::PartOfSpeech] - attr_accessor :part_of_speech - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) + @part_of_speech = args[:part_of_speech] if args.key?(:part_of_speech) @text = args[:text] if args.key?(:text) @dependency_edge = args[:dependency_edge] if args.key?(:dependency_edge) @lemma = args[:lemma] if args.key?(:lemma) - @part_of_speech = args[:part_of_speech] if args.key?(:part_of_speech) end end - # Represents an output piece of text. - class TextSpan - include Google::Apis::Core::Hashable - - # The API calculates the beginning offset of the content in the original - # document according to the EncodingType specified in the API request. - # Corresponds to the JSON property `beginOffset` - # @return [Fixnum] - attr_accessor :begin_offset - - # The content of the output text. - # Corresponds to the JSON property `content` - # @return [String] - attr_accessor :content - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @begin_offset = args[:begin_offset] if args.key?(:begin_offset) - @content = args[:content] if args.key?(:content) - end - end - # 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 @@ -585,15 +721,10 @@ # - Logging. If some API errors are stored in logs, the message `Status` could # be used directly after any stripping needed for security/privacy reasons. class Status include Google::Apis::Core::Hashable - # The status code, which should be an enum value of google.rpc.Code. - # Corresponds to the JSON property `code` - # @return [Fixnum] - attr_accessor :code - # 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. # Corresponds to the JSON property `message` # @return [String] @@ -603,154 +734,23 @@ # common set of message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array<Hash<String,Object>>] attr_accessor :details + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @code = args[:code] if args.key?(:code) @message = args[:message] if args.key?(:message) @details = args[:details] if args.key?(:details) - end - end - - # Represents a mention for an entity in the text. Currently, proper noun - # mentions are supported. - class EntityMention - include Google::Apis::Core::Hashable - - # Represents an output piece of text. - # Corresponds to the JSON property `text` - # @return [Google::Apis::LanguageV1beta1::TextSpan] - attr_accessor :text - - # The type of the entity mention. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @text = args[:text] if args.key?(:text) - @type = args[:type] if args.key?(:type) - end - end - - # All available features for sentiment, syntax, and semantic analysis. - # Setting each one to true will enable that specific analysis for the input. - class Features - include Google::Apis::Core::Hashable - - # Extract entities. - # Corresponds to the JSON property `extractEntities` - # @return [Boolean] - attr_accessor :extract_entities - alias_method :extract_entities?, :extract_entities - - # Extract syntax information. - # Corresponds to the JSON property `extractSyntax` - # @return [Boolean] - attr_accessor :extract_syntax - alias_method :extract_syntax?, :extract_syntax - - # Extract document-level sentiment. - # Corresponds to the JSON property `extractDocumentSentiment` - # @return [Boolean] - attr_accessor :extract_document_sentiment - alias_method :extract_document_sentiment?, :extract_document_sentiment - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @extract_entities = args[:extract_entities] if args.key?(:extract_entities) - @extract_syntax = args[:extract_syntax] if args.key?(:extract_syntax) - @extract_document_sentiment = args[:extract_document_sentiment] if args.key?(:extract_document_sentiment) - end - end - - # Represents a sentence in the input document. - class Sentence - include Google::Apis::Core::Hashable - - # Represents an output piece of text. - # Corresponds to the JSON property `text` - # @return [Google::Apis::LanguageV1beta1::TextSpan] - attr_accessor :text - - # Represents the feeling associated with the entire text or entities in - # the text. - # Corresponds to the JSON property `sentiment` - # @return [Google::Apis::LanguageV1beta1::Sentiment] - attr_accessor :sentiment - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @text = args[:text] if args.key?(:text) - @sentiment = args[:sentiment] if args.key?(:sentiment) - end - end - - # ################################################################ # - # Represents the input to API methods. - class Document - include Google::Apis::Core::Hashable - - # Required. If the type is not set or is `TYPE_UNSPECIFIED`, - # returns an `INVALID_ARGUMENT` error. - # Corresponds to the JSON property `type` - # @return [String] - attr_accessor :type - - # The content of the input in string format. - # Corresponds to the JSON property `content` - # @return [String] - attr_accessor :content - - # The Google Cloud Storage URI where the file content is located. - # This URI must be of the form: gs://bucket_name/object_name. For more - # details, see https://cloud.google.com/storage/docs/reference-uris. - # NOTE: Cloud Storage object versioning is not supported. - # Corresponds to the JSON property `gcsContentUri` - # @return [String] - attr_accessor :gcs_content_uri - - # The language of the document (if not specified, the language is - # automatically detected). Both ISO and BCP-47 language codes are - # accepted.<br> - # **Current Language Restrictions:** - # * Only English, Spanish, and Japanese textual content are supported. - # If the language (either specified by the caller or automatically detected) - # is not supported by the called API method, an `INVALID_ARGUMENT` error - # is returned. - # Corresponds to the JSON property `language` - # @return [String] - attr_accessor :language - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @type = args[:type] if args.key?(:type) - @content = args[:content] if args.key?(:content) - @gcs_content_uri = args[:gcs_content_uri] if args.key?(:gcs_content_uri) - @language = args[:language] if args.key?(:language) + @code = args[:code] if args.key?(:code) end end end end end