annotation_specs parse_attribute_restriction#

Description#

自然言語で書かれた属性制約の情報から、Annofabの属性制約を解析します。アノテーションルールや運用ルールの文章から、属性制約ASTやAnnofabに登録可能なJSONを生成したいときに利用できます。 annofab_json 形式で出力したJSONは、 annofabcli annotation_specs add_attribute_restriction コマンドでAnnofabに登録できます。

このコマンドを実行するには、対象のラベルと属性がアノテーション仕様に存在している必要があります。新規でアノテーション仕様を作成する場合は、先に annotation_specs parse_label と annotation_specs parse_attribute でラベルと属性を追加してください。

Examples#

基本的な使い方#

--output_format を省略した場合は、 human_readable 形式で出力されます。

restriction.md#

属性`occluded`がチェックされているときは、属性`note`を必須にしてください。
属性`vehicle_type`には`general_car`を選択してください。

$ annofabcli-llm annotation_specs parse_attribute_restriction \
 --annotation_specs_json_file annotation_specs.json \
 --restriction_text @restriction.md

標準出力#

[restrictions]
- If 'occluded' is checked, 'note' is not empty.
- 'vehicle_type' is 'general_car'

Annofabに登録可能なJSONを出力する#

$ annofabcli-llm annotation_specs parse_attribute_restriction \
 --project_id ${PROJECT_ID} \
 --restriction_text @restriction.md \
 --output restriction.json \
 --output_format annofab_json

生成された restriction.json は、 annofabcli annotation_specs add_attribute_restriction コマンドの入力として利用できます。以下は restriction.json の出力例です。 additional_data_definition_id や選択肢のIDは、プロジェクトのアノテーション仕様によって異なります。

restriction.json#

[
  {
    "additional_data_definition_id": "attr_note",
    "condition": {
      "_type": "Imply",
      "premise": {
        "additional_data_definition_id": "attr_occluded",
        "condition": {
          "_type": "Equals",
          "value": "true"
        }
      },
      "condition": {
        "_type": "NotEquals",
        "value": ""
      }
    }
  },
  {
    "additional_data_definition_id": "attr_vehicle_type",
    "condition": {
      "_type": "Equals",
      "value": "choice_general_car"
    }
  }
]

ASTのJSONを出力する#

$ annofabcli-llm annotation_specs parse_attribute_restriction \
 --annotation_specs_json_file annotation_specs.json \
 --restriction_text @restriction.md \
 --output restriction_ast.json \
 --output_format ast_json

restriction_ast.json#

{
  "asts": [
    {
      "type": "imply",
      "premise": {
        "type": "checked",
        "attribute_name": "occluded"
      },
      "conclusion": {
        "type": "is_not_empty",
        "attribute_name": "note"
      }
    },
    {
      "type": "has_choice",
      "attribute_name": "vehicle_type",
      "choice_name": "general_car"
    }
  ],
  "warnings": [],
  "unresolved_texts": []
}

注釈

解析結果の途中経過は $HOME/.cache/annofab-cli-llm/temp/parse_attribute_restriction_* に出力されます。

Usage Details#

自然言語から属性制約を解析します。 --output_format annofab_json で出力されるJSONは、 [annofabcli annotation_specs add_attribute_restriction](https://annofab-cli.readthedocs.io/ja/latest/command_reference/annotation_specs/add_attribute_restriction.html) コマンドでAnnofabに登録できます。

usage: annofabcli-llm annotation_specs parse_attribute_restriction
       [-h] [-m MODEL] [--verbose] [--yes] [--annofab_pat ANNOFAB_PAT]
       (--annotation_specs_json_file ANNOTATION_SPECS_JSON_FILE |
       -p PROJECT_ID) --restriction_text RESTRICTION_TEXT [-o OUTPUT]
       [--output_format {human_readable,ast_json,annofab_json}]
       [--no-interactive]

Named Arguments#

--annotation_specs_json_file

annotation specs v3 のJSONファイルのパス

-p, --project_id

AnnofabのプロジェクトID

--restriction_text

属性制約の情報が記載された自然言語。先頭に`@`を指定すると、`@`以降をファイルパスとみなしてファイルの中身を読み込みます。

-o, --output

出力先のファイルパス。指定しない場合は、標準出力に出力されます。

--output_format

Possible choices: human_readable, ast_json, annofab_json

出力形式

Default: 'human_readable'

--no-interactive

未解決テキストが存在しても、補足情報の入力を求めずに終了します。

global optional arguments#

-m, --model

使用するLLMのモデルです。使用できるモデルは https://docs.litellm.ai/docs/providers を参照してください。

Default: 'openai/gpt-5.4-mini'

--verbose

詳細なログを出力します。

--yes

確認メッセージに対して常に'yes'と回答したとみなします。確認メッセージが表示されません。

--annofab_pat

AnnofabのPersonal Access Token