Base de connaissances Adobe Acrobat (préversion)

La base de connaissances dans Adobe Acrobat Studio permet aux utilisateurs d’accéder à des connaissances qui se trouvent dans des collections de documents volumineuses et organisées, sur des Q&A multitours, une synthèse, une extraction et une recherche. Intégrer les fonctionnalités de la Base de connaissances dans les applications et les flux de travail dans lesquels vous travaillez pour connecter les connaissances stockées dans SharePoint et d’autres référentiels pris en charge, ainsi que les notifications, la création de contenu et les processus métier pris en charge.

Ce connecteur est disponible dans les produits et régions suivants :

Service classe Regions
Copilot Studio Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Applications logiques Standard Toutes les régions Logic Apps , à l’exception des suivantes :
     - Régions Azure Government
     - Régions Azure Chine
     - Us Department of Defense (DoD)
Power Apps Premium Toutes les régions Power Apps , à l’exception des suivantes :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Power Automate Premium Toutes les régions Power Automate , à l’exception des éléments suivants :
     - Us Government (GCC)
     - Us Government (GCC High)
     - China Cloud géré par 21Vianet
     - Us Department of Defense (DoD)
Contact
Name Adobe
URL https://www.adobe.com
Métadonnées du connecteur
Éditeur ADOBE INC.
Website https://business.adobe.com/products/acrobat-business/knowledge-base.html
Politique de confidentialité https://www.adobe.com/go/privacy_policy
Categories Productivité

Base de connaissances dans Acrobat

La base de connaissances dans Adobe Acrobat Studio permet aux utilisateurs d’accéder à des connaissances qui se trouvent dans des collections de documents volumineuses et organisées, sur des Q&A multitours, une synthèse, une extraction et une recherche. Intégrer les fonctionnalités de la Base de connaissances dans les applications et les flux de travail dans lesquels vous travaillez pour connecter les connaissances stockées dans SharePoint et d’autres référentiels pris en charge, ainsi que les notifications, la création de contenu et les processus métier pris en charge.

Éditeur : Adobe, Inc.

Prerequisites

Un compte Adobe disposant d’un accès à la Base de connaissances dans Acrobat est requis.

Comment obtenir des informations d’identification

Connectez-vous avec votre ID Adobe lorsque vous créez une connexion. Ce connecteur s’authentifie auprès d’Adobe Identity Management System (IMS) à l’aide d’OAuth 2.0 ; vous êtes redirigé vers la page de connexion Adobe et vous êtes invité à donner son consentement aux autorisations demandées avant la création de la connexion.

Bien démarrer avec votre connecteur

N/A

Problèmes connus et limitations

N/A

Erreurs courantes et solutions

N/A

FAQ

N/A

Actions

Chargement de documents

Chargez un ou plusieurs documents dans une collection pour l’indexation.

Charger des documents joints

Chargez une ou plusieurs pièces jointes.

Créer une collection

Créez une collection (espace de noms qui regroupe les documents et contrôle l’accès).

Lister les collections

Répertoriez les collections que l’utilisateur peut accéder.

Mettre à jour la collection

Mettez à jour toutes les propriétés d’une collection existante.

Obtenir le fichier de document

Obtenez les métadonnées et le contenu d’un document unique par son UUID.

Obtenir le fichier de pièce jointe

Téléchargez le contenu d’un fichier d’une pièce jointe par son UUID.

Obtenir l’état du document

Obtenez l’état d’indexation d’un document unique par son UUID.

Obtenir une pièce jointe

Obtenez une pièce jointe unique par son UUID.

Poser une question

Posez une question en langage naturel sur une collection et obtenez une réponse avec des citations.

Rechercher des documents (paginés)

Recherchez des documents dans une collection avec des résultats classés paginés.

Récupérer une collection

Obtenez une collection unique par son UUID.

Répertorier les documents

Répertorier les documents d’une collection.

Répertorier les pièces jointes

Répertorier les pièces jointes.

Résumer des documents

Générez un résumé d’un ou plusieurs documents d’une collection.

Supprimer des documents

Supprimez un ou plusieurs documents d’une collection par leurs UUID.

Supprimer une collection

Supprimez une collection et tous ses documents.

Supprimer une pièce jointe

Supprimez une pièce jointe unique par son UUID.

Chargement de documents

Chargez un ou plusieurs documents dans une collection pour l’indexation.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant de la collection
collection_id True uuid4

Identificateur unique de la collection

Gestion des doublons
option string

Stratégie de gestion dupliquée.

Value Behavior
FILE_NAME Remplacer un document existant par le même nom de fichier
FILE_CHECKSUM Remplacez le fichier uniquement lorsque le nom de fichier correspond, mais que le hachage de contenu (MD5) est différent.
SKIP_DUPLICATES Ignorez silencieusement les fichiers qui existent déjà (par somme de contrôle)
REJECT_REQUEST_ON_DUPLICATE Retourner une erreur 400 si un doublon est détecté
(omis) Autoriser les chargements en double
Mode OCR
ocr string

Mode de traitement OCR pour les documents PDF et image. Les chargements d’images nécessitent toujours l’OCR.

Value Behavior
AUTO Appliquez l’OCR si nécessaire ; Les chargements d’images sont toujours traités (par défaut)
FORCE Toujours rastériser et traiter OCR chaque page
NONE Ignorez l’OCR pour les documents non-image ; Les chargements d’images sont toujours traités
REJECT_BAD Appliquer automatiquement l’OCR et rejeter les pages qui échouent aux vérifications de qualité
Extraction de feuille masquée
hidden_sheets string

Contrôle le mode d’extraction de feuille masqué pour Excel documents.

Value Behavior
ALL extraire toutes les feuilles, y compris les feuilles masquées et très masquées (par défaut)
NONE extraire uniquement les feuilles visibles
HIDDEN extraire des feuilles visibles et masquées
VERY_HIDDEN extraire des feuilles visibles et très masquées
Fichier à charger
documents True file

Un ou plusieurs fichiers à charger. Formats pris en charge : PDF, DOC/DOCX, DOT/DOTX, TXT, RTF, XLS/XLSM/XLSX, PPT/PPTX, ODP, ODT, CSV, EML, JSON, MD, HTML, JPEG, PNG, TIFF, GIF, WebP et BMP.

Balises de document
document_tags string

Tableau JSON de balises clé-valeur à attacher à tous les documents chargés. Chaque balise doit avoir un key (1-127 caractères, des caractères alphanumériques minuscules et des traits d’union) et un value (1-256 caractères).

Liens sources HTML
html_links string

Mappage d’objets JSON de noms HTML à leurs URL sources d’origine. S’applique uniquement aux fichiers HTML chargés. La clé est le nom de fichier d’un fichier HTML dans le chargement, et la valeur est l’URL d’origine à partir de laquelle il a été enregistré.

Retours

Response Uploaddocuments
array of UploadDocumentResponse

Charger des documents joints

Chargez une ou plusieurs pièces jointes.

Paramètres

Nom Clé Obligatoire Type Description
Fichier à charger
documents True file

1 à 10 images ou fichiers. Images : image/jpeg, image/png, image/jpg, image/webp, image/gif - ≤10 Mo chacun. Fichiers : application/pdf - ≤8 Mo chacun

Retours

Réponse de l’API pour les chargements de lots de pièces jointes v2.

AttachmentUploadsResponse
AttachmentUploadsResponse

Créer une collection

Créez une collection (espace de noms qui regroupe les documents et contrôle l’accès).

Paramètres

Nom Clé Obligatoire Type Description
Name
name True string

Nom complet de la collection. Obligatoire, longueur maximale de 100 caractères

Descriptif
description string

Description facultative de la collection. Valeur par défaut : chaîne vide, longueur maximale de 500 caractères

Est public
is_public boolean

Indique si la collection est accessible publiquement.

Est figé
is_frozen boolean

Indique si la collection est figée et ne peut pas être modifiée.

Lire les utilisateurs
read_users array of string

Liste des ID d’utilisateur avec accès en lecture à la collection.

Écrire des utilisateurs
write_users array of string

Liste des ID d’utilisateur disposant d’un accès en écriture à la collection.

Lire des groupes
read_groups array of string

Liste des ID de groupe (UUID) avec accès en lecture à la collection.

Écrire des groupes
write_groups array of string

Liste des ID de groupe (UUID) avec accès en écriture à la collection.

Metadata
metadata object

Métadonnées facultatives associées à la collection. Longueur maximale de 1 000 caractères

Retours

Complétez les détails de la collection, notamment les métadonnées, les autorisations et l’état.

NamespaceResponse
NamespaceResponse

Lister les collections

Répertoriez les collections que l’utilisateur peut accéder.

Paramètres

Nom Clé Obligatoire Type Description
Page
page integer

Numéro de page (basé sur 1)

Taille de page
page_size integer

Nombre d’éléments par page (1 à 100)

Trier par
order_by string

Champ par lequel trier les résultats.

Value Trie par
name Nom complet de la collection (valeur par défaut)
created_at Horodateur de création
modified_at Horodatage de dernière modification
Croissant
asc boolean

Tri dans l’ordre croissant si true, décroissant si false.

Nom contient
infix string

Terme de recherche pour le nom de la collection (correspondance partielle sans respect de la casse).

Filter
filter_constraint string

Filtrez les regroupements par propriété ou par étendue.

Value Returns
created_by:me Collections que vous avez créées
shared_by:me Collections que vous avez partagées avec d’autres utilisateurs
shared_by:others Regroupements partagés avec vous
scope:org Toutes les collections de votre organisation (administrateur d’organisation uniquement)
scope:system Toutes les collections de toutes les organisations (administrateur système uniquement)

Retours

CollectionPage
CollectionPage

Mettre à jour la collection

Mettez à jour toutes les propriétés d’une collection existante.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant de la collection
collection_id True uuid4

Identificateur unique de la collection

Name
name True string

Nom complet de la collection. Obligatoire, longueur maximale de 100 caractères

Descriptif
description string

Description facultative de la collection. Valeur par défaut : chaîne vide, longueur maximale de 500 caractères

Est public
is_public boolean

Indique si la collection est accessible publiquement.

Est figé
is_frozen boolean

Indique si la collection est figée et ne peut pas être modifiée.

Lire les utilisateurs
read_users array of string

Liste des ID d’utilisateur avec accès en lecture à la collection.

Écrire des utilisateurs
write_users array of string

Liste des ID d’utilisateur disposant d’un accès en écriture à la collection.

Lire des groupes
read_groups array of string

Liste des ID de groupe (UUID) avec accès en lecture à la collection.

Écrire des groupes
write_groups array of string

Liste des ID de groupe (UUID) avec accès en écriture à la collection.

Metadata
metadata object

Métadonnées facultatives associées à la collection. Longueur maximale de 1 000 caractères

ID d’espace de noms
namespace_id string

UUID de la collection à mettre à jour.

Retours

Complétez les détails de la collection, notamment les métadonnées, les autorisations et l’état.

NamespaceResponse
NamespaceResponse

Obtenir le fichier de document

Obtenez les métadonnées et le contenu d’un document unique par son UUID.

Paramètres

Nom Clé Obligatoire Type Description
ID du document
document_id True uuid

UUID du document

Nom de fichier d’artefact
filename string

Artefact stocké spécifique à récupérer. En cas d’omission, le rendu de document actuel est retourné.

Retours

response
binary

Obtenir le fichier de pièce jointe

Téléchargez le contenu d’un fichier d’une pièce jointe par son UUID.

Paramètres

Nom Clé Obligatoire Type Description
ID de pièce jointe
attachment_id True uuid

UUID de la pièce jointe

Obtenir l’état du document

Obtenez l’état d’indexation d’un document unique par son UUID.

Paramètres

Nom Clé Obligatoire Type Description
ID du document
document_id True uuid

UUID du document

Retours

Informations sur le document
DocumentInfoApiResponse

Obtenir une pièce jointe

Obtenez une pièce jointe unique par son UUID.

Paramètres

Nom Clé Obligatoire Type Description
ID de pièce jointe
attachment_id True uuid

UUID de la pièce jointe

Retours

AttachmentResponse
AttachmentResponse

Poser une question

Posez une question en langage naturel sur une collection et obtenez une réponse avec des citations.

Paramètres

Nom Clé Obligatoire Type Description
ID de demande
request_id string

Identificateur unique pour cette demande, utilisé pour le suivi dans l’historique des conversations.

ID de document
document_ids array of string

UUIDs de documents spécifiques pour restreindre la recherche. Lorsqu’ils sont vides, tous les documents des collections spécifiées sont recherchés.

Collections
collections array of string

Espaces de noms de collection à rechercher. Au moins une est requise pour la source COLLECTION.

Inputs
inputs string

Question ou invite à répondre. Prend en charge les requêtes en langage naturel.

Formats
format string
Verbosité
style string
Tonalité
tone string
Reasoning
reasoning string
Instructions personnalisées
custom_instructions string

Instructions de texte libre pour personnaliser davantage le comportement de réponse IA.

SourceOptions
Source Options string
Mode d’inférence
inference_mode string

Niveau de modèle IA à utiliser. Options : STANDARD (vitesse équilibrée et qualité), FAST_REASONING (optimisé pour la vitesse avec raisonnement), ADVANCED (qualité la plus élevée), LITE (rapide, moindre coût — non COLLECTION uniquement), NANO (coût le plus rapide, le plus bas, non-COLLECTION uniquement). Pour inference_type=AGENTIC cela, il s’agit du niveau de l’agent qui écrit la réponse ; le travail qu’il délègue peut s’exécuter sur un niveau plus rapide choisi par le service.

Stratégie d’exécution
inference_type string

Stratégie d’exécution pour l’inférence question-réponse.

Orthogonal to InferenceMode (niveau de modèle) : AGENTIC sélectionne la boucle de l’agent multi-itération, DEFAULT le chemin RAG d’inférence unique classique. Aucune contrainte manquante : les valeurs inconnues doivent échouer à la validation.

Key
key True string

Identificateur de balise. Caractères alphanumériques et traits d’union uniquement.

Value
value True string

Valeur de balise. Caractères alphanumériques et traits d’union uniquement.

ID de pièce jointe
attachment_ids array of uuid4

ID des pièces jointes de fichiers précédemment chargées à inclure en tant que contexte visuel. Maximum 15 par requête. Types d’entrée acceptés : images (JPEG, PNG, GIF, WebP) et PDF. D’autres types de fichiers sont rejetés au moment du chargement. Dans les conversations à plusieurs tours, les derniers fichiers générés par LLM sont automatiquement relectés en tant que contexte ; seules les images et les fichiers PDF sont relues en raison des limitations de l’infrastructure de service LLM.

Mode de génération de fichiers
file_generation string
ID de connexion
connection_id string

ID de la connexion Office 365 à utiliser. Obligatoire uniquement pour OFFICE365 source. Si elle est omise, la première connexion correspondante est utilisée.

Fuseau horaire
time_zone string

Identificateur de fuseau horaire IANA pour les requêtes prenant en charge les dates (par exemple, America/Los_Angeles, UTC).

Activer les figures
enable_figures boolean

Lorsque la valeur est true, les illustrations de document récupérées (graphiques, images) sont incluses en tant que contexte visuel. Jusqu’à 8 chiffres total (maximum 4 par document).

Magasin
store boolean

Lorsque la valeur est true, la conversation est conservée dans l’historique des conversations, ce qui permet de suivre plusieurs tour. Définissez la valeur false pour les requêtes sans état, ponctuelles.

AttributionField
Include string

Champs de DocumentInfo éligibles à l’inclusion dans les réponses sources.

Chaque valeur est un chemin de notation par points rooté dans DocumentInfo. Chaque chemin doit être résolu en champ annoté avec attribution_eligible = True.

BoundCoordinateFormat
bound_coordinate_format string
Enabled
enabled boolean

Activez les événements de progression pendant la diffusion en continu.

ResponseEventDetail
detail string
Mises à jour des réponses
answer_updates boolean

Diffusez en continu la réponse agentique telle qu’elle est écrite, en tant que trames portant une answer_update (ajouter, puis terminer ou échouer) au lieu d’une trame finale. Le client doit appliquer ces opérations. Ignoré pour les demandes non de diffusion en continu et non agentiques.

ID de Exchange
exchange_id string

Identificateur du client de cet échange au sein de la conversation. Stocké avec l’échange et retourné dans l’historique des conversations, afin qu’un client puisse rapprocher son tour local avec l’enregistrement : la même question posée deux fois génère deux échanges, et seul l’ID les sépare.

Retours

QAInferenceResponse
QAInferenceResponse

Rechercher des documents (paginés)

Recherchez des documents dans une collection avec des résultats classés paginés.

Paramètres

Nom Clé Obligatoire Type Description
Espace de noms de document
document_namespace True string

Nom de la collection des documents à rechercher.

Filtrer par
filter_by True string

Requête de recherche par mot clé pour filtrer les documents par contenu ou par métadonnées.

ID de document
document_ids array of string

Liste des ID de document spécifiques pour restreindre la recherche. Maximum de 1 000 ID de document.

Key
key True string

Identificateur de balise. Caractères alphanumériques et traits d’union uniquement.

Value
value True string

Valeur de balise. Caractères alphanumériques et traits d’union uniquement.

Taille de la page
page_size integer

Nombre de résultats à retourner par page. La recherche non paginé retourne toujours page_size de 1 0000.

Commande par
order_by string

Champ par lequel trier les résultats.

Asc
asc boolean

Ordre de tri : True pour l’ordre croissant, False pour décroissant.

Ordre de pagination
pagination_order string

Détermine s’il faut obtenir la page suivante ou précédente des résultats.

Clé paginé
paginated_key string

Clé utilisée pour la pagination.

Retours

PaginédSearchApiResponse
PaginatedSearchApiResponse

Récupérer une collection

Obtenez une collection unique par son UUID.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant de la collection
collection_id True string

Identificateur unique de la collection

Retours

Complétez les détails de la collection, notamment les métadonnées, les autorisations et l’état.

NamespaceResponse
NamespaceResponse

Répertorier les documents

Répertorier les documents d’une collection.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant de la collection
collection_id True string

Identificateur unique de la collection

Page
page integer

Numéro de page (basé sur 1)

Taille de page
page_size integer

Nombre d’éléments par page (1 à 100)

Trier par
order_by string

Champ par lequel trier les résultats.

Value Trie par
document_name Nom de fichier de document (valeur par défaut)
updated_at Horodatage de dernière modification
upload_status Traitement des status
uploaded_at Chargement de l’horodatage
uploaded_by Téléchargeur
Croissant
asc boolean

Tri dans l’ordre croissant si true, décroissant si false.

Nom contient
infix string

Terme de recherche pour le nom du document (correspondance partielle sans respect de la casse).

Type de source
source_type string

Limitez les résultats aux documents avec cette source d’origine. Les documents sans métadonnées sources sont exclus lorsque ce filtre est défini.

Retours

InfoPageApiResponse
InfoPageApiResponse

Répertorier les pièces jointes

Répertorier les pièces jointes.

Retours

Listes de réponses
array of AttachmentResponse

Résumer des documents

Générez un résumé d’un ou plusieurs documents d’une collection.

Paramètres

Nom Clé Obligatoire Type Description
ID de document
document_ids True array of string

UUIDs de documents spécifiques à synthétiser. Maximum 10 documents par demande.

Espace de noms de document
document_namespace True string

Espace de noms de collection contenant les documents.

Retours

Response Summarizedocuments
array of SummarizationResponse

Supprimer des documents

Supprimez un ou plusieurs documents d’une collection par leurs UUID.

Paramètres

Nom Clé Obligatoire Type Description
ID de document
document_ids array of uuid4

Liste des UUID de document à supprimer.

Collection Id
collection_id string

UUID de la collection contenant les documents.

Retours

DeleteDocumentResponse
DeleteDocumentResponse

Supprimer une collection

Supprimez une collection et tous ses documents.

Paramètres

Nom Clé Obligatoire Type Description
Identifiant de la collection
collection_id True uuid4

Identificateur unique de la collection

Retours

Complétez les détails de la collection, notamment les métadonnées, les autorisations et l’état.

NamespaceResponse
NamespaceResponse

Supprimer une pièce jointe

Supprimez une pièce jointe unique par son UUID.

Paramètres

Nom Clé Obligatoire Type Description
ID de pièce jointe
attachment_id True uuid

UUID de la pièce jointe

Définitions

RésultatRéponse

Résultat d’une réponse : aucun, complet ou incomplet avec le code de ce qui l’a coupé.

Nom Chemin d’accès Type Description
Status
status string

Indique si une réponse existe et si sa génération est terminée.

Reason
reason string

Code d’interruption lorsqu’il est incomplet, code d’échec quand aucun ; n’est jamais défini lorsque vous avez terminé.

AnswerUpdate

Une opération sur la réponse qu’un client de diffusion en continu affiche : ajouter, terminer ou échouer.

complete est incomplet lorsqu’il reason est défini ; fail porte un code d’échec et ne retire jamais le texte affiché.

Nom Chemin d’accès Type Description
Operation
operation string
Reason
reason string

Terminal uniquement : code d’interruption terminé (par exemple, response_truncated_deadline), code d’échec en cas d’échec (par exemple, budget_exhausted, save_failed).

Persévérance
persistence Persistence

Indique si un échange est enregistré ; unknown signifie que la validation a pu se produire.

AttachmentErrorCode

Codes d’erreur pour les chargements de pièces jointes ayant échoué.

Codes d’erreur pour les chargements de pièces jointes ayant échoué.

AttachmentErrorCode
string

AttachmentResponse

Nom Chemin d’accès Type Description
ID de pièce jointe
attachment_id string
Nom de la pièce jointe
attachment_name string
Type Mime de pièce jointe
attachment_mime_type string

Type MIME d’image (par exemple, image/png)

Somme de contrôle des pièces jointes
attachment_checksum string

Somme de contrôle MD5 des octets d’image

Taille de la pièce jointe
attachment_size integer

Taille de l’image en octets

État de la pièce jointe
attachment_status string

AttachmentUploadError

Détails de l’échec lisible par l’ordinateur pour un chargement de pièce jointe unique.

Nom Chemin d’accès Type Description
AttachmentErrorCode
code AttachmentErrorCode

Codes d’erreur pour les chargements de pièces jointes ayant échoué.

Message
message string
Taille
size integer
Mime Type
mime_type string

AttachmentUploadItem

La réponse de chargement de la pièce jointe v2 est unifiée par fichier.

Nom Chemin d’accès Type Description
Filename
filename string
AttachmentUploadItemStatus
status AttachmentUploadItemStatus

État par fichier pour les réponses de chargement par lot de pièces jointes v2.

Code de statut
status_code integer
AttachmentResponse
attachment AttachmentResponse
AttachmentUploadError
error AttachmentUploadError

Détails de l’échec lisible par l’ordinateur pour un chargement de pièce jointe unique.

AttachmentUploadItemStatus

État par fichier pour les réponses de chargement par lot de pièces jointes v2.

État par fichier pour les réponses de chargement par lot de pièces jointes v2.

AttachmentUploadItemStatus
string

AttachmentUploadsResponse

Réponse de l’API pour les chargements de lots de pièces jointes v2.

Nom Chemin d’accès Type Description
Uploads
uploads array of AttachmentUploadItem

CollectionPage

Nom Chemin d’accès Type Description
Page
page integer

Numéro de page actuel (basé sur 1).

Taille
size integer

Nombre d’éléments par page.

Total
total integer

Nombre total de collections correspondant à la requête.

Commande par
order_by string

Champ utilisé pour trier les résultats.

Asc
asc boolean

Indique si les résultats sont triés dans l’ordre croissant.

Pages
pages array of Namespace

Liste des collections sur la page active.

DeleteDocumentResponse

Nom Chemin d’accès Type Description
Détails
details array of DocumentDeletionStatus

Résultats de suppression par document.

DocumentDeletionStatus

Nom Chemin d’accès Type Description
Identifiant du document
document_id string

UUID du document.

Status
status Status
Message
message string

Message lisible par l’homme décrivant le résultat.

DocumentInfoApiResponse

Nom Chemin d’accès Type Description
Identifiant du document
document_id string

UUID du document.

Nom du document
document_name string

Nom complet du document (généralement le nom de fichier d’origine).

Chemin d’accès au document
document_path string

Chemin d’accès de stockage du document au sein du système.

Espace de noms de document
document_namespace string

Espace de noms de collection auquel appartient ce document.

ID de l’espace de noms de document
document_namespace_id string

UUID de la collection à laquelle appartient le document.

Document Description
document_description string

Description fournie par l’utilisateur du document.

Chargé par
uploaded_by string

Adresse e-mail de la personne qui a chargé le document. Null lorsqu’aucun e-mail du chargeur n’est disponible.

État du chargement
upload_status string

État actuel du chargement/traitement.

Value Meaning
UPLOADED Fichier reçu, en attente de traitement
IN_PROGRESS Le traitement a démarré
CONVERTING Conversion en format indexable
INDEXING Création d’un index de recherche
COMPLETE Prêt pour les requêtes
FAILED Échec du traitement
Somme de contrôle
checksum string

Somme de contrôle SHA-256 du fichier de document pour la vérification de l’intégrité.

Mime Type
mime_type string

Type MIME du document source d’origine.

Type Mime de rendu
rendition_mime_type string

Type MIME du rendu client ; les sources externes utilisent text/uri-list.

Type de source
source_type string

Source d’origine de ce document : SHAREPOINT, , SHAREPOINT_SITEGOOGLE_DRIVE, ou UPLOAD. null pour les documents sans métadonnées sources.

DocumentStatus
status DocumentStatus
Chargé à l’adresse
uploaded_at date-time

Horodatage lorsque le document a été chargé (format ISO 8601).

Mis à jour le
updated_at date-time

Horodatage de la dernière mise à jour de l’enregistrement du document, le cas échéant.

Est supprimé
is_deleted boolean

Indique si le document a été supprimé de manière réversible.

DocumentMetadata
document_metadata DocumentMetadata

DocumentMetadata

Nom Chemin d’accès Type Description
Permissions
permissions
Balises de document
document_tags array of DocumentTag
Métadonnées sources
source_metadata
IngestionMetadata
ingestion_metadata IngestionMetadata

DocumentStatus

Nom Chemin d’accès Type Description
Status
status string
Code d’erreur
error_code string

DocumentTag

Nom Chemin d’accès Type Description
Key
key string

Identificateur de balise. Caractères alphanumériques et traits d’union uniquement.

Value
value string

Valeur de balise. Caractères alphanumériques et traits d’union uniquement.

InfoPageApiResponse

Nom Chemin d’accès Type Description
Page
page integer

Numéro de page actuel (basé sur 1).

Taille
size integer

Nombre d’éléments par page.

Total
total integer

Nombre total de documents correspondant à la requête.

Commande par
order_by string

Champ utilisé pour trier les résultats.

Asc
asc boolean

Indique si les résultats sont triés dans l’ordre croissant.

Pages
pages array of DocumentInfoApiResponse

Liste des documents de la page active.

IngestionMetadata

Nom Chemin d’accès Type Description
Score de confiance
confidence_score number
Ocr
ocr boolean
Caractères incorrects
bad_characters boolean
Feuilles masquées trouvées
found_hidden_sheets boolean
Feuilles très masquées trouvées
found_very_hidden_sheets boolean
Feuilles masquées protégées trouvées
found_protected_hidden_sheets boolean
Feuilles masquées activées
enabled_hidden_sheets boolean
Feuilles très masquées activées
enabled_very_hidden_sheets boolean
Date de création du document
document_created_date date-time

Namespace

Nom Chemin d’accès Type Description
Namespace
namespace string

Identificateur unique de la collection. La valeur par défaut est UUID. Utilisez-le en tant qu’ID externe.

Name
name string

Nom complet facultatif de la collection. Obligatoire si 'namespace' n’est pas fourni.

Descriptif
description string

Description lisible par l’homme de la collection.

Est figé
is_frozen boolean

Indique si la collection est figée et ne peut pas être modifiée.

Créée par
created_by string

Adresse e-mail ou ID du créateur de la collection.

Créé par ID d’utilisateur
created_by_user_id string

ID utilisateur du créateur de collection.

Est public
is_public boolean

Indique si la collection est accessible publiquement.

Lire les utilisateurs
read_users array of string

Liste des ID d’utilisateur avec accès en lecture.

Écrire des utilisateurs
write_users array of string

Liste des ID d’utilisateur disposant d’un accès en écriture.

Lire des groupes
read_groups array of string

Liste des ID de groupe avec accès en lecture.

Écrire des groupes
write_groups array of string

Liste des ID de groupe avec accès en écriture.

Metadata
metadata object

Métadonnées supplémentaires associées à la collection.

Version
version string

Version d’API de la collection.

ID d’espace de noms
namespace_id string

Identificateur unique de la collection.

Créé à
created_at date-time

Horodatage lors de la création de la collection.

Modifié à
modified_at date-time

Horodatage lorsque la collection a été modifiée pour la dernière fois.

Est supprimé
is_deleted boolean

Indique si la collection a été supprimée de manière réversible.

Est actif
is_active boolean

Indique si la collection est actuellement active.

Nombre de documents
doc_count integer

Nombre de documents pour l’espace de noms. Exposer en tant que propriété de niveau supérieur pour l’espace de noms, à partir de metadata.doc_count

NamespaceResponse

Complétez les détails de la collection, notamment les métadonnées, les autorisations et l’état.

Nom Chemin d’accès Type Description
ID d’espace de noms
namespace_id string

Identificateur unique de la collection.

Namespace
namespace string

Identificateur sécurisé d’URL utilisé dans les appels d’API.

Name
name string

Nom d’affichage de la collection.

Descriptif
description string

Description lisible par l’homme de la collection.

Est figé
is_frozen boolean

Indique si la collection est figée et ne peut pas être modifiée.

Créée par
created_by string

ID utilisateur du créateur de collection.

Est public
is_public boolean

Indique si la collection est accessible publiquement.

Lire les utilisateurs
read_users array of string

Liste des ID d’utilisateur avec accès en lecture.

Écrire des utilisateurs
write_users array of string

Liste des ID d’utilisateur disposant d’un accès en écriture.

Lire des groupes
read_groups array of string

Liste des ID de groupe avec accès en lecture.

Écrire des groupes
write_groups array of string

Liste des ID de groupe avec accès en écriture.

Partages d’écriture rejetés
rejected_write_shares array of string

Utilisateurs de partage d’écriture non autorisés

Metadata
metadata object

Métadonnées supplémentaires associées à la collection.

Version
version string

Version de l’API pour cette réponse.

Créé à
created_at date-time

Horodatage lors de la création de la collection.

Modifié à
modified_at date-time

Horodatage lorsque la collection a été modifiée pour la dernière fois.

Est supprimé
is_deleted boolean

Indique si la collection a été supprimée de manière réversible.

Est actif
is_active boolean

Indique si la collection est actuellement active.

Nombre de documents
doc_count integer

Nombre de documents dans la collection.

Owner
owner string

E-mail du propriétaire du regroupement. Actuellement, l’utilisateur qui a créé la collection.

PaginédSearchApiResponse

Nom Chemin d’accès Type Description
Totaldocuments
totalDocuments integer

Nombre total de documents correspondant aux critères de recherche.

Documentinfo
documentInfo array of DocumentInfoApiResponse

Liste des documents dans la page actuelle des résultats.

Clé paginé
paginated_key string

Jeton de pagination opaque. Transmettez cette valeur dans les requêtes suivantes pour récupérer la page suivante ou précédente.

Persévérance

Indique si un échange est enregistré ; unknown signifie que la validation a pu se produire.

Indique si un échange est enregistré ; unknown signifie que la validation a pu se produire.

Persévérance
string

QAInferenceResponse

Nom Chemin d’accès Type Description
Texte généré
generated_text string

Réponse générée par l’IA au format Markdown.

Source
source object

Documents sources référencés dans la réponse, clé par des marqueurs de citation numériques (par exemple, 1, 2). Les citations apparaissent dans le texte généré sous [1], [2]etc.

Flux terminé
stream_complete boolean

Indique si la réponse de diffusion en continu a terminé. Toujours true pour les réponses non diffusées en continu.

Options sources
source_options array of SourceOptions

Types de sources de réponse utilisés pour générer cette réponse.

Attachments
attachments array of uuid4

ID des pièces jointes générées par LLM (par exemple, CSV, XLSX, JSON, PDF, images) qui accompagnent la réponse. Les types de sortie pris en charge incluent des formats de texte, des feuilles de calcul, des documents et des images. Dans les conversations à plusieurs tours, les 5 derniers fichiers générés sont automatiquement relus au modèle ; seules les images et les fichiers PDF sont relectés en tant qu’entrée LLM en raison des limitations de l’infrastructure de service LLM.

Résumé du raisonnement
reasoning_summary string

Résumé du processus de raisonnement ia inclus lorsque le mode de raisonnement est activé.

ResponseEvent
response_event ResponseEvent
AnswerUpdate
answer_update AnswerUpdate

Une opération sur la réponse qu’un client de diffusion en continu affiche : ajouter, terminer ou échouer.

complete est incomplet lorsqu’il reason est défini ; fail porte un code d’échec et ne retire jamais le texte affiché.

RésultatRéponse
answer_outcome AnswerOutcome

Résultat d’une réponse : aucun, complet ou incomplet avec le code de ce qui l’a coupé.

ResponseEvent

Nom Chemin d’accès Type Description
Type
type string

Identificateur d’événement dot-namespaced suivant le modèle response.status.{phase}.{state}. Événements de cycle de vie : response.created, response.in_progress, response.error. Événements d’état : context.loading (chargement de l’historique des conversations pour les questions de suivi), question.analyzing (compréhension de la question), documents.searching (recherche de documents pertinents), documents.found (récupération complète, documents identifiés), sources.linking (mappage des preuves de réponse aux documents sources), figures.analyzing (analyse des figures de document et des graphiques), context.preparing (assemblage du contexte de document pour le modèle), answer.generating (modèle génère la réponse), answer.streaming (premier jeton de réponse reçu, diffusion en continu en cours).

Message
message string

Texte de progression orienté utilisateur décrivant l’étape de traitement actuelle.

Meta
meta object

Métadonnées structurées pour l’événement. Champs courants : collection_names (liste des noms d’affichage de collection), doc_count (nombre de documents trouvés), question (texte de la question analysée), (noms de documents demandés spécifiques), document_namesis_follow_up (true pour les questions de suivi à plusieurs tour).

Créé à
created_at string

Horodatage UTC ISO 8601 du moment où cet événement a été produit.

SourceOptions

SourceOptions
string

Status

Status
string

SummarizationResponse

Nom Chemin d’accès Type Description
Résumé
summary string

Résumé du document généré par l’IA au format Markdown.

Source
source object

Documents sources utilisés pour produire le résumé, clé par marqueur de citation numérique.

UploadDocumentResponse

Réponse retournée pour chaque document chargé.

Nom Chemin d’accès Type Description
Identifiant utilisateur
user_id string

ID de l’utilisateur qui a chargé le document.

Identifiant du document
document_id string

Identificateur unique affecté au document chargé.

Nom du document
document_name string

Nom de fichier d’origine du document chargé.

Espace de noms de document
document_namespace string

Espace de noms (identificateur de collection) auquel appartient le document.

ID de l’espace de noms de document
document_namespace_id string

UUID de la collection à laquelle appartient le document.

Status
status string

État de traitement du document chargé.

Type de contenu
content_type string

Type MIME du document chargé.

binary

Il s’agit du type de données de base "binaire".