Adding usage doc for Natural Language API. by dhermes · Pull Request #2062 · googleapis/google-cloud-python

dhermes · 2016-08-08T17:00:42Z

/cc @omaray are you in the org yet (I can't assign you to this PR)

Sign in to view

+and each method uses a `Document`_ for representing text. To
+create a :class:`~gcloud.language.document.Document`,
+
+  .. code-block:: python


tseaver · 2016-08-08T17:19:20Z

A couple of more general questions:

Shouldn't this PR (and subsequent implementation PRs) target a natural-language-feature branch?
Should we be packaging up the JSON results for the three APIs into objects?

Sign in to view

+app. You can analyze text uploaded in your request or integrate
+with your document storage on Google Cloud Storage.
+
+This is a Beta release of Google Cloud Natural Language API. This


dhermes · 2016-08-17T22:07:01Z

@tseaver Can you weigh in here on which response values you think we should wrap?

elibixby · 2016-08-18T03:32:32Z

@jerjou Can you take a look to make sure we have someone who has used the API a bit to comment on usability.

tseaver · 2016-08-18T16:14:37Z

Can you weigh in here on which response values you think we should wrap?

For analyze_entities, we could return instances of a (putative) Entity class:

for entity in document.analyze_entities():
    build_entity_link(entity.name, entity.type, entity.url)

For analyze_sentiment, we could return a (putative) Sentiment instance:

def by_sentiment(document):
    """Sort key:  rank from most negative to most positive."""
    sentiment = document.analyze_sentiment()
    return sentiment.polarity * sentiment.magnitude

ranked = sorted(documents, key=by_sentiment)

For annotate_text, (assuming we have flags to disable unwanted features):

only_syntax = document.annotate_text(
    include_entities=False, include_sentiment=False)

assert only_syntax.entities is None
assert only_syntax.sentiment is None

tree = ParseTree()  # imagined class w/ 'add_token' method.

for index, token in enumerate(only_syntax.tokens):
    edge = token.dependency_edge
    tree.add_token(
        index, token.lemma, token.part_of_speech, edge.head_index, edge.label)

Sign in to view

+     >>> document = client.document(text_content)
+
+By default, the document's language and type are English and
+plain text:


tseaver · 2016-08-22T23:18:19Z

LGTM.

dhermes · 2016-08-22T23:47:51Z

@jgeewax In the interest of keeping this PR from reaching 15 days of age, I'll merge with @tseaver's LGTM and we can address after the fact as the API develops (it's a small surface area so it won't be overwhelming).

Sign in to view

+  .. code-block:: python
+
+     >>> client = language.Client(language='es',
+     ...                          encoding=encoding=language.Encoding.UTF16)


… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

* feat: support pandas.Index as key for DataFrame.__setitem__() * fix format

dhermes added the natural-language label Aug 8, 2016

dhermes assigned jgeewax, daspecster and tseaver Aug 8, 2016

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 8, 2016

tseaver reviewed Aug 8, 2016
View reviewed changes

dhermes mentioned this pull request Aug 8, 2016

Implement natural language API #2027

Closed

daspecster reviewed Aug 15, 2016
View reviewed changes

jerjou reviewed Aug 18, 2016
View reviewed changes

Adding usage doc for Natural Language API.

d36ad4d

dhermes force-pushed the language-usage-doc branch from cdb4adf to d36ad4d Compare August 23, 2016 00:29

dhermes removed the PR: Needs to be squashed label Aug 23, 2016

dhermes merged commit 9a6bf7f into googleapis:master Aug 23, 2016

dhermes deleted the language-usage-doc branch August 23, 2016 01:32

jgeewax reviewed Aug 23, 2016
View reviewed changes

dhermes mentioned this pull request Aug 24, 2016

Updating language implementation after some review comments #2187

Merged

dhermes mentioned this pull request Sep 19, 2016

Cut 0.19.0 release. #2270

Merged

theacodes unassigned jgeewax and daspecster Sep 28, 2018

atulep pushed a commit that referenced this pull request Apr 6, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

995dc0a

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

atulep pushed a commit that referenced this pull request Apr 6, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

9611a56

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

atulep pushed a commit that referenced this pull request Apr 6, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

a8d59bd

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

atulep pushed a commit that referenced this pull request Apr 6, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

25e526a

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

atulep pushed a commit that referenced this pull request Apr 18, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

1930787

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

atulep pushed a commit that referenced this pull request Apr 18, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

f6cd730

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

parthea pushed a commit that referenced this pull request Oct 22, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

9789750

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

parthea pushed a commit that referenced this pull request Oct 22, 2023

Move mic samples out of cloud-client so that cloud-client samples can…

26b530d

… be run in cloud shell [(#2062)](GoogleCloudPlatform/python-docs-samples#2062)

parthea pushed a commit that referenced this pull request Nov 24, 2025

chore(python): use python 3.10 for docs build (#2062)

75294fd

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

parthea pushed a commit that referenced this pull request Apr 1, 2026

feat: support pandas.Index as key for DataFrame.__setitem__() (#2062)

b00c8c2

* feat: support pandas.Index as key for DataFrame.__setitem__() * fix format

Conversation

dhermes commented Aug 8, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

tseaver commented Aug 8, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

dhermes commented Aug 17, 2016

Uh oh!

elibixby commented Aug 18, 2016

Uh oh!

tseaver commented Aug 18, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

tseaver commented Aug 22, 2016

Uh oh!

dhermes commented Aug 22, 2016

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants