Skip to content

docs(redis): pass instruction= in the Quick Start agent - #8249

Open
prassu017 wants to merge 1 commit into
google:mainfrom
prassu017:fix-8247-redis-readme-instruction
Open

prassu017 wants to merge 1 commit into
google:mainfrom
prassu017:fix-8247-redis-readme-instruction

Conversation

@prassu017

Copy link
Copy Markdown

Link to Issue or Description of Change

1. Link to an existing issue (if applicable):

Problem:
The Quick Start in src/google/adk/integrations/redis/README.md builds the agent with instructions= (plural). LlmAgent forbids extra fields, so copying the snippet fails with ValidationError: ... instructions Extra inputs are not permitted.

Solution:
Use the real field name, instruction=. One-line docs change.

Testing Plan

Small documentation fix, so no unit tests were added.

Manual End-to-End (E2E) Tests:

Extracted the Quick Start block from the README on main (1997a12) and ran it with google-adk==2.14.1 and redis installed (Python 3.13, no Redis server needed since nothing connects at construction):

  • Before: pydantic_core._pydantic_core.ValidationError: 1 validation error for LlmAgent / instructions / Extra inputs are not permitted
  • After: the snippet runs to the end (Agent, RedisSessionService and Runner all construct).

LlmAgent on main still declares only instruction: str | InstructionProvider. No other code or docs changed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(redis): Quick Start snippet in src/google/adk/integrations/redis/README.md passes invalid Agent(instructions=...) kwarg

2 participants