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
- (::Google::Cloud::Language::V1beta2::Document::BoilerplateHandling) — Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
#boilerplate_handling=
def boilerplate_handling=(value) -> ::Google::Cloud::Language::V1beta2::Document::BoilerplateHandling Parameter
- value (::Google::Cloud::Language::V1beta2::Document::BoilerplateHandling) — Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
Returns
- (::Google::Cloud::Language::V1beta2::Document::BoilerplateHandling) — Indicates how detected boilerplate(e.g. advertisements, copyright declarations, banners) should be handled for this document. If not specified, boilerplate will be treated the same as content.
#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.
#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.
Returns
- (::String) — The content of the input in string format. Cloud audit logging exempt since it is based on user data.
#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.
#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.
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.
#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, anINVALID_ARGUMENTerror 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, anINVALID_ARGUMENTerror 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, anINVALID_ARGUMENTerror 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
- (::Google::Cloud::Language::V1beta2::Document::Type) — Required. If the type is not set or is
TYPE_UNSPECIFIED, returns anINVALID_ARGUMENTerror.
#type=
def type=(value) -> ::Google::Cloud::Language::V1beta2::Document::Type Parameter
- value (::Google::Cloud::Language::V1beta2::Document::Type) — Required. If the type is not set or is
TYPE_UNSPECIFIED, returns anINVALID_ARGUMENTerror.
Returns
- (::Google::Cloud::Language::V1beta2::Document::Type) — Required. If the type is not set or is
TYPE_UNSPECIFIED, returns anINVALID_ARGUMENTerror.