Files - Upload

Ссылка

Служба:: Azure AI Services

Версия API:: 2024-05-01-preview

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

POST {endpoint}/openai/files?api-version=2024-05-01-preview

Параметры URI

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

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

Media Types: "multipart/form-data"

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

Ответы

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

Имя

Тип

Описание

201 Created

File

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

Заголовки

Location: string

Other Status Codes

ErrorResponse

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

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

api-key

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

Тип: apiKey
В: header

Примеры

Upload a file.

Образец запроса

HTTP

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

Пример ответа

Код состояния:: 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"
}

Определения

Имя	Описание
Error	Ошибка
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	File
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	Сообщение об ошибке с подробными сведениями на случай сбоя обработки этого файла.

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

Назначение

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

TypeDiscriminator

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

Поделиться через

Files - Upload

Параметры URI

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

Ответы

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

api-key

Примеры

Upload a file.

Образец запроса

Пример ответа

Определения

Error

ErrorCode

ErrorResponse

File

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator

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