@equinor/fusion-framework-cli-plugin-ai-search 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,65 @@
+# @equinor/fusion-framework-cli-plugin-ai-search
+
+## 1.0.0
+
+### Major Changes
+
+- [`e2d2a76`](https://github.com/equinor/fusion-framework/commit/e2d2a76d08b86c3a9d8783fed1606551df9d5633) Thanks [@odinr](https://github.com/odinr)! - Add new AI search plugin package for vector store search capabilities.
+
+  This plugin extends the Fusion Framework CLI with semantic search functionality for querying vector store embeddings, enabling validation of indexed documents and retrieval of relevant content.
+
+  **Features:**
+
+  - Semantic search using vector embeddings
+  - Configurable result limits
+  - OData filter expressions for metadata-based filtering
+  - Multiple search types (similarity and MMR - Maximum Marginal Relevance)
+  - JSON output option for programmatic use
+  - Raw metadata output option
+  - Verbose output mode
+
+  **Quick Usage:**
+
+  1. Install the plugin:
+
+  ```sh
+  pnpm add -D @equinor/fusion-framework-cli-plugin-ai-search
+  ```
+
+  2. Configure in `fusion-cli.config.ts`:
+
+  ```typescript
+  import { defineFusionCli } from "@equinor/fusion-framework-cli";
+
+  export default defineFusionCli(() => ({
+    plugins: ["@equinor/fusion-framework-cli-plugin-ai-search"],
+  }));
+  ```
+
+  3. Use the search command:
+
+  ```sh
+  # Basic semantic search
+  ffc ai search "how to use the framework"
+
+  # Limit results and use MMR search
+  ffc ai search "authentication" --limit 5 --search-type mmr
+
+  # Filter by metadata
+  ffc ai search "typescript" --filter "metadata/source eq 'src/index.ts'"
+
+  # JSON output for programmatic use
+  ffc ai search "documentation" --json
+
+  # Raw metadata output
+  ffc ai search "API reference" --json --raw --verbose
+  ```
+
+  The plugin supports Azure OpenAI and Azure Cognitive Search configuration via command-line options or environment variables.
+
+### Patch Changes
+
+- Updated dependencies [[`e2d2a76`](https://github.com/equinor/fusion-framework/commit/e2d2a76d08b86c3a9d8783fed1606551df9d5633), [`e2d2a76`](https://github.com/equinor/fusion-framework/commit/e2d2a76d08b86c3a9d8783fed1606551df9d5633), [`e2d2a76`](https://github.com/equinor/fusion-framework/commit/e2d2a76d08b86c3a9d8783fed1606551df9d5633)]:
+  - @equinor/fusion-framework-cli-plugin-ai-base@1.0.0
+  - @equinor/fusion-framework-cli@13.0.0
+  - @equinor/fusion-framework-module-ai@2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Equinor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# @equinor/fusion-framework-cli-plugin-ai-search
+
+AI search plugin for Fusion Framework CLI providing vector store search capabilities.
+
+## Installation
+
+```sh
+pnpm add -D @equinor/fusion-framework-cli-plugin-ai-search
+```
+
+## Configuration
+
+After installing the plugin, create a `fusion-cli.config.ts` file in your project root:
+
+```typescript
+import { defineFusionCli } from '@equinor/fusion-framework-cli';
+
+export default defineFusionCli(() => ({
+  plugins: [
+    '@equinor/fusion-framework-cli-plugin-ai-search',
+  ],
+}));
+```
+
+The CLI will automatically discover and load plugins listed in this configuration file. The config file can be `.ts`, `.js`, or `.json`. The `defineFusionCli` helper provides type safety and IntelliSense support.
+
+## Features
+
+This plugin extends the Fusion Framework CLI with AI search capabilities:
+
+- **Vector store search** for validating embeddings
+- Semantic search using vector embeddings
+- Configurable result limits
+- Filter support for metadata-based filtering
+- JSON output option for programmatic use
+
+## Usage
+
+Once installed, the search command is automatically available:
+
+```sh
+# Search the vector store
+ffc ai search "your query"
+```
+
+## Commands
+
+### `ai search`
+
+Search the vector store to validate embeddings and retrieve relevant documents.
+
+**Features:**
+- Semantic search using vector embeddings
+- Configurable result limits
+- Filter support for metadata-based filtering
+- JSON output option for programmatic use
+- Detailed result display with scores and metadata
+
+**Options:**
+- `--limit <number>` - Maximum number of results to return (default: 10)
+- `--search-type <type>` - Search type: 'mmr' or 'similarity' (default: similarity)
+- `--filter <expression>` - OData filter expression for metadata filtering
+- `--json` - Output results as JSON
+- `--raw` - Output raw metadata without normalization
+- `--verbose` - Enable verbose output
+- `--openai-api-key <key>` - API key for Azure OpenAI
+- `--openai-api-version <version>` - API version (default: 2024-02-15-preview)
+- `--openai-instance <name>` - Azure OpenAI instance name
+- `--openai-embedding-deployment <name>` - Azure OpenAI embedding deployment name
+- `--azure-search-endpoint <url>` - Azure Search endpoint URL
+- `--azure-search-api-key <key>` - Azure Search API key
+- `--azure-search-index-name <name>` - Azure Search index name
+
+**Examples:**
+```sh
+$ ffc ai search "how to use the framework"
+$ ffc ai search "authentication" --limit 5
+$ ffc ai search "typescript" --filter "metadata/source eq 'src/index.ts'"
+$ ffc ai search "documentation" --search-type mmr
+$ ffc ai search "documentation" --json
+$ ffc ai search "documentation" --json --raw
+$ ffc ai search "API reference" --verbose
+```
+
+## Configuration
+
+The plugin requires Azure OpenAI and Azure Cognitive Search configuration. See the main CLI documentation for details on setting up API keys and endpoints.
+
+## License
+
+ISC
+

package/dist/esm/index.js

@@ -0,0 +1,11 @@
+import { registerAiPlugin as registerAiPluginBase } from '@equinor/fusion-framework-cli-plugin-ai-base';
+import { command as searchCommand } from './search.js';
+/**
+ * Registers the AI search plugin command with the CLI program
+ * @param program - The Commander program instance to register commands with
+ */
+export function registerAiPlugin(program) {
+    registerAiPluginBase(program, searchCommand);
+}
+export default registerAiPlugin;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,IAAI,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACxG,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,aAAa,CAAC;AAEvD;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,OAAgB;IAC/C,oBAAoB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;AAC/C,CAAC;AAED,eAAe,gBAAgB,CAAC"}

package/dist/esm/options/ai.js

@@ -0,0 +1,152 @@
+import { createOption, InvalidOptionArgumentError } from 'commander';
+/**
+ * Option for specifying the Azure OpenAI API key.
+ * Required for authentication with Azure OpenAI services.
+ */
+export const apiKeyOption = createOption('--openai-api-key <key>', 'API key for Azure OpenAI services').env('AZURE_OPENAI_API_KEY');
+/**
+ * Option for specifying the Azure OpenAI API version.
+ * Defaults to the latest stable version if not provided.
+ */
+export const apiVersionOption = createOption('--openai-api-version <version>', 'Azure OpenAI API version')
+    .env('AZURE_OPENAI_API_VERSION')
+    .default('2024-02-15-preview');
+/**
+ * Option for specifying the Azure OpenAI instance name.
+ * Required for Azure OpenAI service endpoint construction.
+ */
+export const apiInstanceOption = createOption('--openai-instance <name>', 'Azure OpenAI instance name').env('AZURE_OPENAI_INSTANCE_NAME');
+/**
+ * Option for specifying the Azure OpenAI deployment name for chat models.
+ * Required for chat completions API calls.
+ */
+export const chatDeploymentOption = createOption('--openai-chat-deployment <name>', 'Azure OpenAI chat deployment name').env('AZURE_OPENAI_CHAT_DEPLOYMENT_NAME');
+/**
+ * Option for specifying the Azure OpenAI deployment name for embedding models.
+ * Required for embeddings API calls.
+ */
+export const embeddingDeploymentOption = createOption('--openai-embedding-deployment <name>', 'Azure OpenAI embedding deployment name').env('AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME');
+/**
+ * Option for specifying the Azure Search endpoint URL.
+ * Required for Azure Cognitive Search operations.
+ */
+export const azureSearchEndpointOption = createOption('--azure-search-endpoint <url>', 'Azure Search endpoint URL').env('AZURE_SEARCH_ENDPOINT');
+/**
+ * Option for specifying the Azure Search API key.
+ * Required for authentication with Azure Cognitive Search.
+ */
+export const azureSearchApiKeyOption = createOption('--azure-search-api-key <key>', 'Azure Search API key').env('AZURE_SEARCH_API_KEY');
+/**
+ * Option for specifying the Azure Search index name.
+ * Required for search operations on a specific index.
+ */
+export const azureSearchIndexNameOption = createOption('--azure-search-index-name <name>', 'Azure Search index name').env('AZURE_SEARCH_INDEX_NAME');
+/**
+ * Enhances a given command with AI-related options.
+ *
+ * This function adds the following options to the provided command:
+ * - `openaiApiKey`: Azure OpenAI API key
+ * - `openaiApiVersion`: Azure OpenAI API version
+ * - `openaiInstance`: Azure OpenAI instance name
+ * - `openaiChatDeployment`: Chat model deployment name
+ * - `openaiEmbeddingDeployment`: Embedding model deployment name (if includeEmbedding is true)
+ * - `azureSearchEndpoint`: Azure Search endpoint URL (if includeSearch is true)
+ * - `azureSearchApiKey`: Azure Search API key (if includeSearch is true)
+ * - `azureSearchIndexName`: Azure Search index name (if includeSearch is true)
+ *
+ * @param command - The command to which AI options will be added
+ * @param args - Optional configuration for which options to include
+ * @param args.includeEmbedding - Whether to include embedding deployment option
+ * @param args.includeChat - Whether to include chat deployment option (defaults to true)
+ * @param args.includeSearch - Whether to include Azure Search options (defaults to false)
+ * @returns The enhanced command with AI options
+ *
+ * @example
+ * ```ts
+ * import { createCommand } from 'commander';
+ * import { withAiOptions } from './path/to/this/file';
+ *
+ * const command = withAiOptions(
+ *   createCommand('ai-chat')
+ *     .description('Chat with AI models')
+ *     .action((options) => {
+ *       console.log('API Key:', options.openaiApiKey);
+ *       console.log('Instance:', options.openaiInstance);
+ *       console.log('Chat Deployment:', options.openaiChatDeployment);
+ *     })
+ * );
+ * ```
+ */
+export const withAiOptions = (command, args) => {
+    // Core authentication options
+    command.addOption(apiKeyOption);
+    command.addOption(apiVersionOption);
+    command.addOption(apiInstanceOption);
+    // Deployment options
+    if (args?.includeChat === true) {
+        command.addOption(chatDeploymentOption);
+    }
+    if (args?.includeEmbedding === true) {
+        command.addOption(embeddingDeploymentOption);
+    }
+    // Azure Search options
+    if (args?.includeSearch === true) {
+        command.addOption(azureSearchEndpointOption);
+        command.addOption(azureSearchApiKeyOption);
+        command.addOption(azureSearchIndexNameOption);
+    }
+    // Validation hook
+    command.hook('preAction', (thisCommand) => {
+        const options = thisCommand.opts();
+        // Validate API key
+        if (!options.openaiApiKey ||
+            typeof options.openaiApiKey !== 'string' ||
+            options.openaiApiKey.trim() === '') {
+            throw new InvalidOptionArgumentError('API key is required and must be a non-empty string.');
+        }
+        // Validate API version
+        if (!options.openaiApiVersion || typeof options.openaiApiVersion !== 'string') {
+            throw new InvalidOptionArgumentError('API version must be a non-empty string.');
+        }
+        // Validate instance name
+        if (!options.openaiInstance ||
+            typeof options.openaiInstance !== 'string' ||
+            options.openaiInstance.trim() === '') {
+            throw new InvalidOptionArgumentError('API instance name is required and must be a non-empty string.');
+        }
+        if (args?.includeChat === true) {
+            if (!options.openaiChatDeployment ||
+                typeof options.openaiChatDeployment !== 'string' ||
+                options.openaiChatDeployment.trim() === '') {
+                throw new InvalidOptionArgumentError('Chat deployment name is required and must be a non-empty string.');
+            }
+        }
+        if (args?.includeEmbedding === true) {
+            if (!options.openaiEmbeddingDeployment ||
+                typeof options.openaiEmbeddingDeployment !== 'string' ||
+                options.openaiEmbeddingDeployment.trim() === '') {
+                throw new InvalidOptionArgumentError('Embedding deployment name is required and must be a non-empty string.');
+            }
+        }
+        if (args?.includeSearch === true) {
+            if (!options.azureSearchEndpoint ||
+                typeof options.azureSearchEndpoint !== 'string' ||
+                options.azureSearchEndpoint.trim() === '') {
+                throw new InvalidOptionArgumentError('Azure Search endpoint is required and must be a non-empty string.');
+            }
+            if (!options.azureSearchApiKey ||
+                typeof options.azureSearchApiKey !== 'string' ||
+                options.azureSearchApiKey.trim() === '') {
+                throw new InvalidOptionArgumentError('Azure Search API key is required and must be a non-empty string.');
+            }
+            if (!options.azureSearchIndexName ||
+                typeof options.azureSearchIndexName !== 'string' ||
+                options.azureSearchIndexName.trim() === '') {
+                throw new InvalidOptionArgumentError('Azure Search index name is required and must be a non-empty string.');
+            }
+        }
+    });
+    return command;
+};
+export default withAiOptions;
+//# sourceMappingURL=ai.js.map

package/dist/esm/options/ai.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.js","sourceRoot":"","sources":["../../../src/options/ai.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,YAAY,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAC;AAyBnF;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,YAAY,CACtC,wBAAwB,EACxB,mCAAmC,CACpC,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAC1C,gCAAgC,EAChC,0BAA0B,CAC3B;KACE,GAAG,CAAC,0BAA0B,CAAC;KAC/B,OAAO,CAAC,oBAAoB,CAAC,CAAC;AAEjC;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,YAAY,CAC3C,0BAA0B,EAC1B,4BAA4B,CAC7B,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;AAEpC;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,YAAY,CAC9C,iCAAiC,EACjC,mCAAmC,CACpC,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;AAE3C;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,YAAY,CACnD,sCAAsC,EACtC,wCAAwC,CACzC,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;AAEhD;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,YAAY,CACnD,+BAA+B,EAC/B,2BAA2B,CAC5B,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;AAE/B;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,YAAY,CACjD,8BAA8B,EAC9B,sBAAsB,CACvB,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;AAE9B;;;GAGG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,YAAY,CACpD,kCAAkC,EAClC,yBAAyB,CAC1B,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AAEjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,OAAgB,EAChB,IAIE,EACO,EAAE;IACX,8BAA8B;IAC9B,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAChC,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACpC,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAErC,qBAAqB;IACrB,IAAI,IAAI,EAAE,WAAW,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,IAAI,EAAE,gBAAgB,KAAK,IAAI,EAAE,CAAC;QACpC,OAAO,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;IAC/C,CAAC;IAED,uBAAuB;IACvB,IAAI,IAAI,EAAE,aAAa,KAAK,IAAI,EAAE,CAAC;QACjC,OAAO,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;QAC7C,OAAO,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;QAC3C,OAAO,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;IAChD,CAAC;IAED,kBAAkB;IAClB,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,WAAW,EAAE,EAAE;QACxC,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC;QAEnC,mBAAmB;QACnB,IACE,CAAC,OAAO,CAAC,YAAY;YACrB,OAAO,OAAO,CAAC,YAAY,KAAK,QAAQ;YACxC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,EAClC,CAAC;YACD,MAAM,IAAI,0BAA0B,CAAC,qDAAqD,CAAC,CAAC;QAC9F,CAAC;QAED,uBAAuB;QACvB,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,OAAO,OAAO,CAAC,gBAAgB,KAAK,QAAQ,EAAE,CAAC;YAC9E,MAAM,IAAI,0BAA0B,CAAC,yCAAyC,CAAC,CAAC;QAClF,CAAC;QAED,yBAAyB;QACzB,IACE,CAAC,OAAO,CAAC,cAAc;YACvB,OAAO,OAAO,CAAC,cAAc,KAAK,QAAQ;YAC1C,OAAO,CAAC,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,EACpC,CAAC;YACD,MAAM,IAAI,0BAA0B,CAClC,+DAA+D,CAChE,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,EAAE,WAAW,KAAK,IAAI,EAAE,CAAC;YAC/B,IACE,CAAC,OAAO,CAAC,oBAAoB;gBAC7B,OAAO,OAAO,CAAC,oBAAoB,KAAK,QAAQ;gBAChD,OAAO,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,EAC1C,CAAC;gBACD,MAAM,IAAI,0BAA0B,CAClC,kEAAkE,CACnE,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,IAAI,EAAE,gBAAgB,KAAK,IAAI,EAAE,CAAC;YACpC,IACE,CAAC,OAAO,CAAC,yBAAyB;gBAClC,OAAO,OAAO,CAAC,yBAAyB,KAAK,QAAQ;gBACrD,OAAO,CAAC,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,EAC/C,CAAC;gBACD,MAAM,IAAI,0BAA0B,CAClC,uEAAuE,CACxE,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,IAAI,EAAE,aAAa,KAAK,IAAI,EAAE,CAAC;YACjC,IACE,CAAC,OAAO,CAAC,mBAAmB;gBAC5B,OAAO,OAAO,CAAC,mBAAmB,KAAK,QAAQ;gBAC/C,OAAO,CAAC,mBAAmB,CAAC,IAAI,EAAE,KAAK,EAAE,EACzC,CAAC;gBACD,MAAM,IAAI,0BAA0B,CAClC,mEAAmE,CACpE,CAAC;YACJ,CAAC;YAED,IACE,CAAC,OAAO,CAAC,iBAAiB;gBAC1B,OAAO,OAAO,CAAC,iBAAiB,KAAK,QAAQ;gBAC7C,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,KAAK,EAAE,EACvC,CAAC;gBACD,MAAM,IAAI,0BAA0B,CAClC,kEAAkE,CACnE,CAAC;YACJ,CAAC;YAED,IACE,CAAC,OAAO,CAAC,oBAAoB;gBAC7B,OAAO,OAAO,CAAC,oBAAoB,KAAK,QAAQ;gBAChD,OAAO,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,EAAE,EAC1C,CAAC;gBACD,MAAM,IAAI,0BAA0B,CAClC,qEAAqE,CACtE,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,eAAe,aAAa,CAAC"}

package/dist/esm/search.js

@@ -0,0 +1,227 @@
+import { createCommand, createOption } from 'commander';
+import { withAiOptions } from './options/ai.js';
+import { setupFramework } from './utils/setup-framework.js';
+import { inspect } from 'node:util';
+/**
+ * Normalizes metadata attributes from Azure Search format to a flat object
+ * Azure Search returns metadata attributes as an array of {key, value} pairs,
+ * which this function converts to a simple key-value object for easier access
+ * @param metadata - Raw metadata object that may contain attributes array
+ * @returns Normalized metadata with attributes flattened into the root object
+ */
+const normalizeMetadata = (metadata) => {
+    const normalized = { ...metadata };
+    // Azure Search returns attributes as an array of {key, value} pairs
+    // Convert this to a flat object structure for easier access
+    if (Array.isArray(normalized.attributes)) {
+        const attributesObj = {};
+        for (const attr of normalized.attributes) {
+            // Validate attribute structure before processing
+            if (typeof attr === 'object' &&
+                attr !== null &&
+                'key' in attr &&
+                'value' in attr &&
+                typeof attr.key === 'string') {
+                // Try to parse JSON values (Azure Search stores complex values as JSON strings)
+                // Fall back to raw value if parsing fails (for string values)
+                try {
+                    attributesObj[attr.key] = JSON.parse(attr.value);
+                }
+                catch {
+                    attributesObj[attr.key] = attr.value;
+                }
+            }
+        }
+        // Merge flattened attributes into the root metadata object
+        Object.assign(normalized, attributesObj);
+        // Remove the original attributes array to avoid duplication
+        delete normalized.attributes;
+    }
+    return normalized;
+};
+/**
+ * CLI command: `ai search`
+ *
+ * Search the vector store to validate embeddings and retrieve relevant documents.
+ *
+ * Features:
+ * - Semantic search using vector embeddings
+ * - Configurable result limits
+ * - Filter support for metadata-based filtering
+ * - JSON output option for programmatic use
+ * - Detailed result display with scores and metadata
+ *
+ * Usage:
+ *   $ ffc ai search <query> [options]
+ *
+ * Options:
+ *   --limit <number>                    Maximum number of results to return (default: 10)
+ *   --search-type <type>                Search type: 'mmr' or 'similarity' (default: similarity)
+ *   --filter <expression>               OData filter expression for metadata filtering
+ *   --json                              Output results as JSON
+ *   --raw                               Output raw metadata without normalization
+ *   --verbose                           Enable verbose output
+ *   --openai-api-key <key>              API key for Azure OpenAI
+ *   --openai-api-version <version>      API version (default: 2024-02-15-preview)
+ *   --openai-instance <name>            Azure OpenAI instance name
+ *   --openai-embedding-deployment <name> Azure OpenAI embedding deployment name
+ *   --azure-search-endpoint <url>       Azure Search endpoint URL
+ *   --azure-search-api-key <key>        Azure Search API key
+ *   --azure-search-index-name <name>    Azure Search index name
+ *
+ * Environment Variables:
+ *   AZURE_OPENAI_API_KEY                    API key for Azure OpenAI
+ *   AZURE_OPENAI_API_VERSION                API version
+ *   AZURE_OPENAI_INSTANCE_NAME              Instance name
+ *   AZURE_OPENAI_EMBEDDING_DEPLOYMENT_NAME  Embedding deployment name
+ *   AZURE_SEARCH_ENDPOINT                   Azure Search endpoint
+ *   AZURE_SEARCH_API_KEY                    Azure Search API key
+ *   AZURE_SEARCH_INDEX_NAME                 Azure Search index name
+ *
+ * Examples:
+ *   $ ffc ai search "how to use the framework"
+ *   $ ffc ai search "authentication" --limit 5
+ *   $ ffc ai search "typescript" --filter "metadata/source eq 'src/index.ts'"
+ *   $ ffc ai search "documentation" --search-type similarity
+ *   $ ffc ai search "documentation" --json
+ *   $ ffc ai search "documentation" --json --raw
+ *   $ ffc ai search "API reference" --verbose
+ */
+export const command = withAiOptions(createCommand('search')
+    .description('Search the vector store to validate embeddings and retrieve relevant documents')
+    .addOption(createOption('--limit <number>', 'Maximum number of results to return')
+    .default(10)
+    .argParser(parseInt))
+    .addOption(createOption('--search-type <type>', 'Search type: mmr or similarity')
+    .choices(['mmr', 'similarity'])
+    .default('similarity'))
+    .addOption(createOption('--filter <expression>', 'OData filter expression for metadata filtering'))
+    .addOption(createOption('--json', 'Output results as JSON').default(false))
+    .addOption(createOption('--raw', 'Output raw metadata without normalization').default(false))
+    .addOption(createOption('--verbose', 'Enable verbose output').default(false))
+    .argument('<query>', 'Search query string')
+    .action(async (query, options) => {
+    if (options.verbose) {
+        console.log('🔍 Initializing framework...');
+    }
+    const framework = await setupFramework(options);
+    if (!options.azureSearchIndexName) {
+        throw new Error('Azure Search index name is required');
+    }
+    if (options.verbose) {
+        console.log('✅ Framework initialized successfully');
+        console.log(`🔎 Searching for: "${query}"`);
+        console.log(`📊 Limit: ${options.limit}`);
+        console.log(`🔍 Search type: ${options.searchType}`);
+        if (options.filter) {
+            console.log(`🔧 Filter: ${options.filter}`);
+        }
+        console.log('');
+    }
+    const vectorStoreService = framework.ai.getService('search', options.azureSearchIndexName);
+    try {
+        // Configure retriever options for semantic search
+        // The retriever provides more control over search parameters than direct vector store queries
+        // RetrieverOptions is a discriminated union, so we construct it based on search type
+        const filter = options.filter
+            ? {
+                filterExpression: options.filter,
+            }
+            : undefined;
+        // Construct retriever options based on search type
+        // MMR search requires additional parameters for diversity optimization
+        // Similarity search doesn't need these parameters
+        const retrieverOptions = options.searchType === 'mmr'
+            ? {
+                k: options.limit,
+                searchType: 'mmr',
+                ...(filter && { filter: filter }),
+            }
+            : {
+                k: options.limit,
+                searchType: 'similarity',
+                ...(filter && { filter: filter }),
+            };
+        // Create retriever and execute search query
+        const retriever = vectorStoreService.asRetriever(retrieverOptions);
+        const results = await retriever.invoke(query);
+        // Validate that results is an array
+        if (!results || !Array.isArray(results)) {
+            throw new Error(`Invalid search results: expected array but got ${results === null ? 'null' : typeof results}`);
+        }
+        if (options.json) {
+            // Output as JSON for programmatic use (e.g., piping to other tools)
+            for (const doc of results) {
+                if (options.raw) {
+                    // Output raw document structure with full depth inspection
+                    console.log(inspect(doc, { depth: null, colors: true }));
+                }
+                else {
+                    // Output normalized metadata for cleaner JSON structure
+                    const metadata = normalizeMetadata(doc.metadata);
+                    console.log({
+                        content: doc.pageContent,
+                        metadata,
+                        score: metadata?.score,
+                    });
+                }
+            }
+        }
+        else {
+            // Format results for human-readable output
+            if (results.length === 0) {
+                console.log('❌ No results found');
+                return;
+            }
+            console.log(`✅ Found ${results.length} result${results.length !== 1 ? 's' : ''}:\n`);
+            results.forEach((doc, index) => {
+                // Normalize metadata to flatten attributes array unless --raw flag is set
+                // Raw mode preserves Azure Search's original metadata structure
+                const processedMetadata = options.raw
+                    ? doc.metadata
+                    : normalizeMetadata(doc.metadata);
+                const metadata = processedMetadata;
+                const score = metadata.score;
+                const source = metadata.source || 'Unknown source';
+                // Display result header with score if available
+                console.log(`${'─'.repeat(80)}`);
+                console.log(`Result ${index + 1}${score !== undefined ? ` (Score: ${score.toFixed(4)})` : ''}`);
+                console.log(`Source: ${source}`);
+                // Display additional metadata fields if verbose mode is enabled
+                // Exclude source and score from additional metadata to avoid duplication
+                if (options.verbose) {
+                    const { source: _, score: __, ...otherMetadata } = metadata;
+                    if (Object.keys(otherMetadata).length > 0) {
+                        console.log(`Metadata:`, JSON.stringify(otherMetadata, null, 2));
+                    }
+                }
+                console.log('');
+                // Truncate content if too long to keep output readable
+                // Full content is still available in JSON mode
+                const content = doc.pageContent;
+                const maxLength = 500;
+                if (content.length > maxLength) {
+                    console.log(`${content.substring(0, maxLength)}...`);
+                    console.log(`\n[Content truncated - ${content.length} characters total]`);
+                }
+                else {
+                    console.log(content);
+                }
+                console.log('');
+            });
+            console.log(`${'─'.repeat(80)}`);
+        }
+    }
+    catch (error) {
+        console.error(`❌ Search failed: ${error instanceof Error ? error.message : 'Unknown error'}`);
+        if (options.verbose && error instanceof Error && error.stack) {
+            console.error(error.stack);
+        }
+        process.exit(1);
+    }
+}), {
+    includeEmbedding: true,
+    includeSearch: true,
+});
+export default command;
+//# sourceMappingURL=search.js.map

package/dist/esm/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/search.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAExD,OAAO,EAAE,aAAa,EAAkB,MAAM,iBAAiB,CAAC;AAEhE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAqBpC;;;;;;GAMG;AACH,MAAM,iBAAiB,GAAG,CAAC,QAAiC,EAA2B,EAAE;IACvF,MAAM,UAAU,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;IAEnC,oEAAoE;IACpE,4DAA4D;IAC5D,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QACzC,MAAM,aAAa,GAA4B,EAAE,CAAC;QAClD,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC;YACzC,iDAAiD;YACjD,IACE,OAAO,IAAI,KAAK,QAAQ;gBACxB,IAAI,KAAK,IAAI;gBACb,KAAK,IAAI,IAAI;gBACb,OAAO,IAAI,IAAI;gBACf,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,EAC5B,CAAC;gBACD,gFAAgF;gBAChF,8DAA8D;gBAC9D,IAAI,CAAC;oBACH,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;gBAC7D,CAAC;gBAAC,MAAM,CAAC;oBACP,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBACvC,CAAC;YACH,CAAC;QACH,CAAC;QACD,2DAA2D;QAC3D,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;QACzC,4DAA4D;QAC5D,OAAO,UAAU,CAAC,UAAU,CAAC;IAC/B,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,aAAa,CAClC,aAAa,CAAC,QAAQ,CAAC;KACpB,WAAW,CAAC,gFAAgF,CAAC;KAC7F,SAAS,CACR,YAAY,CAAC,kBAAkB,EAAE,qCAAqC,CAAC;KACpE,OAAO,CAAC,EAAE,CAAC;KACX,SAAS,CAAC,QAAQ,CAAC,CACvB;KACA,SAAS,CACR,YAAY,CAAC,sBAAsB,EAAE,gCAAgC,CAAC;KACnE,OAAO,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;KAC9B,OAAO,CAAC,YAAY,CAAC,CACzB;KACA,SAAS,CACR,YAAY,CAAC,uBAAuB,EAAE,gDAAgD,CAAC,CACxF;KACA,SAAS,CAAC,YAAY,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC1E,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,2CAA2C,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC5F,SAAS,CAAC,YAAY,CAAC,WAAW,EAAE,uBAAuB,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;KAC5E,QAAQ,CAAC,SAAS,EAAE,qBAAqB,CAAC;KAC1C,MAAM,CAAC,KAAK,EAAE,KAAa,EAAE,OAAuB,EAAE,EAAE;IACvD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;IAEhD,IAAI,CAAC,OAAO,CAAC,oBAAoB,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IACzD,CAAC;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,sBAAsB,KAAK,GAAG,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,aAAa,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAC1C,OAAO,CAAC,GAAG,CAAC,mBAAmB,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,cAAc,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9C,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,kBAAkB,GAAG,SAAS,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE3F,IAAI,CAAC;QACH,kDAAkD;QAClD,8FAA8F;QAC9F,qFAAqF;QACrF,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;YAC3B,CAAC,CAAC;gBACE,gBAAgB,EAAE,OAAO,CAAC,MAAM;aACjC;YACH,CAAC,CAAC,SAAS,CAAC;QAEd,mDAAmD;QACnD,uEAAuE;QACvE,kDAAkD;QAClD,MAAM,gBAAgB,GACpB,OAAO,CAAC,UAAU,KAAK,KAAK;YAC1B,CAAC,CAAC;gBACE,CAAC,EAAE,OAAO,CAAC,KAAK;gBAChB,UAAU,EAAE,KAAK;gBACjB,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,MAAiC,EAAE,CAAC;aAC7D;YACH,CAAC,CAAC;gBACE,CAAC,EAAE,OAAO,CAAC,KAAK;gBAChB,UAAU,EAAE,YAAY;gBACxB,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,MAAiC,EAAE,CAAC;aAC7D,CAAC;QAER,4CAA4C;QAC5C,MAAM,SAAS,GAAG,kBAAkB,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAE9C,oCAAoC;QACpC,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CACb,kDAAkD,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,OAAO,EAAE,CAC/F,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,oEAAoE;YACpE,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;gBAC1B,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;oBAChB,2DAA2D;oBAC3D,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;gBAC3D,CAAC;qBAAM,CAAC;oBACN,wDAAwD;oBACxD,MAAM,QAAQ,GAAG,iBAAiB,CAAC,GAAG,CAAC,QAAmC,CAAC,CAAC;oBAC5E,OAAO,CAAC,GAAG,CAAC;wBACV,OAAO,EAAE,GAAG,CAAC,WAAW;wBACxB,QAAQ;wBACR,KAAK,EAAG,QAA+B,EAAE,KAAK;qBAC/C,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,2CAA2C;YAC3C,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACzB,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;gBAClC,OAAO;YACT,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,WAAW,OAAO,CAAC,MAAM,UAAU,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAErF,OAAO,CAAC,OAAO,CAAC,CAAC,GAAa,EAAE,KAAa,EAAE,EAAE;gBAC/C,0EAA0E;gBAC1E,gEAAgE;gBAChE,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG;oBACnC,CAAC,CAAE,GAAG,CAAC,QAAoC;oBAC3C,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAmC,CAAC,CAAC;gBAC/D,MAAM,QAAQ,GAAG,iBAIhB,CAAC;gBACF,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC;gBAC7B,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,IAAI,gBAAgB,CAAC;gBAEnD,gDAAgD;gBAChD,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;gBACjC,OAAO,CAAC,GAAG,CACT,UAAU,KAAK,GAAG,CAAC,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CACnF,CAAC;gBACF,OAAO,CAAC,GAAG,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;gBAEjC,gEAAgE;gBAChE,yEAAyE;gBACzE,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;oBACpB,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,GAAG,aAAa,EAAE,GAAG,QAAQ,CAAC;oBAC5D,IAAI,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC1C,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;oBACnE,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAEhB,uDAAuD;gBACvD,+CAA+C;gBAC/C,MAAM,OAAO,GAAG,GAAG,CAAC,WAAW,CAAC;gBAChC,MAAM,SAAS,GAAG,GAAG,CAAC;gBACtB,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;oBAC/B,OAAO,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC;oBACrD,OAAO,CAAC,GAAG,CAAC,0BAA0B,OAAO,CAAC,MAAM,oBAAoB,CAAC,CAAC;gBAC5E,CAAC;qBAAM,CAAC;oBACN,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACvB,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;YAEH,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CACX,oBAAoB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,EAAE,CAC/E,CAAC;QACF,IAAI,OAAO,CAAC,OAAO,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;YAC7D,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC,EACJ;IACE,gBAAgB,EAAE,IAAI;IACtB,aAAa,EAAE,IAAI;CACpB,CACF,CAAC;AAEF,eAAe,OAAO,CAAC"}

package/dist/esm/utils/setup-framework.js

@@ -0,0 +1,53 @@
+import { enableAI } from '@equinor/fusion-framework-module-ai';
+import { AzureOpenAiEmbed, AzureOpenAIModel, AzureVectorStore, } from '@equinor/fusion-framework-module-ai/azure';
+import { ModulesConfigurator } from '@equinor/fusion-framework-module';
+/**
+ * Initializes and configures the Fusion Framework with AI module capabilities
+ * @param options - AI configuration options including API keys, deployments, and vector store settings
+ * @returns Promise resolving to an initialized framework instance with AI module
+ * @throws {Error} If embedding deployment is required but not provided when configuring vector store
+ */
+export const setupFramework = async (options) => {
+    // Create a new module configurator for the framework
+    const configurator = new ModulesConfigurator();
+    // Configure AI module with provided options
+    enableAI(configurator, (aiConfig) => {
+        // Configure chat model if deployment name is provided
+        if (options.openaiChatDeployment) {
+            aiConfig.setModel(options.openaiChatDeployment, new AzureOpenAIModel({
+                azureOpenAIApiKey: options.openaiApiKey,
+                azureOpenAIApiDeploymentName: options.openaiChatDeployment,
+                azureOpenAIApiInstanceName: options.openaiInstance,
+                azureOpenAIApiVersion: options.openaiApiVersion,
+            }));
+        }
+        // Configure embedding model if deployment name is provided
+        if (options.openaiEmbeddingDeployment) {
+            aiConfig.setEmbedding(options.openaiEmbeddingDeployment, new AzureOpenAiEmbed({
+                azureOpenAIApiKey: options.openaiApiKey,
+                azureOpenAIApiDeploymentName: options.openaiEmbeddingDeployment,
+                azureOpenAIApiInstanceName: options.openaiInstance,
+                azureOpenAIApiVersion: options.openaiApiVersion,
+            }));
+        }
+        // Configure vector store if Azure Search options are provided
+        // Vector store requires an embedding service to generate embeddings for documents
+        if (options.azureSearchEndpoint && options.azureSearchApiKey && options.azureSearchIndexName) {
+            if (!options.openaiEmbeddingDeployment) {
+                throw new Error('Embedding deployment is required to configure the vector store');
+            }
+            // Retrieve the embedding service to pass to the vector store
+            // The vector store uses embeddings to index and search documents
+            const embeddingService = aiConfig.getService('embeddings', options.openaiEmbeddingDeployment);
+            aiConfig.setVectorStore(options.azureSearchIndexName, new AzureVectorStore(embeddingService, {
+                endpoint: options.azureSearchEndpoint,
+                key: options.azureSearchApiKey,
+                indexName: options.azureSearchIndexName,
+            }));
+        }
+    });
+    // Initialize the framework with all configured modules
+    const framework = await configurator.initialize();
+    return framework;
+};
+//# sourceMappingURL=setup-framework.js.map

package/dist/esm/utils/setup-framework.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup-framework.js","sourceRoot":"","sources":["../../../src/utils/setup-framework.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAuC,MAAM,qCAAqC,CAAC;AAEpG,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,2CAA2C,CAAC;AAGnD,OAAO,EAAE,mBAAmB,EAAwB,MAAM,kCAAkC,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,OAAkB,EAAwC,EAAE;IAC/F,qDAAqD;IACrD,MAAM,YAAY,GAAG,IAAI,mBAAmB,EAAc,CAAC;IAE3D,4CAA4C;IAC5C,QAAQ,CAAC,YAAY,EAAE,CAAC,QAAyB,EAAE,EAAE;QACnD,sDAAsD;QACtD,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;YACjC,QAAQ,CAAC,QAAQ,CACf,OAAO,CAAC,oBAAoB,EAC5B,IAAI,gBAAgB,CAAC;gBACnB,iBAAiB,EAAE,OAAO,CAAC,YAAY;gBACvC,4BAA4B,EAAE,OAAO,CAAC,oBAAoB;gBAC1D,0BAA0B,EAAE,OAAO,CAAC,cAAc;gBAClD,qBAAqB,EAAE,OAAO,CAAC,gBAAgB;aAChD,CAAC,CACH,CAAC;QACJ,CAAC;QAED,2DAA2D;QAC3D,IAAI,OAAO,CAAC,yBAAyB,EAAE,CAAC;YACtC,QAAQ,CAAC,YAAY,CACnB,OAAO,CAAC,yBAAyB,EACjC,IAAI,gBAAgB,CAAC;gBACnB,iBAAiB,EAAE,OAAO,CAAC,YAAY;gBACvC,4BAA4B,EAAE,OAAO,CAAC,yBAAyB;gBAC/D,0BAA0B,EAAE,OAAO,CAAC,cAAc;gBAClD,qBAAqB,EAAE,OAAO,CAAC,gBAAgB;aAChD,CAAC,CACH,CAAC;QACJ,CAAC;QAED,8DAA8D;QAC9D,kFAAkF;QAClF,IAAI,OAAO,CAAC,mBAAmB,IAAI,OAAO,CAAC,iBAAiB,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;YAC7F,IAAI,CAAC,OAAO,CAAC,yBAAyB,EAAE,CAAC;gBACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;YACpF,CAAC;YAED,6DAA6D;YAC7D,iEAAiE;YACjE,MAAM,gBAAgB,GAAG,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,OAAO,CAAC,yBAAyB,CAAC,CAAC;YAE9F,QAAQ,CAAC,cAAc,CACrB,OAAO,CAAC,oBAAoB,EAC5B,IAAI,gBAAgB,CAAC,gBAAgB,EAAE;gBACrC,QAAQ,EAAE,OAAO,CAAC,mBAAmB;gBACrC,GAAG,EAAE,OAAO,CAAC,iBAAiB;gBAC9B,SAAS,EAAE,OAAO,CAAC,oBAAoB;aACxC,CAAC,CACH,CAAC;QACJ,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,uDAAuD;IACvD,MAAM,SAAS,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC;IAClD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}

package/dist/esm/version.js

@@ -0,0 +1,3 @@
+// Generated by genversion.
+export const version = '1.0.0';
+//# sourceMappingURL=version.js.map