feat(language): update code example for Cloud NL v2 - python by kornosk · Pull Request #10544 · GoogleCloudPlatform/python-docs-samples

kornosk · 2023-08-22T19:18:08Z

Description

Fixes b/296927741

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

I have followed Sample Guidelines from AUTHORING_GUIDE.MD
README is updated to include all relevant information
Tests pass: nox -s py-3.9 (see Test Environment Setup)
Lint pass: nox -s lint (see Test Environment Setup)
These samples need a new API enabled in testing projects to pass (let us know which ones): b/295392278.
These samples need a new/updated env vars in testing projects set to pass (let us know which ones)
This sample adds a new sample directory, and I updated the CODEOWNERS file with the codeowners for this sample
This sample adds a new Product API, and I updated the Blunderbuss issue/PR auto-assigner with the codeowners for this sample
Please merge this PR for me once it is approved

snippet-bot · 2023-08-22T19:52:25Z

Here is the summary of changes.

You are about to add 6 region tags.

language/v2/language_classify_gcs.py:23, tag language_classify_gcs
language/v2/language_classify_text.py:23, tag language_classify_text
language/v2/language_entities_gcs.py:23, tag language_entities_gcs
language/v2/language_entities_text.py:23, tag language_entities_text
language/v2/language_sentiment_gcs.py:23, tag language_sentiment_gcs
language/v2/language_sentiment_text.py:23, tag language_sentiment_text

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

dandhlee

Will you be adding tests?

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

kornosk · 2023-08-22T22:42:06Z

I copied the test folder from https://github.com/GoogleCloudPlatform/python-docs-samples/tree/HEAD/language/v1/test. Does this work?

Plan to have the other API samples once this language_entities looks good.

dandhlee · 2023-08-22T22:51:24Z

Gotcha. I'm not entirely sure how the test layout is done since this sample was from a client library repository. I'll leave it to the product team to help verify, but looks like the tests are included in the new run under v2!

kornosk · 2023-08-22T23:24:29Z

@dandhlee Thank you for the review! I've addressed all your comments. Please let me know if you have any more concerns.

dandhlee

Reviewing for Python style.

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

more filed added, taking a quick look

telpirion · 2023-08-24T17:41:54Z

Be sure to review the Python style guidance and Style Guide.

dandhlee

Reviewing for Python style.

kornosk · 2023-08-24T18:58:34Z

Added tests and minor changes in style.

telpirion · 2023-08-24T17:36:24Z

+# [END language_classify_gcs]
+
+
+def main():


issue: remove CLI.

https://googlecloudplatform.github.io/samples-style-guide/#no-cli

Not sure why you still see this but I've removed all the main() functions already. Probably a github glitch or browser not refreshed.

telpirion · 2023-08-24T17:36:51Z

+# [END language_classify_text]
+
+
+def main():


Same as above, no CLI.

It's already removed.

telpirion · 2023-08-24T19:08:12Z

+    language_classify_gcs.sample_classify_text()
+    captured = capsys.readouterr()
+    assert (
+        "TV" in captured.out


issue: don't test for model results in these integration tests. Model changes can affect API output, which leads to these tests being broken.

Instead, test for the string literals printed to stdout (e.g. "Confidence" and "Category"). These literals won't be printed if the call to the API fails, which provides sufficient signal for sample quality.

telpirion · 2023-08-24T19:08:45Z

+    language_classify_text.sample_classify_text()
+    captured = capsys.readouterr()
+    assert (
+        "TV" in captured.out


See previous about API output.

telpirion · 2023-08-24T19:09:38Z

+    captured = capsys.readouterr()
+    assert (
+        "Representative name for the entity: California" in captured.out
+        and "Entity type: LOCATION" in captured.out


See previous about testing for API output.

telpirion · 2023-08-24T19:10:42Z

+    # the language specified in the request or, if not specified,
+    # the automatically-detected language.
+    print(f"Language of the text: {response.language_code}")
+


Remove extraneous line

telpirion · 2023-08-24T19:10:54Z

+    language_entities_text.sample_analyze_entities()
+    captured = capsys.readouterr()
+    assert (
+        "Representative name for the entity: California" in captured.out


See previous about testing for output.

telpirion · 2023-08-24T19:11:19Z

+    # the language specified in the request or, if not specified,
+    # the automatically-detected language.
+    print(f"Language of the text: {response.language_code}")
+


Remove extraneous empty line.

telpirion · 2023-08-24T19:11:31Z

+    language_sentiment_gcs.sample_analyze_sentiment()
+    captured = capsys.readouterr()
+    assert (
+        "Document sentiment score: 0." in captured.out


See previous about testing for output.

telpirion · 2023-08-24T19:11:50Z

+    language_sentiment_text.sample_analyze_sentiment()
+    captured = capsys.readouterr()
+    assert (
+        "Document sentiment score: 0." in captured.out


See previous about testing for API output.

telpirion

Looks great! Let's merge it when we can.

Kornraphop (Ken) Kawintiranon added 4 commits August 21, 2023 16:37

Update API v2 example code for analyze_sentiment

d0f1b6e

Update library client version to 2.11.0

691283b

Update API v2 example code for analyze_entities

dbb09f2

Update API v2 example code for analyze_entities

3fcb024

product-auto-label Bot added samples Issues that are directly related to samples. api: language Issues related to the Cloud Natural Language API API. labels Aug 22, 2023

kornosk marked this pull request as ready for review August 22, 2023 19:52

kornosk requested review from a team as code owners August 22, 2023 19:52

blunderbuss-gcf Bot assigned telpirion Aug 22, 2023

kornosk changed the title ~~Update code example for Cloud NL v2 - python~~ Update code example for Cloud NL v2 - python (analyze_entities) Aug 22, 2023

kornosk force-pushed the nl-v2 branch from 5d0f58c to 488ad04 Compare August 22, 2023 19:58

Revert back example code for analyze_sentiment to v1

81e7ac8

kornosk force-pushed the nl-v2 branch from 488ad04 to 81e7ac8 Compare August 22, 2023 20:37

dandhlee added the kokoro:run Add this label to force Kokoro to re-run the tests. label Aug 22, 2023

kokoro-team removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Aug 22, 2023

kornosk marked this pull request as draft August 22, 2023 21:44

dandhlee reviewed Aug 22, 2023

View reviewed changes

kornosk and others added 6 commits August 22, 2023 15:23

Update language/v2/language_entities_gcs.py

3b552c8

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Update language/v2/language_entities_gcs.py

6ed14e2

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Update language/v2/language_entities_gcs.py

9310d67

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Update language/v2/language_entities_gcs.py

2398a41

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Update based on comments

9841f66

Update based on comments

eb7810f

kornosk marked this pull request as ready for review August 22, 2023 22:48

kornosk requested a review from dandhlee August 22, 2023 22:49

Update based on comments

ed5451c

Update based on comments

8403af1

dandhlee previously approved these changes Aug 23, 2023

View reviewed changes

kornosk and others added 6 commits August 22, 2023 22:10

Update language/v2/language_entities_gcs.py

7d9c234

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Update language/v2/language_entities_text.py

f59aca3

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Update language/v2/language_entities_text.py

f009cfd

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Update language/v2/language_entities_gcs.py

7120824

Co-authored-by: Dan Lee <71398022+dandhlee@users.noreply.github.com>

Add code samples for language_classify

1b8926d

Add code samples for language_sentiment

1e20571

kornosk changed the title ~~Update code example for Cloud NL v2 - python (analyze_entities)~~ Update code example for Cloud NL v2 - python Aug 23, 2023

Fix minor bugs

a3ca4b2

dandhlee reviewed Aug 23, 2023

View reviewed changes

Comment thread language/v2/language_classify_gcs.py Outdated

Comment thread language/v2/language_entities_text.py Outdated

Comment thread language/v2/language_sentiment_text.py

Update based on comments.

d946415

telpirion changed the title ~~Update code example for Cloud NL v2 - python~~ feat(language): update code example for Cloud NL v2 - python Aug 24, 2023

telpirion added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Aug 24, 2023

dandhlee approved these changes Aug 24, 2023

View reviewed changes

Update based on the style guide

6be6119

telpirion suggested changes Aug 24, 2023

View reviewed changes

Update based on comments

c99ec17

telpirion approved these changes Aug 24, 2023

View reviewed changes

telpirion removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Aug 24, 2023

telpirion merged commit e440097 into GoogleCloudPlatform:main Aug 24, 2023

Conversation

kornosk commented Aug 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

snippet-bot Bot commented Aug 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dandhlee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kornosk commented Aug 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dandhlee commented Aug 22, 2023

Uh oh!

kornosk commented Aug 22, 2023

Uh oh!

dandhlee left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

telpirion commented Aug 24, 2023

Uh oh!

dandhlee left a comment

Choose a reason for hiding this comment

Uh oh!

kornosk commented Aug 24, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kornosk Aug 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

kornosk commented Aug 22, 2023 •

edited

Loading

snippet-bot Bot commented Aug 22, 2023 •

edited

Loading

kornosk commented Aug 22, 2023 •

edited

Loading

kornosk Aug 24, 2023 •

edited

Loading