Skip to content

fix(model_garden): add deepseek example #13444

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

msampathkumar
Copy link
Member

Description

Add new samples for Model Garden.

Note - Need to enable the Model!

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

Checklist

  • 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)
  • Please merge this PR for me once it is approved

@product-auto-label product-auto-label bot added the samples Issues that are directly related to samples. label Jun 18, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @msampathkumar, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request adds a new Python sample to the Model Garden section, specifically for the DeepSeek model. It provides a functional example of how to programmatically interact with the DeepSeek model via Vertex AI's OpenAPI endpoint, including necessary authentication, dependency management, and a dedicated test case.

Highlights

  • New DeepSeek Model Example: This PR introduces a new Python example demonstrating how to interact with the DeepSeek model hosted in Vertex AI Model Garden. The example showcases text generation by making an API call to the model's OpenAPI endpoint.
  • Authentication and API Interaction: The core example (textgen_with_txt.py) includes a helper function to obtain Google Cloud ADC (Application Default Credentials) and a bearer token, which are then used to authenticate and make a POST request to the Vertex AI endpoint for chat completions.
  • Testing and Dependencies: Accompanying the example are new requirements.txt and requirements-test.txt files to manage runtime and testing dependencies (like requests and pytest), along with a noxfile_config.py for build configuration and a test_examples.py to verify the example's functionality.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new Python example for interacting with a DeepSeek model via Vertex AI Model Garden. The changes include the core script for API interaction, unit tests, Nox configuration, and dependency files. My review focuses on several key areas:

  • Correctness: Ensuring type hints match actual return types and that the primary function returns the expected generated content.
  • Error Handling: Adding checks for HTTP errors to make the script more robust.
  • Maintainability (PEP 8): Recommending standard import placement for better code organization.

Overall, the example is a good starting point, and the suggested changes aim to enhance its reliability and adherence to Python best practices. The review comments reference PEP 8, Python's official style guide, particularly concerning import statement placement.

# limitations under the License.


def get_bearer_token() -> str:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

critical

The function get_bearer_token is type-hinted to return str, but it actually returns a tuple (project_name, bearer_token). This mismatch can lead to type errors and incorrect assumptions by callers of this function.

Suggested change
def get_bearer_token() -> str:
def get_bearer_token() -> tuple[str, str]:

}
# Send the request
response = requests.post(url, headers=headers, data=json.dumps(data))
print(f"Request Response: {response.status_code}")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The HTTP response status is printed, but errors (like 4xx or 5xx client/server errors) are not explicitly handled before attempting to process the response. If the API call fails, json.loads(response.content) could raise an exception on unexpected content, or the script might proceed with invalid data. It's robust practice to check for HTTP errors immediately after the request.

Consider using response.raise_for_status(), which will raise an requests.exceptions.HTTPError if the HTTP request returned an unsuccessful status code.

Suggested change
print(f"Request Response: {response.status_code}")
response.raise_for_status() # Will raise an HTTPError for bad responses (4XX or 5XX)
print(f"Request Response: {response.status_code}")

# The sky appears blue due to a phenomenon called **Rayleigh scattering**,
# which occurs when sunlight passes through Earth's atmosphere and
# ...
return response.content
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The function generate_content is type-hinted to return str and its name suggests it returns the generated textual content from the model. However, it currently returns response.content, which is of type bytes (the raw response body).

To align with the type hint and function's intent, it should parse the JSON response and return the actual generated text string, typically found within the choices part of the response. Accessing nested dictionary keys should also be done safely (e.g., using .get()).

Suggested change
return response.content
# Extract and return the assistant's message if available
if model_response.get("choices") and len(model_response["choices"]) > 0:
message = model_response["choices"][0].get("message", {})
content = message.get("content")
if content is not None:
return content
return "" # Return empty string or raise an error if content not found/as appropriate

Comment on lines +18 to +19
import google.auth
from google.auth.transport.requests import Request
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Imports google.auth and google.auth.transport.requests are defined locally within the get_bearer_token function. According to PEP 81, imports should generally be at the top of the file (after module docstrings and comments, before globals and constants) for better readability, maintainability, and discoverability of dependencies. Please move these imports to the module level.

Style Guide References

Suggested change
import google.auth
from google.auth.transport.requests import Request
# These imports should be moved to the top of the file:
# import google.auth
# from google.auth.transport.requests import Request

Footnotes

  1. PEP 8: Imports are always put at the top of the file, just after any module comments and docstrings, and before module globals and constants. This improves clarity and makes it easier to see what modules a script requires.

Comment on lines +32 to +33
import requests
import json
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Imports requests and json are defined locally within the generate_content function. Similar to the previous comment, PEP 81 recommends placing imports at the top of the file. Please move these to the module level.

Style Guide References

Suggested change
import requests
import json
# These imports should be moved to the top of the file:
# import requests
# import json

Footnotes

  1. PEP 8: Imports are always put at the top of the file, just after any module comments and docstrings, and before module globals and constants. This improves clarity and makes it easier to see what modules a script requires.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
samples Issues that are directly related to samples.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant