Files - Import

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-10-21

Tworzy nową jednostkę pliku, importując dane z podanego adresu URL. Przekazane pliki mogą na przykład służyć do trenowania lub oceniania dostrajanych modeli.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string url	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://aoairesource.openai.azure.com. Zastąp ciąg "aoairesource" nazwą konta usługi Azure OpenAI.
api-version	query	True	string	Żądana wersja interfejsu API.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
api-key	True	string	Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Treść żądania

Nazwa	Wymagane	Typ	Opis
content_url	True	string	Adres URL do pobrania dokumentu z witryny (może to być adres URL sygnatury dostępu współdzielonego obiektu blob lub dowolny inny zewnętrzny adres URL dostępny za pomocą żądania GET).
filename	True	string	Nazwa pliku JSON Lines, który ma zostać przekazany. Jeśli `purpose` jest ustawiona na "dostrojenie", każdy wiersz jest rekordem JSON z polami "prompt" i "completion" reprezentującymi przykłady trenowania.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	File	Plik został pomyślnie utworzony. Nagłówki Location: string
Other Status Codes	ErrorResponse	Wystąpił błąd.

Nazwa

Typ

Opis

201 Created

File

Plik został pomyślnie utworzony.

Nagłówki

Location: string

Other Status Codes

ErrorResponse

Wystąpił błąd.

Zabezpieczenia

api-key

Tutaj podaj klucz konta usługi Azure OpenAI w usługach Cognitive Services.

Typ: apiKey
W: header

Przykłady

Importing a file with a blob url as source.

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
}

Definicje

Nazwa	Opis
Error	Błąd
ErrorCode	Kod błędu
ErrorResponse	ErrorResponse
File	Plik
FileImport	PlikImportuj
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Cel
TypeDiscriminator	TypeDiscriminator

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu Kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Szczegóły błędu, jeśli są dostępne.
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Komunikat o tym błędzie.
target	string	Lokalizacja, w której wystąpił błąd, jeśli jest dostępny.

ErrorCode

Kod błędu

Nazwa	Typ	Opis
conflict	string	Żądana operacja powoduje konflikt z bieżącym stanem zasobu.
contentFilter	string	Generowanie obrazu nie powiodło się w wyniku naszego systemu bezpieczeństwa.
fileImportFailed	string	Importowanie pliku nie powiodło się.
forbidden	string	Operacja jest zabroniona dla bieżącego klucza użytkownika/interfejsu API.
internalFailure	string	Błąd wewnętrzny. Ponów próbę.
invalidPayload	string	Dane żądania są nieprawidłowe dla tej operacji.
itemDoesAlreadyExist	string	Element już istnieje.
jsonlValidationFailed	string	Sprawdzanie poprawności danych jsonl nie powiodło się.
notFound	string	Nie można odnaleźć zasobu.
quotaExceeded	string	Przekroczono limit przydziału.
serviceUnavailable	string	Usługa jest obecnie niedostępna.
tooManyRequests	string	Zbyt wiele żądań. Spróbuj ponownie później.
unauthorized	string	Bieżący klucz użytkownika/interfejsu API nie jest autoryzowany dla operacji.
unexpectedEntityState	string	Nie można wykonać operacji w stanie bieżącego zasobu.

ErrorResponse

Nazwa	Typ	Opis
error	Error	Błąd Zawartość błędu zdefiniowana w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Plik

Nazwa	Typ	Opis
bytes	integer	Rozmiar tego pliku, jeśli jest dostępny (może mieć wartość null). Rozmiary plików większe niż 2^53–1 nie są obsługiwane w celu zapewnienia zgodności z liczbami całkowitymi języka JavaScript.
created_at	integer	Sygnatura czasowa utworzenia tego zadania lub elementu (w epokach unix).
filename	string	Nazwa pliku.
id	string	Tożsamość tego elementu.
object	TypeDiscriminator	TypeDiscriminator Definiuje typ obiektu.
purpose	Purpose	Cel Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku.
status	FileState	FileState Stan pliku.
status_details	string	Komunikat o błędzie ze szczegółami w przypadku niepowodzenia przetwarzania tego pliku.

FileImport

PlikImportuj

Nazwa	Typ	Opis
content_url	string	Adres URL do pobrania dokumentu z witryny (może to być adres URL sygnatury dostępu współdzielonego obiektu blob lub dowolny inny zewnętrzny adres URL dostępny za pomocą żądania GET).
filename	string	Nazwa pliku JSON Lines, który ma zostać przekazany. Jeśli `purpose` jest ustawiona na "dostrojenie", każdy wiersz jest rekordem JSON z polami "prompt" i "completion" reprezentującymi przykłady trenowania.
purpose	Purpose	Cel Przeznaczenie przekazanych dokumentów. Użyj polecenia "fine-tune" w celu dostrajania. Dzięki temu możemy zweryfikować format przekazanego pliku.

FileState

Nazwa	Typ	Opis
deleted	string	Jednostka została usunięta, ale nadal może być przywoływała inne jednostki poprzedzające usunięcie. Można go podzielić na stan terminalu.
deleting	string	Jednostka jest ni proces, który ma zostać usunięty. Ten stan nie jest zwracany przez usługę Azure OpenAI i uwidaczniany tylko pod kątem zgodności. Można go sklasyfikować jako aktywny stan.
error	string	Operacja zakończyła przetwarzanie z powodu błędu i nie może być jeszcze bardziej zużywana. Można go podzielić na stan terminalu.
pending	string	Operacja została utworzona i nie zostanie utworzona w kolejce do przetworzenia w przyszłości. Można go sklasyfikować jako stan nieaktywny.
processed	string	Operacja została pomyślnie przetworzona i jest gotowa do użycia. Można go podzielić na stan terminalu.
running	string	Operacja została rozpoczęta do przetworzenia. Można go sklasyfikować jako aktywny stan.
uploaded	string	Plik został przekazany, ale nie został jeszcze przetworzony. Ten stan nie jest zwracany przez usługę Azure OpenAI i uwidaczniany tylko pod kątem zgodności. Można go sklasyfikować jako stan nieaktywny.

InnerError

Nazwa	Typ	Opis
code	InnerErrorCode	InnerErrorCode Wewnętrzne kody błędów zdefiniowane w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Błąd wewnętrzny zdefiniowany w wytycznych REST firmy Microsoft (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Nazwa	Typ	Opis
invalidPayload	string	Dane żądania są nieprawidłowe dla tej operacji.

Purpose

Cel

Nazwa	Typ	Opis
assistants	string	Ten plik zawiera dane do użycia w asystentach.
assistants_output	string	Ten plik zawiera wyniki asystenta.
batch	string	Ten plik zawiera dane wejściowe dla partii.
batch_output	string	Ten plik zawiera wyniki partii.
fine-tune	string	Ten plik zawiera dane szkoleniowe dla zadania dostrajania.
fine-tune-results	string	Ten plik zawiera wyniki zadania dostrajania.

TypeDiscriminator

Nazwa	Typ	Opis
batch	string	Ten obiekt reprezentuje partię.
file	string	Ten obiekt reprezentuje plik.
fine_tuning.job	string	Ten obiekt reprezentuje zadanie dostrajania.
fine_tuning.job.checkpoint	string	Ten obiekt reprezentuje punkt kontrolny zadania dostrajania.
fine_tuning.job.event	string	Ten obiekt reprezentuje zdarzenie zadania dostrajania.
list	string	Ten obiekt reprezentuje listę innych obiektów.
model	string	Ten obiekt reprezentuje model (może być modelem bazowym lub dostrajać wynik zadania).
upload	string	Ten obiekt reprezentuje przekazywanie pliku.
upload.part	string	Ten obiekt reprezentuje część przekazywania plików.

Udostępnij za pośrednictwem

Files - Import

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

api-key

Przykłady

Importing a file with a blob url as source.

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Dodatkowe zasoby