Files - Import

Referentie

Service:: Azure AI Services

API Version:: 2024-02-01

Hiermee maakt u een nieuwe bestandsentiteit door gegevens te importeren vanuit een opgegeven URL. Geüploade bestanden kunnen bijvoorbeeld worden gebruikt voor het trainen of evalueren van nauwkeurig afgestemde modellen.

POST {endpoint}/openai/files/import?api-version=2024-02-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string url	Ondersteunde Cognitive Services-eindpunten (protocol- en hostnaam, bijvoorbeeld: https://aoairesource.openai.azure.com. Vervang 'aoairesource' door de naam van uw Azure OpenAI-account).
api-version	query	True	string	De aangevraagde API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
api-key	True	string	Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Aanvraagbody

Name	Vereist	Type	Description
content_url	True	string	De URL waaruit het document moet worden gedownload (dit kan de SAS-URL van een blob zijn of een andere externe URL die toegankelijk is met een GET-aanvraag).
filename	True	string	De naam van het JSON Lines-bestand dat moet worden geüpload. Als de `purpose` is ingesteld op 'fine-tune', is elke regel een JSON-record met de velden 'prompt' en 'completion' die uw trainingsvoorbeelden vertegenwoordigen.
purpose	True	Purpose	Doel Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hiermee kunnen we de indeling van het geüploade bestand valideren.

Antwoorden

Name	Type	Description
201 Created	File	Het bestand is gemaakt. Headers Location: string
Other Status Codes	ErrorResponse	Er is een fout opgetreden.

Name

Type

Description

201 Created

File

Het bestand is gemaakt.

Headers

Location: string

Other Status Codes

ErrorResponse

Er is een fout opgetreden.

Beveiliging

api-key

Geef hier uw Azure OpenAI-accountsleutel voor Cognitive Services op.

Type: apiKey
In: header

Voorbeelden

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"
}

Definities

Name	Description
Error	Fout
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	File
FileImport	Bestandimport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Doel
TypeDiscriminator	TypeDiscriminator

Error

Fout

Name	Type	Description
code	ErrorCode	ErrorCode Foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	De foutdetails, indien beschikbaar.
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Het bericht van deze fout.
target	string	De locatie waar de fout is opgetreden, indien beschikbaar.

ErrorCode

Name	Type	Description
conflict	string	De aangevraagde bewerking conflicteert met de huidige resourcestatus.
contentFilter	string	Het genereren van installatiekopieën is mislukt als gevolg van ons veiligheidssysteem.
fileImportFailed	string	Het importeren van het bestand is mislukt.
forbidden	string	De bewerking is verboden voor de huidige gebruiker/API-sleutel.
internalFailure	string	Interne fout. Probeer het opnieuw.
invalidPayload	string	De aanvraaggegevens zijn ongeldig voor deze bewerking.
itemDoesAlreadyExist	string	Het item bestaat al.
jsonlValidationFailed	string	Validatie van jsonl-gegevens is mislukt.
notFound	string	De resource is niet gevonden.
quotaExceeded	string	Het quotum is overschreden.
serviceUnavailable	string	De service is momenteel niet beschikbaar.
tooManyRequests	string	Te veel aanvragen. Probeer het later opnieuw.
unauthorized	string	De huidige gebruiker/API-sleutel is niet geautoriseerd voor de bewerking.
unexpectedEntityState	string	De bewerking kan niet worden uitgevoerd in de status van de huidige resource.

ErrorResponse

Name	Type	Description
error	Error	Fout Foutinhoud zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Name	Type	Description
bytes	integer	De grootte van dit bestand indien beschikbaar (kan null zijn). Bestandsgrootten groter dan 2^53-1 worden niet ondersteund om compatibiliteit met gehele JavaScript-getallen te garanderen.
created_at	integer	Een tijdstempel wanneer deze taak of dit item is gemaakt (in unix-epochs).
filename	string	De naam van het bestand.
id	string	De identiteit van dit item.
object	TypeDiscriminator	TypeDiscriminator Definieert het type van een object.
purpose	Purpose	Doel Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hiermee kunnen we de indeling van het geüploade bestand valideren.
status	FileState	FileState De status van een bestand.
status_details	string	Het foutbericht met details voor het geval de verwerking van dit bestand is mislukt.

FileImport

Bestandimport

Name	Type	Description
content_url	string	De URL waaruit het document moet worden gedownload (dit kan de SAS-URL van een blob zijn of een andere externe URL die toegankelijk is met een GET-aanvraag).
filename	string	De naam van het JSON Lines-bestand dat moet worden geüpload. Als de `purpose` is ingesteld op 'fine-tune', is elke regel een JSON-record met de velden 'prompt' en 'completion' die uw trainingsvoorbeelden vertegenwoordigen.
purpose	Purpose	Doel Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hiermee kunnen we de indeling van het geüploade bestand valideren.

FileState

Name	Type	Description
deleted	string	De entiteit is verwijderd, maar kan nog steeds worden verwezen door andere entiteiten die dateren van vóór de verwijdering. Het kan worden gecategoriseerd als een terminale status.
deleting	string	De entiteit is ni het proces dat moet worden verwijderd. Deze status wordt niet geretourneerd door Azure OpenAI en wordt alleen beschikbaar gesteld voor compatibiliteit. Het kan worden gecategoriseerd als een actieve status.
error	string	De bewerking is voltooid met een fout en kan niet verder worden gebruikt. Het kan worden gecategoriseerd als een terminale status.
pending	string	De bewerking is gemaakt en wordt niet in de wachtrij geplaatst om in de toekomst te worden verwerkt. Het kan worden gecategoriseerd als een inactieve status.
processed	string	De bewerking is verwerkt en is gereed voor gebruik. Het kan worden gecategoriseerd als een terminale status.
running	string	De bewerking is gestart. Het kan worden gecategoriseerd als een actieve status.
uploaded	string	Het bestand is geüpload, maar is nog niet verwerkt. Deze status wordt niet geretourneerd door Azure OpenAI en wordt alleen beschikbaar gesteld voor compatibiliteit. Het kan worden gecategoriseerd als een inactieve status.

InnerError

Name	Type	Description
code	InnerErrorCode	InnerErrorCode Interne foutcodes zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Interne fout zoals gedefinieerd in de Microsoft REST-richtlijnen (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Name	Type	Description
invalidPayload	string	De aanvraaggegevens zijn ongeldig voor deze bewerking.

Purpose

Doel

Name	Type	Description
fine-tune	string	Dit bestand bevat trainingsgegevens voor een taak voor het afstemmen.
fine-tune-results	string	Dit bestand bevat de resultaten van een taak voor het afstemmen.

TypeDiscriminator

Name	Type	Description
file	string	Dit object vertegenwoordigt een bestand.
fine-tune	string	Dit object vertegenwoordigt een taak om af te stemmen.
fine-tune-event	string	Dit object vertegenwoordigt een gebeurtenis van een taak voor het afstemmen.
fine_tuning.job	string	Dit object vertegenwoordigt een taak om af te stemmen.
fine_tuning.job.event	string	Dit object vertegenwoordigt een gebeurtenis van een taak voor het afstemmen.
list	string	Dit object vertegenwoordigt een lijst met andere objecten.
model	string	Dit object vertegenwoordigt een model (kan een basismodel zijn of taakresultaat nauwkeurig afstemmen).

Share via

Files - Import

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

api-key

Voorbeelden

Importing a file with a blob url as source.

Sample Request

Sample Response

Definities

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Aanvullende resources