@azure/ai-projects 1.0.0-beta.5 → 1.0.0-beta.7

package/dist/browser/api/inference/enableTelemetry.js

@@ -0,0 +1,185 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import * as opentelemetry from "@opentelemetry/api";
+import { registerInstrumentations } from "@opentelemetry/instrumentation";
+import { createAzureSdkInstrumentation } from "@azure/opentelemetry-instrumentation-azure-sdk";
+import { OpenAIInstrumentation } from "@traceloop/instrumentation-openai";
+import { LangChainInstrumentation } from "@traceloop/instrumentation-langchain";
+import { ConsoleSpanExporter, NodeTracerProvider, SimpleSpanProcessor, } from "@opentelemetry/sdk-trace-node";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-grpc";
+import { logs } from "@opentelemetry/api-logs";
+import { LoggerProvider, SimpleLogRecordProcessor, ConsoleLogRecordExporter, } from "@opentelemetry/sdk-logs";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
+import { logger } from "../../logger.js";
+/**
+ * Enables telemetry collection with OpenTelemetry for Azure AI clients and popular GenAI libraries.
+ *
+ * Following instrumentations are enabled (when corresponding packages are installed):
+ * - Azure AI Agents (`@azure/ai-agents`)
+ * - Azure AI Inference (`@azure-rest/ai-inference`)
+ * - OpenAI (`@traceloop/instrumentation-openai`)
+ * - Langchain (`@traceloop/instrumentation-langchain`)
+ *
+ * When destination is provided, the method configures OpenTelemetry SDK to export traces to
+ * stdout or OTLP (OpenTelemetry protocol) gRPC endpoint. It's recommended for local
+ * development only. For production use, make sure to configure OpenTelemetry SDK directly.
+ *
+ * @param destination - Recommended for local testing only. Set it to `"stdout"` for
+ *        tracing to console output, or a string holding the OpenTelemetry protocol (OTLP)
+ *        endpoint such as "http://localhost:4317".
+ *        If not provided, the method enables instrumentations, but does not configure OpenTelemetry
+ *        SDK to export traces.
+ */
+export function enableTelemetry(destination) {
+    const spanExporter = getTraceExporter(destination);
+    configureTracing(spanExporter);
+    const logExporter = getLogExporter(destination);
+    configureLogging(logExporter);
+    // Try to configure Azure SDK tracing and instrument AI Inference
+    try {
+        registerInstrumentations({
+            instrumentations: [createAzureSdkInstrumentation()],
+        });
+    }
+    catch (error) {
+        logger.warning("Could not register `createAzureSdkInstrumentation()`");
+    }
+    // TODO: Try to instrument AI Agents
+    // Try to instrument OpenAI
+    try {
+        registerInstrumentations({
+            instrumentations: [new OpenAIInstrumentation()],
+        });
+    }
+    catch (error) {
+        logger.warning("Could not register `new OpenAIInstrumentation()`");
+    }
+    // Try to instrument Langchain
+    try {
+        registerInstrumentations({
+            instrumentations: [new LangChainInstrumentation()],
+        });
+    }
+    catch (error) {
+        logger.warning("Could not call LangchainInstrumentor().instrument()` since " +
+            "`@traceloop/instrumentation-langchain` is not installed");
+    }
+}
+/**
+ * Gets the appropriate trace exporter based on the destination
+ * @param destination - The destination for exporting traces
+ * @returns The trace exporter instance or undefined
+ */
+function getTraceExporter(destination) {
+    if (!destination) {
+        return undefined;
+    }
+    try {
+        if (destination === "stdout") {
+            return new ConsoleSpanExporter();
+        }
+        else if (typeof destination === "string") {
+            return new OTLPTraceExporter({ url: destination });
+        }
+    }
+    catch (error) {
+        logger.error("Failed to create trace exporter", error);
+        return undefined;
+    }
+    return undefined;
+}
+/**
+ * Gets the appropriate log exporter based on the destination
+ * @param destination - The destination for exporting logs
+ * @returns The log exporter instance or undefined
+ */
+function getLogExporter(destination) {
+    if (!destination) {
+        return undefined;
+    }
+    try {
+        if (destination === "stdout") {
+            return new ConsoleLogRecordExporter();
+        }
+        else if (typeof destination === "string") {
+            return new OTLPLogExporter({ url: destination });
+        }
+    }
+    catch (error) {
+        logger.warning("Failed to configure OpenTelemetry logging exporter.");
+        return undefined;
+    }
+    return undefined;
+}
+/**
+ * Configures OpenTelemetry tracing
+ * @param spanExporter - The span exporter to use
+ */
+function configureTracing(spanExporter) {
+    if (!spanExporter) {
+        return;
+    }
+    try {
+        let provider;
+        // Check if tracing was not set up before
+        try {
+            const existingProvider = opentelemetry.trace.getTracerProvider();
+            // Check if the provider is already a NodeTracerProvider by checking for addSpanProcessor method
+            if (!("register" in existingProvider) ||
+                typeof existingProvider.register !== "function" ||
+                existingProvider.register.name !== "register") {
+                // If the provider is not a NodeTracerProvider, we need to set up a new provider
+                provider = new NodeTracerProvider({
+                    spanProcessors: [new SimpleSpanProcessor(spanExporter)],
+                });
+                provider.register();
+            }
+            else {
+                // If the provider is already a NodeTracerProvider, we can use it
+                provider = existingProvider;
+            }
+        }
+        catch (error) {
+            // If we get here, we need to set up a new provider
+            provider = new NodeTracerProvider({
+                spanProcessors: [new SimpleSpanProcessor(spanExporter)],
+            });
+            provider.register();
+        }
+    }
+    catch (error) {
+        throw error;
+    }
+}
+/**
+ * Configures OpenTelemetry logging
+ * @param logExporter - The log exporter to use
+ */
+function configureLogging(logExporter) {
+    if (!logExporter) {
+        return;
+    }
+    try {
+        let loggerProvider;
+        try {
+            const existingProvider = logs.getLoggerProvider();
+            if (!(existingProvider instanceof LoggerProvider)) {
+                loggerProvider = new LoggerProvider();
+                logs.setGlobalLoggerProvider(loggerProvider);
+            }
+            else {
+                loggerProvider = existingProvider;
+            }
+        }
+        catch (error) {
+            // If we get here, we need to set up a new provider
+            loggerProvider = new LoggerProvider();
+            logs.setGlobalLoggerProvider(loggerProvider);
+        }
+        loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(logExporter));
+    }
+    catch (error) {
+        logger.warning("Failed to configure OpenTelemetry logging. This might be because OpenTelemetry logs API is still experimental.");
+    }
+}
+//# sourceMappingURL=enableTelemetry.js.map

package/dist/browser/api/inference/enableTelemetry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enableTelemetry.js","sourceRoot":"","sources":["../../../../src/api/inference/enableTelemetry.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,6BAA6B,EAAE,MAAM,gDAAgD,CAAC;AAC/F,OAAO,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC1E,OAAO,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAChF,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AAC5E,OAAO,EAAE,IAAI,EAAE,MAAM,yBAAyB,CAAC;AAC/C,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAEzC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,eAAe,CAAC,WAAoB;IAClD,MAAM,YAAY,GAAG,gBAAgB,CAAC,WAAW,CAAC,CAAC;IACnD,gBAAgB,CAAC,YAAY,CAAC,CAAC;IAE/B,MAAM,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC;IAChD,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAE9B,iEAAiE;IACjE,IAAI,CAAC;QACH,wBAAwB,CAAC;YACvB,gBAAgB,EAAE,CAAC,6BAA6B,EAAE,CAAC;SACpD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,CAAC,sDAAsD,CAAC,CAAC;IACzE,CAAC;IAED,oCAAoC;IAEpC,2BAA2B;IAC3B,IAAI,CAAC;QACH,wBAAwB,CAAC;YACvB,gBAAgB,EAAE,CAAC,IAAI,qBAAqB,EAAE,CAAC;SAChD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,CAAC,kDAAkD,CAAC,CAAC;IACrE,CAAC;IAED,8BAA8B;IAC9B,IAAI,CAAC;QACH,wBAAwB,CAAC;YACvB,gBAAgB,EAAE,CAAC,IAAI,wBAAwB,EAAE,CAAC;SACnD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,CACZ,6DAA6D;YAC3D,yDAAyD,CAC5D,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAS,gBAAgB,CACvB,WAAoB;IAEpB,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC;QACH,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,mBAAmB,EAAE,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3C,OAAO,IAAI,iBAAiB,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;QACvD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,SAAS,cAAc,CACrB,WAAoB;IAEpB,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,CAAC;QACH,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,IAAI,wBAAwB,EAAE,CAAC;QACxC,CAAC;aAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3C,OAAO,IAAI,eAAe,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,CAAC,qDAAqD,CAAC,CAAC;QACtE,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,YAAsD;IAC9E,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,IAAI,QAA4B,CAAC;QACjC,yCAAyC;QACzC,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,aAAa,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;YACjE,gGAAgG;YAChG,IACE,CAAC,CAAC,UAAU,IAAI,gBAAgB,CAAC;gBACjC,OAAO,gBAAgB,CAAC,QAAQ,KAAK,UAAU;gBAC/C,gBAAgB,CAAC,QAAQ,CAAC,IAAI,KAAK,UAAU,EAC7C,CAAC;gBACD,gFAAgF;gBAChF,QAAQ,GAAG,IAAI,kBAAkB,CAAC;oBAChC,cAAc,EAAE,CAAC,IAAI,mBAAmB,CAAC,YAA4B,CAAC,CAAC;iBACxE,CAAC,CAAC;gBACH,QAAQ,CAAC,QAAQ,EAAE,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,iEAAiE;gBACjE,QAAQ,GAAG,gBAAsC,CAAC;YACpD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,mDAAmD;YACnD,QAAQ,GAAG,IAAI,kBAAkB,CAAC;gBAChC,cAAc,EAAE,CAAC,IAAI,mBAAmB,CAAC,YAA4B,CAAC,CAAC;aACxE,CAAC,CAAC;YACH,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,KAAc,CAAC;IACvB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB,CAAC,WAAwD;IAChF,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,IAAI,cAA8B,CAAC;QACnC,IAAI,CAAC;YACH,MAAM,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAClD,IAAI,CAAC,CAAC,gBAAgB,YAAY,cAAc,CAAC,EAAE,CAAC;gBAClD,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;gBACtC,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,cAAc,GAAG,gBAAkC,CAAC;YACtD,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,mDAAmD;YACnD,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;YACtC,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;QAC/C,CAAC;QAED,cAAc,CAAC,qBAAqB,CAAC,IAAI,wBAAwB,CAAC,WAAW,CAAC,CAAC,CAAC;IAClF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,OAAO,CACZ,gHAAgH,CACjH,CAAC;IACJ,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport * as opentelemetry from \"@opentelemetry/api\";\nimport { registerInstrumentations } from \"@opentelemetry/instrumentation\";\nimport { createAzureSdkInstrumentation } from \"@azure/opentelemetry-instrumentation-azure-sdk\";\nimport { OpenAIInstrumentation } from \"@traceloop/instrumentation-openai\";\nimport { LangChainInstrumentation } from \"@traceloop/instrumentation-langchain\";\nimport {\n  ConsoleSpanExporter,\n  NodeTracerProvider,\n  SimpleSpanProcessor,\n} from \"@opentelemetry/sdk-trace-node\";\nimport type { SpanExporter } from \"@opentelemetry/sdk-trace-node\";\nimport { OTLPTraceExporter } from \"@opentelemetry/exporter-trace-otlp-grpc\";\nimport { logs } from \"@opentelemetry/api-logs\";\nimport {\n  LoggerProvider,\n  SimpleLogRecordProcessor,\n  ConsoleLogRecordExporter,\n} from \"@opentelemetry/sdk-logs\";\nimport { OTLPLogExporter } from \"@opentelemetry/exporter-logs-otlp-grpc\";\nimport { logger } from \"../../logger.js\";\n\n/**\n * Enables telemetry collection with OpenTelemetry for Azure AI clients and popular GenAI libraries.\n *\n * Following instrumentations are enabled (when corresponding packages are installed):\n * - Azure AI Agents (`@azure/ai-agents`)\n * - Azure AI Inference (`@azure-rest/ai-inference`)\n * - OpenAI (`@traceloop/instrumentation-openai`)\n * - Langchain (`@traceloop/instrumentation-langchain`)\n *\n * When destination is provided, the method configures OpenTelemetry SDK to export traces to\n * stdout or OTLP (OpenTelemetry protocol) gRPC endpoint. It's recommended for local\n * development only. For production use, make sure to configure OpenTelemetry SDK directly.\n *\n * @param destination - Recommended for local testing only. Set it to `\"stdout\"` for\n *        tracing to console output, or a string holding the OpenTelemetry protocol (OTLP)\n *        endpoint such as \"http://localhost:4317\".\n *        If not provided, the method enables instrumentations, but does not configure OpenTelemetry\n *        SDK to export traces.\n */\nexport function enableTelemetry(destination?: string): void {\n  const spanExporter = getTraceExporter(destination);\n  configureTracing(spanExporter);\n\n  const logExporter = getLogExporter(destination);\n  configureLogging(logExporter);\n\n  // Try to configure Azure SDK tracing and instrument AI Inference\n  try {\n    registerInstrumentations({\n      instrumentations: [createAzureSdkInstrumentation()],\n    });\n  } catch (error) {\n    logger.warning(\"Could not register `createAzureSdkInstrumentation()`\");\n  }\n\n  // TODO: Try to instrument AI Agents\n\n  // Try to instrument OpenAI\n  try {\n    registerInstrumentations({\n      instrumentations: [new OpenAIInstrumentation()],\n    });\n  } catch (error) {\n    logger.warning(\"Could not register `new OpenAIInstrumentation()`\");\n  }\n\n  // Try to instrument Langchain\n  try {\n    registerInstrumentations({\n      instrumentations: [new LangChainInstrumentation()],\n    });\n  } catch (error) {\n    logger.warning(\n      \"Could not call LangchainInstrumentor().instrument()` since \" +\n        \"`@traceloop/instrumentation-langchain` is not installed\",\n    );\n  }\n}\n\n/**\n * Gets the appropriate trace exporter based on the destination\n * @param destination - The destination for exporting traces\n * @returns The trace exporter instance or undefined\n */\nfunction getTraceExporter(\n  destination?: string,\n): ConsoleSpanExporter | OTLPTraceExporter | undefined {\n  if (!destination) {\n    return undefined;\n  }\n\n  try {\n    if (destination === \"stdout\") {\n      return new ConsoleSpanExporter();\n    } else if (typeof destination === \"string\") {\n      return new OTLPTraceExporter({ url: destination });\n    }\n  } catch (error) {\n    logger.error(\"Failed to create trace exporter\", error);\n    return undefined;\n  }\n\n  return undefined;\n}\n\n/**\n * Gets the appropriate log exporter based on the destination\n * @param destination - The destination for exporting logs\n * @returns The log exporter instance or undefined\n */\nfunction getLogExporter(\n  destination?: string,\n): ConsoleLogRecordExporter | OTLPLogExporter | undefined {\n  if (!destination) {\n    return undefined;\n  }\n\n  try {\n    if (destination === \"stdout\") {\n      return new ConsoleLogRecordExporter();\n    } else if (typeof destination === \"string\") {\n      return new OTLPLogExporter({ url: destination });\n    }\n  } catch (error) {\n    logger.warning(\"Failed to configure OpenTelemetry logging exporter.\");\n    return undefined;\n  }\n\n  return undefined;\n}\n\n/**\n * Configures OpenTelemetry tracing\n * @param spanExporter - The span exporter to use\n */\nfunction configureTracing(spanExporter?: ConsoleSpanExporter | OTLPTraceExporter): void {\n  if (!spanExporter) {\n    return;\n  }\n\n  try {\n    let provider: NodeTracerProvider;\n    // Check if tracing was not set up before\n    try {\n      const existingProvider = opentelemetry.trace.getTracerProvider();\n      // Check if the provider is already a NodeTracerProvider by checking for addSpanProcessor method\n      if (\n        !(\"register\" in existingProvider) ||\n        typeof existingProvider.register !== \"function\" ||\n        existingProvider.register.name !== \"register\"\n      ) {\n        // If the provider is not a NodeTracerProvider, we need to set up a new provider\n        provider = new NodeTracerProvider({\n          spanProcessors: [new SimpleSpanProcessor(spanExporter as SpanExporter)],\n        });\n        provider.register();\n      } else {\n        // If the provider is already a NodeTracerProvider, we can use it\n        provider = existingProvider as NodeTracerProvider;\n      }\n    } catch (error) {\n      // If we get here, we need to set up a new provider\n      provider = new NodeTracerProvider({\n        spanProcessors: [new SimpleSpanProcessor(spanExporter as SpanExporter)],\n      });\n      provider.register();\n    }\n  } catch (error) {\n    throw error as Error;\n  }\n}\n\n/**\n * Configures OpenTelemetry logging\n * @param logExporter - The log exporter to use\n */\nfunction configureLogging(logExporter?: ConsoleLogRecordExporter | OTLPLogExporter): void {\n  if (!logExporter) {\n    return;\n  }\n\n  try {\n    let loggerProvider: LoggerProvider;\n    try {\n      const existingProvider = logs.getLoggerProvider();\n      if (!(existingProvider instanceof LoggerProvider)) {\n        loggerProvider = new LoggerProvider();\n        logs.setGlobalLoggerProvider(loggerProvider);\n      } else {\n        loggerProvider = existingProvider as LoggerProvider;\n      }\n    } catch (error) {\n      // If we get here, we need to set up a new provider\n      loggerProvider = new LoggerProvider();\n      logs.setGlobalLoggerProvider(loggerProvider);\n    }\n\n    loggerProvider.addLogRecordProcessor(new SimpleLogRecordProcessor(logExporter));\n  } catch (error) {\n    logger.warning(\n      \"Failed to configure OpenTelemetry logging. This might be because OpenTelemetry logs API is still experimental.\",\n    );\n  }\n}\n"]}

package/dist/browser/api/inference/operations.d.ts

@@ -0,0 +1,59 @@
+import type { GetChatCompletions, GetEmbeddings, GetImageEmbeddings, ModelClient, ModelClientOptions } from "@azure-rest/ai-inference";
+import type { AIProjectContext as Client } from "../index.js";
+import { AzureOpenAI } from "openai";
+import { ConnectionsOperations } from "../../classic/index.js";
+import type { AzureOpenAIClientOptions } from "./options.js";
+/**
+ * Converts an input URL in the format:
+ * https://<host-name>/<some-path>
+ * to:
+ * https://<host-name>/api/models
+ *
+ * @param url - The input endpoint URL used to construct AIProjectClient.
+ * @returns The endpoint URL required to construct inference clients from the @azure-rest/ai-inference package.
+ * @throws Error if the URL is not a valid HTTPS URL with a host.
+ */
+export declare function _getInferenceURL(url: string): string;
+/**
+ * a generic function to get the inference client for making inference requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The ModelClient instance for making inference requests.
+ */
+export declare function _getInferenceClient(context: Client, options?: ModelClientOptions): ModelClient;
+/**
+ * Get the chat completions client for making chat completion requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The GetChatCompletions instance for making chat completion requests.
+ */
+export declare function _getChatCompletionsClient(context: Client, options?: ModelClientOptions): GetChatCompletions;
+/**
+ * Get the embedding client for making embedding requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The GetEmbeddings instance for making embedding requests.
+ */
+export declare function _getEmbeddingClient(context: Client, options?: ModelClientOptions): GetEmbeddings;
+/**
+ * Get the image embedding client for making image embedding requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The GetImageEmbeddings instance for making image embedding requests.
+ */
+export declare function _getImageEmbeddingClient(context: Client, options?: ModelClientOptions): GetImageEmbeddings;
+/**
+ * Get an authenticated AzureOpenAI client (from the `openai` package) for the default
+ * Azure OpenAI connection (if `connectionName` is not specified), or from the Azure OpenAI
+ * resource given by its connection name.
+ *
+ * @param context - The AIProjectContext used to construct the client.
+ * @param connections - The ConnectionsOperations used to manage connections.
+ * @param options - Optional parameters.
+ * @returns An authenticated AzureOpenAI client.
+ * @throws ResourceNotFoundError if an Azure OpenAI connection does not exist.
+ * @throws Error if the connection name is an empty string.
+ * @throws HttpResponseError for other HTTP-related errors.
+ */
+export declare function _getAzureOpenAIClient(context: Client, connections: ConnectionsOperations, options?: AzureOpenAIClientOptions): Promise<AzureOpenAI>;
+//# sourceMappingURL=operations.d.ts.map

package/dist/browser/api/inference/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../../../src/api/inference/operations.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACV,kBAAkB,EAClB,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,KAAK,EAAE,gBAAgB,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAErC,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE7D;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAepD;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,WAAW,CA0B9F;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,kBAAkB,GAC3B,kBAAkB,CAIpB;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,aAAa,CAIhG;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,kBAAkB,GAC3B,kBAAkB,CAIpB;AA2BD;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,qBAAqB,EAClC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,WAAW,CAAC,CAkEtB"}

package/dist/browser/api/inference/operations.js

@@ -0,0 +1,177 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/* eslint-disable tsdoc/syntax */
+import createModelClient from "@azure-rest/ai-inference";
+import { getBearerTokenProvider } from "@azure/identity";
+import { AzureOpenAI } from "openai";
+/**
+ * Converts an input URL in the format:
+ * https://<host-name>/<some-path>
+ * to:
+ * https://<host-name>/api/models
+ *
+ * @param url - The input endpoint URL used to construct AIProjectClient.
+ * @returns The endpoint URL required to construct inference clients from the @azure-rest/ai-inference package.
+ * @throws Error if the URL is not a valid HTTPS URL with a host.
+ */
+export function _getInferenceURL(url) {
+    try {
+        const parsedUrl = new URL(url);
+        if (parsedUrl.protocol !== "https:" || !parsedUrl.hostname) {
+            throw new Error("Invalid endpoint URL format. Must be an https URL with a host.");
+        }
+        return `https://${parsedUrl.hostname}/models`;
+    }
+    catch (error) {
+        if (error instanceof TypeError) {
+            throw new Error("Invalid URL format. Please provide a valid URL.");
+        }
+        throw error;
+    }
+}
+/**
+ * a generic function to get the inference client for making inference requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The ModelClient instance for making inference requests.
+ */
+export function _getInferenceClient(context, options) {
+    var _a, _b;
+    const url = _getInferenceURL(context.getEndpointUrl());
+    const credential = context.getCredential();
+    const USER_AGENT_APP_ID = "AIProjectClient";
+    const userAgentPrefix = ((_a = options === null || options === void 0 ? void 0 : options.userAgentOptions) === null || _a === void 0 ? void 0 : _a.userAgentPrefix)
+        ? `${options.userAgentOptions.userAgentPrefix}-${USER_AGENT_APP_ID}`
+        : USER_AGENT_APP_ID;
+    const clientOptions = Object.assign(Object.assign({ apiVersion: context.apiVersion }, options), { userAgentOptions: Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.userAgentOptions), { userAgentPrefix }) });
+    if ((((_b = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.credentials) === null || _b === void 0 ? void 0 : _b.scopes) || []).length === 0) {
+        clientOptions.credentials = Object.assign(Object.assign({}, clientOptions.credentials), { scopes: ["https://cognitiveservices.azure.com/.default"] });
+    }
+    const client = createModelClient(url, credential, clientOptions);
+    return client;
+}
+/**
+ * Get the chat completions client for making chat completion requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The GetChatCompletions instance for making chat completion requests.
+ */
+export function _getChatCompletionsClient(context, options) {
+    const inferenceClient = _getInferenceClient(context, options);
+    const chatCompletionsClient = inferenceClient.path("/chat/completions");
+    return chatCompletionsClient;
+}
+/**
+ * Get the embedding client for making embedding requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The GetEmbeddings instance for making embedding requests.
+ */
+export function _getEmbeddingClient(context, options) {
+    const inferenceClient = _getInferenceClient(context, options);
+    const embeddingClient = inferenceClient.path("/embeddings");
+    return embeddingClient;
+}
+/**
+ * Get the image embedding client for making image embedding requests.
+ * @param context - The AIProjectContext used to construct the client.
+ * @param options - Optional parameters for the model client.
+ * @returns The GetImageEmbeddings instance for making image embedding requests.
+ */
+export function _getImageEmbeddingClient(context, options) {
+    const inferenceClient = _getInferenceClient(context, options);
+    const imageEmbeddingClient = inferenceClient.path("/images/embeddings");
+    return imageEmbeddingClient;
+}
+/**
+ * Converts an input URL in the format:
+ * https://<host-name>/<some-path>
+ * to:
+ * https://<host-name>
+ *
+ * @param url - The input endpoint URL used to construct AIProjectClient.
+ * @returns The endpoint URL required to construct an AzureOpenAI client.
+ * @throws Error if the input URL format is invalid.
+ */
+function _getAoaiInferenceUrl(url) {
+    try {
+        const parsedUrl = new URL(url);
+        if (parsedUrl.protocol !== "https:" || !parsedUrl.hostname) {
+            throw new Error("Invalid endpoint URL format. Must be an https URL with a host.");
+        }
+        return `https://${parsedUrl.hostname}`;
+    }
+    catch (e) {
+        // Catches errors from URL constructor (e.g., invalid URL)
+        throw new Error(`Invalid endpoint URL format: ${url}. ${e instanceof Error ? e.message : String(e)}`);
+    }
+}
+/**
+ * Get an authenticated AzureOpenAI client (from the `openai` package) for the default
+ * Azure OpenAI connection (if `connectionName` is not specified), or from the Azure OpenAI
+ * resource given by its connection name.
+ *
+ * @param context - The AIProjectContext used to construct the client.
+ * @param connections - The ConnectionsOperations used to manage connections.
+ * @param options - Optional parameters.
+ * @returns An authenticated AzureOpenAI client.
+ * @throws ResourceNotFoundError if an Azure OpenAI connection does not exist.
+ * @throws Error if the connection name is an empty string.
+ * @throws HttpResponseError for other HTTP-related errors.
+ */
+export async function _getAzureOpenAIClient(context, connections, options) {
+    // Validate connection name if provided
+    if ((options === null || options === void 0 ? void 0 : options.connectionName) === "") {
+        throw new Error("Connection name cannot be empty");
+    }
+    const connectionName = options === null || options === void 0 ? void 0 : options.connectionName;
+    if (connectionName) {
+        // Get the specific connection
+        const connection = await connections.getWithCredentials(connectionName, options === null || options === void 0 ? void 0 : options.connectionOptions);
+        if (connection.type !== "AzureOpenAI") {
+            throw new Error(`Connection '${connectionName}' is not of type Azure OpenAI.`);
+        }
+        // Format the endpoint URL
+        const targetUrl = new URL(connection.target);
+        const azureEndpoint = targetUrl.href.endsWith("/")
+            ? targetUrl.href.slice(0, -1)
+            : targetUrl.href;
+        if (connection.credentials.type === "ApiKey") {
+            const apiKeyCredential = connection.credentials;
+            return new AzureOpenAI({
+                apiKey: apiKeyCredential.apiKey,
+                endpoint: azureEndpoint,
+                apiVersion: options === null || options === void 0 ? void 0 : options.apiVersion,
+            });
+        }
+        else if (connection.credentials.type === "AAD") {
+            const tokenCredential = context.getCredential();
+            return new AzureOpenAI({
+                azureADTokenProvider: async () => {
+                    const getAccessToken = getBearerTokenProvider(tokenCredential, "https://cognitiveservices.azure.com/.default");
+                    const token = await getAccessToken();
+                    return token;
+                },
+                endpoint: azureEndpoint,
+                apiVersion: options === null || options === void 0 ? void 0 : options.apiVersion,
+            });
+        }
+        else {
+            throw new Error(`Unsupported authentication type '${connection.credentials.type || "unknown"}' for connection '${connectionName}'.`);
+        }
+    }
+    else {
+        const azureEndpoint = _getAoaiInferenceUrl(context.getEndpointUrl());
+        const tokenCredential = context.getCredential();
+        return new AzureOpenAI({
+            azureADTokenProvider: async () => {
+                const getAccessToken = getBearerTokenProvider(tokenCredential, "https://cognitiveservices.azure.com/.default");
+                const token = await getAccessToken();
+                return token;
+            },
+            endpoint: azureEndpoint,
+            apiVersion: options === null || options === void 0 ? void 0 : options.apiVersion,
+        });
+    }
+}
+//# sourceMappingURL=operations.js.map

package/dist/browser/api/inference/operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../../src/api/inference/operations.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,iCAAiC;AAEjC,OAAO,iBAAiB,MAAM,0BAA0B,CAAC;AASzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AAEzD,OAAO,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAKrC;;;;;;;;;GASG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAE/B,IAAI,SAAS,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;QAED,OAAO,WAAW,SAAS,CAAC,QAAQ,SAAS,CAAC;IAChD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,OAA4B;;IAC/E,MAAM,GAAG,GAAG,gBAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IACvD,MAAM,UAAU,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,MAAM,iBAAiB,GAAG,iBAAiB,CAAC;IAC5C,MAAM,eAAe,GAAG,CAAA,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,0CAAE,eAAe;QAChE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,iBAAiB,EAAE;QACpE,CAAC,CAAC,iBAAiB,CAAC;IAEtB,MAAM,aAAa,iCACjB,UAAU,EAAE,OAAO,CAAC,UAAU,IAC3B,OAAO,KACV,gBAAgB,kCACX,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,KAC5B,eAAe,MAElB,CAAC;IAEF,IAAI,CAAC,CAAA,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,WAAW,0CAAE,MAAM,KAAI,EAAE,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5D,aAAa,CAAC,WAAW,mCACpB,aAAa,CAAC,WAAW,KAC5B,MAAM,EAAE,CAAC,8CAA8C,CAAC,GACzD,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAG,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,OAAe,EACf,OAA4B;IAE5B,MAAM,eAAe,GAAG,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,qBAAqB,GAAG,eAAe,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IACxE,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,OAA4B;IAC/E,MAAM,eAAe,GAAG,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,eAAe,GAAG,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5D,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAe,EACf,OAA4B;IAE5B,MAAM,eAAe,GAAG,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC9D,MAAM,oBAAoB,GAAG,eAAe,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IACxE,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,oBAAoB,CAAC,GAAW;IACvC,IAAI,CAAC;QACH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,SAAS,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;QACD,OAAO,WAAW,SAAS,CAAC,QAAQ,EAAE,CAAC;IACzC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,0DAA0D;QAC1D,MAAM,IAAI,KAAK,CACb,gCAAgC,GAAG,KAAK,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CACrF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CACzC,OAAe,EACf,WAAkC,EAClC,OAAkC;IAElC,uCAAuC;IACvC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,MAAK,EAAE,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IAED,MAAM,cAAc,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC;IAE/C,IAAI,cAAc,EAAE,CAAC;QACnB,8BAA8B;QAC9B,MAAM,UAAU,GAAG,MAAM,WAAW,CAAC,kBAAkB,CACrD,cAAc,EACd,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,iBAAiB,CAC3B,CAAC;QAEF,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,eAAe,cAAc,gCAAgC,CAAC,CAAC;QACjF,CAAC;QAED,0BAA0B;QAC1B,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;YAChD,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;YAC7B,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC;QACnB,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7C,MAAM,gBAAgB,GAAG,UAAU,CAAC,WAAgC,CAAC;YACrE,OAAO,IAAI,WAAW,CAAC;gBACrB,MAAM,EAAE,gBAAgB,CAAC,MAAM;gBAC/B,QAAQ,EAAE,aAAa;gBACvB,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;aAChC,CAAC,CAAC;QACL,CAAC;aAAM,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;YACjD,MAAM,eAAe,GAAG,OAAO,CAAC,aAAa,EAAqB,CAAC;YACnE,OAAO,IAAI,WAAW,CAAC;gBACrB,oBAAoB,EAAE,KAAK,IAAI,EAAE;oBAC/B,MAAM,cAAc,GAAG,sBAAsB,CAC3C,eAAe,EACf,8CAA8C,CAC/C,CAAC;oBACF,MAAM,KAAK,GAAG,MAAM,cAAc,EAAE,CAAC;oBACrC,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,QAAQ,EAAE,aAAa;gBACvB,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;aAChC,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CACb,oCAAoC,UAAU,CAAC,WAAW,CAAC,IAAI,IAAI,SAAS,qBAAqB,cAAc,IAAI,CACpH,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,aAAa,GAAG,oBAAoB,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;QACrE,MAAM,eAAe,GAAG,OAAO,CAAC,aAAa,EAAqB,CAAC;QACnE,OAAO,IAAI,WAAW,CAAC;YACrB,oBAAoB,EAAE,KAAK,IAAI,EAAE;gBAC/B,MAAM,cAAc,GAAG,sBAAsB,CAC3C,eAAe,EACf,8CAA8C,CAC/C,CAAC;gBACF,MAAM,KAAK,GAAG,MAAM,cAAc,EAAE,CAAC;gBACrC,OAAO,KAAK,CAAC;YACf,CAAC;YACD,QAAQ,EAAE,aAAa;YACvB,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;SAChC,CAAC,CAAC;IACL,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/* eslint-disable tsdoc/syntax */\n\nimport createModelClient from \"@azure-rest/ai-inference\";\nimport type {\n  GetChatCompletions,\n  GetEmbeddings,\n  GetImageEmbeddings,\n  ModelClient,\n  ModelClientOptions,\n} from \"@azure-rest/ai-inference\";\nimport type { TokenCredential } from \"@azure/core-auth\";\nimport { getBearerTokenProvider } from \"@azure/identity\";\nimport type { AIProjectContext as Client } from \"../index.js\";\nimport { AzureOpenAI } from \"openai\";\nimport { ApiKeyCredentials } from \"../../models/models.js\";\nimport { ConnectionsOperations } from \"../../classic/index.js\";\nimport type { AzureOpenAIClientOptions } from \"./options.js\";\n\n/**\n * Converts an input URL in the format:\n * https://<host-name>/<some-path>\n * to:\n * https://<host-name>/api/models\n *\n * @param url - The input endpoint URL used to construct AIProjectClient.\n * @returns The endpoint URL required to construct inference clients from the @azure-rest/ai-inference package.\n * @throws Error if the URL is not a valid HTTPS URL with a host.\n */\nexport function _getInferenceURL(url: string): string {\n  try {\n    const parsedUrl = new URL(url);\n\n    if (parsedUrl.protocol !== \"https:\" || !parsedUrl.hostname) {\n      throw new Error(\"Invalid endpoint URL format. Must be an https URL with a host.\");\n    }\n\n    return `https://${parsedUrl.hostname}/models`;\n  } catch (error) {\n    if (error instanceof TypeError) {\n      throw new Error(\"Invalid URL format. Please provide a valid URL.\");\n    }\n    throw error;\n  }\n}\n\n/**\n * a generic function to get the inference client for making inference requests.\n * @param context - The AIProjectContext used to construct the client.\n * @param options - Optional parameters for the model client.\n * @returns The ModelClient instance for making inference requests.\n */\nexport function _getInferenceClient(context: Client, options?: ModelClientOptions): ModelClient {\n  const url = _getInferenceURL(context.getEndpointUrl());\n  const credential = context.getCredential();\n  const USER_AGENT_APP_ID = \"AIProjectClient\";\n  const userAgentPrefix = options?.userAgentOptions?.userAgentPrefix\n    ? `${options.userAgentOptions.userAgentPrefix}-${USER_AGENT_APP_ID}`\n    : USER_AGENT_APP_ID;\n\n  const clientOptions = {\n    apiVersion: context.apiVersion,\n    ...options,\n    userAgentOptions: {\n      ...options?.userAgentOptions,\n      userAgentPrefix,\n    },\n  };\n\n  if ((clientOptions?.credentials?.scopes || []).length === 0) {\n    clientOptions.credentials = {\n      ...clientOptions.credentials,\n      scopes: [\"https://cognitiveservices.azure.com/.default\"],\n    };\n  }\n\n  const client = createModelClient(url, credential, clientOptions);\n  return client;\n}\n\n/**\n * Get the chat completions client for making chat completion requests.\n * @param context - The AIProjectContext used to construct the client.\n * @param options - Optional parameters for the model client.\n * @returns The GetChatCompletions instance for making chat completion requests.\n */\nexport function _getChatCompletionsClient(\n  context: Client,\n  options?: ModelClientOptions,\n): GetChatCompletions {\n  const inferenceClient = _getInferenceClient(context, options);\n  const chatCompletionsClient = inferenceClient.path(\"/chat/completions\");\n  return chatCompletionsClient;\n}\n\n/**\n * Get the embedding client for making embedding requests.\n * @param context - The AIProjectContext used to construct the client.\n * @param options - Optional parameters for the model client.\n * @returns The GetEmbeddings instance for making embedding requests.\n */\nexport function _getEmbeddingClient(context: Client, options?: ModelClientOptions): GetEmbeddings {\n  const inferenceClient = _getInferenceClient(context, options);\n  const embeddingClient = inferenceClient.path(\"/embeddings\");\n  return embeddingClient;\n}\n\n/**\n * Get the image embedding client for making image embedding requests.\n * @param context - The AIProjectContext used to construct the client.\n * @param options - Optional parameters for the model client.\n * @returns The GetImageEmbeddings instance for making image embedding requests.\n */\nexport function _getImageEmbeddingClient(\n  context: Client,\n  options?: ModelClientOptions,\n): GetImageEmbeddings {\n  const inferenceClient = _getInferenceClient(context, options);\n  const imageEmbeddingClient = inferenceClient.path(\"/images/embeddings\");\n  return imageEmbeddingClient;\n}\n\n/**\n * Converts an input URL in the format:\n * https://<host-name>/<some-path>\n * to:\n * https://<host-name>\n *\n * @param url - The input endpoint URL used to construct AIProjectClient.\n * @returns The endpoint URL required to construct an AzureOpenAI client.\n * @throws Error if the input URL format is invalid.\n */\nfunction _getAoaiInferenceUrl(url: string): string {\n  try {\n    const parsedUrl = new URL(url);\n    if (parsedUrl.protocol !== \"https:\" || !parsedUrl.hostname) {\n      throw new Error(\"Invalid endpoint URL format. Must be an https URL with a host.\");\n    }\n    return `https://${parsedUrl.hostname}`;\n  } catch (e) {\n    // Catches errors from URL constructor (e.g., invalid URL)\n    throw new Error(\n      `Invalid endpoint URL format: ${url}. ${e instanceof Error ? e.message : String(e)}`,\n    );\n  }\n}\n\n/**\n * Get an authenticated AzureOpenAI client (from the `openai` package) for the default\n * Azure OpenAI connection (if `connectionName` is not specified), or from the Azure OpenAI\n * resource given by its connection name.\n *\n * @param context - The AIProjectContext used to construct the client.\n * @param connections - The ConnectionsOperations used to manage connections.\n * @param options - Optional parameters.\n * @returns An authenticated AzureOpenAI client.\n * @throws ResourceNotFoundError if an Azure OpenAI connection does not exist.\n * @throws Error if the connection name is an empty string.\n * @throws HttpResponseError for other HTTP-related errors.\n */\nexport async function _getAzureOpenAIClient(\n  context: Client,\n  connections: ConnectionsOperations,\n  options?: AzureOpenAIClientOptions,\n): Promise<AzureOpenAI> {\n  // Validate connection name if provided\n  if (options?.connectionName === \"\") {\n    throw new Error(\"Connection name cannot be empty\");\n  }\n\n  const connectionName = options?.connectionName;\n\n  if (connectionName) {\n    // Get the specific connection\n    const connection = await connections.getWithCredentials(\n      connectionName,\n      options?.connectionOptions,\n    );\n\n    if (connection.type !== \"AzureOpenAI\") {\n      throw new Error(`Connection '${connectionName}' is not of type Azure OpenAI.`);\n    }\n\n    // Format the endpoint URL\n    const targetUrl = new URL(connection.target);\n    const azureEndpoint = targetUrl.href.endsWith(\"/\")\n      ? targetUrl.href.slice(0, -1)\n      : targetUrl.href;\n    if (connection.credentials.type === \"ApiKey\") {\n      const apiKeyCredential = connection.credentials as ApiKeyCredentials;\n      return new AzureOpenAI({\n        apiKey: apiKeyCredential.apiKey,\n        endpoint: azureEndpoint,\n        apiVersion: options?.apiVersion,\n      });\n    } else if (connection.credentials.type === \"AAD\") {\n      const tokenCredential = context.getCredential() as TokenCredential;\n      return new AzureOpenAI({\n        azureADTokenProvider: async () => {\n          const getAccessToken = getBearerTokenProvider(\n            tokenCredential,\n            \"https://cognitiveservices.azure.com/.default\",\n          );\n          const token = await getAccessToken();\n          return token;\n        },\n        endpoint: azureEndpoint,\n        apiVersion: options?.apiVersion,\n      });\n    } else {\n      throw new Error(\n        `Unsupported authentication type '${connection.credentials.type || \"unknown\"}' for connection '${connectionName}'.`,\n      );\n    }\n  } else {\n    const azureEndpoint = _getAoaiInferenceUrl(context.getEndpointUrl());\n    const tokenCredential = context.getCredential() as TokenCredential;\n    return new AzureOpenAI({\n      azureADTokenProvider: async () => {\n        const getAccessToken = getBearerTokenProvider(\n          tokenCredential,\n          \"https://cognitiveservices.azure.com/.default\",\n        );\n        const token = await getAccessToken();\n        return token;\n      },\n      endpoint: azureEndpoint,\n      apiVersion: options?.apiVersion,\n    });\n  }\n}\n"]}

package/dist/browser/api/inference/options.d.ts

@@ -0,0 +1,18 @@
+import type { ConnectionsGetOptionalParams, ConnectionsGetWithCredentialsOptionalParams } from "../connections/options.js";
+/** The options for configuring the Azure OpenAI client. */
+export interface AzureOpenAIClientOptions {
+    /**
+     * The Azure OpenAI api-version to use when creating the client.
+     *  See "Data plane - Inference" row in the table at
+     *  https://learn.microsoft.com/azure/ai-services/openai/reference#api-specs. If not provided,
+     *  you must set the environment variable `OPENAI_API_VERSION` instead.
+     */
+    apiVersion?: string;
+    /**  The name of a connection to an Azure OpenAI resource in your AI Foundry project. If not provided, the default Azure OpenAI connection will be used. */
+    connectionName?: string;
+    /** The connection options to use for the Azure OpenAI connection. */
+    connectionOptions?: ConnectionsGetOptionalParams;
+    /** The connection secret options to use for the Azure OpenAI client. */
+    connectionSecretOptions?: ConnectionsGetWithCredentialsOptionalParams;
+}
+//# sourceMappingURL=options.d.ts.map

package/dist/browser/api/inference/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../../src/api/inference/options.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,4BAA4B,EAC5B,2CAA2C,EAC5C,MAAM,2BAA2B,CAAC;AAEnC,2DAA2D;AAC3D,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2JAA2J;IAC3J,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qEAAqE;IACrE,iBAAiB,CAAC,EAAE,4BAA4B,CAAC;IACjD,wEAAwE;IACxE,uBAAuB,CAAC,EAAE,2CAA2C,CAAC;CACvE"}

package/dist/browser/api/inference/options.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export {};
+//# sourceMappingURL=options.js.map

package/dist/browser/api/inference/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../../src/api/inference/options.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  ConnectionsGetOptionalParams,\n  ConnectionsGetWithCredentialsOptionalParams,\n} from \"../connections/options.js\";\n\n/** The options for configuring the Azure OpenAI client. */\nexport interface AzureOpenAIClientOptions {\n  /**\n   * The Azure OpenAI api-version to use when creating the client.\n   *  See \"Data plane - Inference\" row in the table at\n   *  https://learn.microsoft.com/azure/ai-services/openai/reference#api-specs. If not provided,\n   *  you must set the environment variable `OPENAI_API_VERSION` instead.\n   */\n  apiVersion?: string;\n  /**  The name of a connection to an Azure OpenAI resource in your AI Foundry project. If not provided, the default Azure OpenAI connection will be used. */\n  connectionName?: string;\n  /** The connection options to use for the Azure OpenAI connection. */\n  connectionOptions?: ConnectionsGetOptionalParams;\n  /** The connection secret options to use for the Azure OpenAI client. */\n  connectionSecretOptions?: ConnectionsGetWithCredentialsOptionalParams;\n}\n"]}

package/dist/browser/api/redTeams/index.d.ts

@@ -0,0 +1,3 @@
+export { create, list, get } from "./operations.js";
+export { RedTeamsCreateOptionalParams, RedTeamsListOptionalParams, RedTeamsGetOptionalParams, } from "./options.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/api/redTeams/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/redTeams/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EACL,4BAA4B,EAC5B,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,cAAc,CAAC"}

package/dist/browser/api/redTeams/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+export { create, list, get } from "./operations.js";
+//# sourceMappingURL=index.js.map

package/dist/browser/api/redTeams/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/redTeams/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport { create, list, get } from \"./operations.js\";\nexport {\n  RedTeamsCreateOptionalParams,\n  RedTeamsListOptionalParams,\n  RedTeamsGetOptionalParams,\n} from \"./options.js\";\n"]}

package/dist/browser/api/redTeams/operations.d.ts

@@ -0,0 +1,18 @@
+import { AIProjectContext as Client } from "../index.js";
+import { RedTeam, _PagedRedTeam } from "../../models/models.js";
+import { RedTeamsCreateOptionalParams, RedTeamsListOptionalParams, RedTeamsGetOptionalParams } from "./options.js";
+import { PagedAsyncIterableIterator } from "../../static-helpers/pagingHelpers.js";
+import { StreamableMethod, PathUncheckedResponse } from "@azure-rest/core-client";
+export declare function _createSend(context: Client, redTeam: RedTeam, options?: RedTeamsCreateOptionalParams): StreamableMethod;
+export declare function _createDeserialize(result: PathUncheckedResponse): Promise<RedTeam>;
+/** Creates a redteam run. */
+export declare function create(context: Client, redTeam: RedTeam, options?: RedTeamsCreateOptionalParams): Promise<RedTeam>;
+export declare function _listSend(context: Client, options?: RedTeamsListOptionalParams): StreamableMethod;
+export declare function _listDeserialize(result: PathUncheckedResponse): Promise<_PagedRedTeam>;
+/** List a redteam by name. */
+export declare function list(context: Client, options?: RedTeamsListOptionalParams): PagedAsyncIterableIterator<RedTeam>;
+export declare function _getSend(context: Client, name: string, options?: RedTeamsGetOptionalParams): StreamableMethod;
+export declare function _getDeserialize(result: PathUncheckedResponse): Promise<RedTeam>;
+/** Get a redteam by name. */
+export declare function get(context: Client, name: string, options?: RedTeamsGetOptionalParams): Promise<RedTeam>;
+//# sourceMappingURL=operations.d.ts.map

package/dist/browser/api/redTeams/operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.d.ts","sourceRoot":"","sources":["../../../../src/api/redTeams/operations.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,gBAAgB,IAAI,MAAM,EAAE,MAAM,aAAa,CAAC;AACzD,OAAO,EACL,OAAO,EAGP,aAAa,EAEd,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,4BAA4B,EAC5B,0BAA0B,EAC1B,yBAAyB,EAC1B,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,0BAA0B,EAE3B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EAGtB,MAAM,yBAAyB,CAAC;AAEjC,wBAAgB,WAAW,CACzB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,4BAAqD,GAC7D,gBAAgB,CAmBlB;AAED,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,CAOxF;AAED,6BAA6B;AAC7B,wBAAsB,MAAM,CAC1B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,4BAAqD,GAC7D,OAAO,CAAC,OAAO,CAAC,CAGlB;AAED,wBAAgB,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,0BAAmD,GAC3D,gBAAgB,CAoBlB;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,aAAa,CAAC,CAO5F;AAED,8BAA8B;AAC9B,wBAAgB,IAAI,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,0BAAmD,GAC3D,0BAA0B,CAAC,OAAO,CAAC,CAQrC;AAED,wBAAgB,QAAQ,CACtB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,yBAAkD,GAC1D,gBAAgB,CAqBlB;AAED,wBAAsB,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,CAOrF;AAED,6BAA6B;AAC7B,wBAAsB,GAAG,CACvB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,yBAAkD,GAC1D,OAAO,CAAC,OAAO,CAAC,CAGlB"}

package/dist/browser/api/redTeams/operations.js

@@ -0,0 +1,74 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { redTeamSerializer, redTeamDeserializer, _pagedRedTeamDeserializer, } from "../../models/models.js";
+import { expandUrlTemplate } from "../../static-helpers/urlTemplate.js";
+import { buildPagedAsyncIterator, } from "../../static-helpers/pagingHelpers.js";
+import { createRestError, operationOptionsToRequestParameters, } from "@azure-rest/core-client";
+export function _createSend(context, redTeam, options = { requestOptions: {} }) {
+    var _a, _b;
+    const path = expandUrlTemplate("/redTeams/runs:run{?api-version}", {
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: (_a = options === null || options === void 0 ? void 0 : options.requestOptions) === null || _a === void 0 ? void 0 : _a.skipUrlEncoding,
+    });
+    return context.path(path).post(Object.assign(Object.assign({}, operationOptionsToRequestParameters(options)), { contentType: "application/json", headers: Object.assign({ accept: "application/json" }, (_b = options.requestOptions) === null || _b === void 0 ? void 0 : _b.headers), body: redTeamSerializer(redTeam) }));
+}
+export async function _createDeserialize(result) {
+    const expectedStatuses = ["201"];
+    if (!expectedStatuses.includes(result.status)) {
+        throw createRestError(result);
+    }
+    return redTeamDeserializer(result.body);
+}
+/** Creates a redteam run. */
+export async function create(context, redTeam, options = { requestOptions: {} }) {
+    const result = await _createSend(context, redTeam, options);
+    return _createDeserialize(result);
+}
+export function _listSend(context, options = { requestOptions: {} }) {
+    var _a, _b;
+    const path = expandUrlTemplate("/redTeams/runs{?api-version}", {
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: (_a = options === null || options === void 0 ? void 0 : options.requestOptions) === null || _a === void 0 ? void 0 : _a.skipUrlEncoding,
+    });
+    return context.path(path).get(Object.assign(Object.assign({}, operationOptionsToRequestParameters(options)), { headers: Object.assign(Object.assign(Object.assign({}, ((options === null || options === void 0 ? void 0 : options.clientRequestId) !== undefined
+            ? { "x-ms-client-request-id": options === null || options === void 0 ? void 0 : options.clientRequestId }
+            : {})), { accept: "application/json" }), (_b = options.requestOptions) === null || _b === void 0 ? void 0 : _b.headers) }));
+}
+export async function _listDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        throw createRestError(result);
+    }
+    return _pagedRedTeamDeserializer(result.body);
+}
+/** List a redteam by name. */
+export function list(context, options = { requestOptions: {} }) {
+    return buildPagedAsyncIterator(context, () => _listSend(context, options), _listDeserialize, ["200"], { itemName: "value", nextLinkName: "nextLink" });
+}
+export function _getSend(context, name, options = { requestOptions: {} }) {
+    var _a, _b;
+    const path = expandUrlTemplate("/redTeams/runs/{name}{?api-version}", {
+        name: name,
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: (_a = options === null || options === void 0 ? void 0 : options.requestOptions) === null || _a === void 0 ? void 0 : _a.skipUrlEncoding,
+    });
+    return context.path(path).get(Object.assign(Object.assign({}, operationOptionsToRequestParameters(options)), { headers: Object.assign(Object.assign(Object.assign({}, ((options === null || options === void 0 ? void 0 : options.clientRequestId) !== undefined
+            ? { "x-ms-client-request-id": options === null || options === void 0 ? void 0 : options.clientRequestId }
+            : {})), { accept: "application/json" }), (_b = options.requestOptions) === null || _b === void 0 ? void 0 : _b.headers) }));
+}
+export async function _getDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        throw createRestError(result);
+    }
+    return redTeamDeserializer(result.body);
+}
+/** Get a redteam by name. */
+export async function get(context, name, options = { requestOptions: {} }) {
+    const result = await _getSend(context, name, options);
+    return _getDeserialize(result);
+}
+//# sourceMappingURL=operations.js.map