Jak przygotować pliki wsadowe do bazy wiedzy?

Artykuł opisuje, jak prawidłowo przygotować pliki wsadowe do wykorzystania w bazie wiedzy asystenta AI w Welyo. Dobrze zaprojektowana struktura dokumentów zwiększa trafność wyszukiwania informacji oraz minimalizuje ryzyko przekazywania nieaktualnych lub nieprecyzyjnych danych. W tekście przedstawiono najważniejsze zasady dotyczące struktury dokumentów, formatowania treści oraz sposobu organizacji informacji. Dzięki nim baza wiedzy staje się bardziej czytelna i skuteczniejsza w działaniu.

Jak przygotować pliki do bazy wiedzy?

W bazie wiedzy Welyo dla asystenta AI obsługiwane są formaty:  .txt, .pdf

Struktura dokumentu

Dokumenty w bazie wiedzy powinny mieć czytelną strukturę. Informacje są wyszukiwane we fragmentach tekstu, dlatego dobrze zorganizowany dokument zwiększa trafność wyników.

Zalecana struktura:

Tytuł dokumentu  
Abstrakt / krótkie streszczenie (2–4 zdania) 
 1. Sekcja główna 
1.1 Podsekcja 
1.2 Podsekcja  
2. Kolejna sekcja  
Podsumowanie (opcjonalnie)
FAQ

Jedna koncepcja na sekcję

Każda sekcja powinna dotyczyć jednego tematu lub odpowiadać na jedno pytanie.

Nie należy łączyć wielu niezależnych zagadnień w jednym fragmencie.

Przykład:

• Niezalecane:

• Polecane:

Dzięki temu asystent łatwiej znajdzie właściwy fragment podczas wyszukiwania.

Opisowe nagłówki

Nagłówki powinny zawierać konkretne słowa kluczowe.

Zamiast nadać nagłówek "Konfiguracja"  lepiej zadziała:  "Konfiguracja integracji API z CRM".

Krótkie i informacyjne akapity

Najlepiej sprawdzają się akapity skupione na jednej informacji.

Bardzo długie bloki tekstu utrudniają skuteczne wyszukiwanie informacji.

Format pytań i odpowiedzi

Struktura pytanie–odpowiedź działa bardzo dobrze w dokumentach przygotowywanych dla asystenta AI. Taki sposób zapisu ułatwia agentowi odnalezienie fragmentu, który bezpośrednio odpowiada na pytanie użytkownika.

Przykład:

Sekcja: Jak skonfigurować integrację z CRM?
Aby skonfigurować integrację z CRM należy:
1. Utworzyć klucz API
2. Skonfigurować endpoint
3. Włączyć synchronizację

Ponieważ użytkownicy najczęściej zadają pytania w naturalnej formie, struktura pytanie – odpowiedź zwiększa prawdopodobieństwo szybkiego odnalezienia właściwego fragmentu dokumentacji przez agenta AI.

Listy zamiast długich opisów

Zamiast długiego opisu tekstowego procesu, który zawiera wiele etapów, lepiej przygotować jest opis tego procesu w formie listy/ kroków.

Przykład:

Polecamy:

Zamiast:

Listy poprawiają czytelność i ułatwiają indeksowanie treści.

Unikanie odniesień kontekstowych

Fragment dokumentu może zostać pobrany przez system bez całego kontekstu. Dlatego warto unikać sformułowań takich jak:

Lepszym podejściem będzie sformułowanie:

Wyjaśnianie używanych skrótów

Zasilając bazę wiedzy, dobrze jest wyjaśnić skróty jakie są zastosowane w dokumentach, można to zrobić w ramach osobnej sekcji w dokumencie lub przy użyciu skrótu w dokumencie.

Przykład:

Zasilając bazę wiedzy dla systemu RAG (Retrieval-Augmented Generation), warto wyjaśniać skróty używane w dokumentach. Można to zrobić w osobnej sekcji dokumentu lub przy pierwszym użyciu skrótu w treści.

Opisywanie obrazów i diagramów

Jeśli dokument zawiera obrazy lub diagramy, powinny one mieć krótki opis tekstowy.

Przykład:

Formatowanie

Najlepiej działają dokumenty zawierające:

• zwykły tekst
• nagłówki
• listy

Należy unikać:

• złożonych układów graficznych
• tekstu w obrazach
• skomplikowanego layoutu dokumentu

Powtarzanie kluczowych pojęć

Ważne terminy powinny pojawiać się w dokumencie wprost i w spójnej formie. Pomaga to systemowi łatwiej odnaleźć właściwe informacje podczas wyszukiwania.

Jeżeli dokument dotyczy na przykład bazy wiedzy, warto używać tego określenia w kilku miejscach w tekście zamiast zastępować je wyłącznie synonimami, takimi jak „repozytorium informacji” czy „zbiór dokumentacji”.

Metadane dokumentu

Na początku dokumentu warto umieścić podstawowe informacje:

• Tytuł
• Autor
• Data aktualizacji
• Produkt / system Wersja

Ułatwia to zarządzanie dokumentacją i jej aktualizację.

FAQ

1. Jakie formaty plików są obsługiwane w bazie wiedzy?

Baza wiedzy obsługuje pliki w formatach .txt oraz .pdf (zawierające tekst, obrazy lub diagramy). Pliki zawierające wyłącznie obrazy nie są zalecane, ponieważ system AI nie będzie w stanie poprawnie odczytać ich treści.

2. Dlaczego struktura dokumentu jest ważna dla bazy wiedzy?

AI wyszukuje informacje w fragmentach tekstu, dlatego dobrze uporządkowana struktura dokumentu ułatwia odnajdywanie właściwych informacji. Czytelne sekcje, podsekcje i nagłówki zwiększają trafność odpowiedzi generowanych przez system.

3. Jak powinna wyglądać zalecana struktura dokumentu?

Dokument powinien zawierać:

• tytuł
• krótki abstrakt (2–4 zdania)
• sekcje główne i podsekcje
• opcjonalne podsumowanie
• sekcję FAQ

Taka struktura ułatwia zarówno czytanie dokumentu, jak i jego przeszukiwanie przez system AI.

4. Czy jedna sekcja może obejmować kilka różnych tematów?

Nie jest to zalecane. Każda sekcja powinna dotyczyć jednego konkretnego zagadnienia lub odpowiadać na jedno pytanie. Dzięki temu system łatwiej odnajdzie właściwy fragment podczas wyszukiwania.

5. Jak powinny być formułowane nagłówki w dokumentach?

Nagłówki powinny być konkretne i opisowe, najlepiej zawierające słowa kluczowe. Zamiast ogólnego nagłówka „Konfiguracja” lepiej użyć np. „Konfiguracja integracji API z CRM”.

6. Czy lepiej używać długich opisów czy list kroków?

W przypadku procesów lub instrukcji lepiej stosować listy kroków, ponieważ są bardziej czytelne i łatwiejsze do przeszukiwania przez system AI niż długie akapity tekstu.

7. Czy w dokumentach można używać odniesień kontekstowych, np. „jak wspomniano wcześniej”?

Nie jest to zalecane. System może pobrać fragment tekstu bez wcześniejszego kontekstu, dlatego informacje powinny być sformułowane w sposób samodzielny i kompletny.

8. Jak przygotować obrazy i diagramy w dokumentach?

Każdy obraz lub diagram powinien mieć krótki opis tekstowy, który wyjaśnia jego znaczenie. Dzięki temu system AI będzie mógł lepiej zrozumieć zawartość dokumentu.

9. Jakie elementy formatowania działają najlepiej w dokumentach do bazy wiedzy?

Najlepiej sprawdzają się:

• zwykły tekst
• nagłówki
• listy

Należy natomiast unikać skomplikowanych układów graficznych oraz tekstu umieszczonego w obrazach.

10. Czy warto powtarzać kluczowe pojęcia w dokumencie?

Tak. Powtarzanie ważnych terminów w spójnej formie pomaga systemowi AI łatwiej odnaleźć właściwe informacje podczas wyszukiwania.