Files - Import

Служба:: Azure AI Services

Версия API:: 2024-10-21

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

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

Параметры 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-адрес для скачивания документа (может быть URL-адрес SAS большого двоичного объекта или любого другого внешнего URL-адреса, доступного с помощью запроса GET).
filename	True	string minLength: 1	Имя отправленного файла строк JSON . Если для `purpose` задано значение "точной настройки", каждая строка представляет собой запись JSON с полями "запрос" и "завершение", представляющих примеры обучения.

Ответы

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

Имя

Тип

Описание

201 Created

File

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

Заголовки

Location: string

Other Status Codes

ErrorResponse

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

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

api-key

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

Тип: apiKey
В: header

Примеры

Importing a file with a blob url as source.

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

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

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

Код состояния:: 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	Код ошибки
ErrorResponse	ErrorResponse
File	Файл
FileImport	FileImport
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Цель
TypeDiscriminator	TypeDiscriminator

Error

Object

Ошибка

Имя	Тип	Описание
code	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 minLength: 1	Сообщение об этой ошибке.
target	string	Расположение, в котором произошла ошибка, если она доступна.

ErrorCode

Перечисление

Код ошибки

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

ErrorResponse

Object

ErrorResponse

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

File

Object

Файл

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

FileImport

Object

FileImport

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

FileState

Перечисление

FileState

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

InnerError

Object

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

Перечисление

InnerErrorCode

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

Purpose

Перечисление

Цель

Значение	Описание
fine-tune	Этот файл содержит данные обучения для точного задания настройки.
fine-tune-results	Этот файл содержит результаты точного задания настройки.
assistants	Этот файл содержит данные, которые будут использоваться в помощниках.
assistants_output	Этот файл содержит результаты помощника.
batch	Этот файл содержит входные данные для пакета.
batch_output	Этот файл содержит результаты пакета.

TypeDiscriminator

Перечисление

TypeDiscriminator

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

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

Files - Import

Параметры URI

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

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

Ответы

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

api-key

Примеры

Importing a file with a blob url as source.

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

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

Определения

Error

ErrorCode

ErrorResponse

File

FileImport

FileState

InnerError

InnerErrorCode

Purpose

TypeDiscriminator