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

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-адрес SAS большого двоичного объекта или любого другого внешнего URL-адреса, доступного с помощью запроса GET).
filename True

string

Имя отправленного файла строк JSON . Если для purpose задано значение "точной настройки", каждая строка представляет собой запись JSON с полями "запрос" и "завершение", представляющих примеры обучения.

Ответы

Имя Тип Описание
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.

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

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

Ошибка

Имя Тип Описание
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

Сообщение об этой ошибке.
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

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

FileImport

Имя Тип Описание
content_url

string

URL-адрес для скачивания документа (может быть URL-адрес SAS большого двоичного объекта или любого другого внешнего URL-адреса, доступного с помощью запроса GET).
filename

string

Имя отправленного файла строк JSON . Если для purpose задано значение "точной настройки", каждая строка представляет собой запись JSON с полями "запрос" и "завершение", представляющих примеры обучения.
purpose

Purpose

Цель
Предназначение отправленных документов. Используйте "точной настройки" для точной настройки. Это позволяет проверить формат отправленного файла.

FileState

FileState

Имя Тип Описание
deleted

string

Сущность была удалена, но может по-прежнему ссылаться на другие сущности, предшествующие удалению. Его можно классифицировать как состояние терминала.
deleting

string

Сущность является ni процессом удаления. Это состояние не возвращается Azure OpenAI и предоставляется только для обеспечения совместимости. Его можно классифицировать как активное состояние.
error

string

Операция завершила обработку с ошибкой и не может быть дополнительно занята. Его можно классифицировать как состояние терминала.
pending

string

Операция была создана и не помещается в очередь для обработки в будущем. Его можно классифицировать как неактивное состояние.
processed

string

Операция успешно обработана и готова к использованию. Его можно классифицировать как состояние терминала.
running

string

Операция начала обрабатываться. Его можно классифицировать как активное состояние.
uploaded

string

Файл был отправлен, но он еще не обработан. Это состояние не возвращается Azure OpenAI и предоставляется только для обеспечения совместимости. Его можно классифицировать как неактивное состояние.

InnerError

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

string

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

Purpose

Цель

Имя Тип Описание
assistants

string

Этот файл содержит данные, которые будут использоваться в помощниках.
assistants_output

string

Этот файл содержит результаты помощника.
batch

string

Этот файл содержит входные данные для пакета.
batch_output

string

Этот файл содержит результаты пакета.
fine-tune

string

Этот файл содержит данные обучения для точного задания настройки.
fine-tune-results

string

Этот файл содержит результаты точного задания настройки.

TypeDiscriminator

TypeDiscriminator

Имя Тип Описание
batch

string

Этот объект представляет пакет.
file

string

Этот объект представляет файл.
fine_tuning.job

string

Этот объект представляет точное задание настройки.
fine_tuning.job.checkpoint

string

Этот объект представляет контрольную точку задания тонкой настройки.
fine_tuning.job.event

string

Этот объект представляет событие задания тонкой настройки.
list

string

Этот объект представляет список других объектов.
model

string

Этот объект представляет модель (может быть базовой моделью или результатом точной настройки задания).
upload

string

Этот объект представляет отправку файла.
upload.part

string

Этот объект представляет часть отправки файла.