Extract entities and relationships
curl --request POST \
--url https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"graph_extraction_prompt": "graph_extraction",
"graph_entity_description_prompt": "graph_entity_description",
"entity_types": "<string>",
"relation_types": "<string>",
"chunk_merge_count": 2,
"max_knowledge_relationships": 65536,
"generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": true,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [
{
"Base Model": {}
}
],
"extended_thinking": false,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"automatic_deduplication": false
}
'import requests
url = "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract"
payload = {
"graph_extraction_prompt": "graph_extraction",
"graph_entity_description_prompt": "graph_entity_description",
"entity_types": "<string>",
"relation_types": "<string>",
"chunk_merge_count": 2,
"max_knowledge_relationships": 65536,
"generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": True,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [{ "Base Model": {} }],
"extended_thinking": False,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"automatic_deduplication": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
graph_extraction_prompt: 'graph_extraction',
graph_entity_description_prompt: 'graph_entity_description',
entity_types: '<string>',
relation_types: '<string>',
chunk_merge_count: 2,
max_knowledge_relationships: 65536,
generation_config: {
model: '<string>',
temperature: 123,
top_p: 123,
max_tokens_to_sample: 123,
stream: true,
functions: '<array>',
tools: '<array>',
add_generation_kwargs: '<array>',
api_base: '<string>',
response_format: [{'Base Model': {}}],
extended_thinking: false,
thinking_budget: 123,
reasoning_effort: '<string>'
},
automatic_deduplication: false
})
};
fetch('https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'graph_extraction_prompt' => 'graph_extraction',
'graph_entity_description_prompt' => 'graph_entity_description',
'entity_types' => '<string>',
'relation_types' => '<string>',
'chunk_merge_count' => 2,
'max_knowledge_relationships' => 65536,
'generation_config' => [
'model' => '<string>',
'temperature' => 123,
'top_p' => 123,
'max_tokens_to_sample' => 123,
'stream' => true,
'functions' => '<array>',
'tools' => '<array>',
'add_generation_kwargs' => '<array>',
'api_base' => '<string>',
'response_format' => [
[
'Base Model' => [
]
]
],
'extended_thinking' => false,
'thinking_budget' => 123,
'reasoning_effort' => '<string>'
],
'automatic_deduplication' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract"
payload := strings.NewReader("{\n \"graph_extraction_prompt\": \"graph_extraction\",\n \"graph_entity_description_prompt\": \"graph_entity_description\",\n \"entity_types\": \"<string>\",\n \"relation_types\": \"<string>\",\n \"chunk_merge_count\": 2,\n \"max_knowledge_relationships\": 65536,\n \"generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"automatic_deduplication\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"graph_extraction_prompt\": \"graph_extraction\",\n \"graph_entity_description_prompt\": \"graph_entity_description\",\n \"entity_types\": \"<string>\",\n \"relation_types\": \"<string>\",\n \"chunk_merge_count\": 2,\n \"max_knowledge_relationships\": 65536,\n \"generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"automatic_deduplication\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"graph_extraction_prompt\": \"graph_extraction\",\n \"graph_entity_description_prompt\": \"graph_entity_description\",\n \"entity_types\": \"<string>\",\n \"relation_types\": \"<string>\",\n \"chunk_merge_count\": 2,\n \"max_knowledge_relationships\": 65536,\n \"generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"automatic_deduplication\": false\n}"
response = http.request(request)
puts response.read_body{
"results": {
"message": "message"
}
}{}""Collections
Extract entities and relationships
Extracts entities and relationships from a document.
POST
/
api
/
r2r
/
v3
/
collections
/
{id}
/
extract
Extract entities and relationships
curl --request POST \
--url https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"graph_extraction_prompt": "graph_extraction",
"graph_entity_description_prompt": "graph_entity_description",
"entity_types": "<string>",
"relation_types": "<string>",
"chunk_merge_count": 2,
"max_knowledge_relationships": 65536,
"generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": true,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [
{
"Base Model": {}
}
],
"extended_thinking": false,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"automatic_deduplication": false
}
'import requests
url = "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract"
payload = {
"graph_extraction_prompt": "graph_extraction",
"graph_entity_description_prompt": "graph_entity_description",
"entity_types": "<string>",
"relation_types": "<string>",
"chunk_merge_count": 2,
"max_knowledge_relationships": 65536,
"generation_config": {
"model": "<string>",
"temperature": 123,
"top_p": 123,
"max_tokens_to_sample": 123,
"stream": True,
"functions": "<array>",
"tools": "<array>",
"add_generation_kwargs": "<array>",
"api_base": "<string>",
"response_format": [{ "Base Model": {} }],
"extended_thinking": False,
"thinking_budget": 123,
"reasoning_effort": "<string>"
},
"automatic_deduplication": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
graph_extraction_prompt: 'graph_extraction',
graph_entity_description_prompt: 'graph_entity_description',
entity_types: '<string>',
relation_types: '<string>',
chunk_merge_count: 2,
max_knowledge_relationships: 65536,
generation_config: {
model: '<string>',
temperature: 123,
top_p: 123,
max_tokens_to_sample: 123,
stream: true,
functions: '<array>',
tools: '<array>',
add_generation_kwargs: '<array>',
api_base: '<string>',
response_format: [{'Base Model': {}}],
extended_thinking: false,
thinking_budget: 123,
reasoning_effort: '<string>'
},
automatic_deduplication: false
})
};
fetch('https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'graph_extraction_prompt' => 'graph_extraction',
'graph_entity_description_prompt' => 'graph_entity_description',
'entity_types' => '<string>',
'relation_types' => '<string>',
'chunk_merge_count' => 2,
'max_knowledge_relationships' => 65536,
'generation_config' => [
'model' => '<string>',
'temperature' => 123,
'top_p' => 123,
'max_tokens_to_sample' => 123,
'stream' => true,
'functions' => '<array>',
'tools' => '<array>',
'add_generation_kwargs' => '<array>',
'api_base' => '<string>',
'response_format' => [
[
'Base Model' => [
]
]
],
'extended_thinking' => false,
'thinking_budget' => 123,
'reasoning_effort' => '<string>'
],
'automatic_deduplication' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract"
payload := strings.NewReader("{\n \"graph_extraction_prompt\": \"graph_extraction\",\n \"graph_entity_description_prompt\": \"graph_entity_description\",\n \"entity_types\": \"<string>\",\n \"relation_types\": \"<string>\",\n \"chunk_merge_count\": 2,\n \"max_knowledge_relationships\": 65536,\n \"generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"automatic_deduplication\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"graph_extraction_prompt\": \"graph_extraction\",\n \"graph_entity_description_prompt\": \"graph_entity_description\",\n \"entity_types\": \"<string>\",\n \"relation_types\": \"<string>\",\n \"chunk_merge_count\": 2,\n \"max_knowledge_relationships\": 65536,\n \"generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"automatic_deduplication\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.intelligence.io.solutions/api/r2r/v3/collections/{id}/extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"graph_extraction_prompt\": \"graph_extraction\",\n \"graph_entity_description_prompt\": \"graph_entity_description\",\n \"entity_types\": \"<string>\",\n \"relation_types\": \"<string>\",\n \"chunk_merge_count\": 2,\n \"max_knowledge_relationships\": 65536,\n \"generation_config\": {\n \"model\": \"<string>\",\n \"temperature\": 123,\n \"top_p\": 123,\n \"max_tokens_to_sample\": 123,\n \"stream\": true,\n \"functions\": \"<array>\",\n \"tools\": \"<array>\",\n \"add_generation_kwargs\": \"<array>\",\n \"api_base\": \"<string>\",\n \"response_format\": [\n {\n \"Base Model\": {}\n }\n ],\n \"extended_thinking\": false,\n \"thinking_budget\": 123,\n \"reasoning_effort\": \"<string>\"\n },\n \"automatic_deduplication\": false\n}"
response = http.request(request)
puts response.read_body{
"results": {
"message": "message"
}
}{}""The entities and relationships extraction process involves:
- Parsing documents into semantic chunks
- Extracting entities and relationships using LLMs
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Collection ID
Body
application/json
The prompt to use for knowledge graph extraction.
The prompt to use for entity description generation.
The types of entities to extract.
The types of relations to extract.
The number of extractions to merge into a single graph extraction.
The maximum length of the description for a node in the graph.
Show child attributes
Show child attributes
Whether to automatically deduplicate entities.
Response
200
Show child attributes
Show child attributes
Was this page helpful?
⌘I