wehub-resource-sync
c56bef871b
Sync docs with Docusaurus / sync (push) Waiting to run
Tests / Check if changed (push) Waiting to run
Tests / format (push) Blocked by required conditions
Tests / check-imports (push) Blocked by required conditions
Tests / Unit / macos-latest (push) Blocked by required conditions
Tests / Unit / ubuntu-latest (push) Blocked by required conditions
Tests / Unit / windows-latest (push) Blocked by required conditions
Tests / mypy (push) Blocked by required conditions
Tests / Integration / ubuntu-latest (push) Blocked by required conditions
Tests / Integration / macos-latest (push) Blocked by required conditions
Tests / Integration / windows-latest (push) Blocked by required conditions
Tests / notify-slack-on-failure (push) Blocked by required conditions
Tests / Mark tests as completed (push) Blocked by required conditions
Docker image release / Build base image (push) Waiting to run
CodeQL / Analyze (python) (push) Has been cancelled
Update Platform Components Table / update (push) Has been cancelled
129 lines
3.4 KiB
Markdown
129 lines
3.4 KiB
Markdown
---
|
||
title: "SearchApi"
|
||
id: integrations-searchapi
|
||
description: "SearchApi integration for Haystack"
|
||
slug: "/integrations-searchapi"
|
||
---
|
||
|
||
|
||
## haystack_integrations.components.websearch.searchapi.websearch
|
||
|
||
### SearchApiWebSearch
|
||
|
||
Uses [SearchApi](https://www.searchapi.io/) to search the web for relevant documents.
|
||
|
||
Usage example:
|
||
|
||
```python
|
||
from haystack.utils import Secret
|
||
|
||
from haystack_integrations.components.websearch.searchapi import SearchApiWebSearch
|
||
|
||
websearch = SearchApiWebSearch(top_k=10, api_key=Secret.from_env_var("SEARCHAPI_API_KEY"))
|
||
results = websearch.run(query="Who is the boyfriend of Olivia Wilde?")
|
||
|
||
assert results["documents"]
|
||
assert results["links"]
|
||
```
|
||
|
||
#### __init__
|
||
|
||
```python
|
||
__init__(
|
||
api_key: Secret = Secret.from_env_var("SEARCHAPI_API_KEY"),
|
||
top_k: int | None = 10,
|
||
allowed_domains: list[str] | None = None,
|
||
search_params: dict[str, Any] | None = None,
|
||
) -> None
|
||
```
|
||
|
||
Initialize the SearchApiWebSearch component.
|
||
|
||
**Parameters:**
|
||
|
||
- **api_key** (<code>Secret</code>) – API key for the SearchApi API
|
||
- **top_k** (<code>int | None</code>) – Number of documents to return.
|
||
- **allowed_domains** (<code>list\[str\] | None</code>) – List of domains to limit the search to.
|
||
- **search_params** (<code>dict\[str, Any\] | None</code>) – Additional parameters passed to the SearchApi API.
|
||
For example, you can set 'num' to 100 to increase the number of search results.
|
||
See the [SearchApi website](https://www.searchapi.io/) for more details.
|
||
|
||
The default search engine is Google, however, users can change it by setting the `engine`
|
||
parameter in the `search_params`.
|
||
|
||
#### to_dict
|
||
|
||
```python
|
||
to_dict() -> dict[str, Any]
|
||
```
|
||
|
||
Serializes the component to a dictionary.
|
||
|
||
**Returns:**
|
||
|
||
- <code>dict\[str, Any\]</code> – Dictionary with serialized data.
|
||
|
||
#### from_dict
|
||
|
||
```python
|
||
from_dict(data: dict[str, Any]) -> SearchApiWebSearch
|
||
```
|
||
|
||
Deserializes the component from a dictionary.
|
||
|
||
**Parameters:**
|
||
|
||
- **data** (<code>dict\[str, Any\]</code>) – The dictionary to deserialize from.
|
||
|
||
**Returns:**
|
||
|
||
- <code>SearchApiWebSearch</code> – The deserialized component.
|
||
|
||
#### run
|
||
|
||
```python
|
||
run(query: str) -> dict[str, list[Document] | list[str]]
|
||
```
|
||
|
||
Uses [SearchApi](https://www.searchapi.io/) to search the web.
|
||
|
||
**Parameters:**
|
||
|
||
- **query** (<code>str</code>) – Search query.
|
||
|
||
**Returns:**
|
||
|
||
- <code>dict\[str, list\[Document\] | list\[str\]\]</code> – A dictionary with the following keys:
|
||
- "documents": List of documents returned by the search engine.
|
||
- "links": List of links returned by the search engine.
|
||
|
||
**Raises:**
|
||
|
||
- <code>TimeoutError</code> – If the request to the SearchApi API times out.
|
||
- <code>SearchApiError</code> – If an error occurs while querying the SearchApi API.
|
||
|
||
#### run_async
|
||
|
||
```python
|
||
run_async(query: str) -> dict[str, list[Document] | list[str]]
|
||
```
|
||
|
||
Asynchronously uses [SearchApi](https://www.searchapi.io/) to search the web.
|
||
|
||
This is the asynchronous version of the `run` method with the same parameters and return values.
|
||
|
||
**Parameters:**
|
||
|
||
- **query** (<code>str</code>) – Search query.
|
||
|
||
**Returns:**
|
||
|
||
- <code>dict\[str, list\[Document\] | list\[str\]\]</code> – A dictionary with the following keys:
|
||
- "documents": List of documents returned by the search engine.
|
||
- "links": List of links returned by the search engine.
|
||
|
||
**Raises:**
|
||
|
||
- <code>TimeoutError</code> – If the request to the SearchApi API times out.
|
||
- <code>SearchApiError</code> – If an error occurs while querying the SearchApi API.
|