Skip to main content

Docs: Get Document 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:docs:get_document

Tool description: Get a document from Google Docs in plain text format by ID. The GoogleDriveSearchTool should be used to search for a document by name if an ID is not known.

Args schema:

{
"description": "Schema for the Google Docs get document tool.",
"properties": {
"document_id": {
"description": "The ID of the document to get. It can contain letters, numbers, and some special characters.",
"title": "Document Id",
"type": "string"
}
},
"required": [
"document_id"
],
"title": "GoogleDocsGetDocumentToolSchema",
"type": "object"
}

Output schema:

('str', 'str: The content of the document in plain text format.')