Méthodes

Utilisez les méthodes de sortie Données du document pour accéder aux valeurs de champ extraites en fonction du paramètre Générer un type de données de l’activité Extraire les données du document.

Le paramètre Générer un type de données (Generate Data Type) dans l’activité Extraire les données du document (Extract Document Data) détermine les types de sortie Données du document (Document Data) :

1. Lorsque l’option Générer les données est True, les Données du document sont générées sous la forme IDocumentData<ExtractorType>.
2. Lorsque l’option Générer les données est False, les Données du document sont générées sous la forme IDocumentData<DictionaryData>.

Le type IDocumentData<DictionaryData> vous permet de récupérer et de modifier les valeurs de champ à l’aide de certaines méthodes. Vous pouvez également modifier le type de document dans la station de validation.

You can work with this output in two ways:

• The lower-level Get/Set methods documented on this page, which return raw extraction objects such as ResultsDataPoint and ResultsValue.
• The strongly-typed Handler property, which exposes an ExtractionResultHandler navigator for a fluent, typed way to read and edit fields, tables, and field groups.

The following sections show the available members for DocumentData.Data.

Remarque :

Le paramètre fieldIdOrName est traité à la fois comme l’identifiant et le nom du champ.

Handler

Returns an ExtractionResultHandler — the strongly-typed V1 navigator over the extraction result. It provides a fluent, typed alternative to the Get/Set methods for reading and editing fields, tables, and field groups.

Syntaxe

Handler

RetournerValeur

ExtractionResultHandler

The navigator over the document's extraction result.

Exemple

The following example shows how to use the property:

var handler = DocumentData.Data.Handler;
// Read a basic field value through the navigator.
string invoiceDate = handler.GetSimpleField("InvoiceDate")?.Value?.Value;

GetFields()

Renvoie toutes les informations des champs d’un type de document, à l’exception des champs de table.

Syntaxe

GetFields()

RetournerValeur

ResultsDataPoint[]

Tableau de tous les champs et de leurs valeurs extraites associées.

Exemple

The following example shows how to use the method:

ResultsDataPoint[] allFields = DocumentData.Data.GetFields()

GetField(string)

Renvoie toutes les informations du champ, selon un ID ou un nom de champ donné.

Syntaxe

GetField(string fieldIdOrName)

Paramètres

• fieldIdOrName String: l'ID ou le nom du champ que vous souhaitez récupérer ou définir. La méthode recherche d’abord une correspondance à l’aide de l’ID. Si aucune correspondance n’est trouvée, la recherche utilisera alors la même valeur que le nom du champ.

  Vous pouvez découvrir l’ID et le nom du champ des manières suivantes :

  • Accédez à la section Créer (Build) de votre projet. Sélectionnez le gestionnaire de type de document pour un exemple de document. Passez à Champs (Fields), puis sélectionnez Paramètres avancés (Advanced Settings) pour le champ pertinent.

  

  • Ouvrez la station de validation et, sous Type de document (Document Type), recherchez les noms de champ existants.
  • Si vous utilisez des API Document Understanding, vous pouvez utiliser les API du service Discovery pour récupérer les noms et les ID des champs. Consultez la page Utiliser les API de découverte pour vérifier les appels API disponibles.

RetournerValeur

ResultsDataPoint

Le champ et ses valeurs extraites associées.

Exemple

The following example shows how to use the method, when the desired field ID or name is vendor:

ResultsDataPoint vendorData = DocumentData.Data.GetField("vendor");

GetFieldValue(string)

Renvoie la première valeur de champ, basée sur un ID de champ ou un nom donné.

Syntaxe

GetFieldValue(string fieldIdOrName)

Paramètres

• fieldIdOrName String L'ID ou le nom du champ que vous souhaitez récupérer ou définir. La méthode recherche d’abord une correspondance à l’aide de l’ID. Si aucune correspondance n’est trouvée, la recherche utilisera alors la même valeur que le nom du champ.

  Vous pouvez découvrir l’ID et le nom du champ des manières suivantes :

  • Accédez à la section Créer (Build) de votre projet. Sélectionnez le gestionnaire de type de document pour un exemple de document. Passez à Champs (Fields), puis sélectionnez Paramètres avancés (Advanced Settings) pour le champ pertinent.

  

  • Ouvrez la station de validation et, sous Type de document (Document Type), recherchez les noms de champ existants.
  • Si vous utilisez des API Document Understanding, vous pouvez utiliser les API du service Discovery pour récupérer les noms et les ID des champs. Consultez la page Utiliser les API de découverte pour vérifier les appels API disponibles.

RetournerValeur

ResultsValue

La valeur signalée pour un champ dans un résultat d’extraction.

Exceptions

Si fieldIdOrName est introuvable, l’exception suivante est levée : Field {FieldIDOrName} introuvable.

Exemple

The following example shows how to use the method, when the field ID or name is vendor:

ResultsValue fieldValue = DocumentData.Data.GetFieldValue("vendor");
    // stores the value of the fieldValue object in a string variable
    string value = fieldValue.Value;
    // stores the confidence of the fieldValue object in a float variable
    float confidence = fieldValue.Confidence;

GetFieldValue(string, int)

Renvoie une valeur de champ, basée sur un ID de champ ou un nom donné, ainsi que le champ index, pour renvoyer une valeur spécifique à partir du tableau de valeurs.

Cette méthode s’applique aux champs simples.

Syntaxe

GetFieldValue(string fieldIdOrName, int index)

Paramètres

• fieldIdOrName String L'ID ou le nom du champ que vous souhaitez récupérer ou définir. La méthode recherche d’abord une correspondance à l’aide de l’ID. Si aucune correspondance n’est trouvée, la recherche utilisera alors la même valeur que le nom du champ.

  Vous pouvez découvrir l’ID et le nom du champ des manières suivantes :

  • Accédez à la section Créer (Build) de votre projet. Sélectionnez le gestionnaire de type de document pour un exemple de document. Passez à Champs (Fields), puis sélectionnez Paramètres avancés (Advanced Settings) pour le champ pertinent.

  

  • Ouvrez la station de validation et, sous Type de document (Document Type), recherchez les noms de champ existants.
  • Si vous utilisez des API Document Understanding, vous pouvez utiliser les API du service Discovery pour récupérer les noms et les ID des champs. Consultez la page Utiliser les API de découverte pour vérifier les appels API disponibles.

• index Int : l'index d'une valeur spécifique.

RetournerValeur

ResultsValue

La valeur signalée pour un champ dans un résultat d’extraction.

Exceptions

• Si fieldIdOrName est introuvable, l’exception suivante est levée : Field {fieldIdOrName} introuvable.
• Si index est introuvable, l’exception suivante est levée : Index is out of range.

Exemple

The following example shows how to use the method, where field ID is vendor, and the index for the desired value is 2:

ResultsValue fieldValue = DocumentData.Data.GetFieldValue("vendor", 2);
    // store the retrieved value in a string variable
    string value = fieldValue.Value;
    // retrieve and store the confidence level of the field value
    float confidence = fieldValue.Confidence

GetFieldValues(string)

Renvoie toutes les valeurs d’un champ d’un type de document, en fonction de l’ID ou du nom d’un champ donné.

Cette méthode s’applique non seulement aux champs à valeurs multiples, mais également aux champs pour lesquels le modèle d’extraction fournit des valeurs alternatives. Cela signifie qu’un champ peut avoir plusieurs valeurs d’alternatives, même s’il n’est pas automatiquement un champ à valeurs multiples.

Syntaxe

GetFieldValues(string fieldIdOrName)

Paramètres

• fieldIdOrName String L'ID ou le nom du champ que vous souhaitez récupérer ou définir. La méthode recherche d’abord une correspondance à l’aide de l’ID. Si aucune correspondance n’est trouvée, la recherche utilisera alors la même valeur que le nom du champ.

  Vous pouvez découvrir l’ID et le nom du champ des manières suivantes :

  • Accédez à la section Créer (Build) de votre projet. Sélectionnez le gestionnaire de type de document pour un exemple de document. Passez à Champs (Fields), puis sélectionnez Paramètres avancés (Advanced Settings) pour le champ pertinent.

  

  • Ouvrez la station de validation et, sous Type de document (Document Type), recherchez les noms de champ existants.
  • Si vous utilisez des API Document Understanding, vous pouvez utiliser les API du service Discovery pour récupérer les noms et les ID des champs. Consultez la page Utiliser les API de découverte pour vérifier les appels API disponibles.

RetournerValeur

ResultsValue[]

Tableau des valeurs signalées pour un champ dans un résultat d’extraction.

Exceptions

Si fieldIdOrName est introuvable, l’exception suivante est levée : Field {fieldIdOrName} introuvable.

Exemple

The following example shows how to use the method, where field ID is vendor:

ResultsValue[] fieldValues = DocumentData.Data.GetFieldValues("vendor");

GetTables()

Renvoie toutes les informations de champ de toutes les tables dans un type de document.

Syntaxe

GetTables()

RetournerValeur

ResultsTable[]

Le champ de table extrait sous forme de tableau et contenant un ou plusieurs objets ValeursTableRésultats (ResultsTableValues) (pour prendre en charge respectivement les tables à valeur unique et les tables à valeurs multiples). Chaque valeur a un tableau de valeurs CellulesTableauRésultats (ResultsTableCells). Chaque cellule a un tableau de valeurs ResultsValue (ResultsValue) qui est l’objet de valeur standard utilisé pour les champs simples.

Exemple

The following example shows how to use the method:

ResultsTable[] tableValues = DocumentData.Data.GetTables();

GetTable(string)

Renvoie toutes les informations de champ d’une table dans un type de document, selon un ID donné.

Syntaxe

GetTable(string tableID)

Paramètres

• tableID String : l'ID de la table à récupérer. Vous pouvez trouver l’ID de table en accédant à la section Créer de votre projet. Sélectionnez le gestionnaire de type de document pour l’exemple de document. Passez à Champs, puis sélectionnez Paramètres avancés pour le champ de table pertinent.

RetournerValeur

ResultsTable

Le champ de table extrait contenant un ou plusieurs objets ValeursTableRésultats (ResultsTableValues) (pour prendre en charge respectivement les tables à valeur unique et les tables à valeurs multiples). Chaque valeur a un tableau de valeurs CellulesTableauRésultats (ResultsTableCells). Chaque cellule a un tableau de valeurs ResultsValue (ResultsValue) qui est l’objet de valeur standard utilisé pour les champs simples.

Exemple

The following example shows how to use the method, where table ID is prices:

var tableValues = DocumentData.Data.GetTable("prices");

SetFieldValue(string, ResultsValue)

Remplace un tableau entier de valeurs identifiées par l’ID de champ, avec la valeur spécifiée.

Syntaxe

SetFieldValue(string fieldID, ResultsValue value)

Paramètres

• fieldIdOrName String L'ID ou le nom du champ que vous souhaitez récupérer ou définir. La méthode recherche d’abord une correspondance à l’aide de l’ID. Si aucune correspondance n’est trouvée, la recherche utilisera alors la même valeur que le nom du champ.

  Vous pouvez découvrir l’ID et le nom du champ des manières suivantes :

  • Accédez à la section Créer (Build) de votre projet. Sélectionnez le gestionnaire de type de document pour un exemple de document. Passez à Champs (Fields), puis sélectionnez Paramètres avancés (Advanced Settings) pour le champ pertinent.

  

  • Ouvrez la station de validation et, sous Type de document (Document Type), recherchez les noms de champ existants.
  • Si vous utilisez des API Document Understanding, vous pouvez utiliser les API du service Discovery pour récupérer les noms et les ID des champs. Consultez la page Utiliser les API de découverte pour vérifier les appels API disponibles.

• value ValeurRésultats : la valeur que vous souhaitez définir pour un champ.

Exceptions

Si fieldID est introuvable, l’exception suivante est levée : Field {FieldIDOrName} introuvable.

Exemple

The following example shows how to use the method, where we first create the field value using the ResultsValue.CreateWithNoReference helper method. The helper method takes the following parameters:

• Le premier paramètre représente la valeur.
• Le second paramètre représente la confiance.
• Le troisième paramètre représente la confiance de l’OCR.

Après avoir créé l’objet de valeur de champ taxValue, nous remplaçons les potentielles valeurs préexistantes du champ tax (le cas échéant) par un nouveau tableau contenant uniquement l’objet taxValue. Dans cette instance, le champ tax utilisera la nouvelle valeur 10 dans la mesure où nous utilisons SetFieldValue.

var taxValue = ResultsValue.CreateWithNoReference("10", 1, 1);
documentData.Data.SetFieldValue("tax", taxValue);

SetFieldValue(string, ResultsValue, int)

Définit une valeur de champ basée sur un ID ou un nom de champ donné et basée sur un index de champ.

Cette méthode s’applique aux champs simples.

Syntaxe

SetFieldValue(string fieldID, ResultsValue value, int index)

Paramètres

• fieldIdOrName String L'ID ou le nom du champ que vous souhaitez récupérer ou définir. La méthode recherche d’abord une correspondance à l’aide de l’ID. Si aucune correspondance n’est trouvée, la recherche utilisera alors la même valeur que le nom du champ.

  Vous pouvez découvrir l’ID et le nom du champ des manières suivantes :

  • Accédez à la section Créer (Build) de votre projet. Sélectionnez le gestionnaire de type de document pour un exemple de document. Passez à Champs (Fields), puis sélectionnez Paramètres avancés (Advanced Settings) pour le champ pertinent.

  

  • Ouvrez la station de validation et, sous Type de document (Document Type), recherchez les noms de champ existants.
  • Si vous utilisez des API Document Understanding, vous pouvez utiliser les API du service Discovery pour récupérer les noms et les ID des champs. Consultez la page Utiliser les API de découverte pour vérifier les appels API disponibles.

• value ValeurRésultats : la valeur que vous souhaitez définir pour un champ.

• index Int : l'index d'une valeur spécifique.

Exceptions

• Si fieldID est introuvable, l’exception suivante est levée : Field {FieldIDOrName} introuvable.
• Si index est introuvable, l’exception suivante est levée : Index is out of range.

Exemple

The following example shows how to use the method, where we first create the field value using the ResultsValue.CreateWithNoReference helper method. The helper method takes the following parameters:

• Le premier paramètre représente le tableau des valeurs.
• Le second paramètre représente la confiance.
• Le troisième paramètre représente la confiance de l’OCR.

Après avoir créé l’objet de valeur de champ taxValue, nous procédons au remplacement de la valeur à l’index 1 du tableau de champs tax par ce nouvel objet taxValue. Ici, la méthode SetFieldValue est utilisée pour remplacer la valeur à l’index 1.

var taxValue = ResultsValue.CreateWithNoReference("10", 1, 1);
documentData.Data.SetFieldValue("tax", new [] {taxValue}, 1);

SetFieldValues(string, ResultsValue[])

Remplace l’ensemble du tableau de valeurs par un autre tableau de valeurs spécifié, pour un ID de champ ou un nom donné.

Syntaxe

SetFieldValues(string fieldID, ResultsValue[] values)

Paramètres

• fieldIdOrName String L'ID ou le nom du champ que vous souhaitez récupérer ou définir. La méthode recherche d’abord une correspondance à l’aide de l’ID. Si aucune correspondance n’est trouvée, la recherche utilisera alors la même valeur que le nom du champ.

  Vous pouvez découvrir l’ID et le nom du champ des manières suivantes :

  • Accédez à la section Créer (Build) de votre projet. Sélectionnez le gestionnaire de type de document pour un exemple de document. Passez à Champs (Fields), puis sélectionnez Paramètres avancés (Advanced Settings) pour le champ pertinent.

  

  • Ouvrez la station de validation et, sous Type de document (Document Type), recherchez les noms de champ existants.
  • Si vous utilisez des API Document Understanding, vous pouvez utiliser les API du service Discovery pour récupérer les noms et les ID des champs. Consultez la page Utiliser les API de découverte pour vérifier les appels API disponibles.

• values ValeurRésultats[] : le tableau des valeurs que vous souhaitez définir pour un champ.

Exceptions

Si fieldID est introuvable, l’exception suivante est levée : Field {FieldIDOrName} introuvable.

Exemple

The following example shows how to use this method, where we first create two field value objects using the ResultsValue.CreateWithNoReference helper method : total1 and total2. The helper method accepts three parameters:

1. Le premier paramètre représente la valeur réelle.
2. Le deuxième paramètre représente la valeur de confiance.
3. Le troisième paramètre représente la valeur de confiance de l’OCR.

Après avoir créé ces valeurs de champ, nous remplaçons les valeurs d’un champ nommé Total Amount par un tableau contenant total1 et total2.

var total1 = ResultsValue.CreateWithNoReference("100", 1, 1);
    var total2 = ResultsValue.CreateWithNoReference("200", 1, 1);
    documentData.Data.SetFieldValues("Total Amount", new []{total1, total2});