W tym samouczku dowiesz się, jak przygotować się do korzystania z OpenAI API. Przewodzę cię krok po kroku przez proces konfiguracji, aby upewnić się, że ustawiasz wszystkie niezbędne komponenty – od generowania klucza API po instalację wymaganej paczki OpenAI NPM. Następnie pokażę ci, jak korzystać z API w swojej aplikacji. Zaczynamy!
Najważniejsze informacje
- Klucz API jest wymagany do dostępu do OpenAI API, który możesz wygenerować na platformie OpenAI.
- Potrzebujesz pakietu openai-npm do wykonywania wywołań API.
- Wszystko to odbywa się przy użyciu Node.js i JavaScript, a ja pokażę ci, jak dokonać konfiguracji.
Instrukcja krok po kroku
Aby skutecznie korzystać z API OpenAI, postępuj zgodnie z poniższymi krokami:
1. Utwórz konto na platformie OpenAI
Najpierw musisz utworzyć konto na platformie OpenAI. Otwórz swą przeglądarkę i przejdź do platform.openai.com. Kliknij „Zarejestruj się”, aby się zarejestrować.
Podaj swój adres e-mail i wybierz hasło. Możesz także zalogować się za pomocą swojego konta Google, Microsoft lub Apple.
2. Wygeneruj klucz API
Po utworzeniu konta, przejdź do ustawień. Tam znajdziesz opcję „Klucze API”. Tutaj możesz wygenerować swój klucz API.
Kliknij odpowiedni przycisk, aby utworzyć nowy klucz API. Możesz mu nadać nazwę. Po utworzeniu klucz API zostanie wyświetlony. Skopiuj ten klucz i zachowaj go bezpiecznie – albo w kodzie swojej aplikacji, albo w osobnym pliku.
Upewnij się, że nie zgubisz tego klucza. Jeśli zamkniesz okno dialogowe, nie będziesz miał możliwości zobaczenia klucza ponownie i będziesz musiał utworzyć nowy.
3. Zrozum system tokenów
Aby korzystać z API, potrzebujesz tokenów lub kredytów. Każde wywołanie API zużywa określoną liczbę tokenów. Ważne jest, aby wiedzieć, że tokeny często zawierają więcej niż rzeczywistą liczbę słów, ponieważ mogą obejmować także części słów.
Po zalogowaniu otrzymasz zazwyczaj określoną liczbę kredytów, które możesz użyć do wywołań API. Upewnij się, że przechowujesz klucze bezpiecznie, aby mieć do nich zawsze dostęp.
4. Zainstaluj pakiet openai-npm
Następnym krokiem jest instalacja pakietu openai-npm. Przejdź do terminala i przejdź do katalogu, w którym utworzyłeś swoją aplikację.
Wykonaj polecenie npm install openai, aby zainstalować pakiet.
Kiedy instalacja zostanie zakończona, sprawdź plik package.json, aby upewnić się, że pakiet został pomyślnie dodany.
5. Importuj wymagane moduły
Teraz, gdy pakiet został zainstalowany, musisz zaimportować wymagane moduły do swojego kodu JavaScript. Zaimportuj moduły Konfiguracja i OpenAI z pakietu openai.
6. Skonfiguruj API OpenAI
Teraz możesz przystąpić do konfiguracji API. Utwórz nowy obiekt konfiguracyjny, który zawiera Twój klucz API.
Aby to zrobić, użyj wywołania new Configuration() i przekaż obiekt klucza API.
Następnie możesz zainicjować API OpenAI przy użyciu wywołania new OpenAI({configuration}).
7. Przygotuj zapytanie API
Następnie musisz przygotować zapytanie API, aby wykonać wywołanie API. Utwórz funkcję asynchroniczną, w której jest potrzebne zapytanie API.
Funkcja completeChat otrzymuje wiadomość, która jest przekazywana za pomocą zmiennej. Wywołaj metodę createChatCompletion z OpenAI i przekaż niezbędne parametry, takie jak model (np. gpt-3.5-turbo) oraz wszystkie wysłane wiadomości.
8. Przetwórz odpowiedź API
Gdy pomyślnie skorzystasz z API, otrzymasz odpowiedź, którą musisz przetworzyć. W odpowiedzi znajdziesz dane, których potrzebujesz, takie jak opcje, które zawierają wygenerowaną odpowiedź API.
Zapisz treść odpowiedzi i zwróć ją, aby móc jej użyć w aplikacji.
9. Przetestuj swoją funkcję
Teraz nadszedł czas, aby przetestować funkcję. Uruchom swój serwer lokalny i sprawdź, czy otrzymujesz odpowiedź od SI.
Screenshot_567
Powinieneś być w stanie otrzymać różne odpowiedzi, gdy zapytasz wielokrotnie, co dowodzi, że komunikacja z modelem działa.
Podsumowanie
W tym samouczku nauczyłeś się, jak przygotować się do korzystania z API OpenAI. Od generowania klucza API i instalacji wymaganej paczki npm, po tworzenie zapytania API i przetwarzanie odpowiedzi - przeszedłeś przez wszystkie podstawowe kroki.
Najczęstsze pytania
Czym jest klucz API?Klucz API to unikalny klucz, który daje Ci dostęp do API OpenAI.
Ile kredytów otrzymuję przy rejestracji?Zazwyczaj otrzymujesz kredyt w wysokości kilku dolarów (np. 5 dolarów), które możesz wykorzystać na żądania API.
Co zrobić, jeśli zgubię klucz API?Musisz wygenerować nowy klucz API poprzez ustawienia na platformie OpenAI.
Czy tokeny to to samo co słowa?Nie, tokeny mogą być częścią słowa, dlatego liczba tokenów jest zazwyczaj większa niż liczba słów w tekście.
Czy mogę używać API do celów komercyjnych?Tak, jednak zaleca się sprawdzenie aktualnych warunków korzystania z OpenAI.