Microsoft Foundry

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

Authentication

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

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

Области:

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

Агенты

Агенты — создание агента

POST {endpoint}/agents?api-version=v1

Создает агент.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Агенты — агенты списка

GET {endpoint}/agents?api-version=v1

Возвращает список всех агентов.

Параметры URI

Responses

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

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

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

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

Агенты — получение агента

GET {endpoint}/agents/{agent_name}?api-version=v1

Извлекает агента.

Параметры URI

Responses

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

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

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

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

Агенты — агент обновления

POST {endpoint}/agents/{agent_name}?api-version=v1

Обновляет агент путем добавления новой версии, если в определение агента вносятся какие-либо изменения. Если изменений нет, возвращается существующая версия агента.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Агенты — удаление агента

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Удаляет агент.

Параметры URI

Responses

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

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

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

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

Агенты — обновление агента из манифеста

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Обновляет агент из манифеста, добавив новую версию, если в определении агента есть какие-либо изменения. Если изменений нет, возвращается существующая версия агента.

Параметры URI

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Агенты — создание версии агента

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Создайте новую версию агента.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Агенты — версии агента списка

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Возвращает список версий агента.

Параметры URI

Responses

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

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

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

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

Агенты — получение версии агента

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Извлекает определенную версию агента.

Параметры URI

Responses

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

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

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

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

Агенты — удаление версии агента

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Удаляет определенную версию агента.

Параметры URI

Responses

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

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

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

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

Агенты — создание версии агента из манифеста

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Создайте новую версию агента из манифеста.

Параметры URI

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Агенты — создание агента из манифеста

POST {endpoint}/agents:import?api-version=v1

Создает агента из манифеста.

Параметры URI

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Контейнеры агентов

Контейнеры агента — операции контейнера агента списка

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Вывод списка операций контейнера для агента.

Параметры URI

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

Responses

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

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

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

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

Контейнеры агента — получение операции контейнера агента

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Получение состояния операции контейнера для агента.

Параметры URI

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

Responses

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

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

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

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

Контейнеры агента — получение контейнера агента

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Получите контейнер для определенной версии агента.

Параметры URI

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

Responses

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

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

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

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

Контейнеры агента — операции контейнера версии агента списка

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Вывод списка операций контейнера для определенной версии агента.

Параметры URI

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

Responses

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

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

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

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

Контейнеры агента — удаление контейнера агента

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Удалите контейнер для определенной версии агента. Если контейнер не существует, операция будет no-op. Операция является длительной операцией. Следование рекомендациям по проектированию для долгосрочных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

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

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

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

Контейнеры агентов — журналы контейнеров агента потоковой передачи

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Запись журнала контейнера передавалась из контейнера в виде текстовых фрагментов. Каждый блок представляет собой строку UTF-8, которая может быть либо лог-линией в виде обычного текста, либо записью в формате JSON, в зависимости от типа потокового контейнерного журнала. Клиенты должны рассматривать каждый фрагмент как непрозрачный текст и, при необходимости, пытаться парсировать его как JSON в зависимости от требований к логированию.

Для системных журналов формат JSON со следующей структурой: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Подключение к коллекционеру событий...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Успешно подключено к событиям server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Для консольных логов формат представляет собой обычный текст, исходящий от stdout/stderr контейнера. 2025-12-15T08:43:48.72656 Подключение к контейнеру 'агент-контейнер'... 2025-12-15T08:43:48.75451 Успешно подключено к контейнеру: 'agent-container' [Редакция: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', реплика: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

Параметры URI

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

Responses

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

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

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

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

Контейнеры агента — запуск контейнера агента

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Запустите контейнер для определенной версии агента. Если контейнер уже запущен, операция будет no-op. Операция является длительной операцией. Следование рекомендациям по проектированию для долгосрочных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

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

Контейнеры агента — контейнер агента остановки

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Остановите контейнер для определенной версии агента. Если контейнер не запущен или уже остановлен, операция будет no-op. Операция является длительной операцией. Следование рекомендациям по проектированию для долгосрочных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

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

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

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

Контейнеры агента — контейнер агента обновления

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Обновите контейнер для определенной версии агента. Если контейнер не запущен, операция будет no-op. Операция является длительной операцией. Следование рекомендациям по проектированию для долгосрочных операций в Azure REST API. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

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

Connections

Подключения — список

GET {endpoint}/connections?api-version=v1

Перечислить все соединения в project, не заполняя учетные данные соединения

Параметры URI

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

Responses

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

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

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

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

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

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

Подключения — получение

GET {endpoint}/connections/{name}?api-version=v1

Получение подключения по имени, без заполнения учетных данных подключения

Параметры URI

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

Responses

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

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

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

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

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

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

Подключения — получение учетных данных

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Получение подключения по имени с учетными данными для подключения

Параметры URI

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

Responses

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

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

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

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

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

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

Наборы данных

Наборы данных — список последних версий

GET {endpoint}/datasets?api-version=v1

Перечисление последней версии каждой версии DatasetVersion

Параметры URI

Responses

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

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

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

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

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

Наборы данных — версии списка

GET {endpoint}/datasets/{name}/versions?api-version=v1

Вывод списка всех версий заданного DatasetVersion

Параметры URI

Responses

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

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

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

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

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

Наборы данных — получение версии

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Получите конкретную версию DatasetVersion. Служба возвращает ошибку 404 Not Found, если DatasetVersion не существует.

Параметры URI

Responses

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

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

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

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

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

Наборы данных — удаление версии

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Удалите определенную версию DatasetVersion. Служба возвращает 204 No Content, если DatasetVersion был успешно удален или если DatasetVersion не существует.

Параметры URI

Responses

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

Описание. Для этого запроса нет содержимого, но заголовки могут быть полезны.

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

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

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

Наборы данных — создание или обновление версии

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Создание новой или обновление существующей версии DatasetVersion с заданным идентификатором версии

Параметры URI

Тело запроса

Тип содержания: application/merge-patch+json

Responses

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Наборы данных — получение учетных данных

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Получите учётную запись SAS для access к аккаунту storage, связанному с версией Dataset.

Параметры URI

Responses

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

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

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

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

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

Наборы данных — запуск ожидающей отправки версии

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

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

Параметры URI

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

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

Развертывания

Развертывания — список

GET {endpoint}/deployments?api-version=v1

Перечислите все развернутые модели в project

Параметры URI

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

Responses

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

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

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

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

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

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

Развертывания — получение

GET {endpoint}/deployments/{name}?api-version=v1

Получите развернутую модель.

Параметры URI

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

Responses

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

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

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

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

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

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

Оценка таксономий

Оценка таксономий — список

GET {endpoint}/evaluationtaxonomies?api-version=v1

Список таксономий оценки

Параметры URI

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

Responses

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

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

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

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

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

Оценка таксономий — получение

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Получите прогон оценки по имени.

Параметры URI

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

Responses

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

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

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

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

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

Оценка таксономий — удаление

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Удалите таксономию оценки по имени.

Параметры URI

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

Responses

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

Описание. Для этого запроса нет содержимого, но заголовки могут быть полезны.

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

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

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

Оценка таксономий — создание

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Создание таксономии оценки.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Оценка таксономий — обновление

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Обновление таксономии оценки.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

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

Правила оценки

Правила оценки — список

GET {endpoint}/evaluationrules?api-version=v1

Перечислите все правила оценки.

Параметры URI

Responses

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

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

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

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

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

Правила оценки — получение

GET {endpoint}/evaluationrules/{id}?api-version=v1

Получите правило оценки.

Параметры URI

Responses

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

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

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

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

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

Правила оценки — удаление

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Удалите правило оценки.

Параметры URI

Responses

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

Описание. Для этого запроса нет содержимого, но заголовки могут быть полезны.

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

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

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

Правила оценки — создание или обновление

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Создание или обновление правила оценки.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Оценщиков

Вычислители — список последних версий

GET {endpoint}/evaluators?api-version=v1

Перечислите последнюю версию каждого оценщика

Параметры URI

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

Responses

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

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

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

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

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

Вычислители — версии списка

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Перечислите все версии данного оценщика

Параметры URI

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

Responses

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

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

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

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

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

Вычислители — создание версии

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Создание нового EvaluatorVersion с автоматически увеличиваемым идентификатором версии

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Вычислители — получение версии

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Получите конкретную версию EvaluatorVersion. Служба возвращает ошибку 404 Not Found, если EvaluatorVersion не существует.

Параметры URI

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

Responses

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

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

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

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

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

Вычислители — удаление версии

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Удалите конкретную версию EvaluatorVersion. Служба возвращает 204 No Content, если EvaluatorVersion был успешно удален или если EvaluatorVersion не существует.

Параметры URI

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

Responses

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

Описание. Для этого запроса нет содержимого, но заголовки могут быть полезны.

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

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

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

Вычислители — версия обновления

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Обновите существующую версию EvaluatorVersion с указанным идентификатором версии

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

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

Индексы

Индексы — список последних версий

GET {endpoint}/indexes?api-version=v1

Перечисление последней версии каждого индекса

Параметры URI

Responses

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

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

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

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

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

Индексы — версии списка

GET {endpoint}/indexes/{name}/versions?api-version=v1

Список всех версий данного индекса

Параметры URI

Responses

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

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

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

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

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

Индексы — получение версии

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Получите конкретную версию индекса. Служба возвращает ошибку 404 Not Found, если индекс не существует.

Параметры URI

Responses

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

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

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

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

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

Индексы — удаление версии

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Удалите конкретную версию индекса. Служба возвращает 204 No Content, если индекс был успешно удален или если индекс не существует.

Параметры URI

Responses

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

Описание. Для этого запроса нет содержимого, но заголовки могут быть полезны.

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

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

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

Индексы — создание или обновление версии

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Создание нового или обновление существующего индекса с заданным идентификатором версии

Параметры URI

Тело запроса

Тип содержания: application/merge-patch+json

Responses

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

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

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Insights

Аналитика — создание

POST {endpoint}/insights?api-version=v1

Генерируйте аналитические сведения

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

Описание: запрос успешно выполнен, и в результате был создан новый ресурс.

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

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

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

Аналитика — список

GET {endpoint}/insights?api-version=v1

Перечислите все идеи в обратном хронологическом порядке (сначала новые).

Параметры URI

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

Responses

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

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

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

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

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

Аналитика — получение

GET {endpoint}/insights/{id}?api-version=v1

Получите конкретное представление по идентификатору.

Параметры URI

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

Responses

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

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

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

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

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

Хранилища памяти

Создание хранилища памяти

POST {endpoint}/memory_stores?api-version=v1

Создайте хранилище памяти.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Список хранилищ памяти

GET {endpoint}/memory_stores?api-version=v1

Перечислите все хранилища памяти.

Параметры URI

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

Responses

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

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

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

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

Обновление хранилища памяти

POST {endpoint}/memory_stores/{name}?api-version=v1

Обновите хранилище памяти.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Получение хранилища памяти

GET {endpoint}/memory_stores/{name}?api-version=v1

Извлечение хранилища памяти.

Параметры URI

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

Responses

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

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

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

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

Удаление хранилища памяти

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Удалите хранилище памяти.

Параметры URI

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

Responses

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

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

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

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

Получение результата обновления

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Получите результат обновления хранилища памяти.

Параметры URI

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

Responses

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

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

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

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

Удаление памяти области

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Удалите все воспоминания, связанные с определенной областью, из хранилища памяти.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Поиск воспоминаний

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Ищите релевантные воспоминания в хранилище памяти на основе контекста разговора.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Обновление воспоминаний

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Обновите хранилище памяти с помощью воспоминаний о разговорах.

Параметры URI

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

Тело запроса

Тип содержания: application/json

Responses

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

Описание. Запрос был принят для обработки, но обработка еще не завершена.

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

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

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

Беседы

Создание беседы

POST {endpoint}/openai/v1/conversations

Создайте беседу.

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Список бесед

GET {endpoint}/openai/v1/conversations

Возвращает список всех бесед.

Параметры URI

Responses

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

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

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

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

Обновление беседы

POST {endpoint}/openai/v1/conversations/{conversation_id}

Обновите беседу.

Параметры URI

Тело запроса

Тип содержания: application/json

Responses

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

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

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

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

Получение беседы

GET {endpoint}/openai/v1/conversations/{conversation_id}

Извлекает беседу.

Параметры URI

Responses

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

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

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

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