agsamantha/node_modules/@langchain/community/dist/tools/gmail/descriptions.d.ts
2024-10-02 15:15:21 -05:00

5 lines
4.3 KiB
TypeScript

export declare const CREATE_DRAFT_DESCRIPTION = "A tool for creating draft emails in Gmail.\n\nINPUT example:\n{\n \"message\": \"Hello, this is a test draft\",\n \"to\": [\"example1@email.com\", \"example2@email.com\"],\n \"subject\": \"Test Draft\",\n \"cc\": [\"cc1@email.com\"],\n \"bcc\": [\"bcc1@email.com\"]\n}\n\nOUTPUT:\nThe output is a confirmation message with the draft ID.\n";
export declare const GET_MESSAGE_DESCRIPTION = "A tool for retrieving a specific email message from Gmail using its message ID.\n\nINPUT example:\n{\n \"messageId\": \"unique_message_id_string\"\n}\n\nOUTPUT:\nThe output includes detailed information about the retrieved email message. This includes the subject, body, sender (from), recipients (to), date of the email, and the message ID. If any of these details are not available in the email, the tool will throw an error indicating the missing information.\n\nExample Output:\n\"Result for the prompt unique_message_id_string\n{\n 'subject': 'Email Subject',\n 'body': 'Email Body Content',\n 'from': 'sender@email.com',\n 'to': 'recipient@email.com',\n 'date': 'Email Date',\n 'messageId': 'unique_message_id_string'\n}\"\n";
export declare const GET_THREAD_DESCRIPTION = "A tool for retrieving an entire email thread from Gmail using the thread ID.\n\nINPUT example:\n{\n \"threadId\": \"unique_thread_id_string\"\n}\n\nOUTPUT:\nThe output includes an array of all the messages in the specified thread. Each message in the array contains detailed information including the subject, body, sender (from), recipients (to), date of the email, and the message ID. If any of these details are not available in a message, the tool will throw an error indicating the missing information.\n\nExample Output:\n\"Result for the prompt unique_thread_id_string\n[\n {\n 'subject': 'Email Subject',\n 'body': 'Email Body Content',\n 'from': 'sender@email.com',\n 'to': 'recipient@email.com',\n 'date': 'Email Date',\n 'messageId': 'unique_message_id_string'\n },\n ... (other messages in the thread)\n]\"\n";
export declare const SEND_MESSAGE_DESCRIPTION = "A tool for sending an email message using Gmail. It allows users to specify recipients, subject, and the content of the message, along with optional cc and bcc fields.\n\nINPUT example:\n{\n \"message\": \"Hello, this is a test email\",\n \"to\": [\"recipient1@email.com\", \"recipient2@email.com\"],\n \"subject\": \"Test Email\",\n \"cc\": [\"cc1@email.com\"],\n \"bcc\": [\"bcc1@email.com\"]\n}\n\nOUTPUT:\nThe output is a confirmation message with the ID of the sent email. If there is an error during the sending process, the tool will throw an error with a description of the problem.\n\nExample Output:\n\"Message sent. Message Id: unique_message_id_string\"\n";
export declare const SEARCH_DESCRIPTION = "A tool for searching email messages or threads in Gmail using a specific query. It offers the flexibility to choose between messages and threads as the search resource.\n\nINPUT example:\n{\n \"query\": \"specific search query\",\n \"maxResults\": 10, // Optional: number of results to return\n \"resource\": \"messages\" // Optional: can be \"messages\" or \"threads\"\n}\n\nOUTPUT:\nThe output is a JSON list of either email messages or threads, depending on the specified resource, that matches the search query. For 'messages', the output includes details like the message ID, thread ID, snippet, body, subject, and sender of each message. For 'threads', it includes the thread ID, snippet, body, subject, and sender of the first message in each thread. If no data is returned, or if the specified resource is invalid, the tool throws an error with a relevant message.\n\nExample Output for 'messages':\n\"Result for the query 'specific search query':\n[\n {\n 'id': 'message_id',\n 'threadId': 'thread_id',\n 'snippet': 'message snippet',\n 'body': 'message body',\n 'subject': 'message subject',\n 'sender': 'sender's email'\n },\n ... (other messages matching the query)\n]\"\n\nExample Output for 'threads':\n\"Result for the query 'specific search query':\n[\n {\n 'id': 'thread_id',\n 'snippet': 'thread snippet',\n 'body': 'first message body',\n 'subject': 'first message subject',\n 'sender': 'first message sender'\n },\n ... (other threads matching the query)\n]\"\n";