Extract entities and relationships — The most advanced AI retrieval system. Agentic Retrieval-Augmented Generation (RAG) with a RESTful API.

Extracts entities and relationships from a document. The entities and relationships extraction process involves:

idstringRequired

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

X-API-KeystringRequired

run_with_orchestrationbooleanOptional

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

Settings for the entities and relationships extraction process.

clustering_modestringOptionalDefaults to local

Whether to use remote clustering for graph creation.

graphrag_relationships_extraction_few_shotstringOptionalDefaults to graphrag_relationships_extraction_few_shot

The prompt to use for knowledge graph extraction.

graphrag_entity_description_promptstringOptionalDefaults to graphrag_entity_description

The prompt to use for entity description generation.

entity_typeslist of stringsOptional

The types of entities to extract.

relation_typeslist of stringsOptional

The types of relations to extract.

chunk_merge_countintegerOptionalDefaults to 2

The number of extractions to merge into a single KG extraction.

max_knowledge_relationshipsintegerOptionalDefaults to 100

The maximum number of knowledge relationships to extract from each chunk.

max_description_input_lengthintegerOptionalDefaults to 65536

The maximum length of the description for a node in the graph.

generation_configobjectOptional

Configuration for text generation during graph enrichment.

automatic_deduplicationbooleanOptionalDefaults to false

Whether to automatically deduplicate entities.

Successful Response

1	from r2r import R2RClient
2
3	client = R2RClient()
4	# when using auth, do client.login(...)
5
6	result = client.documents.extract(
7	id="9fbe403b-c11c-5aae-8ade-ef22980c3ad1"
8	)