Skip to main content

.DOCSEARCH

Durchsucht Skill-Dokumente per Vektorsuche und stellt Ergebnisse dar (RAGAI.DOCSEARCH).

Hintergrund

returnType in searchAsJson bestimmt nicht nur das Format, sondern teils auch was zurückgegeben wird: "json" liefert die Rohdaten, "table"/"text" bereits fertig aufbereitete Darstellungen, "hasresults"/ "counter" nur einen Boolean bzw. eine Zahl (nützlich für Bedingungen im Logik-Editor, ohne die vollen Suchergebnisse verarbeiten zu müssen). minScore wird als Prozentwert (0-100) entgegengenommen, aber vor dem Backend-Aufruf intern durch 100 geteilt. clickFn öffnet Trefferdokumente standardmäßig in einem RAGAI.OVERLAY.html()-iFrame, kann aber überschrieben werden.

Methoden

.searchAsJson(searchString, skillIds?, searchCount?, minScore?, returnType?, searchType?)

Durchsucht Skill-Dokumente und liefert das Ergebnis im gewünschten Format.

ParameterTypBeschreibung
searchStringstring | z.input<typeof docSearchSchema>Suchbegriff, oder ein Objekt gemäß docSearchSchema.
skillIdsnull | string[]Auf diese Skills beschränken, oder null für alle.
searchCountnumberMaximale Anzahl an Treffern.
minScorenumberMindest-Ähnlichkeitswert in Prozent (0-100).
returnTypestringAusgabeformat: "json", "table", "text", "hasresults" oder "counter".
searchTypestringSuchmethode, z. B. "vector".

Objekt-Form (validiert über docSearchSchema):

FeldTypPflichtBeschreibung
querystringDer Suchbegriff.
skillIdsanyAuf diese Skills beschränken, oder null für alle.
countnumberMaximale Anzahl an Treffern.
minScorenumberMindest-Ähnlichkeitswert in Prozent (0-100).

Rückgabewert: Promise<string | number | boolean | DocSearchResult>

Die Suchergebnisse im gewählten Format.

.jsonToHtml(data)

Rendert Suchergebnisse als HTML-Liste.

ParameterTypBeschreibung
dataDocSearchResultDie Suchergebnisse.

Rückgabewert: string

Der gerenderte HTML-String.

.searchAsCard(searchString, skillIds, searchCount?, minScore?)

Durchsucht Skill-Dokumente und zeigt das Ergebnis direkt als HTML-Card an.

ParameterTypBeschreibung
searchStringstringSuchbegriff.
skillIdsnull | string[]Auf diese Skills beschränken, oder null für alle.
searchCountnumberMaximale Anzahl an Treffern.
minScorenumberMindest-Ähnlichkeitswert in Prozent (0-100).

Rückgabewert: Promise<void>

.docSearchResult(searchString, skillIds, searchCount?, minScore?)

Durchsucht Skill-Dokumente und liefert das Ergebnis als HTML-String zurück.

ParameterTypBeschreibung
searchStringstringSuchbegriff.
skillIdsnull | string[]Auf diese Skills beschränken, oder null für alle.
searchCountnumberMaximale Anzahl an Treffern.
minScorenumberMindest-Ähnlichkeitswert in Prozent (0-100).

Rückgabewert: Promise<string>

Der gerenderte HTML-String.