コレクションとキー

コレクション（Collection）とキー（Key）は、データベースに追加された際、顔データにある2つのインデックス化されたフィールドです。一般に、これら2つのフィールドは同じプロパティであり、完全に互換性があります。従来のサービスユーザーを配慮して、AnySeeでのデータパーティションと外部ユーザーキーの使用を表すために、これらの名目上の名前を使用しています。

コレクション

従来の顔認証サービスとは異なり、AnySeeは顔データを追加・検索する前に、データのパーティションを作成する必要はありません。しかし、その機能を模擬するには、collectionフィールドを提供しています。

コレクションを使用するには、顔データ追加APIをコールする時に、リクエスト本文にそのフィールドを含めてください。フォーマットに準拠していれば受け入れられます。実際のコレクションは作成されませんが、インデックス化されるフィールドであるため、一覧表示や検索時にタグのような機能をします。この性質上、作成できるコレクションの数にも制限はありません。データセットが小さい場合は、コレクションフィールドなしでコールすることもできます。その場合、値は空白（""）になります。

このタグのようなフィールドを使用する主な利点は、検索の柔軟性が向上することです。リクエスト本文の1つのパラメーターを変更するだけで、検索範囲を特定のコレクションに簡単に絞り込んだり、テナント全体を検索したりできます。また、コレクションを管理する手間も軽減されます。

この仕様の唯一の欠点は、コレクション全体を簡単に一括削除したい場合、簡単に実現する方法はありません。ただし、毎日コレクションを削除・再作成する場合は、不要なデータを自動的に消去する TTL機能が提供されます。将来的には、1回のリクエストで特定範囲のデータをすべて削除するバッチAPIも提供する予定です。

キー

AnySeeのキー（Key）フィールドは、従業員番号や顧客番号など、顧客管理の外部一意のIDを格納するために用意しています。しかし、本サービスがリソースを生成する際にその一意性をチェックしません。お客様ご自身でご確認ください。一方、同一人物の複数の顔データを保存したい場合は、同じキーを利用して追加することによって、実現できます。また、メタデータ機能を使えば、同一人物の顔データに番号を付けることもできます。

キーの入力は任意です。リクエスト本文に含めない場合、値は空白（""）になります。