Champs (Fields)
Les Champs (Fields) sont les informations extraites des documents.
Créer un Paramètre (Parameter)
POST
https://api.openai.com/v1/create_parameter
Créé un Paramètre (Parameter)
Request body
Template_id Integer Required L’ID du Dossier (Folder) dans lequel le Paramètre est créé.
Name String Required Le nom du Paramètre (Parameter) à créer, unique.
Type String Required
Définit si le Paramètre est extrait une seule fois (general fields
) ou pour chaque ligne (line fields
).
Desc String La description du Paramètre (Parameter) à créer.
Format String
Le format de Paramètre à extraire, avec leur formatage personnalisé. Par défaut, Text
. Pour consulter tous les formats de Paramètres, veuillez vous référer à cette page.
Position Integer La position du Paramètre (Parameter) dans la sortie, par rapport aux autres paramètres. Par défaut : ajouté à la fin.
Returns
L'object Paramètre (Parameter) créé
Récupérer un Paramètre (Parameter)
GET
https://api.openai.com/v1/fetch_parameter/{param_id}
Récupère toutes les informations concernant un Paramètre, en utilisant le param_id
.
Path parameters
Param_id Integer Required L'ID du Paramètre (Parameter) à récupérer.
Returns
L'object Paramètre (Parameter)
Mettre à jour un Paramètre (Parameter)
PUT
https://api.openai.com/v1/update_parameter/{param_id}
Met à jour le Paramètre (Parameter), avec son param_id
Path parameters
Param_id Integer Required L'ID du Paramètre (Parameter) à mettre à jour.
Request body
Name String Le nom du Paramètre à créer, unique.
Desc String La description du Paramètre à créer.
Format String
Le format de Paramètre à extraire, avec leur formatage personnalisé. Par défaut, Text
. Pour consulter tous les formats de Paramètres, veuillez vous référer à cette page.
Type String
Définit si le Paramètre est extrait une seule fois (general fields
) ou pour chaque ligne (line fields
).
Position Integer La position du Paramètre dans la sortie, par rapport aux autres paramètres. Par défaut : ajouté à la fin.
Returns
L'object Paramètre (Parameter)
Supprimer un Paramètre (Parameter)
DELETE
https://api.openai.com/v1/delete_parameter/{param_id}
Supprime un Paramètre (Parameter), avec son param_id
Path parameters
Param_id Integer Required L'ID du Paramètre (Parameter) à mettre à jour
Object Paramètre (Parameter)
id
Integer
name
String
Le nom du Paramètre, unique
desc
String
La description du Paramètre
format
String
Le format de Paramètre à extraire, avec leur formatage personnalisé. Par défaut, Text
. Pour tous les formats de Paramètres, veuillez vous référer à cette page.
type
String
Définit si le Paramètre est extrait une seule fois (general fields
) ou pour chaque ligne (line fields
).
position
Integer
La position du Paramètre dans la sortie, par rapport aux autres Paramètres. Par défaut : ajouté à la fin.
Template_id
Integer
L’ID du Modèle (Template) auquel le Paramètre (Parameter) est lié.
Last updated
Was this helpful?