Obtenir une liste de transactions

Une liste de toutes les transactions actives ou terminées peut servir à :

Suivre les transactions actives actuellement à l’étape de relecture manuelle.
Obtenir un lien de relecture manuelle pour les transactions actives.
Télécharger les fichiers de résultats des transactions terminées.

Vous pouvez obtenir une liste de transactions avec leurs identifiants à l’aide de l’API Vantage. Vous pouvez utiliser Skill Monitor pour appliquer des filtres plus avancés.

Liste des transactions actives

Pour obtenir une liste des transactions actives, envoyez une requête GET à la ressource transactions/active. Dans le corps de la requête, indiquez les paramètres suivants :

Parameter	Description
StageType	L’étape de la transaction. Les valeurs possibles sont : - ManuaReview - CustomActivity - Automatic (toutes les étapes pour lesquelles l’intervention de l’utilisateur n’est pas requise, par exemple l’extraction de champs)
StageName	Le nom de l’action spécifique (uniquement pour l’étape ManualReview).
SkillId	L’identifiant du Skill. Si aucune valeur n’est spécifiée, tous les Skills disponibles seront pris en compte.
SkillVersion	La version du Skill. Si aucune valeur n’est spécifiée, toutes les versions des Skills disponibles seront prises en compte.
StartDate	L’horodatage de création de la transaction la plus ancienne (doit être spécifié au format UTC).
EndDate	L’horodatage de création de la transaction la plus récente (doit être spécifié au format UTC). Si cette valeur n’est pas spécifiée, l’heure UTC actuelle sera utilisée à la place.
TransactionParameters	La liste des paramètres de transaction composée de paires clé-valeur de type string. Ces paramètres fournissent des informations utilisateur supplémentaires (par exemple, le nom du client). Les paramètres doivent être fournis au format suivant : `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La liste des paramètres de document composée de paires clé-valeur de type string. Ces paramètres fournissent des informations supplémentaires sur le document (par exemple, le nom du fichier). Les paramètres doivent être fournis au format suivant : `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	Le décalage de pagination. La valeur par défaut du paramètre est 0.
Limit	La limite de pagination. Ce paramètre est obligatoire. La valeur par défaut du paramètre est 0.

Exemple de requête : La réponse à une requête pour laquelle un identifiant de compétence est spécifié contiendra un fichier JSON similaire au suivant :

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review",
      "seqId": 13758,
      "transactionId": "56a50415-fe1d-4493-81ba-97ff07e3ffce",
      "createTimeUtc": "2023-09-11T13:53:30.633Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "skillId": "workspace.default.processing",
      "skillVersion": 18,
      "documentCount": 1
    }
  ],
  "totalItemCount": 7
}

La réponse à une requête pour laquelle une étape et une action sont spécifiées contiendra un fichier JSON contenant toutes les transactions actives, similaire à ce qui suit :

{
  "items": [
    {
      "stage": "ManualReview",
      "stageName": "Review2",
      "seqId": 13852,
      "transactionId": "e646754e-d854-4b21-af91-58cb63ead7a6",
      "createTimeUtc": "2023-09-11T14:04:37.97Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 2
}

Vous pouvez également obtenir un lien client de relecture manuelle pour les transactions en cours. Pour ce faire, envoyez une requête GET à la ressource transactions/<transaction_id> avec l’identifiant de la transaction dans l’URI de la requête. Exemple de requête : La réponse contiendra un code semblable à ce qui suit : La clé manualReviewLink contiendra un lien vers l’interface Web du client de relecture manuelle ainsi qu’un jeton d’accès Vantage, si une relecture manuelle est requise. Ce lien et ce jeton peuvent être utilisés pour vérifier et corriger les résultats de classification et d’extraction des champs d’une transaction spécifique. Le lien fourni est valide pendant 168 heures, après quoi un nouveau lien doit être créé et récupéré pour une nouvelle période de 168 heures en utilisant la même méthode. Pour plus d’informations, voir Intégration de la relecture manuelle.

Les utilisateurs autorisés via ce lien ne pourront pas afficher ni modifier d’autres documents ou transactions.

Liste des transactions terminées

Pour obtenir une liste des transactions terminées, envoyez une requête GET à la ressource transactions/completed. Dans le corps de la requête, spécifiez les paramètres suivants :

Parameter	Description
TransactionStatus	Le statut de la transaction. Les valeurs possibles sont : - Processed - Canceled - Failed
SkillId	L’identifiant de la compétence. Si aucune valeur n’est spécifiée, toutes les compétences disponibles seront prises en compte.
SkillVersion	La version de la compétence. Si aucune valeur n’est spécifiée, toutes les versions des compétences disponibles seront prises en compte.
StartDate	La date et l’heure de création de la première transaction (doit être spécifiée au format UTC).
EndDate	La date et l’heure de création de la dernière transaction (doit être spécifiée au format UTC). Si cette valeur n’est pas spécifiée, l’heure UTC actuelle sera utilisée à la place.
TransactionParameters	La liste des paramètres de transaction, composée de paires clé-valeur de type string. Ces paramètres fournissent des informations supplémentaires sur l’utilisateur (par exemple, le nom du client). Les paramètres doivent être fournis au format suivant : `TransactionParameters={“key”: “string_1”,”value”:”string”}&TransactionParameters={“key”: “string_2”,”value”:”string”}`
DocumentParameters	La liste des paramètres de document, composée de paires clé-valeur de type string. Ces paramètres fournissent des informations supplémentaires sur le document (par exemple, le nom du fichier). Les paramètres doivent être fournis au format suivant : `DocumentParameters={“key”: “string_1”,”value”:”string”}&DocumentParameters={“key”: “string_2”,”value”:”string”}`
Offset	Le décalage de pagination. La valeur par défaut de ce paramètre est 0.
Limit	La limite de pagination. Ce paramètre est obligatoire. La valeur par défaut de ce paramètre est 0.

La réponse contiendra un fichier JSON avec toutes les transactions terminées et un nombre de pages traitées similaire à ce qui suit :

{
  "items": [
    {
      "status": "FinishedSuccessfully",
      "pageCount": 1,
      "seqId": 13705,
      "transactionId": "fc9920fe-f788-47f8-9972-b767493faed9",
      "createTimeUtc": "2023-09-11T13:47:50.273Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "App",
          "value": "PublicAPI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "string",
          "value": "string"
        },
        {
          "isReadOnly": true,
          "key": "Index",
          "value": "0"
        },
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "BillofLading_1.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "PublicAPI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 29842,
      "transactionId": "c0dd3e08-f295-4c6c-b919-31eaa67817cc",
      "createTimeUtc": "2023-09-12T19:28:01.27Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36254,
      "transactionId": "8391871e-abf5-41bc-8a66-1059418a3843",
      "createTimeUtc": "2023-09-13T08:53:41.9Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed _1_.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36632,
      "transactionId": "7f7cd557-a03e-42e3-a454-e7981e8e9fc0",
      "createTimeUtc": "2023-09-13T09:35:27.48Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    },
    {
      "status": "FinishedSuccessfully",
      "pageCount": 2,
      "seqId": 36663,
      "transactionId": "c9b3cd4d-d90f-48be-adc2-99985ece4e11",
      "createTimeUtc": "2023-09-13T09:38:29.573Z",
      "transactionParameters": [
        {
          "isReadOnly": true,
          "key": "App",
          "value": "VantageUI"
        }
      ],
      "fileParameters": [
        {
          "isReadOnly": true,
          "key": "SourceFileName",
          "value": "Invoice _ 1213123123 _2__signed_signed _1__signed.pdf"
        },
        {
          "isReadOnly": true,
          "key": "SourceType",
          "value": "VantageUI"
        }
      ],
      "documentCount": 1
    }
  ],
  "totalItemCount": 5
}

​Liste des transactions actives

​Liste des transactions terminées

Liste des transactions actives

Liste des transactions terminées