コマンド リファレンス

再設定

名前付きコンテキストを管理するための操作は、re config コマンドでスコープが設定されます。これには、コンテキストを作成、読み取り、更新、削除するためのサブコマンドと、デフォルトの名前付きコンテキストとユーティリティの設定が含まれます。

使用状況

re config [OPTIONS] <SUBCOMMAND>

サブコマンド

コマンド	説明
re config add	構成ファイル内の名前付きコンテキストを作成または変更する
re config current	使用中の現在のコンテキストを表示する
re config delete	指定したコンテキストを reinfer 構成ファイルから削除します
re config get-token	特定のコンテキストのトークン、または指定されていない場合は現在のコンテキストのトークンを出力します
re config ls	構成ファイル内の使用可能なすべてのコンテキストを一覧表示します
re config use	コマンドに何も指定されていない場合に使用する既定のコンテキストを設定する

使用可能なサブコマンドを表示したり、特定のサブコマンドに関するヘルプを表示したりするには

re config help

re config add

構成ファイル内の名前付きコンテキストを作成または変更する

使用状況

re config add [FLAGS] [OPTIONS]

オプション

名前	説明
-n, --name <name>	作成または更新されるコンテキストの名前。
-e, --endpoint <endpoint>	このコンテキストに使用される Communications Mining クラスター エンドポイントです
-t, --token <token>	このコンテキストに使用される Communications Mining の API トークン。
--proxy <proxy>	HTTP プロキシの URL です。指定した場合、すべての要求に使用されます。
-k, --accept-invalid-certificates	無効な TLS 証明書を受け入れるかどうか。 これを使用する必要はなく、開発用に Communications Mining クラスターをローカルで実行します

例

# Add a new context called `acme`. The cli will interactively ask to provide an API token.
re config add --name acme --endpoint https://acme.reinfer.io

# Using `--name` with a context that already exists will modify it instead.# For example, the next command changes the endpoint of the `acme` context.
re config add --name acme --endpoint https://acme-dev.reinfer.io

# Create a context specifying all information as arguments.
re config add -n staging -e https://localhost:9443 -k -t MYTOKEN

# If options are not provided, the cli will interactively prompt user to enter them
re config add
# Standard output:
* Context name: my-context
I A new context `my-context` will be created
* Enter API token [none]: SECRETTOKEN
W Be careful, API tokens are stored in cleartext in /home/marius/.config/reinfer/contexts.json
* Endpoint [https://reinfer.io/]: https://acme.reinfer.io
I New context `my-context` was created

re config current

使用中の現在のコンテキストを標準出力に出力する

使用状況

re config current

例

# Print the currently used context to stdout
re config current

# Save the current context to an environment variable
export REINFER_CONTEXT=`re config current`

re config delete

指定したコンテキストを reinfer 構成ファイルから削除します

使用状況

re config delete [names]...

例

# Delete context acme
re config delete acme

# Delete multiple contexts
re config delete acme other-context

re config get-token

特定のコンテキストの API トークン、または現在のコンテキスト (指定されていない場合) の API トークンを標準出力に出力します

使用法​

re config get-token [name]

例

# Print the API token for the current context to stdout
re config get-token

# Save the API token for the current context in an environment variable
export REINFER_TOKEN=`re config get-token`

# Same, but get the API token for a specific context (acme)
export REINFER_TOKEN=`re config get-token`

re config ls

構成ファイル内の使用可能なすべてのコンテキストを一覧表示します

使用状況

re config ls [OPTIONS]

オプション

OPTION	説明
--tokens	APIトークンを表示(デフォルトではトークンは非表示です)

re config use

コマンドの実行時に既定で使用するコンテキストを設定する

使用状況

re config use <name>

オプション

OPTION	説明
<name>	新しい既定値にするコンテキストの名前

re create

新規リソースを作成するためのサブコマンド

使用状況

re create [OPTIONS] <SUBCOMMAND>

サブコマンド

サブコマンド	説明
re create annotations	注釈を作成または更新する
re create bucket	新しいバケットを作成する
re create comments	コメントを作成または更新する
re create dataset	新しいデータセットを作成する
re create emails	メールを作成または更新する
re create project	新しいプロジェクトを作成する
re create source	新しいソースを作成する
re create stream-exception	新しいストリームの例外を作成する
re create user	新しいユーザーを作成する (注: ウェルカム メールは送信されません)

オプション

OPTION	説明
-h、 --help	ヘルプ情報を出力する
-V、 --version	バージョン情報を出力する

使用可能なサブコマンドを表示したり、特定のサブコマンドに関するヘルプを表示したりするには

re create help

re get

コメントをローカルファイルシステムに一括でエクスポートするなど、リソースを標準出力に出力します。

re get [OPTIONS] <SUBCOMMAND>

サブコマンド

サブコマンド	説明
re get buckets	使用可能なバケットのリストを表示します。
re get comment	ソースから 1 つのコメントを取得する
re get comments	ソースからすべてのコメントをダウンロードする
re get current-user	使用中の API トークンに関連付けられているユーザーを取得する
re get datasets	利用可能なデータセットのリストを表示する
re get projects	使用可能なプロジェクトの一覧表示
re get sources	使用可能なソースを一覧表示する
re get stream-comments	ストリームからコメントを取得する
re get streams	データセットで使用可能なストリームを一覧表示する
re get users	使用可能なユーザーを一覧表示する

使用可能なサブコマンドを表示したり、特定のサブコマンドに関するヘルプを表示したりするには

re get help

オプション

OPTION	説明
-h、 --help	ヘルプ情報を出力する
-V、 --version	バージョン情報を出力する

re get buckets

使用可能なバケットを一覧表示します。

使用状況

re get buckets [bucket-name]

re get comment

ソースから 1 つのコメントを取得します。

使用状況

re get comment [OPTIONS] --source <source> <comment-id>

OPTION	説明
--source <source>	(必須) ソースの名前または ID
-f, --file <path>	コメントを JSON として書き込むパスです。 指定しない場合は、stdout が使用されます
<comment-id>	コメント ID

re get comments

ソースから多くのコメントをダウンロードする

re get comments [FLAGS] [OPTIONS] <source>

オプション

OPTION	説明
<source>	(必須) ソースの名前または ID
-d, --dataset <dataset>	データセットの名前または ID
-f, --file <path>	コメントを JSON として書き込むパス。指定しない場合は、stdout が使用されます。
--no-progress	プログレスバーを表示しない(--fileが使用されている場合にのみ適用可能)
--from-timestamp <from-timestamp>	取得するコメントの開始タイムスタンプ (両端を含む)
--predictions <include-predictions>	各コメントの予測ラベルと一般フィールドを保存する
--reviewed-only <reviewed-only>	レビュー済みのコメントのみをダウンロードする
--to-timestamp <to-timestamp>	取得するコメントの終了タイムスタンプ (両端を含む)

re get current-user

使用中の API トークンに関連付けられているユーザーを取得する

使用状況

re get current-user

re get datasets

利用可能なデータセットのリストを表示する

使用状況

re get datasets [dataset]

オプション

OPTION	説明
<dataset>	指定した場合、このデータセット (名前または ID) のみを一覧表示します

re get projects

使用可能なプロジェクトの一覧表示

使用状況

re get projects [dataset]

オプション

OPTION	説明
<dataset>	指定した場合、このデータセット (名前または ID) のみを一覧表示します

re get sources

使用可能なソースを一覧表示する

使用状況

re get sources [source]

オプション

OPTION	説明
<source>	指定した場合、このデータセット (名前または ID) のみを一覧表示します

re get stream-comments

ストリームからコメントを取得する

使用状況

re get stream-comments [FLAGS] [OPTIONS] --stream <stream>

オプション

OPTION	説明
--stream <stream>	(必須) 完全なストリーム名 <owner>/<dataset>/<stream>
--individual-advance	設定されている場合、コマンドは完全なバッチではなく、各コメントを順番に確認します
--listen <listen>	設定されている場合、コマンドは永久に実行され、N秒ごとにポーリングされ、ストリームを進めます
--size <size>	バッチごとに返されるコメントの最大数 [既定値: 16]

re get streams

データセットで使用可能なストリームを一覧表示する

使用状況

re get streams --dataset <dataset>

オプション

OPTION	説明
-d, --dataset <dataset>	(必須) データセットの名前または ID

re get users

使用可能なユーザーを一覧表示する

使用状況

re get users [OPTIONS]

オプション

OPTION	説明
-u, --user <user>	指定した ID を持つ 1 人のユーザーを取得するために使用します

再削除

リソースを削除するためのサブコマンド

使用状況

re delete <SUBCOMMAND>

サブコマンド

サブコマンド	説明
re delete bucket	バケットを削除する
re delete bulk	特定の時間範囲のすべてのコメントを削除する
re delete comments	ソース内のIDでコメントを削除する
re delete dataset	データセットを削除する
re delete help	このメッセージまたは指定されたサブコマンドのヘルプを出力する
re delete project	プロジェクトを削除する
re delete source	ソースを削除する
re delete user	ユーザーを削除する

フラグ

フラグ	説明
-h、 --help	ヘルプ情報を出力する
-V、 --version	バージョン情報を出力する

使用可能なサブコマンドを表示したり、特定のサブコマンドに関するヘルプを表示したりするには

re delete help