参考 hub_sdk/base/api_client.py
注
このファイルはhttps://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client.py にあります。もし問題を発見したら、Pull Request🛠️ を投稿して修正にご協力ください。ありがとうございました!
hub_sdk.base.api_client.APIClientError
ベース: Exception
API クライアントエラー用のカスタム例外クラス。
属性:
名称 | タイプ | 説明 |
---|---|---|
message |
str
|
人間が読めるエラーメッセージ。 |
status_code |
int
|
もしあれば、エラーに関連するHTTPステータスコード。 |
ソースコード hub_sdk/base/api_client.py
__init__(message, status_code=None)
APIClientErrorインスタンスを初期化します。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
message |
str
|
人間が読めるエラーメッセージ。 |
必須 |
status_code |
int
|
もしあれば、エラーに関連するHTTPステータスコード。 |
None
|
ソースコード hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
指定されたベースURLへのリクエストを行うAPIクライアントを表す。
属性:
名称 | タイプ | 説明 |
---|---|---|
base_url |
str
|
APIのベースURL。 |
headers |
(dict, None)
|
各リクエストに含まれるヘッダー。 |
logger |
Logger
|
ロギング用のロガーのインスタンス。 |
ソースコード hub_sdk/base/api_client.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
__init__(base_url, headers=None)
APIClientクラスのインスタンスを初期化します。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
base_url |
str
|
APIのベースURL。 |
必須 |
headers |
dict
|
各リクエストに含まれるヘッダー。 |
None
|
ソースコード hub_sdk/base/api_client.py
delete(endpoint, params=None)
APIにDELETEリクエストを行う。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
endpoint |
str
|
リクエストのベース URL に追加するエンドポイント。 |
必須 |
params |
dict
|
リクエストに含めるパラメータ。 |
None
|
リターンズ
タイプ | 説明 |
---|---|
Optional[Response]
|
HTTP DELETE リクエストのレスポンス・オブジェクト。 |
ソースコード hub_sdk/base/api_client.py
get(endpoint, params=None)
APIにGETリクエストを行う。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
endpoint |
str
|
リクエストのベース URL に追加するエンドポイント。 |
必須 |
params |
dict
|
リクエストのクエリパラメータ。 |
None
|
リターンズ
タイプ | 説明 |
---|---|
Optional[Response]
|
HTTP GETリクエストのレスポンス・オブジェクト。 |
ソースコード hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
APIにPATCHリクエストを行う。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
endpoint |
str
|
リクエストのベース URL に追加するエンドポイント。 |
必須 |
data |
dict
|
リクエストのボディに送られるデータ。 |
None
|
json |
dict
|
リクエスト・ボディに送信するJSONデータ。 |
None
|
リターンズ
タイプ | 説明 |
---|---|
Optional[Response]
|
HTTP PATCH リクエストのレスポンス・オブジェクト。 |
ソースコード hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
APIにPOSTリクエストを行う。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
endpoint |
str
|
リクエストのベース URL に追加するエンドポイント。 |
必須 |
data |
dict
|
リクエストのボディに送られるデータ。 |
None
|
json |
dict
|
リクエスト・ボディに送信するJSONデータ。 |
None
|
files |
dict
|
リクエストに含まれるファイル(もしあれば)。 |
None
|
stream |
bool
|
True の場合、レスポンスの内容はストリームされます。 |
False
|
リターンズ
タイプ | 説明 |
---|---|
Optional[Response]
|
HTTP POSTリクエストのレスポンス・オブジェクト。 |
ソースコード hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
APIにPUTリクエストを行う。
パラメーター
名称 | タイプ | 説明 | デフォルト |
---|---|---|---|
endpoint |
str
|
リクエストのベース URL に追加するエンドポイント。 |
必須 |
data |
Optional[Dict]
|
リクエストのボディに送られるデータ。 |
None
|
json |
Optional[Dict]
|
リクエスト・ボディに送信されるJSONデータ |
None
|
リターンズ
タイプ | 説明 |
---|---|
Optional[Response]
|
HTTP PUT リクエストのレスポンス・オブジェクト。 |