Skip to content

命令行工具 (CLI) 概述

OraAI Web界面中不提供数据集开发页面,需要下载orai-cli客户端,在Windows或MacOS中开发语义模型。开发完成,通过orai-cli命令行把语义模型上传到OraAI Web平台。

orai-cli是一个强大的命令行工具,旨在帮助您管理、开发和部署用于自然语言数据分析的语义模型。它提供了与 OraAI平台交互的直观界面。

安装

在使用orai-cli之前,您需要先安装它。请参阅安装指南

可用命令

orai-cli包含以下命令:

shell
$ orai-cli -help
Ora CLI - 管理语义模型并与 OraAI API 交互。

Usage: orai-cli <COMMAND>

Commands:
  init      初始化一个新的 OraAI 项目
  auth      使用 OraAI API 进行身份验证
  deploy    将语义模型部署到 OraAI 平台
  generate dbt 项目生成或更新语义模型 YAML 定义
  parse     解析和验证语义模型 YAML 定义
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

环境变量

orai-cli进行身份认证时,使用环境变量保存OraAI API的URL和API密钥。

OraAI平台API服务默认端口为3001。

shell
# OraAI平台API服务URL及端口,默认端口为3001
$ export ORAI_HOST=http://47.120.51.218:3001
# OraAI API Key,从OraAI平台获取
$ export ORAI_API_KEY=xxxxxxxx

基本流程

  1. 设置orai-cli环境变量

    shell
    $ export ORAI_HOST=http://47.120.51.218:3001
    $ export ORAI_API_KEY=xxxxxxxx
  2. 与OraAI平台进行认证

    shell
    $ orai-cli auth
     您已成功连接到 OraAI!
    连接详情:
    host: http://47.120.51.218:3001
    api_key: ****XXXXX
    凭据保存成功!
  3. 验证语义模型工程

    shell
    $ orai-cli parse
    🚀 开始 OraAI 模型解析...
    ......
    🎉 所有指定的模型文件解析成功!
  4. 部署语义模型工程

    shell
    $ orai-cli deploy
    🚀 开始部署语义模型...
    ......
     所有模型已成功部署!