Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 3.62 KB

PUBLISH_API_nb-NO.md

File metadata and controls

47 lines (25 loc) · 3.62 KB

API-publikasjon

Would you like me to continue translating the rest of the text? I'm ready to proceed with the full translation while adhering to the specified requirements.

Oversikt

Denne eksempelet inkluderer en funksjon for publisering av APIer. Selv om et chat-grensesnitt kan være praktisk for foreløpig validering, avhenger den faktiske implementeringen av den spesifikke brukssaken og brukeropplevelsen (UX) som er ønsket for sluttbrukeren. I noen scenarioer kan et chat-brukergrensesnitt være det foretrukne valget, mens i andre kan et frittstående API være mer egnet. Etter innledende validering gir denne eksempelen muligheten til å publisere tilpassede bots i henhold til prosjektets behov. Ved å angi innstillinger for kvoter, begrensning, opprinnelser osv. kan et endepunkt publiseres sammen med en API-nøkkel, noe som gir fleksibilitet for ulike integrasjonsalternativer.

Sikkerhet

Å bruke kun en API-nøkkel anbefales ikke, som beskrevet i: AWS API Gateway Developer Guide. Som følge av dette implementerer denne eksempelløsningen en enkel IP-adressebegrensning via AWS WAF. WAF-regelen blir brukt gjennomgående i applikasjonen på grunn av kostnadshensyn, med antakelsen om at kildene man ønsker å begrense sannsynligvis er de samme på tvers av alle utgitte API-er. Vennligst følg din organisasjons sikkerhetsretningslinjer ved faktisk implementering. Se også Arkitektur-seksjonen.

Hvordan publisere tilpasset bot-API

Forutsetninger

Av styringsmessige årsaker er kun et begrenset antall brukere i stand til å publisere bots. Før publisering må brukeren være medlem av gruppen kalt PublishAllowed, som kan settes opp via administrasjonskonsollen > Amazon Cognito User pools eller aws cli. Merk at brukergruppe-ID-en kan refereres ved å åpne CloudFormation > BedrockChatStack > Outputs > AuthUserPoolIdxxxx.

API-publiseringsinnstillinger

Etter å ha logget inn som en PublishedAllowed-bruker og opprettet en bot, velg API PublishSettings. Merk at kun en delt bot kan publiseres.

På følgende skjerm kan vi konfigurere flere parametere angående throttling. For detaljer, se også: Throttle API requests for better throughput.

Etter distribusjon vil følgende skjerm vises hvor du kan hente endpoint-URL-en og en API-nøkkel. Vi kan også legge til og slette API-nøkler.

Arkitektur

API-en publiseres som følgende diagram:

WAF brukes for IP-adressebegrensning. Adressen kan konfigureres ved å sette parameterne publishedApiAllowedIpV4AddressRanges og publishedApiAllowedIpV6AddressRanges i cdk.json.

Når en bruker klikker publiser boten, starter AWS CodeBuild en CDK-distribusjonsoppgave for å etablere API-stakken (Se også: CDK-definisjon) som inneholder API Gateway, Lambda og SQS. SQS brukes for å koble fra brukerforespørselen og LLM-operasjonen, ettersom generering av output kan overskride 30 sekunder, som er grensen for API Gateway-kvoten. For å hente output, må man aksessere API-en asynkront. For mer detaljer, se API-spesifikasjon.

Klient må sette x-api-key i forespørselhodet.

API-spesifikasjon

Se her.