Added Outlook integration toolkit

docs/core_docs/docs/integrations/toolkits/outlook.mdx

@@ -0,0 +1,154 @@
+import CodeBlock from "@theme/CodeBlock";
+
+# Outlook Toolkit
+
+## Overview
+
+Using this toolkit, you can integrate Microsoft Graph API functionalities into
+your applications to manage email interactions.
+
+## Learn Microsoft Graph
+
+Microsoft Graph is a RESTful web API that enables you to access Microsoft
+Cloud service resources. With Microsoft Graph, you can integrate various
+Microsoft services and data, including users' emails, calendar, contacts,
+and more, into your applications.
+
+After you register your app and get authentication tokens for a user or service,
+you can make requests to the Microsoft Graph API.
+
+How to get authentication tokens for a user:  
+https://learn.microsoft.com/en-us/graph/auth-v2-user
+
+## Set up
+
+An `accessToken` is needed to use the Outlook Toolkit.
+
+You need to first register an application in Azure Portal to obtain
+necessary credentials.
+
+### App register
+
+1. Register an Application:
+
+   - Go to Azure Portal.
+   - Navigate to Azure Active Directory -> App registrations.
+   - Register a new application, note down the Client ID.
+
+2. Generate Client Secret:
+
+   - In the application settings, go to Certificates & Secrets.
+   - Create a new client secret and note down the Client Secret.
+
+3. Configure Redirect URI:
+
+   - In the application settings, go to Authentication.
+   - Add a Redirect URI and note down the Redirect URI.
+
+4. Permissions and Admin Consent:
+   - In API permissions, grant necessary permissions for Microsoft Graph API or
+     Outlook API.
+   - Grant admin consent for the added permissions.
+
+At this point, you should have these three credentials:
+clientId, clientSecret, redirectUri
+
+Set them as environment variables:
+
+```env
+OUTLOOK_CLIENT_ID=your_client_id
+OUTLOOK_CLIENT_SECRET=your_client_secret
+OUTLOOK_REDIRECT_URI=your_redirect_uri
+```
+
+**Keep these values secure and avoid exposing them in public repositories.**
+
+The following link from Microsoft is a good reference for the above steps:
+https://learn.microsoft.com/en-us/graph/auth-v2-user
+
+This video may also be helpful:
+https://www.youtube.com/watch?v=NAtiNpwnivI&t=309s
+
+### Get an accessToken
+
+Now you are able to use the above credentials to get an `accessToken`.
+
+The `AuthFlowREST` class implements the OAuth 2.0 authorization code flow.
+You can use the `getAccessToken()` which will open a temporary server on
+your `redirectUri` and you need to manually open the printed link to login
+on behalf of the user. For every `AuthFlowREST` instance, you only need to
+login once. The next time you can run the `getAccessToken()` method, it will
+make use of the `refreshToken` obtained together with the first `accessToken`
+to get a new `accessToken` without the need of the server and login.
+
+Having the above credentials, you can either pass them to the constructor
+or put them in the environment.
+
+```typescript
+import { AuthFlowREST } from "@langchain/community/tools/outlook";
+
+const authFlow = new AuthFlowREST();
+const authFlow = new AuthFlowREST(clientId, clientSecret, redirectUri);
+// Get accessToken
+const accessToken = await authFlow.getAccessToken();
+// After the above line, you can get the refreshToken
+const refreshToken = authFlow.getRefreshToken();
+// Get accessToken again without login
+const accessToken = await authFlow.getAccessToken();
+```
+
+Now you can set the `accessToken` and `refreshToken` as environment variable:
+
+```env
+OUTLOOK_ACCESS_TOKEN=your_access_token
+OUTLOOK_REFRESH_TOKEN=your_refresh_token
+```
+
+### Provide accessToken to Outlook Toolkit
+
+The Outlook Toolkit needs `AuthFlowBase` abstarct class to provide accessToken.
+
+```typescript
+const authFlow = new AuthFlowREST();
+const outlookReadMail = new OutlookReadMailTool(authFlow);
+// or simply this when you have the credentials in .env
+const outlookReadMail = new OutlookReadMailTool(undefined, "rest");
+```
+
+### Other classes to provide accessToken
+
+If you only have a valid `accessToken` in your env, you can use `AuthFlowToken`:
+
+```typescript
+const authFlow = new AuthFlowToken(accessToken);
+// if you have accessToken stored in .env
+const authFlow = new AuthFlowToken();
+const outlookReadMail = new OutlookReadMailTool(authFlow);
+// or simply this when you have accessToken in .env
+const outlookReadMail = new OutlookReadMailTool(undefined, "token");
+```
+
+Usually when you obtain a accessToken you also get a refreshToken
+used to refresh expired accessToken. The `AuthFlowRefresh` class needs
+the following credentials: `clientId`, `clientSecret`, `redirectUri`
+and `refreshToken`. In this way you won't need to login, no server
+will be open.
+
+```typescript
+const authFlow = new AuthFlowRefresh();
+const outlookReadMail = new OutlookReadMailTool(authFlow);
+// or simply this when you have the credentials in .env
+const outlookReadMail = new OutlookReadMailTool(undefined, "refresh");
+```
+
+### Customize your own authentication flow
+
+Inherit from `AuthFlowBase` and implement the `getAccessToken()` method.
+
+## Usage
+
+These two examples show how to readand send emails by using agent.
+
+import ToolExample from "@examples/tools/outlook.ts";
+
+<CodeBlock language="typescript">{ToolExample}</CodeBlock>

examples/src/tools/outlook.ts

@@ -0,0 +1,68 @@
+import {
+  OutlookReadMailTool,
+  OutlookSendMailTool,
+} from "@langchain/community/tools/outlook";
+import { ChatOpenAI } from "@langchain/openai";
+import type { ChatPromptTemplate } from "@langchain/core/prompts";
+import { pull } from "langchain/hub";
+import { AgentExecutor, createOpenAIFunctionsAgent } from "langchain/agents";
+
+async function AgentRead() {
+  const llm = new ChatOpenAI({
+    modelName: "gpt-3.5-turbo-1106",
+  });
+
+  const outlookReadMail = new OutlookReadMailTool(undefined, "token");
+  const tools = [outlookReadMail];
+  const prompt = await pull<ChatPromptTemplate>(
+    "hwchase17/openai-functions-agent"
+  );
+
+  const agent = await createOpenAIFunctionsAgent({
+    llm,
+    tools,
+    prompt,
+  });
+
+  const agentExecutor = new AgentExecutor({
+    agent,
+    tools,
+  });
+
+  const input = "show my emails";
+  const result = await agentExecutor.invoke({ input });
+
+  console.log(result);
+}
+
+AgentRead();
+
+async function AgentSend() {
+  const llm = new ChatOpenAI({
+    modelName: "gpt-4",
+  });
+
+  const sendMailTool = new OutlookSendMailTool(undefined, "token");
+  const tools = [sendMailTool];
+  const prompt = await pull<ChatPromptTemplate>(
+    "hwchase17/openai-functions-agent"
+  );
+
+  const agent = await createOpenAIFunctionsAgent({
+    llm,
+    tools,
+    prompt,
+  });
+  const agentExecutor = new AgentExecutor({
+    agent,
+    tools,
+  });
+
+  const input =
+    "send an email to YOUR_EMAIL and invite him to a meeting at 3pm tomorrow";
+  const result = await agentExecutor.invoke({ input });
+
+  console.log(result);
+}
+
+AgentSend();

langchain/.env.example

@@ -92,6 +92,11 @@ NEO4J_USERNAME=ADD_YOURS_HERE
 NEO4J_PASSWORD=ADD_YOURS_HERE
 CLOSEVECTOR_API_KEY=ADD_YOURS_HERE
 CLOSEVECTOR_API_SECRET=ADD_YOURS_HERE
+OUTLOOK_CLIENT_ID=ADD_YOURS_HERE
+OUTLOOK_CLIENT_SECRET=ADD_YOURS_HERE
+OUTLOOK_REDIRECT_URI=ADD_YOURS_HERE
+OUTLOOK_REFRESH_TOKEN=ADD_YOURS_HERE
+OUTLOOK_ACCESS_TOKEN=ADD_YOURS_HERE
 GPLACES_API_KEY=ADD_YOURS_HERE
 CONFLUENCE_USERNAME=ADD_YOURS_HERE
 CONFLUENCE_PASSWORD=ADD_YOURS_HERE

libs/langchain-community/.gitignore

@@ -49,6 +49,9 @@ tools/google_places.d.ts
 tools/ifttt.cjs
 tools/ifttt.js
 tools/ifttt.d.ts
+tools/outlook.cjs
+tools/outlook.js
+tools/outlook.d.ts
 tools/searchapi.cjs
 tools/searchapi.js
 tools/searchapi.d.ts

libs/langchain-community/package.json

@@ -567,6 +567,11 @@
       "import": "./tools/ifttt.js",
       "require": "./tools/ifttt.cjs"
     },
+    "./tools/outlook": {
+      "types": "./tools/outlook.d.ts",
+      "import": "./tools/outlook.js",
+      "require": "./tools/outlook.cjs"
+    },
     "./tools/searchapi": {
       "types": "./tools/searchapi.d.ts",
       "import": "./tools/searchapi.js",
@@ -1362,6 +1367,9 @@
     "tools/ifttt.cjs",
     "tools/ifttt.js",
     "tools/ifttt.d.ts",
+    "tools/outlook.cjs",
+    "tools/outlook.js",
+    "tools/outlook.d.ts",
     "tools/searchapi.cjs",
     "tools/searchapi.js",
     "tools/searchapi.d.ts",

libs/langchain-community/scripts/create-entrypoints.js

@@ -26,6 +26,7 @@ const entrypoints = {
   "tools/google_custom_search": "tools/google_custom_search",
   "tools/google_places": "tools/google_places",
   "tools/ifttt": "tools/ifttt",
+  "tools/outlook": "tools/outlook/index",
   "tools/searchapi": "tools/searchapi",
   "tools/searxng_search": "tools/searxng_search",
   "tools/serpapi": "tools/serpapi",
@@ -203,6 +204,7 @@ const requiresOptionalDependency = [
   "tools/aws_lambda",
   "tools/discord",
   "tools/gmail",
+  "tools/outlook",
   "tools/google_calendar",
   "agents/toolkits/aws_sfn",
   "callbacks/handlers/llmonitor",

libs/langchain-community/src/load/import_constants.ts

@@ -6,6 +6,7 @@ export const optionalImportEntrypoints = [
   "langchain_community/tools/discord",
   "langchain_community/tools/gmail",
   "langchain_community/tools/google_calendar",
+  "langchain_community/tools/outlook",
   "langchain_community/agents/toolkits/aws_sfn",
   "langchain_community/embeddings/bedrock",
   "langchain_community/embeddings/cloudflare_workersai",

libs/langchain-community/src/load/import_type.d.ts

@@ -16,6 +16,9 @@ export interface OptionalImportMap {
   "@langchain/community/tools/google_calendar"?:
     | typeof import("../tools/google_calendar/index.js")
     | Promise<typeof import("../tools/google_calendar/index.js")>;
+  "@langchain/community/tools/outlook"?:
+    | typeof import("../tools/outlook/index.js")
+    | Promise<typeof import("../tools/outlook/index.js")>;
   "@langchain/community/agents/toolkits/aws_sfn"?:
     | typeof import("../agents/toolkits/aws_sfn.js")
     | Promise<typeof import("../agents/toolkits/aws_sfn.js")>;

libs/langchain-community/src/tools/outlook/auth/base.ts

@@ -0,0 +1,43 @@
+/**
+ * Base class for handling authentication flows.
+ *
+ * @class AuthFlowBase
+ */
+export abstract class AuthFlowBase {
+  /**
+   * The client ID used for authentication.
+   *
+   * @protected
+   * @type {string}
+   * @memberof AuthFlowBase
+   */
+  protected clientId: string;
+
+  /**
+   * The access token obtained through authentication.
+   *
+   * @protected
+   * @type {string}
+   * @memberof AuthFlowBase
+   */
+  protected accessToken = "";
+
+  /**
+   * Creates an instance of AuthFlowBase.
+   *
+   * @param {string} clientId - The client ID for authentication.
+   * @memberof AuthFlowBase
+   */
+  constructor(clientId: string) {
+    this.clientId = clientId;
+  }
+
+  /**
+   * Abstract method to get the access token.
+   *
+   * @abstract
+   * @returns {Promise<string>} A promise that resolves to the access token.
+   * @memberof AuthFlowBase
+   */
+  public abstract getAccessToken(): Promise<string>;
+}