Smart Search SDK

Welcome to the Smart Search SDK documentation. This guide will help you understand how to use the various features of the SDK effectively.

Overview

The Smart Search SDK provides a high-level interface for integrating Smart Search capabilities directly into your applications. It simplifies communication with the Smart Search API by managing authentication, requests, and responses automatically — allowing developers to focus on building functionality rather than handling raw HTTP calls.

The SDK enables unified access to web search and connector capabilities across both internal and external data sources such as websites, Google Drive, Gmail, Google Calendar, and GitHub.

---

SDK Versions

The Smart Search SDK currently supports two major versions:

v1 — Deprecated

The original version of Smart Search SDK that included three main capabilities:

1. Get Authenticated Emails — List all users that have access to Smart Search

2. Search — Run lexical, semantic, or vector-based searches

3. Deep Research — Execute long-form research via Sonar or Assafelovic (using HTTP or WebSocket modes)

⚠️ Note: v1 is now deprecated and no longer maintained. New users and integrations should migrate to v2 for continued support and feature compatibility.

---

v2 — Current

The latest version of Smart Search SDK introduces a modular architecture with two primary capability groups:

• Web Search Capabilities

  • get_web_search_results — Retrieve search results with snippets, keypoints, or summary

  • get_web_search_urls — Return relevant URLs only

  • get_web_page — Fetch web page content

  • get_web_page_snippets — Extract snippets (paragraph or sentence style)

  • get_web_page_keypoints — Generate key points from a web page

• Connector Capabilities

  • search_github

  • search_google_calendar

  • search_google_drive

  • search_google_mail

All v2 capabilities share a consistent authentication mechanism using the Smart Search Token. In v2, each functionality is also exposed through MCP Tools, allowing seamless integration with agentic or modular environments.

---

Getting Started

Developers can utilize Smart Search SDK to build backend applications. You can use smart-search-sdk by adding smart-search-sdk in the development configuration. Please check out this link for more concrete examples.

Prerequisites

To add smart-search-sdk to your project, please ensure you already have:

• Python <3.13, >=3.11

• Poetry (recommended) or pip

---

Installation

Install the SDK by cloning from the GitHub repository.

git clone https://github.com/GDP-ADMIN/smart-search-sdk.git
cd smart-search-sdk/python/smart-search-sdk
pip install .

Once installed, you're ready to import Smart Search clients and start interacting with the platform.

The Smart Search SDK is organized into two main sections:

• Web Search SDK — Learn how to perform web searches, extract snippets, and summarize web pages.

• Connector SDK — Learn how to connect and search within third-party apps like Google Drive, Gmail, Calendar, and GitHub.

Each section provides:

• Setup instructions

• Parameter references

• Full code examples for direct use in your application