add more comments

Author: maltsev-dev

src/api_handler/call_request.rs

@@ -3,20 +3,34 @@ use crate::models::general::llm::{APIResponse, ChatCompletion, Message};
 use dotenv::dotenv;
 use reqwest::header::{HeaderMap, HeaderValue};
 use std::env;
-// backend_hive
 
-// Call LLM GPT
+/*
+    Этот код отвечает за взаимодействие с API OpenAI для вызова функции "Chat Completions",
+        которая используется для отправки сообщений и получения ответов от модели GPT
+*/
+
+/*
+        Функция call_gpt выполняет следующие задачи:
+            Загружает API-ключи и другие параметры из окружения.
+            Создаёт HTTP-запрос для вызова API OpenAI.
+            Отправляет сообщения модели GPT и получает ответ.
+            Обрабатывает ошибки на каждом этапе.
+            Возвращает текст ответа от модели.
+*/
+
+//  message: Vec<Message>: Вектор сообщений (Message), которые отправляются в модель GPT. Это, например, история чата или конкретные запросы.
 pub async fn call_gpt(message: Vec<Message>) -> Result<String, Box<dyn std::error::Error + Send>> {
+    // Загружает переменные окружения из файла .env в текущую среду.
     dotenv().ok();
 
     // Extract api keys from .env
     let api_key: String = env::var("OPEN_AI_KEY").expect("OPEN_AI_KEY not found");
     let api_org: String = env::var("OPEN_AI_ORG").expect("OPEN_AI_ORG not found");
 
-    // Confirm base url endpoint
+    // Это конечная точка OpenAI для вызова функции "Chat Completions"
     let url: &str = "https://api.openai.com/v1/chat/completions";
 
-    // Create client headers
+    // Создаётся объект HeaderMap, который хранит HTTP-заголовки.
     let mut headers = HeaderMap::new();
     headers.insert(
         "authorization",
@@ -27,13 +41,18 @@ pub async fn call_gpt(message: Vec<Message>) -> Result<String, Box<dyn std::erro
         HeaderValue::from_str(&api_org.as_str())
             .map_err(|e| -> Box<dyn std::error::Error + Send>{ Box::new(e) })?);
 
-    // create reqwest client
+    // Создаётся клиент с предварительно заданными заголовками (default_headers).
     let client = reqwest::Client::builder()
         .default_headers(headers)
         .build()
         .map_err(|e| -> Box<dyn std::error::Error + Send>{ Box::new(e) })?;
 
     // create chat completion
+    /*
+            model: Указание используемой модели (gpt-3.5-turbo).
+            messages: Сообщения, которые будут отправлены модели.
+            temperature: Параметр, определяющий степень случайности в ответах. Значение 0.1 указывает на минимальную случайность (ответы будут более детерминированными).
+    */
     let chat_completion: ChatCompletion = ChatCompletion {
         model: "gpt-3.5-turbo".to_string(),
         messages: message,
@@ -61,6 +80,8 @@ pub async fn call_gpt(message: Vec<Message>) -> Result<String, Box<dyn std::erro
         .map_err(|e| -> Box<dyn std::error::Error + Send>{ Box::new(e) })?;
 
     //parse 'content' from massage from choice from api call response
+    // Первый элемент из массива choices (модель может вернуть несколько вариантов ответа).
+    // Поле message.content, которое содержит текст ответа.
     Ok(res.choices[0].message.content.clone())
 }
 

src/lib.rs

@@ -4,6 +4,9 @@ use proc_macro::TokenStream;
 use quote::{quote, ToTokens};
 use syn::{parse_macro_input, ItemFn};
 
+
+// Его задача — взять функцию, помеченную атрибутом #[function_to_string],
+// и сгенерировать новую функцию, которая возвращает текстовое представление исходной функции.
 #[proc_macro_attribute]
 pub fn function_to_string(_attr: TokenStream, item: TokenStream) -> TokenStream {
     let input_fn: ItemFn = parse_macro_input!(item as ItemFn);