Skip to content

Python: feat(python): add close() and async context manager to embedding clients - #9895

Open
Lushiyao5 wants to merge 1 commit into
microsoft:mainfrom
Lushiyao5:feat/embedding-client-lifecycle
Open

Lushiyao5 wants to merge 1 commit into
microsoft:mainfrom
Lushiyao5:feat/embedding-client-lifecycle

Conversation

@Lushiyao5

Copy link
Copy Markdown

Closes #9814

Embedding clients were left out of the deterministic lifecycle that #9748 gave chat clients: BaseEmbeddingClient had no __aenter__/__aexit__/close(), so async with did not work for any embedding client, and internally created SDK clients (OpenAI httpx connection pools, Ollama httpx transports) were only ever released by GC.

Change

  • BaseEmbeddingClient (core): async context manager plus a no-op close() default, mirroring BaseChatClient — entering the context is never required for ordinary requests, and resource-owning implementations override close().
  • OpenAIEmbeddingClient: tracks _owns_client = async_client is None; close() awaits client.close() only when the SDK client was created internally (via load_openai_service_settings), covering both the OpenAI and Azure paths.
  • OllamaEmbeddingClient: the same ownership pattern; close() awaits AsyncClient.aclose().

Caller-supplied clients always stay open — their lifecycle belongs to the caller. GeminiEmbeddingClient already implemented this pattern and is untouched. Bedrock's boto3 runtime client has no close() surface, so it keeps the base no-op.

Tests

  • core (test_embedding_client.py): the async context manager protocol works on the base and the default close() is a no-op;
  • openai (test_openai_embedding_client.py): close() releases an internally created client and leaves a caller-supplied one unawaited;
  • ollama suite passes unchanged with the ownership tracking in place.

Embedding clients were left out of the deterministic lifecycle that microsoft#9748
gave chat clients: BaseEmbeddingClient had no __aenter__/__aexit__/close(),
so 'async with' did not work and internally created SDK clients (OpenAI
httpx pools, Ollama httpx transports) were only released by GC. This aligns
the embedding family with the chat clients and with the existing
GeminiEmbeddingClient.close()/_owns_client pattern.

- BaseEmbeddingClient: async context manager and a no-op close() default,
  mirroring BaseChatClient.
- OpenAI embedding client: track _owns_client; close() awaits
  client.close() only when the SDK client was created internally.
- Ollama embedding client: same ownership pattern via AsyncClient.aclose().

Caller-supplied clients always stay open: their lifecycle belongs to the
caller. Bedrock's boto3 client has no close() to call and keeps its
default no-op.

Closes microsoft#9814
Copilot AI balanced review requested due to automatic review settings October 30, 2026 17:23
@agent-framework-automation agent-framework-automation Bot added the python Usage: [Issues, PRs], Target: Python label Oct 30, 2026
@github-actions github-actions Bot changed the title feat(python): add close() and async context manager to embedding clients Python: feat(python): add close() and async context manager to embedding clients Oct 30, 2026
@microsoft-github-policy-service

Copy link
Copy Markdown

Lushiyao5 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

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

Internally created Ollama clients raise AttributeError during cleanup because AsyncClient has no close() method, leaving the HTTP transport open.

1 open issue
What changed in this PR

Extends the Python chat-client lifecycle pattern to embedding clients, adding optional context management and ownership-aware cleanup to address #9814.

Changes:

  • Adds async context management and a default no-op close() to BaseEmbeddingClient.
  • Adds ownership tracking and cleanup methods to OpenAI and Ollama embedding clients.
  • Adds tests for the base lifecycle and OpenAI client ownership.
File Description
python/​packages/​openai/​tests/​openai/​test_openai_embedding_client.py Tests cleanup of owned clients and preservation of caller-supplied clients.
python/​packages/​openai/​agent_framework_openai/​_embedding_client.py Adds ownership-aware OpenAI SDK cleanup.
python/​packages/​ollama/​agent_framework_ollama/​_embedding_client.py Adds ownership tracking and a cleanup override.
python/​packages/​core/​tests/​core/​test_embedding_client.py Tests context entry and default no-op cleanup.
python/​packages/​core/​agent_framework/​_clients.py Defines the shared embedding-client lifecycle methods.

Review effort: Balanced

A caller-supplied ``client`` stays open: its lifecycle belongs to the caller.
"""
if self._owns_client:
await self.client.close()

This branch was previously deployed

1 inactive deployment
github-app-auth — 8664a6b1 Deployed Oct 30, 2026 by Lushiyao5 via add_label #26719
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python: Embedding clients have no close()/context manager and leak their internally created SDK clients

2 participants