Contacts: Search Tool

Usage

All Portia tools using API endpoints that require OAuth are built with plug and play authentication support. They use Portia client credentials including client ID, client name and redirect URL. Such tools will raise a Action Clarification with an OAuth link as the action URL. The portia.wait_for_ready() method must be used in this scenario: Portia's OAuth server will listen for the authentication result and resolve the concerned clarification, allowing your plan run to resume again.

For more on this, please visit to the section on running Portia tools (↗).

Tool details

Tool ID: portia:google:people:search_contacts

Tool description: Finds the most relevant matching contacts.

Args schema:

{
  "description": "Schema for retrieving contacts from the Google People API.",
  "properties": {
    "search_term": {
      "description": "The term to search for in the contacts.",
      "title": "Search Term",
      "type": "string"
    }
  },
  "required": [
    "search_term"
  ],
  "title": "GooglePeopleSearchContactsSchema",
  "type": "object"
}

Output schema:

('dict[str, list[dict[str,str]]]', "Dict with a key 'contacts' and a list of dicts, each with 'name' and 'email' keys.")