Skip to content

docs: add TavilyWebSearch component page and external integration entry#10954

Merged
anakin87 merged 17 commits intodeepset-ai:mainfrom
SyedShahmeerAli12:feat/add-tavily-docs
Mar 30, 2026
Merged

docs: add TavilyWebSearch component page and external integration entry#10954
anakin87 merged 17 commits intodeepset-ai:mainfrom
SyedShahmeerAli12:feat/add-tavily-docs

Conversation

@SyedShahmeerAli12
Copy link
Copy Markdown
Contributor

Adds documentation for the TavilyWebSearch component from the tavily-haystack package:

  • New page: docs/pipeline-components/websearch/tavilywebsearch.mdx
  • Added Tavily row to external-integrations-websearch.mdx

Part of deepset-ai/haystack-core-integrations#2961

@SyedShahmeerAli12 SyedShahmeerAli12 requested a review from a team as a code owner March 27, 2026 11:37
@SyedShahmeerAli12 SyedShahmeerAli12 requested review from julian-risch and removed request for a team March 27, 2026 11:37
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 27, 2026

@SyedShahmeerAli12 is attempting to deploy a commit to the deepset Team on Vercel.

A member of the Team first needs to authorize it.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 27, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Mar 30, 2026 2:06pm

Request Review

Copy link
Copy Markdown
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

I left some comments. In addition, please

  • copy the same files to docs-website/versioned_docs/version-2.26 (stable version)
  • add the link to docs-website/sidebars.js and docs-website/versioned_sidebars/version-2.26-sidebars.json

| [Exa](https://haystack.deepset.ai/integrations/exa) | Search the web with Exa's AI-powered search, get content, answers, and conduct deep research. |
| [Serpex](https://haystack.deepset.ai/integrations/serpex) | Multi-engine web search for Haystack — access Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex via Serpex API. | No newline at end of file
| [Serpex](https://haystack.deepset.ai/integrations/serpex) | Multi-engine web search for Haystack — access Google, Bing, DuckDuckGo, Brave, Yahoo, and Yandex via Serpex API. |
| [Tavily](https://haystack.deepset.ai/integrations/tavily) | Search the web using Tavily's AI-powered search API, optimized for LLM applications. | No newline at end of file
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

remove this row, since it is for integrations not maintained by us.

Instead, please add it to docs-website/docs/pipeline-components/websearch.mdx


| | |
| --- | --- |
| **Most common position in a pipeline** | Before a [`ChatPromptBuilder`](../builders/chatpromptbuilder.mdx) or [`LinkContentFetcher`](../fetchers/linkcontentfetcher.mdx) |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
| **Most common position in a pipeline** | Before a [`ChatPromptBuilder`](../builders/chatpromptbuilder.mdx) or [`LinkContentFetcher`](../fetchers/linkcontentfetcher.mdx) |
| **Most common position in a pipeline** | Before a [`ChatPromptBuilder`](../builders/chatpromptbuilder.mdx) or right at the beginning of an indexing pipeline. |

I'd say it is not compatible with the fetcher


llm = OpenAIChatGenerator(
api_key=Secret.from_env_var("OPENAI_API_KEY"),
model="gpt-4o-mini",
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
model="gpt-4o-mini",

if we avoid mentioning the specific model, we avoid future maintenance efforts


result = pipe.run(data={"search": {"query": query}, "prompt_builder": {"query": query}})

print(result["llm"]["replies"][0].content)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
print(result["llm"]["replies"][0].content)
print(result["llm"]["replies"][0].text)

text is the right field. content has been previously removed.

pandego and others added 14 commits March 30, 2026 16:36
…mentsAsyncTest` (deepset-ai#10948)

* fix: address deepset-ai#10917

* removing lazyimport + solving MRO conflict

---------

Co-authored-by: David S. Batista <[email protected]>
* fix: address deepset-ai#10919

* adding delete_all_documents_async missing in InMemoryDocumentStore

---------

Co-authored-by: David S. Batista <[email protected]>
…ountUniqueMetadataByFilterAsyncTest` (deepset-ai#10953)

* fix: address deepset-ai#10920

* formatting

---------

Co-authored-by: David S. Batista <[email protected]>
* fixing docs syntax errors

* fixing a few more docs syntax errors
…oryDocumentStore async operations and tests (deepset-ai#10963)

* adding get_metadata async related Mixin tests

* adding get_metadata async methods to the InMemoryDocumentStore

* using Mixin async metadata tests to InMemoryDocumentstore tests

* adding release notes

* double ticks in release notes

* Update haystack/testing/document_store_async.py

Co-authored-by: Stefano Fiorucci <[email protected]>

---------

Co-authored-by: Stefano Fiorucci <[email protected]>
- Fix pipeline position description (remove LinkContentFetcher reference)
- Remove hardcoded model name to avoid future maintenance
- Fix .content -> .text (field was removed)
- Move Tavily entry from external-integrations-websearch.mdx to websearch.mdx
- Copy tavilywebsearch.mdx to versioned_docs/version-2.26
- Add tavilywebsearch to sidebars.js and version-2.26-sidebars.json

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
@SyedShahmeerAli12
Copy link
Copy Markdown
Contributor Author

▎ Hi @anakin87, thanks for the review! I've addressed all your comments:

  • Moved Tavily entry from external-integrations-websearch.mdx to websearch.mdx
  • Fixed the pipeline position description (removed LinkContentFetcher reference)
  • Removed the hardcoded gpt-4o-mini model name
  • Fixed .content → .text
  • Copied files to versioned_docs/version-2.26/ and updated both sidebars

Should the tavilywebsearch.mdx page also be linked from the https://haystack.deepset.ai/integrations/tavily on the Haystack website, or is that handled separately?

Copy link
Copy Markdown
Member

@anakin87 anakin87 left a comment

Choose a reason for hiding this comment

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

Looks good

@anakin87 anakin87 merged commit 93a986b into deepset-ai:main Mar 30, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants