Tworzenie narzędzia (wersja beta)

Funkcje w wersji beta. Tworzenie od zera w pełni niestandardowych narzędzi jest w otwartej wersji beta i jest dostępne dla wszystkich użytkowników Customer Agent konto – nie jest wymagana rejestracja. Stronę Narzędzia znajdziesz w Customer Agent. Nadal trwa rozwijanie funkcji, ponieważ może ulec zmianie.

Czego się dowiesz?

Jak dotrzeć do klienta HTTP z dowolnym punktem końcowym, jak napisać opis narzędzia, który faktycznie wykorzysta Customer Agent, i przetestować działanie narzędzia, zanim dołączy do niego umiejętność.

Kilka słów na początek

Potrzebne będą:

• Włączono funkcję Customer Agent
• HTTP punkt końcowy, do którego dzwonił Agent klienta – taki, który dziś nie wymaga tajnych danych uwierzytelniających (interfejs API Kluczy na okaziciela itp.).
• Umiejętność, do której można dołączyć to narzędzie – albo umiejętność Customer Agent, z którą korzystasz, albo w pełni niestandardowa umiejętność opracowana przez Ciebie

Jeśli nie masz jeszcze skonfigurowanej umiejętności, najpierw ją utwórz. Narzędzia same z nich nic nie robią – muszą być powiązane z umiejętnością.

Ostrzeżenie: już wkrótce będzie dostępne bezpieczne przechowywanie dla API klucz i innych sekretów. Do tego czasu nie należy umieszczać interfejsu API klucz, tokenów okaziciela ani innych poufnych danych uwierzytelniających do w pełni niestandardowych narzędzi – konfiguracja narzędzia nie jest jeszcze bezpiecznym miejscem do ich przechowywania. Obecnie należy korzystać tylko z narzędzi, których zamknięcie nie jest już opatrzone tajemnicą autora (np. narzędzia te znajdują się na liście dozwolonych odbiorców lub finalnej, który akceptuje identyfikatory, które nie są poufne). Przygotowanie do weryfikacji dla uwierzytelnionego 1 kończy się.

Czym jest w pełni niestandardowe narzędzie

W pełni niestandardowym narzędziem jest żądanie HTTP, które Customer Agent może przesłać podczas konwersacji. Tworzenie w pełni niestandardowych narzędzi jest w otwartej wersji beta i jest dostępne dla wszystkich Customer Agent konto. Użyj go, gdy narzędzia Customer Agent nie obejmują tego, czego potrzebujesz – na przykład wyszukanie zamówienia we własnym systemie zarządzania zamówieniami zamiast w Shopify, sprawdzenie stanu magazynowego w niestandardowym systemie magazynowym lub utworzenie zgłoszenia w helpdesku Klaviyo z którym nie ma natywnej integracji.

Więcej na ten temat w artykule Informacje o narzędziach Customer Agent.

Kiedy w pełni niestandardowe narzędzie należy tworzyć?

Sięgnij po w pełni spersonalizowane narzędzie, gdy:

• Potrzebujesz danych w czasie rzeczywistym z systemu, z którym Klaviyo nie ma zintegrowanej integracji
• Chcesz, aby Customer Agent wykonał działanie w systemie zewnętrznym (anulował subskrypcję w swoim systemie, utworzył zgłoszenie, zaktualizował rekord)
• Istniejące narzędzie nie pasuje – na przykład do zamówień używasz niestandardowego OMS zamiast Shopify

Jeśli informacje nie zmieniają się często i są takie same dla każdego klienta, dodaj je jako treść. Narzędzia przeznaczone są do dynamicznych danych i działań dotyczących poszczególnych klientów i klientek.

Skonfiguruj it

1. Otwórz stronę Narzędzia

Przejdź do Customer Agent > Narzędzia, a następnie kliknij przycisk Utwórz narzędzie.

2. Nazwij i opisz narzędzie

• Nazwa – skrócony identyfikator, taki jak „Wybierz stan magazynowy” lub „Utwórz zgłoszenie powrotne”.
• Opis – w języku naturalnym wyjaśnia, do czego służy narzędzie i kiedy go używać. Customer Agent czyta ten opis, aby zdecydować, czy użyć narzędzia do danego zgłoszenia. Bądź konkretny.

Przykładowy opis:

Pobiera z systemu magazynowego dane o stanie zapasów w czasie rzeczywistym dla danego produktu. Używaj, gdy kupujący pyta, czy dany produkt jest dostępny.

Niejasny przykładowy opis (unikaj):

Pobiera informacje o produkcie.

3. Skonfiguruj żądanie HTTP

• Metoda – GET, POST, PUT, DELETE lub PATCH.
• URL – Pełny punkt końcowy URL. W przypadku wartości dynamicznych można uwzględnić symbole zastępcze (patrz: Krok 5).
• Nagłówki — Wszelkie nagłówki wymagane przez punkt końcowy, w tym Content-Type i nagłówki uwierzytelniania.

4. Skonfiguruj treść żądania (dla POST, PUT, PATCH)

Podaj treść JSON. Dla wartości, które Customer Agent powinien wpisać w środowisku wykonawczym, użyj symboli zastępczych.

Przykładowa treść:

{
"customer_id": "{{profile_id}}",
"sku": "{{product_sku}}"
}

5. Wartości dynamicznych używaj symboli zastępczych

Customer Agent może wpisywać wartości w środowisku wykonawczym za pomocą symboli zastępczych. Typowe symbole zastępcze:

• {{profile_id}} — Identyfikator profilu Klaviyo klienta w konwersacji
• {{conversation_id}} — Bieżący identyfikator konwersacji
• Dowolny parametr zdefiniowany w schemacie wejściowym (np. {{product_sku}}, {{order_id}})

Symbole zastępcze działają w adresie URL, nagłówkach i treści.

6. Uwierzytelnianie

Dla użytkowników uwierzytelnionych udostępnimy pomoc techniczną dla osób, które już wkrótce będą gotowe. Do tego czasu nie należy umieszczać w pełni niestandardowego narzędzia API klucz, tokenów okaziciela ani innych sekretów. Inaczej jest w przypadku osób bez tajnych danych uwierzytelniających. Obejmują one osoby znajdujące się na liście „dopuszczalnej” na liście IP lub osoby publiczne, które akceptują identyfikatory, które nie są poufne.

Bezpieczne tajne przechowywanie jest już wkrótce gotowe.

7. Przetestuj narzędzie

Kliknij Narzędzie testowe. Podaj przykładowe wartości dla dowolnych parametrów wejściowych. Sprawdź, czy:

• Odpowiedź wróciła pomyślnie
• Format odpowiedzi jest taki, jakiego oczekuje Customer Agent
• Wszelkie przypadki błędów są obsługiwane

8. Zapisz i dołącz do umiejętności

Kliknij Zapisz. Aby Customer Agent faktycznie korzystał z tego narzędzia, otwórz umiejętność, której chcesz użyć, i dodaj tam narzędzie.

Tworzenie dobrego opisu narzędzia

Opis jest najważniejszym polem. Customer Agent wybiera narzędzie w oparciu o opis – nie nazwę. Dobre opisy:

• Powiedz jednym zdaniem do czego służy narzędzie
• Jednym zdaniem powiedz, kiedy użyć
• Konkretnie odnoszą się do zwróconych danych lub podjętych działań

Nieprawidłowe opisy są niejasne („Pobiera informacje o klientach”), zbyt szerokie („Obsługuje wszystko, co związane z zamówieniami”) lub instruują Customer Agent, jak się zachowywać, a nie to, co robi narzędzie.

Względy bezpieczeństwa

• Nie używaj w pełni niestandardowych narzędzi, które wymagają jeszcze tajnych danych uwierzytelniających. Dla użytkowników uwierzytelnionych udostępnimy pomoc techniczną dla osób, które już wkrótce będą gotowe. Do czasu wysyłki telefonu korzystaj tylko z punktu, w którym telefon nie ma poufnego upoważnienia.
• Jeśli to możliwe, używaj białej listy IP. Jeśli Twój punkt końcowy jest wewnętrznym punktem końcowym, ogranicz dostęp do zakresów adresów IP Klaviyo zamiast polegać na kluczach tajnych.
• Miej świadomość tego, jakie dane wysyłasz. Customer Agent przekazuje dane klienta do narzędzia na podstawie informacji zawartych w instrukcjach umiejętności. Sprawdź, jakie pola otrzymuje Twój punkt końcowy.
• Limity szybkości. Jeśli Twój punkt końcowy ma limity szybkości, upewnij się, że są wystarczająco wysokie, aby obsłużyć oczekiwaną liczbę konwersacji.

Rozwiązywanie problemów

Objaw: Customer Agent nigdy nie używa tego narzędzia.
Prawdopodobna przyczyna: opis jest zbyt niejasny lub narzędzie nie jest powiązane z umiejętnością, która by go używała.
Porada: przepisz opis na nowo, tak aby dokładnie opisywać, kiedy należy go użyć. Potwierdź, że narzędzie pojawi się na liście narzędzi umiejętności.

Objaw: Narzędzie zwraca błąd podczas testowania.
Prawdopodobna przyczyna: zły adres URL, nieprawidłowa treść lub banał – na nic nie można pozwolić.
Poprawka: użyj narzędzia testowego, aby sprawdzić nieprzetworzone żądanie i odpowiedź. Zweryfikuj format adresu URL i treści pod kątem oczekiwanych danych wejściowych.

Objaw: Customer Agent korzysta z narzędzia, ale przekazuje nieprawidłowe parametry.
Prawdopodobna przyczyna: nazwy symboli zastępczych nie pasują do schematu lub w instrukcjach dotyczących umiejętności niejasno zależy od tego, co przekazywać.
Poprawka: sprawdź, czy nazwy symboli zastępczych są dokładnie takie same. Zaktualizuj instrukcje dotyczące umiejętności, aby jednoznacznie określić, kiedy używać narzędzia i jakie należy podać parametry.

Objaw: narzędzie działa wolno, co powoduje opóźnienia w odpowiedziach.
Prawdopodobnaprzyczyna: końcowy czas oczekiwania.
Poprawka: zoptymalizuj punkt końcowy. Sprawdź, czy możesz buforować wyniki po swojej stronie.

Najczęściej zadawane pytania

Czy jedno narzędzie może być używane przez wiele umiejętności?
Tak. Po utworzeniu narzędzie można przypisać do dowolnej liczby umiejętności.

Jakie metody uwierzytelniania są obsługiwane?
Dla użytkowników uwierzytelnionych udostępnimy pomoc techniczną dla osób, które już wkrótce będą gotowe. W obecnej chwili skończą się na przykładami tradycyjnymi, które nie wymagają tajnych danych uwierzytelniających (wyróżniające się na liście IP lub osoby publiczne mają identyfikatory niewrażliwe na zagrożenia).

Co się stanie, jeśli mój punkt końcowy przestanie działać lub zwróci błąd?
Nie utworzono jeszcze obsługi błędów w przypadku w pełni niestandardowych narzędzi. Jeśli Twój punkt końcowy ulegnie awarii, Customer Agent może udzielić odpowiedzi nieprawidłowej lub niejasnej. Punktu końcowym to na pewno Ci się to spodoba – i dokładnie obserwuj zachowanie narzędzia.

Czy mogę edytować utworzone narzędzie?
Tak. Nazwę, opis, konfigurację i dołączone umiejętności można edytować w dowolnym momencie.

Czy mogę sprawdzić
wersję narzędzia? Obsługa wersji nie jest jeszcze obsługiwana. Zmiany wprowadzone do narzędzia są natychmiast widoczne dla wszystkich umiejętności, które z niego korzystają.

Additional resources