Document bijwerken

PATCH

/v1/convai/knowledge-base/:documentation_id

PATCH

/v1/convai/knowledge-base/:documentation_id

curl -X PATCH https://api.elevenlabs.io/v1/convai/knowledge-base/21m00Tcm4TlvDq8ikWAM \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "type": "url",
  "access_info": {
    "is_creator": true,
    "creator_name": "John Doe",
    "creator_email": "john.doe@example.com",
    "role": "admin",
    "anonymous_access_level_override": "admin",
    "access_source": "creator"
  },
  "extracted_inner_html": "extracted_inner_html",
  "id": "id",
  "metadata": {
    "created_at_unix_secs": 1,
    "last_updated_at_unix_secs": 1,
    "size_bytes": 1
  },
  "name": "name",
  "supported_usages": [
    "prompt"
  ],
  "url": "url",
  "auto_sync_info": {
    "minimum_frequency_days": 1,
    "auto_remove": true,
    "consec_failures": 1,
    "next_refresh_by": 1
  },
  "content_format": "html",
  "folder_parent_id": "folder_parent_id",
  "folder_path": [
    {
      "id": "id",
      "name": "name"
    }
  ]
}

Werk de naam, inhoud en/of auto-syncinstellingen van een document bij.

Path parameters

documentation_idstringRequired

De id van een document uit de kennisbank. Deze wordt teruggegeven wanneer het document wordt toegevoegd.

Request

This endpoint expects an object.

namestringOptional>=1 character

Een aangepaste, leesbare naam voor het document.

contentstringOptional

Bijgewerkte inhoud voor het document. Alleen ondersteund voor tekstdocumenten, URL-documenten met uitgeschakelde automatische synchronisatie en bestandsdocumenten die niet vanuit een externe bron worden gesynchroniseerd.

enable_auto_syncbooleanOptional

Of het document of de map automatisch wordt vernieuwd. Alleen van toepassing op URL-documenten, mappen en extern gesynchroniseerde bestanden. Laat deze waarde niet ingesteld om de huidige waarde te behouden.

auto_removebooleanOptional

Of het document automatisch moet worden verwijderd zodra de bron niet meer beschikbaar is. Alleen van toepassing als auto-sync is ingeschakeld. Laat deze waarde niet ingesteld om de huidige waarde te behouden.

minimum_frequency_daysintegerOptional1-180

Minimale frequentie (in dagen) waarmee het document wordt vernieuwd. Het werkelijke interval kan korter zijn, maar nooit langer. Alleen van toepassing als auto-sync is ingeschakeld. Laat deze waarde niet ingesteld om de huidige waarde te behouden.

tighten_onlybooleanOptionalDefaults to false

Alleen mappen. Wanneer true is, worden items die al in de map staan alleen aangescherpt zodat ze minstens even strikt blijven als de map, en behouden ze instellingen die strikter zijn dan die van de map. Wanneer false is, worden ze exact ingesteld op de auto-syncinstellingen van de map. Genegeerd voor extern gesynchroniseerde mappen, waarvan de inhoud altijd het schema van de map volgt.

Response

Geslaagde response

urlobject

fileobject

textobject

folderobject

Errors

422

Documents Update Request Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors