README
¶
General
| Workflow | Status |
|---|---|
| Continuous Integration (CI) |  |
rai-sdk-go
The RelationalAI Software Development Kit for Go enables developers to access the RAI REST APIs from Go.
- You can find RelationalAI Go SDK documentation at https://docs.relational.ai/rkgms/sdk/go-sdk
- You can find RelationalAI product documentation at https://docs.relational.ai
- You can learn more about RelationalAI at https://relational.ai
Getting started
Requirements
- Go 1.17+
The SDK has been tested on golang version 1.17+, but likely works with earlier versions.
Building the SDK
Compile the SDK
cd ./rai
go build
Run the tests
cd ./rai
go test
Note, the test are run against the account configured in your SDK config file.
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
port = <api-port> # optional, default: 443
scheme = <scheme> # optional, default: https
client_id = <your client_id>
client_secret = <your client secret>
client_credentials_url = <account login URL> # optional
# default: 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.
Examples
The SDK contains examples for every API, and various other SDK features. These
are located in ./examples folder.
Each example can be run using the go command.
cd ./examples
go run get_database/main.go -d sdk-test
There is also a bash script in ./examples that can be used to run
individual examples.
cd ./examples
./run get_database -d sdk-test
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 Go is licensed under the Apache License 2.0. See: https://github.com/RelationalAI/rai-sdk-go/blob/master/LICENSE
Directories