Zum Hauptinhalt springen

Textbewertung & Analyse

Bewerten Sie eine Reihe von Texten​

POST/api/v1/workspaces/{workspaceId}/text-scores

Bewerten Sie einen oder mehrere vollständige Texte anhand eines Einbettungsmodells über die angeforderten Dimensionen und Mapper. Wenn goalConfig bereitgestellt wird, wird ein kombinierter goalScore pro Text sowie eine Aufschlüsselung der beitragenden goalScoreFactors zurückgegeben.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaDer Arbeitsbereich, auf den sich die Anfrage bezieht. Muss dem Workspace-Anspruch im Gateway-Token entsprechen.

Anfrage-Body​

FeldTypErforderlichBeschreibung
textsarray<string>JaZu bewertende Texte. Jeder Text wird mit seinen eigenen Bewertungen in data zurückgegeben.
embeddingModelIdstringJaID des Einbettungsmodells zum Bewerten (siehe GET /embedding-models).
goalConfigobjectNeinDefinition des Ziels, auf das ein Bewertungslauf optimiert wird. Ein Ziel kombiniert eine optionale modelRankScore-Präferenz, optionale Pro-Dimension-Gewichtungen und optionale Pro-Mapper-Gewichtungen sowie eine Normalisierungsstrategie.
modelRankScorenumberNeinWortfrequenz-Präferenz von -1 (nur seltene Wörter zählen positiv) bis 1 (nur sehr häufige).
dimensionsarray<object>NeinPro-Dimension-Gewichtungen, die das Ziel ausmachen.
idintegerJaDimensions-ID, die mit der id eines Eintrags in dimensions übereinstimmt.
weightintegerJaRichtung, in die ein Faktor die Zielwertung beeinflusst.
mappersarray<object>NeinPro-Mapper-Gewichtungen, die das Ziel ausmachen.
idstringJaMapper-ID, die mit der id eines Eintrags in mappers übereinstimmt.
weightintegerJaRichtung, in die ein Faktor die Zielwertung beeinflusst.
normalizationstringNeinNormalisierung, die auf Pro-Faktor-Bewertungen angewendet wird, bevor sie kombiniert werden.
dimensionsarray<object>NeinSemantische Dimensionen zur Bewertung jedes Textes.
idintegerJaInterne Dimensions-ID. Wiederholen Sie diese ID in goalConfig.dimensions[].id, um der Dimension eine Gewichtung zu geben.
wordsarray<string>NeinSeed-Wörter, die diese Dimension definieren. Werden direkt verwendet, wenn type manual ist; werden mit den gespeicherten Seeds der Dimension zusammengeführt, wenn type dimension ist.
typestringJaOb die Dimension von einer bekannten Dimension oder von manuellen Seed-Wörtern abgeleitet ist.
namestringNeinOptionaler Anzeigename für Analytik/UI.
mapperKeysarray<string>NeinZusammengesetzte Mapper-Variablen-IDs zur Bewertung jedes Textes. Jede ID entspricht der id, die von GET /mappers zurückgegeben wird (z. B. en_emotions_standard_valence).

Antwort​

FeldTypBeschreibung
dataarray<object>Bewertete Texte in der Reihenfolge ihrer Einreichung.
modelRankScorenumberBewertung, die widerspiegelt, wie häufig die in diesem Text verwendeten Wörter im Vokabular des Einbettungsmodells vorkommen.
goalScoreFactorsarray<object>Aufschlüsselung der Faktoren, die zu goalScore beigetragen haben. Leer, wenn keine goalConfig bereitgestellt wurde.
fieldstringName des Faktors (Dimension/Mapper/intrinsisch), der beigetragen hat.
valuenumberNumerischer Beitrag dieses Faktors zur kombinierten Zielwertung.
typestringKategorie des Faktors (z. B. dimension, mapper, intrinsic).
dimensionScoresobjectPro-Dimension-Wertungen mit Schlüssel str(dimension.id).
mapperScoresobjectPro-Mapper-Variable-Wertungen mit Schlüssel Mapper id.
goalScorenumberKombinierte Zielwertung (nur gesetzt, wenn goalConfig bereitgestellt wird).

Beispiel​

curl -X POST "https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/text-scores" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "texts": [],
      "embeddingModelId": "string",
      "goalConfig": {},
      "dimensions": [],
      "mapperKeys": []
  }'

Antwort:

{
  "data": [
    {
      "modelRankScore": 0.32,
      "goalScoreFactors": [
        {
          "field": "...",
          "value": "...",
          "type": "..."
        }
      ],
      "dimensionScores": {
        "29": 0.71
      },
      "mapperScores": {
        "en_emotions_standard_valence": 0.65
      },
      "goalScore": 0.58
    }
  ]
}

Wörter gegen ein Seed-Konzept bewerten​

POST/api/v1/workspaces/{workspaceId}/word-scores

Nimmt eine Reihe von Seed-Konzepten (seedWords) und gibt bewertete Kandidatenwörter gegen ein Embedding-Modell zurück. Für jedes Kandidatenwort enthält die Antwort:

  • seedScore – semantische Ähnlichkeit zum Schwerpunkt der Seed-Wörter (Kosinus-Ähnlichkeit, Bereich ungefähr -1..1)
  • modelRank – Häufigkeitsrang des Wortes im Vokabular des Embedding-Modells (niedriger bedeutet häufiger)
  • dimensionScores – pro-Achsen-Bewertungen für jeden Eintrag in dimensions (z. B. wie „frisch" oder „luxuriös" das Wort wirkt)
  • mapperScores – pro-Variable-Bewertungen für jede ID in mapperKeys (z. B. Valenz, Erregung)
  • goalScore – nur gefüllt, wenn seedScore-Gewichtung in der Anfrage gesetzt ist; entspricht seedScore_weight * seed_similarity

Zwei Modi, gesteuert durch whitelistWords:

  • Feste Liste bewerten. Senden Sie eine nicht leere whitelistWords und nur diese Wörter werden bewertet.
  • Suchen und bewerten. Lassen Sie whitelistWords leer und der Service wählt die limit-Wörter aus dem Embedding-Vokabular aus, die seedWords am nächsten sind (weiter eingeengt durch wordrankLimit, falls vorhanden), und bewertet diese dann.

Typischer Anwendungsfall: Optimierung von Marketing-Keywords – geben Sie der API Ihre Kampagnenkonzepte in seedWords und eine Liste von Kandidaten-Keywords in whitelistWords zur Bewertung an, oder überspringen Sie die Whitelist und lassen Sie den Service frische Vorschläge ermitteln.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaDer Arbeitsbereich, auf den sich die Anfrage bezieht. Muss dem Workspace-Anspruch im Gateway-Token entsprechen.

Anfrage-Body​

FeldTypErforderlichBeschreibung
seedWordsarray<string>JaAnker-Wörter für den Durchlauf. Ihr Schwerpunkt definiert, wogegen seedScore und das pro-Wort-Feld seedScore Ähnlichkeit messen. Im Such- und Bewertungsmodus (leere whitelistWords) wird die Kandidatenmenge auch aus der Region des Vokabulars gezogen, die diesem Schwerpunkt am nächsten liegt.
whitelistWordsarray<string>NeinBewertung auf genau diese Wörter beschränken. Falls leer, läuft der Service im Such- und Bewertungsmodus und wählt Kandidaten aus dem Vokabular des Embedding-Modells.
embeddingModelIdstringJaID des Embedding-Modells, dessen Vokabular und Vektorraum die Bewertung ausführt. Siehe GET /embedding-models.
limitintegerNeinNur Such- und Bewertungsmodus: maximale Anzahl von Kandidatenwörtern, die aus dem Vokabular vor der Bewertung gezogen werden. Wird ignoriert, wenn whitelistWords nicht leer ist.
wordrankLimitintegerNeinHäufigkeitsabschnitt bei der Kandidatenauswahl angewendet: nur Wörter in den Top-N häufigsten des Vokabulars sind berechtigt. -1 deaktiviert den Abschnitt. Hat keine Auswirkung, wenn whitelistWords angegeben ist.
seedScorenumberNeinGewichtung angewendet auf den pro-Wort-Seed-Ähnlichkeitsfaktor bei der Berechnung des kombinierten goalScore. Bereich -1 (Wörter nahe dem Seed bestrafen) bis 1 (Wörter nahe dem Seed belohnen). null deaktiviert die Berechnung des Zielscores vollständig, in diesem Fall sind die goalScore-Felder der Antwort auch null.
dimensionsarray<object>NeinSemantische Dimensionen, gegen die jedes Wort bewertet werden soll. Jeder Eintrag trägt einen pro-Wort-Wert dimensionScores in der Antwort bei.
idintegerJaInterne Dimensions-ID. Wiederholen Sie diese ID in goalConfig.dimensions[].id, um der Dimension eine Gewichtung zu geben.
wordsarray<string>NeinSeed-Wörter, die diese Dimension definieren. Werden direkt verwendet, wenn type manual ist; werden mit den gespeicherten Seeds der Dimension zusammengeführt, wenn type dimension ist.
typestringJaOb die Dimension von einer bekannten Dimension oder von manuellen Seed-Wörtern abgeleitet ist.
namestringNeinOptionaler Anzeigename für Analytik/UI.
mapperKeysarray<string>NeinZusammengesetzte Mapper-Variable-IDs, gegen die jedes Wort bewertet werden soll. Jede ID entspricht der id, die von GET /mappers zurückgegeben wird (z. B. en_emotions_standard_valence). Jede ID trägt einen pro-Wort-Wert mapperScores in der Antwort bei.

Antwort​

FeldTypBeschreibung
dataarray<object>Bewertete Wörter, die von der Anfrage zurückgegeben werden.
wordstringDas bewertete Wort, in Kleinbuchstaben.
seedScorenumberSemantische Ähnlichkeit mit den Seed-Wörtern der Anfrage. null wenn kein Seed bereitgestellt wurde (Whitelist-Modus).
modelRankintegerHäufigkeitsrang im Vokabular des Embedding-Modells (niedriger = häufiger).
seedScoreQuartileintegerQuartilzuweisung innerhalb der bewerteten Menge; -1 bedeutet nicht zugewiesen.
modelRankQuartileintegerQuartilzuweisung innerhalb der bewerteten Menge; -1 bedeutet nicht zugewiesen.
dimensionScoresobjectPro-Dimensions-Bewertungen mit Schlüssel str(dimension.id). Fehlende Werte werden weggelassen (verwenden Sie 0 als Fallback in Clients).
mapperScoresobjectPro-Mapper-Variable-Bewertungen mit Schlüssel der Mapper-id. Fehlende Werte werden weggelassen.
goalScorenumberKombinierte Zielwertung (nur gesetzt, wenn goalConfig bereitgestellt wird).
averagesobjectDurchschnittswerte über alle bewerteten Wörter für dieselbe Anfrage.
modelRankScorenumberDurchschnittliche Modell-Rang-Bewertung über die bewertete Menge.
seedScorenumberDurchschnittliche Seed-Ähnlichkeitsbewertung über die bewertete Menge.
dimensionScoresobjectPro-Dimension-Durchschnitte mit Schlüssel str(dimension.id).
mapperScoresobjectPro-Mapper-Durchschnitte mit Schlüssel Mapper id.
goalScorenumberDurchschnittliche Zielwertung (nur gesetzt, wenn goalConfig bereitgestellt wird).

Beispiel​

curl -X POST "https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/word-scores" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "seedWords": [],
      "whitelistWords": [],
      "embeddingModelId": "string",
      "limit": 100,
      "wordrankLimit": -1,
      "seedScore": 0,
      "dimensions": [],
      "mapperKeys": []
  }'

Antwort:

{
  "data": [
    {
      "word": "innovative",
      "seedScore": 0.42,
      "modelRank": 1234,
      "seedScoreQuartile": 0,
      "modelRankQuartile": 0,
      "dimensionScores": {
        "29": 0.71
      },
      "mapperScores": {
        "en_emotions_standard_valence": 0.65
      },
      "goalScore": 0.58
    }
  ],
  "averages": {
    "modelRankScore": 0.32,
    "seedScore": 0.45,
    "dimensionScores": {
      "29": 0.62
    },
    "mapperScores": {
      "en_emotions_standard_valence": 0.58
    },
    "goalScore": 0.55
  }
}

Text auf Plagiate prüfen​

POST/api/v1/workspaces/{workspaceId}/plagiarism-checks

Scannen Sie einen Text auf wörtliche Übereinstimmungen im öffentlichen Web über den vorgelagerten Plagiatsprüfdienst. Die Eingabe muss mindestens 15 Wörter enthalten. Gibt die Gesamtanzahl der Wörter in der Eingabe plus eine Liste von Quellen zurück, in denen Übereinstimmungen gefunden wurden, mit einem matchPercentage pro Quelle.

Das Kontingent wird durch den Nutzungsdienst gegen das plagiarismChecks-Budget des Arbeitsbereichs durchgesetzt – Aufrufer, die ihr monatliches Kontingent erschöpft haben, erhalten 403 mit ERROR_NO_REMAINING_PLAGIARISM_CHECKS. Jeder erfolgreiche Aufruf erhöht den Zähler um eins.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaDer Arbeitsbereich, auf den sich die Anfrage bezieht. Muss dem Workspace-Anspruch im Gateway-Token entsprechen.

Anfrage-Body​

FeldTypErforderlichBeschreibung
textstringJaDer Text, der auf Plagiate gescannt werden soll. Muss mindestens 15 Wörter enthalten, nachdem Satzzeichen entfernt wurden, sonst wird die Anfrage mit Übersetzungsschlüssel plagiarismTextTooShort abgelehnt.

Antwort​

FeldTypBeschreibung
wordCountintegerGesamtzahl der Wörter im Eingabetext text (nach Entfernung der Satzzeichen).
matchesarray<object>Quellen im öffentlichen Web, die Passagen enthalten, die dem Eingabetext text entsprechen. Leer, wenn keine Plagiate erkannt wurden.
urlstringURL der externen Seite, auf der die Übereinstimmung gefunden wurde.
titlestringHTML &lt;title&gt; der Seite, auf der die Übereinstimmung gefunden wurde.
matchSnippetstringAuszug der übereinstimmenden Passage, normalerweise mit umgebendem Kontext. Geeignet zum Hervorheben in der Benutzeroberfläche.
wordsMatchedintegerAnzahl der Wörter im Eingabetext, die dieser Quelle entsprachen.
matchPercentagenumberAnteil des Eingabetexts, der dieser Quelle entspricht, ausgedrückt als Prozentsatz im Bereich 0 - 100.

Beispiel​

curl -X POST "https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/plagiarism-checks" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "text": "string"
  }'

Antwort:

{
  "wordCount": 28,
  "matches": [
    {
      "url": "https://en.wikipedia.org/wiki/Example_Person",
      "title": "Example Person - Wikipedia",
      "matchSnippet": "She was born in Sydney and studied English Literature and Law at the University of New South Wales...",
      "wordsMatched": 24,
      "matchPercentage": 84.5
    }
  ]
}

Text tokenisieren​

POST/api/v1/workspaces/{workspaceId}/tokenizations

Teilen Sie einen Text in Token auf, indem Sie den Tokenizer für die angegebene language verwenden. Jedes Token enthält seine Oberflächenform, normalisierte Form, Zeichenoffsets im Originaltext, ein Stoppwort-Flag und (falls verfügbar) eine Liste von Synonymen. Die Antwort enthält auch tokenCount zur Bequemlichkeit.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaDer Arbeitsbereich, auf den sich die Anfrage bezieht. Muss dem Workspace-Anspruch im Gateway-Token entsprechen.

Anfrage-Body​

FeldTypErforderlichBeschreibung
languagestringJaISO 639-1-Sprachcode, der festlegt, welcher Tokenizer/welches Modell verwendet werden soll, z. B. en, de, fr, ja.
textstringJaDer zu tokenisierende Text.

Antwort​

FeldTypBeschreibung
tokenCountintegerGesamtanzahl der zurückgegebenen Token. Gleich wie len(tokens).
tokensarray<object>Die aus dem Eingabetext erzeugten Token in ihrer ursprünglichen Reihenfolge.
stringstringDer ursprüngliche Teilstring der Eingabe, den dieses Token abdeckt.
tokenstringDie normalisierte/lemmatisierte Form des Token, die für die nachgelagerte Verarbeitung verwendet wird. Für japanische Eingaben ist dies identisch mit string.
indexStartintegerNullbasierter Zeichenoffset, bei dem dieses Token im Eingabetext beginnt.
indexEndintegerNullbasierter Zeichenoffset, bei dem dieses Token im Eingabetext endet (exklusiv).
isStopbooleanOb das Token in der gewählten Sprache als Stoppwort betrachtet wird (z. B. the, and, of im Englischen).
synonymsarray<string>Synonyme des Token, falls für diese Sprache verfügbar. Leere Liste, wenn keine Synonyme gefunden wurden.

Beispiel​

curl -X POST "https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/tokenizations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "language": "string",
      "text": "string"
  }'

Antwort:

{
  "tokenCount": 5,
  "tokens": [
    {
      "string": "Angela",
      "token": "angela",
      "indexStart": 0,
      "indexEnd": 6,
      "isStop": false,
      "synonyms": []
    }
  ]
}

Vervollständigungsvorschläge für ein Teilwort​

POST/api/v1/workspaces/{workspaceId}/autocomplete-suggestions

Bis zu zehn Vorschläge für ein teilweise eingegebenes Wort aus dem Vokabular des bereitgestellten Einbettungsmodells zurückgeben. Verwenden Sie das Feld whitelistWords, um die Kandidatenmenge einzuschränken (z. B. auf ein kampagnenspezifisches Glossar).

Typischer Anwendungsfall: Betrieb des Inline-Autocomplete-Dropdowns in einer Bearbeitungs-UI.

Pfadparameter​

ParameterTypErforderlichBeschreibung
workspaceIdstringJaDer Arbeitsbereich, auf den sich die Anfrage bezieht. Muss dem Workspace-Anspruch im Gateway-Token entsprechen.

Anfrage-Body​

FeldTypErforderlichBeschreibung
wordstringJaTeilwort, für das der Aufrufer Vervollständigungen wünscht. Wird als Präfix behandelt und mit dem Vokabular des Einbettungsmodells abgeglichen.
embeddingModelIdstringJaID des Einbettungsmodells, dessen Vokabular für Vervollständigungen verwendet wird (siehe GET /embedding-models).
whitelistWordsarray<string>NeinWenn nicht leer, werden nur Vervollständigungen zurückgegeben, die in dieser Whitelist vorhanden sind. Nützlich, um Autocomplete auf ein kampagnenspezifisches Glossar zu beschränken.

Antwort​

FeldTypBeschreibung
suggestionsarray<string>Bis zu zehn empfohlene Vervollständigungen, sortiert von beste zu schlechteste.

Beispiel​

curl -X POST "https://app.neuroflash.com/api/v1/workspaces/{workspace_id}/autocomplete-suggestions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "word": "string",
      "embeddingModelId": "string",
      "whitelistWords": []
  }'

Antwort:

{
  "suggestions": [
    "multicolored",
    "multihued"
  ]
}