Extract entities and relationships

POST

Extracts entities and relationships from a document.

The entities and relationships extraction process involves:

  1. Parsing documents into semantic chunks

  2. Extracting entities and relationships using LLMs

  3. Storing the created entities and relationships in the knowledge graph

  4. Preserving the document’s metadata and content, and associating the elements with collections the document belongs to

Path parameters

idstringRequired

The ID of the document to extract entities and relationships from.

Request

This endpoint expects an object.
run_type"estimate" or "run"Optional
Allowed values: estimaterun

Whether to return an estimate of the creation cost or to actually extract the document.

settingsobjectOptional

Settings for the entities and relationships extraction process.

run_with_orchestrationbooleanOptional

Whether to run the entities and relationships extraction process with orchestration.

Response

Successful Response

resultsobject

Errors