Files - Delete File
Löschen Einer zuvor hochgeladenen Datei.
DELETE {endpoint}/files/{fileId}?api-version=v1
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
endpoint
|
path | True |
string (uri) |
Projektendpunkt in Form von: https://.services.ai.azure.com/api/projects/ |
file
|
path | True |
string |
Die ID der zu löschenden Datei. |
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Status des Löschvorgangs. |
|
Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiche
Name | Beschreibung |
---|---|
https://ai.azure.com/.default |
Beispiele
Files_Delete |
Files_Delete |
Files_DeleteFile_MaximumSet
Beispielanforderung
DELETE {endpoint}/files/tyaedopyezvvftrscawrfl?api-version=v1
Beispiel für eine Antwort
{
"id": "xpadlhlkrkdclxvs",
"deleted": true,
"object": "file"
}
Files_DeleteFile_MinimumSet
Beispielanforderung
DELETE {endpoint}/files/tvdttofovjkpnxbxprgwdvoqdldz?api-version=v1
Beispiel für eine Antwort
{
"id": "xpadlhlkrkdclxvs",
"deleted": true,
"object": "file"
}
Definitionen
Name | Beschreibung |
---|---|
Agent |
Beschreibt die Fehlerinformationen, die von der Agenten-API zurückgegeben werden. |
AgentV1Error |
Fehlernutzlast, die von der Agenten-API zurückgegeben wird. |
File |
Eine Statusantwort eines Dateilöschvorgangs. |
AgentErrorDetail
Beschreibt die Fehlerinformationen, die von der Agenten-API zurückgegeben werden.
Name | Typ | Beschreibung |
---|---|---|
code |
string |
Maschinenlesbarer Fehlercode. |
message |
string |
Für Menschen lesbare Beschreibung des Fehlers. |
param |
string |
Name des Parameters, der den Fehler verursacht hat, falls zutreffend. |
type |
string |
Kennung des Fehlertyps (z. B. |
AgentV1Error
Fehlernutzlast, die von der Agenten-API zurückgegeben wird.
Name | Typ | Beschreibung |
---|---|---|
error |
Stellt den Fehler dar. |
FileDeletionStatus
Eine Statusantwort eines Dateilöschvorgangs.
Name | Typ | Beschreibung |
---|---|---|
deleted |
boolean |
Ein Wert, der angibt, ob das Löschen erfolgreich war. |
id |
string |
Die ID der zum Löschen angegebenen Ressource. |
object |
enum:
file |
Der Objekttyp, der immer "Datei" ist. |