Interfejs API obsługuje przepływy pracy związane z zarządzaniem kolekcjami i dokumentami, przetwarzaniem zawartości oraz stosowaniem funkcji SI, takich jak odpowiadanie na pytania, podsumowanie, wyszukiwanie i ekstrakcja strukturalna.Użyj tej strony, aby zrozumieć, jak te elementy współpracują ze sobą, a następnie skorzystaj z dokumentacji interfejsu API, aby uzyskać szczegóły implementacji na poziomie punktów końcowych.
Upewnij się, że masz:
Jeśli nie skonfigurowałeś dostępu do interfejsu API, zobacz Skonfiguruj dostęp do interfejsu API Knowledge Base.
Typowy obieg pracy interfejsu API Knowledge Base przebiega według tej sekwencji:
Uwierzytelnianie → Kolekcja → Dokument → Indeks → Wnioskowanie → Odpowiedź
Kolekcja definiuje domenę wiedzy, z którą pracuje aplikacja.Gdy tworzysz kolekcję, odpowiedź zawiera jej unikalną przestrzeń nazw, której używasz w kolejnych operacjach.
Na przykład:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Zachowaj przestrzeń nazw kolekcji w żądaniach dotyczących dokumentów i wnioskowania.
Dokumenty są przesyłane do kolekcji i otrzymują unikalne identyfikatory dokumentów.
Odpowiedź przesyłania identyfikuje dokument, dzięki czemu aplikacja może śledzić przetwarzanie i odwoływać się do niego w późniejszych żądaniach.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Przesyłanie dokumentu i jego indeksowanie to oddzielne etapy.
Przesyłanie pliku powoduje jego przeniesienie do Knowledge Base.Indeksowanie wyodrębnia jego zawartość i przetwarza tę zawartość do użytku przez operacje SI.
Aplikacja powinna potwierdzić, że przetwarzanie zostało ukończone przed przesłaniem żądań wnioskowania dotyczących dokumentu.
Operacje wnioskowania stosują możliwości SI Knowledge Base do przetworzonej zawartości.
Dostępne operacje obejmują:
Skorzystaj z dokumentacji API, aby określić punkt końcowy i schemat żądania dla operacji, którą chcesz wykonać.
Odpowiedzi wnioskowania zwracają wygenerowany wynik i mogą zawierać pomocne informacje o przypisaniu.
W zależności od operacji dane przypisania mogą identyfikować zawartość źródłową, stronę i współrzędne powiązane z wynikiem.Aplikacja określa sposób prezentowania tych informacji użytkownikowi.
Najprostszy obieg pracy aplikacji polega na utworzeniu kolekcji, dodaniu dokumentu, oczekiwaniu na przetwarzanie, a następnie uruchomieniu operacji wnioskowania.
Utwórz kolekcję, która będzie zawierać dokumenty źródłowe dla aplikacji.
Zachowaj przestrzeń nazw zwróconą w odpowiedzi:
collection_namespace = <returned-namespace>
Ta wartość zostanie użyta podczas dodawania dokumentów i wywoływania operacji w kolekcji.
Prześlij dokument do kolekcji i zachowaj zwrócony identyfikator dokumentu:
document_id = <returned-document-id>
Identyfikator dokumentu identyfikuje przesłany dokument niezależnie od nazwy pliku.
Uruchom wymaganą operację indeksowania, a następnie sprawdzaj status dokumentu do momentu zakończenia przetwarzania.
Nie zakładaj, że pomyślne przesłanie oznacza, że dokument jest gotowy do operacji SI.
Typowy przepływ aplikacji to:
Prześlij dokument
↓
Uruchom indeksowanie
↓
Sprawdź status przetwarzania
↓
Zakończ
Jeśli przetwarzanie nie powiedzie się, rozwiąż problem z przetwarzaniem dokumentów przed przesłaniem żądania wnioskowania.
Po zakończeniu przetwarzania prześlij przestrzeń nazw kolekcji, identyfikator dokumentu i wszelkie dane wejściowe specyficzne dla operacji wymagane przez punkt końcowy.
Na przykład żądanie odpowiedzi na pytanie w ujęciu koncepcyjnym obejmuje:
Kolekcja: <collection-namespace>
Dokument: <document-id>
Pytanie: Jakie są kluczowe ustalenia?
Użyj dokumentacji interfejsu API, aby zapoznać się z rzeczywistym schematem żądania.
Użyj zwróconej odpowiedzi lub wyodrębnionych danych w aplikacji.
Jeśli odpowiedź zawiera informacje o atrybucji, można ich użyć do połączenia wygenerowanych informacji z odpowiednią zawartością dokumentu źródłowego.
Cykl życia dokumentu wpływa na to, kiedy aplikacja może używać przesłanej zawartości.
| Etap | Co się dzieje | Działanie aplikacji |
|---|---|---|
| Przekaż | Plik zostaje dodany do Knowledge Base i otrzymuje identyfikator dokumentu. | Zachowaj identyfikator dokumentu. |
| Indeksowanie | Zawartość jest wyodrębniana i przetwarzana do użycia przez SI. | Monitoruj status dokumentu. |
| Zakończ | Przetworzona zawartość jest dostępna do wnioskowania. | Prześlij żądania SI. |
| Niepowodzenie | Przetwarzanie nie zostało ukończone pomyślnie. | Usuń przyczynę błędu przed kontynuowaniem. |
To rozróżnienie jest szczególnie ważne w zautomatyzowanych obiegach pracy.Aplikacja powinna sprawdzić status przetwarzania zamiast natychmiastowego wysyłania żądania wnioskowania po przesłaniu.
Wybierz operację na podstawie tego, co aplikacja musi zrobić z zawartością źródłową.
Użyj funkcji Pytania i odpowiedzi do przesyłania pytań w języku naturalnym na temat zawartości kolekcji lub dokumentu.
Interfejs API zapewnia funkcję pytań i odpowiedzi zarówno w trybie strumieniowym, jak i niestrumieniowym.
Funkcja Pytania i odpowiedzi w trybie strumieniowym zwraca odpowiedź stopniowo podczas generowania. Używaj jej, gdy interfejs użytkownika powinien wyświetlać generowaną zawartość progresywnie.
Funkcja Pytania i odpowiedzi w trybie strumieniowym obsługuje także sterowanie tym, czy instrukcje niestandardowe są stosowane w żądaniu. Można także sterować tym, czy rozumowanie jest generowane dla odpowiedzi funkcji Pytania i odpowiedzi w trybie strumieniowym.
Funkcja Pytania i odpowiedzi w trybie niestrumieniowym czeka na ukończenie generowania i zwraca gotową odpowiedź. Używaj jej, gdy aplikacja nie musi wyświetlać częściowych wyników.
Użyj funkcji podsumowania do wygenerowania skondensowanej reprezentacji zawartości dokumentu.
Dokumentacja interfejsu API określa bieżące wymagania dotyczące żądań i obsługiwane dane wejściowe.
Użyj wyszukiwania kontekstowego do pobierania zawartości istotnej dla określonego tekstu wyszukiwania.
Może to pomóc aplikacjom w identyfikacji istotnego materiału źródłowego bez generowania odpowiedzi konwersacyjnej.
Użyj wyodrębniania, gdy aplikacja potrzebuje ustrukturyzowanych wartości z zawartości dokumentu.
Definicja wyodrębniania może identyfikować informacje, takie jak:
Nazwa właściwości: contract_value
Typ: integer
Opis: Wartość umowy
Polecenie: Wyodrębnij największą wartość umowy w dolarach.
Zwrócony wynik może zawierać wyodrębnioną wartość, informacje o pewności i atrybucję źródła.
Interfejs API zapewnia kilka sposobów określania, która zawartość uczestniczy w żądaniu.
Użyj identyfikatorów kolekcji i dokumentów do zdefiniowania głównej zawartości dostępnej dla operacji.
Tagi są powiązane z dokumentami, a nie z kolekcjami.
Tagi dokumentów są dostępne tylko za pośrednictwem interfejsu API Knowledge Base i nie są widoczne w standardowym interfejsie użytkownika.
Można użyć tagów z obsługiwanymi operacjami, aby filtrować dokumenty uwzględniane w żądaniu.Na przykład aplikacja może oznaczyć grupę dokumentów jako dokumenty finansowe i ograniczyć pytanie do dokumentów z tym tagiem.
Załączniki są oddzielone od dokumentów kolekcji.
Dodanie załącznika do rozmowy nie powoduje dodania tego pliku do kolekcji. Załącznik może nadal dostarczać kontekst do wygenerowanej odpowiedzi, wraz z zawartością kolekcji i historią czatu.
Używaj punktów końcowych załączników, gdy aplikacja potrzebuje tymczasowej lub specyficznej dla konwersacji zawartości bez trwałego dodawania jej do kolekcji.
Odpowiedzi wnioskowania mogą zawierać informacje o atrybucji, które łączą wygenerowane dane wyjściowe z obsługującą zawartością źródłową.
Dane atrybucji mogą obejmować informacje takie jak:
Interfejs API dostarcza te informacje jako dane. Twoja aplikacja jest odpowiedzialna za decydowanie o sposobie ich prezentacji.
Na przykład aplikacja może użyć zwróconych współrzędnych do utworzenia interfejsu wyróżniania źródła, który identyfikuje lokalizację wspierającą wygenerowaną odpowiedź.
Operacje API używają uprawnień dostępnych dla uwierzytelnionej tożsamości.
Żądanie może zakończyć się niepowodzeniem, jeśli uwierzytelniona tożsamość nie ma dostępu do żądanej kolekcji, dokumentu lub operacji.
Podczas rozwiązywania problemów:
X-Request-ID identyfikuje żądanie w usługach Knowledge Base i może pomóc zespołowi pomocy technicznej w zbadaniu nieudanego żądania.
Korzystaj z wersji demonstracyjnej Python, gdy potrzebujesz działających przykładów pokazujących te koncepcje w aplikacji.
Rozpocznij pracę z demonstracją Python Knowledge Base
Korzystaj z dokumentacji interfejsu API, gdy jesteś gotowy do wdrożenia określonej operacji.
