Before initializing Prisme.ai AI Products, you need to ensure that your environment meets all necessary prerequisites and configurations. This guide will walk you through the required services, configuration steps, and verification processes.

Core Requirements

A fully operational Prisme.ai environment is required, including both open-source and private microservices.

The following microservices must be running:

  • prismeai-api-gateway
  • prismeai-console
  • prismeai-pages
  • prismeai-workspaces
  • prismeai-events
  • prismeai-runtime

For offline environments, additional prerequisites may be required. Please refer to the offline environment setup guide.

Configuration Requirements

Several environment variables must be configured in the prismeai-runtime microservice to ensure proper functioning of installed Apps. If your deployment uses custom API ports modified by a container orchestrator or configuration, you’ll need to adapt these values accordingly.

Environment Variables

Network Requirements

All microservices should be able to communicate with each other within your environment. Ensure that:

  • The runtime service can reach all other services (functions, crawler, searchengine, etc.)
  • The functions service can reach external package repositories for npm/pip dependencies
  • The console service is accessible to administrators

Hardware Requirements

Minimum Requirements

  • 8 CPU cores
  • 16GB RAM
  • 100GB storage
  • Suitable for testing and small-scale deployments

Recommended Requirements

  • 16+ CPU cores
  • 32GB+ RAM
  • 250GB+ storage
  • Suitable for production deployments

Hardware requirements may vary depending on your specific usage patterns, the number of concurrent users, and the amount of data processed.

Storage Recommendations

Offline environments

If the installation environment does not have access to internet, ensure that the following prerequisites are always met :

  • If using app microservices, prismeai-functions need access to a NPM registry. If the default https://registry.npmjs.org/ is not available, you must configure your own npm registry using NPM_CONFIG_REGISTRY environment variable inside prismeai-functions microservice
    • Depending on your NPM proxy, it might require additional configuration for authentication
  • If using internal / self-signed TLS certificates, they must be configured inside almost all microservices to avoid HTTPS errors
    • prismeai-searchengine and prismeai-crawler are Python microservices : once mounted, the certificate file location can be configured with REQUESTS_CA_BUNDLE prismeai-llm does not need the custom certificate
    • Every other prismeai-* services are NodeJS : once mounted, the certificate file location can be configured with NODE_EXTRA_CA_CERTS

AI Products Initialization Process

Once you’ve confirmed that all prerequisites have been met, you can proceed with importing the Prisme.ai App Store and associated product workspaces. The initialization process involves importing archives in the correct sequence and verifying functionality after each step.

It’s recommended to perform archive imports using a studio account dedicated to this task to avoid cluttering the dashboard of an administrator account with the multiple app workspaces.

Import Process Overview

The initialization process follows a specific sequence of imports, with testing performed after each step:

1

Import Package 1: Base Apps

Import the first archive containing foundational apps required by other components.

2

Test Base Apps

Verify the functionality of apps imported in the first step.

3

Import Package 2: Extended Base

Import the second archive with additional core services.

4

Test Extended Base Apps

Verify the functionality of apps imported in the second step.

5

Import Package 3: AI Products

Import the main AI product workspaces.

6

Configure AI Products

Complete final configuration steps for AI products.

Importing Archives

To import an archive:

  1. Navigate to the platform
  2. Hover over the “Create a workspace” button
  3. Click on the three-dot menu
  4. Select “Import a workspace from an archive” from the dropdown
  5. Select the archive file
  6. Wait for the import to complete
  7. Refresh the page to view the newly imported workspaces

Package 1: apps-base1.zip

This archive contains foundational apps required by many other components.

Key Components

Custom Code

Enables execution of custom JS/Python code

Requires the functions microservice to be online and configured

Prisme.ai API

Enables API calls to Prisme.ai from Automations (YAML files)

Verification Tests

After importing the first package, run these tests to verify functionality:

Package 2: apps-base2.zip

This archive contains extended base applications that build upon the first package.

Key Components

Collection

MongoDB integration

Requires the Custom Code App to work correctly

Crawler

Web page indexing & search engine

Requires the crawler and searchengine microservices

NLU

NLU engine

Requires the nlu microservice

RedisSearch

Interface with the redis-stack-server database

Verification Tests

After importing the second package, run these tests to verify functionality:

Package 3: apps-extended.zip

This final archive contains the main Prisme.ai AI products and is larger than the previous packages.

The import is complete when you see a log similar to:

{
  "level":30,
  "time":1691420134138,
  "app":"core-prismeai-workspaces",
  "msg":"Terminated bulk import",
  "result":{
    "imported":[...],
    "errors":[...],
    "createdWorkspaceIds":[...],
    "updatedWorkspaceIds":[],
    "publishedApps":[...]
  }
}

Several new workspaces should appear when you refresh the page after seeing this log.

Post-Import Configuration

After successfully importing all three packages, you need to proceed with the AI Products configuration to complete the setup process.

Troubleshooting

If you encounter issues during the initialization process, here are some common problems and their solutions:

Next Steps