Using AI Services CLI

Edit online

Deploy the Digital Assistant using the ai-services command-line interface. This section describes how to set up a Digital Assistant using the built-in templates available in AI Services.

Before proceeding, ensure that AI Services is set up and all prerequisites are met. For more information, see Setting up AI Services and Prerequisites.

1. Deploying Digital Assistant

Initialize a new application using the built-in rag template. This template generates all the essential resources required for Digital Assistant. Provide a unique application name to ensure a smooth deployment (replace <app-name> with your chosen name). 

ai-services application create <app-name> -t rag --runtime podman --params <params>
Note:

To view the full list of supported parameters for the RAG template, run: 

ai-services application templates parameters --template rag --runtime podman

After the command completes successfully, the CLI displays the next steps required to initialize the Digital Assistant. Follow the provided instructions to perform document ingestion and setup the knowledge base.

2. Access the Services

Run the following command to view all service endpoints and details of the deployed application: 

ai-services application info <app-name> --runtime podman

The following endpoints and interfaces are available for interacting with the platform:

  • Question and Answer UI: Access the Digital Assistant interface using the URL provided in the CLI output.
  • Question and Answer API: Interact with the Digital Assistant programmatically.
  • Digitize UI: Upload and manage documents, and convert them into structured, machine-readable text.
  • Digitize API: Perform document conversion and ingestion programmatically.
  • Summarize API: Perform programmatic document summarization.
  • Find Similar Items API: Identify and retrieve items similar to a reference item based on content, attributes, or patterns.