Конфігурація та брендинг
На цій сторінці
Зберігайте конфіденційні облікові дані в конфігурації бекенду, а в конфігурації фронтенду — лише публічні значення.
Як користуватися цими інструментами
- Спочатку викличте відповідний інструмент читання або перевірки стану.
- Перевірте ціль та обовʼязкові аргументи.
- Виконайте одну заплановану дію; якщо потрібне явне підтвердження людини, отримайте його.
- Після цього перевірте стан або повторно прочитайте ресурс, якого стосувалася дія.
Наведені нижче вхідні параметри описують публічний контракт. Орієнтуйтеся на поточний перелік інструментів підключеного сервера. Деякі інструменти потребують певного хоста, розташування проєкту, режиму інференсу чи плану. Ідентифікатори — це значення, які повернули попередні інструменти; не вигадуйте їх.
project_settings
Налаштування проєкту.
Прочитайте повернутий ресурс і враховуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|---|---|
projectId | Ні | рядок |
scope | Ні | ephemeral, production |
Операція: лише читання.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
update_project_settings
Змініть налаштування проєкту.
Прочитайте повернутий ресурс і враховуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|---|---|
projectId | Ні | рядок |
copyright | Ні | рядок |
organizationName | Ні | рядок |
termsUrl | Ні | рядок |
privacyUrl | Ні | рядок |
googleTag | Ні | рядок |
useOrganizationDefaults | Ні | логічне значення |
scope | Ні | ephemeral, production |
Операція: може змінити стан або запустити роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
set_platform_credit
Приховайте або покажіть згадку про платформу.
Можливість прибрати брендинг платформи залежить від умов плану. Зберігайте обовʼязкові юридичні повідомлення та повідомлення третіх сторін.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|---|---|
projectId | Ні | рядок |
hidden | Так | логічне значення |
scope | Ні | ephemeral, production |
Операція: може змінити стан або запустити роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
project_configuration
Змінні конфігурації проєкту.
Прочитайте повернутий ресурс і враховуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|---|---|
projectId | Ні | рядок |
scope | Ні | ephemeral, production |
Операція: лише читання.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
update_project_configuration
Задайте змінні конфігурації.
Конфіденційні облікові дані слід зберігати в значеннях бекенду. Значення фронтенду можуть бути доступні відвідувачам; ніколи не зберігайте в них приватні ключі.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|---|---|
projectId | Ні | рядок |
backend | Ні | обʼєкт |
frontend | Ні | обʼєкт |
scope | Ні | ephemeral, production |
Операція: може змінити стан або запустити роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
recollect_configuration
Знайдіть змінні, оголошені у вихідному коді.
Оновлює відомий перелік оголошених змінних після змін у вихідному коді. Перевірте значення, перш ніж застосовувати конфігурацію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|---|---|
projectId | Ні | рядок |
Операція: може змінити стан або запустити роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
organization_branding
Типові налаштування брендингу організації.
Прочитайте повернутий ресурс і враховуйте його поточні значення, коли плануєте наступну дію.
Аргументи: немає ({}).
Операція: лише читання.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
update_organization_branding
Змініть типові налаштування брендингу організації.
Прочитайте повернутий ресурс і враховуйте його поточні значення, коли плануєте наступну дію.
| Аргумент | Обовʼязковий | Тип або допустимі значення |
|---|---|---|
organizationName | Ні | рядок |
copyright | Ні | рядок |
Операція: може змінити стан або запустити роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.
backfill_project_branding
Заповніть порожні налаштування проєкту типовими значеннями.
Заповнює порожні налаштування брендингу проєкту типовими значеннями організації. Після цього перевірте наявні значення проєкту.
Аргументи: немає ({}).
Операція: може змінити стан або запустити роботу.
Доступні конфігурації: stdio, хмарний проєкт, хмарний інференс; stdio, хмарний проєкт, делегований інференс; stdio, локальний проєкт, хмарний інференс; stdio, локальний проєкт, делегований інференс; HTTP на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.