Azure OpenAI Files

Версия API: версия 1

Server:{endpoint}/openai/v1 — Azure AI Foundry API моделей

Переменные сервера:

Variable По умолчанию Description
endpoint Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).

Authentication

ApiKeyAuth (ключ API)

Передайте свой API в api-key заголовок.

ApiKeyAuth_ (Ключ API)

Передайте свой API в authorization заголовок.

OAuth2Auth (OAuth 2.0)

Поток: неявный

URL-адрес авторизации:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области:

  • https://cognitiveservices.azure.com/.default

Требования к безопасности

Конечные точки принимают любой из следующих методов аутентификации:

  1. ApiKeyAuth
  2. ApiKeyAuth_
  3. OAuth2Auth (прицелы: https://cognitiveservices.azure.com/.default)

Создать файл

POST {endpoint}/openai/v1/files

Параметры URI

Name In Обязательный Type Description
endpoint server Да строка Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).
версия API query Нет строка
Возможные значения: v1, preview		 Явная версия API Azure AI Foundry Models, используемая для этого запроса.
v1, если не указано иначе.

Тело запроса

Content-Type: многочастный формат данных

Name Type Description Обязательный По умолчанию
истекает через object Да
└─ Привязка AzureFileExpiryAnchor Да
└= секунды целое число (int32) Да
file Объект File (не имя файла) для отправки. Да
purpose enum Целевое назначение загружаемого файла. Одно из следующих: assistants: используется в API помощника - batch: используется в API пакетной обработки - fine-tune: используется для точной настройки - evals: используется для наборов данных оценки
Возможные значения: assistants, , batchfine-tuneevals		 Да

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
байт целое число Размер файла в байтах. Да
создано_в целое число (UnixTime) Метка времени Unix (в секундах) для момента создания файла. Да
срок_действия_до целое число (UnixTime) Метка времени Unix (в секундах) для истечения срока действия файла. Нет
filename строка Имя файла. Да
id строка Идентификатор файла, на который можно ссылаться в конечных точках API. Да
object enum Тип объекта, который всегда является file.
Возможные значения: file		 Да
purpose enum Предназначение файла. Поддерживаемые значения: assistants, , assistants_outputbatch, batch_outputfine-tuneи fine-tune-results.
Возможные значения: assistants, , , assistants_outputbatchbatch_outputfine-tunefine-tune-resultsevals		 Да
Статус enum
Возможные значения: uploaded, , , pendingrunningprocessederrordeletingdeleted		 Да
подробности_статуса string (не рекомендуется) Deprecated. Чтобы узнать, почему файл обучения для точной настройки не прошел проверку, см. в поле error на fine_tuning.job. Нет

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
code строка или null Да
внутренняя ошибка Нет
message строка Да
параметр строка или null Да
type строка Да

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Примеры

Пример

POST {endpoint}/openai/v1/files?api-version=v1

Перечень файлов

GET {endpoint}/openai/v1/files

Параметры URI

Name In Обязательный Type Description
endpoint server Да строка Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).
версия API query Нет строка
Возможные значения: v1, preview		 Явная версия API Azure AI Foundry Models, используемая для этого запроса.
v1, если не указано иначе.
purpose query Нет строка
Сериализация: взрыв: ложь
limit query Нет целое число
Сериализация: взрыв: ложь
order query Нет строка
Возможные значения: asc, desc
Сериализация: взрыв: ложь
После query Нет строка
Сериализация: взрыв: ложь

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого Type Description
application/json OpenAI.ListFilesResponse

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
code строка или null Да
внутренняя ошибка Нет
message строка Да
параметр строка или null Да
type строка Да

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Получение файла

GET {endpoint}/openai/v1/files/{file_id}

Параметры URI

Name In Обязательный Type Description
endpoint server Да строка Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).
версия API query Нет строка
Возможные значения: v1, preview		 Явная версия API Azure AI Foundry Models, используемая для этого запроса.
v1, если не указано иначе.
идентификатор_файла path Да строка Идентификатор файла, используемого для этого запроса.

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
байт целое число Размер файла в байтах. Да
создано_в целое число (UnixTime) Метка времени Unix (в секундах) для момента создания файла. Да
срок_действия_до целое число (UnixTime) Метка времени Unix (в секундах) для истечения срока действия файла. Нет
filename строка Имя файла. Да
id строка Идентификатор файла, на который можно ссылаться в конечных точках API. Да
object enum Тип объекта, который всегда является file.
Возможные значения: file		 Да
purpose enum Предназначение файла. Поддерживаемые значения: assistants, , assistants_outputbatch, batch_outputfine-tuneи fine-tune-results.
Возможные значения: assistants, , , assistants_outputbatchbatch_outputfine-tunefine-tune-resultsevals		 Да
Статус enum
Возможные значения: uploaded, , , pendingrunningprocessederrordeletingdeleted		 Да
подробности_статуса string (не рекомендуется) Deprecated. Чтобы узнать, почему файл обучения для точной настройки не прошел проверку, см. в поле error на fine_tuning.job. Нет

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
code строка или null Да
внутренняя ошибка Нет
message строка Да
параметр строка или null Да
type строка Да

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Удалить файл

DELETE {endpoint}/openai/v1/files/{file_id}

Параметры URI

Name In Обязательный Type Description
endpoint server Да строка Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).
версия API query Нет строка
Возможные значения: v1, preview		 Явная версия API Azure AI Foundry Models, используемая для этого запроса.
v1, если не указано иначе.
идентификатор_файла path Да строка Идентификатор файла, используемого для этого запроса.

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого Type Description
application/json OpenAI.DeleteFileResponse

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
code строка или null Да
внутренняя ошибка Нет
message строка Да
параметр строка или null Да
type строка Да

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Скачивание файла

GET {endpoint}/openai/v1/files/{file_id}/content

Параметры URI

Name In Обязательный Type Description
endpoint server Да строка Поддерживаемый Azure AI Foundry моделирует конечную точку API, включая протокол и имя хоста.
Рассмотрим пример.
https://westus.api.cognitive.microsoft.com).
версия API query Нет строка
Возможные значения: v1, preview		 Явная версия API Azure AI Foundry Models, используемая для этого запроса.
v1, если не указано иначе.
идентификатор_файла path Да строка Идентификатор файла, используемого для этого запроса.

Responses

Код состояния: 200

Описание: запрос выполнен успешно.

Тип содержимого Type Description
application/octet-stream object

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Код состояния: по умолчанию

Описание: непредвиденная ошибка.

Тип содержимого Type Description
application/json object
Name Type Description Обязательный По умолчанию
code строка или null Да
внутренняя ошибка Нет
message строка Да
параметр строка или null Да
type строка Да

Заголовки ответа:

Заголовка Type Description
apim-request-id строка Идентификатор запроса, используемый для устранения неполадок.

Components

AzureAIFoundryModelsApiVersion

Property Ценность
Type строка
Значения v1
preview

AzureFileExpiryAnchor

Property Ценность
Type строка
Значения created_at

OpenAI.CreateFileRequest

Name Type Description Обязательный По умолчанию
истекает через object Да
└─ Привязка AzureFileExpiryAnchor Да
└= секунды целое число (int32) Да
file Объект File (не имя файла) для отправки. Да
purpose enum Целевое назначение загружаемого файла. Одно из следующих: assistants: используется в API помощника - batch: используется в API пакетной обработки - fine-tune: используется для точной настройки - evals: используется для наборов данных оценки
Возможные значения: assistants, , batchfine-tuneevals		 Да

OpenAI.DeleteFileResponse

Name Type Description Обязательный По умолчанию
удалено boolean Да
id строка Да
object enum
Возможные значения: file		 Да

OpenAI.ListFilesResponse

Name Type Description Обязательный По умолчанию
data массив OpenAI.OpenAIFile Да
первый_идентификатор строка Да
есть_еще boolean Да
last_id строка Да
object строка Да

OpenAI.OpenAIFile

OpenAIFile

Объект File представляет документ, который был отправлен в OpenAI.

Name Type Description Обязательный По умолчанию
байт целое число Размер файла в байтах. Да
создано_в целое число (UnixTime) Метка времени Unix (в секундах) для момента создания файла. Да
срок_действия_до целое число (UnixTime) Метка времени Unix (в секундах) для истечения срока действия файла. Нет
filename строка Имя файла. Да
id строка Идентификатор файла, на который можно ссылаться в конечных точках API. Да
object enum Тип объекта, который всегда является file.
Возможные значения: file		 Да
purpose enum Предназначение файла. Поддерживаемые значения: assistants, , assistants_outputbatch, batch_outputfine-tuneи fine-tune-results.
Возможные значения: assistants, , , assistants_outputbatchbatch_outputfine-tunefine-tune-resultsevals		 Да
Статус enum
Возможные значения: uploaded, , , pendingrunningprocessederrordeletingdeleted		 Да
подробности_статуса string (не рекомендуется) Deprecated. Чтобы узнать, почему файл обучения для точной настройки не прошел проверку, см. в поле error на fine_tuning.job. Нет
  • Last updated on