Skip to content

Python: Align Redis context sample guide with current APIs - #9446

Merged
Eduard van Valkenburg (eavanvalkenburg) merged 3 commits into
microsoft:mainfrom
ktz03:docs/redis-context-guide-current-api
Oct 26, 2026
Merged

Eduard van Valkenburg (eavanvalkenburg) merged 3 commits into
microsoft:mainfrom
ktz03:docs/redis-context-guide-current-api

Conversation

@ktz03

Copy link
Copy Markdown
Contributor

Motivation & Context

The Redis context-provider sample guide still documents removed configuration names and the old invoking hook. Its optional OpenAI-key instructions also conflict with examples that instantiate OpenAITextVectorizer.

Description & Review Guide

  • What are the major changes? Align one sample README with redis_vectorizer, overwrite_index, the before_run/after_run hooks, and the existing examples' embedding prerequisites. Distinguish context retrieval from complete conversation-history persistence.
  • What is the impact of these changes? Documentation only. Full-text and hybrid constructor/schema configurations were checked locally, together with the eight constructor calls in the three unchanged context samples. Live Redis, OpenAI/Foundry calls and the full sample suite were not run.
  • What do you want reviewers to focus on? Whether the configuration and setup instructions accurately match the existing provider and examples.

Related Issue

N/A - trivial change: correct stale API names and setup instructions in one README; no runtime or public API changes.

AI Assistance

  • No material AI assistance was used.
  • This is an AI-assisted contribution. I reviewed, understood, and verified all submitted content and accept responsibility for it.

AI assistance details: Documentation, API checks, and PR description.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR links to an agreed issue with no competing open PR, or the Related Issue section documents a trivial-change or repository-automation exception.
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" in the title prefix).

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The prerequisites still omit an embedding-dependent scenario, leaving readers without setup instructions needed to run it.

2 open findings
What changed in this PR

Updates the Redis context-provider sample guide to match current APIs and embedding requirements. No runtime code changes.

Changes:

  • Replaces obsolete configuration names and lifecycle hooks.
  • Clarifies OpenAI embedding prerequisites.
  • Distinguishes context retrieval from complete conversation-history persistence.
File Description
python/​samples/​02-agents/​context_providers/​redis/​README.md Updates API guidance, setup requirements, and sample descriptions.

🧠 Review effort: Balanced


💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread python/samples/02-agents/context_providers/redis/README.md Outdated
Comment thread python/samples/02-agents/context_providers/redis/README.md Outdated
@eavanvalkenburg

Copy link
Copy Markdown
Member

LI (@ktz03), the setup still installs only agent-framework-redis, but all three context samples import FoundryChatClient, which requires the separate agent-framework-foundry distribution. Neither Redis nor its core dependency installs that connector, so following this guide in a fresh environment fails at import before reaching the corrected configuration. Please include agent-framework-foundry in the installation command.

@ktz03

Copy link
Copy Markdown
Contributor Author

Added agent-framework-foundry to the Redis sample installation command in fc9b861. The three context samples import FoundryChatClient from that separate connector.

Merged via the queue into microsoft:main with commit 1c19834 Oct 26, 2026
48 checks passed

This branch was previously deployed

1 inactive deployment
github-app-auth — fc9b861d Deployed Oct 26, 2026 by ktz03 via add_label #26175
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants