From d2c512d7967696b73e64db91a2c89d645433e4be Mon Sep 17 00:00:00 2001
From: Angelos Petropoulos <angelpe@microsoft.com>
Date: Tue, 10 Sep 2024 17:42:52 -0500
Subject: [PATCH] Improved comment for AzureOpenAI's baseURL

---
 src/index.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/index.ts b/src/index.ts
index c0e527d25..36064286d 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -381,7 +381,7 @@ export class AzureOpenAI extends OpenAI {
    * @param {string | undefined} [opts.apiKey=process.env['AZURE_OPENAI_API_KEY'] ?? undefined]
    * @param {string | undefined} opts.deployment - A model deployment, if given, sets the base client URL to include `/deployments/{deployment}`.
    * @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null]
-   * @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL']] - Sets the base URL for the API.
+   * @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL']] - Sets the base URL for the API, e.g. `https://example-resource.azure.openai.com/openai/`.
    * @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
    * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.