github.com/instill-ai/component@v0.16.0-beta/pkg/connector/googlesearch/v0/README.mdx (about)

     1  ---
     2  title: "Google Search"
     3  lang: "en-US"
     4  draft: false
     5  description: "Learn about how to set up a VDP Google Search connector https://github.com/instill-ai/instill-core"
     6  ---
     7  
     8  The Google Search component is a data connector that allows users to leverage the Google Search engine.
     9  It can carry out the following tasks:
    10  
    11  - [Search](#search)
    12  
    13  ## Release Stage
    14  
    15  `Alpha`
    16  
    17  ## Configuration
    18  
    19  The component configuration is defined and maintained [here](https://github.com/instill-ai/component/blob/main/pkg/connector/googlesearch/v0/config/definition.json).
    20  
    21  ## Connection
    22  
    23  | Field | Field ID | Type | Note |
    24  | :--- | :--- | :--- | :--- |
    25  | API Key (required) | `api_key` | string | API Key for the Google Custom Search API. You can create one here: https://developers.google.com/custom-search/v1/overview#api_key |
    26  | Search Engine ID (required) | `cse_id` | string | ID of the Search Engine to use. Before using the Custom Search JSON API you will first need to create and configure your Programmable Search Engine. If you have not already created a Programmable Search Engine, you can start by visiting the Programmable Search Engine control panel https://programmablesearchengine.google.com/controlpanel/all. You can find this in the URL of your Search Engine. For example, if the URL of your search engine is https://cse.google.com/cse.js?cx=012345678910, the ID value is: 012345678910 |
    27  
    28  ## Supported Tasks
    29  
    30  ### Search
    31  
    32  Search data via Google Search Engine.
    33  
    34  | Input | ID | Type | Description |
    35  | :--- | :--- | :--- | :--- |
    36  | Task ID (required) | `task` | string | `TASK_SEARCH` |
    37  | Query (required) | `query` | string | The search query for Google |
    38  | Top K | `top_k` | integer | The number of results to return for each query |
    39  | Include Link Text | `include_link_text` | boolean | Indicate whether to scrape the link and include the text of the link associated with this search result in the 'link_text' field |
    40  | Include Link HTML | `include_link_html` | boolean | Indicate whether to scrape the link and include the raw HTML of the link associated with this search result in the 'link_html' field |
    41  
    42  | Output | ID | Type | Description |
    43  | :--- | :--- | :--- | :--- |
    44  | Results | `results` | array[object] | The returned search results from Google |