Adobe Acrobat Knowledge Base (preview)
Met Knowledge Base in Adobe Acrobat Studio hebben gebruikers gesprekstoegang tot kennis die zich in grote, gecureerde documentverzamelingen bevindt, in Q&A met meerdere paden, samenvattingen, extractie en zoekopdrachten. Breng knowledge base-mogelijkheden in de toepassingen en werkstromen waar u werkt om kennis te verbinden die is opgeslagen in SharePoint en andere ondersteunde opslagplaatsen en stroomgoedkeuringen, meldingen, het maken van inhoud en bedrijfsprocessen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logische apps | Standard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate regio's behalve: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Name | Adobe |
| URL | https://www.adobe.com |
| Connectormetagegevens | |
|---|---|
| Publisher | ADOBE INC. |
| Website | https://business.adobe.com/products/acrobat-business/knowledge-base.html |
| Privacybeleid | https://www.adobe.com/go/privacy_policy |
| Categorieën | Productiviteit |
Knowledge Base in Acrobat
Met Knowledge Base in Adobe Acrobat Studio hebben gebruikers gesprekstoegang tot kennis die zich in grote, gecureerde documentverzamelingen bevindt, in Q&A met meerdere paden, samenvattingen, extractie en zoekopdrachten. Breng knowledge base-mogelijkheden in de toepassingen en werkstromen waar u werkt om kennis te verbinden die is opgeslagen in SharePoint en andere ondersteunde opslagplaatsen en stroomgoedkeuringen, meldingen, het maken van inhoud en bedrijfsprocessen.
Uitgever: Adobe, Inc.
Prerequisites
Een Adobe-account met toegang tot Knowledge Base in Acrobat is vereist.
Referenties ophalen
Meld u aan met uw Adobe ID wanneer u een verbinding maakt. Deze connector verifieert met Adobe Identity Management System (IMS) met behulp van OAuth 2.0; u wordt omgeleid naar de aanmeldingspagina van Adobe en u wordt gevraagd om toestemming te geven voor de aangevraagde machtigingen voordat de verbinding wordt gemaakt.
Aan de slag met uw connector
N/A
Bekende problemen en beperkingen
N/A
Veelvoorkomende fouten en oplossingen
N/A
FAQ
N/A
Acties
| Bijlage ophalen |
Haal één bijlage op met de UUID. |
| Bijlage verwijderen |
Eén bijlage verwijderen door de UUID. |
| Bijlagebestand ophalen |
Download de bestandsinhoud van een bijlage door de UUID. |
| Bijlagen uploaden |
Upload een of meer bijlagen. |
| Bijlagen weergeven |
Bijlagen weergeven. |
| Documentbestand ophalen |
Haal de metagegevens en inhoud van één document op door de UUID. |
| Documenten samenvatten |
Genereer een samenvatting van een of meer documenten in een verzameling. |
| Documenten uploaden |
Upload een of meer documenten naar een verzameling voor indexering. |
| Documenten verwijderen |
Verwijder een of meer documenten uit een verzameling door hun UUID's. |
| Documenten weergeven |
De documenten in een verzameling weergeven. |
| Documenten zoeken (gepagineerd) |
Doorzoek documenten in een verzameling met gepagineerde gerangschikte resultaten. |
| Documentstatus ophalen |
De indexeringsstatus van één document ophalen door de UUID. |
| Stel een vraag |
Stel een vraag in natuurlijke taal tegen een verzameling en krijg een antwoord met bronvermeldingen. |
| Verzameling bijwerken |
Werk alle eigenschappen van een bestaande verzameling bij. |
| Verzameling maken |
Maak een verzameling (een naamruimte die documenten groeperen en de toegang beheert). |
| Verzameling ophalen |
Haal één verzameling op met de UUID. |
| Verzameling verwijderen |
Een verzameling en alle bijbehorende documenten verwijderen. |
| Verzamelingen weergeven |
Geef een lijst weer van de verzamelingen die de gebruiker kan openen. |
Bijlage ophalen
Haal één bijlage op met de UUID.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bijlage-ID
|
attachment_id | True | uuid |
UUID van de bijlage |
Retouren
- AttachmentResponse
- AttachmentResponse
Bijlage verwijderen
Eén bijlage verwijderen door de UUID.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bijlage-ID
|
attachment_id | True | uuid |
UUID van de bijlage |
Bijlagebestand ophalen
Download de bestandsinhoud van een bijlage door de UUID.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Bijlage-ID
|
attachment_id | True | uuid |
UUID van de bijlage |
Bijlagen uploaden
Upload een of meer bijlagen.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Te uploaden bestand
|
documents | True | file |
1-10 afbeeldingen of bestanden. Afbeeldingen: image/jpeg, image/png, image/jpg, image/webp, image/gif - ≤10 MB elk. Bestanden: toepassing/pdf - ≤8 MB |
Retouren
API-antwoord voor batchuploads van v2-bijlagen.
- AttachmentUploadsResponse
- AttachmentUploadsResponse
Bijlagen weergeven
Documentbestand ophalen
Haal de metagegevens en inhoud van één document op door de UUID.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-ID
|
document_id | True | uuid |
UUID van het document |
|
Bestandsnaam van artefact
|
filename | string |
Specifiek opgeslagen artefact dat moet worden opgehaald. Als u dit weglaat, wordt de huidige documentweergave geretourneerd. |
Retouren
- response
- binary
Documenten samenvatten
Genereer een samenvatting van een of meer documenten in een verzameling.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id's
|
document_ids | True | array of string |
UUID's van specifieke documenten om samen te vatten. Maximaal 10 documenten per aanvraag. |
|
Documentnaamruimte
|
document_namespace | True | string |
Verzamelingsnaamruimte met de documenten. |
Retouren
- Samenvattingsdocumenten voor antwoorden
- array of SummarizationResponse
Documenten uploaden
Upload een of meer documenten naar een verzameling voor indexering.
Parameters
| Naam | Sleutel | Vereist | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Verzamelings-ID
|
collection_id | True | uuid4 |
Unieke id van de verzameling |
||||||||||||
|
Dubbele verwerking
|
option | string |
Strategie voor dubbele verwerking.
|
|||||||||||||
|
OCR-modus
|
ocr | string |
OCR-verwerkingsmodus voor PDF- en afbeeldingsdocumenten. Voor het uploaden van afbeeldingen is altijd OCR vereist.
|
|||||||||||||
|
Verborgen-bladextractie
|
hidden_sheets | string |
Hiermee bepaalt u de verborgen modus voor bladextractie voor Excel documenten.
|
|||||||||||||
|
Te uploaden bestand
|
documents | True | file |
Een of meer bestanden die u wilt uploaden. Ondersteunde indelingen: PDF, DOC/DOCX, DOT/DOTX, TXT, RTF, XLS/XLSM/XLSX, PPT/PPTX, ODP, ODP, ODT, CSV, EML, JSON, MD, HTML, JPEG, PNG, TIFF, GIF, WebP en BMP. |
||||||||||||
|
Documenttags
|
document_tags | string |
JSON-matrix met sleutel-waardetags die moeten worden gekoppeld aan alle geüploade documenten. Elke tag moet een |
|||||||||||||
|
HTML-bronkoppelingen
|
html_links | string |
JSON-objecttoewijzing html-bestandsnamen aan de oorspronkelijke bron-URL's. Alleen van toepassing op geüploade HTML-bestanden. De sleutel is de bestandsnaam van een HTML-bestand in het uploaden en de waarde is de oorspronkelijke URL waaruit het is opgeslagen. |
Retouren
- Uploaddocuments voor antwoorden
- array of UploadDocumentResponse
Documenten verwijderen
Verwijder een of meer documenten uit een verzameling door hun UUID's.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-id's
|
document_ids | array of uuid4 |
Lijst met document-UUID's die u wilt verwijderen. |
|
|
Verzamelings-id
|
collection_id | string |
UUID van de verzameling die de documenten bevat. |
Retouren
- DeleteDocumentResponse
- DeleteDocumentResponse
Documenten weergeven
De documenten in een verzameling weergeven.
Parameters
| Naam | Sleutel | Vereist | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Verzamelings-ID
|
collection_id | True | string |
Unieke id van de verzameling |
||||||||||||
|
Page
|
page | integer |
Paginanummer (op basis van 1) |
|||||||||||||
|
Paginaformaat
|
page_size | integer |
Aantal items per pagina (1-100) |
|||||||||||||
|
Bestellen op
|
order_by | string |
Veld voor het sorteren van resultaten op.
|
|||||||||||||
|
Oplopend
|
asc | boolean |
Sorteer in oplopende volgorde als |
|||||||||||||
|
Naam bevat
|
infix | string |
Zoekterm voor documentnaam (hoofdlettergevoelige gedeeltelijke overeenkomst). |
|||||||||||||
|
Bronsoort
|
source_type | string |
Beperk resultaten tot documenten met deze oorspronkelijke bron. Documenten zonder bronmetagegevens worden uitgesloten wanneer dit filter is ingesteld. |
Retouren
- InfoPageApiResponse
- InfoPageApiResponse
Documenten zoeken (gepagineerd)
Doorzoek documenten in een verzameling met gepagineerde gerangschikte resultaten.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Documentnaamruimte
|
document_namespace | True | string |
De naam van de verzameling van de documenten die u wilt doorzoeken. |
|
Filteren op
|
filter_by | True | string |
Zoekquery voor trefwoorden om documenten te filteren op inhoud of metagegevens. |
|
Document-id's
|
document_ids | array of string |
Lijst met specifieke document-id's om de zoekopdracht te beperken. Maximaal 1000 document-id's. |
|
|
Key
|
key | True | string |
Tag-identificatie. Alleen alfanumerieke tekens en afbreekstreepjes. |
|
Value
|
value | True | string |
Tagwaarde. Alleen alfanumerieke tekens en afbreekstreepjes. |
|
Paginagrootte
|
page_size | integer |
Het aantal resultaten dat per pagina moet worden geretourneerd. Niet-gepagineerde zoekopdracht retourneert altijd page_size van 10000. |
|
|
Sorteren op
|
order_by | string |
Het veld voor het sorteren van de resultaten op. |
|
|
Asc
|
asc | boolean |
Sorteervolgorde: Waar voor oplopend, Onwaar voor aflopend. |
|
|
Pagineringsvolgorde
|
pagination_order | string |
Bepaalt of de volgende of vorige pagina met resultaten moet worden opgehaald. |
|
|
Gepagineerde sleutel
|
paginated_key | string |
Een sleutel die wordt gebruikt voor paginering. |
Retouren
- PaginatedSearchApiResponse
- PaginatedSearchApiResponse
Documentstatus ophalen
De indexeringsstatus van één document ophalen door de UUID.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Document-ID
|
document_id | True | uuid |
UUID van het document |
Retouren
- Documentinfo
- DocumentInfoApiResponse
Stel een vraag
Stel een vraag in natuurlijke taal tegen een verzameling en krijg een antwoord met bronvermeldingen.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Aanvraag-id
|
request_id | string |
Unieke id voor deze aanvraag, die wordt gebruikt voor het bijhouden in de chatgeschiedenis. |
|
|
Document-id's
|
document_ids | array of string |
UUID's van specifieke documenten om de zoekopdracht te beperken. Als deze leeg is, worden alle documenten in de opgegeven verzamelingen doorzocht. |
|
|
Collections
|
collections | array of string |
Verzamelingsnaamruimten om te zoeken. Er is ten minste één vereist voor verzamelingsbron. |
|
|
Inputs
|
inputs | string |
De vraag of prompt om te beantwoorden. Ondersteunt query's in natuurlijke taal. |
|
|
Format
|
format | string | ||
|
Verbosity
|
style | string | ||
|
Toon
|
tone | string | ||
|
Redenering
|
reasoning | string | ||
|
Aangepaste instructies
|
custom_instructions | string |
Instructies voor vrije tekst om het gedrag van ai-reacties verder aan te passen. |
|
|
SourceOptions
|
Source Options | string | ||
|
Deductiemodus
|
inference_mode | string |
Te gebruiken AI-modellaag. Opties: |
|
|
Uitvoeringsstrategie
|
inference_type | string |
Uitvoeringsstrategie voor vraag-antwoorddeductie. Orthogonaal naar deductiemodus (modellaag): AGENTIC selecteert de multi-iteratieagentlus, DEFAULT het klassieke RAG-pad met één deductie. Er ontbreekt geen dwang. Er moeten onbekende waarden mislukken. |
|
|
Key
|
key | True | string |
Tag-identificatie. Alleen alfanumerieke tekens en afbreekstreepjes. |
|
Value
|
value | True | string |
Tagwaarde. Alleen alfanumerieke tekens en afbreekstreepjes. |
|
Bijlage-id's
|
attachment_ids | array of uuid4 |
Id's van eerder geüploade bestandsbijlagen die als visuele context moeten worden opgenomen. Maximum 15 per aanvraag. Geaccepteerde invoertypen: afbeeldingen (JPEG, PNG, GIF, WebP) en PDF. Andere bestandstypen worden geweigerd tijdens het uploaden. In gesprekken met meerdere paden worden de meest recente 5 door LLM gegenereerde bestanden automatisch opnieuw afgespeeld als context; alleen afbeeldingen en PDF-bestanden worden opnieuw afgespeeld vanwege beperkingen van de LLM-serviceinfrastructuur. |
|
|
Modus voor het genereren van bestanden
|
file_generation | string | ||
|
Verbindings-ID
|
connection_id | string |
Id van de Office 365 verbinding die moet worden gebruikt. Alleen vereist voor OFFICE365 bron. Als u dit weglaat, wordt de eerste overeenkomende verbinding gebruikt. |
|
|
Tijdzone
|
time_zone | string |
IANA-tijdzone-id voor datumbewuste query's (bijvoorbeeld |
|
|
Afbeeldingen inschakelen
|
enable_figures | boolean |
Wanneer waar worden opgehaalde documentcijfers (grafieken, afbeeldingen) opgenomen als visuele context. Maximaal 8 cijfers totaal (max. 4 per document). |
|
|
Store
|
store | boolean |
Wanneer waar, blijft het gesprek behouden tot de chatgeschiedenis, waardoor follow-ups met meerdere paden mogelijk zijn. Ingesteld op onwaar voor staatloze, eenmalige query's. |
|
|
AttributionField
|
Include | string |
Velden uit DocumentInfo komen in aanmerking voor opname in bronantwoorden. Elke waarde is een punt-notatiepad dat is geroot in DocumentInfo. Elk pad moet worden omgezet in een veld met aantekeningen met attribution_eligible = True. |
|
|
BoundCoordinateFormat
|
bound_coordinate_format | string | ||
|
Ingeschakeld
|
enabled | boolean |
Schakel voortgangsevenementen in tijdens het streamen. |
|
|
ResponseEventDetail
|
detail | string | ||
|
Antwoordupdates
|
answer_updates | boolean |
Stream het agentische antwoord zoals het is geschreven, als frames met een answer_update (toevoegen, vervolgens voltooien of mislukken) in plaats van één definitief frame. De client moet deze bewerkingen toepassen. Genegeerd voor niet-streaming- en niet-agentische aanvragen. |
|
|
Exchange-id
|
exchange_id | string |
De client-id van deze uitwisseling binnen het gesprek. Opgeslagen met de uitwisseling en geretourneerd in de chatgeschiedenis, zodat een client de lokale beurt kan afstemmen met de record: dezelfde vraag die twee keer wordt gesteld, levert twee uitwisselingen op en alleen de id vertelt ze uit elkaar. |
Retouren
- QAInferenceResponse
- QAInferenceResponse
Verzameling bijwerken
Werk alle eigenschappen van een bestaande verzameling bij.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Verzamelings-ID
|
collection_id | True | uuid4 |
Unieke id van de verzameling |
|
Name
|
name | True | string |
Weergavenaam voor de verzameling. Vereist, maximale lengte 100 tekens |
|
Description
|
description | string |
Optionele beschrijving van de verzameling. Standaard ingesteld op lege tekenreeks, maximale lengte 500 tekens |
|
|
Is openbaar
|
is_public | boolean |
Of de verzameling openbaar toegankelijk is. |
|
|
Is geblokkeerd
|
is_frozen | boolean |
Of de verzameling is geblokkeerd en niet kan worden gewijzigd. |
|
|
Gebruikers lezen
|
read_users | array of string |
Lijst met gebruikers-id's met leestoegang tot de verzameling. |
|
|
Gebruikers schrijven
|
write_users | array of string |
Lijst met gebruikers-id's met schrijftoegang tot de verzameling. |
|
|
Groepen lezen
|
read_groups | array of string |
Lijst met groeps-id's (UUID's) met leestoegang tot de verzameling. |
|
|
Groepen schrijven
|
write_groups | array of string |
Lijst met groeps-id's (UUID's) met schrijftoegang tot de verzameling. |
|
|
Metadata
|
metadata | object |
Optionele metagegevens die aan de verzameling zijn gekoppeld. Maximale lengte 1000 tekens |
|
|
Naamruimte-id
|
namespace_id | string |
UUID van de verzameling die moet worden bijgewerkt. |
Retouren
Volledige verzamelingsgegevens, waaronder metagegevens, machtigingen en status.
- NaamruimteResponse
- NamespaceResponse
Verzameling maken
Maak een verzameling (een naamruimte die documenten groeperen en de toegang beheert).
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
Weergavenaam voor de verzameling. Vereist, maximale lengte 100 tekens |
|
Description
|
description | string |
Optionele beschrijving van de verzameling. Standaard ingesteld op lege tekenreeks, maximale lengte 500 tekens |
|
|
Is openbaar
|
is_public | boolean |
Of de verzameling openbaar toegankelijk is. |
|
|
Is geblokkeerd
|
is_frozen | boolean |
Of de verzameling is geblokkeerd en niet kan worden gewijzigd. |
|
|
Gebruikers lezen
|
read_users | array of string |
Lijst met gebruikers-id's met leestoegang tot de verzameling. |
|
|
Gebruikers schrijven
|
write_users | array of string |
Lijst met gebruikers-id's met schrijftoegang tot de verzameling. |
|
|
Groepen lezen
|
read_groups | array of string |
Lijst met groeps-id's (UUID's) met leestoegang tot de verzameling. |
|
|
Groepen schrijven
|
write_groups | array of string |
Lijst met groeps-id's (UUID's) met schrijftoegang tot de verzameling. |
|
|
Metadata
|
metadata | object |
Optionele metagegevens die aan de verzameling zijn gekoppeld. Maximale lengte 1000 tekens |
Retouren
Volledige verzamelingsgegevens, waaronder metagegevens, machtigingen en status.
- NaamruimteResponse
- NamespaceResponse
Verzameling ophalen
Haal één verzameling op met de UUID.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Verzamelings-ID
|
collection_id | True | string |
Unieke id van de verzameling |
Retouren
Volledige verzamelingsgegevens, waaronder metagegevens, machtigingen en status.
- NaamruimteResponse
- NamespaceResponse
Verzameling verwijderen
Een verzameling en alle bijbehorende documenten verwijderen.
Parameters
| Naam | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Verzamelings-ID
|
collection_id | True | uuid4 |
Unieke id van de verzameling |
Retouren
Volledige verzamelingsgegevens, waaronder metagegevens, machtigingen en status.
- NaamruimteResponse
- NamespaceResponse
Verzamelingen weergeven
Geef een lijst weer van de verzamelingen die de gebruiker kan openen.
Parameters
| Naam | Sleutel | Vereist | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Page
|
page | integer |
Paginanummer (op basis van 1) |
|||||||||||||
|
Paginaformaat
|
page_size | integer |
Aantal items per pagina (1-100) |
|||||||||||||
|
Bestellen op
|
order_by | string |
Veld voor het sorteren van resultaten op.
|
|||||||||||||
|
Oplopend
|
asc | boolean |
Sorteer in oplopende volgorde als |
|||||||||||||
|
Naam bevat
|
infix | string |
Zoekterm voor verzamelingsnaam (hoofdlettergevoelige gedeeltelijke overeenkomst). |
|||||||||||||
|
Filter
|
filter_constraint | string |
Verzamelingen filteren op eigendom of bereik.
|
Retouren
- CollectionPage
- CollectionPage
Definities
AnswerOutcome
Het resultaat van één antwoord: geen, volledig of onvolledig met de code van wat het knipt.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Status
|
status | string |
Of er een antwoord bestaat en of de generatie is voltooid. |
|
Reden
|
reason | string |
De onderbrekingscode wanneer deze onvolledig is, de foutcode wanneer er geen is; nooit ingesteld wanneer het is voltooid. |
AnswerUpdate
Eén bewerking op het antwoord van een streamingclient toont: toevoegen, voltooien of mislukken.
complete is onvolledig wanneer reason deze is ingesteld; fail voert een foutcode uit en trekt de weergegeven tekst nooit in.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Operation
|
operation | string | |
|
Reden
|
reason | string |
Alleen terminal: de onderbrekingscode die is voltooid (bijvoorbeeld response_truncated_deadline), de foutcode mislukt (bijvoorbeeld budget_exhausted, save_failed). |
|
Persistentie
|
persistence | Persistence |
Of een uitwisseling op een record staat; |
AttachmentErrorCode
Foutcodes voor mislukte uploads van bijlagen.
Foutcodes voor mislukte uploads van bijlagen.
- AttachmentErrorCode
- string
AttachmentResponse
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Bijlage-id
|
attachment_id | string | |
|
Bijlagenaam
|
attachment_name | string | |
|
Mime-type bijlage
|
attachment_mime_type | string |
Mime-type afbeelding (bijvoorbeeld afbeelding/png) |
|
Controlesom van bijlage
|
attachment_checksum | string |
MD5-controlesom van de afbeeldingsbytes |
|
Bijlagegrootte
|
attachment_size | integer |
Grootte van de afbeelding in bytes |
|
Bijlagestatus
|
attachment_status | string |
AttachmentUploadError
Foutdetails die kunnen worden gelezen voor één bijlageupload.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
AttachmentErrorCode
|
code | AttachmentErrorCode |
Foutcodes voor mislukte uploads van bijlagen. |
|
Message
|
message | string | |
|
Size
|
size | integer | |
|
Mime-type
|
mime_type | string |
AttachmentUploadItem
Gecombineerd resultaat per bestand in het antwoord voor uploaden van v2-bijlagen.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Bestandsnaam
|
filename | string | |
|
AttachmentUploadItemStatus
|
status | AttachmentUploadItemStatus |
Status per bestand voor antwoorden voor het uploaden van v2-bijlagenbatch. |
|
Statuscode
|
status_code | integer | |
|
AttachmentResponse
|
attachment | AttachmentResponse | |
|
AttachmentUploadError
|
error | AttachmentUploadError |
Foutdetails die kunnen worden gelezen voor één bijlageupload. |
AttachmentUploadItemStatus
Status per bestand voor antwoorden voor het uploaden van v2-bijlagenbatch.
Status per bestand voor antwoorden voor het uploaden van v2-bijlagenbatch.
- AttachmentUploadItemStatus
- string
AttachmentUploadsResponse
API-antwoord voor batchuploads van v2-bijlagen.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Uploads
|
uploads | array of AttachmentUploadItem |
CollectionPage
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Page
|
page | integer |
Huidig paginanummer (op basis van 1). |
|
Size
|
size | integer |
Aantal items per pagina. |
|
Total
|
total | integer |
Totaal aantal verzamelingen dat overeenkomt met de query. |
|
Sorteren op
|
order_by | string |
Veld dat wordt gebruikt om resultaten te sorteren. |
|
Asc
|
asc | boolean |
Of de resultaten in oplopende volgorde worden gesorteerd. |
|
Bladzijden
|
pages | array of Namespace |
Lijst met verzamelingen op de huidige pagina. |
DeleteDocumentResponse
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Gegevens
|
details | array of DocumentDeletionStatus |
Resultaten van verwijdering per document. |
DocumentDeletionStatus
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Document-id
|
document_id | string |
UUID van het document. |
|
Status
|
status | Status | |
|
Message
|
message | string |
Leesbaar bericht waarin het resultaat wordt beschreven. |
DocumentInfoApiResponse
| Naam | Pad | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Document-id
|
document_id | string |
UUID van het document. |
||||||||||||||
|
Documentnaam
|
document_name | string |
Weergavenaam van het document (meestal de oorspronkelijke bestandsnaam). |
||||||||||||||
|
Documentpad
|
document_path | string |
Opslagpad van het document in het systeem. |
||||||||||||||
|
Documentnaamruimte
|
document_namespace | string |
Verzamelingsnaamruimte waartoe dit document behoort. |
||||||||||||||
|
Documentnaamruimte-id
|
document_namespace_id | string |
UUID van de verzameling waartoe het document behoort. |
||||||||||||||
|
Documentbeschrijving
|
document_description | string |
Door de gebruiker verstrekte beschrijving van het document. |
||||||||||||||
|
Geüpload door
|
uploaded_by | string |
E-mailadres van de persoon die het document heeft geüpload. Null als er geen uploader-e-mail beschikbaar is. |
||||||||||||||
|
Uploadstatus
|
upload_status | string |
Huidige status van uploaden/verwerken.
|
||||||||||||||
|
Checksum
|
checksum | string |
SHA-256 controlesom van het documentbestand voor integriteitscontrole. |
||||||||||||||
|
Mime-type
|
mime_type | string |
MIME-type van het oorspronkelijke brondocument. |
||||||||||||||
|
Mime-type weergave
|
rendition_mime_type | string |
MIME-type van de clientweergave; gebruik van externe bronnen |
||||||||||||||
|
Brontype
|
source_type | string |
Bron van dit document: |
||||||||||||||
|
DocumentStatus
|
status | DocumentStatus | |||||||||||||||
|
Geüpload op
|
uploaded_at | date-time |
Tijdstempel toen het document werd geüpload (ISO 8601-indeling). |
||||||||||||||
|
Bijgewerkt op
|
updated_at | date-time |
Tijdstempel van de laatste update van de documentrecord, indien van toepassing. |
||||||||||||||
|
Wordt verwijderd
|
is_deleted | boolean |
Of het document voorlopig is verwijderd. |
||||||||||||||
|
DocumentMetadata
|
document_metadata | DocumentMetadata |
DocumentMetadata
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Machtigingen
|
permissions | ||
|
Documenttags
|
document_tags | array of DocumentTag | |
|
Bronmetagegevens
|
source_metadata | ||
|
IngestionMetadata
|
ingestion_metadata | IngestionMetadata |
DocumentStatus
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Status
|
status | string | |
|
Foutcode
|
error_code | string |
DocumentTag
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Key
|
key | string |
Tag-identificatie. Alleen alfanumerieke tekens en afbreekstreepjes. |
|
Value
|
value | string |
Tagwaarde. Alleen alfanumerieke tekens en afbreekstreepjes. |
InfoPageApiResponse
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Page
|
page | integer |
Huidig paginanummer (op basis van 1). |
|
Size
|
size | integer |
Aantal items per pagina. |
|
Total
|
total | integer |
Totaal aantal documenten dat overeenkomt met de query. |
|
Sorteren op
|
order_by | string |
Veld dat wordt gebruikt om resultaten te sorteren. |
|
Asc
|
asc | boolean |
Of de resultaten in oplopende volgorde worden gesorteerd. |
|
Bladzijden
|
pages | array of DocumentInfoApiResponse |
Lijst met documenten op de huidige pagina. |
IngestionMetadata
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Confidence Score (Betrouwbaarheidsscore)
|
confidence_score | number | |
|
Ocr
|
ocr | boolean | |
|
Ongeldige tekens
|
bad_characters | boolean | |
|
Verborgen bladen gevonden
|
found_hidden_sheets | boolean | |
|
Zeer verborgen bladen gevonden
|
found_very_hidden_sheets | boolean | |
|
Beveiligde verborgen bladen gevonden
|
found_protected_hidden_sheets | boolean | |
|
Verborgen bladen ingeschakeld
|
enabled_hidden_sheets | boolean | |
|
Zeer verborgen bladen ingeschakeld
|
enabled_very_hidden_sheets | boolean | |
|
Document gemaakt op
|
document_created_date | date-time |
Namespace
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Namespace
|
namespace | string |
Unieke id voor de verzameling. Standaard ingesteld op UUID. Gebruik deze als een externe id. |
|
Name
|
name | string |
Optionele weergavenaam voor de verzameling. Vereist als er geen 'naamruimte' is opgegeven. |
|
Description
|
description | string |
Leesbare beschrijving van de verzameling. |
|
Is geblokkeerd
|
is_frozen | boolean |
Of de verzameling is geblokkeerd en niet kan worden gewijzigd. |
|
Gemaakt door
|
created_by | string |
E-mail of id van de maker van de verzameling. |
|
Gemaakt door gebruikers-id
|
created_by_user_id | string |
Gebruikers-id van de maker van de verzameling. |
|
Is openbaar
|
is_public | boolean |
Of de verzameling openbaar toegankelijk is. |
|
Gebruikers lezen
|
read_users | array of string |
Lijst met gebruikers-id's met leestoegang. |
|
Gebruikers schrijven
|
write_users | array of string |
Lijst met gebruikers-id's met schrijftoegang. |
|
Groepen lezen
|
read_groups | array of string |
Lijst met groeps-id's met leestoegang. |
|
Groepen schrijven
|
write_groups | array of string |
Lijst met groeps-id's met schrijftoegang. |
|
Metadata
|
metadata | object |
Aanvullende metagegevens die aan de verzameling zijn gekoppeld. |
|
Versie
|
version | string |
API-versie van de verzameling. |
|
Naamruimte-id
|
namespace_id | string |
Unieke id voor de verzameling. |
|
Gemaakt op
|
created_at | date-time |
Tijdstempel toen de verzameling is gemaakt. |
|
Gewijzigd op
|
modified_at | date-time |
Tijdstempel toen de verzameling voor het laatst is gewijzigd. |
|
Wordt verwijderd
|
is_deleted | boolean |
Of de verzameling voorlopig is verwijderd. |
|
Is actief
|
is_active | boolean |
Of de verzameling momenteel actief is. |
|
Aantal documenten
|
doc_count | integer |
Aantal documenten voor de naamruimte. Beschikbaar maken als een eigenschap op het hoogste niveau voor naamruimte, van metadata.doc_count |
NaamruimteResponse
Volledige verzamelingsgegevens, waaronder metagegevens, machtigingen en status.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Naamruimte-id
|
namespace_id | string |
Unieke id voor de verzameling. |
|
Namespace
|
namespace | string |
URL-veilige id die wordt gebruikt in API-aanroepen. |
|
Name
|
name | string |
Weergavenaam van de verzameling. |
|
Description
|
description | string |
Leesbare beschrijving van de verzameling. |
|
Is geblokkeerd
|
is_frozen | boolean |
Of de verzameling is geblokkeerd en niet kan worden gewijzigd. |
|
Gemaakt door
|
created_by | string |
Gebruikers-id van de maker van de verzameling. |
|
Is openbaar
|
is_public | boolean |
Of de verzameling openbaar toegankelijk is. |
|
Gebruikers lezen
|
read_users | array of string |
Lijst met gebruikers-id's met leestoegang. |
|
Gebruikers schrijven
|
write_users | array of string |
Lijst met gebruikers-id's met schrijftoegang. |
|
Groepen lezen
|
read_groups | array of string |
Lijst met groeps-id's met leestoegang. |
|
Groepen schrijven
|
write_groups | array of string |
Lijst met groeps-id's met schrijftoegang. |
|
Geweigerde schrijfshares
|
rejected_write_shares | array of string |
Niet-gerechtigde gebruikers van het schrijven van delen |
|
Metadata
|
metadata | object |
Aanvullende metagegevens die aan de verzameling zijn gekoppeld. |
|
Versie
|
version | string |
API-versie voor dit antwoord. |
|
Gemaakt op
|
created_at | date-time |
Tijdstempel toen de verzameling is gemaakt. |
|
Gewijzigd op
|
modified_at | date-time |
Tijdstempel toen de verzameling voor het laatst is gewijzigd. |
|
Wordt verwijderd
|
is_deleted | boolean |
Of de verzameling voorlopig is verwijderd. |
|
Is actief
|
is_active | boolean |
Of de verzameling momenteel actief is. |
|
Aantal documenten
|
doc_count | integer |
Aantal documenten in de verzameling. |
|
Owner
|
owner | string |
E-mail van de eigenaar van de verzameling. Momenteel de gebruiker die de verzameling heeft gemaakt. |
PaginatedSearchApiResponse
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Totaldocuments
|
totalDocuments | integer |
Totaal aantal documenten dat overeenkomt met de zoekcriteria. |
|
Documentinfo
|
documentInfo | array of DocumentInfoApiResponse |
Lijst met documenten op de huidige pagina met resultaten. |
|
Gepagineerde sleutel
|
paginated_key | string |
Ondoorzichtig pagineringstoken. Geef deze waarde door in volgende aanvragen om de volgende of vorige pagina op te halen. |
Persistentie
Of een uitwisseling op een record staat; unknown betekent dat de doorvoering mogelijk is gebeurd.
Of een uitwisseling op een record staat; unknown betekent dat de doorvoering mogelijk is gebeurd.
- Persistentie
- string
QAInferenceResponse
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Gegenereerde tekst
|
generated_text | string |
Het door AI gegenereerde antwoord in Markdown-indeling. |
|
Source
|
source | object |
Brondocumenten waarnaar wordt verwezen in het antwoord, gesleuteld door numerieke bronvermeldingsmarkeringen (bijvoorbeeld |
|
Stream voltooid
|
stream_complete | boolean |
Geeft aan of het streaming-antwoord is voltooid. Altijd waar voor niet-streaming-antwoorden. |
|
Bronopties
|
source_options | array of SourceOptions |
De antwoordbrontypen die zijn gebruikt om dit antwoord te genereren. |
|
Bijlagen
|
attachments | array of uuid4 |
Id's van door LLM gegenereerde bestandsbijlagen (bijvoorbeeld CSV, XLSX, JSON, PDF, afbeeldingen) die bij het antwoord horen. Ondersteunde uitvoertypen zijn tekstindelingen, spreadsheets, documenten en afbeeldingen. In gesprekken met meerdere paden worden de meest recente vijf gegenereerde bestanden automatisch opnieuw afgespeeld in het model; alleen afbeeldingen en PDF-bestanden worden opnieuw afgespeeld als LLM-invoer vanwege beperkingen van de INFRASTRUCTUUR van de LLM-service. |
|
Redeneringsoverzicht
|
reasoning_summary | string |
Een samenvatting van het AI-redeneringsproces, opgenomen wanneer de redeneringsmodus is ingeschakeld. |
|
ResponseEvent
|
response_event | ResponseEvent | |
|
AnswerUpdate
|
answer_update | AnswerUpdate |
Eén bewerking op het antwoord van een streamingclient toont: toevoegen, voltooien of mislukken.
|
|
AnswerOutcome
|
answer_outcome | AnswerOutcome |
Het resultaat van één antwoord: geen, volledig of onvolledig met de code van wat het knipt. |
ResponseEvent
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Type
|
type | string |
Dot-namespaced gebeurtenis-id volgens het patroon |
|
Message
|
message | string |
Door de gebruiker gerichte voortgangstekst die de huidige verwerkingsstap beschrijft. |
|
Meta
|
meta | object |
Gestructureerde metagegevens voor de gebeurtenis. Algemene velden: |
|
Gemaakt op
|
created_at | string |
ISO 8601 UTC-tijdstempel van toen deze gebeurtenis werd geproduceerd. |
SourceOptions
- SourceOptions
- string
Status
- Status
- string
Samenvattingsresponse
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Overzicht
|
summary | string |
De door AI gegenereerde documentsamenvatting in Markdown-indeling. |
|
Source
|
source | object |
Brondocumenten die worden gebruikt om de samenvatting te produceren, gesleuteld door een numerieke bronvermeldingsmarkering. |
UploadDocumentResponse
Antwoord geretourneerd voor elk geüpload document.
| Naam | Pad | Type | Description |
|---|---|---|---|
|
Gebruikersnaam
|
user_id | string |
Id van de gebruiker die het document heeft geüpload. |
|
Document-id
|
document_id | string |
Unieke id die is toegewezen aan het geüploade document. |
|
Documentnaam
|
document_name | string |
Oorspronkelijke bestandsnaam van het geüploade document. |
|
Documentnaamruimte
|
document_namespace | string |
Naamruimte (verzamelings-id) waartoe het document behoort. |
|
Documentnaamruimte-id
|
document_namespace_id | string |
UUID van de verzameling waartoe het document behoort. |
|
Status
|
status | string |
Verwerkingsstatus van het geüploade document. |
|
Inhoudstype
|
content_type | string |
MIME-type van het geüploade document. |
binary
Dit is het basisgegevenstype 'binair'.