Blame - docs/dyn/language_v1.documents.html - platform/external/python/google-api-python-client

2017-01-06 09:58:29 -0800

[diff] [blame]

553

# Populated if the user enables

554

# AnnotateTextRequest.Features.extract_entities.

555

{ # Represents a phrase in the text that is a known entity, such as

556

# a person, an organization, or location. The API associates information, such

557

# as salience and mentions, with entities.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

558

"mentions": [ # The mentions of this entity in the input document. The API currently

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

559

# supports proper noun mentions.

560

{ # Represents a mention for an entity in the text. Currently, proper noun

561

# mentions are supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

562

"text": { # Represents an output piece of text. # The mention text.

563

"beginOffset": 42, # The API calculates the beginning offset of the content in the original

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

564

# document according to the EncodingType specified in the API request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

565

"content": "A String", # The content of the output text.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

566

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

567

"type": "A String", # The type of the entity mention.

568

"sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

569

# AnnotateTextRequest.Features.extract_entity_sentiment is set to

570

# true, this field will contain the sentiment expressed for this mention of

571

# the entity in the provided document.

572

# the text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

573

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

574

# (positive sentiment).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

575

"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

576

# the absolute magnitude of sentiment regardless of score (positive or

577

# negative).

578

},

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

579

},

580

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

581

"name": "A String", # The representative name for the entity.

582

"type": "A String", # The entity type.

583

"metadata": { # Metadata associated with the entity.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

584

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

585

# For most entity types, the metadata is a Wikipedia URL (`wikipedia_url`)

586

# and Knowledge Graph MID (`mid`), if they are available. For the metadata

587

# associated with other entity types, see the Type table below.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

588

"a_key": "A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

589

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

590

"salience": 3.14, # The salience score associated with the entity in the [0, 1.0] range.

591

#

592

# The salience score for an entity provides information about the

593

# importance or centrality of that entity to the entire document text.

594

# Scores closer to 0 are less salient, while scores closer to 1.0 are highly

595

# salient.

596

"sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeEntitySentiment or if

597

# AnnotateTextRequest.Features.extract_entity_sentiment is set to

598

# true, this field will contain the aggregate sentiment expressed for this

599

# entity in the provided document.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

600

# the text.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

601

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

602

# (positive sentiment).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

603

"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

604

# the absolute magnitude of sentiment regardless of score (positive or

# negative).

},

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

609

"sentences": [ # Sentences in the input document. Populated if the user enables

610

# AnnotateTextRequest.Features.extract_syntax.

611

{ # Represents a sentence in the input document.

612

"sentiment": { # Represents the feeling associated with the entire text or entities in # For calls to AnalyzeSentiment or if

613

# AnnotateTextRequest.Features.extract_document_sentiment is set to

614

# true, this field will contain the sentiment for the sentence.

615

# the text.

616

"score": 3.14, # Sentiment score between -1.0 (negative sentiment) and 1.0

617

# (positive sentiment).

618

"magnitude": 3.14, # A non-negative number in the [0, +inf) range, which represents

619

# the absolute magnitude of sentiment regardless of score (positive or

620

# negative).

621

},

622

"text": { # Represents an output piece of text. # The sentence text.

623

"beginOffset": 42, # The API calculates the beginning offset of the content in the original

624

# document according to the EncodingType specified in the API request.

625

"content": "A String", # The content of the output text.

},

},

],

"tokens": [ # Tokens, along with their syntactic information, in the input document.

630

# Populated if the user enables

631

# AnnotateTextRequest.Features.extract_syntax.

632

{ # Represents the smallest syntactic building block of the text.

633

"text": { # Represents an output piece of text. # The token text.

634

"beginOffset": 42, # The API calculates the beginning offset of the content in the original

635

# document according to the EncodingType specified in the API request.

636

"content": "A String", # The content of the output text.

637

},

638

"dependencyEdge": { # Represents dependency parse tree information for a token. (For more # Dependency tree parse for this token.

639

# information on dependency labels, see

640

# http://www.aclweb.org/anthology/P13-2017

641

"label": "A String", # The parse label for the token.

642

"headTokenIndex": 42, # Represents the head of this token in the dependency tree.

643

# This is the index of the token which has an arc going to this token.

644

# The index is the position of the token in the array of tokens returned

645

# by the API method. If this token is a root token, then the

646

# `head_token_index` is its own index.

647

},

648

"lemma": "A String", # [Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.

649

"partOfSpeech": { # Represents part of speech information for a token. Parts of speech # Parts of speech tag for this token.

650

# are as defined in

651

# http://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf

652

"proper": "A String", # The grammatical properness.

653

"case": "A String", # The grammatical case.

654

"tense": "A String", # The grammatical tense.

655

"reciprocity": "A String", # The grammatical reciprocity.

656

"form": "A String", # The grammatical form.

657

"number": "A String", # The grammatical number.

658

"voice": "A String", # The grammatical voice.

659

"aspect": "A String", # The grammatical aspect.

660

"mood": "A String", # The grammatical mood.

661

"tag": "A String", # The part of speech tag.

662

"gender": "A String", # The grammatical gender.

663

"person": "A String", # The grammatical person.

664

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

671

<code class="details" id="classifyText">classifyText(body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

672

<pre>Classifies a document into categories.

673

674

Args:

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

675

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

676

The object takes the form of:

677

678

{ # The document classification request message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

679

"document": { # ################################################################ # # Required. Input document.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

680

#

681

# Represents the input to API methods.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

682

"gcsContentUri": "A String", # The Google Cloud Storage URI where the file content is located.

683

# This URI must be of the form: gs://bucket_name/object_name. For more

684

# details, see https://cloud.google.com/storage/docs/reference-uris.

685

# NOTE: Cloud Storage object versioning is not supported.

686

"language": "A String", # The language of the document (if not specified, the language is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

687

# automatically detected). Both ISO and BCP-47 language codes are

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

688

# accepted.<br>

689

# [Language

690

# Support](https://cloud.google.com/natural-language/docs/languages) lists

691

# currently supported languages for each API method. If the language (either

692

# specified by the caller or automatically detected) is not supported by the

693

# called API method, an `INVALID_ARGUMENT` error is returned.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

694

"type": "A String", # Required. If the type is not set or is `TYPE_UNSPECIFIED`,

695

# returns an `INVALID_ARGUMENT` error.

696

"content": "A String", # The content of the input in string format.

697

# Cloud audit logging exempt since it is based on user data.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

708

709

{ # The document classification response message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

710

"categories": [ # Categories representing the input document.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

711

{ # Represents a category returned from the text classifier.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

712

"name": "A String", # The name of the category representing the document, from the [predefined

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

713

# taxonomy](https://cloud.google.com/natural-language/docs/categories).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

714

"confidence": 3.14, # The classifier's confidence of the category. Number represents how certain

715

# the classifier is that this category represents the given text.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

716

},

717

],

Jon Wayne Parrott