ユーザー向けエラーをスローする

Workshop や Actions などのプラットフォームの他の部分で関数を実行する際に、詳細なメッセージを伴うエラーをスローしたい場合があります。そのためには、functions.api モジュールから UserFacingError をスローします。たとえば:

Copied!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
from functions.api import function, UserFacingError
from ontology_sdk import FoundryClient
from ontology_sdk.ontology.object_sets import AircraftObjectSet
from ontology_sdk.ontology.objects import Aircraft

# @function デコレータを使用して関数を定義
@function(edits=[Aircraft])
def edit_exactly_five_aircraft(
    aircraft_object_set: AircraftObjectSet
) -> list[OntologyEdit]:
    aircraft = list(aircraft_object_set)  # AircraftObjectSetをリストに変換
    if not len(aircraft) == 5:  # 航空機の数が5でない場合にエラーを発生させる
        raise UserFacingError(f"Pass in exactly 5 aircraft. Received ${len(aircraft)}.")
    ... # オブジェクトを編集

この Workshop アプリケーション で 関数を利用したアクション として実行する際に、従業員数が正しくない場合、ユーザーは以下のエラーを目にします。

詳細なユーザー向けエラーメッセージを追加することで、関数の他のユーザーが問題を迅速に特定し、修正できるように支援できます。