Pierwsze kroki z interfejsem Perspective API

Pierwsze kroki z interfejsem Perspective API

Informacje o tym ćwiczeniu (w Codelabs)

Ostatnia aktualizacja: mar 10, 2022

Autorzy: Jigsaw

1. Zanim zaczniesz

Perspektywiczny interfejs API to bezpłatny interfejs API, który ułatwia prowadzenie lepszych rozmów online. Interfejs ten korzysta z systemów uczących się do analizowania ciągów tekstowych i przewidywania ich wpływu na rozmowę.

W tym ćwiczeniu skonfigurujesz interfejs Perspective API.

Uwaga: interfejs Perspektyw API ma ułatwiać moderację treści. Artykuł nie ma na celu całkowicie zastąpienia pracy osób podejmujących decyzje.

Czego się nauczysz

• Podejście wspomagane przez sztuczną inteligencję, które oznacza treści w momencie ich utworzenia.

Czego potrzebujesz

• konto Google zapewniające dostęp do Google Cloud.
• Przyzwoity internet

2. Rozpocznij

Na początek potrzebujesz projektu Google Cloud do uwierzytelniania żądań do interfejsu API.

1. Użyj istniejącego projektu w Google Cloud Console.
2. W razie potrzeby wykonaj te czynności, by utworzyć nowy projekt:

• Zaloguj się na swoje konto Google.
• Otwórz Cloud Console.
• Kliknij Utwórz projekt lub otwórz menu Wybierz projekt, a potem w oknie kliknij Nowy projekt.
• Nazwij swój projekt i kliknij Utwórz.

Projekt pojawi się w menu.

Poproś o dostęp do interfejsu API

• Aby poprosić o dostęp do interfejsu API, wypełnij ten formularz.

W ciągu godziny otrzymasz e-maila z potwierdzeniem, że możesz wyświetlić i włączyć interfejs API w Google Cloud.

Uwaga: jeśli nie otrzymasz e-maila w ciągu 1 dnia roboczego, ponownie wypełnij formularz lub skontaktuj się z zespołem pomocy.

3. Włączanie interfejsu API

• W Cloud Console otwórz stronę Perspektywnego interfejsu API – przegląd i kliknij Włącz.

4. Generowanie klucza interfejsu API

1. W menu nawigacyjnym kliknij APIs & Services > Credentials > Create credentials > API Key (Interfejsy API > Dane logowania > Utwórz dane logowania).

Uwaga: jeśli wysyłasz żądania z języka po stronie klienta, np. JavaScriptu, Twój klucz interfejsu API jest widoczny dla wszystkich użytkowników. Zdecydowanie zalecamy przekazanie żądania przez serwer proxy za pomocą serwera i zastosowanie ograniczeń dotyczących klucza, tak aby klucz nie był widoczny w przeglądarkach i jedynie serwer mógł z niego korzystać. Aby dowiedzieć się więcej, zobacz przykład serwera proxy jako serwer proxy i więcej zaleceń dotyczących bezpieczeństwa klucza interfejsu API.

Klucz interfejsu API powinien zacząć działać w ciągu kilku minut, ale może to potrwać do godziny. Do tego czasu może się pojawić komunikat o błędzie.

2. Skopiuj klucz interfejsu API.

5. Przykładowe zapytania

Biblioteki klienta API możesz generować za pomocą bibliotek klienta interfejsu API Google. Te przykłady pokazują, jak skonfigurować bibliotekę interfejsu API w przypadku najpopularniejszych języków.

1. Wyślij prośbę o AnalyzeComment.
2. Uruchom jedno z tych przykładowych wywołań interfejsu API, aby uzyskać wyniki bezpośrednio z interfejsu Perspective API.

Metoda AnalyzeComment wysyła żądanie interfejsu API do analizy pola comment.text dla requestedAttributes. W tym przypadku jest to model TOXICITY.

3. Wklej klucz interfejsu API w polu API_KEY.

Możesz też użyć flagi doNotStore, aby mieć pewność, że po zwróceniu wyników wszystkie przesłane komentarze zostaną automatycznie usunięte.

4. Przeczytaj dokumentację referencyjną interfejsu API, by dowiedzieć się więcej o wszystkich polach żądania i odpowiedzi oraz dostępnych wartościach atrybutu requestedAttributes.

Możesz też korzystać z atrybutów eksperymentalnych, takich jak OBSCENE, ATTACK_ON_tutorial i SPAM.

Python

To przykładowe żądanie i odpowiedź używa wersji Pythona bibliotek klienta interfejsu API Google.

1. Zainstaluj bibliotekę klienta dla języka Python.
2. Uruchom te polecenia:

Wyniki powinny wyglądać mniej więcej tak:

Twoje powitanie otrzymało niski wynik toksyczności.

Node.js

To przykładowe żądanie i odpowiedź używa wersji Node.js bibliotek klienta interfejsu API Google.

1. Zainstaluj bibliotekę klienta Node.js lub zainstaluj pakiet npm googleapis.
2. Uruchom te polecenia:

Wyniki powinny wyglądać mniej więcej tak:

cURL

To przykładowe żądanie i odpowiedź używają polecenia cURL. To polecenie powinno działać w przypadku większości użytkowników systemów MacOS i Linux. Do uruchomienia tego polecenia może być konieczne zainstalowanie programu cURL.

• Zastąp YOUR_KEY_HERE kluczem interfejsu API.

W tej odpowiedzi pole attributeScores.TOXICITY.summaryScore.value podaje wynik działania modelu toksyczności dla danego komentarza. Ocena uzyskała 0,9 na 1,0.

6. Gratulacje

Masz włączony interfejs Perspective API.

Więcej informacji

• Więcej informacji o interfejsie API, w tym studia przypadków, znajdziesz na stronie Perspective API.
• Więcej informacji o atrybutach, językach i metodach znajdziesz na stronie dla programistów Perspective API. Jeśli chcesz szybko rozpocząć, na stronie Metody opisaliśmy sposoby użycia metod AnalyzeComment i SuggestCommentScore.