はじめに
3 分
グラウンドトゥルース生成プロセスをプログラムから操作できるように、HTTP APIを提供しています。このページでは、これらの統合の使用方法、利用可能な機能、および使用される概念と識別子について説明します。
現在の機能は、納品済みアノテーションのレビューに限定されています。
前提条件
始める前に、以下がそろっていることを確認してください：
- APIを使用する権限を持つアカウント
- 生成済みのAPI認証情報（高度な設定高度な設定を参照してください）
- 認証用のPython 3 SDKをインストール済み — kognic-auth
このページでは以下も前提とします：
- ユーザーが少なくとも1つのプロジェクトにアクセスでき、そのプロジェクトに少なくとも1つのインプットバッチがアップロードされていること。
APIクライアント
kognic-io Pythonクライアントは大部分のエンドポイントをカバーしています。カバーされていないエンドポイントについては、kognic-authとrequestsライブラリのみを使用してAPIを利用する方法の例を示します。
エンドポイント
アクセス可能なエンドポイントの一覧は、Swaggerドキュメントで確認できます。
リクエスト例
以下は、kognic-authライブラリを使用して、ユーザーが利用可能なレビューフィードバックエラータイプを取得する例です：
import requests
from kognic.auth.requests.auth_session import RequestsAuthSession
base_url = "https://annotation-integration.app.kognic.com/v1/"
client = RequestsAuthSession()
try:
response = client.session.get(base_url + "reviews/error-types")
response.raise_for_status()
data = response.json()
print(data)
except requests.exceptions.RequestException as e:
print(f"Request error: {e}")