Referenz für hub_sdk/base/api_client.py
Hinweis
Diese Datei ist verfügbar unter https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/api_client .py. Wenn du ein Problem entdeckst, hilf bitte, es zu beheben, indem du einen Pull Request 🛠️ einreichst. Vielen Dank 🙏!
hub_sdk.base.api_client.APIClientError
Basen: Exception
Benutzerdefinierte Ausnahmeklasse für API-Client-Fehler.
Attribute:
Name | Typ | Beschreibung |
---|---|---|
message |
str
|
Eine für Menschen lesbare Fehlermeldung. |
status_code |
int
|
Der mit dem Fehler verbundene HTTP-Statuscode, falls verfügbar. |
Quellcode in hub_sdk/base/api_client.py
__init__(message, status_code=None)
Initialisiere die APIClientError-Instanz.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
message |
str
|
Eine für Menschen lesbare Fehlermeldung. |
erforderlich |
status_code |
int
|
Der mit dem Fehler verbundene HTTP-Statuscode, falls verfügbar. |
None
|
Quellcode in hub_sdk/base/api_client.py
hub_sdk.base.api_client.APIClient
Stellt einen API-Client dar, der Anfragen an eine bestimmte Basis-URL stellt.
Attribute:
Name | Typ | Beschreibung |
---|---|---|
base_url |
str
|
Die Basis-URL für die API. |
headers |
(dict, None)
|
Kopfzeilen, die in jeder Anfrage enthalten sein müssen. |
logger |
Logger
|
Eine Instanz des Loggers für Protokollierungszwecke. |
Quellcode in 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)
Initialisiere eine Instanz der APIClient-Klasse.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
base_url |
str
|
Die Basis-URL für die API. |
erforderlich |
headers |
dict
|
Kopfzeilen, die in jeder Anfrage enthalten sein müssen. |
None
|
Quellcode in hub_sdk/base/api_client.py
delete(endpoint, params=None)
Stelle eine DELETE-Anfrage an die API.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
endpoint |
str
|
Der Endpunkt, der an die Basis-URL für die Anfrage angehängt wird. |
erforderlich |
params |
dict
|
Parameter, die in der Anfrage enthalten sein müssen. |
None
|
Retouren:
Typ | Beschreibung |
---|---|
Optional[Response]
|
Das Antwortobjekt der HTTP-DELETE-Anfrage oder Keine, wenn sie fehlschlägt. |
Quellcode in hub_sdk/base/api_client.py
get(endpoint, params=None)
Stelle eine GET-Anfrage an die API.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
endpoint |
str
|
Der Endpunkt, der an die Basis-URL für die Anfrage angehängt wird. |
erforderlich |
params |
dict
|
Abfrageparameter für die Anfrage. |
None
|
Retouren:
Typ | Beschreibung |
---|---|
Optional[Response]
|
Das Antwortobjekt der HTTP-GET-Anfrage, keine, wenn sie fehlschlägt. |
Quellcode in hub_sdk/base/api_client.py
patch(endpoint, data=None, json=None)
Stelle eine PATCH-Anfrage an die API.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
endpoint |
str
|
Der Endpunkt, der an die Basis-URL für die Anfrage angehängt wird. |
erforderlich |
data |
dict
|
Daten, die im Body der Anfrage gesendet werden. |
None
|
json |
dict
|
JSON-Daten, die im Body der Anfrage gesendet werden sollen. |
None
|
Retouren:
Typ | Beschreibung |
---|---|
Optional[Response]
|
Das Antwortobjekt der HTTP PATCH-Anfrage oder Keine, wenn sie fehlschlägt. |
Quellcode in hub_sdk/base/api_client.py
post(endpoint, data=None, json=None, files=None, stream=False)
Stelle eine POST-Anfrage an die API.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
endpoint |
str
|
Der Endpunkt, der an die Basis-URL für die Anfrage angehängt wird. |
erforderlich |
data |
dict
|
Daten, die im Body der Anfrage gesendet werden. |
None
|
json |
dict
|
JSON-Daten, die im Body der Anfrage gesendet werden sollen. |
None
|
files |
dict
|
Dateien, die dem Antrag beigefügt werden sollen, falls vorhanden. |
None
|
stream |
bool
|
Wenn True, wird der Inhalt der Antwort gestreamt. |
False
|
Retouren:
Typ | Beschreibung |
---|---|
Optional[Response]
|
Das Antwortobjekt der HTTP-POST-Anfrage. |
Quellcode in hub_sdk/base/api_client.py
put(endpoint, data=None, json=None)
Stelle eine PUT-Anfrage an die API.
Parameter:
Name | Typ | Beschreibung | Standard |
---|---|---|---|
endpoint |
str
|
Der Endpunkt, der an die Basis-URL für die Anfrage angehängt wird. |
erforderlich |
data |
Optional[Dict]
|
Daten, die im Body der Anfrage gesendet werden. |
None
|
json |
Optional[Dict]
|
JSON-Daten, die im Body der Anfrage gesendet werden |
None
|
Retouren:
Typ | Beschreibung |
---|---|
Optional[Response]
|
Das Antwortobjekt der HTTP PUT-Anfrage. |