Class: Google::Cloud::Language::V1::AnnotateTextRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/language/v1/language_service.rb

Overview

The request message for the text annotation API, which can perform multiple analysis types (sentiment, entities, and syntax) in one call.

Defined Under Namespace

Classes: Features

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ ::Google::Cloud::Language::V1::Document

Returns Required. Input document.

Returns:



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'proto_docs/google/cloud/language/v1/language_service.rb', line 1088

class AnnotateTextRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All available features for sentiment, syntax, and semantic analysis.
  # Setting each one to true will enable that specific analysis for the input.
  # @!attribute [rw] extract_syntax
  #   @return [::Boolean]
  #     Extract syntax information.
  # @!attribute [rw] extract_entities
  #   @return [::Boolean]
  #     Extract entities.
  # @!attribute [rw] extract_document_sentiment
  #   @return [::Boolean]
  #     Extract document-level sentiment.
  # @!attribute [rw] extract_entity_sentiment
  #   @return [::Boolean]
  #     Extract entities and their associated sentiment.
  # @!attribute [rw] classify_text
  #   @return [::Boolean]
  #     Classify the full document into categories.
  # @!attribute [rw] classification_model_options
  #   @return [::Google::Cloud::Language::V1::ClassificationModelOptions]
  #     The model options to use for classification. Defaults to v1 options
  #     if not specified. Only used if `classify_text` is set to true.
  class Features
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#encoding_type ⇒ ::Google::Cloud::Language::V1::EncodingType

Returns The encoding type used by the API to calculate offsets.

Returns:



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'proto_docs/google/cloud/language/v1/language_service.rb', line 1088

class AnnotateTextRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All available features for sentiment, syntax, and semantic analysis.
  # Setting each one to true will enable that specific analysis for the input.
  # @!attribute [rw] extract_syntax
  #   @return [::Boolean]
  #     Extract syntax information.
  # @!attribute [rw] extract_entities
  #   @return [::Boolean]
  #     Extract entities.
  # @!attribute [rw] extract_document_sentiment
  #   @return [::Boolean]
  #     Extract document-level sentiment.
  # @!attribute [rw] extract_entity_sentiment
  #   @return [::Boolean]
  #     Extract entities and their associated sentiment.
  # @!attribute [rw] classify_text
  #   @return [::Boolean]
  #     Classify the full document into categories.
  # @!attribute [rw] classification_model_options
  #   @return [::Google::Cloud::Language::V1::ClassificationModelOptions]
  #     The model options to use for classification. Defaults to v1 options
  #     if not specified. Only used if `classify_text` is set to true.
  class Features
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#features ⇒ ::Google::Cloud::Language::V1::AnnotateTextRequest::Features

Returns Required. The enabled features.

Returns:



1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'proto_docs/google/cloud/language/v1/language_service.rb', line 1088

class AnnotateTextRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All available features for sentiment, syntax, and semantic analysis.
  # Setting each one to true will enable that specific analysis for the input.
  # @!attribute [rw] extract_syntax
  #   @return [::Boolean]
  #     Extract syntax information.
  # @!attribute [rw] extract_entities
  #   @return [::Boolean]
  #     Extract entities.
  # @!attribute [rw] extract_document_sentiment
  #   @return [::Boolean]
  #     Extract document-level sentiment.
  # @!attribute [rw] extract_entity_sentiment
  #   @return [::Boolean]
  #     Extract entities and their associated sentiment.
  # @!attribute [rw] classify_text
  #   @return [::Boolean]
  #     Classify the full document into categories.
  # @!attribute [rw] classification_model_options
  #   @return [::Google::Cloud::Language::V1::ClassificationModelOptions]
  #     The model options to use for classification. Defaults to v1 options
  #     if not specified. Only used if `classify_text` is set to true.
  class Features
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end