Instructions
Les instructions sont prises en compte par Koncile pour extraire les Champs Généraux (General fields) des Champs Répétés (Line fields).
Créer une Instruction
POST
https://api.openai.com/v1/create_instruction
Créée une instruction
Request body
Template_id Integer Required L'ID du Modèle (Template) dans lequel l'instruction est ajoutée
Content String Required Le contenu de l'instruction
Type String Required
Définit si l’instruction cible les champs extraits une seule fois (General fields
) ou pour chaque ligne (Line fields
).
Returns
L'objet Instruction créé
Récupérer une Instruction
GET
https://api.openai.com/v1/fetch_instruction/{instruction_id}
Récupère toutes les informations concernant une instruction, en utilisant l’instruction_id
.
Path parameters
Instruction_id Integer Required L'ID de l'instruction à récupérer
Returns
L'objet Instruction
Mettre à jour une Instruction
PUT
https://api.openai.com/v1/update_instruction/{instruction_id}
Met à jour une instruction, en utilisant l’instruction_id
.
Path parameters
Instruction_id Integer Required L'ID de l'instruction à mettre à jour
Request body
Content String Le contenu de l'instruction
Type String
Définit si l’instruction cible les champs extraits une seule fois (General fields
) ou pour chaque ligne (Line fields
).
Returns
L'objet Instruction créé
Supprimer une Instruction
DELETE
https://api.openai.com/v1/delete_instruction/{instruction_id}
Supprime une instruction, en utilisant l’instruction_id
.
Path parameters
Instruction_id Integer Required L'ID de l'instruction à supprimer
L'object Instruction
id
Integer
content
String
Le contenu de l'instruction
type
String
Indique si l’instruction doit être extraite une seule fois ou pour chaque ligne. Cela peut être Champs Généraux (General Fields
) ou Champs Répétés (Line fields
).
template_id
Integer
L’ID du Modèle (Template) auquel l’instruction est liée.
Last updated
Was this helpful?