@azure/ai-projects 1.0.0-alpha.20250428.1 → 1.0.0-alpha.20250505.4

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

@@ -0,0 +1,189 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enableTelemetry = enableTelemetry;
+const tslib_1 = require("tslib");
+const opentelemetry = tslib_1.__importStar(require("@opentelemetry/api"));
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const opentelemetry_instrumentation_azure_sdk_1 = require("@azure/opentelemetry-instrumentation-azure-sdk");
+const instrumentation_openai_1 = require("@traceloop/instrumentation-openai");
+const instrumentation_langchain_1 = require("@traceloop/instrumentation-langchain");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const exporter_trace_otlp_grpc_1 = require("@opentelemetry/exporter-trace-otlp-grpc");
+const api_logs_1 = require("@opentelemetry/api-logs");
+const sdk_logs_1 = require("@opentelemetry/sdk-logs");
+const exporter_logs_otlp_grpc_1 = require("@opentelemetry/exporter-logs-otlp-grpc");
+const logger_js_1 = require("../../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.
+ */
+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 {
+        (0, instrumentation_1.registerInstrumentations)({
+            instrumentations: [(0, opentelemetry_instrumentation_azure_sdk_1.createAzureSdkInstrumentation)()],
+        });
+    }
+    catch (error) {
+        logger_js_1.logger.warning("Could not register `createAzureSdkInstrumentation()`");
+    }
+    // TODO: Try to instrument AI Agents
+    // Try to instrument OpenAI
+    try {
+        (0, instrumentation_1.registerInstrumentations)({
+            instrumentations: [new instrumentation_openai_1.OpenAIInstrumentation()],
+        });
+    }
+    catch (error) {
+        logger_js_1.logger.warning("Could not register `new OpenAIInstrumentation()`");
+    }
+    // Try to instrument Langchain
+    try {
+        (0, instrumentation_1.registerInstrumentations)({
+            instrumentations: [new instrumentation_langchain_1.LangChainInstrumentation()],
+        });
+    }
+    catch (error) {
+        logger_js_1.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 sdk_trace_node_1.ConsoleSpanExporter();
+        }
+        else if (typeof destination === "string") {
+            return new exporter_trace_otlp_grpc_1.OTLPTraceExporter({ url: destination });
+        }
+    }
+    catch (error) {
+        logger_js_1.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 sdk_logs_1.ConsoleLogRecordExporter();
+        }
+        else if (typeof destination === "string") {
+            return new exporter_logs_otlp_grpc_1.OTLPLogExporter({ url: destination });
+        }
+    }
+    catch (error) {
+        logger_js_1.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 sdk_trace_node_1.NodeTracerProvider({
+                    spanProcessors: [new sdk_trace_node_1.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 sdk_trace_node_1.NodeTracerProvider({
+                spanProcessors: [new sdk_trace_node_1.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 = api_logs_1.logs.getLoggerProvider();
+            if (!(existingProvider instanceof sdk_logs_1.LoggerProvider)) {
+                loggerProvider = new sdk_logs_1.LoggerProvider();
+                api_logs_1.logs.setGlobalLoggerProvider(loggerProvider);
+            }
+            else {
+                loggerProvider = existingProvider;
+            }
+        }
+        catch (error) {
+            // If we get here, we need to set up a new provider
+            loggerProvider = new sdk_logs_1.LoggerProvider();
+            api_logs_1.logs.setGlobalLoggerProvider(loggerProvider);
+        }
+        loggerProvider.addLogRecordProcessor(new sdk_logs_1.SimpleLogRecordProcessor(logExporter));
+    }
+    catch (error) {
+        logger_js_1.logger.warning("Failed to configure OpenTelemetry logging. This might be because OpenTelemetry logs API is still experimental.");
+    }
+}
+//# sourceMappingURL=enableTelemetry.js.map

package/dist/commonjs/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;;AA0ClC,0CAsCC;;AA9ED,0EAAoD;AACpD,oEAA0E;AAC1E,4GAA+F;AAC/F,8EAA0E;AAC1E,oFAAgF;AAChF,kEAIuC;AAEvC,sFAA4E;AAC5E,sDAA+C;AAC/C,sDAIiC;AACjC,oFAAyE;AACzE,+CAAyC;AAEzC;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,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,IAAA,0CAAwB,EAAC;YACvB,gBAAgB,EAAE,CAAC,IAAA,uEAA6B,GAAE,CAAC;SACpD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAM,CAAC,OAAO,CAAC,sDAAsD,CAAC,CAAC;IACzE,CAAC;IAED,oCAAoC;IAEpC,2BAA2B;IAC3B,IAAI,CAAC;QACH,IAAA,0CAAwB,EAAC;YACvB,gBAAgB,EAAE,CAAC,IAAI,8CAAqB,EAAE,CAAC;SAChD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAM,CAAC,OAAO,CAAC,kDAAkD,CAAC,CAAC;IACrE,CAAC;IAED,8BAA8B;IAC9B,IAAI,CAAC;QACH,IAAA,0CAAwB,EAAC;YACvB,gBAAgB,EAAE,CAAC,IAAI,oDAAwB,EAAE,CAAC;SACnD,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAM,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,oCAAmB,EAAE,CAAC;QACnC,CAAC;aAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3C,OAAO,IAAI,4CAAiB,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAM,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,mCAAwB,EAAE,CAAC;QACxC,CAAC;aAAM,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YAC3C,OAAO,IAAI,yCAAe,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAM,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,mCAAkB,CAAC;oBAChC,cAAc,EAAE,CAAC,IAAI,oCAAmB,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,mCAAkB,CAAC;gBAChC,cAAc,EAAE,CAAC,IAAI,oCAAmB,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,eAAI,CAAC,iBAAiB,EAAE,CAAC;YAClD,IAAI,CAAC,CAAC,gBAAgB,YAAY,yBAAc,CAAC,EAAE,CAAC;gBAClD,cAAc,GAAG,IAAI,yBAAc,EAAE,CAAC;gBACtC,eAAI,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,yBAAc,EAAE,CAAC;YACtC,eAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;QAC/C,CAAC;QAED,cAAc,CAAC,qBAAqB,CAAC,IAAI,mCAAwB,CAAC,WAAW,CAAC,CAAC,CAAC;IAClF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,kBAAM,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/commonjs/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/commonjs/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;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,MAAM,EACf,WAAW,EAAE,qBAAqB,EAClC,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,WAAW,CAAC,CA6EtB"}

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

@@ -0,0 +1,187 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._getInferenceURL = _getInferenceURL;
+exports._getInferenceClient = _getInferenceClient;
+exports._getChatCompletionsClient = _getChatCompletionsClient;
+exports._getEmbeddingClient = _getEmbeddingClient;
+exports._getImageEmbeddingClient = _getImageEmbeddingClient;
+exports._getAzureOpenAIClient = _getAzureOpenAIClient;
+const tslib_1 = require("tslib");
+/* eslint-disable tsdoc/syntax */
+const ai_inference_1 = tslib_1.__importDefault(require("@azure-rest/ai-inference"));
+const identity_1 = require("@azure/identity");
+const openai_1 = require("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.
+ */
+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}/api/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.
+ */
+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 = (0, ai_inference_1.default)(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.
+ */
+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.
+ */
+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.
+ */
+function _getImageEmbeddingClient(context, options) {
+    const inferenceClient = _getInferenceClient(context, options);
+    const imageEmbeddingClient = inferenceClient.path("/images/embeddings");
+    return imageEmbeddingClient;
+}
+/**
+ * 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.
+ */
+async function _getAzureOpenAIClient(context, connections, options) {
+    var _a, e_1, _b, _c;
+    // Validate connection name if provided
+    if ((options === null || options === void 0 ? void 0 : options.connectionName) !== undefined && options.connectionName === "") {
+        throw new Error("Connection name cannot be empty");
+    }
+    let connection;
+    let connectionName = options === null || options === void 0 ? void 0 : options.connectionName;
+    if (connectionName) {
+        // Get the specific connection
+        connection = await connections.get(connectionName, false, options === null || options === void 0 ? void 0 : options.connectionOptions);
+        if (connection.type !== "AzureOpenAI") {
+            throw new Error(`Connection '${connectionName}' is not of type Azure OpenAI.`);
+        }
+    }
+    else {
+        // If connection name was not specified, get the default Azure OpenAI connection
+        const _connections = [];
+        try {
+            for (var _d = true, _e = tslib_1.__asyncValues(connections.list({
+                connectionType: "AzureOpenAI",
+                defaultConnection: true,
+            })), _f; _f = await _e.next(), _a = _f.done, !_a; _d = true) {
+                _c = _f.value;
+                _d = false;
+                const conn = _c;
+                _connections.push(conn);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_d && !_a && (_b = _e.return)) await _b.call(_e);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        if (_connections.length === 0) {
+            throw new Error("No default Azure OpenAI connection found.");
+        }
+        connection = _connections[0];
+        connectionName = connection.name;
+    }
+    // If the connection uses API key authentication, get connection with API key populated
+    if (connection.credentials.type === "ApiKey") {
+        connection = await connections.getWithCredentials(connectionName, options === null || options === void 0 ? void 0 : options.connectionSecretOptions);
+    }
+    // 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") {
+        // Create client with API key authentication
+        return new openai_1.AzureOpenAI({
+            apiKey: connection.credentials.apiKey,
+            endpoint: azureEndpoint,
+            apiVersion: options === null || options === void 0 ? void 0 : options.apiVersion,
+        });
+    }
+    else if (connection.credentials.type === "AAD") {
+        // Create client with Entra ID authentication
+        try {
+            // Get token provider from the context credential
+            return new openai_1.AzureOpenAI({
+                azureADTokenProvider: async () => {
+                    const getAccessToken = (0, identity_1.getBearerTokenProvider)(context.getCredential(), "https://cognitiveservices.azure.com/.default");
+                    const token = await getAccessToken();
+                    return token;
+                },
+                endpoint: azureEndpoint,
+                apiVersion: options === null || options === void 0 ? void 0 : options.apiVersion,
+            });
+        }
+        catch (e) {
+            throw new Error("Azure identity package not available or credential issue: " + JSON.stringify(e));
+        }
+    }
+    else {
+        throw new Error(`Unsupported authentication type: ${connection.credentials.type}`);
+    }
+}
+//# sourceMappingURL=operations.js.map

package/dist/commonjs/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;;AA8BlC,4CAeC;AAQD,kDA0BC;AAQD,8DAOC;AAQD,kDAIC;AAQD,4DAOC;AAeD,sDAiFC;;AAvND,iCAAiC;AAEjC,oFAAyD;AASzD,8CAAyD;AAEzD,mCAAqC;AAKrC;;;;;;;;;GASG;AACH,SAAgB,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,aAAa,CAAC;IACpD,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,SAAgB,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,IAAA,sBAAiB,EAAC,GAAG,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,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,SAAgB,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,SAAgB,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;;;;;;;;;;;;GAYG;AACI,KAAK,UAAU,qBAAqB,CACzC,OAAe,EACf,WAAkC,EAClC,OAAkC;;IAElC,uCAAuC;IACvC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,MAAK,SAAS,IAAI,OAAO,CAAC,cAAc,KAAK,EAAE,EAAE,CAAC;QAC3E,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,UAAsB,CAAC;IAC3B,IAAI,cAAc,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,CAAC;IAE7C,IAAI,cAAc,EAAE,CAAC;QACnB,8BAA8B;QAC9B,UAAU,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,cAAc,EAAE,KAAK,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,iBAAiB,CAAC,CAAC;QAEtF,IAAI,UAAU,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,eAAe,cAAc,gCAAgC,CAAC,CAAC;QACjF,CAAC;IACH,CAAC;SAAM,CAAC;QACN,gFAAgF;QAChF,MAAM,YAAY,GAAiB,EAAE,CAAC;;YACtC,KAAyB,eAAA,KAAA,sBAAA,WAAW,CAAC,IAAI,CAAC;gBACxC,cAAc,EAAE,aAAa;gBAC7B,iBAAiB,EAAE,IAAI;aACxB,CAAC,CAAA,IAAA,sDAAE,CAAC;gBAHoB,cAGvB;gBAHuB,WAGvB;gBAHS,MAAM,IAAI,KAAA,CAAA;gBAInB,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;;;;;;;;;QAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QAED,UAAU,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7B,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IACnC,CAAC;IAED,uFAAuF;IACvF,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7C,UAAU,GAAG,MAAM,WAAW,CAAC,kBAAkB,CAC/C,cAAc,EACd,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,uBAAuB,CACjC,CAAC;IACJ,CAAC;IAED,0BAA0B;IAC1B,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC;IAElG,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7C,4CAA4C;QAC5C,OAAO,IAAI,oBAAW,CAAC;YACrB,MAAM,EAAG,UAAU,CAAC,WAAiC,CAAC,MAAM;YAC5D,QAAQ,EAAE,aAAa;YACvB,UAAU,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU;SAChC,CAAC,CAAC;IACL,CAAC;SAAM,IAAI,UAAU,CAAC,WAAW,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QACjD,6CAA6C;QAC7C,IAAI,CAAC;YACH,iDAAiD;YACjD,OAAO,IAAI,oBAAW,CAAC;gBACrB,oBAAoB,EAAE,KAAK,IAAI,EAAE;oBAC/B,MAAM,cAAc,GAAG,IAAA,iCAAsB,EAC3C,OAAO,CAAC,aAAa,EAAqB,EAC1C,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;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,4DAA4D,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CACjF,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,oCAAoC,UAAU,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IACrF,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, Connection } 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}/api/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 * 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 !== undefined && options.connectionName === \"\") {\n    throw new Error(\"Connection name cannot be empty\");\n  }\n\n  let connection: Connection;\n  let connectionName = options?.connectionName;\n\n  if (connectionName) {\n    // Get the specific connection\n    connection = await connections.get(connectionName, false, options?.connectionOptions);\n\n    if (connection.type !== \"AzureOpenAI\") {\n      throw new Error(`Connection '${connectionName}' is not of type Azure OpenAI.`);\n    }\n  } else {\n    // If connection name was not specified, get the default Azure OpenAI connection\n    const _connections: Connection[] = [];\n    for await (const conn of connections.list({\n      connectionType: \"AzureOpenAI\",\n      defaultConnection: true,\n    })) {\n      _connections.push(conn);\n    }\n\n    if (_connections.length === 0) {\n      throw new Error(\"No default Azure OpenAI connection found.\");\n    }\n\n    connection = _connections[0];\n    connectionName = connection.name;\n  }\n\n  // If the connection uses API key authentication, get connection with API key populated\n  if (connection.credentials.type === \"ApiKey\") {\n    connection = await connections.getWithCredentials(\n      connectionName,\n      options?.connectionSecretOptions,\n    );\n  }\n\n  // Format the endpoint URL\n  const targetUrl = new URL(connection.target);\n  const azureEndpoint = targetUrl.href.endsWith(\"/\") ? targetUrl.href.slice(0, -1) : targetUrl.href;\n\n  if (connection.credentials.type === \"ApiKey\") {\n    // Create client with API key authentication\n    return new AzureOpenAI({\n      apiKey: (connection.credentials as ApiKeyCredentials).apiKey,\n      endpoint: azureEndpoint,\n      apiVersion: options?.apiVersion,\n    });\n  } else if (connection.credentials.type === \"AAD\") {\n    // Create client with Entra ID authentication\n    try {\n      // Get token provider from the context credential\n      return new AzureOpenAI({\n        azureADTokenProvider: async () => {\n          const getAccessToken = getBearerTokenProvider(\n            context.getCredential() as 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    } catch (e) {\n      throw new Error(\n        \"Azure identity package not available or credential issue: \" + JSON.stringify(e),\n      );\n    }\n  } else {\n    throw new Error(`Unsupported authentication type: ${connection.credentials.type}`);\n  }\n}\n"]}

package/dist/commonjs/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/commonjs/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/commonjs/api/inference/options.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=options.js.map

package/dist/commonjs/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/commonjs/api/redTeams/index.d.ts

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

package/dist/commonjs/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,SAAS,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EACL,+BAA+B,EAC/B,0BAA0B,EAC1B,yBAAyB,GAC1B,MAAM,cAAc,CAAC"}

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

@@ -0,0 +1,10 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.get = exports.list = exports.createRun = void 0;
+var operations_js_1 = require("./operations.js");
+Object.defineProperty(exports, "createRun", { enumerable: true, get: function () { return operations_js_1.createRun; } });
+Object.defineProperty(exports, "list", { enumerable: true, get: function () { return operations_js_1.list; } });
+Object.defineProperty(exports, "get", { enumerable: true, get: function () { return operations_js_1.get; } });
+//# sourceMappingURL=index.js.map

package/dist/commonjs/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,iDAAuD;AAA9C,0GAAA,SAAS,OAAA;AAAE,qGAAA,IAAI,OAAA;AAAE,oGAAA,GAAG,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport { createRun, list, get } from \"./operations.js\";\nexport {\n  RedTeamsCreateRunOptionalParams,\n  RedTeamsListOptionalParams,\n  RedTeamsGetOptionalParams,\n} from \"./options.js\";\n"]}

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

@@ -0,0 +1,18 @@
+import { AIProjectContext as Client } from "../index.js";
+import { RedTeam, _PagedRedTeam } from "../../models/models.js";
+import { RedTeamsCreateRunOptionalParams, RedTeamsListOptionalParams, RedTeamsGetOptionalParams } from "./options.js";
+import { PagedAsyncIterableIterator } from "../../static-helpers/pagingHelpers.js";
+import { StreamableMethod, PathUncheckedResponse } from "@azure-rest/core-client";
+export declare function _createRunSend(context: Client, redTeam: RedTeam, options?: RedTeamsCreateRunOptionalParams): StreamableMethod;
+export declare function _createRunDeserialize(result: PathUncheckedResponse): Promise<RedTeam>;
+/** Creates a redteam run. */
+export declare function createRun(context: Client, redTeam: RedTeam, options?: RedTeamsCreateRunOptionalParams): 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/commonjs/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,+BAA+B,EAC/B,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,cAAc,CAC5B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,+BAAwD,GAChE,gBAAgB,CAmBlB;AAED,wBAAsB,qBAAqB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,OAAO,CAAC,CAO3F;AAED,6BAA6B;AAC7B,wBAAsB,SAAS,CAC7B,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,EAChB,OAAO,GAAE,+BAAwD,GAChE,OAAO,CAAC,OAAO,CAAC,CAGlB;AAED,wBAAgB,SAAS,CACvB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,0BAAmD,GAC3D,gBAAgB,CAuBlB;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"}