Adds docs on passing custom headers to OAI model

Author: jacoblee93

docs/core_docs/docs/integrations/chat/azure.ipynb

@@ -324,6 +324,48 @@
     "});\n"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "id": "092e7a38",
+   "metadata": {},
+   "source": [
+    "## Custom headers\n",
+    "\n",
+    "You can specify custom headers by passing in a `configuration` field:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "43503a94",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import { AzureChatOpenAI } from \"@langchain/openai\";\n",
+    "\n",
+    "const llmWithCustomHeaders = new AzureChatOpenAI({\n",
+    "  azureOpenAIApiKey: process.env.AZURE_OPENAI_API_KEY, // In Node.js defaults to process.env.AZURE_OPENAI_API_KEY\n",
+    "  azureOpenAIApiInstanceName: process.env.AZURE_OPENAI_API_INSTANCE_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_INSTANCE_NAME\n",
+    "  azureOpenAIApiDeploymentName: process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME, // In Node.js defaults to process.env.AZURE_OPENAI_API_DEPLOYMENT_NAME\n",
+    "  azureOpenAIApiVersion: process.env.AZURE_OPENAI_API_VERSION, // In Node.js defaults to process.env.AZURE_OPENAI_API_VERSION\n",
+    "  configuration: {\n",
+    "    defaultHeaders: {\n",
+    "      \"x-custom-header\": `SOME_VALUE`,\n",
+    "    },\n",
+    "  },\n",
+    "});\n",
+    "\n",
+    "await llmWithCustomHeaders.invoke(\"Hi there!\");"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "1a6b849d",
+   "metadata": {},
+   "source": [
+    "The `configuration` field also accepts other `ClientOptions` parameters accepted by the official SDK."
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "0ac0310c",

docs/core_docs/docs/integrations/chat/openai.ipynb

@@ -272,13 +272,44 @@
   },
   {
    "cell_type": "markdown",
-   "id": "013b6300",
+   "id": "20b60ccb",
    "metadata": {},
    "source": [
-    "You can also pass other `ClientOptions` parameters accepted by the official SDK here.\n",
+    "The `configuration` field also accepts other `ClientOptions` parameters accepted by the official SDK.\n",
     "\n",
     "If you are hosting on Azure OpenAI, see the [dedicated page instead](/docs/integrations/chat/azure).\n",
     "\n",
+    "## Custom headers\n",
+    "\n",
+    "You can specify custom headers in the same `configuration` field:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "cd612609",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import { ChatOpenAI } from \"@langchain/openai\";\n",
+    "\n",
+    "const llmWithCustomHeaders = new ChatOpenAI({\n",
+    "  temperature: 0.9,\n",
+    "  configuration: {\n",
+    "    defaultHeaders: {\n",
+    "      \"Authorization\": `Bearer SOME_CUSTOM_VALUE`,\n",
+    "    },\n",
+    "  },\n",
+    "});\n",
+    "\n",
+    "await llmWithCustomHeaders.invoke(\"Hi there!\");"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "013b6300",
+   "metadata": {},
+   "source": [
     "## Calling fine-tuned models\n",
     "\n",
     "You can call fine-tuned OpenAI models by passing in your corresponding `modelName` parameter.\n",
@@ -411,7 +442,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "bc5ecebd",
+   "id": "3a5bb5ca-c3ae-4a58-be67-2cd18574b9a3",
    "metadata": {},
    "source": [
     "## Tool calling\n",
@@ -420,82 +451,8 @@
     "\n",
     "- [How to: disable parallel tool calling](/docs/how_to/tool_calling_parallel/)\n",
     "- [How to: force a tool call](/docs/how_to/tool_choice/)\n",
-    "- [How to: bind model-specific tool formats to a model](/docs/how_to/tool_calling#binding-model-specific-formats-advanced)."
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "3392390e",
-   "metadata": {},
-   "source": [
-    "### ``strict: true``\n",
-    "\n",
-    "```{=mdx}\n",
+    "- [How to: bind model-specific tool formats to a model](/docs/how_to/tool_calling#binding-model-specific-formats-advanced).\n",
     "\n",
-    ":::info Requires ``@langchain/openai >= 0.2.6``\n",
-    "\n",
-    "As of Aug 6, 2024, OpenAI supports a `strict` argument when calling tools that will enforce that the tool argument schema is respected by the model. See more here: https://platform.openai.com/docs/guides/function-calling\n",
-    "\n",
-    "**Note**: If ``strict: true`` the tool definition will also be validated, and a subset of JSON schema are accepted. Crucially, schema cannot have optional args (those with default values). Read the full docs on what types of schema are supported here: https://platform.openai.com/docs/guides/structured-outputs/supported-schemas. \n",
-    ":::\n",
-    "\n",
-    "\n",
-    "```"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 1,
-   "id": "90f0d465",
-   "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "[\n",
-      "  {\n",
-      "    name: 'get_current_weather',\n",
-      "    args: { location: 'Hanoi' },\n",
-      "    type: 'tool_call',\n",
-      "    id: 'call_aB85ybkLCoccpzqHquuJGH3d'\n",
-      "  }\n",
-      "]\n"
-     ]
-    }
-   ],
-   "source": [
-    "import { ChatOpenAI } from \"@langchain/openai\";\n",
-    "import { tool } from \"@langchain/core/tools\";\n",
-    "import { z } from \"zod\";\n",
-    "\n",
-    "const weatherTool = tool((_) => \"no-op\", {\n",
-    "  name: \"get_current_weather\",\n",
-    "  description: \"Get the current weather\",\n",
-    "  schema: z.object({\n",
-    "    location: z.string(),\n",
-    "  }),\n",
-    "})\n",
-    "\n",
-    "const llmWithStrictTrue = new ChatOpenAI({\n",
-    "  model: \"gpt-4o\",\n",
-    "}).bindTools([weatherTool], {\n",
-    "  strict: true,\n",
-    "  tool_choice: weatherTool.name,\n",
-    "});\n",
-    "\n",
-    "// Although the question is not about the weather, it will call the tool with the correct arguments\n",
-    "// because we passed `tool_choice` and `strict: true`.\n",
-    "const strictTrueResult = await llmWithStrictTrue.invoke(\"What is 127862 times 12898 divided by 2?\");\n",
-    "\n",
-    "console.dir(strictTrueResult.tool_calls, { depth: null });"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "id": "3a5bb5ca-c3ae-4a58-be67-2cd18574b9a3",
-   "metadata": {},
-   "source": [
     "## API reference\n",
     "\n",
     "For detailed documentation of all ChatOpenAI features and configurations head to the API reference: https://api.js.langchain.com/classes/langchain_openai.ChatOpenAI.html"