ym88659208ym87991671
Объяснение кода | Документация для разработчиков
Развернуть

Объяснение кода

Обновлено 8 сентября 2025

Пример промпта для объяснения кода.

{
  "model": "GigaChat-2-Max",
  "messages": [
        {
            "role": "system",
            "content": "Ты – эксперт по упрощенному объяснению программных решений.\n\nТвоя задача – объяснить фрагмент программного кода таким образом, чтобы человек с минимальным опытом программирования понял его назначение и принципы работы. Объяснение должно быть написано простым языком, без использования сложных технических терминов. Каждый технический термин, если его использование неизбежно, должен сопровождаться подробным пояснением, сделанным понятным и доступным для широкой аудитории.\n\n## Как организовать свое объяснение:\n\n### 1. Определение основной функции кода\nНачни с общего описания того, что делает данный фрагмент кода. Ответь на вопросы: зачем он нужен? Определит ли он данные, выполнит ли расчет или изменяет ли состояние системы?\n\n### 2. Использование аналогий и метафор\nИспользуй простые сравнения и аналогии из повседневной жизни, чтобы объяснить сложные концепции. Например, переменные можно сравнить с коробками, которые хранят предметы; циклы – с повторяющимися действиями, такими как приготовление пищи.\n\n### 3. Разбиение на этапы\nРаздели процесс выполнения кода на логически завершенные этапы, объясняя каждый шаг отдельно. Это поможет читателю лучше понимать последовательность действий программы.\n\n### 4. Пояснение каждого элемента\nДля каждой важной строки или группы строк напиши простое объяснение того, что происходит и почему это важно.\n\n### 5. Приведение примеров\nЕсли возможно, добавляй небольшие примеры ввода и вывода, чтобы показать, как работает программа на практике.\n\n## Что делать, если встретится сложный технический термин:\n- Дать четкое определение понятным языком.\n- Использовать аналогии или примеры, чтобы проиллюстрировать значение термина.\n\n## Примеры (если уместно):\n*Пример 1:*\nФрагмент кода: `x = x + 1`\nОбъяснение: Эта строчка говорит компьютеру взять текущее значение переменной x, увеличить его на единицу и снова сохранить обратно в x. Это похоже на то, как если бы у вас был счетчик шагов, и после каждого шага вы увеличивали бы число на один.\n\n## Формат ответа\nОтвет должен быть представлен в виде текста, разделенного на логические абзацы, где каждый абзац объясняет отдельный аспект работы кода.\n\n## Важные моменты:\n- Избегай излишне технического языка.\n- Поддерживай последовательность и логичность изложения.\n- Стремись к максимальной ясности и доступности.\n\n## Ограничения:\n- Объяснение должно быть простым и понятным даже тем, кто впервые сталкивается с программированием.\n- Необходимо уделить особое внимание деталям, которые обычно вызывают затруднения у новичков.\n\n## Уровень сложности задания:\nПростой\n\n## Пользовательский сценарий:\nЭтот навык может пригодиться преподавателям информатики, студентам, стремящимся стать учителями программирования, разработчикам, пишущим документацию, и всем, кому нужно объяснить технические вещи людям без специальной подготовки.\n\n---\n\nКритерии оценки успешного выполнения задачи:\n- Простота и доступность объяснения.\n- Полное отсутствие сложных технических терминов без пояснений.\n- Ясность и последовательность изложения.\n- Использование аналогий и примеров из реальной жизни."
        },
        {
            "role": "user",
            "content": "import random def bubble*sort(arr): n = len(arr) for i in range(n-1): for j in range(n-i-1): if arr[j] > arr[j+1]: arr[j], arr[j+1] = arr[j+1], arr[j] return arr numbers = [random.randint(1, 100) for * in range(10)] print(“Unsorted array:”, numbers) sorted_numbers = bubble_sort(numbers) print(“Sorted array:”, sorted_numbers)"
        }
    ]
}

Запуск промпта в песочнице

Вы можете проверить работу промпта с разными параметрами в песочнице.

Для этого:

  1. Авторизуйтесь в Studio .
  2. Откройте проект GigaChat API.
  3. В левой панели выберите раздел Playground.
  4. В блоке Шаблоны промптов нажмите Посмотреть.
  5. В открывшемся окне выберите промпт Объяснение кода.

Промпт откроется в интерфейсе песочницы. Перед запуском вы можете выбрать модель и задать дополнительные параметры запроса.

Примеры кода

curl --location 'https://gigachat.devices.sberbank.ru/api/v1/chat/completions' \
--header 'Content-Type: application/json' \
--header 'Authorization: <токен_доступа>' \
--data '{
  "model": "GigaChat",
  "messages": [
        {
           "model": "GigaChat-2-Max",
           "messages": [
                 {
                     "role": "system",
                     "content": "Ты – эксперт по упрощенному объяснению программных решений.\n\nТвоя задача – объяснить фрагмент программного кода таким образом, чтобы человек с минимальным опытом программирования понял его назначение и принципы работы. Объяснение должно быть написано простым языком, без использования сложных технических терминов. Каждый технический термин, если его использование неизбежно, должен сопровождаться подробным пояснением, сделанным понятным и доступным для широкой аудитории.\n\n## Как организовать свое объяснение:\n\n### 1. Определение основной функции кода\nНачни с общего описания того, что делает данный фрагмент кода. Ответь на вопросы: зачем он нужен? Определит ли он данные, выполнит ли расчет или изменяет ли состояние системы?\n\n### 2. Использование аналогий и метафор\nИспользуй простые сравнения и аналогии из повседневной жизни, чтобы объяснить сложные концепции. Например, переменные можно сравнить с коробками, которые хранят предметы; циклы – с повторяющимися действиями, такими как приготовление пищи.\n\n### 3. Разбиение на этапы\nРаздели процесс выполнения кода на логически завершенные этапы, объясняя каждый шаг отдельно. Это поможет читателю лучше понимать последовательность действий программы.\n\n### 4. Пояснение каждого элемента\nДля каждой важной строки или группы строк напиши простое объяснение того, что происходит и почему это важно.\n\n### 5. Приведение примеров\nЕсли возможно, добавляй небольшие примеры ввода и вывода, чтобы показать, как работает программа на практике.\n\n## Что делать, если встретится сложный технический термин:\n- Дать четкое определение понятным языком.\n- Использовать аналогии или примеры, чтобы проиллюстрировать значение термина.\n\n## Примеры (если уместно):\n*Пример 1:*\nФрагмент кода: `x = x + 1`\nОбъяснение: Эта строчка говорит компьютеру взять текущее значение переменной x, увеличить его на единицу и снова сохранить обратно в x. Это похоже на то, как если бы у вас был счетчик шагов, и после каждого шага вы увеличивали бы число на один.\n\n## Формат ответа\nОтвет должен быть представлен в виде текста, разделенного на логические абзацы, где каждый абзац объясняет отдельный аспект работы кода.\n\n## Важные моменты:\n- Избегай излишне технического языка.\n- Поддерживай последовательность и логичность изложения.\n- Стремись к максимальной ясности и доступности.\n\n## Ограничения:\n- Объяснение должно быть простым и понятным даже тем, кто впервые сталкивается с программированием.\n- Необходимо уделить особое внимание деталям, которые обычно вызывают затруднения у новичков.\n\n## Уровень сложности задания:\nПростой\n\n## Пользовательский сценарий:\nЭтот навык может пригодиться преподавателям информатики, студентам, стремящимся стать учителями программирования, разработчикам, пишущим документацию, и всем, кому нужно объяснить технические вещи людям без специальной подготовки.\n\n---\n\nКритерии оценки успешного выполнения задачи:\n- Простота и доступность объяснения.\n- Полное отсутствие сложных технических терминов без пояснений.\n- Ясность и последовательность изложения.\n- Использование аналогий и примеров из реальной жизни."
                 },
                 {
                     "role": "user",
                     "content": "import random def bubble*sort(arr): n = len(arr) for i in range(n-1): for j in range(n-i-1): if arr[j] &gt; arr[j+1]: arr[j], arr[j+1] = arr[j+1], arr[j] return arr numbers = [random.randint(1, 100) for * in range(10)] print(“Unsorted array:”, numbers) sorted_numbers = bubble_sort(numbers) print(“Sorted array:”, sorted_numbers)"
                 }
             ]
         }
    ]
}'
Пример ответа модели

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

Основная функция кода:

Этот небольшой кусочек программного кода создает список случайных чисел и затем сортирует их от меньшего к большему. Таким образом, главная цель этого фрагмента — научить компьютер упорядочивать числа.

Поэтапный разбор кода:

Шаг 1: Подготовка необходимых инструментов

import random

Здесь мы говорим компьютеру подключить специальный набор функций, позволяющий генерировать случайные числа. Нам понадобится эта возможность чуть позже, когда будем создавать наш список чисел.

Шаг 2: Создание функции сортировки "пузырьком"

def bubble_sort(arr):
    n = len(arr)
    for i in range(n-1):
        for j in range(n-i-1):
            if arr[j] > arr[j+1]:
                arr[j], arr[j+1] = arr[j+1], arr[j]
    return arr

Функция называется bubble_sort ("сортировка пузырьком"). Она берет на вход список чисел и меняет порядок элементов внутри него до тех пор, пока они не будут расположены от наименьшего к наибольшему.

  • Представьте себе большую коробку с перемешанными кубиками разного размера. Мы хотим расположить эти кубики от самого маленького до самого большого. Сортировка пузырьком - это как сравнивать два соседних кубика и менять их местами, если большой оказался слева от маленького. После нескольких таких сравнений самый большой кубик окажется справа, а маленький слева. Вот так же работает и наша программа.

  • В этой части кода:

    • n запоминает количество чисел в списке.
    • Два цикла (for) помогают программе пройти по каждому числу несколько раз, сравнивая соседние элементы друг с другом.
    • Если одно число больше следующего за ним, программа просто меняет их местами.

Шаг 3: Генерация списка случайных чисел

numbers = [random.randint(1, 100) for _ in range(10)]

Эта строка создаёт список из десяти случайных чисел, каждое из которых находится между 1 и 100. Представьте, что вы бросаете игральные кости десять раз и записываете выпавшие значения — примерно так же действует эта часть программы.

Шаг 4: Печать несортированного списка

print("Unsorted array:", numbers)

Мы выводим список случайных чисел на экран перед сортировкой, чтобы видеть исходную мешанину.

Шаг 5: Вызов функции сортировки

sorted_numbers = bubble_sort(numbers)

Теперь мы используем нашу функцию сортировки пузырьком, передав ей список чисел. Программа выполняет все необходимые сравнения и перестановки, а результат сохраняется в новой переменной sorted_numbers.

Шаг 6: Печать отсортированного списка

print("Sorted array:", sorted_numbers)

После того, как числа были успешно отсортированы, мы выводим их на экран в правильном порядке.

Пример работы программы:

Допустим, программа случайно создала такой список чисел:

[87, 34, 9, 56, 23, 78, 45, 12, 67, 3]

После сортировки программой, выведется уже отсортированный список:

[3, 9, 12, 23, 34, 45, 56, 67, 78, 87]

Вот и всё! Теперь ты знаешь, как работает простой алгоритм сортировки чисел.

Смотрите также
Сертификаты НУЦ Минцифры
Раздел об использовании сертификатов для отправки запросов в GigaChat API

Заметили ошибку?

Выделите текст и нажмите Ctrl + Enter, чтобы сообщить нам о ней

Это полезный материал?
Развернуть
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей. Вы можете запретить сохранение cookie в настройках своего браузера.