Skip to content

This Ballerina module enables seamless connection to Devant by WSO2 for accessing and consuming AI services.

License

Notifications You must be signed in to change notification settings

ballerina-platform/module-ballerinax-ai.devant

Repository files navigation

Ballerina AI Devant Library

Build GitHub Last Commit License

Overview

The ai.devant module provides APIs to interact with Devant by WSO2, enabling document chunking and loading documents from a directory in the format expected by the Devant Chunker. It integrates seamlessly with the ballerina/ai module to provide a smooth workflow for processing AI documents using Devant AI services.

Quickstart

To use the ai.devant module in your Ballerina application, follow these steps:

Step 1: Import the module

import ballerinax/ai.devant;

Step 2: Load the document

devant:BinaryDataLoader loader = check new ("./sample.pdf");
ai:Document|ai:Document[] docs = check loader.load();

Step 3: Chunk the documents using the Devant service

devant:Chunker chunker = new (serviceUrl, accessToken);
if docs is ai:Document {
    ai:Chunk[] chunks = check chunker.chunk(docs);
}

Issues and projects

Issues and Projects tabs are disabled for this repository as this is part of the Ballerina Library. To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina Library parent repository. This repository only contains the source code for the module.

Build from the source

Prerequisites

  1. Download and install Java SE Development Kit (JDK) version 21 (from one of the following locations).

    • Oracle

    • OpenJDK

      Note: Set the JAVA_HOME environment variable to the path name of the directory into which you installed JDK.

  2. Generate a GitHub access token with read package permissions, then set the following env variables:

    export packageUser=<Your GitHub Username>
    export packagePAT=<GitHub Personal Access Token>

Build options

Execute the commands below to build from the source.

  1. To build the package:

    ./gradlew clean build
  2. To run the tests:

    ./gradlew clean test
  3. To run a group of tests

    ./gradlew clean test -Pgroups=<test_group_names>
  4. To build the without the tests:

    ./gradlew clean build -x test
  5. To debug the package with a remote debugger:

    ./gradlew clean build -Pdebug=<port>
  6. To debug with Ballerina language:

    ./gradlew clean build -PbalJavaDebug=<port>
  7. Publish the generated artifacts to the local Ballerina central repository:

    ./gradlew clean build -PpublishToLocalCentral=true
  8. Publish the generated artifacts to the Ballerina central repository:

    ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

About

This Ballerina module enables seamless connection to Devant by WSO2 for accessing and consuming AI services.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors 4

  •  
  •  
  •  
  •