Natural Language V1beta2 API - Class Google::Cloud::Language::V1beta2::Document (v0.13.0)

Reference documentation and code samples for the Natural Language V1beta2 API class Google::Cloud::Language::V1beta2::Document.

Represents the input to API methods.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#boilerplate_handling

def boilerplate_handling() -> ::Google::Cloud::Language::V1beta2::Document::BoilerplateHandling
Returns

#boilerplate_handling=

def boilerplate_handling=(value) -> ::Google::Cloud::Language::V1beta2::Document::BoilerplateHandling
Parameter
Returns

#content

def content() -> ::String
Returns
  • (::String) — The content of the input in string format. Cloud audit logging exempt since it is based on user data.

    Note: The following fields are mutually exclusive: content, gcs_content_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#content=

def content=(value) -> ::String
Parameter
  • value (::String) — The content of the input in string format. Cloud audit logging exempt since it is based on user data.

    Note: The following fields are mutually exclusive: content, gcs_content_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The content of the input in string format. Cloud audit logging exempt since it is based on user data.

    Note: The following fields are mutually exclusive: content, gcs_content_uri. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_content_uri

def gcs_content_uri() -> ::String
Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: gcs_content_uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_content_uri=

def gcs_content_uri=(value) -> ::String
Parameter
  • value (::String) — 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.

    Note: The following fields are mutually exclusive: gcs_content_uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: gcs_content_uri, content. If a field in that set is populated, all other fields in the set will automatically be cleared.

#language

def language() -> ::String
Returns
  • (::String) — The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.
    Language Support lists currently supported languages for each API method. 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.

#language=

def language=(value) -> ::String
Parameter
  • value (::String) — The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.
    Language Support lists currently supported languages for each API method. 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.
Returns
  • (::String) — The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted.
    Language Support lists currently supported languages for each API method. 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.

#reference_web_uri

def reference_web_uri() -> ::String
Returns
  • (::String) — The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document.

#reference_web_uri=

def reference_web_uri=(value) -> ::String
Parameter
  • value (::String) — The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document.
Returns
  • (::String) — The web URI where the document comes from. This URI is not used for fetching the content, but as a hint for analyzing the document.

#type

def type() -> ::Google::Cloud::Language::V1beta2::Document::Type
Returns

#type=

def type=(value) -> ::Google::Cloud::Language::V1beta2::Document::Type
Parameter
Returns