@azure/ai-projects 1.0.0-beta.1

package/dist/esm/agents/traceUtility.js

@@ -0,0 +1,127 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { TracingAttributes, TracingUtility } from "../tracing.js";
+import { getTelemetryOptions } from "../telemetry/telemetry.js";
+export function traceStartAgentGeneric(span, options) {
+    var _a;
+    const attributeOptions = options.tracingAttributeOptions || {};
+    TracingUtility.setSpanAttributes(span, ((_a = options.tracingAttributeOptions) === null || _a === void 0 ? void 0 : _a.operationName) || "Agent_Operation", UpdateWithAgentAttributes(attributeOptions));
+}
+export function traceEndAgentGeneric(span, _options) {
+    const attributeOptions = {};
+    TracingUtility.updateSpanAttributes(span, UpdateWithAgentAttributes(attributeOptions));
+}
+export function UpdateWithAgentAttributes(attributeOptions) {
+    attributeOptions.genAiSystem = TracingAttributes.AZ_AI_AGENT_SYSTEM;
+    return attributeOptions;
+}
+/**
+ * Adds a message event to the span.
+ * @param span - The span to add the event to.
+ * @param messageAttributes - The attributes of the message event.
+ */
+export function addMessageEvent(span, messageAttributes, usage) {
+    var _a;
+    const eventBody = {};
+    const telemetryOptions = getTelemetryOptions();
+    if (telemetryOptions.enableContentRecording) {
+        eventBody.content = getMessageContent(messageAttributes.content);
+    }
+    eventBody.role = messageAttributes.role;
+    if (messageAttributes.attachments) {
+        eventBody.attachments = messageAttributes.attachments.map((attachment) => {
+            return {
+                id: attachment.file_id,
+                tools: attachment.tools.map((tool) => tool.type),
+            };
+        });
+    }
+    const threadId = messageAttributes.thread_id;
+    const agentId = (_a = messageAttributes.assistant_id) !== null && _a !== void 0 ? _a : undefined;
+    const threadRunId = messageAttributes.run_id;
+    const messageStatus = messageAttributes.status;
+    const messageId = messageAttributes.id;
+    const incompleteDetails = messageAttributes.incomplete_details;
+    if (incompleteDetails) {
+        eventBody.incomplete_details = incompleteDetails;
+    }
+    const usagePromptTokens = usage === null || usage === void 0 ? void 0 : usage.prompt_tokens;
+    const usageCompletionTokens = usage === null || usage === void 0 ? void 0 : usage.completion_tokens;
+    const attributes = {
+        eventContent: JSON.stringify(eventBody),
+        threadId,
+        agentId,
+        threadRunId,
+        messageStatus,
+        messageId,
+        usagePromptTokens,
+        usageCompletionTokens,
+        genAiSystem: TracingAttributes.AZ_AI_AGENT_SYSTEM,
+    };
+    TracingUtility.addSpanEvent(span, `gen_ai.${messageAttributes.role}.message`, attributes);
+}
+/**
+ * Adds an instruction event to the span.
+ * @param span - The span to add the event to.
+ * @param instructionAttributes - The attributes of the instruction event.
+ */
+export function addInstructionsEvent(span, instructionAttributes) {
+    const eventBody = {};
+    if (instructionAttributes.instructions || instructionAttributes.additional_instructions) {
+        eventBody.content =
+            instructionAttributes.instructions && instructionAttributes.additional_instructions
+                ? `${instructionAttributes.instructions} ${instructionAttributes.additional_instructions}`
+                : instructionAttributes.instructions || instructionAttributes.additional_instructions;
+    }
+    const attributes = {
+        eventContent: JSON.stringify(eventBody),
+        threadId: instructionAttributes.threadId,
+        agentId: instructionAttributes.agentId,
+        genAiSystem: TracingAttributes.AZ_AI_AGENT_SYSTEM,
+    };
+    TracingUtility.addSpanEvent(span, "gen_ai.system.message", attributes);
+}
+/**
+ * Formats the agent API response.
+ * @param responseFormat - The response format option.
+ * @returns The formatted response as a string, or null/undefined.
+ */
+export function formatAgentApiResponse(responseFormat) {
+    var _a;
+    if (typeof responseFormat === "string" ||
+        responseFormat === undefined ||
+        responseFormat === null) {
+        return responseFormat !== null && responseFormat !== void 0 ? responseFormat : undefined;
+    }
+    if (responseFormat.type) {
+        return (_a = responseFormat.type) !== null && _a !== void 0 ? _a : undefined;
+    }
+    return undefined;
+}
+/**
+ * Adds a tool messages event to the span
+ * @param span - The span to add the event to.
+ * @param tool_outputs - List of tool oupts
+ */
+export function addToolMessagesEvent(span, tool_outputs) {
+    tool_outputs.forEach((tool_output) => {
+        const eventBody = { content: tool_output.output, id: tool_output.tool_call_id };
+        TracingUtility.addSpanEvent(span, "gen_ai.tool.message", {
+            eventContent: JSON.stringify(eventBody),
+            genAiSystem: TracingAttributes.AZ_AI_AGENT_SYSTEM,
+        });
+    });
+}
+function getMessageContent(messageContent) {
+    if (!Array.isArray(messageContent)) {
+        return messageContent;
+    }
+    const contentBody = {};
+    messageContent.forEach((content) => {
+        const typedContent = content.type;
+        const { value, annotations } = content[typedContent];
+        contentBody[typedContent] = { value, annotations };
+    });
+    return contentBody;
+}
+//# sourceMappingURL=traceUtility.js.map

package/dist/esm/agents/traceUtility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traceUtility.js","sourceRoot":"","sources":["../../../src/agents/traceUtility.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAYlC,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,MAAM,UAAU,sBAAsB,CACpC,IAAU,EACV,OAAgB;;IAEhB,MAAM,gBAAgB,GAAG,OAAO,CAAC,uBAAuB,IAAI,EAAE,CAAC;IAC/D,cAAc,CAAC,iBAAiB,CAC9B,IAAI,EACJ,CAAA,MAAA,OAAO,CAAC,uBAAuB,0CAAE,aAAa,KAAI,iBAAiB,EACnE,yBAAyB,CAAC,gBAAgB,CAAC,CAC5C,CAAC;AACJ,CAAC;AACD,MAAM,UAAU,oBAAoB,CAClC,IAAU,EACV,QAAiB;IAEjB,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,cAAc,CAAC,oBAAoB,CAAC,IAAI,EAAE,yBAAyB,CAAC,gBAAgB,CAAC,CAAC,CAAC;AACzF,CAAC;AAED,MAAM,UAAU,yBAAyB,CACvC,gBAAgE;IAEhE,gBAAgB,CAAC,WAAW,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;IACpE,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAU,EACV,iBAAuD,EACvD,KAAoC;;IAEpC,MAAM,SAAS,GAA4B,EAAE,CAAC;IAC9C,MAAM,gBAAgB,GAAG,mBAAmB,EAAE,CAAC;IAC/C,IAAI,gBAAgB,CAAC,sBAAsB,EAAE,CAAC;QAC5C,SAAS,CAAC,OAAO,GAAG,iBAAiB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IACD,SAAS,CAAC,IAAI,GAAG,iBAAiB,CAAC,IAAI,CAAC;IACxC,IAAI,iBAAiB,CAAC,WAAW,EAAE,CAAC;QAClC,SAAS,CAAC,WAAW,GAAG,iBAAiB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;YACvE,OAAO;gBACL,EAAE,EAAE,UAAU,CAAC,OAAO;gBACtB,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC;aACjD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IACD,MAAM,QAAQ,GAAI,iBAAmC,CAAC,SAAS,CAAC;IAChE,MAAM,OAAO,GAAG,MAAC,iBAAmC,CAAC,YAAY,mCAAI,SAAS,CAAC;IAC/E,MAAM,WAAW,GAAI,iBAAmC,CAAC,MAAM,CAAC;IAChE,MAAM,aAAa,GAAI,iBAAmC,CAAC,MAAM,CAAC;IAClE,MAAM,SAAS,GAAI,iBAAmC,CAAC,EAAE,CAAC;IAC1D,MAAM,iBAAiB,GAAI,iBAAmC,CAAC,kBAAkB,CAAC;IAClF,IAAI,iBAAiB,EAAE,CAAC;QACtB,SAAS,CAAC,kBAAkB,GAAG,iBAAiB,CAAC;IACnD,CAAC;IACD,MAAM,iBAAiB,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,CAAC;IAC/C,MAAM,qBAAqB,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,CAAC;IACvD,MAAM,UAAU,GAAG;QACjB,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;QACvC,QAAQ;QACR,OAAO;QACP,WAAW;QACX,aAAa;QACb,SAAS;QACT,iBAAiB;QACjB,qBAAqB;QACrB,WAAW,EAAE,iBAAiB,CAAC,kBAAkB;KAClD,CAAC;IACF,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,UAAU,iBAAiB,CAAC,IAAI,UAAU,EAAE,UAAU,CAAC,CAAC;AAC5F,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAClC,IAAU,EACV,qBAKC;IAED,MAAM,SAAS,GAA4B,EAAE,CAAC;IAC9C,IAAI,qBAAqB,CAAC,YAAY,IAAI,qBAAqB,CAAC,uBAAuB,EAAE,CAAC;QACxF,SAAS,CAAC,OAAO;YACf,qBAAqB,CAAC,YAAY,IAAI,qBAAqB,CAAC,uBAAuB;gBACjF,CAAC,CAAC,GAAG,qBAAqB,CAAC,YAAY,IAAI,qBAAqB,CAAC,uBAAuB,EAAE;gBAC1F,CAAC,CAAC,qBAAqB,CAAC,YAAY,IAAI,qBAAqB,CAAC,uBAAuB,CAAC;IAC5F,CAAC;IACD,MAAM,UAAU,GAAG;QACjB,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;QACvC,QAAQ,EAAE,qBAAqB,CAAC,QAAQ;QACxC,OAAO,EAAE,qBAAqB,CAAC,OAAO;QACtC,WAAW,EAAE,iBAAiB,CAAC,kBAAkB;KAClD,CAAC;IACF,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,uBAAuB,EAAE,UAAU,CAAC,CAAC;AACzE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,cAAgE;;IAEhE,IACE,OAAO,cAAc,KAAK,QAAQ;QAClC,cAAc,KAAK,SAAS;QAC5B,cAAc,KAAK,IAAI,EACvB,CAAC;QACD,OAAO,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,SAAS,CAAC;IACrC,CAAC;IACD,IAAK,cAA0C,CAAC,IAAI,EAAE,CAAC;QACrD,OAAO,MAAC,cAA0C,CAAC,IAAI,mCAAI,SAAS,CAAC;IACvE,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAU,EAAE,YAA+B;IAC9E,YAAY,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,EAAE;QACnC,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,EAAE,EAAE,WAAW,CAAC,YAAY,EAAE,CAAC;QAChF,cAAc,CAAC,YAAY,CAAC,IAAI,EAAE,qBAAqB,EAAE;YACvD,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC;YACvC,WAAW,EAAE,iBAAiB,CAAC,kBAAkB;SAClD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,iBAAiB,CAAC,cAAyC;IAElE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;QACnC,OAAO,cAAc,CAAC;IACxB,CAAC;IACD,MAAM,WAAW,GAA2B,EAAE,CAAC;IAC/C,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACjC,MAAM,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;QAClC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAI,OAAkC,CAAC,YAAY,CAAC,CAAC;QACjF,WAAW,CAAC,YAAY,CAAC,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACrB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  AgentsApiResponseFormat,\n  AgentsApiResponseFormatOption,\n  MessageContent,\n  ThreadMessage,\n  ThreadMessageOptions,\n  ToolOutput,\n} from \"../generated/src/models.js\";\nimport type { RunStepCompletionUsageOutput } from \"../generated/src/outputModels.js\";\nimport type { OptionsWithTracing, Span, TracingAttributeOptions } from \"../tracing.js\";\nimport { TracingAttributes, TracingUtility } from \"../tracing.js\";\nimport { getTelemetryOptions } from \"../telemetry/telemetry.js\";\n\nexport function traceStartAgentGeneric<Options extends OptionsWithTracing>(\n  span: Span,\n  options: Options,\n): void {\n  const attributeOptions = options.tracingAttributeOptions || {};\n  TracingUtility.setSpanAttributes(\n    span,\n    options.tracingAttributeOptions?.operationName || \"Agent_Operation\",\n    UpdateWithAgentAttributes(attributeOptions),\n  );\n}\nexport function traceEndAgentGeneric<Options extends OptionsWithTracing>(\n  span: Span,\n  _options: Options,\n): void {\n  const attributeOptions = {};\n  TracingUtility.updateSpanAttributes(span, UpdateWithAgentAttributes(attributeOptions));\n}\n\nexport function UpdateWithAgentAttributes(\n  attributeOptions: Omit<TracingAttributeOptions, \"operationName\">,\n): Omit<TracingAttributeOptions, \"operationName\"> {\n  attributeOptions.genAiSystem = TracingAttributes.AZ_AI_AGENT_SYSTEM;\n  return attributeOptions;\n}\n\n/**\n * Adds a message event to the span.\n * @param span - The span to add the event to.\n * @param messageAttributes - The attributes of the message event.\n */\nexport function addMessageEvent(\n  span: Span,\n  messageAttributes: ThreadMessageOptions | ThreadMessage,\n  usage?: RunStepCompletionUsageOutput,\n): void {\n  const eventBody: Record<string, unknown> = {};\n  const telemetryOptions = getTelemetryOptions();\n  if (telemetryOptions.enableContentRecording) {\n    eventBody.content = getMessageContent(messageAttributes.content);\n  }\n  eventBody.role = messageAttributes.role;\n  if (messageAttributes.attachments) {\n    eventBody.attachments = messageAttributes.attachments.map((attachment) => {\n      return {\n        id: attachment.file_id,\n        tools: attachment.tools.map((tool) => tool.type),\n      };\n    });\n  }\n  const threadId = (messageAttributes as ThreadMessage).thread_id;\n  const agentId = (messageAttributes as ThreadMessage).assistant_id ?? undefined;\n  const threadRunId = (messageAttributes as ThreadMessage).run_id;\n  const messageStatus = (messageAttributes as ThreadMessage).status;\n  const messageId = (messageAttributes as ThreadMessage).id;\n  const incompleteDetails = (messageAttributes as ThreadMessage).incomplete_details;\n  if (incompleteDetails) {\n    eventBody.incomplete_details = incompleteDetails;\n  }\n  const usagePromptTokens = usage?.prompt_tokens;\n  const usageCompletionTokens = usage?.completion_tokens;\n  const attributes = {\n    eventContent: JSON.stringify(eventBody),\n    threadId,\n    agentId,\n    threadRunId,\n    messageStatus,\n    messageId,\n    usagePromptTokens,\n    usageCompletionTokens,\n    genAiSystem: TracingAttributes.AZ_AI_AGENT_SYSTEM,\n  };\n  TracingUtility.addSpanEvent(span, `gen_ai.${messageAttributes.role}.message`, attributes);\n}\n\n/**\n * Adds an instruction event to the span.\n * @param span - The span to add the event to.\n * @param instructionAttributes - The attributes of the instruction event.\n */\nexport function addInstructionsEvent(\n  span: Span,\n  instructionAttributes: {\n    instructions?: string | null;\n    additional_instructions?: string | null;\n    threadId?: string;\n    agentId?: string;\n  },\n): void {\n  const eventBody: Record<string, unknown> = {};\n  if (instructionAttributes.instructions || instructionAttributes.additional_instructions) {\n    eventBody.content =\n      instructionAttributes.instructions && instructionAttributes.additional_instructions\n        ? `${instructionAttributes.instructions} ${instructionAttributes.additional_instructions}`\n        : instructionAttributes.instructions || instructionAttributes.additional_instructions;\n  }\n  const attributes = {\n    eventContent: JSON.stringify(eventBody),\n    threadId: instructionAttributes.threadId,\n    agentId: instructionAttributes.agentId,\n    genAiSystem: TracingAttributes.AZ_AI_AGENT_SYSTEM,\n  };\n  TracingUtility.addSpanEvent(span, \"gen_ai.system.message\", attributes);\n}\n\n/**\n * Formats the agent API response.\n * @param responseFormat - The response format option.\n * @returns The formatted response as a string, or null/undefined.\n */\nexport function formatAgentApiResponse(\n  responseFormat: AgentsApiResponseFormatOption | null | undefined,\n): string | undefined {\n  if (\n    typeof responseFormat === \"string\" ||\n    responseFormat === undefined ||\n    responseFormat === null\n  ) {\n    return responseFormat ?? undefined;\n  }\n  if ((responseFormat as AgentsApiResponseFormat).type) {\n    return (responseFormat as AgentsApiResponseFormat).type ?? undefined;\n  }\n  return undefined;\n}\n\n/**\n * Adds a tool messages event to the span\n * @param span - The span to add the event to.\n * @param tool_outputs - List of tool oupts\n */\nexport function addToolMessagesEvent(span: Span, tool_outputs: Array<ToolOutput>): void {\n  tool_outputs.forEach((tool_output) => {\n    const eventBody = { content: tool_output.output, id: tool_output.tool_call_id };\n    TracingUtility.addSpanEvent(span, \"gen_ai.tool.message\", {\n      eventContent: JSON.stringify(eventBody),\n      genAiSystem: TracingAttributes.AZ_AI_AGENT_SYSTEM,\n    });\n  });\n}\n\nfunction getMessageContent(messageContent: string | MessageContent[]): string | {} {\n  type MessageContentExtended = MessageContent & { [key: string]: any };\n  if (!Array.isArray(messageContent)) {\n    return messageContent;\n  }\n  const contentBody: { [key: string]: any } = {};\n  messageContent.forEach((content) => {\n    const typedContent = content.type;\n    const { value, annotations } = (content as MessageContentExtended)[typedContent];\n    contentBody[typedContent] = { value, annotations };\n  });\n  return contentBody;\n}\n"]}

package/dist/esm/agents/utils.d.ts

@@ -0,0 +1,141 @@
+import type { AzureAISearchToolDefinition, CodeInterpreterToolDefinition, FileSearchToolDefinition, FileSearchToolDefinitionDetails, FunctionDefinition, FunctionToolDefinition, RequiredActionOutput, RequiredToolCallOutput, ToolDefinition, ToolDefinitionOutputParent, ToolResources, VectorStoreConfigurations, VectorStoreDataSource } from "./inputOutputs.js";
+/**
+ * Determines if the given output is of the specified type.
+ *
+ * @template T - The type to check against, which extends one of the possible output parent types.
+ * @param output - The action to check, which can be of type `RequiredActionOutput`, `RequiredToolCallOutput`, or `ToolDefinitionOutputParent`.
+ * @param type - The type to check the action against.
+ * @returns A boolean indicating whether the action is of the specified type.
+ */
+export declare function isOutputOfType<T extends {
+    type: string;
+}>(output: RequiredActionOutput | RequiredToolCallOutput | ToolDefinitionOutputParent, type: string): output is T;
+/** Types of connection tools used to configure an agent */
+export declare enum connectionToolType {
+    /** Bing grounding search tool */
+    BingGrounding = "bing_grounding",
+    /** Microsoft Fabric tool */
+    MicrosoftFabric = "microsoft_fabric",
+    /** Sharepoint tool */
+    SharepointGrounding = "sharepoint_grounding"
+}
+/**
+ * Utility class for creating various tools.
+ */
+export declare class ToolUtility {
+    /**
+     * Creates a connection tool
+     *
+     * @param toolType - The type of the connection tool.
+     * @param connectionIds - A list of the IDs of the connections to use.
+     * @returns An object containing the definition for the connection tool
+     */
+    static createConnectionTool(toolType: connectionToolType, connectionIds: string[]): {
+        definition: ToolDefinition;
+    };
+    /**
+     * Creates a file search tool
+     *
+     * @param vectorStoreIds - The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.
+     * @param vectorStores - The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.
+     * @param definitionDetails - The input definition information for a file search tool as used to configure an agent.
+     *
+     * @returns An object containing the definition and resources for the file search tool
+     */
+    static createFileSearchTool(vectorStoreIds?: string[], vectorStores?: Array<VectorStoreConfigurations>, definitionDetails?: FileSearchToolDefinitionDetails): {
+        definition: FileSearchToolDefinition;
+        resources: ToolResources;
+    };
+    /**
+     * Creates a code interpreter tool
+     *
+     * @param fileIds - A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
+     * @param dataSources - The data sources to be used. This option is mutually exclusive with fileIds.
+     *
+     * @returns An object containing the definition and resources for the code interpreter tool.
+     */
+    static createCodeInterpreterTool(fileIds?: string[], dataSources?: Array<VectorStoreDataSource>): {
+        definition: CodeInterpreterToolDefinition;
+        resources: ToolResources;
+    };
+    /**
+     * Creates an Azure AI search tool
+     *
+     * @param indexConnectionId - The connection ID of the Azure AI search index.
+     * @param indexName - The name of the Azure AI search index.
+     *
+     * @returns An object containing the definition and resources for the Azure AI search tool.
+     */
+    static createAzureAISearchTool(indexConnectionId: string, indexName: string): {
+        definition: AzureAISearchToolDefinition;
+        resources: ToolResources;
+    };
+    /**
+     * Creates a function tool
+     *
+     * @param functionDefinition - The function definition to use.
+     *
+     * @returns An object containing the definition for the function tool.
+     */
+    static createFunctionTool(functionDefinition: FunctionDefinition): {
+        definition: FunctionToolDefinition;
+    };
+}
+/**
+ * Represents a set of tools with their definitions and resources.
+ */
+export declare class ToolSet {
+    /** A list of tool definitions that have been added to the tool set. */
+    toolDefinitions: ToolDefinition[];
+    /** A collection of resources associated with the tools in the tool set. */
+    toolResources: ToolResources;
+    /**
+     * Adds a connection tool to the tool set.
+     *
+     * @param toolType - The type of the connection tool.
+     * @param connectionIds - A list of the IDs of the connections to use.
+     *
+     * @returns An object containing the definition for the connection tool
+     */
+    addConnectionTool(toolType: connectionToolType, connectionIds: string[]): {
+        definition: ToolDefinition;
+    };
+    /**
+     * Adds a file search tool to the tool set.
+     *
+     * @param vectorStoreIds - The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.
+     * @param vectorStores -  The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.
+     * @param definitionDetails - The input definition information for a file search tool as used to configure an agent.
+     *
+     * @returns An object containing the definition and resources for the file search tool
+     */
+    addFileSearchTool(vectorStoreIds?: string[], vectorStores?: Array<VectorStoreConfigurations>, definitionDetails?: FileSearchToolDefinitionDetails): {
+        definition: FileSearchToolDefinition;
+        resources: ToolResources;
+    };
+    /**
+     * Adds a code interpreter tool to the tool set.
+     *
+     * @param fileIds - A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
+     * @param dataSources - The data sources to be used. This option is mutually exclusive with fileIds.
+     *
+     * @returns An object containing the definition and resources for the code interpreter tool
+     */
+    addCodeInterpreterTool(fileIds?: string[], dataSources?: Array<VectorStoreDataSource>): {
+        definition: CodeInterpreterToolDefinition;
+        resources: ToolResources;
+    };
+    /**
+     * Adds an Azure AI search tool to the tool set.
+     *
+     * @param indexConnectionId - The connection ID of the Azure AI search index.
+     * @param indexName - The name of the Azure AI search index.
+     *
+     * @returns An object containing the definition and resources for the Azure AI search tool
+     */
+    addAzureAISearchTool(indexConnectionId: string, indexName: string): {
+        definition: AzureAISearchToolDefinition;
+        resources: ToolResources;
+    };
+}
+//# sourceMappingURL=utils.d.ts.map

package/dist/esm/agents/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/agents/utils.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,2BAA2B,EAC3B,6BAA6B,EAC7B,wBAAwB,EACxB,+BAA+B,EAC/B,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,cAAc,EACd,0BAA0B,EAC1B,aAAa,EACb,yBAAyB,EACzB,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,CAAC,SAAS;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,EACvD,MAAM,EAAE,oBAAoB,GAAG,sBAAsB,GAAG,0BAA0B,EAClF,IAAI,EAAE,MAAM,GACX,MAAM,IAAI,CAAC,CAEb;AAED,2DAA2D;AAC3D,oBAAY,kBAAkB;IAC5B,iCAAiC;IACjC,aAAa,mBAAmB;IAChC,4BAA4B;IAC5B,eAAe,qBAAqB;IACpC,sBAAsB;IACtB,mBAAmB,yBAAyB;CAC7C;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB;;;;;;OAMG;IACH,MAAM,CAAC,oBAAoB,CACzB,QAAQ,EAAE,kBAAkB,EAC5B,aAAa,EAAE,MAAM,EAAE,GACtB;QAAE,UAAU,EAAE,cAAc,CAAA;KAAE;IAWjC;;;;;;;;OAQG;IACH,MAAM,CAAC,oBAAoB,CACzB,cAAc,CAAC,EAAE,MAAM,EAAE,EACzB,YAAY,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,EAC/C,iBAAiB,CAAC,EAAE,+BAA+B,GAClD;QAAE,UAAU,EAAE,wBAAwB,CAAC;QAAC,SAAS,EAAE,aAAa,CAAA;KAAE;IAOrE;;;;;;;OAOG;IACH,MAAM,CAAC,yBAAyB,CAC9B,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,GACzC;QAAE,UAAU,EAAE,6BAA6B,CAAC;QAAC,SAAS,EAAE,aAAa,CAAA;KAAE;IAW1E;;;;;;;OAOG;IACH,MAAM,CAAC,uBAAuB,CAC5B,iBAAiB,EAAE,MAAM,EACzB,SAAS,EAAE,MAAM,GAChB;QAAE,UAAU,EAAE,2BAA2B,CAAC;QAAC,SAAS,EAAE,aAAa,CAAA;KAAE;IAWxE;;;;;;OAMG;IACH,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,kBAAkB,GAAG;QACjE,UAAU,EAAE,sBAAsB,CAAC;KACpC;CAQF;AAED;;GAEG;AACH,qBAAa,OAAO;IAClB,uEAAuE;IACvE,eAAe,EAAE,cAAc,EAAE,CAAM;IAEvC,2EAA2E;IAC3E,aAAa,EAAE,aAAa,CAAM;IAElC;;;;;;;OAOG;IACH,iBAAiB,CACf,QAAQ,EAAE,kBAAkB,EAC5B,aAAa,EAAE,MAAM,EAAE,GACtB;QAAE,UAAU,EAAE,cAAc,CAAA;KAAE;IAMjC;;;;;;;;OAQG;IACH,iBAAiB,CACf,cAAc,CAAC,EAAE,MAAM,EAAE,EACzB,YAAY,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,EAC/C,iBAAiB,CAAC,EAAE,+BAA+B,GAClD;QAAE,UAAU,EAAE,wBAAwB,CAAC;QAAC,SAAS,EAAE,aAAa,CAAA;KAAE;IAOrE;;;;;;;OAOG;IACH,sBAAsB,CACpB,OAAO,CAAC,EAAE,MAAM,EAAE,EAClB,WAAW,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,GACzC;QAAE,UAAU,EAAE,6BAA6B,CAAC;QAAC,SAAS,EAAE,aAAa,CAAA;KAAE;IAO1E;;;;;;;OAOG;IACH,oBAAoB,CAClB,iBAAiB,EAAE,MAAM,EACzB,SAAS,EAAE,MAAM,GAChB;QAAE,UAAU,EAAE,2BAA2B,CAAC;QAAC,SAAS,EAAE,aAAa,CAAA;KAAE;CAMzE"}

package/dist/esm/agents/utils.js

@@ -0,0 +1,178 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+/**
+ * Determines if the given output is of the specified type.
+ *
+ * @template T - The type to check against, which extends one of the possible output parent types.
+ * @param output - The action to check, which can be of type `RequiredActionOutput`, `RequiredToolCallOutput`, or `ToolDefinitionOutputParent`.
+ * @param type - The type to check the action against.
+ * @returns A boolean indicating whether the action is of the specified type.
+ */
+export function isOutputOfType(output, type) {
+    return output.type === type;
+}
+/** Types of connection tools used to configure an agent */
+export var connectionToolType;
+(function (connectionToolType) {
+    /** Bing grounding search tool */
+    connectionToolType["BingGrounding"] = "bing_grounding";
+    /** Microsoft Fabric tool */
+    connectionToolType["MicrosoftFabric"] = "microsoft_fabric";
+    /** Sharepoint tool */
+    connectionToolType["SharepointGrounding"] = "sharepoint_grounding";
+})(connectionToolType || (connectionToolType = {}));
+/**
+ * Utility class for creating various tools.
+ */
+export class ToolUtility {
+    /**
+     * Creates a connection tool
+     *
+     * @param toolType - The type of the connection tool.
+     * @param connectionIds - A list of the IDs of the connections to use.
+     * @returns An object containing the definition for the connection tool
+     */
+    static createConnectionTool(toolType, connectionIds) {
+        return {
+            definition: {
+                type: toolType,
+                [toolType]: {
+                    connections: connectionIds.map((connectionId) => ({ connectionId: connectionId })),
+                },
+            },
+        };
+    }
+    /**
+     * Creates a file search tool
+     *
+     * @param vectorStoreIds - The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.
+     * @param vectorStores - The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.
+     * @param definitionDetails - The input definition information for a file search tool as used to configure an agent.
+     *
+     * @returns An object containing the definition and resources for the file search tool
+     */
+    static createFileSearchTool(vectorStoreIds, vectorStores, definitionDetails) {
+        return {
+            definition: { type: "file_search", fileSearch: definitionDetails },
+            resources: { fileSearch: { vectorStoreIds: vectorStoreIds, vectorStores: vectorStores } },
+        };
+    }
+    /**
+     * Creates a code interpreter tool
+     *
+     * @param fileIds - A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
+     * @param dataSources - The data sources to be used. This option is mutually exclusive with fileIds.
+     *
+     * @returns An object containing the definition and resources for the code interpreter tool.
+     */
+    static createCodeInterpreterTool(fileIds, dataSources) {
+        if (fileIds && dataSources) {
+            throw new Error("Cannot specify both fileIds and dataSources");
+        }
+        return {
+            definition: { type: "code_interpreter" },
+            resources: { codeInterpreter: { fileIds: fileIds, dataSources: dataSources } },
+        };
+    }
+    /**
+     * Creates an Azure AI search tool
+     *
+     * @param indexConnectionId - The connection ID of the Azure AI search index.
+     * @param indexName - The name of the Azure AI search index.
+     *
+     * @returns An object containing the definition and resources for the Azure AI search tool.
+     */
+    static createAzureAISearchTool(indexConnectionId, indexName) {
+        return {
+            definition: { type: "azure_ai_search" },
+            resources: {
+                azureAISearch: {
+                    indexes: [{ indexConnectionId: indexConnectionId, indexName: indexName }],
+                },
+            },
+        };
+    }
+    /**
+     * Creates a function tool
+     *
+     * @param functionDefinition - The function definition to use.
+     *
+     * @returns An object containing the definition for the function tool.
+     */
+    static createFunctionTool(functionDefinition) {
+        return {
+            definition: {
+                type: "function",
+                function: functionDefinition,
+            },
+        };
+    }
+}
+/**
+ * Represents a set of tools with their definitions and resources.
+ */
+export class ToolSet {
+    constructor() {
+        /** A list of tool definitions that have been added to the tool set. */
+        this.toolDefinitions = [];
+        /** A collection of resources associated with the tools in the tool set. */
+        this.toolResources = {};
+    }
+    /**
+     * Adds a connection tool to the tool set.
+     *
+     * @param toolType - The type of the connection tool.
+     * @param connectionIds - A list of the IDs of the connections to use.
+     *
+     * @returns An object containing the definition for the connection tool
+     */
+    addConnectionTool(toolType, connectionIds) {
+        const tool = ToolUtility.createConnectionTool(toolType, connectionIds);
+        this.toolDefinitions.push(tool.definition);
+        return tool;
+    }
+    /**
+     * Adds a file search tool to the tool set.
+     *
+     * @param vectorStoreIds - The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.
+     * @param vectorStores -  The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.
+     * @param definitionDetails - The input definition information for a file search tool as used to configure an agent.
+     *
+     * @returns An object containing the definition and resources for the file search tool
+     */
+    addFileSearchTool(vectorStoreIds, vectorStores, definitionDetails) {
+        const tool = ToolUtility.createFileSearchTool(vectorStoreIds, vectorStores, definitionDetails);
+        this.toolDefinitions.push(tool.definition);
+        this.toolResources = Object.assign(Object.assign({}, this.toolResources), tool.resources);
+        return tool;
+    }
+    /**
+     * Adds a code interpreter tool to the tool set.
+     *
+     * @param fileIds - A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.
+     * @param dataSources - The data sources to be used. This option is mutually exclusive with fileIds.
+     *
+     * @returns An object containing the definition and resources for the code interpreter tool
+     */
+    addCodeInterpreterTool(fileIds, dataSources) {
+        const tool = ToolUtility.createCodeInterpreterTool(fileIds, dataSources);
+        this.toolDefinitions.push(tool.definition);
+        this.toolResources = Object.assign(Object.assign({}, this.toolResources), tool.resources);
+        return tool;
+    }
+    /**
+     * Adds an Azure AI search tool to the tool set.
+     *
+     * @param indexConnectionId - The connection ID of the Azure AI search index.
+     * @param indexName - The name of the Azure AI search index.
+     *
+     * @returns An object containing the definition and resources for the Azure AI search tool
+     */
+    addAzureAISearchTool(indexConnectionId, indexName) {
+        const tool = ToolUtility.createAzureAISearchTool(indexConnectionId, indexName);
+        this.toolDefinitions.push(tool.definition);
+        this.toolResources = Object.assign(Object.assign({}, this.toolResources), tool.resources);
+        return tool;
+    }
+}
+//# sourceMappingURL=utils.js.map

package/dist/esm/agents/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/agents/utils.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAkBlC;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAC5B,MAAkF,EAClF,IAAY;IAEZ,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC;AAC9B,CAAC;AAED,2DAA2D;AAC3D,MAAM,CAAN,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,iCAAiC;IACjC,sDAAgC,CAAA;IAChC,4BAA4B;IAC5B,0DAAoC,CAAA;IACpC,sBAAsB;IACtB,kEAA4C,CAAA;AAC9C,CAAC,EAPW,kBAAkB,KAAlB,kBAAkB,QAO7B;AAED;;GAEG;AACH,MAAM,OAAO,WAAW;IACtB;;;;;;OAMG;IACH,MAAM,CAAC,oBAAoB,CACzB,QAA4B,EAC5B,aAAuB;QAEvB,OAAO;YACL,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,CAAC,QAAQ,CAAC,EAAE;oBACV,WAAW,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC,CAAC;iBACnF;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,oBAAoB,CACzB,cAAyB,EACzB,YAA+C,EAC/C,iBAAmD;QAEnD,OAAO;YACL,UAAU,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,iBAAiB,EAAE;YAClE,SAAS,EAAE,EAAE,UAAU,EAAE,EAAE,cAAc,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,EAAE;SAC1F,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,yBAAyB,CAC9B,OAAkB,EAClB,WAA0C;QAE1C,IAAI,OAAO,IAAI,WAAW,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,OAAO;YACL,UAAU,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE;YACxC,SAAS,EAAE,EAAE,eAAe,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,EAAE;SAC/E,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,uBAAuB,CAC5B,iBAAyB,EACzB,SAAiB;QAEjB,OAAO;YACL,UAAU,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE;YACvC,SAAS,EAAE;gBACT,aAAa,EAAE;oBACb,OAAO,EAAE,CAAC,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,SAAS,EAAE,SAAS,EAAE,CAAC;iBAC1E;aACF;SACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,kBAAkB,CAAC,kBAAsC;QAG9D,OAAO;YACL,UAAU,EAAE;gBACV,IAAI,EAAE,UAAU;gBAChB,QAAQ,EAAE,kBAAkB;aAC7B;SACF,CAAC;IACJ,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,OAAO;IAApB;QACE,uEAAuE;QACvE,oBAAe,GAAqB,EAAE,CAAC;QAEvC,2EAA2E;QAC3E,kBAAa,GAAkB,EAAE,CAAC;IA0EpC,CAAC;IAxEC;;;;;;;OAOG;IACH,iBAAiB,CACf,QAA4B,EAC5B,aAAuB;QAEvB,MAAM,IAAI,GAAG,WAAW,CAAC,oBAAoB,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC;QACvE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CACf,cAAyB,EACzB,YAA+C,EAC/C,iBAAmD;QAEnD,MAAM,IAAI,GAAG,WAAW,CAAC,oBAAoB,CAAC,cAAc,EAAE,YAAY,EAAE,iBAAiB,CAAC,CAAC;QAC/F,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,mCAAQ,IAAI,CAAC,aAAa,GAAK,IAAI,CAAC,SAAS,CAAE,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,sBAAsB,CACpB,OAAkB,EAClB,WAA0C;QAE1C,MAAM,IAAI,GAAG,WAAW,CAAC,yBAAyB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;QACzE,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,mCAAQ,IAAI,CAAC,aAAa,GAAK,IAAI,CAAC,SAAS,CAAE,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,oBAAoB,CAClB,iBAAyB,EACzB,SAAiB;QAEjB,MAAM,IAAI,GAAG,WAAW,CAAC,uBAAuB,CAAC,iBAAiB,EAAE,SAAS,CAAC,CAAC;QAC/E,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,CAAC,aAAa,mCAAQ,IAAI,CAAC,aAAa,GAAK,IAAI,CAAC,SAAS,CAAE,CAAC;QAClE,OAAO,IAAI,CAAC;IACd,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  AzureAISearchToolDefinition,\n  CodeInterpreterToolDefinition,\n  FileSearchToolDefinition,\n  FileSearchToolDefinitionDetails,\n  FunctionDefinition,\n  FunctionToolDefinition,\n  RequiredActionOutput,\n  RequiredToolCallOutput,\n  ToolDefinition,\n  ToolDefinitionOutputParent,\n  ToolResources,\n  VectorStoreConfigurations,\n  VectorStoreDataSource,\n} from \"./inputOutputs.js\";\n\n/**\n * Determines if the given output is of the specified type.\n *\n * @template T - The type to check against, which extends one of the possible output parent types.\n * @param output - The action to check, which can be of type `RequiredActionOutput`, `RequiredToolCallOutput`, or `ToolDefinitionOutputParent`.\n * @param type - The type to check the action against.\n * @returns A boolean indicating whether the action is of the specified type.\n */\nexport function isOutputOfType<T extends { type: string }>(\n  output: RequiredActionOutput | RequiredToolCallOutput | ToolDefinitionOutputParent,\n  type: string,\n): output is T {\n  return output.type === type;\n}\n\n/** Types of connection tools used to configure an agent */\nexport enum connectionToolType {\n  /** Bing grounding search tool */\n  BingGrounding = \"bing_grounding\",\n  /** Microsoft Fabric tool */\n  MicrosoftFabric = \"microsoft_fabric\",\n  /** Sharepoint tool */\n  SharepointGrounding = \"sharepoint_grounding\",\n}\n\n/**\n * Utility class for creating various tools.\n */\nexport class ToolUtility {\n  /**\n   * Creates a connection tool\n   *\n   * @param toolType - The type of the connection tool.\n   * @param connectionIds - A list of the IDs of the connections to use.\n   * @returns An object containing the definition for the connection tool\n   */\n  static createConnectionTool(\n    toolType: connectionToolType,\n    connectionIds: string[],\n  ): { definition: ToolDefinition } {\n    return {\n      definition: {\n        type: toolType,\n        [toolType]: {\n          connections: connectionIds.map((connectionId) => ({ connectionId: connectionId })),\n        },\n      },\n    };\n  }\n\n  /**\n   * Creates a file search tool\n   *\n   * @param vectorStoreIds - The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.\n   * @param vectorStores - The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.\n   * @param definitionDetails - The input definition information for a file search tool as used to configure an agent.\n   *\n   * @returns An object containing the definition and resources for the file search tool\n   */\n  static createFileSearchTool(\n    vectorStoreIds?: string[],\n    vectorStores?: Array<VectorStoreConfigurations>,\n    definitionDetails?: FileSearchToolDefinitionDetails,\n  ): { definition: FileSearchToolDefinition; resources: ToolResources } {\n    return {\n      definition: { type: \"file_search\", fileSearch: definitionDetails },\n      resources: { fileSearch: { vectorStoreIds: vectorStoreIds, vectorStores: vectorStores } },\n    };\n  }\n\n  /**\n   * Creates a code interpreter tool\n   *\n   * @param fileIds - A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n   * @param dataSources - The data sources to be used. This option is mutually exclusive with fileIds.\n   *\n   * @returns An object containing the definition and resources for the code interpreter tool.\n   */\n  static createCodeInterpreterTool(\n    fileIds?: string[],\n    dataSources?: Array<VectorStoreDataSource>,\n  ): { definition: CodeInterpreterToolDefinition; resources: ToolResources } {\n    if (fileIds && dataSources) {\n      throw new Error(\"Cannot specify both fileIds and dataSources\");\n    }\n\n    return {\n      definition: { type: \"code_interpreter\" },\n      resources: { codeInterpreter: { fileIds: fileIds, dataSources: dataSources } },\n    };\n  }\n\n  /**\n   * Creates an Azure AI search tool\n   *\n   * @param indexConnectionId - The connection ID of the Azure AI search index.\n   * @param indexName - The name of the Azure AI search index.\n   *\n   * @returns An object containing the definition and resources for the Azure AI search tool.\n   */\n  static createAzureAISearchTool(\n    indexConnectionId: string,\n    indexName: string,\n  ): { definition: AzureAISearchToolDefinition; resources: ToolResources } {\n    return {\n      definition: { type: \"azure_ai_search\" },\n      resources: {\n        azureAISearch: {\n          indexes: [{ indexConnectionId: indexConnectionId, indexName: indexName }],\n        },\n      },\n    };\n  }\n\n  /**\n   * Creates a function tool\n   *\n   * @param functionDefinition - The function definition to use.\n   *\n   * @returns An object containing the definition for the function tool.\n   */\n  static createFunctionTool(functionDefinition: FunctionDefinition): {\n    definition: FunctionToolDefinition;\n  } {\n    return {\n      definition: {\n        type: \"function\",\n        function: functionDefinition,\n      },\n    };\n  }\n}\n\n/**\n * Represents a set of tools with their definitions and resources.\n */\nexport class ToolSet {\n  /** A list of tool definitions that have been added to the tool set. */\n  toolDefinitions: ToolDefinition[] = [];\n\n  /** A collection of resources associated with the tools in the tool set. */\n  toolResources: ToolResources = {};\n\n  /**\n   * Adds a connection tool to the tool set.\n   *\n   * @param toolType - The type of the connection tool.\n   * @param connectionIds - A list of the IDs of the connections to use.\n   *\n   * @returns An object containing the definition for the connection tool\n   */\n  addConnectionTool(\n    toolType: connectionToolType,\n    connectionIds: string[],\n  ): { definition: ToolDefinition } {\n    const tool = ToolUtility.createConnectionTool(toolType, connectionIds);\n    this.toolDefinitions.push(tool.definition);\n    return tool;\n  }\n\n  /**\n   * Adds a file search tool to the tool set.\n   *\n   * @param vectorStoreIds - The ID of the vector store attached to this agent. There can be a maximum of 1 vector store attached to the agent.\n   * @param vectorStores -  The list of vector store configuration objects from Azure. This list is limited to one element. The only element of this list contains the list of azure asset IDs used by the search tool.\n   * @param definitionDetails - The input definition information for a file search tool as used to configure an agent.\n   *\n   * @returns An object containing the definition and resources for the file search tool\n   */\n  addFileSearchTool(\n    vectorStoreIds?: string[],\n    vectorStores?: Array<VectorStoreConfigurations>,\n    definitionDetails?: FileSearchToolDefinitionDetails,\n  ): { definition: FileSearchToolDefinition; resources: ToolResources } {\n    const tool = ToolUtility.createFileSearchTool(vectorStoreIds, vectorStores, definitionDetails);\n    this.toolDefinitions.push(tool.definition);\n    this.toolResources = { ...this.toolResources, ...tool.resources };\n    return tool;\n  }\n\n  /**\n   * Adds a code interpreter tool to the tool set.\n   *\n   * @param fileIds - A list of file IDs made available to the `code_interpreter` tool. There can be a maximum of 20 files associated with the tool.\n   * @param dataSources - The data sources to be used. This option is mutually exclusive with fileIds.\n   *\n   * @returns An object containing the definition and resources for the code interpreter tool\n   */\n  addCodeInterpreterTool(\n    fileIds?: string[],\n    dataSources?: Array<VectorStoreDataSource>,\n  ): { definition: CodeInterpreterToolDefinition; resources: ToolResources } {\n    const tool = ToolUtility.createCodeInterpreterTool(fileIds, dataSources);\n    this.toolDefinitions.push(tool.definition);\n    this.toolResources = { ...this.toolResources, ...tool.resources };\n    return tool;\n  }\n\n  /**\n   * Adds an Azure AI search tool to the tool set.\n   *\n   * @param indexConnectionId - The connection ID of the Azure AI search index.\n   * @param indexName - The name of the Azure AI search index.\n   *\n   * @returns An object containing the definition and resources for the Azure AI search tool\n   */\n  addAzureAISearchTool(\n    indexConnectionId: string,\n    indexName: string,\n  ): { definition: AzureAISearchToolDefinition; resources: ToolResources } {\n    const tool = ToolUtility.createAzureAISearchTool(indexConnectionId, indexName);\n    this.toolDefinitions.push(tool.definition);\n    this.toolResources = { ...this.toolResources, ...tool.resources };\n    return tool;\n  }\n}\n"]}

package/dist/esm/agents/vectorStores.d.ts

@@ -0,0 +1,20 @@
+import type { Client } from "@azure-rest/core-client";
+import type { OpenAIPageableListOfVectorStoreOutput, VectorStoreDeletionStatusOutput, VectorStoreOutput } from "../customization/outputModels.js";
+import type { CreateVectorStoreWithPollingOptionalParams } from "./customModels.js";
+import { type CreateVectorStoreOptionalParams, type DeleteVectorStoreOptionalParams, type GetVectorStoreOptionalParams, type ListVectorStoresOptionalParams, type UpdateVectorStoreOptionalParams } from "./customModels.js";
+import type { PollerLike, PollOperationState } from "@azure/core-lro";
+/** Returns a list of vector stores. */
+export declare function listVectorStores(context: Client, options?: ListVectorStoresOptionalParams): Promise<OpenAIPageableListOfVectorStoreOutput>;
+/** Creates a vector store. */
+export declare function createVectorStore(context: Client, options?: CreateVectorStoreOptionalParams): Promise<VectorStoreOutput>;
+/** Returns the vector store object matching the specified ID. */
+export declare function getVectorStore(context: Client, vectorStoreId: string, options?: GetVectorStoreOptionalParams): Promise<VectorStoreOutput>;
+/** The ID of the vector store to modify. */
+export declare function modifyVectorStore(context: Client, vectorStoreId: string, options?: UpdateVectorStoreOptionalParams): Promise<VectorStoreOutput>;
+/** Deletes the vector store object matching the specified ID. */
+export declare function deleteVectorStore(context: Client, vectorStoreId: string, options?: DeleteVectorStoreOptionalParams): Promise<VectorStoreDeletionStatusOutput>;
+/**
+ * Creates a vector store and poll.
+ */
+export declare function createVectorStoreAndPoll(context: Client, options?: CreateVectorStoreWithPollingOptionalParams): PollerLike<PollOperationState<VectorStoreOutput>, VectorStoreOutput>;
+//# sourceMappingURL=vectorStores.d.ts.map

package/dist/esm/agents/vectorStores.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vectorStores.d.ts","sourceRoot":"","sources":["../../../src/agents/vectorStores.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AAOtD,OAAO,KAAK,EACV,qCAAqC,EACrC,+BAA+B,EAC/B,iBAAiB,EAClB,MAAM,kCAAkC,CAAC;AAE1C,OAAO,KAAK,EAAE,0CAA0C,EAAE,MAAM,mBAAmB,CAAC;AACpF,OAAO,EACL,KAAK,+BAA+B,EACpC,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,8BAA8B,EACnC,KAAK,+BAA+B,EACrC,MAAM,mBAAmB,CAAC;AAY3B,OAAO,KAAK,EAAE,UAAU,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAItE,uCAAuC;AACvC,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,8BAAmC,GAC3C,OAAO,CAAC,qCAAqC,CAAC,CAahD;AAED,8BAA8B;AAC9B,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,+BAAoC,GAC5C,OAAO,CAAC,iBAAiB,CAAC,CAa5B;AAED,iEAAiE;AACjE,wBAAsB,cAAc,CAClC,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,4BAAiC,GACzC,OAAO,CAAC,iBAAiB,CAAC,CAc5B;AAED,4CAA4C;AAC5C,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,+BAAoC,GAC5C,OAAO,CAAC,iBAAiB,CAAC,CAgB5B;AAED,iEAAiE;AACjE,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,MAAM,EACf,aAAa,EAAE,MAAM,EACrB,OAAO,GAAE,+BAAoC,GAC5C,OAAO,CAAC,+BAA+B,CAAC,CAc1C;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,0CAA+C,GACvD,UAAU,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC,CAuBtE"}

package/dist/esm/agents/vectorStores.js

@@ -0,0 +1,116 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import { operationOptionsToRequestParameters } from "@azure-rest/core-client";
+import { AgentsPoller } from "./poller.js";
+import { validateLimit, validateMetadata, validateOrder, validateVectorStoreId, } from "./inputValidations.js";
+import * as ConvertFromWire from "../customization/convertOutputModelsFromWire.js";
+import * as ConvertToWire from "../customization/convertModelsToWrite.js";
+import { convertToListQueryParameters } from "../customization/convertParametersToWire.js";
+import { createOpenAIError } from "./openAIError.js";
+const expectedStatuses = ["200"];
+/** Returns a list of vector stores. */
+export async function listVectorStores(context, options = {}) {
+    const listOptions = Object.assign(Object.assign({}, operationOptionsToRequestParameters(options)), { queryParameters: convertToListQueryParameters(options) });
+    validateListVectorStoresParameters(listOptions);
+    const result = await context.path("/vector_stores").get(listOptions);
+    if (!expectedStatuses.includes(result.status)) {
+        throw createOpenAIError(result);
+    }
+    return ConvertFromWire.convertOpenAIPageableListOfVectorStoreOutput(result.body);
+}
+/** Creates a vector store. */
+export async function createVectorStore(context, options = {}) {
+    const createOptions = Object.assign(Object.assign({}, operationOptionsToRequestParameters(options)), { body: ConvertToWire.convertVectorStoreOptions(options) });
+    validateCreateVectorStoreParameters(createOptions);
+    const result = await context.path("/vector_stores").post(createOptions);
+    if (!expectedStatuses.includes(result.status)) {
+        throw createOpenAIError(result);
+    }
+    return ConvertFromWire.convertVectorStoreOutput(result.body);
+}
+/** Returns the vector store object matching the specified ID. */
+export async function getVectorStore(context, vectorStoreId, options = {}) {
+    const getOptions = Object.assign({}, operationOptionsToRequestParameters(options));
+    validateVectorStoreId(vectorStoreId);
+    const result = await context
+        .path("/vector_stores/{vectorStoreId}", vectorStoreId)
+        .get(getOptions);
+    if (!expectedStatuses.includes(result.status)) {
+        throw createOpenAIError(result);
+    }
+    return ConvertFromWire.convertVectorStoreOutput(result.body);
+}
+/** The ID of the vector store to modify. */
+export async function modifyVectorStore(context, vectorStoreId, options = {}) {
+    const modifyOptions = Object.assign(Object.assign({}, operationOptionsToRequestParameters(options)), { body: ConvertToWire.convertVectorStoreUpdateOptions(options) });
+    validateVectorStoreId(vectorStoreId);
+    validateModifyVectorStoreParameters(modifyOptions);
+    const result = await context
+        .path("/vector_stores/{vectorStoreId}", vectorStoreId)
+        .post(modifyOptions);
+    if (!expectedStatuses.includes(result.status)) {
+        throw createOpenAIError(result);
+    }
+    return ConvertFromWire.convertVectorStoreOutput(result.body);
+}
+/** Deletes the vector store object matching the specified ID. */
+export async function deleteVectorStore(context, vectorStoreId, options = {}) {
+    const deleteOptions = Object.assign({}, operationOptionsToRequestParameters(options));
+    validateVectorStoreId(vectorStoreId);
+    const result = await context
+        .path("/vector_stores/{vectorStoreId}", vectorStoreId)
+        .delete(deleteOptions);
+    if (!expectedStatuses.includes(result.status)) {
+        throw createOpenAIError(result);
+    }
+    return ConvertFromWire.convertVectorStoreDeletionStatusOutput(result.body);
+}
+/**
+ * Creates a vector store and poll.
+ */
+export function createVectorStoreAndPoll(context, options = {}) {
+    async function updateCreateVectorStorePoll(currentResult) {
+        let vectorStore;
+        if (!currentResult) {
+            vectorStore = await createVectorStore(context, options);
+        }
+        else {
+            const getOptions = Object.assign({}, operationOptionsToRequestParameters(options));
+            vectorStore = await getVectorStore(context, currentResult.id, getOptions);
+        }
+        return {
+            result: vectorStore,
+            completed: vectorStore.status !== "in_progress",
+        };
+    }
+    return new AgentsPoller({
+        update: updateCreateVectorStorePoll,
+        pollingOptions: options.pollingOptions,
+    });
+}
+function validateListVectorStoresParameters(options) {
+    var _a, _b;
+    if ((_a = options === null || options === void 0 ? void 0 : options.queryParameters) === null || _a === void 0 ? void 0 : _a.limit) {
+        validateLimit(options.queryParameters.limit);
+    }
+    if ((_b = options === null || options === void 0 ? void 0 : options.queryParameters) === null || _b === void 0 ? void 0 : _b.order) {
+        validateOrder(options.queryParameters.order);
+    }
+}
+function validateCreateVectorStoreParameters(options) {
+    var _a, _b;
+    if (((_a = options === null || options === void 0 ? void 0 : options.body) === null || _a === void 0 ? void 0 : _a.chunking_strategy) &&
+        (!options.body.file_ids || options.body.file_ids.length === 0)) {
+        throw new Error("Chunking strategy is only applicable if fileIds is non-empty");
+    }
+    if ((_b = options === null || options === void 0 ? void 0 : options.body) === null || _b === void 0 ? void 0 : _b.metadata) {
+        validateMetadata(options.body.metadata);
+    }
+}
+function validateModifyVectorStoreParameters(options) {
+    var _a;
+    if ((_a = options === null || options === void 0 ? void 0 : options.body) === null || _a === void 0 ? void 0 : _a.metadata) {
+        validateMetadata(options.body.metadata);
+    }
+}
+//# sourceMappingURL=vectorStores.js.map