Specyfikacja API

Wyślij pierwsze żądanie, wybierz model z katalogu i zachowaj identyfikator żądania do diagnostyki.

Wyślij klucz API w nagłówku Bearer i przechowuj produkcyjne dane uwierzytelniające oddzielnie od deweloperskich.

Używaj różnych bazowych adresów URL dla klientów w stylu OpenAI i Messages: korzystają z jednej specyfikacji, ale inaczej tworzą ścieżki.

Skonfiguruj klienta z kluczem, modelem i bazowym adresem URL zgodnym z jego protokołem; przechowuj sekret w środowisku.

Krótkie, praktyczne odpowiedzi dotyczące kluczy, bazowych adresów URL, modeli, kosztów i diagnostyki integracji.

Twórz wybór modelu na podstawie danych katalogu, zamiast zakodowanej na stałe listy w aplikacji.

Rozdziel klucze, właścicieli, budżety i ślady wykorzystania między aplikacjami oraz przestrzeniami roboczymi.

Traktuj ograniczenia klucza, organizacji, modelu i routingu jako część procesu użytkownika.

Powiąż metadane odpowiedzi i własne dzienniki żądań z rzeczywistymi działaniami użytkowników.

Minimalizuj przesyłane dane, oddziel identyfikator użytkownika końcowego od treści i kontroluj przechowywanie w swoim produkcie.

Twórz wieloetapowe rozmowy w znanym formacie messages i wybieraj model dla każdego żądania.

Używaj formatu Messages do rozmów z instrukcją systemową na najwyższym poziomie żądania i jawnym limitem danych wyjściowych.

Użyj jednego obiektu wejściowego, jeśli Twoja aplikacja korzysta na obsłudze elementów wyjściowych i działań w jednym modelu danych.

Odbieraj tokeny i ustrukturyzowane fragmenty przez SSE bez czekania na pełną odpowiedź.

Opisuj funkcje za pomocą JSON Schema, wykonuj wywołanie w aplikacji i zwracaj wynik do rozmowy.

Poproś o obiekt JSON lub schemat JSON, gdy odpowiedź będzie przetwarzana przez oprogramowanie, a nie przez człowieka.

Ustawiaj poziom namysłu dla poszczególnych żądań tylko w modelach, które deklarują taką możliwość.

Wyraź wymagania dotyczące realizacji w preferencjach dostawcy i zachowaj faktyczny wynik na potrzeby obserwowalności.

Oddziel powtarzalny kontekst, aby klient mógł korzystać ze zgodnego buforowania tam, gdzie obsługuje je wybrany model.

Pobieraj aktualne źródła przez wykonywaną po stronie klienta funkcję `web_search` i przechowuj łącza oddzielnie od wygenerowanego tekstu.

Prześlij plik za pomocą osobnej operacji, zachowaj jego identyfikator, a następnie przekaż odwołanie w późniejszym zgodnym żądaniu.

Twórz obrazy za pomocą jednej ścieżki i wybieraj parametry spośród możliwości wybranego modelu.

Uruchamiaj tworzenie filmu jako zadanie asynchroniczne, zachowuj jego identyfikator i oddzielaj tworzenie od odczytu wyniku.

Używaj oddzielnych operacji do syntezy mowy, transkrypcji i wejścia audio modelu.

Przekształcaj tekst lub obsługiwane dane wejściowe w wektory do wyszukiwania, grupowania i rekomendacji.

Uporządkuj niewielki zbiór kandydatów względem zapytania, aby zwiększyć precyzję końcowego wyszukiwania informacji.

Przetwarzaj niezależne operacje w kontrolowanych grupach, gdy proces pozwala na dostarczanie asynchroniczne.

Połącz klienta AI z dozwolonymi narzędziami, zasobami i poleceniami za pomocą adresu URL połączenia wydanego w ustawieniach konta.

Obsługę oprzyj na statusie HTTP, ustrukturyzowanej treści błędu i identyfikatorze żądania, a nie na tekście komunikatu.