尧图网站建设 
Haystack BraveWebSearch 组件详解使用 Brave Search API 构建联网 RAG 与网页检索管线【免费下载链接】haystackOpen-source AI orchestration framework for building context-engineered, production-ready LLM applications. Design modular pipelines and agent workflows with explicit control over retrieval, routing, memory, and generation. Built for scalable agents, RAG, multimodal applications, semantic search, and conversational systems.项目地址: https://gitcode.com/GitHub_Trending/ha/haystackBraveWebSearch 是 Haystack 生态中的网页搜索组件它通过 Brave Search API 将网络搜索能力封装为 Haystack 标准组件把搜索结果转换为 HaystackDocument对象与 URL 列表。本指南完整讲解该组件的初始化参数、同步/异步调用方法、独立使用方式以及在 RAG 管线中与ChatPromptBuilder、OpenAIChatGenerator串联的完整实战方案帮助你基于独立搜索引擎快速搭建检索-增强-生成链路。组件定位与关键信息速览Brave Search 是拥有独立网络索引的搜索引擎其 API 不依赖 Google 或 Bing适合需要可靠且注重隐私的网页结果来源的 RAG 场景。BraveWebSearch正是 Haystack 对其 API 的官方封装属于haystack-core-integrations生态中的brave-haystack包。项目说明最常用管线位置位于ChatPromptBuilder之前或索引管线indexing pipeline的最前端必填初始化变量api_keyBrave Search API 密钥可通过BRAVE_API_KEY环境变量设置必填运行变量query搜索查询字符串输出变量documents包含搜索内容与元数据的 HaystackDocument列表links结果 URL 字符串列表API 参考Brave Search API 参考软件包名brave-haystack该组件的详细介绍可参见组件文档 bravewebsearch.mdx组件索引见 websearch.mdxHaystack Enterprise Platform 也已将 BraveWebSearch 列为可用组件。安装与 API 密钥准备使用BraveWebSearch前需要完成两件事注册 Brave Search API 并获取密钥在 Brave 官网的 Search API 页面申请 API key本组件文档明确要求持有该密钥才能工作见 brave.md。安装集成包并配置密钥安装brave-haystack集成包后通过环境变量或初始化参数传入密钥。组件默认从BRAVE_API_KEY环境变量读取密钥也可以直接在初始化时通过Secret对象显式传入例如Secret.from_env_var(BRAVE_API_KEY)。使用Secret统一管理密钥是 Haystack 的标准做法避免在代码或日志中明文暴露凭据。初始化参数全解BraveWebSearch.__init__的完整签名如下__init__( api_key: Secret Secret.from_env_var(BRAVE_API_KEY), top_k: int | None 10, country: str | None None, search_lang: str | None None, extra_params: dict[str, Any] | None None, timeout: int 10, max_retries: int 3, ) - None各参数含义与注意事项参数类型默认值说明api_keySecretSecret.from_env_var(BRAVE_API_KEY)Brave Search API 密钥默认从BRAVE_API_KEY环境变量读取top_kint \| None10返回的最大结果数直接映射到 Brave API 的count参数countrystr \| NoneNone两位国家代码用于偏置搜索结果例如US、DEsearch_langstr \| NoneNone搜索结果的语言代码例如en、deextra_paramsdict[str, Any] \| NoneNone额外查询参数会原样透传给 Brave Search API用于按需定制请求timeoutint10HTTP 请求超时时间秒max_retriesint3对瞬时失败的最大重试次数其中值得深入说明的三点top_k与count的映射关系初始化时的top_k并不是最终硬编码值而是作为默认上限同时映射为 Brave API 请求中的count参数。这意味着你可以在初始化时设定全局上限再在单次运行时按需覆盖详见下文run方法。extra_params的透传机制该字典中的键值会被直接附加到 Brave Search API 的查询参数中。从源码结构看这是组件为覆盖 Brave API 更多可选能力如新鲜度、站点过滤等高级参数预留的通用扩展口可结合 brave.md 中的参数文档与 Brave API 官方文档对照使用。容错配置timeout10与max_retries3为网络请求提供了基础的稳定性保障适合在真实网络环境下直接使用无需额外包装重试逻辑。run 与 run_async调用方法详解组件提供同步与异步两种调用方式签名一致run(query: str, top_k: int | None None) - dict[str, Any] run_async(query: str, top_k: int | None None) - dict[str, Any]参数querystr搜索查询字符串为必填项top_kint | None可选单次运行时的结果数覆盖值若不传则使用初始化时的top_k。返回值dict[str, Any]documentsDocument列表每个Document承载一条搜索结果的内容与元数据links结果 URL 的字符串列表便于快速拿到原始来源链接。run_async适用于异步管线场景两者返回结构完全一致因此同一套下游消费逻辑如遍历documents或读取links可以复用。这与 Haystack 近年来逐步为各类组件补齐异步能力的整体方向一致可在 websearch 组件索引 中对比其他同类组件的 API 形态。独立使用示例单独使用BraveWebSearch完成一次网页搜索并消费结果from haystack_integrations.components.websearch.brave import BraveWebSearch from haystack.utils import Secret web_search BraveWebSearch( api_keySecret.from_env_var(BRAVE_API_KEY), top_k5, ) query What is Haystack by deepset? response web_search.run(queryquery) for doc in response[documents]: print(doc.content)运行后response[documents]是 5 条受top_k5限制包含搜索摘要内容的Document对象response[links]则是对应的原始 URL 列表documents response[documents] links response[links]这种内容 链接的双输出设计既方便直接对documents做向量化或拼接也方便单独追踪引用来源。在 RAG 管线中集成BraveWebSearch最常见的实战用法是作为 RAG 管线的检索起点先联网搜索再把结果拼进 Prompt最后交给 LLM 生成回答。完整示例from haystack import Pipeline from haystack.utils import Secret from haystack.components.builders.chat_prompt_builder import ChatPromptBuilder from haystack.components.generators.chat import OpenAIChatGenerator from haystack_integrations.components.websearch.brave import BraveWebSearch from haystack.dataclasses import ChatMessage web_search BraveWebSearch( api_keySecret.from_env_var(BRAVE_API_KEY), top_k3, ) prompt_template [ ChatMessage.from_system(You are a helpful assistant.), ChatMessage.from_user( Given the information below:\n {% for document in documents %}{{ document.content }}\n{% endfor %}\n Answer the following question: {{ query }}.\nAnswer:, ), ] prompt_builder ChatPromptBuilder( templateprompt_template, required_variables{query, documents}, ) llm OpenAIChatGenerator( api_keySecret.from_env_var(OPENAI_API_KEY), ) pipe Pipeline() pipe.add_component(search, web_search) pipe.add_component(prompt_builder, prompt_builder) pipe.add_component(llm, llm) pipe.connect(search.documents, prompt_builder.documents) pipe.connect(prompt_builder.prompt, llm.messages) query What is Haystack by deepset? result pipe.run( data{ search: {query: query}, prompt_builder: {query: query}, } ) print(result[llm][replies][0].text)这段代码展示的链路可以拆解为三个环节检索search组件BraveWebSearch接收query联网搜索并把结果以documents输出组装prompt_builderChatPromptBuilder通过 Jinja 模板{% for document in documents %}将搜索结果逐条拼入用户消息required_variables{query, documents}声明了模板必需的两个变量生成llmOpenAIChatGenerator基于带检索上下文的 Prompt 生成最终回答。注意pipe.run()的入参结构search需要queryprompt_builder也需要query用于模板中的{{ query }}因此两个组件的输入要分别给出。这是 Haystack 管线中同一变量供给多个组件的典型写法。在 Haystack 网页搜索组件家族中的定位BraveWebSearch只是 Haystack 网页搜索能力的一种实现。在 websearch 组件索引 中Haystack 还提供了DDGSWebSearch免 API key 的多引擎搜索、FirecrawlWebSearch、LinkupWebSearch、PerplexityWebSearch、SearchApiWebSearch、SerperDevWebSearch、TavilyWebSearch、YouComWebSearch等多个选择而 external-integrations-websearch.mdx 还列出了 DuckDuckGo、Exa、Serpex 等外部集成。相较之下BraveWebSearch的核心差异点在于依赖独立索引、需持有 Brave API key适合对搜索来源独立性、隐私性有要求的 RAG 或语义搜索应用。选择哪一款应根据是否愿意申请密钥、是否需要多引擎聚合、以及对检索质量与成本的权衡来决定。实用建议与注意事项密钥管理优先使用BRAVE_API_KEY环境变量 Secret.from_env_var避免把密钥硬编码进代码仓库Secret对象由 Haystack 工具模块 提供统一管理。结果数量控制初始化top_k设默认上限单次运行用run(query, top_kn)覆盖灵活控制每次搜索的成本与上下文长度。地域与语言偏置面向特定国家/语言用户的应用建议设置country与search_lang提升结果相关性需要更细粒度控制时使用extra_params透传 Brave API 高级参数。稳定性配置保持timeout10、max_retries3的默认值可在多数场景下获得良好的健壮性对网络波动敏感的高并发场景可酌情调整。异步场景在异步管线中使用run_async而非自行包装run返回值结构相同便于与AsyncPipeline协同。作为索引管线入口除 RAG 外也可把BraveWebSearch放在索引管线最前端将搜索结果转成Document后继续做清洗、切分、向量化入库实现增量式网络内容采集。通过本文的配置参数详解、独立调用与 RAG 管线集成示例你已经可以基于BraveWebSearch快速搭建联网问答、语义搜索或网络内容索引应用更完整的 API 细节可随时查阅 Brave Search API 参考 与 组件使用文档。【免费下载链接】haystackOpen-source AI orchestration framework for building context-engineered, production-ready LLM applications. Design modular pipelines and agent workflows with explicit control over retrieval, routing, memory, and generation. Built for scalable agents, RAG, multimodal applications, semantic search, and conversational systems.项目地址: https://gitcode.com/GitHub_Trending/ha/haystack创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Haystack BraveWebSearch 组件详解：使用 Brave Search API 构建联网 RAG 与网页检索管线
Haystack BraveWebSearch 组件详解使用 Brave Search API 构建联网 RAG 与网页检索管线【免费下载链接】haystackOpen-source AI orchestration framework for building context-engineered, production-ready LLM applications. Design modular pipelines and agent workflows with explicit control over retrieval, routing, memory, and generation. Built for scalable agents, RAG, multimodal applications, semantic search, and conversational systems.项目地址: https://gitcode.com/GitHub_Trending/ha/haystackBraveWebSearch 是 Haystack 生态中的网页搜索组件它通过 Brave Search API 将网络搜索能力封装为 Haystack 标准组件把搜索结果转换为 HaystackDocument对象与 URL 列表。本指南完整讲解该组件的初始化参数、同步/异步调用方法、独立使用方式以及在 RAG 管线中与ChatPromptBuilder、OpenAIChatGenerator串联的完整实战方案帮助你基于独立搜索引擎快速搭建检索-增强-生成链路。组件定位与关键信息速览Brave Search 是拥有独立网络索引的搜索引擎其 API 不依赖 Google 或 Bing适合需要可靠且注重隐私的网页结果来源的 RAG 场景。BraveWebSearch正是 Haystack 对其 API 的官方封装属于haystack-core-integrations生态中的brave-haystack包。项目说明最常用管线位置位于ChatPromptBuilder之前或索引管线indexing pipeline的最前端必填初始化变量api_keyBrave Search API 密钥可通过BRAVE_API_KEY环境变量设置必填运行变量query搜索查询字符串输出变量documents包含搜索内容与元数据的 HaystackDocument列表links结果 URL 字符串列表API 参考Brave Search API 参考软件包名brave-haystack该组件的详细介绍可参见组件文档 bravewebsearch.mdx组件索引见 websearch.mdxHaystack Enterprise Platform 也已将 BraveWebSearch 列为可用组件。安装与 API 密钥准备使用BraveWebSearch前需要完成两件事注册 Brave Search API 并获取密钥在 Brave 官网的 Search API 页面申请 API key本组件文档明确要求持有该密钥才能工作见 brave.md。安装集成包并配置密钥安装brave-haystack集成包后通过环境变量或初始化参数传入密钥。组件默认从BRAVE_API_KEY环境变量读取密钥也可以直接在初始化时通过Secret对象显式传入例如Secret.from_env_var(BRAVE_API_KEY)。使用Secret统一管理密钥是 Haystack 的标准做法避免在代码或日志中明文暴露凭据。初始化参数全解BraveWebSearch.__init__的完整签名如下__init__( api_key: Secret Secret.from_env_var(BRAVE_API_KEY), top_k: int | None 10, country: str | None None, search_lang: str | None None, extra_params: dict[str, Any] | None None, timeout: int 10, max_retries: int 3, ) - None各参数含义与注意事项参数类型默认值说明api_keySecretSecret.from_env_var(BRAVE_API_KEY)Brave Search API 密钥默认从BRAVE_API_KEY环境变量读取top_kint \| None10返回的最大结果数直接映射到 Brave API 的count参数countrystr \| NoneNone两位国家代码用于偏置搜索结果例如US、DEsearch_langstr \| NoneNone搜索结果的语言代码例如en、deextra_paramsdict[str, Any] \| NoneNone额外查询参数会原样透传给 Brave Search API用于按需定制请求timeoutint10HTTP 请求超时时间秒max_retriesint3对瞬时失败的最大重试次数其中值得深入说明的三点top_k与count的映射关系初始化时的top_k并不是最终硬编码值而是作为默认上限同时映射为 Brave API 请求中的count参数。这意味着你可以在初始化时设定全局上限再在单次运行时按需覆盖详见下文run方法。extra_params的透传机制该字典中的键值会被直接附加到 Brave Search API 的查询参数中。从源码结构看这是组件为覆盖 Brave API 更多可选能力如新鲜度、站点过滤等高级参数预留的通用扩展口可结合 brave.md 中的参数文档与 Brave API 官方文档对照使用。容错配置timeout10与max_retries3为网络请求提供了基础的稳定性保障适合在真实网络环境下直接使用无需额外包装重试逻辑。run 与 run_async调用方法详解组件提供同步与异步两种调用方式签名一致run(query: str, top_k: int | None None) - dict[str, Any] run_async(query: str, top_k: int | None None) - dict[str, Any]参数querystr搜索查询字符串为必填项top_kint | None可选单次运行时的结果数覆盖值若不传则使用初始化时的top_k。返回值dict[str, Any]documentsDocument列表每个Document承载一条搜索结果的内容与元数据links结果 URL 的字符串列表便于快速拿到原始来源链接。run_async适用于异步管线场景两者返回结构完全一致因此同一套下游消费逻辑如遍历documents或读取links可以复用。这与 Haystack 近年来逐步为各类组件补齐异步能力的整体方向一致可在 websearch 组件索引 中对比其他同类组件的 API 形态。独立使用示例单独使用BraveWebSearch完成一次网页搜索并消费结果from haystack_integrations.components.websearch.brave import BraveWebSearch from haystack.utils import Secret web_search BraveWebSearch( api_keySecret.from_env_var(BRAVE_API_KEY), top_k5, ) query What is Haystack by deepset? response web_search.run(queryquery) for doc in response[documents]: print(doc.content)运行后response[documents]是 5 条受top_k5限制包含搜索摘要内容的Document对象response[links]则是对应的原始 URL 列表documents response[documents] links response[links]这种内容 链接的双输出设计既方便直接对documents做向量化或拼接也方便单独追踪引用来源。在 RAG 管线中集成BraveWebSearch最常见的实战用法是作为 RAG 管线的检索起点先联网搜索再把结果拼进 Prompt最后交给 LLM 生成回答。完整示例from haystack import Pipeline from haystack.utils import Secret from haystack.components.builders.chat_prompt_builder import ChatPromptBuilder from haystack.components.generators.chat import OpenAIChatGenerator from haystack_integrations.components.websearch.brave import BraveWebSearch from haystack.dataclasses import ChatMessage web_search BraveWebSearch( api_keySecret.from_env_var(BRAVE_API_KEY), top_k3, ) prompt_template [ ChatMessage.from_system(You are a helpful assistant.), ChatMessage.from_user( Given the information below:\n {% for document in documents %}{{ document.content }}\n{% endfor %}\n Answer the following question: {{ query }}.\nAnswer:, ), ] prompt_builder ChatPromptBuilder( templateprompt_template, required_variables{query, documents}, ) llm OpenAIChatGenerator( api_keySecret.from_env_var(OPENAI_API_KEY), ) pipe Pipeline() pipe.add_component(search, web_search) pipe.add_component(prompt_builder, prompt_builder) pipe.add_component(llm, llm) pipe.connect(search.documents, prompt_builder.documents) pipe.connect(prompt_builder.prompt, llm.messages) query What is Haystack by deepset? result pipe.run( data{ search: {query: query}, prompt_builder: {query: query}, } ) print(result[llm][replies][0].text)这段代码展示的链路可以拆解为三个环节检索search组件BraveWebSearch接收query联网搜索并把结果以documents输出组装prompt_builderChatPromptBuilder通过 Jinja 模板{% for document in documents %}将搜索结果逐条拼入用户消息required_variables{query, documents}声明了模板必需的两个变量生成llmOpenAIChatGenerator基于带检索上下文的 Prompt 生成最终回答。注意pipe.run()的入参结构search需要queryprompt_builder也需要query用于模板中的{{ query }}因此两个组件的输入要分别给出。这是 Haystack 管线中同一变量供给多个组件的典型写法。在 Haystack 网页搜索组件家族中的定位BraveWebSearch只是 Haystack 网页搜索能力的一种实现。在 websearch 组件索引 中Haystack 还提供了DDGSWebSearch免 API key 的多引擎搜索、FirecrawlWebSearch、LinkupWebSearch、PerplexityWebSearch、SearchApiWebSearch、SerperDevWebSearch、TavilyWebSearch、YouComWebSearch等多个选择而 external-integrations-websearch.mdx 还列出了 DuckDuckGo、Exa、Serpex 等外部集成。相较之下BraveWebSearch的核心差异点在于依赖独立索引、需持有 Brave API key适合对搜索来源独立性、隐私性有要求的 RAG 或语义搜索应用。选择哪一款应根据是否愿意申请密钥、是否需要多引擎聚合、以及对检索质量与成本的权衡来决定。实用建议与注意事项密钥管理优先使用BRAVE_API_KEY环境变量 Secret.from_env_var避免把密钥硬编码进代码仓库Secret对象由 Haystack 工具模块 提供统一管理。结果数量控制初始化top_k设默认上限单次运行用run(query, top_kn)覆盖灵活控制每次搜索的成本与上下文长度。地域与语言偏置面向特定国家/语言用户的应用建议设置country与search_lang提升结果相关性需要更细粒度控制时使用extra_params透传 Brave API 高级参数。稳定性配置保持timeout10、max_retries3的默认值可在多数场景下获得良好的健壮性对网络波动敏感的高并发场景可酌情调整。异步场景在异步管线中使用run_async而非自行包装run返回值结构相同便于与AsyncPipeline协同。作为索引管线入口除 RAG 外也可把BraveWebSearch放在索引管线最前端将搜索结果转成Document后继续做清洗、切分、向量化入库实现增量式网络内容采集。通过本文的配置参数详解、独立调用与 RAG 管线集成示例你已经可以基于BraveWebSearch快速搭建联网问答、语义搜索或网络内容索引应用更完整的 API 细节可随时查阅 Brave Search API 参考 与 组件使用文档。【免费下载链接】haystackOpen-source AI orchestration framework for building context-engineered, production-ready LLM applications. Design modular pipelines and agent workflows with explicit control over retrieval, routing, memory, and generation. Built for scalable agents, RAG, multimodal applications, semantic search, and conversational systems.项目地址: https://gitcode.com/GitHub_Trending/ha/haystack创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考