Files - Upload

Référence

Service:: Azure AI Services

Version d'API:: 2024-10-21

Crée une entité de fichier en chargeant des données à partir d’une machine locale. Les fichiers chargés peuvent, par exemple, être utilisés pour l’entraînement ou l’évaluation des modèles affinés.

POST {endpoint}/openai/files?api-version=2024-10-21

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	Purpose	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 votre clé de compte Azure OpenAI Cognitive Services ici.

Réponses

Nom	Type	Description
201 Created	File	Le fichier a été créé avec succès. En-têtes Location: string
Other Status Codes	ErrorResponse	Une erreur s’est produite.

Nom

Type

Description

201 Created

File

Le fichier a été créé avec succès.

En-têtes

Location: string

Other Status Codes

ErrorResponse

Une erreur s’est produite.

Sécurité

api-key

Fournissez votre clé de compte Azure OpenAI Cognitive Services ici.

Type: apiKey
Dans: header

Exemples

Upload a file.

Exemple de requête

HTTP

POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-10-21

Exemple de réponse

Code d’état:: 201

location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099

{
  "status": "pending",
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "created_at": 1646126127,
  "object": "file"
}

Définitions

Nom	Description
Error	Erreur
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	Lime
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	But
TypeDiscriminator	TypeDiscriminator

Error

Erreur

Nom	Type	Description
code	ErrorCode	ErrorCode Codes d’erreur tels que définis dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Détails de l’erreur s’il est disponible.
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Message de cette erreur.
target	string	Emplacement où l’erreur s’est produite si disponible.

ErrorCode

Nom	Type	Description
conflict	string	L’opération demandée est en conflit avec l’état de ressource actuel.
contentFilter	string	La génération d’images a échoué suite à notre système de sécurité.
fileImportFailed	string	Échec de l’importation du fichier.
forbidden	string	L’opération est interdite pour la clé utilisateur/API actuelle.
internalFailure	string	Erreur interne. Réessayez.
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 de demandes. Réessayez ultérieurement.
unauthorized	string	La clé utilisateur/API actuelle n’est pas autorisée pour l’opération.
unexpectedEntityState	string	L’opération ne peut pas être exécutée dans l’état de la ressource actuelle.

ErrorResponse

Nom	Type	Description
error	Error	Erreur Contenu d’erreur tel que défini dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Lime

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 lors de la création de ce travail ou de cet élément (dans les époques unix).
filename	string	Nom du fichier.
id	string	Identité de cet élément.
object	TypeDiscriminator	TypeDiscriminator Définit le type d’un objet.
purpose	Purpose	But Objectif prévu des documents chargés. Utilisez « affiner » pour affiner le réglage. Cela nous permet de valider le format du fichier chargé.
status	FileState	FileState État d’un fichier.
status_details	string	Message d’erreur avec des détails dans le cas où le traitement de ce fichier a échoué.

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 avant 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é comme état actif.
error	string	L’opération a terminé le traitement avec un échec et ne peut pas être consommée. 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 ultérieurement. 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é comme é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

Nom	Type	Description
code	InnerErrorCode	InnerErrorCode Codes d’erreur internes tels que définis dans les instructions MICROSOFT REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Erreur interne telle que définie dans les instructions REST Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nom	Type	Description
invalidPayload	string	Les données de requête ne sont pas valides pour cette opération.

Purpose

But

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.
batch	string	Ce fichier contient les données d’entrée d’un lot.
batch_output	string	Ce fichier contient les résultats d’un lot.
fine-tune	string	Ce fichier contient des données d’apprentissage pour un travail d’optimisation.
fine-tune-results	string	Ce fichier contient les résultats d’un travail d’optimisation.

TypeDiscriminator

Nom	Type	Description
batch	string	Cet objet représente un lot.
file	string	Cet objet représente un fichier.
fine_tuning.job	string	Cet objet représente un travail d’optimisation.
fine_tuning.job.checkpoint	string	Cet objet représente un point de contrôle d’un travail de réglage précis.
fine_tuning.job.event	string	Cet objet représente un événement d’un travail de réglage précis.
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 affiné).
upload	string	Cet objet représente un chargement de fichier.
upload.part	string	Cet objet représente une partie d’un chargement de fichier.

Partager via

Files - Upload

Paramètres URI

En-tête de la demande

Réponses

Sécurité

api-key

Exemples

Upload a file.

Exemple de requête

Exemple de réponse

Définitions

Error

ErrorCode

ErrorResponse

File

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Ressources supplémentaires