Skip to content

fix(docs): remove inaccurate backwards compatibility notes in Google provider docs #2329

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.

Sign up for GitHub

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

Closed
nigamgauri wants to merge 1 commit into from
+4 −6
Closed

fix(docs): remove inaccurate backwards compatibility notes in Google provider docs #2329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/integrations/genai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ We currently have two modes for Gemini

This filtering happens automatically and requires no additional configuration. For more information about Gemini's thinking feature, see the [official documentation](https://ai.google.dev/gemini-api/docs/thinking).

!!! note "Backwards Compatibility"

The provider-specific modes (`Mode.TOOLS`, `Mode.JSON`, `Mode.JSON`) are still supported but emit deprecation warnings and map to the generic modes (`Mode.TOOLS`, `Mode.JSON`).

## Installation

Expand Down Expand Up @@ -550,7 +548,7 @@ print(response)
**As of July 11, 2025, Google GenAI does not support streaming with tool/function calling or structured outputs for regular models.**

- `Mode.TOOLS` and `Mode.JSON` do not support streaming with regular models
- To use streaming, you must use `Partial[YourModel]` explicitly or switch to other modes like `Mode.JSON`
- To use streaming, you must use `Partial[YourModel]` explicitly
- Alternatively, set `stream=False` to disable streaming

Streaming allows you to process responses incrementally rather than waiting for the complete result. This is extremely useful for making UI changes feel instant and responsive.
Expand Down
2 changes: 0 additions & 2 deletions docs/integrations/google.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,9 +338,7 @@ We provide several modes to make it easy to work with the different response mod
1. `instructor.Mode.TOOLS` : This uses Gemini's tool calling API to return structured outputs (default)
2. `instructor.Mode.JSON` : This uses Gemini's JSON schema mode for structured outputs

!!! note "Backwards Compatibility"

Legacy provider-specific modes (for example `Mode.TOOLS`, `Mode.JSON`, `Mode.JSON`, `Mode.TOOLS`) are deprecated. They emit warnings and map to the generic modes.

!!! info "Mode Selection"
When using `from_provider`, the appropriate mode is automatically selected based on the provider and model capabilities.
Expand Down
4 changes: 3 additions & 1 deletion docs/integrations/vertex.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,9 @@ from vertexai.generative_models import GenerativeModel

vertexai.init(project="your-project", location="us-central1")

client = instructor.from_provider("google/gemini-2.5-flash", vertexai=True),
client = instructor.from_provider(
"google/gemini-2.5-flash",
vertexai=True,
mode=instructor.Mode.TOOLS,
)
```
Expand Down