Files - Import

Référence

Service:: Azure AI Services

API Version:: 2024-02-01

Crée une entité de fichier en important des données à partir d’une URL fournie. 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/import?api-version=2024-02-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
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

Nom	Obligatoire	Type	Description
api-key	True	string	Fournissez la clé de votre compte Azure OpenAI Cognitive Services ici.

Corps de la demande

Nom	Obligatoire	Type	Description
content_url	True	string	URL à partir de laquelle télécharger le document (peut être l’URL SAS d’un objet blob ou toute autre URL externe accessible avec une requête GET).
filename	True	string	Nom du fichier de lignes JSON à charger. Si le `purpose` est défini sur « affiner », chaque ligne est un enregistrement JSON avec les champs « prompt » et « completion » représentant vos exemples d’entraînement.
purpose	True	Purpose	Objectif Objectif prévu des documents chargés. Utilisez « affiner » pour affiner le réglage. Cela nous permet de valider le format du fichier chargé.

Réponses

Nom	Type	Description
201 Created	File	Le fichier a été créé avec succès. Headers Location: string
Other Status Codes	ErrorResponse	Une erreur est survenue.

Nom

Type

Description

201 Created

File

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

Headers

Location: string

Other Status Codes

ErrorResponse

Une erreur est survenue.

Sécurité

api-key

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

Type: apiKey
In: header

Exemples

Importing a file with a blob url as source.

Sample Request

HTTP

POST https://aoairesource.openai.azure.com/openai/files/import?api-version=2024-02-01


{
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl"
}

Sample Response

Status code:: 201

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

Response Body

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

Définitions

Nom	Description
Error	Erreur
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	Fichier
FileImport	FileImport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Objectif
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[]	Les détails de l’erreur s’ils sont disponibles.
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 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

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

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	TypeDiscriminator Définit le type d’un objet.
purpose	Purpose	Objectif 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 contenant les détails en cas d’échec du traitement de ce fichier.

FileImport

Nom	Type	Description
content_url	string	URL à partir de laquelle télécharger le document (peut être l’URL SAS d’un objet blob ou toute autre URL externe accessible avec une requête GET).
filename	string	Nom du fichier de lignes JSON à charger. Si le `purpose` est défini sur « affiner », chaque ligne est un enregistrement JSON avec les champs « prompt » et « completion » représentant vos exemples d’entraînement.
purpose	Purpose	Objectif Objectif prévu des documents chargés. Utilisez « affiner » pour affiner le réglage. Cela nous permet de valider le format du fichier chargé.

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

Nom	Type	Description
code	InnerErrorCode	InnerErrorCode Codes d’erreur internes tels que définis dans les instructions REST Microsoft (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

Objectif

Nom	Type	Description
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

Nom	Type	Description
file	string	Cet objet représente un fichier.
fine-tune	string	Cet objet représente un travail d’optimisation.
fine-tune-event	string	Cet objet représente un événement d’un travail de réglage.
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).

Files - Import

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

api-key

Exemples

Importing a file with a blob url as source.

Sample Request

Sample Response

Définitions

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Ressources supplémentaires