github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-07-17 18:23:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

searx_search: docs updates (#1175)

Browse Source 
- fix notebook formatting, remove empty cells and add scrolling for long
text

---------

Co-authored-by: blob42 <spike@w530>
This commit is contained in:
blob42 2023-02-20 14:46:44 +00:00 committed by GitHub
parent 4f3fbd7267
commit 9962bda70b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/modules/utils/examples/searx_search.ipynb
View File

@ -52,13 +52,6 @@
"jukit_cell_id": "gGM9PVQX6m" "jukit_cell_id": "gGM9PVQX6m"
}, },
"outputs": [ "outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\n"
]
},
{ {
"data": { "data": {
"text/plain": [ "text/plain": [
@ -109,16 +102,12 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 2, "execution_count": 2,
"metadata": { "metadata": {
"jukit_cell_id": "3FyQ6yHI8K" "jukit_cell_id": "3FyQ6yHI8K",
"tags": [
"scroll-output"
]
}, },
"outputs": [ "outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\n"
]
},
{ {
"data": { "data": {
"text/plain": [ "text/plain": [
@ -150,13 +139,6 @@
"jukit_cell_id": "32rDh0Mvbx" "jukit_cell_id": "32rDh0Mvbx"
}, },
"outputs": [ "outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\n"
]
},
{ {
"data": { "data": {
"text/plain": [ "text/plain": [
@ -208,7 +190,10 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 4, "execution_count": 4,
"metadata": { "metadata": {
"jukit_cell_id": "r7qUtvKNOh" "jukit_cell_id": "r7qUtvKNOh",
"tags": [
"scroll-output"
]
}, },
"outputs": [ "outputs": [
{ {
@ -276,7 +261,10 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 5, "execution_count": 5,
"metadata": { "metadata": {
"jukit_cell_id": "JyNgoFm0vo" "jukit_cell_id": "JyNgoFm0vo",
"tags": [
"scroll-output"
]
}, },
"outputs": [ "outputs": [
{ {
@ -454,7 +442,10 @@
"cell_type": "code", "cell_type": "code",
"execution_count": 7, "execution_count": 7,
"metadata": { "metadata": {
"jukit_cell_id": "5NrlredKxM" "jukit_cell_id": "5NrlredKxM",
"tags": [
"scroll-output"
]
}, },
"outputs": [ "outputs": [
{ {

26
langchain/utilities/searx_search.py
View File

@ -32,9 +32,6 @@ You can now use the ``search`` instance to query the searx API.
Searching Searching
--------- ---------
ref to the run method with a custom name
Use the :meth:`run() <SearxSearchWrapper.run>` and Use the :meth:`run() <SearxSearchWrapper.run>` and
:meth:`results() <SearxSearchWrapper.results>` methods to query the searx API. :meth:`results() <SearxSearchWrapper.results>` methods to query the searx API.
Other methods are are available for convenience. Other methods are are available for convenience.
@ -45,7 +42,6 @@ Example usage of the ``run`` method to make a search:
.. code-block:: python .. code-block:: python
# using google and duckduckgo engines
s.run(query="what is the best search engine?") s.run(query="what is the best search engine?")
Engine Parameters Engine Parameters
@ -284,17 +280,27 @@ class SearxSearchWrapper(BaseModel):
Args: Args:
query: The query to search for. query: The query to search for.
num_results: Limit the number of results to return. num_results: Limit the number of results to return.
engines: List of engines to use for the query. engines: List of engines to use for the query.
**kwargs: extra parameters to pass to the searx API. **kwargs: extra parameters to pass to the searx API.
Returns: Returns:
A list of dictionaries with the following keys: Dict with the following keys:
snippet - The description of the result.
title - The title of the result. {
link - The link to the result. snippet: The description of the result.
engines - The engines used for the result.
category - Searx category of the result. title: The title of the result.
link: The link to the result.
engines: The engines used for the result.
category: Searx category of the result.
}
""" """