Skip to content

.Net: fix Tavily pagination and image handling; add search options - #14670

Draft
Mani (manisrinivasan2k1) wants to merge 8 commits into
microsoft:mainfrom
manisrinivasan2k1:feat/tavily-search-skip-limits-images
Draft

Mani (manisrinivasan2k1) wants to merge 8 commits into
microsoft:mainfrom
manisrinivasan2k1:feat/tavily-search-skip-limits-images

Conversation

@manisrinivasan2k1

@manisrinivasan2k1 Mani (manisrinivasan2k1) commented Oct 27, 2026 •

Copy link
Copy Markdown

Summary

Fixes in TavilyTextSearch:

  • Skip: max_results was computed as top - skip, so Skip never skipped anything and Top == Skip sent max_results: 0. Tavily has no offset parameter, so the connector now requests top + skip results (capped at Tavily's maximum of 20) and drops the first skip client-side. Skip values that push past the 20-result window return fewer than Top results.
  • Request window: the outgoing max_results is capped at Tavily's maximum of 20 (computed with overflow-safe arithmetic); the accepted Top range is unchanged.
  • Image response parsing: accepts both plain URL strings and objects with descriptions. A live call with images enabled previously threw at $.images[0]; the parser now handles that response without changing public options.
  • Images: IncludeImages ?? false && Images is not null parsed as IncludeImages ?? (false && …); with IncludeImages = true and no images in the response the enumerators threw. The condition is now parenthesized.
  • Search options: adds the fast and ultra-fast search depths (TavilySearchDepth.Fast / UltraFast, appended so existing values are unchanged) and optional Country, StartDate, EndDate, SafeSearch, IncludeDomainsMode, Language, FilterByLanguage, ExactMatch and AutoParameters options. They are sent only when set (IncludeDomainsMode only when the request has include domains). Corrects the chunks_per_source doc comment (1–3).
  • Client name: requests now carry X-Client-Name: semantic-kernel (added per request; not added when the caller's HttpClient already sets that header). The existing User-Agent, Authorization and request bodies are unchanged.

Defaults, result shapes and exception types are unchanged; the days filter is left as is.

Validation

  • The focused Tavily suite passes 60/60 tests at 99aeaf8, including URL-string images, existing object descriptions, malformed objects, pagination, options and attribution. The earlier baseline run had 9 failures in 44 tests against the unmodified source; the new image defect was separately reproduced twice against the live API before its fix.
  • Ten bounded real Search API requests through TavilyTextSearch: eight original cases, one image-shape diagnostic and one final image retest. Default search, same-response Top/Skip slicing, include-domain restriction, added option serialization and invalid-key 401 handling passed. Country with ultra-fast returns the API's expected 400; its option comment now documents the limitation.
  • The image retest at the final head returned eight items from a response containing plain URL strings without throwing; existing object descriptions are covered by fixtures. The other live cases ran before the isolated image-parser correction and were not repeated after it. Ten synthetic HTTP harness checks also pass.
  • Outbound X-Client-Name: semantic-kernel was observed. No server analytics ingestion or real-model agent test is claimed. API acceptance of date/language flags does not prove their semantic filtering accuracy.

Behavior notes

  • The accepted Top range is unchanged (1–50). Only the outgoing max_results is capped at 20, so Top values above 20 now return at most 20 results; previously the larger value was sent to the API.
  • Not added: favicon, usage and the include_answer basic/advanced modes. IncludeAnswer keeps its existing type.

🤖 Generated with Claude Code

- Apply Skip client-side: request top + skip results (capped at the
  Tavily max_results ceiling of 20) and drop the first skip results,
  instead of sending max_results = top - skip.
- Validate Top against the Tavily maximum of 20 instead of 50.
- Parenthesize IncludeImages checks so a missing images array no
  longer throws when IncludeImages is true.
- Add Fast and UltraFast search depths (serialized as "fast" and
  "ultra-fast") and a Country option.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
- Keep the accepted Top range (1-50) unchanged; cap only the outgoing
  max_results request window at 20 using overflow-safe arithmetic.
- Make the skip window tests internally consistent.
- Remove the contradictory ChunksPerSource availability comment.
- Add StartDate, EndDate, SafeSearch and IncludeDomainsMode options,
  serialized only when set.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@semantic-kernel-automation semantic-kernel-automation Bot added the .NET Issue or Pull requests regarding .NET code label Oct 27, 2026
@github-actions github-actions Bot changed the title .NET: fix Tavily pagination and image handling; add search options .Net: fix Tavily pagination and image handling; add search options Oct 27, 2026
Adds a per-request X-Client-Name header unless the caller's HttpClient
already sets one. User-Agent, Authorization, request bodies and results
are unchanged.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…nduplicated

HttpClient merges DefaultRequestHeaders into the request before the handler
sees it, so the captured request carries the caller's single value.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…ters search options

Additive nullable options serialized only when set (explicit false is sent).
Existing property types, defaults and request bodies are unchanged.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…epths

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
When image descriptions are not requested Tavily returns images as URL strings,
which the url+description image model could not deserialize. A converter now
reads either form; the object form keeps its required url and description.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…scription

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@microsoft-github-policy-service

Copy link
Copy Markdown

Mani (@manisrinivasan2k1) 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.

This branch was successfully deployed

1 active deployment
github-app-auth — 99aeaf86 Deployed Oct 27, 2026 by manisrinivasan2k1 via add_label #29473
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

.NET Issue or Pull requests regarding .NET code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant