命令参考

重新配置

管理命名上下文的操作的作用域是re config命令。 其中包括用于创建、读取、更新、删除上下文的子命令，以及设置默认命名上下文和实用程序的子命令。

用法

re config [OPTIONS] <SUBCOMMAND>

子命令

命令	说明
re config add	在配置文件中创建或修改命名上下文
re config current	显示当前使用的上下文
re config delete	从重新推断配置文件中删除指定的上下文
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

从重新推断配置文件中删除指定的上下文

用法

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]

选项

选项	说明
--tokens	显示 API 令牌（默认情况下隐藏令牌）

re config use

设置运行命令时默认使用的上下文

用法

re config use <name>

选项

选项	说明
<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	创建新用户 (注意: 不会发送欢迎电子邮件)

选项

选项	说明
-h、 --help	打印帮助信息
-V、 --version	打印版本信息

查看可用子命令或有关给定子命令的帮助

re create help

re get

将资源打印到标准输出，包括将注释批量导出到本地文件系统。

re get [OPTIONS] <SUBCOMMAND>

子命令

子命令	说明
re get buckets	列出可用存储桶
re get comment	从来源获取单个注释
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

选项

选项	说明
-h、 --help	打印帮助信息
-V、 --version	打印版本信息

re get buckets

列出可用的存储桶。

用法

re get buckets [bucket-name]

re get comment

从来源获取单个注释。

用法

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

选项	说明
--source <source>	(必填)来源名称或 ID
-f, --file <path>	要以 JSON 形式写入注释的路径。 如果未指定，则将使用标准输出
<comment-id>	注释 ID

re get comments

从来源下载许多注释

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

选项

选项	说明
<source>	(必填)来源名称或 ID
-d, --dataset <dataset>	数据集名称或 ID
-f, --file <path>	要以 JSON 形式写入注释的路径。 如果未指定，则将使用标准输出。
--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]

选项

选项	说明
<dataset>	如果指定，则仅列出此数据集（名称或 ID）

re get projects

列出可用项目

用法

re get projects [dataset]

选项

选项	说明
<dataset>	如果指定，则仅列出此数据集（名称或 ID）

re get sources

列出可用来源

用法

re get sources [source]

选项

选项	说明
<source>	如果指定，则仅列出此数据集（名称或 ID）

re get stream-comments

从流中获取注释

用法

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

选项

选项	说明
--stream <stream>	（必填）完整的流名称<owner>/<dataset>/<stream>
--individual-advance	如果设置，该命令将按顺序确认每个注释，而不是整批确认
--listen <listen>	如果设置，该命令将永久运行，每 N 秒轮询一次并推进流
--size <size>	每批返回的最大注释数 [默认值: 16]

re get streams

列出数据集的可用流

用法

re get streams --dataset <dataset>

选项

选项	说明
-d, --dataset <dataset>	（必需）数据集名称或 ID

re get users

列出可用用户

用法

re get users [OPTIONS]

选项

选项	说明
-u, --user <user>	用于检索具有提供的 ID 的单个用户

重新删除

用于删除资源的子命令

用法

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