Files - Import

Ссылка

Service:: Azure AI Services

API Version:: 2024-02-01

Создает новую сущность файла путем импорта данных из предоставленного URL-адреса. Загруженные файлы можно, например, использовать для обучения или оценки точно настроенных моделей.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string url	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например: https://aoairesource.openai.azure.com. Замените aoairesource именем учетной записи Azure OpenAI.
api-version	query	True	string	Запрошенная версия API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
api-key	True	string	Укажите ключ учетной записи Azure OpenAI для Cognitive Services.

Текст запроса

Имя	Обязательно	Тип	Описание
content_url	True	string	URL-адрес для скачивания документа (может быть URL-адресОМ SAS большого двоичного объекта или любым другим внешним URL-адресом, доступным с помощью запроса GET).
filename	True	string	Имя передаваемого файла строк JSON . `purpose` Если задано значение "точная настройка", каждая строка представляет собой запись JSON с полями "prompt" и "completion", представляющими примеры обучения.
purpose	True	Purpose	Назначение Предусмотренная цель отправленных документов. Используйте "тонкая настройка" для точной настройки. Это позволяет проверить формат отправленного файла.

Ответы

Имя	Тип	Описание
201 Created	File	Файл успешно создан. Headers Location: string
Other Status Codes	ErrorResponse	Произошла ошибка.

Имя

Тип

Описание

201 Created

File

Файл успешно создан.

Headers

Location: string

Other Status Codes

ErrorResponse

Произошла ошибка.

Безопасность

api-key

Укажите ключ учетной записи Azure OpenAI для Cognitive Services.

Type: apiKey
In: header

Примеры

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

Определения

Имя	Описание
Error	Ошибка
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	File
FileImport	FileImport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Назначение
TypeDiscriminator	TypeDiscriminator

Error

Ошибка

Имя	Тип	Описание
code	ErrorCode	ErrorCode Коды ошибок, определенные в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Сведения об ошибке, если они доступны.
innererror	InnerError	InnerError Внутренняя ошибка, определенная в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Сообщение об этой ошибке.
target	string	Расположение, в котором произошла ошибка , если доступно.

ErrorCode

Имя	Тип	Описание
conflict	string	Запрошенная операция конфликтует с текущим состоянием ресурса.
contentFilter	string	Сбой создания образа из-за нашей системы безопасности.
fileImportFailed	string	Сбой импорта файла.
forbidden	string	Операция запрещена для текущего ключа пользователя или API.
internalFailure	string	Внутренняя ошибка. Повторите попытку.
invalidPayload	string	Данные запроса недопустимы для этой операции.
itemDoesAlreadyExist	string	Элемент уже существует.
jsonlValidationFailed	string	Сбой проверки данных jsonl.
notFound	string	Ресурс не найден.
quotaExceeded	string	Превышена квота.
serviceUnavailable	string	В настоящее время служба недоступна.
tooManyRequests	string	Слишком много запросов. Повторите попытку позже.
unauthorized	string	Текущий ключ пользователя или API не авторизован для операции.
unexpectedEntityState	string	Операция не может быть выполнена в состоянии текущего ресурса.

ErrorResponse

Имя	Тип	Описание
error	Error	Ошибка Содержимое ошибки, как определено в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

Имя	Тип	Описание
bytes	integer	Размер этого файла, если он доступен (может иметь значение NULL). Файлы размером больше 2^53–1 не поддерживаются для обеспечения совместимости с целыми числами JavaScript.
created_at	integer	Метка времени создания этого задания или элемента (в эпохах Unix).
filename	string	Имя файла.
id	string	Удостоверение этого элемента.
object	TypeDiscriminator	TypeDiscriminator Определяет тип объекта .
purpose	Purpose	Назначение Предусмотренная цель отправленных документов. Используйте "тонкая настройка" для точной настройки. Это позволяет проверить формат отправленного файла.
status	FileState	FileState Состояние файла.
status_details	string	Сообщение об ошибке с подробными сведениями на случай сбоя обработки этого файла.

FileImport

Имя	Тип	Описание
content_url	string	URL-адрес для скачивания документа (может быть URL-адресОМ SAS большого двоичного объекта или любым другим внешним URL-адресом, доступным с помощью запроса GET).
filename	string	Имя передаваемого файла строк JSON . `purpose` Если задано значение "точная настройка", каждая строка представляет собой запись JSON с полями "prompt" и "completion", представляющими примеры обучения.
purpose	Purpose	Назначение Предусмотренная цель отправленных документов. Используйте "тонкая настройка" для точной настройки. Это позволяет проверить формат отправленного файла.

FileState

Имя	Тип	Описание
deleted	string	Сущность удалена, но на нее могут ссылаться другие сущности, предшествующие удалению. Его можно классифицировать как конечное состояние.
deleting	string	Сущность является процессом, который требуется удалить. Azure OpenAI не возвращает это состояние и предоставляется только для обеспечения совместимости. Его можно классифицировать как активное состояние.
error	string	Операция завершила обработку с ошибкой и не может быть использована в дальнейшем. Его можно классифицировать как конечное состояние.
pending	string	Операция была создана и не помещается в очередь для обработки в будущем. Его можно классифицировать как неактивное состояние.
processed	string	Операция успешно обработана и готова к использованию. Его можно классифицировать как конечное состояние.
running	string	Операция запущена для обработки. Его можно классифицировать как активное состояние.
uploaded	string	Файл отправлен, но еще не обработан. Azure OpenAI не возвращает это состояние и предоставляется только для обеспечения совместимости. Его можно классифицировать как неактивное состояние.

InnerError

Имя	Тип	Описание
code	InnerErrorCode	InnerErrorCode Внутренние коды ошибок, определенные в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Внутренняя ошибка, определенная в рекомендациях Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

Имя	Тип	Описание
invalidPayload	string	Данные запроса недопустимы для этой операции.

Purpose

Назначение

Имя	Тип	Описание
fine-tune	string	Этот файл содержит обучающие данные для задания точной настройки.
fine-tune-results	string	Этот файл содержит результаты задания точной настройки.

TypeDiscriminator

Имя	Тип	Описание
file	string	Этот объект представляет файл.
fine-tune	string	Этот объект представляет задание точной настройки.
fine-tune-event	string	Этот объект представляет событие задания точной настройки.
fine_tuning.job	string	Этот объект представляет задание точной настройки.
fine_tuning.job.event	string	Этот объект представляет событие задания тонкой настройки.
list	string	Этот объект представляет список других объектов.
model	string	Этот объект представляет модель (может быть базовой моделью или результатом точной настройки задания).

Files - Import

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

api-key

Примеры

Importing a file with a blob url as source.

Sample Request

Sample Response

Определения

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

Дополнительные ресурсы