https://aie24.pl/
Dodatek Owlbot AI firmy ReadMe wykorzystuje sztuczną inteligencję, aby zapewnić czytelnikom Twojej dokumentacji interfejs czatu, w którym mogą zadawać pytania na temat Twojej dokumentacji. Możesz jednak również zbudować własny, korzystając z API asystentów OpenAI lub tworząc własny GPT w ChatGPT Plus. W poniższej demonstracji używam ChatGPT Plus, ale jeśli chcesz użyć API asystentów, możesz uzyskać do niego dostęp, korzystając z instrukcji w sekcji „Budowanie własnego bota dokumentacji”. Jeśli jesteś subskrybentem ChatGPT Plus, możesz uzyskać dostęp do ekranu konfiguracji niestandardowego GPT, klikając ikonę użytkownika w lewym dolnym rogu i wybierając Moje GPT, jak pokazano na rysunku.
Wykonaj następujące kroki, aby utworzyć chatbota dokumentacji API.
- Na ekranie My GPTs (https://chat.openai.com/gpts/mine) kliknij Create a GPT. Pojawi się ekran New GPT.
- Kliknij przycisk Configure, aby uzyskać dostęp do formularza konfiguracji GPT.
3. Wpisz nazwę i opis swojego GPT. Nazwa i opis, których użyłem, są pokazane na rysunku
- Wprowadź instrukcje dla GPT. Oto instrukcje, których użyłem:
Jesteś pomocnym i eksperckim botem wsparcia technicznego, który biegle posługuje się wieloma językami programowania i jest dostępny, aby pomóc każdemu z pytaniami dotyczącymi REST API dla serwera mediów społecznościowych o nazwie „Soliloquy”. Konsultując plik OpenAPI w swojej wiedzy, możesz udzielić odpowiedzi na temat wykonywania zadań, takich jak rejestrowanie użytkowników, logowanie użytkowników, tworzenie nowych postów, edytowanie postów, usuwanie postów i pobieranie postów. Możesz również odpowiedzieć na pytania dotyczące pisania programów, które wykorzystują API.
- W sekcji Knowledge formularza wybierz i prześlij swój plik OAS. Jest to plik YAML utworzony w sekcji „Documenting a REST API”.
- W sekcji Capabilities formularza wybierz Web Browsing and Code Interpreter. Możesz również wybrać dodatkowe opcje, jeśli chcesz (takie jak DALL-E Image Generation).
- Zapisz swój GPT, klikając Save w prawym górnym rogu i wybierając opcję w menu Publish To. Na rysunku wybrałem Anyone with a Link.
Po zakończeniu konfiguracji GPT możesz go przetestować! W pierwszym teście dałem mu następujący monit:
Jak mogę utworzyć nowego użytkownika?
Chatbot zastanowił się przez chwilę, a następnie udzielił idealnej odpowiedzi, jak pokazano na rysunku .
W moim drugim teście postanowiłem spróbować szczęścia. Poprosiłem mojego chatbota o napisanie programu JavaScript i strony HTML, która mogłaby posłużyć do utworzenia użytkownika. Oto prośba, której użyłem:
Czy potrafisz napisać stronę internetową i program JavaScript, aby utworzyć nowego użytkownika?
Jego odpowiedź była świetnym początkiem. Jednak popełnił kilka błędów i podjął nieidealne decyzje. Na przykład dodał dodatkowe pole (nazwa użytkownika) do formularza rejestracyjnego, którego serwer nie obsługuje, a kilka rzeczy w kodzie (takich jak użycie słowa kluczowego var zamiast nowocześniejszego let lub const) można by poprawić. Oto pełny program, który stworzył chatbot:
<!DOCTYPE html>
<html lang=”en”>
<head>
<meta charset=”UTF-8″>
<meta name=”viewport” content=”width=device-width, initial-scale=1.0″>
<title>Create New User</title>
<script>
function signupUser() {
var xhr = new XMLHttpRequest();
var url = “https://api.soliloquy.com/user/signup”; // Replace with
your API’s URL
xhr.open(“POST”, url, true);
xhr.setRequestHeader(“Content-Type”, “application/json”);
xhr.onreadystatechange = function () {
if (xhr.readyState === 4 && xhr.status === 200) {
var jsonResponse = JSON.parse(xhr.responseText);
console.log(“User created: “, jsonResponse);
alert(“User successfully created!”);
}
};
var username = document.getElementById(“username”).value;
var password = document.getElementById(“password”).value;
var email = document.getElementById(“email”).value;
var userData = JSON.stringify({
“username”: username,
“password”: password,
“email”: email
});
xhr.send(userData);
}
</script>
</head>
<body>
<h2>Create New User</h2>
<form onsubmit=”event.preventDefault(); signupUser();”>
<label for=”username”>Username:</label><br>
<input type=”text” id=”username” name=”username” required><br>
<label for=”password”>Password:</label><br>
<input type=”password” id=”password” name=”password” required><br>
<label for=”email”>Email:</label><br>
<input type=”email” id=”email” name=”email” required><br><br>
<input type=”submit” value=”Create User”>
</form>
</body>
</html>
Przetestowałem program na moim serwerze i próbował wysłać żądanie HTTP POST. Żądanie zostało zablokowane z powodu polityki cross-origin resource sharing (CORS) przeglądarki. Po skonfigurowaniu serwera tak, aby zezwalał na żądanie POST z mojego komputera deweloperskiego i wprowadzeniu kilku dodatkowych poprawek program zadziałał!
Gdyby Soliloquy był prawdziwym produktem, a ja tworzyłbym chatbota API, dopracowałbym instrukcje Soliloquy i przesłałbym próbkę aplikacji klienckiej, która używa API. Spodziewam się, że znacznie zwiększyłoby to dokładność asystenta. Ogólnie rzecz biorąc, w tym momencie generatywne systemy AI całkiem nieźle radzą sobie z tworzeniem dokumentacji oprogramowania i mogą być ogromną oszczędnością czasu podczas generowania dokumentacji API. Jednak, jak w przypadku każdego zastosowania generatywnej AI, ważne jest, aby nie zakładać, że jakakolwiek wygenerowana treść jest dokładna lub tak dobra, jak ta, którą można by utworzyć ręcznie.
