Проверить содержимое сообщений

Обновлено 10 декабря 2024

POST

/filter/check

Проверяет подпадает содержимое сообщений под тематические ограничения или нет. Содержимое функций (массив functions) не проверяется.

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

Вы можете проверять как текст, так и изображения, переданные в массиве attachments.

Запрос

Header Parameters

X-Client-ID
string
X-Request-ID
string
X-Session-ID
string

• application/json

Body

model

string

required

По умолчанию: GigaFilter

Название модели, которая будет использоваться при работе фильтра

settings object

Параметры проверки. Если явно не передать объект с параметрами, все проверки будут включены.

neuro

boolean

По умолчанию: true

Включает проверку с помощью нейросетевой модели.

blacklist

boolean

По умолчанию: true

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

whitelist

boolean

По умолчанию: true

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

messages object[]required
Массив сообщений, которыми пользователь обменивался с моделью.
Array [
role
string
Возможные значения: [system, user, assistant, function]
Роль автора сообщения:
• system — системный промпт, который задает роль модели, например, должна модель отвечать как академик или как школьник;
• assistant — ответ модели;
• user — сообщение пользователя;
• function — сообщение с результатом работы пользовательской функции. В сообщении с этой ролью передавайте в поле content валидный JSON-объект с результатами работы функции.
Для сохранения контекста диалога с пользователем передайте несколько сообщений. Подробнее читайте в разделе Работа с историей чата.
content
Содержимое сообщения. Зависит от роли.
Если поле передается в сообщении с ролью function, то в нем указывается валидный JSON-объект с аргументами функции, указанной в поле function_call.name.
В остальных случаях содержит либо системный промпт (сообщение с ролью system), либо текст сообщения пользователя или модели.
functions_state_id
uuidv4
Идентификатор, который объединяет массив функций, переданных в запросе. Возвращается в ответе модели (сообщение с "role": "assistant") при вызове встроенных или собственных функций. Позволяет сохранить контекст вызова функции и повысить качество работы модели. Для этого нужно передать идентификатор в запросе на генерацию в сообщении с ролью assistant.
Сейчас поле работает только при обращении к моделям в раннем доступе.
attachments
string[]
Массив идентификаторов файлов, которые нужно использовать при генерации. Идентификатор присваивается файлу при загрузке в хранилище. Посмотреть список файлов в хранилище можно с помощью метода GET /files.
При работе с текстовыми документами в одном запросе на генерацию нужно передавать только один идентификатор. Если вы передадите несколько идентификаторов файлов, для генерации будет использован только первый файл из списка.
В одном сообщении (объект в массиве messages) можно передать только одно изображение. В одной сессии можно передать до 10 изображений.
При этом общий размер запроса должен быть меньше 20 Мб.
Например, ваш запрос может включать текст промпта и два идентификатора изображений, которые ссылаются на файлы размерами 6 Мб и 12 Мб.
Подробнее — в разделе Обработка файлов
]
functions

object[]

Список функций, доступных для вызова при следующем запросе POST /chat/completions.

Ответы

• 200

OK

• application/json

• Схема
• Пример из схемы

Schema

is_profane

boolean

required

Указывает подпадает содержимое сообщений под тематические ограничения или нет.

usage objectrequired

filter_tokens

integer

required

Количество токенов, которые ограниченного контента.

{
  "is_profane": true,
  "usage": {
    "filter_tokens": 35
  }
}

Loading...

Loading...