Upsert
curl --request PUT \
--url http://api.gu1.ai/entities/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": {},
"options": {},
"options.conflictResolution": {},
"options.deduplicationStrategy": {},
"options.createRelationships": true
}
'import requests
url = "http://api.gu1.ai/entities/upsert"
payload = {
"entity": {},
"options": {},
"options.conflictResolution": {},
"options.deduplicationStrategy": {},
"options.createRelationships": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: {},
options: {},
'options.conflictResolution': {},
'options.deduplicationStrategy': {},
'options.createRelationships': true
})
};
fetch('http://api.gu1.ai/entities/upsert', 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 => "http://api.gu1.ai/entities/upsert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'entity' => [
],
'options' => [
],
'options.conflictResolution' => [
],
'options.deduplicationStrategy' => [
],
'options.createRelationships' => true
]),
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 := "http://api.gu1.ai/entities/upsert"
payload := strings.NewReader("{\n \"entity\": {},\n \"options\": {},\n \"options.conflictResolution\": {},\n \"options.deduplicationStrategy\": {},\n \"options.createRelationships\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("http://api.gu1.ai/entities/upsert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": {},\n \"options\": {},\n \"options.conflictResolution\": {},\n \"options.deduplicationStrategy\": {},\n \"options.createRelationships\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/entities/upsert")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": {},\n \"options\": {},\n \"options.conflictResolution\": {},\n \"options.deduplicationStrategy\": {},\n \"options.createRelationships\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"action": "<string>",
"entity": {},
"previousEntity": {},
"confidence": 123,
"reasoning": "<string>",
"conflicts": [
{}
]
}Upsert de uma entidade
Cria ou atualiza uma entidade no gu1 com detecção de duplicatas que resolve conflitos em ID externo, identificação fiscal e dados de contato.
PUT
/
entities
/
upsert
Upsert
curl --request PUT \
--url http://api.gu1.ai/entities/upsert \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity": {},
"options": {},
"options.conflictResolution": {},
"options.deduplicationStrategy": {},
"options.createRelationships": true
}
'import requests
url = "http://api.gu1.ai/entities/upsert"
payload = {
"entity": {},
"options": {},
"options.conflictResolution": {},
"options.deduplicationStrategy": {},
"options.createRelationships": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity: {},
options: {},
'options.conflictResolution': {},
'options.deduplicationStrategy': {},
'options.createRelationships': true
})
};
fetch('http://api.gu1.ai/entities/upsert', 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 => "http://api.gu1.ai/entities/upsert",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'entity' => [
],
'options' => [
],
'options.conflictResolution' => [
],
'options.deduplicationStrategy' => [
],
'options.createRelationships' => true
]),
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 := "http://api.gu1.ai/entities/upsert"
payload := strings.NewReader("{\n \"entity\": {},\n \"options\": {},\n \"options.conflictResolution\": {},\n \"options.deduplicationStrategy\": {},\n \"options.createRelationships\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("http://api.gu1.ai/entities/upsert")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": {},\n \"options\": {},\n \"options.conflictResolution\": {},\n \"options.deduplicationStrategy\": {},\n \"options.createRelationships\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/entities/upsert")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"entity\": {},\n \"options\": {},\n \"options.conflictResolution\": {},\n \"options.deduplicationStrategy\": {},\n \"options.createRelationships\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"action": "<string>",
"entity": {},
"previousEntity": {},
"confidence": 123,
"reasoning": "<string>",
"conflicts": [
{}
]
}Visão Geral
O endpoint de upsert cria inteligentemente uma nova entidade ou atualiza uma existente com base em estratégias configuráveis de detecção de duplicatas. Ele gerencia automaticamente conflitos e previne registros duplicados usando correspondência exata, correspondência difusa ou detecção de similaridade alimentada por IA.Endpoint
PUT http://api.gu1.ai/entities/upsert
Autenticação
Requer uma chave de API válida no cabeçalho Authorization:Authorization: Bearer YOUR_API_KEY
Corpo da Requisição
object
required
Os dados da entidade (mesma estrutura de Criar entidade), incluindo campos raiz opcionais como
email, phone e nationality (ISO 3166-1 alpha-2 ou rótulo mapeável).O esquema pode aceitar as mesmas chaves que criar (ex.:
monitoring, autoExecuteIntegrations). O upsert não executa auto-enriquecimentos nem aplica monitoring. Use POST /entities ou POST /entities/automatic para lista / Regtia op 1 durante o enriquecimento.object
Opções de configuração para o comportamento do upsert
enum
Como lidar com conflitos quando uma entidade existente é encontrada:
source_wins- Novos dados sobrescrevem os dados existentestarget_wins- Mantém os dados existentes, ignora novos dadosmanual_review- Sinaliza para revisão manual sem atualizarsmart_merge(padrão) - Mescla inteligentemente ambos os conjuntos de dados
enum
Estratégia para detectar entidades duplicadas:
exact_match- Correspondência por externalId e taxId (insensível a maiúsculas)fuzzy_match- Correspondência de similaridade em name e taxId (limiar de 80%)ai_similarity- Detecção de similaridade semântica alimentada por IAhybrid(recomendado) - Correspondência exata com fallback difuso
boolean
default:"true"
Se deve criar automaticamente relacionamentos entre entidades
Resposta
boolean
Indica se a operação foi bem-sucedida
string
A ação realizada:
created ou updatedobject
O estado final da entidade após o upsert
object
O estado da entidade antes da atualização (null se recém-criada)
number
Pontuação de confiança (0-1) para a correspondência de detecção de duplicatas
string
Explicação do porquê a entidade foi criada/atualizada
array
Array de conflitos em nível de campo detectados durante a mesclagem (se houver)
Estratégias de Deduplicação
Correspondência Exata
Corresponde entidades com base em comparação exata de campos (insensível a maiúsculas):- Campos:
externalId,taxId - Caso de uso: Quando você tem identificadores únicos confiáveis
- Velocidade: Mais rápida
- Precisão: 100% para valores idênticos
Correspondência Difusa
Usa distância de Levenshtein para correspondência de similaridade:- Campos:
name,taxId - Limiar: 80% de similaridade
- Caso de uso: Ao lidar com erros de digitação ou variações
- Velocidade: Moderada
- Precisão: Alta para strings similares
Similaridade IA
Detecção de similaridade semântica alimentada por IA:- Método: Embeddings vetoriais e similaridade de cosseno
- Caso de uso: Correspondência complexa de múltiplos campos
- Velocidade: Mais lenta
- Precisão: Mais alta para entidades semanticamente similares
Híbrida (Recomendada)
Combina correspondência exata e difusa:- Primária: Correspondência exata em identificadores
- Fallback: Correspondência difusa em nomes
- Limiar de confiança: 80%
- Caso de uso: Melhor equilíbrio entre velocidade e precisão
Estratégias de Resolução de Conflitos
smart_merge (Padrão)
Mescla inteligentemente dados de ambas as fontes:- Prioridade: Dados mais recentes para campos simples
- Arrays: Mescla e deduplica
- Objetos: Mesclagem profunda com detecção de conflitos
- Valores vazios: Preserva valores existentes não vazios
source_wins
Novos dados substituem completamente os existentes:- Caso de uso: Quando os dados recebidos são autoritativos
- Comportamento: Todos os campos da origem
- Risco: Pode perder dados existentes valiosos
target_wins
Mantém dados existentes, ignora os recebidos:- Caso de uso: Quando os dados existentes são autoritativos
- Comportamento: Nenhuma atualização realizada
- Risco: Pode perder atualizações importantes
manual_review
Sinaliza conflitos sem resolução automática:- Caso de uso: Dados de alto risco que requerem revisão humana
- Comportamento: Cria tarefa de revisão
- Resultado: Entidade marcada para resolução manual
Exemplos
Upsert Simples (Comportamento Padrão)
curl -X PUT http://api.gu1.ai/entities/upsert \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"entity": {
"type": "person",
"externalId": "customer_12345",
"name": "María González",
"countryCode": "AR",
"taxId": "20-12345678-9",
"entityData": {
"person": {
"firstName": "María",
"lastName": "González",
"dateOfBirth": "1985-03-15",
"occupation": "Software Engineer",
"income": 85000
}
}
}
}'
const response = await fetch('http://api.gu1.ai/entities/upsert', {
method: 'PUT',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entity: {
type: 'person',
externalId: 'customer_12345',
name: 'María González',
countryCode: 'AR',
taxId: '20-12345678-9',
entityData: {
person: {
firstName: 'María',
lastName: 'González',
dateOfBirth: '1985-03-15',
occupation: 'Software Engineer',
income: 85000
}
}
}
})
});
const result = await response.json();
console.log(`Action: ${result.action}`); // 'created' or 'updated'
console.log(`Confidence: ${result.confidence}`);
import requests
response = requests.put(
'http://api.gu1.ai/entities/upsert',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'entity': {
'type': 'person',
'externalId': 'customer_12345',
'name': 'María González',
'countryCode': 'AR',
'taxId': '20-12345678-9',
'entityData': {
'person': {
'firstName': 'María',
'lastName': 'González',
'dateOfBirth': '1985-03-15',
'occupation': 'Software Engineer',
'income': 85000
}
}
}
}
)
result = response.json()
print(f"Action: {result['action']}")
print(f"Confidence: {result['confidence']}")
Upsert com Estratégia de Correspondência Exata
curl -X PUT http://api.gu1.ai/entities/upsert \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"entity": {
"type": "company",
"externalId": "company_789",
"name": "Tech Solutions S.A.",
"countryCode": "BR",
"taxId": "12.345.678/0001-90",
"entityData": {
"company": {
"legalName": "Tech Solutions Sociedade Anônima",
"revenue": 7500000
}
}
},
"options": {
"deduplicationStrategy": "exact_match",
"conflictResolution": "smart_merge"
}
}'
const response = await fetch('http://api.gu1.ai/entities/upsert', {
method: 'PUT',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entity: {
type: 'company',
externalId: 'company_789',
name: 'Tech Solutions S.A.',
countryCode: 'BR',
taxId: '12.345.678/0001-90',
entityData: {
company: {
legalName: 'Tech Solutions Sociedade Anônima',
revenue: 7500000
}
}
},
options: {
deduplicationStrategy: 'exact_match',
conflictResolution: 'smart_merge'
}
})
});
const result = await response.json();
if (result.action === 'updated') {
console.log('Found and updated existing company');
console.log('Conflicts:', result.conflicts);
}
import requests
response = requests.put(
'http://api.gu1.ai/entities/upsert',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'entity': {
'type': 'company',
'externalId': 'company_789',
'name': 'Tech Solutions S.A.',
'countryCode': 'BR',
'taxId': '12.345.678/0001-90',
'entityData': {
'company': {
'legalName': 'Tech Solutions Sociedade Anônima',
'revenue': 7500000
}
}
},
'options': {
'deduplicationStrategy': 'exact_match',
'conflictResolution': 'smart_merge'
}
}
)
result = response.json()
if result['action'] == 'updated':
print("Found and updated existing company")
print(f"Conflicts: {result['conflicts']}")
Upsert com Correspondência Difusa
curl -X PUT http://api.gu1.ai/entities/upsert \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"entity": {
"type": "person",
"externalId": "customer_new_123",
"name": "Maria Gonzales",
"countryCode": "AR",
"taxId": "20-12345678-9",
"entityData": {
"person": {
"firstName": "Maria",
"lastName": "Gonzales"
}
}
},
"options": {
"deduplicationStrategy": "fuzzy_match",
"conflictResolution": "smart_merge"
}
}'
// Vai corresponder "Maria Gonzales" com "María González" existente
// devido ao limiar de similaridade de 80%+
const response = await fetch('http://api.gu1.ai/entities/upsert', {
method: 'PUT',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entity: {
type: 'person',
externalId: 'customer_new_123',
name: 'Maria Gonzales', // Leve variação na ortografia
countryCode: 'AR',
taxId: '20-12345678-9',
entityData: {
person: {
firstName: 'Maria',
lastName: 'Gonzales'
}
}
},
options: {
deduplicationStrategy: 'fuzzy_match',
conflictResolution: 'smart_merge'
}
})
});
const result = await response.json();
console.log(`Matched with confidence: ${result.confidence}`);
console.log(`Reasoning: ${result.reasoning}`);
import requests
# Vai corresponder "Maria Gonzales" com "María González" existente
response = requests.put(
'http://api.gu1.ai/entities/upsert',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'entity': {
'type': 'person',
'externalId': 'customer_new_123',
'name': 'Maria Gonzales', # Leve variação
'countryCode': 'AR',
'taxId': '20-12345678-9',
'entityData': {
'person': {
'firstName': 'Maria',
'lastName': 'Gonzales'
}
}
},
'options': {
'deduplicationStrategy': 'fuzzy_match',
'conflictResolution': 'smart_merge'
}
}
)
result = response.json()
print(f"Matched with confidence: {result['confidence']}")
print(f"Reasoning: {result['reasoning']}")
Estratégia Híbrida (Recomendada)
curl -X PUT http://api.gu1.ai/entities/upsert \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"entity": {
"type": "company",
"externalId": "comp_456",
"name": "TechSolutions SA",
"countryCode": "BR",
"taxId": "12.345.678/0001-90",
"entityData": {
"company": {
"employeeCount": 100
}
}
},
"options": {
"deduplicationStrategy": "hybrid"
}
}'
// Tenta correspondência exata primeiro, fallback para difusa se necessário
const response = await fetch('http://api.gu1.ai/entities/upsert', {
method: 'PUT',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entity: {
type: 'company',
externalId: 'comp_456',
name: 'TechSolutions SA', // Variação de "Tech Solutions S.A."
countryCode: 'BR',
taxId: '12.345.678/0001-90', // Correspondência exata no ID fiscal
entityData: {
company: {
employeeCount: 100
}
}
},
options: {
deduplicationStrategy: 'hybrid' // O melhor dos dois mundos
}
})
});
const result = await response.json();
// Vai corresponder por taxId (exata) ou name (difusa)
console.log(`Strategy used: ${result.reasoning}`);
import requests
# Híbrida: tenta correspondência exata primeiro, difusa como fallback
response = requests.put(
'http://api.gu1.ai/entities/upsert',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'entity': {
'type': 'company',
'externalId': 'comp_456',
'name': 'TechSolutions SA',
'countryCode': 'BR',
'taxId': '12.345.678/0001-90',
'entityData': {
'company': {
'employeeCount': 100
}
}
},
'options': {
'deduplicationStrategy': 'hybrid'
}
}
)
result = response.json()
print(f"Strategy used: {result['reasoning']}")
Exemplos de Resposta
Nova Entidade Criada
{
"success": true,
"action": "created",
"entity": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "customer_12345",
"type": "person",
"name": "María González",
...
},
"previousEntity": null,
"confidence": 1.0,
"reasoning": "No existing entity found matching criteria. Created new entity.",
"conflicts": []
}
Entidade Existente Atualizada
{
"success": true,
"action": "updated",
"entity": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "customer_12345",
"type": "person",
"name": "María González",
"entityData": {
"person": {
"income": 95000
}
},
...
},
"previousEntity": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"entityData": {
"person": {
"income": 85000
}
},
...
},
"confidence": 1.0,
"reasoning": "Exact match found on externalId. Updated existing entity with smart merge.",
"conflicts": [
{
"field": "entityData.person.income",
"oldValue": 85000,
"newValue": 95000,
"resolution": "source_wins"
}
]
}
Casos de Uso
Importação de Dados de Sistema Externo
// Importar dados de clientes do CRM, evitando duplicatas
async function importCustomer(crmData) {
const response = await fetch('http://api.gu1.ai/entities/upsert', {
method: 'PUT',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
entity: {
type: 'person',
externalId: crmData.customerId,
name: crmData.fullName,
countryCode: crmData.country,
taxId: crmData.taxId,
entityData: {
person: {
firstName: crmData.firstName,
lastName: crmData.lastName,
income: crmData.annualIncome
}
},
attributes: {
source: 'crm_import',
importDate: new Date().toISOString()
}
},
options: {
deduplicationStrategy: 'hybrid',
conflictResolution: 'smart_merge'
}
})
});
return response.json();
}
Enriquecimento Progressivo de Dados
def enrich_entity_data(external_id, new_data):
"""Adiciona progressivamente dados à entidade conforme ficam disponíveis"""
response = requests.put(
'http://api.gu1.ai/entities/upsert',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'entity': {
'type': 'person',
'externalId': external_id,
'name': new_data.get('name'),
'countryCode': new_data.get('country'),
'entityData': new_data.get('details', {}),
'attributes': new_data.get('attributes', {})
},
'options': {
'deduplicationStrategy': 'exact_match',
'conflictResolution': 'smart_merge' # Mescla novos com existentes
}
}
)
result = response.json()
if result['action'] == 'updated':
print(f"Enriched existing entity with new data")
return result
Melhores Práticas
-
Escolha a Estratégia Certa:
exact_matchpara dados limpos e estruturados com IDs confiáveisfuzzy_matchpara dados digitados por usuários com potenciais erroshybridpara a maioria dos cenários de produção
-
Gerencie Conflitos com Cuidado:
- Use
smart_mergepara resolução automática - Use
manual_reviewpara dados financeiros críticos - Verifique o array
conflictsna resposta para mudanças importantes
- Use
-
Monitore as Pontuações de Confiança:
- Pontuações abaixo de 0.7 podem indicar correspondências fracas
- Registre atualizações com baixa confiança para revisão
- Considere limiar de revisão manual
-
Gerenciamento de Relacionamentos:
- Defina
createRelationships: truepara vincular automaticamente entidades relacionadas - Útil para relacionamentos transação-cliente, empresa-pessoa
- Defina
Respostas de Erro
400 Bad Request
{
"error": "Invalid tax ID format for country"
}
400 Campos Obrigatórios Ausentes
{
"error": "Missing required fields",
"missingFields": ["legalName"],
"requiredFields": ["legalName", "industry"]
}
500 Internal Server Error
{
"error": "Failed to upsert entity"
}
Próximos Passos
- Batch Upsert - Processar múltiplas entidades de uma vez
- List Entities - Consultar entidades com upsert
- Update Entity - Fazer atualizações direcionadas
- Get Entity - Recuperar detalhes completos da entidade
Was this page helpful?