aYOUne
← KI / AI API

KnowledgeSources

Singular: KnowledgeSource — Base-URL: https://ai.ayoune.app — Zugriff: CRUD — Maschinenlesbare Beschreibung (JSON · YAML)

play_circle Jetzt ausprobieren beta

Requests werden über den consumer-app Proxy an *.ayoune.app weitergeleitet. Tokens bleiben im Browser und werden pro Call mitgesendet.

Beispiel-Response (aufgezeichnet) Beispiel

Eine echte, zuvor aufgezeichnete GET /:id-Antwort dieses Endpunkts — nicht der Live-Call oben. Sensible Felder sind maskiert.

{
  "payload": {
    "bibliographic": {
      "authors": [],
      "coAuthors": [],
      "editors": [],
      "translators": [],
      "subjectTags": []
    },
    "qualityMetrics": {
      "issues": [
        {
          "type": "extraction-error",
          "severity": "error",
          "message": "No chunks indexed — source has no content to score",
          "detectedAt": "2026-08-03T03:29:01.740Z",
          "_id": "6a700afdcccb66fc91bc60cc",
          "isDraft": true
        }
      ],
      "chunkCoverage": 0,
      "embeddingCompleteness": 0,
      "lastQualityRunAt": "2026-08-03T03:29:01.740Z",
      "qualityScore": 0
    },
    "ingestionState": {
      "phase": "complete",
      "startedAt": "2026-08-03T03:29:01.575Z",
      "completedAt": "2026-08-03T03:29:01.650Z"
    },
    "collectionConfig": {
      "modelName": "Activities",
      "fieldsToExclude": [],
      "batchSize": 100,
      "fields": []
    },
    "documentConfig": {
      "fileTypes": [],
      "mediaIds": []
    },
    "chatConfig": {
      "channels": [],
      "messageWindowSize": 20,
      "includeInternal": false
    },
    "cmsConfig": {
      "contentTypes": [],
      "publishedOnly": true
    },
    "urlConfig": {
      "urls": [],
      "crawlDepth": 1
    },
    "codeRepoConfig": {
      "includeGlobs": [],
      "excludeGlobs": [],
      "indexingMode": "cloud"
    },
    "_id": "6a353bd45a44977e01d46645",
    "name": "Activities (auto)",
    "description": "Auto-managed knowledge source for Activities collection",
    "status": "active",
    "sourceType": "collection",
    "module": "crm",
    "autoManaged": true,
    "autoSync": true,
    "syncIntervalMinutes": 120,
    "syncResumeId": null,
    "consumerVisible": false,
    "global": false,
    "isDraft": true,
    "createdAt": "2026-06-19T12:53:40.937Z",
    "updatedAt": "2026-08-23T02:30:07.160Z",
    "lastSyncAt": "2026-08-23T02:30:07.160Z",
    "lastSyncError": null,
    "lastSyncStatus": "success",
    "classificationAudit": {
      "candidates": [],
      "agreeingSignals": 0,
      "model": "embedding-knn",
      "levelReached": "library",
      "at": "2026-07-01T04:31:46.658Z",
      "vectorSearchMode": "in-app-cosine",
      "sourceVectorFrom": "none",
      "chunkCount": 0,
      "libraryCount": 0,
      "reason": "no-source-embedding",
      "margin": 0,
      "thresholds": {
        "suggest": 0.3,
        "autoAssign": 0.85,
        "marginDelta": 0.05,
        "autoAssignEnabled": false
      }
    },
    "classificationMethod": "embedding-knn",
    "classificationStatus": "needs-review"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://ai.ayoune.app/knowledgesources/6a353bd45a44977e01d46645",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Repositories",
        "title": "MODEL_REPOSITORY",
        "href": "https://api.ayoune.app/devops/repositories",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "devops.repositories"
      },
      {
        "rel": "Libraries",
        "title": "MODEL_LIBRARY",
        "href": "https://api.ayoune.app/ai/libraries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.libraries"
      },
      {
        "rel": "Libraries",
        "title": "MODEL_LIBRARY",
        "href": "https://api.ayoune.app/ai/libraries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "ai.libraries"
      },
      {
        "rel": "Images",
        "title": "MODEL_IMAGE",
        "href": "https://api.ayoune.app/cms/images",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.images"
      }
    ],
    "debugId": "6a8a6b27216dcd463ba828ef",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_KNOWLEDGESOURCE",
        "href": "https://api.ayoune.app/ai/knowledgesources/6a353bd45a44977e01d46645/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_KNOWLEDGESOURCE",
        "href": "https://api.ayoune.app/ai/knowledgesources/6a353bd45a44977e01d46645/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.162.0",
      "core": "2026.315.1"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9628",
      "reset": "1787459872",
      "resetDate": "Sun Aug 23 2026"
    },
    "responseTime": 27.95483,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpunkte

MethodePathBeschreibungRight
GET /knowledgesources Liste mit Filtern/Paginierung ai.knowledgesources.view
GET /knowledgesources/:id Einzelner Datensatz ai.knowledgesources.view
POST /knowledgesources Neuen Datensatz erstellen ai.knowledgesources.new
PUT /knowledgesources Datensatz aktualisieren ai.knowledgesources.edit
DELETE /knowledgesources/:id Datensatz löschen ai.knowledgesources.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// Alle abrufen
const list = await ay.ai.knowledgeSources.find().limit(10).exec();

// Einzelnen Datensatz
const one = await ay.ai.knowledgeSources.findById('OBJECT_ID').exec();

// Erstellen
const created = await ay.ai.knowledgeSources.create({ name: 'Foo' });

Weiterführend