LangSearch

https://docs.langsearch.com
Admin
LangSearch offers free Web Search and Semantic Rerank APIs to connect LLM applications to the world,...
Tokens:12,254
Snippets:21
Trust Score:6.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Web Search API

Source: https://docs.langsearch.com/getting-started/quickstart

This API allows you to perform web searches and retrieve relevant results, optionally with summaries.

```APIDOC
## POST /v1/web-search

### Description
Performs a web search and returns relevant results. Can optionally provide summaries for the results.

### Method
POST

### Endpoint
https://api.langsearch.com/v1/web-search

### Parameters
#### Request Body
- **query** (string) - Required - The search query.
- **freshness** (string) - Optional - Filters results by freshness (e.g., "30d", "7d", "noLimit"). Defaults to "noLimit".
- **summary** (boolean) - Optional - Whether to include a summary for each result. Defaults to false.
- **count** (integer) - Optional - The number of results to return. Defaults to 10.

### Request Example
```json
{
    "query": "tell me the highlights from Apple 2024 ESG report",
    "freshness": "noLimit",
    "summary": true,
    "count": 10
}
```

### Response
#### Success Response (200)
- **results** (array) - An array of search result objects, each containing a URL, title, snippet, and optionally a summary.

#### Response Example
```json
{
  "results": [
    {
      "url": "https://www.apple.com/newsroom/2024/05/apple-2024-environmental-progress-report/",
      "title": "Apple’s 2024 Environmental Progress Report - Apple",
      "snippet": "Apple today released its 2024 Environmental Progress Report, detailing the company’s continued progress toward its ambitious environmental goals...",
      "summary": "Apple's 2024 ESG report highlights advancements in carbon reduction, renewable energy use, and sustainable material sourcing."
    }
  ]
}
```
```

--------------------------------

### Semantic Rerank API

Source: https://docs.langsearch.com/getting-started/quickstart

This API semantically reranks a list of documents based on a given query, returning the most relevant ones.

```APIDOC
## POST /v1/rerank

### Description
Semantically reranks a provided list of documents based on a query and returns the top N most relevant documents.

### Method
POST

### Endpoint
https://api.langsearch.com/v1/rerank

### Parameters
#### Request Body
- **model** (string) - Required - The rerank model to use (e.g., "langsearch-reranker-v1").
- **query** (string) - Required - The query to rerank documents against.
- **top_n** (integer) - Required - The number of top documents to return.
- **return_documents** (boolean) - Required - Whether to return the full document content in the response.
- **documents** (array) - Required - An array of document strings to be reranked.

### Request Example
```json
{
    "model": "langsearch-reranker-v1",
    "query": "Tell me the key points of Alibaba 2024 ESG report",
    "top_n": 2,
    "return_documents": true,
    "documents": [
        "Alibaba Group released the 2024 Environmental, Social, and Governance (ESG) report...",
        "The core of ESG is about becoming a better company. This year marks the 25th anniversary of Alibaba..."
    ]
}
```

### Response
#### Success Response (200)
- **reranked_documents** (array) - An array of reranked document objects, each containing the document text, score, and potentially other metadata.

#### Response Example
```json
{
  "reranked_documents": [
    {
      "document": "Alibaba Group released the 2024 Environmental, Social, and Governance (ESG) report, detailing the progress made in various ESG areas over the past year...",
      "score": 0.95
    },
    {
      "document": "The core of ESG is about becoming a better company. This year marks the 25th anniversary of Alibaba...",
      "score": 0.88
    }
  ]
}
```
```

--------------------------------

### Web Search API using cURL

Source: https://docs.langsearch.com/getting-started/quickstart

This snippet shows how to perform a web search using the Langsearch Web Search API via cURL. It sends a POST request with a JSON payload containing the search query, freshness preference, summary preference, and the number of results. Requires an API key for authorization.

```bash
curl --location 'https://api.langsearch.com/v1/web-search' \
--header 'Authorization: Bearer YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "query": "tell me the highlights from Apple 2024 ESG report",
    "freshness": "noLimit",
    "summary": true,
    "count": 10
}'
```

--------------------------------

### Web Search API using Python

Source: https://docs.langsearch.com/getting-started/quickstart

This snippet demonstrates how to use the Langsearch Web Search API with Python's requests library. It sends a POST request with a JSON payload for a web search, including query, freshness, summary, and count parameters. An API key is required for the Authorization header.

```python
import requests
import json

url = "https://api.langsearch.com/v1/web-search"

payload = json.dumps({
  "query": "tell me the highlights from Apple's 2024 ESG report",
  "freshness": "noLimit",
  "summary": True,
  "count": 10
})
headers = {
  'Authorization': 'Bearer YOUR-API-KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
```

--------------------------------

### Web Search API

Source: https://docs.langsearch.com/api/web-search-api

This section details how to perform a web search using the Langsearch API. It includes examples for making requests using cURL and Python, demonstrating how to specify search queries, freshness, summary options, and the number of results.

```APIDOC
## POST /v1/web-search

### Description
Performs a web search to retrieve relevant information based on a given query. Allows for specifying search parameters like freshness, summary preference, and the number of results.

### Method
POST

### Endpoint
https://api.langsearch.com/v1/web-search

### Parameters
#### Query Parameters
None

#### Request Body
- **query** (string) - Required - The search query string.
- **freshness** (string) - Optional - Specifies the desired freshness of the search results. Allowed values: `3個月內`, `24小時內`, `7天內`, `noLimit`.
- **summary** (boolean) - Optional - If true, the API will return a summary of the search results. Defaults to false.
- **count** (integer) - Optional - The number of search results to return. Defaults to 10.

### Request Example (cURL)
```bash
curl --location 'https://api.langsearch.com/v1/web-search' \
--header 'Authorization: Bearer YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "query": "tell me the highlights from Apple 2024 ESG report",
    "freshness": "noLimit",
    "summary": true,
    "count": 10
}'
```

### Request Example (Python)
```python
import requests
import json

url = "https://api.langsearch.com/v1/web-search"

payload = json.dumps({
  "query": "tell me the highlights from Apple's 2024 ESG report",
  "freshness": "noLimit",
  "summary": True,
  "count": 10
})
headers = {
  'Authorization': 'Bearer YOUR-API-KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
```

### Response
#### Success Response (200)
- **results** (array) - An array of search result objects.
  - **title** (string) - The title of the search result.
  - **link** (string) - The URL of the search result.
  - **snippet** (string) - A brief snippet or summary of the search result.
  - **date** (string) - The publication date of the search result.
- **summary** (string) - A summarized overview of the search results, if requested.

#### Response Example
```json
{
    "results": [
        {
            "title": "Apple Inc. - 2024 ESG Report Highlights",
            "link": "https://www.apple.com/environment/pdf/Apple_Environmental_Progress_Report_2024.pdf",
            "snippet": "This report details Apple's commitment to environmental, social, and governance (ESG) initiatives, focusing on renewable energy, sustainable materials, and carbon neutrality goals.",
            "date": "2024-04-22"
        },
        {
            "title": "Apple's 2024 Sustainability Goals",
            "link": "https://www.apple.com/newsroom/2024/04/apples-2024-environmental-progress-report/",
            "snippet": "Apple announced its 2024 environmental progress, highlighting achievements in reducing its carbon footprint and increasing the use of recycled materials across its products.",
            "date": "2024-04-22"
        }
    ],
    "summary": "Apple's 2024 ESG report emphasizes its progress in renewable energy adoption, use of recycled materials, and strides towards carbon neutrality. The company continues to invest in sustainable practices across its operations and supply chain."
}
```
```

--------------------------------

### Semantic Rerank API using cURL

Source: https://docs.langsearch.com/getting-started/quickstart

This snippet shows how to use the Langsearch Semantic Rerank API with cURL. It sends a POST request with a JSON payload including the model name, query, number of top results, whether to return documents, and a list of documents to rerank. An API key is required for authentication.

```bash
curl --location 'https://api.langsearch.com/v1/rerank' \
--header 'Authorization: Bearer YOUR-API-KEY' \
--header 'Content-Type: application/json' \
--data '{
    "model": "langsearch-reranker-v1",
    "query": "Tell me the key points of Alibaba 2024 ESG report",
    "top_n": 2,
    "return_documents": true,
    "documents": [
        "Alibaba Group released the 2024 Environmental, Social, and Governance (ESG) report, detailing the progress made in various ESG areas over the past year. The report shows that Alibaba has steadily advanced its carbon reduction efforts, with the group's net carbon emissions and carbon intensity of the value chain continuing to decrease. The group also continues to leverage digital technologies and platform capabilities to support accessible development, healthcare, aging-friendly services, and small and micro enterprises. Alibaba Group's CEO, Wu Yongming, stated in the report: 'The core of ESG is about becoming a better company. Over the past 25 years, the actions related to ESG have formed the foundation of Alibaba, which is just as important as the commercial value we create. While the group is focused on the dual business strategies of 'user-first' and 'AI-driven,' we also remain committed to ESG as one of Alibaba's cornerstone strategies. Alibaba has made solid progress in reducing carbon emissions.'",
        "The core of ESG is about becoming a better company. This year marks the 25th anniversary of Alibaba. Over the past 25 years, Alibaba has adhered to its mission of 'making it easy to do business everywhere,' supporting the prosperity of domestic e-commerce; maintaining an open ecosystem, with the Magic搭 community opening over 3,800 open-source models; assisting in rural revitalization, having sent 29 rural special envoys to 27 counties; promoting platform carbon reduction, pioneering a Scope 3+ carbon reduction plan; and engaging in employee welfare, with the 'Everyone 3 Hours' initiative making small but meaningful changes... These actions form the foundation of Alibaba, which is just as important as creating commercial value. I hope that every Alibaba employee will learn to make difficult but correct choices, maintaining foresight, goodwill, and pragmatism. A better Alibaba is worth our collective efforts. Alibaba's mission, unchanged for over 20 years, is to make it easy to do business in the world. Today, this mission takes on new significance in this era."
    ]
}'
```

--------------------------------

### LangSearch API Request Body Example

Source: https://docs.langsearch.com/api/web-search-api

This JSON object represents the structure of a request body for the LangSearch API. It specifies the search query, desired freshness, whether a summary is required, and the number of results to return.

```json
{
  "query": "tell me the highlights from Apple's 2024 ESG report",
  "freshness": "onLimit",
  "summary": true,
  "count": 10
}
```

--------------------------------

### LangSearch API Response Example

Source: https://docs.langsearch.com/api/web-search-api

This JSON object illustrates a typical response from the LangSearch API after a search query. It includes a status code, log ID, and a data field containing structured web page results, each with a name, URL, snippet, and summary.

```json
{
    "code": 200,
    "log_id": "3f077be5ec003b33",
    "msg": null,
    "data": {
        "_type": "SearchResponse",
        "queryContext": {
            "originalQuery": "tell me the highlights from Apple's 2024 ESG report"
        },
        "webPages": {
            "webSearchUrl": "https://langsearch.com/search?q=tell me the highlights from Apple's 2024 ESG report",
            "totalEstimatedMatches": null,
            "value": [
                {
                    "id": "https://api.langsearch.com/v1/web-search#1",
                    "name": "ESG Report June 2024 - Apple Inc. (AAPL)",
                    "url": "https://www.crispidea.com/report/esg-report-june-2024-apple/",
                    "displayUrl": "https://www.crispidea.com/report/esg-report-june-2024-apple/",
                    "snippet": "esg report june 2024 – apple inc. ( aapl ) \n highlights of the report \n over the last 5 years , the company has an average esg score of 75 . 07 , and a median esg score of 76 . 09 . esg score is calculated as a sum of weighted individual pillar scores . \n esg report june 2024 - apple inc. ( aapl ) \n why crisp idea esg report ? \n ou r esg database helps organizations to navigate the complex landscape of sustainability , responsible business practices , and stakeholder engagement . our esg factors...",
                    "summary": "esg report june 2024 – apple inc. ( aapl ) \n highlights of the report \n over the last 5 years , the company has an average esg score of 75 . 07 , and a median esg score of 76 . 09 . esg score is calculated as a sum of weighted individual pillar scores . \n esg report june 2024 - apple inc. ( aapl ) \n why crisp idea esg report ? \n ou r esg database helps organizations to navigate the complex landscape of sustainability , responsible business practices , and stakeholder engagement . our esg factors can be easily integrated into portfolio analysis , equity research , screening or quantitative analysis . \n we conduct comprehensive assessments to evaluate organization ’s esg performance , policies , and practices . we provide standardized esg ~ 500 data points and ~ 60 analytics for nearly 80 % of global market cap based on publicly reported company data and cover ~ 200 countries . \n table of content \n – esg summary \n – performance summary \n – peer summary \n – historical performance summary \n report details \n esg report june 2024 – apple inc. ( aapl ) \n pages \n 4 \n format \n pdf \n language \n english \n price \n $ 99 . 00",
                    "datePublished": null,
                    "dateLastCrawled": null
                },
                {
                    "id": "https://api.langsearch.com/v1/web-search#2",
                    "name": "Apple ESG rating 2023: Key takeaways from Apple's ESG Report - Permutable",
                    "url": "https://permutable.ai/6-key-takeaways-from-the-apple-esg-report/",
                    "displayUrl": "https://permutable.ai/6-key-takeaways-from-the-apple-esg-report/",
                    "snippet": "apple esg rating 2023 : key takeaways from apple ’s esg report \n this article was originally written in 2023 based on apple ’s esg report from that year . for the most up - to - date information and analysis , please scroll down to the 2024 update section . as of 2023 , the most recent apple esg report showed that the company had made significant efforts to become more environmentally friendly in recent years . with ambitious sustainability goals and progress towards achieving them , there was ,...",
                    "datePublished": null,
                    "dateLastCrawled": null
                }
            ]
        }
    }
}
```

--------------------------------

### Rerank Documents using Langsearch API with Python

Source: https://docs.langsearch.com/getting-started/quickstart

This snippet demonstrates how to rerank a list of documents based on a query using the Langsearch API. It sends a POST request with a JSON payload containing the model, query, top_n, return_documents flag, and the documents themselves. Ensure you replace 'YOUR-API-KEY' with your actual API key and adjust the 'top_n' parameter as needed. The response will contain the reranked documents.

```python
import requests
import json

url = "https://api.langsearch.com/v1/rerank"

payload = json.dumps({
  "model": "langsearch-reranker-v1",
  "query": "Tell me the key points of Alibaba 2024 ESG report",
  "top_n": 2,
  "return_documents": True,
  "documents": [
    "Alibaba Group released the 2024 Environmental, Social, and Governance (ESG) report, detailing the progress made in various ESG areas over the past year. The report shows that Alibaba has steadily advanced its carbon reduction efforts, with the group's net carbon emissions and carbon intensity of the value chain continuing to decrease. The group also continues to leverage digital technologies and platform capabilities to support accessible development, healthcare, aging-friendly services, and small and micro enterprises. Alibaba Group's CEO, Wu Yongming, stated in the report: 'The core of ESG is about becoming a better company. Over the past 25 years, the actions related to ESG have formed the foundation of Alibaba, which is just as important as the commercial value we create. While the group is focused on the dual business strategies of 'user-first' and 'AI-driven,' we also remain committed to ESG as one of Alibaba's cornerstone strategies. Alibaba has made solid progress in reducing carbon emissions.'",
    "The core of ESG is about becoming a better company. This year marks the 25th anniversary of Alibaba. Over the past 25 years, Alibaba has adhered to its mission of 'making it easy to do business everywhere,' supporting the prosperity of domestic e-commerce; maintaining an open ecosystem, with the Magic搭 community opening over 3,800 open-source models; assisting in rural revitalization, having sent 29 rural special envoys to 27 counties; promoting platform carbon reduction, pioneering a Scope 3+ carbon reduction plan; and engaging in employee welfare, with the 'Everyone 3 Hours' initiative making small but meaningful changes... These actions form the foundation of Alibaba, which is just as important as creating commercial value. I hope that every Alibaba employee will learn to make difficult but correct choices, maintaining foresight, goodwill, and pragmatism. A better Alibaba is worth our collective efforts. Alibaba's mission, unchanged for over 20 years, is to make it easy to do business in the world. Today, this mission takes on new significance in this era."
  ]
})
headers = {
  'Authorization': 'Bearer YOUR-API-KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

```

--------------------------------

### Langsearch Request and Response Example (JSON)

Source: https://docs.langsearch.com/api/semantic-rerank-api

This snippet demonstrates a typical request and response structure for the Langsearch API. It includes the JSON payload for sending a query with associated documents and the JSON response containing relevance scores and document data. The request specifies the model, query, and parameters for retrieving relevant documents.

```json
{
    "model": "langsearch-reranker-v1",
    "query": "Tell me the key points of Alibaba's 2024 ESG report",
    "top_n": 2,
    "return_documents": true,
    "documents": [
        "Alibaba Group released the 2024 Environmental, Social, and Governance (ESG) report, detailing the progress made in various ESG areas over the past year. The report shows that Alibaba has steadily advanced its carbon reduction efforts, with the group's net carbon emissions and carbon intensity of the value chain continuing to decrease. The group also continues to leverage digital technologies and platform capabilities to support accessible development, healthcare, aging-friendly services, and small and micro enterprises. Alibaba Group's CEO, Wu Yongming, stated in the report: 'The core of ESG is about becoming a better company. Over the past 25 years, the actions related to ESG have formed the foundation of Alibaba, which is just as important as the commercial value we create. While the group is focused on the dual business strategies of 'user-first' and 'AI-driven,' we also remain committed to ESG as one of Alibaba's cornerstone strategies. Alibaba has made solid progress in reducing carbon emissions.",
        "The core of ESG is about becoming a better company. This year marks the 25th anniversary of Alibaba. Over the past 25 years, Alibaba has adhered to its mission of 'making it easy to do business everywhere,' supporting the prosperity of domestic e-commerce; maintaining an open ecosystem, with the Magic搭 community opening over 3,800 open-source models; assisting in rural revitalization, having sent 29 rural special envoys to 27 counties; promoting platform carbon reduction, pioneering a Scope 3+ carbon reduction plan; and engaging in employee welfare, with the 'Everyone 3 Hours' initiative making small but meaningful changes... These actions form the foundation of Alibaba, which is just as important as creating commercial value. I hope that every Alibaba employee will learn to make difficult but correct choices, maintaining foresight, goodwill, and pragmatism. A better Alibaba is worth our collective efforts. Alibaba's mission, unchanged for over 20 years, is to make it easy to do business in the world. Today, this mission takes on new significance in this era."
    ]
}
```

```json
{
    "code": 200,
    "log_id": "56a3067f9b92dfd0",
    "msg": null,
    "model": "langsearch-reranker-v1",
    "results": [
        {
            "index": 0,
            "document": {
                "text": "Alibaba Group released the 2024 Environmental, Social, and Governance (ESG) report, detailing the progress made in various ESG areas over the past year. The report shows that Alibaba has steadily advanced its carbon reduction efforts, with the group's net carbon emissions and carbon intensity of the value chain continuing to decrease. The group also continues to leverage digital technologies and platform capabilities to support accessible development, healthcare, aging-friendly services, and small and micro enterprises. Alibaba Group's CEO, Wu Yongming, stated in the report: 'The core of ESG is about becoming a better company. Over the past 25 years, the actions related to ESG have formed the foundation of Alibaba, which is just as important as the commercial value we create. While the group is focused on the dual business strategies of 'user-first' and 'AI-driven,' we also remain committed to ESG as one of Alibaba's cornerstone strategies. Alibaba has made solid progress in reducing carbon emissions.'"
            },
            "relevance_score": 0.7166407801262326
        },
        {
            "index": 1,
            "document": {
                "text": "The core of ESG is about becoming a better company. This year marks the 25th anniversary of Alibaba. Over the past 25 years, Alibaba has adhered to its mission of 'making it easy to do business everywhere,' supporting the prosperity of domestic e-commerce; maintaining an open ecosystem, with the Magic搭 community opening over 3,800 open-source models; assisting in rural revitalization, having sent 29 rural special envoys to 27 counties; promoting platform carbon reduction, pioneering a Scope 3+ carbon reduction plan; and engaging in employee welfare, with the 'Everyone 3 Hours' initiative making small but meaningful changes... These actions form the foundation of Alibaba, which is just as important as creating commercial value. I hope that every Alibaba employee will learn to make difficult but correct choices, maintaining foresight, goodwill, and pragmatism. A better Alibaba is worth our collective efforts. Alibaba's mission, unchanged for over 20 years, is to make it easy to do business in the world. Today, this mission takes on new significance in this era."
            },
            "relevance_score": 0.5658672473649548
        }
    ]
}
```

--------------------------------

### Displaying Query Result in Bash

Source: https://docs.langsearch.com/use-cases/using-langsearch-in-langchain

This snippet demonstrates how to display the result of a query in a Bash environment. It shows the input query and the detailed output explanation, likely generated by a natural language processing or search tool.

```bash
{
  "input": "why the sky is blue?",
  "output": "The sky appears blue due to a phenomenon called Rayleigh scattering. Here's how it works:\n\n1. **Sunlight Composition**: Sunlight, or white light, is made up of different colors, each with different wavelengths. The colors range from red (longer wavelengths) to violet (shorter wavelengths).\n\n2. **Atmospheric Interaction**: When sunlight enters the Earth's atmosphere, it collides with molecules and small particles in the air. This interaction causes the light to scatter in different directions.\n\n3. **Scattering of Colors**: Shorter wavelengths of light (blue and violet) scatter more than longer wavelengths (red and yellow). Although violet light scatters even more than blue, our eyes are more sensitive to blue light, and some of the violet light is absorbed by the ozone layer.\n\n4. **Resulting Color**: As a result of this scattering, when we look up at the sky during the day, we see a predominance of blue light, making the sky appear blue.\n\nThis effect is more pronounced when the sun is higher in the sky, and it can change during sunrise and sunset when the light has to pass through more atmosphere, scattering shorter wavelengths and allowing longer wavelengths (reds and oranges) to dominate."
}
```

--------------------------------

### POST /v1/web-search

Source: https://docs.langsearch.com/api/web-search-api

This endpoint allows you to search for web pages. You can specify a query, freshness, whether to include summaries, and the number of results.

```APIDOC
## POST /v1/web-search

### Description
Performs a web search to retrieve relevant web pages based on a given query. Supports filtering by date and requesting summaries.

### Method
POST

### Endpoint
https://api.langsearch.com/v1/web-search

### Parameters
#### Request Headers
- **Authorization** (string) - Required - Authentication token in the format `Bearer {API KEY}`.
- **Content-Type** (string) - Required - Must be `application/json`.

#### Request Body
- **query** (string) - Required - The search query string.
- **freshness** (string) - Optional - Filters results by publication date. Accepted values: `oneDay`, `oneWeek`, `oneMonth`, `oneYear`, `noLimit`. Defaults to `noLimit`.
- **summary** (boolean) - Optional - If true, includes detailed summaries for each result. Defaults to `false`.
- **count** (integer) - Optional - The number of search results to return. Accepted range: 1-10. Defaults to 10.

### Request Example
```json
{
  "query": "artificial intelligence advancements",
  "freshness": "oneMonth",
  "summary": true,
  "count": 5
}
```

### Response
#### Success Response (200)
- **_type** (string) - Type of the response, e.g., "SearchResponse".
- **queryContext** (object) - Information about the search query.
  - **originalQuery** (string) - The original query string.
- **webPages** (object) - Contains the search results.
  - **webSearchUrl** (string) - URL for the web search.
  - **totalEstimatedMatches** (integer) - Estimated total number of matching results.
  - **someResultsRemoved** (boolean) - Indicates if some results were removed.
  - **value** (array) - A list of web page objects.
    - **id** (string) - Unique identifier for the web page.
    - **name** (string) - Title of the web page.
    - **url** (string) - URL of the web page.
    - **displayUrl** (string) - Decoded display URL.
    - **snippet** (string) - A short snippet from the web page.
    - **summary** (string) - Full summary of the web page (present if `summary` was true in the request).
    - **datePublished** (string) - Publication date of the web page.
    - **dateLastCrawled** (string) - Date the web page was last crawled.

#### Response Example
```json
{
  "_type": "SearchResponse",
  "queryContext": {
    "originalQuery": "artificial intelligence advancements"
  },
  "webPages": {
    "webSearchUrl": "https://www.bing.com/search?q=artificial+intelligence+advancements",
    "totalEstimatedMatches": 15000000,
    "someResultsRemoved": false,
    "value": [
      {
        "id": "/web/20240315010102/https://example.com/article1",
        "name": "Latest AI Advancements in 2024",
        "url": "https://example.com/article1",
        "displayUrl": "example.com/article1",
        "snippet": "Explore the cutting-edge advancements in artificial intelligence...",
        "summary": "This article provides a comprehensive overview of the latest breakthroughs in AI, including new models, applications in healthcare, and ethical considerations.",
        "datePublished": "2024-03-10T10:00:00Z",
        "dateLastCrawled": "2024-03-15T01:01:02Z"
      }
    ]
  }
}
```
```

--------------------------------

### Web Search API

Source: https://docs.langsearch.com/api/web-search-api

This endpoint allows you to perform web searches with various options for freshness, summarization, and result count. It returns a structured response containing relevant web pages.

```APIDOC
## POST /websites/langsearch

### Description
Performs a web search based on the provided query and returns summarized or detailed results.

### Method
POST

### Endpoint
/websites/langsearch

### Parameters
#### Request Body
- **query** (string) - Required - The search query string.
- **freshness** (string) - Optional - Specifies the desired freshness of results (e.g., 'onLimit').
- **summary** (boolean) - Optional - If true, the response will include a summary of the search results.
- **count** (integer) - Optional - The number of results to return.

### Request Example
```json
{
  "query": "tell me the highlights from Apple's 2024 ESG report",
  "freshness": "onLimit",
  "summary": true,
  "count": 10
}
```

### Response
#### Success Response (200)
- **code** (integer) - The status code of the response.
- **log_id** (string) - A unique identifier for the log entry.
- **msg** (string or null) - Any additional messages.
- **data** (object) - Contains the search results.
  - **_type** (string) - The type of the response data.
  - **queryContext** (object) - Information about the original query.
    - **originalQuery** (string) - The original search query.
  - **webPages** (object) - Contains details about the web pages found.
    - **webSearchUrl** (string) - The URL for the web search.
    - **totalEstimatedMatches** (integer or null) - Estimated total number of matches.
    - **value** (array) - An array of web page objects.
      - **id** (string) - Unique identifier for the web page.
      - **name** (string) - The title of the web page.
      - **url** (string) - The URL of the web page.
      - **displayUrl** (string) - The display URL for the web page.
      - **snippet** (string) - A short snippet from the web page.
      - **summary** (string) - A summary of the web page content (if requested).
      - **datePublished** (string or null) - The publication date of the content.
      - **dateLastCrawled** (string or null) - The date the content was last crawled.

#### Response Example
```json
{
    "code": 200,
    "log_id": "3f077be5ec003b33",
    "msg": null,
    "data": {
        "_type": "SearchResponse",
        "queryContext": {
            "originalQuery": "tell me the highlights from Apple's 2024 ESG report"
        },
        "webPages": {
            "webSearchUrl": "https://langsearch.com/search?q=tell me the highlights from Apple's 2024 ESG report",
            "totalEstimatedMatches": null,
            "value": [
                {
                    "id": "https://api.langsearch.com/v1/web-search#1",
                    "name": "ESG Report June 2024 - Apple Inc. (AAPL)",
                    "url": "https://www.crispidea.com/report/esg-report-june-2024-apple/",
                    "displayUrl": "https://www.crispidea.com/report/esg-report-june-2024-apple/",
                    "snippet": "esg report june 2024 – apple inc. ( aapl ) \n highlights of the report \n over the last 5 years , the company has an average esg score of 75 . 07 , and a median esg score of 76 . 09 . esg score is calculated as a sum of weighted individual pillar scores . \n esg report june 2024 - apple inc. ( aapl ) \n why crisp idea esg report ? \n ou r esg database helps organizations to navigate the complex landscape of sustainability , responsible business practices , and stakeholder engagement . our esg factors...",
                    "summary": "esg report june 2024 – apple inc. ( aapl ) \n highlights of the report \n over the last 5 years , the company has an average esg score of 75 . 07 , and a median esg score of 76 . 09 . esg score is calculated as a sum of weighted individual pillar scores . \n esg report june 2024 - apple inc. ( aapl ) \n why crisp idea esg report ? \n ou r esg database helps organizations to navigate the complex landscape of sustainability , responsible business practices , and stakeholder engagement . our esg factors can be easily integrated into portfolio analysis , equity research , screening or quantitative analysis . \n we conduct comprehensive assessments to evaluate organization ’s esg performance , policies , and practices . we provide standardized esg ~ 500 data points and ~ 60 analytics for nearly 80 % of global market cap based on publicly reported company data and cover ~ 200 countries . \n table of content \n – esg summary \n – performance summary \n – peer summary \n – historical performance summary \n report details \n esg report june 2024 – apple inc. ( aapl ) \n pages \n 4 \n format \n pdf \n language \n english \n price \n $ 99 . 00",
                    "datePublished": null,
                    "dateLastCrawled": null
                },
                {
                    "id": "https://api.langsearch.com/v1/web-search#2",
                    "name": "Apple ESG rating 2023: Key takeaways from Apple's ESG Report - Permutable",
                    "url": "https://permutable.ai/6-key-takeaways-from-the-apple-esg-report/",
                    "displayUrl": "https://permutable.ai/6-key-takeaways-from-the-apple-esg-report/",
                    "snippet": "apple esg rating 2023 : key takeaways from apple ’s esg report \n this article was originally written in 2023 based on apple ’s esg report from that year . for the most up - to - date information and analysis , please scroll down to the 2024 update section . as of 2023 , the most recent apple esg report showed that the company had made significant efforts to become more environmentally friendly in recent years . with ambitious sustainability goals and progress towards achieving them , there was ,...",
                    "summary": null,
                    "datePublished": null,
                    "dateLastCrawled": null
                }
            ]
        }
    }
}
```
```

--------------------------------

### Define LangSearch Web Search Tool in LangChain (Python)

Source: https://docs.langsearch.com/use-cases/using-langsearch-in-langchain

Integrates the LangSearch Web Search API as a custom tool within LangChain. It requires an API key for authentication and takes a query and optional count for search results. The tool returns detailed information from web pages or an error message if the request fails or no results are found.

```python
import requests
from langchain.agents import AgentExecutor, create_tool_calling_agent
from langchain_core.prompts.chat import ChatPromptTemplate
from langchain_openai import ChatOpenAI
from langchain.tools import tool

OPENAI_API_KEY = ""
LANGSEARCH_API_KEY = ""

# Define LangSearch Web Search tool
@tool
def langsearch_websearch_tool(query: str, count: int = 10) -> str:
    """
    Perform web search using LangSearch Web Search API.

    Parameters:
    - query: Search keywords
    - count: Number of search results to return

    Returns:
    - Detailed information of search results, including web page title, web page URL, web page content, web page publication time, etc.
    """
    
    url = "https://api.langsearch.com/v1/web-search"
    headers = {
        "Authorization": f"Bearer {LANGSEARCH_API_KEY}",  # Please replace with your API key
        "Content-Type": "application/json"
    }
    data = {
        "query": query,
        "freshness": "noLimit",  # Search time range, e.g., "oneDay", "oneWeek", "oneMonth", "oneYear", "noLimit"
        "summary": True,          # Whether to return a long text summary
        "count": count
    }

    response = requests.post(url, headers=headers, json=data)

    if response.status_code == 200:
        json_response = response.json()
        try:
            if json_response["code"] != 200 or not json_response["data"]:
                return f"Search API request failed, reason: {response.msg or 'Unknown error'}"
            
            webpages = json_response["data"]["webPages"]["value"]
            if not webpages:
                return "No relevant results found."
            formatted_results = ""
            for idx, page in enumerate(webpages, start=1):
                formatted_results += (
                    f"Citation: {idx}
"
                    f"Title: {page['name']}
"
                    f"URL: {page['url']}
"
                    f"Content: {page['summary']}
"
                )
            return formatted_results.strip()
        except Exception as e:
            return f"Search API request failed, reason: Failed to parse search results {str(e)}"
    else:
        return f"Search API request failed, status code: {response.status_code}, error message: {response.text}"

# Create LangChain tools
tools = [Tool(
    name="LangSearchWebSearch",
    func=langsearch_websearch_tool,
    description="Use LangSearch Web Search API to search internet web pages. The input should be a search query string, and the output will return detailed information of search results, including web page title, web page URL, web page content, web page publication time, etc."
)]

# Initialize OpenAI language model
model = ChatOpenAI(
    model="gpt-4o-mini",
    temperature=0,
    openai_api_key=OPENAI_API_KEY
)

prompt = ChatPromptTemplate.from_messages(
    [
        ("system", "You are a helpful assistant."),
        ("human", "{input}"),
        ("placeholder", "{agent_scratchpad}"),
    ]
)

# Initialize agent, including langsearch websearch tools
agent = create_tool_calling_agent(model, tools, prompt)
agent_executor = AgentExecutor(agent=agent, tools=tools)

user_question = "why the sky is blue?"
agent_executor.invoke({"input": user_question})
```

--------------------------------

### Rerank Documents with Langsearch API using Python

Source: https://docs.langsearch.com/api/semantic-rerank-api

This snippet shows how to send a POST request to the Langsearch API's rerank endpoint. It requires the 'requests' and 'json' libraries. The input includes the API URL, a JSON payload with reranking parameters and documents, and authentication headers. The output is the text response from the API, typically containing reranked documents.

```python
import requests
import json

url = "https://api.langsearch.com/v1/rerank"

payload = json.dumps({
  "model": "langsearch-reranker-v1",
  "query": "Tell me the key points of Alibaba 2024 ESG report",
  "top_n": 2,
  "return_documents": True,
  "documents": [
    "Alibaba Group released the 2024 Environmental, Social, and Governance (ESG) report, detailing the progress made in various ESG areas over the past year. The report shows that Alibaba has steadily advanced its carbon reduction efforts, with the group's net carbon emissions and carbon intensity of the value chain continuing to decrease. The group also continues to leverage digital technologies and platform capabilities to support accessible development, healthcare, aging-friendly services, and small and micro enterprises. Alibaba Group's CEO, Wu Yongming, stated in the report: 'The core of ESG is about becoming a better company. Over the past 25 years, the actions related to ESG have formed the foundation of Alibaba, which is just as important as the commercial value we create. While the group is focused on the dual business strategies of 'user-first' and 'AI-driven,' we also remain committed to ESG as one of Alibaba's cornerstone strategies. Alibaba has made solid progress in reducing carbon emissions.'",
    "The core of ESG is about becoming a better company. This year marks the 25th anniversary of Alibaba. Over the past 25 years, Alibaba has adhered to its mission of 'making it easy to do business everywhere,' supporting the prosperity of domestic e-commerce; maintaining an open ecosystem, with the Magic搭 community opening over 3,800 open-source models; assisting in rural revitalization, having sent 29 rural special envoys to 27 counties; promoting platform carbon reduction, pioneering a Scope 3+ carbon reduction plan; and engaging in employee welfare, with the 'Everyone 3 Hours' initiative making small but meaningful changes... These actions form the foundation of Alibaba, which is just as important as creating commercial value. I hope that every Alibaba employee will learn to make difficult but correct choices, maintaining foresight, goodwill, and pragmatism. A better Alibaba is worth our collective efforts. Alibaba's mission, unchanged for over 20 years, is to make it easy to do business in the world. Today, this mission takes on new significance in this era."
  ]
})
hereaders = {
  'Authorization': 'Bearer YOUR-API-KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
```
Tokens:
Raw