Skip to content

Latest commit

 

History

History
170 lines (110 loc) · 5.38 KB

README.md

File metadata and controls

170 lines (110 loc) · 5.38 KB
Raw

General

Workflow Status
Continuous Integration (CI) build
Publish to GitHub packages publish
Generate java documentation javadoc

The RelationalAI Software Development Kit for Java

The RelationalAI (RAI) SDK for Java enables developers to access the RAI REST APIs from Java.

Getting started

Requirements

  • Java 11.0.10+
  • Apache Maven

Dependencies

The SDK has a single runtime dependency (jsoniter), a dependency for running the SDK examples (commons-cli) and several additional dependencies for running the unit and integration tests.

Building the SDK

The SDK build lifecycle is managed using the standard mvn lifecycle commands.

Compile the SDK

mvn compile

Run the tests

mvn test

Note, the test are run against the account configured in your SDK config file.

Compile, package, run tests and install the SDK

mvn install

Note that mvn install is required to build and run the examples.

Compile, package and install without running tests

mvn install -DskipTests

Remove all build output files from the repo

mvn clean

If facing errors like module java.base does not "opens java.nio" to unnamed module

export JAVA_TOOL_OPTIONS="--add-opens=java.base/java.nio=ALL-UNNAMED"

Create a configuration file

In order to run the examples you will need to create an SDK config file. The default location for the file is $HOME/.rai/config and the file should include the following:

Sample configuration using OAuth client credentials:

[default]
host = azure.relationalai.com
client_id = <your client_id>
client_secret = <your client secret>

# the following are all optional, with default values shown
# port = 443
# scheme = https
# client_credentials_url = https://login.relationalai.com/oauth/token

Client credentials can be created using the RAI console at https://console.relationalai.com/login

You can copy config.spec from the root of this repo and modify as needed.

Using the SDK as a maven dependency

In order to use the rai-sdk-java, you need add this dependency to your project's POM:

<dependency>
    <groupId>com.relationalai</groupId>
    <artifactId>rai-sdk</artifactId>
    <version>0.4.2-alpha</version>
</dependency>

You need also to point maven to the SDK GitHub packages repository in the project's POM:

<repositories>
    <repository>
        <id>github</id>
        <name>The RelationalAI SDK for Apache Maven</name>
        <url>https://maven.pkg.github.com/RelationalAI/rai-sdk-java</url>
    </repository>
</repositories>

The registry access is available through GiHub api which is protected. You have to add GitHub credentials to $HOME/.m2/settings.xml:

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
        ...
        <servers>
            <server>
                <id>github</id>
                <username>GITHUB_USERNAME</username>
                <password>GITHUB_ACCESS_TOKEN</password>
            </server>
        </servers>
        ...
    </settings>

GITHUB_USERNAME is your GitHub login name.

GITHUB_ACCESS_TOKEN is a generated GitHub personal access token:

GitHub > Settings > Developer Settings > Personal access tokens > Generate new token.

The token needs at least the read:packages scope.

Examples

The SDK contains examples for every API, and various other SDK features. These are located in the examples project under ./rai-sdk-examples.

The examples are packaged into a single JAR file, and can be run individually from the command line using maven.

mvn exec:java -f rai-sdk-examples/pom.xml -Dexec.mainClass=com.relationalai.examples.Runner -Dexec.args="<className> [options]"

Eg, to run the GetDatabase example from the root of the repo.

mvn exec:java -f rai-sdk-examples/pom.xml -Dexec.mainClass=com.relationalai.examples.Runner -Dexec.args="GetDatabase sdk-test"

There is also a bash script in ./rai-sdk-examples that can be used to run individual examples, eg:

cd ./rai-sdk/examples
./run GetDatabase sdk-test

Javadocs

Javadocs for rai-sdk are available here.

Support

You can reach the RAI developer support team at support@relational.ai

Contributing

We value feedback and contributions from our developer community. Feel free to submit an issue or a PR here.

License

The RelationalAI Software Development Kit for Java is licensed under the Apache License 2.0. See: https://github.com/RelationalAI/rai-sdk-java/blob/master/LICENSE G