Skip to content

AnnoFab v0.123.0に対応 #364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion annofabapi/__version__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.48.1"
__version__ = "0.48.2"
2 changes: 1 addition & 1 deletion annofabapi/dataclass/my.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ class MyAccount(DataClassJsonMixin):
""""""

is_external_account: bool
"""[外部アカウント連携](/docs/faq/#mpl0n7)済みのアカウントである場合true """
"""[外部アカウントだけで作成したアカウント](/docs/faq/#v1u344)の場合true。 外部アカウント連携していないAnnoFabアカウントや、後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたAnnoFabアカウントの場合false。 """

updated_datetime: Optional[str]
""""""
Expand Down
1 change: 1 addition & 0 deletions annofabapi/generated_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ def get_annotation_list(
page (int): 検索結果のうち、取得したいページの番号(1始まり)
limit (int): 1ページあたりの取得するデータ件数
aggregate_by_task_and_input (bool): trueを指定した場合に「タスクIDと入力IDの組」ごとに検索結果を集計するようにする。
no_aggregate_label_and_input (bool): trueを指定した場合、ラベルIDによるアノテーション検索数の集約結果、および属性IDによるアノテーション検索数の集約結果を取得しなくなります。 集約計算は時間がかかる処理であるため、アノテーション件数が多い場合はアノテーション検索が遅くなる場合がありますが、 このパラメーターをtrueに指定することで集約計算をおこなわなくなるため、アノテーション検索が速くなる可能性があります。
query (str): 絞り込み条件([AnnotationQuery](#section/AnnotationQuery))をJSON形式で表した文字列。
sort (str): ソート順の指定。 使用可能キーはtask_id, input_data_id, detail.annotation_id, detail.account_id, detail.label_id, detail.data_holding_type, detail.created_datetime, detail.updated_datetimeのいずれかです。降順指定時は先頭に-(ハイフン)を付与します。 複数指定時は,(カンマ)区切りで列挙します。複数キーを列挙した場合は、先頭から優先順位を割り振られます。

Expand Down
4 changes: 2 additions & 2 deletions annofabapi/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@
* authority: AccountAuthority

* is_external_account: bool
[外部アカウント連携](/docs/faq/#mpl0n7)済みのアカウントである場合true
[外部アカウントだけで作成したアカウント](/docs/faq/#v1u344)の場合true。 外部アカウント連携していないAnnoFabアカウントや、後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたAnnoFabアカウントの場合false。
* updated_datetime: str


Expand Down Expand Up @@ -2561,7 +2561,7 @@ class JobStatus(Enum):
* authority: AccountAuthority

* is_external_account: bool
[外部アカウント連携](/docs/faq/#mpl0n7)済みのアカウントである場合true
[外部アカウントだけで作成したアカウント](/docs/faq/#v1u344)の場合true。 外部アカウント連携していないAnnoFabアカウントや、後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたAnnoFabアカウントの場合false。
* updated_datetime: str

* reset_requested_email: str
Expand Down
4 changes: 2 additions & 2 deletions annofabapi/wrapper.py
Original file line number Diff line number Diff line change
Expand Up @@ -991,8 +991,8 @@ def _request_location_header_url(self, response: requests.Response) -> Optional[

response.encoding = "utf-8"
_raise_for_status(response)
content = self.api._response_to_content(response)
return content
# Locationヘッダに記載されているURLの中身はJSONであること前提
return response.json()

def get_task_statistics(self, project_id: str) -> List[Any]:
"""
Expand Down
6 changes: 4 additions & 2 deletions generate/swagger/swagger-api-components.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,9 @@ components:
is_external_account:
type: boolean
description: |
[外部アカウント連携](/docs/faq/#mpl0n7)済みのアカウントである場合true
[外部アカウントだけで作成したアカウント](/docs/faq/#v1u344)の場合true。

外部アカウント連携していないAnnoFabアカウントや、後から[外部アカウントとの紐付け](/docs/faq/#yyyub0)をしたAnnoFabアカウントの場合false。
updated_datetime:
type: string
format: date-time
Expand Down Expand Up @@ -1494,7 +1496,7 @@ components:
$ref: "#/components/schemas/WebhookHeader"
body:
type: string
example: '{\"message\": \"{{PROJECT_ID}} is updated at {{COMPLETE_DATETIME}}\"}'
example: '{"message": "{{PROJECT_ID}} is updated at {{COMPLETE_DATETIME}}"}'
url:
type: string
format: uri
Expand Down
2 changes: 1 addition & 1 deletion generate/swagger/swagger.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ info:

上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。

version: 0.121.0
version: 0.123.0
title: AnnoFab Web API
x-logo:
url: "https://annofab.com/resource/images/logo_landscape.png"
Expand Down
13 changes: 12 additions & 1 deletion generate/swagger/swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ info:
上記例 `account_id_count` は、タスクのフィールド `account_id` でタスクを分類したところ「`account_id` が `c5eee002` であるタスクが9件、`9f110e48` であるタスクが5件、`b25dfeb3` であるタスクが1件」だったという結果を表しています。
また、AggregationResultの集約の件数は、合計で10000件以下に制限されており、それを超える件数がある場合は上位10000件が取得されます。もし、省略された部分を取得したい場合は、検索条件を縛って結果に上る集約の数を減らしてください。

version: 0.121.0
version: 0.123.0
title: AnnoFab Web API
x-logo:
url: "https://annofab.com/resource/images/logo_landscape.png"
Expand Down Expand Up @@ -4132,6 +4132,17 @@ paths:
schema:
type: boolean
default: false
- name: no_aggregate_label_and_input
in: query
description: |
trueを指定した場合、ラベルIDによるアノテーション検索数の集約結果、および属性IDによるアノテーション検索数の集約結果を取得しなくなります。

集約計算は時間がかかる処理であるため、アノテーション件数が多い場合はアノテーション検索が遅くなる場合がありますが、
このパラメーターをtrueに指定することで集約計算をおこなわなくなるため、アノテーション検索が速くなる可能性があります。
required: false
schema:
type: boolean
default: false
- name: query
in: query
description: |
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "annofabapi"
version = "0.48.1"
version = "0.48.2"
description = "Python Clinet Library of AnnoFab WebAPI (https://annofab.com/docs/api/)"
authors = ["yuji38kwmt"]
license = "MIT"
Expand Down