Files - Import

Referentie

Service:: Azure AI Services

API-versie:: 2024-10-21

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

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

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 van waaruit u het document wilt downloaden (kan een SAS-URL van een blob of een andere externe URL zijn 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 Voltooiing die uw trainingsvoorbeelden vertegenwoordigen.

Antwoorden

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

Name

Type

Description

201 Created

File

Het bestand is gemaakt.

Kopteksten

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.

Voorbeeldaanvraag

HTTP

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


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

Voorbeeldrespons

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

Definities

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

Error

Fout

Name	Type	Description
code	ErrorCode	Foutcode 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

Foutcode

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	Importeren van 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 sleutel van de gebruiker/API 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

Bestand

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 JavaScript-gehele getallen te garanderen.
created_at	integer	Een tijdstempel waarin 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 Hiermee definieert u het type van een object.
purpose	Purpose	Doel Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hierdoor 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

Name	Type	Description
content_url	string	De URL van waaruit u het document wilt downloaden (kan een SAS-URL van een blob of een andere externe URL zijn 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 Voltooiing die uw trainingsvoorbeelden vertegenwoordigen.
purpose	Purpose	Doel Het beoogde doel van de geüploade documenten. Gebruik 'fine-tune' om af te stemmen. Hierdoor 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 de verwijdering voorafgaan. Deze kan worden gecategoriseerd als een terminalstatus.
deleting	string	De entiteit is ni het proces dat moet worden verwijderd. Deze status wordt niet geretourneerd door Azure OpenAI en wordt alleen beschikbaar gemaakt voor compatibiliteit. Deze kan worden gecategoriseerd als een actieve status.
error	string	De bewerking is voltooid met een fout en kan niet verder worden verbruikt. Deze kan worden gecategoriseerd als een terminalstatus.
pending	string	De bewerking is gemaakt en wordt niet in de wachtrij geplaatst om in de toekomst te worden verwerkt. Deze kan worden gecategoriseerd als een inactieve status.
processed	string	De bewerking is verwerkt en is gereed voor gebruik. Deze kan worden gecategoriseerd als een terminalstatus.
running	string	De bewerking is gestart. Deze 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 gemaakt voor compatibiliteit. Deze 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
assistants	string	Dit bestand bevat gegevens die moeten worden gebruikt in assistenten.
assistants_output	string	Dit bestand bevat de resultaten van een assistent.
batch	string	Dit bestand bevat de invoergegevens voor een batch.
batch_output	string	Dit bestand bevat de resultaten van een batch.
fine-tune	string	Dit bestand bevat trainingsgegevens voor een taak voor het verfijnen van de taak.
fine-tune-results	string	Dit bestand bevat de resultaten van een taak voor het afstemmen.

TypeDiscriminator

Name	Type	Description
batch	string	Dit object vertegenwoordigt een batch.
file	string	Dit object vertegenwoordigt een bestand.
fine_tuning.job	string	Dit object vertegenwoordigt een taak voor het afstemmen.
fine_tuning.job.checkpoint	string	Dit object vertegenwoordigt een controlepunt van een taak voor het afstemmen.
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 verfijnen).
upload	string	Dit object vertegenwoordigt een bestand uploaden.
upload.part	string	Dit object vertegenwoordigt een deel van een bestandsupload.

Delen via

Files - Import

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

api-key

Voorbeelden

Importing a file with a blob url as source.

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Aanvullende resources