Pular para o conteúdo principal
Biblioteca Java para a API da DeepXL: detecção de fraudes, processamento de documentos e verificação de identidade.

​
Instalação

​
Maven

Adicione a seguinte dependência ao seu pom.xml: 
<dependency>
    <groupId>ai.deepxl.sdk</groupId>
    <artifactId>deepxl</artifactId>
    <version>1.0.0</version>
</dependency>

​
Exemplo

Crie uma chave de API no DeepXL Dashboard (Configurações → Chaves de API).
Trate sua chave de API como qualquer segredo de ambiente. Não faça commit em um repositório público nem armazene em texto simples.
import ai.deepxl.sdk.DeepXLClient;
import ai.deepxl.sdk.DeepXLError;
import com.google.gson.JsonObject;

DeepXLClient client = new DeepXLClient(System.getenv("DEEPXL_API_KEY"));

try {
    JsonObject detection = client.detectFile("document", "./file.pdf");
    JsonObject parsed = client.parseFile("light", "./id.pdf");
    JsonObject verification = client.verifyFiles("./id.jpg", "./selfie.jpg");
    System.out.println(detection.get("likelihood") + " " + parsed.get("documentType") + " " + verification.get("verified"));
} catch (DeepXLError e) {
    // Handle error
}

​
Métodos do cliente

​
Conta

  • checkUsage() – GET /v1/account. Retorna UsageResponse (uso e limites por tipo de mídia).

​
Modelos

  • getDetectionModels() – GET /v1/detection-models. Retorna JsonArray de objetos de modelo.
  • getParsingModels() – GET /v1/parsing-models. Retorna JsonArray de objetos de modelo.

​
Detecção de fraudes

  • detect(modelName, fileName, fileData [, tagsJson]) / detectFile(modelName, filePath [, tagsJson]) – POST /v1/detection. Modelos: document, object. Retorna JsonObject.
  • getDetection(detectionId) – GET /v1/detection/. Retorna JsonObject.
  • listDetections() / listDetections(params) – GET /v1/detection. Parâmetros: Map com limit, offset, sortBy, direction, tagFilter. Retorna JsonObject com totalCount, count, data.

​
Processamento de documentos

  • parse(modelName, fileName, fileData [, tagsJson]) / parseFile(modelName, filePath [, tagsJson]) – POST /v1/parse. Modelos: light, performance. Retorna JsonObject.
  • getParse(parseId) – GET /v1/parse/. Retorna JsonObject.
  • listParses() / listParses(params) – GET /v1/parse. Retorna JsonObject com totalCount, count, data.

​
Verificação de identidade

  • verify(idFileName, idFileData, selfieFileName, selfieFileData [, tagsJson]) / verifyFiles(idFilePath, selfieFilePath [, tagsJson]) – POST /v1/verification. Retorna JsonObject.
  • getVerification(verificationId) – GET /v1/verification/. Retorna JsonObject.
  • listVerifications() / listVerifications(params) – GET /v1/verification. Retorna JsonObject com totalCount, count, data.

​
Recuperação de arquivos

  • getFile(fileName) – GET /v1/files/. Retorna byte[]. Use o nome do arquivo do array files em qualquer resposta de análise.

​
Erros

Todos os métodos lançam DeepXLError para erros de API (chave inválida, requisição incorreta, limite de uso, não encontrado etc.).