Einbettungsmodelle

Wörter-Verfügbarkeit prüfen

POST/api/v1/embedding-models/{embeddingModelId}/word-availabilities

Überprüfen Sie, welche Wörter in words im Vokabular eines bestimmten Einbettungsmodells vorhanden sind. Wenn whitelistWords nicht leer ist, wird ein Wort nur als verfügbar markiert, wenn es sowohl im Vokabular ALS AUCH in der Allow-List vorhanden ist.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`embeddingModelId`	string	Ja

Anfrage-Body

wordsarray<string>JaWörter, deren Vokabular-Präsenz geprüft werden soll.

whitelistWordsarray<string>NeinOptionale Allow-List: Wenn nicht leer, werden nur Wörter, die sowohl im Vokabular des Modells ALS AUCH in dieser Liste vorhanden sind, als verfügbar markiert.

Antwort

availabilitiesarray<object>Ein Eintrag pro Wort, das in der Anfrage bereitgestellt wurde.

wordstringDas geprüfte Wort.

isAvailablebooleanOb das Wort im Vokabular des Modells vorhanden ist.

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/v1/embedding-models/{embedding_model_id}/word-availabilities" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "words": [],
      "whitelistWords": []
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/v1/embedding-models/{embedding_model_id}/word-availabilities",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "words": [],
        "whitelistWords": []
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/v1/embedding-models/${embeddingModelId}/word-availabilities`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "words": [],
          "whitelistWords": []
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"words": []any{},
		"whitelistWords": []any{},
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/v1/embedding-models/"+embeddingModelID+"/word-availabilities", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "availabilities": [
    {
      "word": "car",
      "isAvailable": true
    }
  ]
}

Ähnlichkeitsmatrix für Wörter berechnen

POST/api/v1/embedding-models/{embeddingModelId}/word-similarity-matrices

Paarweise Kosinus-Ähnlichkeitsmatrix für alle Wörter in der Anfrage zurückgeben, die im Vokabular des Modells vorhanden sind. Wörter, die nicht im Vokabular gefunden werden, werden automatisch aus dem Ergebnis ausgeschlossen.

Die Antwortwörterliste und die Matrixzeilen/Spalten sind ausgerichtet: matrix[i][j] ist die Ähnlichkeit zwischen words[i] und words[j]. Werte werden auf zwei Dezimalstellen gerundet.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`embeddingModelId`	string	Ja

Anfrage-Body

wordsarray<string>JaWörter zum paarweisen Vergleich. Nur Wörter, die im Vokabular des Modells vorhanden sind, werden in die Antwort aufgenommen (nicht verfügbare Wörter werden automatisch entfernt).

Antwort

wordsarray<string>Tatsächlich bewertete Wörter — Teilmenge der angeforderten Liste, begrenzt auf Wörter, die im Vokabular des Modells vorhanden sind.

matrixarray<array<number>>Quadratische Matrix paarweise Kosinus-Ähnlichkeitswertungen. Der Eintrag bei [i][j] ist die Ähnlichkeit zwischen words[i] und words[j]. Werte werden auf zwei Dezimalstellen gerundet.

Beispiel

cURL
Python
Node.js
Go

curl -X POST "https://app.neuroflash.com/api/v1/embedding-models/{embedding_model_id}/word-similarity-matrices" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "words": []
  }'

import requests

response = requests.post(
    f"https://app.neuroflash.com/api/v1/embedding-models/{embedding_model_id}/word-similarity-matrices",
    headers={"Authorization": f"Bearer {token}", "Content-Type": "application/json"},
    json={
        "words": []
    },
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/v1/embedding-models/${embeddingModelId}/word-similarity-matrices`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${token}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
          "words": []
    }),
  }
).then((r) => r.json());

body, _ := json.Marshal(map[string]any{
		"words": []any{},
	})

req, _ := http.NewRequest("POST", "https://app.neuroflash.com/api/v1/embedding-models/"+embeddingModelID+"/word-similarity-matrices", bytes.NewReader(body))
req.Header.Set("Authorization", "Bearer "+token)
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "words": [
    "car",
    "automotive",
    "volkswagen"
  ],
  "matrix": [
    [
      0
    ]
  ]
}

Embedding-Modelle auflisten

GET/api/v1/embedding-models

Den Katalog der Wort-Embedding-Modelle zurückgeben, die dem Aufrufer zur Verfügung stehen. Optionale Abfrageparameter country und language beschränken die Liste auf ein einzelnes Gebietsschema. Verwenden Sie die zurückgegebene id eines Modells als embeddingModelId bei den Bewertungs-, Abgleichs- und Vervollständigungsendpunkten. Dieser Katalog ist global — er ist nicht auf Arbeitsbereiche beschränkt.

Abfrageparameter

Parameter	Typ	Standard	Beschreibung
`country`	string	—	ISO 3166-1 alpha-2 country code, e.g. `de` or `us`.
`language`	string	—	ISO 639-1 language code, e.g. `de` or `en`.
`page`	integer	`1`	Page number to retrieve. The first page is 1 (not 0).
`size`	integer	`20`	Number of elements per page. Maximum 100.

Antwort

pageobject

sizeintegerRequested page size. Echoed back even when data contains fewer elements (e.g. on the last page).

totalElementsintegerTotal number of elements across all pages.

totalPagesintegerTotal number of pages given the requested size.

currentPageintegerPage number returned. The first page is 1 (not 0).

dataarray<object>Elements on the current page. May contain fewer than page.size on the last page.

idstringStabiler Bezeichner für dieses Embedding-Modell. Geben Sie dies als embeddingModelId bei den Endpunkten zur Wort-Bewertung / Text-Bewertung / Text-Abgleich / Wort-Vervollständigung an.

languagestringISO-639-1-Sprachcode, auf dem dieses Modell trainiert wurde.

countrystringISO-3166-1-Alpha-2-Ländercode, auf dem dieses Modell trainiert wurde.

versionstringInterne Versionszeichenkette des Modellartefakts.

sourcesarray<string>Datenquellen, die beim Erstellen dieses Modells verwendet wurden.

featuresarray<string>Vorverarbeitungsfeatures, die beim Trainieren dieses Modells angewendet wurden (z. B. Phrasenerkennung, Deduplizierung).

tagstringOptionaler Freitextdiskriminator, der dieses Modell von Geschwistern im selben Gebietsschema/Trainingslauf unterscheidet (z. B. eine kundenspezifische Variante). Nicht lokalisiert.

trainingYearstringJahr des Trainingslaufs, vier Ziffern.

trainingMonthstringMonat des Trainingslaufs, auf zwei Ziffern aufgefüllt.

labelstringEnglisches Anzeigeetikett, das Sprache, Land und Datum kombiniert. Geeignet als benutzersichtbarer Name, wenn keine lokalisierte Zeichenkette verfügbar ist.

languageLabelstringEnglisches Anzeigeetikett für die Sprache des Modells.

countryLabelstringEnglische Anzeigebeschriftung für das Land des Modells.

monthLabelstringEnglische Anzeigebeschriftung für den Trainingsmonat des Modells.

tokenCountintegerAnzahl der Token, die während des Modelltrainings verbraucht wurden.

hasTranslationbooleanGibt an, ob ein englisches Übersetzungs-Begleitmodell verfügbar ist. Wenn true, können Ergebnisse für sprachübergreifende UX übersetzt werden.

loadingStatusstringGibt an, ob das Modellartefakt in den Speicher geladen ist. Einer von loaded, not loaded, loading, error.

_embeddedobjectIn einer :class:EmbeddingModel-Antwort eingebettete Unterressourcen. Spiegelt die HAL-ähnliche _embedded-Konvention wider, die an anderer Stelle in der Plattform verwendet wird (z. B. TargetAudience._embedded).

mappersarray<object>Mit diesem Modell gebündelte Mapper-Bundles. Für den Katalog aller Mapper (mit Land-/Sprachmetadaten) siehe GET /mappers.

keystringStabiler, anzeigbarer eindeutiger Bezeichner des Mapper-Bundles. Nicht lokalisiert; verwenden Sie ihn als key eines Eintrags, der auf diesem Mapper auf POST /word-scores / POST /text-scores verweist.

variablesarray<string>Von diesem Mapper verfügbar gemachte Variablen. Jede kann unabhängig referenziert werden, indem id = name + '_' + variable kombiniert wird.

translationKeystringi18n-Schlüssel für den Anzeigenamen des Mappers. Client-seitig auflösen; zeigen Sie den rohen Schlüssel nicht den Benutzern.

labelstringEnglische Anzeigebeschriftung für diesen Mapper. Verwenden Sie sie als Fallback, wenn das i18n-Bundle für das Gebietsschema des Benutzers translationKey nicht enthält.

Beispiel

cURL
Python
Node.js
Go

curl "https://app.neuroflash.com/api/v1/embedding-models" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

import requests

response = requests.get(
    f"https://app.neuroflash.com/api/v1/embedding-models",
    headers={"Authorization": f"Bearer {token}"},
).json()

const response = await fetch(
  `https://app.neuroflash.com/api/v1/embedding-models`,
  { headers: { Authorization: `Bearer ${token}` } }
).then((r) => r.json());

req, _ := http.NewRequest("GET", "https://app.neuroflash.com/api/v1/embedding-models", nil)
req.Header.Set("Authorization", "Bearer "+token)

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

Antwort:

{
  "page": {
    "size": 20,
    "totalElements": 137,
    "totalPages": 7,
    "currentPage": 1
  },
  "data": [
    {
      "id": "001",
      "language": "en",
      "country": "us",
      "version": "0.1",
      "sources": [
        "commoncrawl"
      ],
      "features": [
        "phrases",
        "deduplication"
      ],
      "tag": "customer",
      "trainingYear": "2020",
      "trainingMonth": "01",
      "label": "English (US) 2020-01",
      "languageLabel": "English",
      "countryLabel": "US",
      "monthLabel": "January",
      "tokenCount": 50000000,
      "hasTranslation": false,
      "loadingStatus": "loaded",
      "_embedded": {
        "mappers": [
          "..."
        ]
      }
    }
  ]
}

Ein Embedding-Modell nach ID abrufen

GET/api/v1/embedding-models/{id}

Geben Sie ein einzelnes Embedding-Modell zurück, das durch seine id identifiziert wird. Die gleiche ID wird als embeddingModelId auf den Scoring-, Matching- und Completion-Endpunkten verwendet.

Pfadparameter

Parameter	Typ	Erforderlich	Beschreibung
`id`	string	Ja