Files - Upload
Crée une entité de fichier en chargeant des données à partir d’un ordinateur local. Les fichiers chargés peuvent, par exemple, être utilisés pour la formation ou l’évaluation de modèles affinés.
POST {endpoint}/openai/files?api-version=2024-02-15-preview
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
file
|
formData | True |
file |
Obtient ou définit le fichier à charger dans Azure OpenAI. |
purpose
|
formData | True |
Objectif prévu des documents chargés. Utilisez « affiner » pour affiner le réglage. Cela nous permet de valider le format du fichier chargé. |
|
endpoint
|
path | True |
string url |
Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://aoairesource.openai.azure.com. Remplacez « aoairesource » par le nom de votre compte Azure OpenAI). |
api-version
|
query | True |
string |
Version de l’API demandée. |
En-tête de la demande
Media Types: "multipart/form-data"
Nom | Obligatoire | Type | Description |
---|---|---|---|
api-key | True |
string |
Fournissez la clé de votre compte Azure OpenAI Cognitive Services ici. |
Réponses
Nom | Type | Description |
---|---|---|
201 Created |
Le fichier a été créé avec succès. En-têtes Location: string |
|
Other Status Codes |
Une erreur est survenue. |
Sécurité
api-key
Fournissez la clé de votre compte Azure OpenAI Cognitive Services ici.
Type:
apiKey
Dans:
header
Exemples
Upload a file.
Exemple de requête
POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-02-15-preview
Exemple de réponse
location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099
{
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"status": "notRunning",
"created_at": 1646126127,
"object": "file"
}
Définitions
Nom | Description |
---|---|
Error |
Erreur |
Error |
ErrorCode |
Error |
ErrorResponse |
File |
Fichier |
File |
FileState |
Inner |
InnerError |
Inner |
InnerErrorCode |
Purpose |
Objectif |
Type |
TypeDiscriminator |
Error
Erreur
Nom | Type | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Les détails de l’erreur s’ils sont disponibles. |
innererror |
InnerError |
|
message |
string |
Message de cette erreur. |
target |
string |
Emplacement où l’erreur s’est produite si disponible. |
ErrorCode
ErrorCode
Nom | Type | Description |
---|---|---|
conflict |
string |
L’opération demandée est en conflit avec l’état actuel de la ressource. |
contentFilter |
string |
La génération d’images a échoué en raison de notre système de sécurité. |
fileImportFailed |
string |
Échec de l’importation du fichier. |
forbidden |
string |
L’opération est interdite pour l’utilisateur/la clé API actuelle. |
internalFailure |
string |
Erreur interne. Veuillez réessayer. |
invalidPayload |
string |
Les données de requête ne sont pas valides pour cette opération. |
itemDoesAlreadyExist |
string |
L’élément existe déjà. |
jsonlValidationFailed |
string |
Échec de la validation des données jsonl. |
notFound |
string |
La ressource est introuvable. |
quotaExceeded |
string |
Quota dépassé. |
serviceUnavailable |
string |
Le service n’est actuellement pas disponible. |
tooManyRequests |
string |
Trop grand nombre de requêtes. Veuillez réessayer ultérieurement. |
unauthorized |
string |
L’utilisateur/clé api actuel n’est pas autorisé pour l’opération. |
unexpectedEntityState |
string |
L’opération ne peut pas être exécutée dans l’état de la ressource actuelle. |
ErrorResponse
ErrorResponse
Nom | Type | Description |
---|---|---|
error |
Erreur |
File
Fichier
Nom | Type | Description |
---|---|---|
bytes |
integer |
Taille de ce fichier lorsqu’il est disponible (peut être null). Les tailles de fichier supérieures à 2^53-1 ne sont pas prises en charge pour garantir la compatibilité avec les entiers JavaScript. |
created_at |
integer |
Horodatage lorsque ce travail ou cet élément a été créé (dans les époques Unix). |
filename |
string |
Nom du fichier. |
id |
string |
Identité de cet élément. |
object |
TypeDiscriminator |
|
purpose |
Objectif |
|
status |
FileState |
|
status_details |
string |
Message d’erreur contenant les détails en cas d’échec du traitement de ce fichier. |
FileState
FileState
Nom | Type | Description |
---|---|---|
deleted |
string |
L’entité a été supprimée, mais peut toujours être référencée par d’autres entités antérieures à la suppression. Il peut être classé comme état terminal. |
deleting |
string |
L’entité est ni le processus à supprimer. Cet état n’est pas retourné par Azure OpenAI et n’est exposé qu’à des fins de compatibilité. Il peut être classé en tant qu’état actif. |
error |
string |
L’opération a terminé le traitement avec un échec et ne peut pas être consommée davantage. Il peut être classé comme état terminal. |
pending |
string |
L’opération a été créée et n’est pas mise en file d’attente pour être traitée à l’avenir. Il peut être classé comme un état inactif. |
processed |
string |
L’opération a été traitée avec succès et est prête à être consommée. Il peut être classé comme état terminal. |
running |
string |
L’opération a commencé à être traitée. Il peut être classé en tant qu’état actif. |
uploaded |
string |
Le fichier a été chargé, mais il n’est pas encore traité. Cet état n’est pas retourné par Azure OpenAI et n’est exposé qu’à des fins de compatibilité. Il peut être classé comme un état inactif. |
InnerError
InnerError
Nom | Type | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Nom | Type | Description |
---|---|---|
invalidPayload |
string |
Les données de requête ne sont pas valides pour cette opération. |
Purpose
Objectif
Nom | Type | Description |
---|---|---|
assistants |
string |
Ce fichier contient des données à utiliser dans les assistants. |
assistants_output |
string |
Ce fichier contient les résultats d’un assistant. |
fine-tune |
string |
Ce fichier contient des données d’entraînement pour un travail d’optimisation. |
fine-tune-results |
string |
Ce fichier contient les résultats d’un travail d’optimisation. |
TypeDiscriminator
TypeDiscriminator
Nom | Type | Description |
---|---|---|
file |
string |
Cet objet représente un fichier. |
fine_tuning.job |
string |
Cet objet représente un travail d’optimisation. |
fine_tuning.job.event |
string |
Cet objet représente un événement d’un travail de réglage. |
list |
string |
Cet objet représente une liste d’autres objets. |
model |
string |
Cet objet représente un modèle (il peut s’agir d’un modèle de base ou d’un résultat de travail de réglage). |