Skip to content

Commit 04b8838

Browse files
AngelosPAngelos Petropoulos
authored andcommitted
docs(azure): example for custom base URL (#1055)
Co-authored-by: Angelos Petropoulos <[email protected]>
1 parent e7d1fce commit 04b8838

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ export class AzureOpenAI extends OpenAI {
381381
* @param {string | undefined} [opts.apiKey=process.env['AZURE_OPENAI_API_KEY'] ?? undefined]
382382
* @param {string | undefined} opts.deployment - A model deployment, if given, sets the base client URL to include `/deployments/{deployment}`.
383383
* @param {string | null | undefined} [opts.organization=process.env['OPENAI_ORG_ID'] ?? null]
384-
* @param {string} [opts.baseURL=process.env['OPENAI_BASE_URL']] - Sets the base URL for the API.
384+
* @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/`.
385385
* @param {number} [opts.timeout=10 minutes] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
386386
* @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections.
387387
* @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.

0 commit comments

Comments
 (0)