Repository navigation
docs: Refresh the README - #192
Merged
Merged
Conversation
- Use models that are currently available: gemini-2.0-flash, gemini-2.0-flash-thinking-exp and text-embedding-004 no longer exist - Document the new features: media resolution, image size, JSON Schema, multimodal function responses, URL context, server-side tool invocations, response metadata, file search import and operations, custom metadata, and faking chats - Add error handling and empty response sections to Troubleshooting - Fix wrong examples: file search store and document names, the function calling thought signature, the helper example that never sent a request, thinking configuration for Gemini 2.5 and 3, cached content TTL wording, and variable names in the Testing section
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A full pass over the README: outdated and wrong examples are fixed, and the features added in recent PRs are documented.
Outdated models
Most examples used models that no longer exist in the API (
gemini-2.0-flash,gemini-2.0-flash-thinking-exp,text-embedding-004), so they failed when copied. Examples now usegemini-2.5-flashandgemini-embedding-001, and the Usage section points to the models list.New sections
imageSizeresponseId, usage metadata,finishMessage,modelStatus)importFile(),getOperation()Fixes
text().thoughtSignatureto the function response; the chat session keeps the real one automatically.files/...as a store name,.../fileSearchDocuments/...for documents), the Table of Contents listed a non-existent "Update File Search Store" section, and the store example imported a non-existentGemini\Enums\Schema.thinkingBudgetand Gemini 3 usesthinkingLevel.$clientand$fake, used$responsefor$result, and used the deprecatedgeminiPro().Verification
php -l, and all internal links resolve.ClientFake.While running the examples,
gemini-2.5-flashwith a per-part media resolution returned usage metadata withouttotalTokenCount, which crashed the client; that is fixed separately in #191.