Ten przykład zawiera funkcję publikowania interfejsów API. Chociaż interfejs czatu może być wygodny do wstępnej weryfikacji, rzeczywista implementacja zależy od konkretnego przypadku użycia oraz pożądanego doświadczenia użytkownika (UX). W niektórych scenariuszach interfejs czatu może być preferowanym wyborem, podczas gdy w innych bardziej odpowiedni może być samodzielny interfejs API. Po wstępnej walidacji, ten przykład zapewnia możliwość publikowania dostosowanych botów zgodnie z potrzebami projektu. Wprowadzając ustawienia dotyczące limitów, ograniczania przepustowości, źródeł itp., można opublikować endpoint wraz z kluczem API, oferując elastyczność dla różnych opcji integracji.
Używanie tylko klucza API nie jest zalecane, zgodnie z opisem w: Przewodniku dla deweloperów AWS API Gateway. W konsekwencji ten przykład implementuje prostą restrickcję adresów IP za pomocą AWS WAF. Reguła WAF jest stosowana wspólnie dla całej aplikacji ze względów kosztowych, przy założeniu, że źródła, które chce się ograniczyć, są prawdopodobnie takie same we wszystkich wydanych interfejsach API. Proszę przestrzegać polityki bezpieczeństwa własnej organizacji podczas rzeczywistej implementacji. Zapoznaj się również z sekcją Architektura.
Ze względów zarządzania, tylko ograniczona liczba użytkowników może publikować boty. Przed publikacją użytkownik musi być członkiem grupy o nazwie PublishAllowed, którą można skonfigurować za pośrednictwem konsoli zarządzania > Amazon Cognito User pools lub aws cli. Należy pamiętać, że identyfikator puli użytkowników można znaleźć, uzyskując dostęp do CloudFormation > BedrockChatStack > Outputs > AuthUserPoolIdxxxx.
Po zalogowaniu się jako użytkownik PublishedAllowed i utworzeniu bota, wybierz API PublishSettings. Należy pamiętać, że opublikować można tylko wspólnego bota.
Na następnym ekranie można skonfigurować kilka parametrów dotyczących ograniczania przepustowości. Aby uzyskać więcej szczegółów, zapoznaj się z: Ograniczanie żądań API w celu zwiększenia przepustowości.
Po wdrożeniu pojawi się następujący ekran, na którym można uzyskać adres URL punktu końcowego i klucz API. Można również dodawać i usuwać klucze API.
Interfejs API jest publikowany zgodnie z poniższym diagramem:
WAF jest używany do ograniczania adresów IP. Adresy można skonfigurować, ustawiając parametry publishedApiAllowedIpV4AddressRanges i publishedApiAllowedIpV6AddressRanges w pliku cdk.json.
Kiedy użytkownik kliknie publikację bota, AWS CodeBuild uruchamia zadanie wdrożenia CDK w celu udostępnienia stosu API (patrz również: definicja CDK), który zawiera API Gateway, Lambda i SQS. SQS służy do rozdzielenia żądania użytkownika i operacji LLM, ponieważ generowanie wyniku może przekroczyć 30 sekund, co jest limitem API Gateway. Aby pobrać wynik, należy uzyskać dostęp do API asynchronicznie. Więcej szczegółów znajduje się w Specyfikacji API.
Klient musi ustawić x-api-key w nagłówku żądania.
Sprawdź tutaj.