Imagen

Workspace Client で Teradata AI Unlimited を使用する

この製品はプレビュー版であり、変更される可能性があります。このサービスの詳細について興味がある場合は、Teradata サポートにお問い合わせください。

概要

Workspace Client (workspacectl) は、Teradata AI Unlimited のコマンド ライン インターフェース (CLI) です。このドキュメントでは、workspacectlをインストールするための手順を説明します。このドキュメントには、CLI コマンドに関する必要な情報とガイダンスがすべて記載されており、コマンド ラインを迅速かつ効率的に操作できるようになります。現在のリリースでは、workspacectl を使用してワークスペース サービスに接続し、エンジンを管理することのみが可能です。Teradata では、データ探索用の Teradata AI Unlimited インターフェースとして JupyterLab を使用することを推奨しています。

始める前に

以下を確認します。

workspacectlのインストール

https://downloads.teradata.com/download/tools/ai-unlimited-ctlからworkspacectlの実行可能ファイルをダウンロードします。

Workspacectlはすべての主要なオペレーティングシステムをサポートしています。

workspacectlを使用する

  1. ターミナルウィンドウを開き、workspacectlファイルを実行します。

    • Windows

    • MacOS

    worksapcesctl.exe
    workspacesctl
    AI Unlimited CLI
  2. API キーを使用してワークスペース サービスを構成します。

    workspacesctl workspaces config
  3. 新しいプロジェクトを作成します。

    workspacesctl project create <Project_Name> -e <CSP> --no-tls
  4. プロジェクトのエンジンをデプロイします。

    workspacesctl project engine deploy <Project_Name> -t <Size_of_Engine> --no-tls
  5. サンプルワークロードを実行します。

  6. プロジェクトとエンジンを管理します。

  7. プロジェクトをバックアップする。

    workspacesctl project backup <Project_Name> --no-tls
  8. エンジンを停止します。

    workspacesctl project engine suspend <Project_Name> --no-tls

サポートされているコマンドのリストについては、 ワークスペースクライアントのリファレンス を参照してください。

ワークスペースクライアントのリファレンス

workspaces config

説明: CLI をワークスペース サービスにバインドするための 1 回限りの構成。ワークスペースサービスのプロファイルページに移動し、APIキーをコピーします。

使用方法:

workspacesctl workspaces config

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

AI Unlimited の CLI 構成

プロンプトに従って、ワークスペースサービスのエンドポイントとAPIキーを選択します。

workspaces user list

説明: GitHub で Teradata AI Unlimited 用に設定されたユーザーのリストを表示します。

使用方法:

workspacesctl workspaces user list --no-tls
設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

AI Unlimited CLIユーザーリスト

project create

説明: Teradata AI Unlimitedでプロジェクトを作成します。このコマンドは、プロジェクトに対応する GitHub リポジトリも作成します。

使用方法:

workspacesctl project create <Project_Name> -e <CSP> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

フラグ 説明 必須?

-e, --environment

文字列

プロジェクト エンジンがホストされる環境。値:aws、azure、またはgcloud。現在、Teradata AI Unlimited は aws と azure をサポートしています。

はい

-f, --manifest

文字列

入力に使用されるyamlファイルをマニフェストするためのパス。

いいえ

-t, --team

文字列

プロジェクトに割り当てられたチーム。

いいえ

-h, --help

コマンドの詳細をリストします。

いいえ

出力:

AI Unlimited CLI プロジェクトの作成

project list

説明: Teradata AI Unlimited で設定されているすべてのプロジェクトの一覧表示します。

使用方法:

workspacesctl project list --no-tls

または

workspacesctl project list <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

AI Unlimited CLI プロジェクトのリスト

project delete

説明: Teradata AI Unlimited でプロジェクトを削除します。

使用方法:

 workspacesctl project delete <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

出力は YAML 形式です。
AI Unlimited CLI プロジェクトの削除

project user list

説明: GitHub でプロジェクトに割り当てられた共同作業者をリストします。

使用方法:

workspacesctl project user list <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

AI Unlimited CLI プロジェクトユーザーのリスト

project backup

説明: エンジン オブジェクト定義を、プロジェクトに割り当てられた GitHub リポジトリにバックアップします。

使用方法:

workspacesctl project backup <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

出力はYAML形式です。
AI Unlimited の CLI プロジェクトのバックアップ

project restore

説明: プロジェクトの GitHub リポジトリからすべてのエンジン オブジェクト定義を復元します。

使用方法:

workspacesctl project restore <Project_Name> --no-tls

または

workspacesctl project restore <Project_Name> --gitref <git_reference> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

フラグ 説明 必須?

-g, --gitref

文字列

タグ、SHA、またはブランチ名。

いいえ

-h, --help

コマンドの詳細をリストします。

いいえ

出力:

出力はYAML形式です。
AI Unlimited CLI プロジェクトの復元

project engine deploy

説明: プロジェクトのエンジンをデプロイします。

使用方法:

workspacesctl project engine deploy <Project_Name> -t small --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

フラグ 説明 必須?

-c, --instance-count

Int

エンジン ノードの数。デフォルト値は1です。

いいえ

-t, --instance-size

文字列

エンジンのインスタンス サイズ。

いいえ

-f, --manifest

文字列

入力に使用する yaml ファイルをマニフェストするパス。

いいえ

-r, --region

文字列

デプロイメントのリージョン。

いいえ

-s, --subnet-id

文字列

デプロイメントのサブネット ID。

いいえ

-h, --help

コマンドの詳細をリストします。

いいえ

project engine suspend

説明: デプロイされたエンジンを破棄し、セッション中に作成されたオブジェクト定義をバックアップします。

使用方法:

workspacesctl project engine suspend <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

出力はYAML形式です。
AI Unlimited CLIエンジンの停止

project engine list

説明: プロジェクトのエンジンに関する詳細情報を表示します。このコマンドは、エンジンの最後の状態を表示します。

使用方法:

workspacesctl project engine list <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

出力はYAML形式です。
AI Unlimited CLIエンジンのリスト

project auth create

説明: オブジェクト ストアの認証を作成します。

使用方法:

workspacesctl project auth create <Project_Name> -n <Auth_Name> -a <Auth_Key> -s <Auth_Secret> -r <ObjectStore_Region> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

フラグ 説明 必須?

-a, --accesskey

文字列

認証アクセスキーまたはID。

はい ( -f フラグを使用していない場合)。

-n, --name string

文字列

オブジェクトストアの認証名。

はい ( -f フラグを使用していない場合)。

-f, --manifest

文字列

入力に使用する yaml ファイルをマニフェストするパス。

いいえ

-r, --region

文字列

オブジェクトストアのリージョン。

はい

-s, --secret string

文字列

オブジェクト ストアの認証シークレット アクセス キー。

はい ( -f フラグを使用していない場合)。

-h, --help

コマンドの詳細をリストします。

いいえ

出力:

出力はYAML形式です。
AI Unlimited CLI 認証の作成

project auth list

説明: プロジェクトに対して作成されたオブジェクト ストアの認証をリストします。

使用方法:

workspacesctl project auth list <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、 `-no-tls`パラメータを追加する必要はありません。

フラグ:

-h--help: コマンドの詳細をリストします。

出力:

出力はYAML形式です。
AI Unlimited CLI 認証のリスト

project auth delete

説明: プロジェクトに対して作成されたオブジェクト ストアの認証を削除します。

使用方法:

workspacesctl project auth delete <Project_Name> -n <Auth_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。

フラグ:

フラグ 説明 必須?

-n, --name

文字列

削除するオブジェクト ストアの認証の名前。

はい

-h, --help

コマンドの詳細をリストします。

いいえ

出力:

出力はYAML形式です。
AI Unlimited CLI 認証の削除
ご質問がある場合、またはさらにサポートが必要な場合は、コミュニティ フォーラムにアクセスしてサポートを受け、他のコミュニティ メンバーと交流してください。
このページは役に立ちましたか?