Добавили в схемы песочницы контекст для ИИ: пример запроса и подсказки

_assets/simulator/spec/methods/access.name.json

@@ -3,23 +3,23 @@
   "method": "access.name",
   "scope": "базовый",
   "kind": "write",
-  "title": "Получить названия прав доступа access.name",
+  "title": "Получить названия кодов доступа access.name",
   "permissions": "любой пользователь",
   "params": [
     {
       "name": "ACCESS",
-      "type": "array",
+      "type": "string[]",
       "base": "array",
-      "required": true,
-      "description": "Список кодов доступа, названия для которых нужно получить. Форматы кодов: - U<id> — пользователь, например U1 - G<id> — группа пользователей, например G2 - AU — все авторизованные пользователи Если параметр не передан или пуст, метод вернет false",
+      "required": "unknown",
+      "description": "Список кодов доступа, названия для которых нужно получить, например [\"U1\", \"D107\"]. Основные форматы кодов: - U<id> — пользователь, например U1 - IU<id> — пользователь и его руководители, например IU1 - G<id> — группа пользователей, например G1 - D<id> — все сотрудники отдела, например D107 - DR<id> — все сотрудники отдела и его подотделов, например DR107 - SG<id>_A, SG<id>_E, SG<id>_K — владелец,…",
       "dynamic": {
         "allowed": true,
         "note": "Состав полей не описан подтаблицей на этой странице"
       }
     }
   ],
   "defs": {},
-  "requiredConvention": true,
+  "requiredConvention": false,
   "confidence": "parsed",
   "source": {
     "file": "api-reference/common/system/access-name.md"
@@ -52,17 +52,23 @@
       "name": "result",
       "type": "object",
       "base": "object",
-      "required": false,
-      "description": "Объект, где ключ это код доступа из параметра ACCESS, а значение это описание кода. Структура описана ниже. Если параметр ACCESS не передан или пуст, метод вернет false"
+      "required": "unknown",
+      "description": "Объект: ключ — код доступа из параметра ACCESS, значение — описание кода (подробное описание). Если ни одного из переданных кодов нет в Битрикс24, метод вернет пустой массив []. Если параметр ACCESS не передан, пуст или передан строкой, метод вернет false"
     },
     {
       "name": "time",
       "type": "time",
       "base": "object",
-      "required": false,
+      "required": "unknown",
       "description": "Информация о времени выполнения запроса"
     }
   ],
   "page": "/api-reference/common/system/access-name.html",
-  "executable": false
+  "executable": false,
+  "requestExample": {
+    "ACCESS": [
+      "G2",
+      "AU"
+    ]
+  }
 }

_assets/simulator/spec/methods/ai.engine.list.json

@@ -8,18 +8,18 @@
   "params": [
     {
       "name": "filter",
-      "type": "array",
-      "base": "array",
+      "type": "object",
+      "base": "object",
       "required": false,
-      "description": "Массив формата: где: - field_n — название поля, по которому будет произведена фильтрация - value_n — значение фильтра К ключам field_n можно добавить префикс, уточняющий работу фильтра. Возможные значения префикса: - >= — больше либо равно - > — больше - <= — меньше либо равно - < — меньше - @ — IN, в качестве значения передается массив - !@ — NOT IN, в качестве значения передается массив - % — LI…",
+      "description": "Объект с условиями фильтрации. Ключ — название поля с необязательным префиксом оператора, значение — искомое значение. Например: Если параметр не передан, метод возвращает записи без дополнительной фильтрации.…",
       "ref": "#/defs/filterFields"
     },
     {
       "name": "limit",
       "type": "integer",
       "base": "integer",
       "required": false,
-      "description": "Максимальное количество элементов в ответе"
+      "description": "Максимальное количество элементов в ответе. Если параметр не передан, метод возвращает все найденные записи"
     }
   ],
   "defs": {
@@ -63,7 +63,33 @@
           "type": "string",
           "base": "string",
           "required": false,
-          "description": "Категория сервиса"
+          "description": "Категория сервиса. Возможные значения: - text — текстовые запросы - image — генерация изображений - audio — обработка аудио - call — обработка аудиозаписей звонков - vision — анализ изображений - classify — классификация данных",
+          "values": [
+            {
+              "value": "text",
+              "title": "текстовые запросы"
+            },
+            {
+              "value": "image",
+              "title": "генерация изображений"
+            },
+            {
+              "value": "audio",
+              "title": "обработка аудио"
+            },
+            {
+              "value": "call",
+              "title": "обработка аудиозаписей звонков"
+            },
+            {
+              "value": "vision",
+              "title": "анализ изображений"
+            },
+            {
+              "value": "classify",
+              "title": "классификация данных"
+            }
+          ]
         },
         {
           "name": "COMPLETIONS_URL",

_assets/simulator/spec/methods/ai.engine.register.json

@@ -25,7 +25,33 @@
       "type": "string",
       "base": "string",
       "required": true,
-      "description": "Категория сервиса. Возможные значения: - text - image - audio - call"
+      "description": "Категория сервиса. Возможные значения: - text — текстовые запросы - image — генерация изображений - audio — обработка аудио - call — обработка аудиозаписей звонков - vision — анализ изображений - classify — классификация данных",
+      "values": [
+        {
+          "value": "text",
+          "title": "текстовые запросы"
+        },
+        {
+          "value": "image",
+          "title": "генерация изображений"
+        },
+        {
+          "value": "audio",
+          "title": "обработка аудио"
+        },
+        {
+          "value": "call",
+          "title": "обработка аудиозаписей звонков"
+        },
+        {
+          "value": "vision",
+          "title": "анализ изображений"
+        },
+        {
+          "value": "classify",
+          "title": "классификация данных"
+        }
+      ]
     },
     {
       "name": "completions_url",
@@ -39,7 +65,7 @@
       "type": "object",
       "base": "object",
       "required": false,
-      "description": "Дополнительные настройки сервиса (подробное описание)",
+      "description": "Дополнительные настройки сервиса (подробное описание). Если параметр не передан, сохраняется пустой набор настроек",
       "ref": "#/defs/settingsFields"
     }
   ],
@@ -63,7 +89,17 @@
           "type": "string",
           "base": "string",
           "required": false,
-          "description": "Способ подсчета контекста. Возможные значения: - token - symbol По умолчанию используется token"
+          "description": "Способ подсчета контекста. Возможные значения: - token — подсчет по токенам - symbol — подсчет по символам По умолчанию используется token",
+          "values": [
+            {
+              "value": "token",
+              "title": "подсчет по токенам"
+            },
+            {
+              "value": "symbol",
+              "title": "подсчет по символам По умолчанию используется token"
+            }
+          ]
         },
         {
           "name": "model_context_limit",
@@ -110,5 +146,16 @@
     }
   ],
   "page": "/api-reference/ai/ai-engine-register.html",
-  "executable": false
+  "executable": false,
+  "requestExample": {
+    "name": "Acme GPT",
+    "code": "acme_gpt",
+    "category": "text",
+    "completions_url": "https://api.example.com/bitrix24/ai/completions",
+    "settings": {
+      "code_alias": "ChatGPT",
+      "model_context_type": "token",
+      "model_context_limit": 15666
+    }
+  }
 }

_assets/simulator/spec/methods/ai.engine.unregister.json

@@ -10,8 +10,8 @@
       "name": "code",
       "type": "string",
       "base": "string",
-      "required": false,
-      "description": "Символьный код удаляемого сервиса"
+      "required": true,
+      "description": "Символьный код удаляемого сервиса. Код должен совпадать с кодом сервиса, зарегистрированного текущим приложением или без привязки к приложению при вызове через вебхук"
     }
   ],
   "defs": {},
@@ -39,7 +39,7 @@
       "type": "boolean",
       "base": "boolean",
       "required": false,
-      "description": "Результат удаления сервиса: - true — сервис удален - false — сервис не найден, не принадлежит текущему приложению или удаление не выполнено"
+      "description": "Результат удаления сервиса: - true — сервис удален - false — сервис не найден, не принадлежит текущему приложению, параметр code не передан или удаление не выполнено"
     },
     {
       "name": "time",
@@ -50,5 +50,8 @@
     }
   ],
   "page": "/api-reference/ai/ai-engine-unregister.html",
-  "executable": false
+  "executable": false,
+  "requestExample": {
+    "code": "acme_gpt"
+  }
 }

_assets/simulator/spec/methods/app.info.json

@@ -0,0 +1,81 @@
+{
+  "$v": 1,
+  "method": "app.info",
+  "scope": "базовый",
+  "kind": "write",
+  "title": "Показать информацию о приложении app.info",
+  "permissions": "любой пользователь",
+  "params": [
+    {
+      "name": "result",
+      "type": "object",
+      "base": "object",
+      "required": "unknown",
+      "description": "Информация о приложении (подробное описание)",
+      "dynamic": {
+        "allowed": true,
+        "note": "Состав полей не описан подтаблицей на этой странице"
+      }
+    },
+    {
+      "name": "time",
+      "type": "time",
+      "base": "object",
+      "required": "unknown",
+      "description": "Информация о времени выполнения запроса",
+      "dynamic": {
+        "allowed": true,
+        "note": "Состав полей не описан подтаблицей на этой странице"
+      }
+    }
+  ],
+  "defs": {},
+  "requiredConvention": false,
+  "confidence": "parsed",
+  "source": {
+    "file": "api-reference/common/system/app-info.md"
+  },
+  "resultExample": {
+    "result": {
+      "ID": 5,
+      "CODE": "telefum24.kp10",
+      "VERSION": 4,
+      "STATUS": "F",
+      "INSTALLED": true,
+      "PAYMENT_EXPIRED": "N",
+      "DAYS": null,
+      "LANGUAGE_ID": "ru",
+      "LICENSE": "ru_ent10000",
+      "LICENSE_TYPE": "ent10000",
+      "LICENSE_FAMILY": "ent"
+    },
+    "time": {
+      "start": 1722841503.0585,
+      "finish": 1722841503.09885,
+      "duration": 0.0403509140014648,
+      "processing": 0.00533103942871094,
+      "date_start": "2024-08-05T07:05:03+00:00",
+      "date_finish": "2024-08-05T07:05:03+00:00",
+      "operating": 0
+    }
+  },
+  "returns": [
+    {
+      "name": "result",
+      "type": "object",
+      "base": "object",
+      "required": "unknown",
+      "description": "Информация о приложении (подробное описание)"
+    },
+    {
+      "name": "time",
+      "type": "time",
+      "base": "object",
+      "required": "unknown",
+      "description": "Информация о времени выполнения запроса"
+    }
+  ],
+  "page": "/api-reference/common/system/app-info.html",
+  "executable": false,
+  "requestExample": {}
+}

_assets/simulator/spec/methods/app.option.get.json

@@ -3,8 +3,8 @@
   "method": "app.option.get",
   "scope": "базовый",
   "kind": "read",
-  "title": "Получить привязанные к приложению данные app.option.get",
-  "permissions": "любой пользователь",
+  "title": "Получить общие настройки приложения app.option.get",
+  "permissions": "любой авторизованный пользователь в контексте приложения",
   "params": [
     {
       "name": "option",
@@ -41,7 +41,7 @@
       "type": "object",
       "base": "object",
       "required": false,
-      "description": "Зависит от параметра option: - параметр не передан — объект, где ключ это название настройки, а значение это сохраненное значение. Если настроек нет, объект пустой - параметр передан — сохраненное значение ключа - параметр передан, но такого ключа нет — null"
+      "description": "Зависит от параметра option: - параметр не передан — объект, где ключ — название настройки, значение — сохраненное значение. Если настроек нет, возвращается пустой массив [] - параметр передан — сохраненное значение ключа: строка, целое или дробное число, логическое значение, массив или объект - параметр передан, но такого ключа нет — null Значение возвращается в том виде, в каком его сохранил app…"
     },
     {
       "name": "time",

_assets/simulator/spec/methods/app.option.set.json

@@ -3,15 +3,15 @@
   "method": "app.option.set",
   "scope": "базовый",
   "kind": "write",
-  "title": "Привязать данные к приложению app.option.set",
-  "permissions": "администратор",
+  "title": "Сохранить общие настройки приложения app.option.set",
+  "permissions": "администратор Битрикс24 в контексте приложения",
   "params": [
     {
       "name": "options",
-      "type": "array",
-      "base": "array",
-      "required": true,
-      "description": "Массив, где ключ — название сохраняемого свойства, а значение — значение свойства. Если передать значение с новым ключом, то метод его запишет, а если существующее — обновит",
+      "type": "object",
+      "base": "object",
+      "required": false,
+      "description": "Объект настроек: ключ — название настройки, значение — ее значение. Передавайте options объектом. Не используйте ключи next и total: при чтении всех настроек REST API вернет их не в result, а в корне ответа. Перезаписываются только переданные ключи, остальные сохраненные настройки не меняются.…",
       "dynamic": {
         "allowed": true,
         "note": "Состав полей не описан подтаблицей на этой странице"