Adobe Acrobat Knowledge Base (förhandsversion)
Kunskapsbasen i Adobe Acrobat Studio ger användarna konversationsåtkomst till kunskap som finns i stora, kurerade dokumentsamlingar, över Q&A med flera turer, sammanfattning, extrahering och sökning. Ta med kunskapsbasfunktioner i de program och arbetsflöden där du arbetar för att ansluta kunskap som lagras i SharePoint och andra lagringsplatser och energigodkännanden som stöds, meddelanden, skapande av innehåll och affärsprocesser.
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Standard | Alla Logic Apps-regioner utom följande: - Azure Government regioner - Azure kinaregioner - US Department of Defense (DoD) |
| Power Apps | Premium | Alla Power Apps regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alla Power Automate regioner förutom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Adobe (på engelska) |
| URL | https://www.adobe.com |
| Metadata för anslutningsprogram | |
|---|---|
| Publisher | ADOBE INC. |
| Webbplats | https://business.adobe.com/products/acrobat-business/knowledge-base.html |
| Sekretesspolicy | https://www.adobe.com/go/privacy_policy |
| Kategorier | Produktivitet |
Kunskapsbas i Acrobat
Kunskapsbasen i Adobe Acrobat Studio ger användarna konversationsåtkomst till kunskap som finns i stora, kurerade dokumentsamlingar, över Q&A med flera turer, sammanfattning, extrahering och sökning. Ta med kunskapsbasfunktioner i de program och arbetsflöden där du arbetar för att ansluta kunskap som lagras i SharePoint och andra lagringsplatser och energigodkännanden som stöds, meddelanden, skapande av innehåll och affärsprocesser.
Utgivare: Adobe, Inc.
Prerequisites
Ett Adobe-konto med åtkomst till Knowledge Base i Acrobat krävs.
Hämta autentiseringsuppgifter
Logga in med ditt Adobe-ID när du skapar en anslutning. Den här anslutningsappen autentiserar med Adobe Identity Management System (IMS) med OAuth 2.0; du omdirigeras till Adobe-inloggningssidan och uppmanas att godkänna de begärda behörigheterna innan anslutningen skapas.
Kom igång med anslutningsappen
N/A
Kända problem och begränsningar
N/A
Vanliga fel och åtgärder
N/A
FAQ
N/A
Åtgärder
| Hämta bifogad fil |
Hämta en enda bifogad fil med dess UUID. |
| Hämta bifogad fil |
Ladda ned filinnehållet i en bifogad fil med dess UUID. |
| Hämta dokumentfil |
Hämta ett enskilt dokuments metadata och innehåll med dess UUID. |
| Hämta dokumentstatus |
Hämta indexeringsstatusen för ett enskilt dokument med dess UUID. |
| Hämta samling |
Hämta en enda samling med dess UUID. |
| Ladda upp bilagor |
Ladda upp en eller flera bifogade filer. |
| Ladda upp dokument |
Ladda upp ett eller flera dokument till en samling för indexering. |
| Lista samlingar |
Visa en lista över de samlingar som användaren kan komma åt. |
| Sammanfatta dokument |
Generera en sammanfattning av ett eller flera dokument i en samling. |
| Skapa samling |
Skapa en samling (ett namnområde som grupperar dokument och styr åtkomst). |
| Ställ en fråga |
Ställ en fråga på naturligt språk mot en samling och få ett svar med citat. |
| Sök dokument (sidnumrerade) |
Sök bland dokument i en samling med sidnumrerade rankade resultat. |
| Ta bort bifogad fil |
Ta bort en enda bifogad fil med dess UUID. |
| Ta bort dokument |
Ta bort ett eller flera dokument från en samling av deras UUID:er. |
| Ta bort samling |
Ta bort en samling och alla dess dokument. |
| Uppdatera samling |
Uppdatera alla egenskaper för en befintlig samling. |
| Visa en lista över bifogade filer |
Visa en lista över bifogade filer. |
| Visa en lista över dokument |
Visa en lista över dokumenten i en samling. |
Hämta bifogad fil
Hämta en enda bifogad fil med dess UUID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID för bifogad fil
|
attachment_id | True | uuid |
UUID för den bifogade filen |
Returer
- AttachmentResponse
- AttachmentResponse
Hämta bifogad fil
Ladda ned filinnehållet i en bifogad fil med dess UUID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID för bifogad fil
|
attachment_id | True | uuid |
UUID för den bifogade filen |
Hämta dokumentfil
Hämta ett enskilt dokuments metadata och innehåll med dess UUID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
document_id | True | uuid |
UUID för dokumentet |
|
Artefaktfilnamn
|
filename | string |
Specifik lagrad artefakt som ska hämtas. Om det utelämnas returneras den aktuella dokumentåtergivningen. |
Returer
- response
- binary
Hämta dokumentstatus
Hämta indexeringsstatusen för ett enskilt dokument med dess UUID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID
|
document_id | True | uuid |
UUID för dokumentet |
Returer
- Dokumentinformation
- DocumentInfoApiResponse
Hämta samling
Hämta en enda samling med dess UUID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Samling-ID
|
collection_id | True | string |
Unik identifierare för samlingen |
Returer
Fullständig samlingsinformation, inklusive metadata, behörigheter och status.
- NamespaceResponse
- NamespaceResponse
Ladda upp bilagor
Ladda upp en eller flera bifogade filer.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Fil som ska laddas upp
|
documents | True | file |
1–10 bilder eller filer. Bilder: image/jpeg, image/png, image/jpg, image/webp, image/gif – ≤10 MB vardera. Filer: program/pdf – ≤8 MB vardera |
Returer
API-svar för batchuppladdningar med v2-bilagor.
- AttachmentUploadsResponse
- AttachmentUploadsResponse
Ladda upp dokument
Ladda upp ett eller flera dokument till en samling för indexering.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Samling-ID
|
collection_id | True | uuid4 |
Unik identifierare för samlingen |
||||||||||||
|
Duplicerad hantering
|
option | string |
Strategi för duplicerad hantering.
|
|||||||||||||
|
OCR-läge
|
ocr | string |
OCR-bearbetningsläge för PDF- och bilddokument. Bilduppladdningar kräver alltid OCR.
|
|||||||||||||
|
Extrahering av dolda blad
|
hidden_sheets | string |
Styr dolt bladextraheringsläge för Excel dokument.
|
|||||||||||||
|
Fil som ska laddas upp
|
documents | True | file |
En eller flera filer att ladda upp. Format som stöds: PDF, DOC/DOCX, DOT/DOTX, TXT, RTF, XLS/XLSM/XLSX, PPT/PPTX, ODP, ODT, CSV, EML, JSON, MD, HTML, JPEG, PNG, TIFF, GIF, WebP och BMP. |
||||||||||||
|
Dokumenttaggar
|
document_tags | string |
JSON-matris med nyckel/värde-taggar som ska bifogas till alla uppladdade dokument. Varje tagg måste ha en |
|||||||||||||
|
HTML-källlänkar
|
html_links | string |
JSON-objekt som mappar HTML-filnamn till sina ursprungliga käll-URL:er. Gäller endast för uppladdade HTML-filer. Nyckeln är filnamnet för en HTML-fil i uppladdningen och värdet är den ursprungliga URL som den sparades från. |
Returer
- Uppladdningsdokument för svar
- array of UploadDocumentResponse
Lista samlingar
Visa en lista över de samlingar som användaren kan komma åt.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sida
|
page | integer |
Sidnummer (1-baserat) |
|||||||||||||
|
Sidstorlek
|
page_size | integer |
Antal objekt per sida (1–100) |
|||||||||||||
|
Sortera efter
|
order_by | string |
Fält att sortera resultat efter.
|
|||||||||||||
|
Stigande
|
asc | boolean |
Sortera i stigande ordning om |
|||||||||||||
|
Namnet innehåller
|
infix | string |
Sökterm för samlingsnamn (skiftlägesokänslig partiell matchning). |
|||||||||||||
|
Filter
|
filter_constraint | string |
Filtrera samlingar efter ägarskap eller omfång.
|
Returer
- CollectionPage
- CollectionPage
Sammanfatta dokument
Generera en sammanfattning av ett eller flera dokument i en samling.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID:t
|
document_ids | True | array of string |
UUID:er för specifika dokument som ska sammanfattas. Maximalt 10 dokument per begäran. |
|
Dokumentnamnområde
|
document_namespace | True | string |
Samlingsnamnområde som innehåller dokumenten. |
Returer
- Sammanfattningsdokument för svar
- array of SummarizationResponse
Skapa samling
Skapa en samling (ett namnområde som grupperar dokument och styr åtkomst).
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
Visningsnamn för samlingen. Obligatorisk, maxlängd 100 tecken |
|
Description
|
description | string |
Valfri beskrivning av samlingen. Standardvärdet är tom sträng, maxlängd 500 tecken |
|
|
Är offentligt
|
is_public | boolean |
Om samlingen är offentligt tillgänglig. |
|
|
Är frusen
|
is_frozen | boolean |
Om samlingen är låst och inte kan ändras. |
|
|
Läsa användare
|
read_users | array of string |
Lista över användar-ID:t med läsbehörighet till samlingen. |
|
|
Skriva användare
|
write_users | array of string |
Lista över användar-ID:t med skrivåtkomst till samlingen. |
|
|
Läsgrupper
|
read_groups | array of string |
Lista över grupp-ID:er (UUID) med läsbehörighet till samlingen. |
|
|
Skrivgrupper
|
write_groups | array of string |
Lista över grupp-ID:er (UUID) med skrivåtkomst till samlingen. |
|
|
Metadata
|
metadata | object |
Valfria metadata som är associerade med samlingen. Max längd 1 000 tecken |
Returer
Fullständig samlingsinformation, inklusive metadata, behörigheter och status.
- NamespaceResponse
- NamespaceResponse
Ställ en fråga
Ställ en fråga på naturligt språk mot en samling och få ett svar med citat.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Begärande-ID
|
request_id | string |
Unik identifierare för den här begäran som används för spårning i chatthistoriken. |
|
|
Dokument-ID:t
|
document_ids | array of string |
UUID:er för specifika dokument att begränsa sökningen till. När de är tomma genomsöks alla dokument i de angivna samlingarna. |
|
|
Collections
|
collections | array of string |
Samlingsnamnområden för sökning. Minst en krävs för COLLECTION-källan. |
|
|
Inputs
|
inputs | string |
Frågan eller uppmaningen att svara. Stöder frågor på naturligt språk. |
|
|
Format
|
format | string | ||
|
Ordrikedom
|
style | string | ||
|
Tonfall
|
tone | string | ||
|
Reasoning
|
reasoning | string | ||
|
Anpassade instruktioner
|
custom_instructions | string |
Instruktioner för fritext för att ytterligare anpassa AI-svarsbeteendet. |
|
|
SourceOptions
|
Source Options | string | ||
|
Slutsatsdragningsläge
|
inference_mode | string |
AI-modellnivå som ska användas. Alternativ: |
|
|
Körningsstrategi
|
inference_type | string |
Körningsstrategi för slutsatsdragning av frågesvar. Ortogonial till InferenceMode (modellnivå): AGENTIC väljer loopen multi-iteration agent, STANDARD den klassiska RAG-sökvägen med enkel slutsatsdragning. Inget tvång saknas – okända värden får inte valideras. |
|
|
Key
|
key | True | string |
Taggens identifierare. Alfanumeriska tecken och bindestreck. |
|
Value
|
value | True | string |
Taggvärde. Alfanumeriska tecken och bindestreck. |
|
ID:t för bifogade filer
|
attachment_ids | array of uuid4 |
ID:t för tidigare uppladdade filbilagor som ska inkluderas som visuell kontext. Maximalt 15 per begäran. Godkända indatatyper: bilder (JPEG, PNG, GIF, WebP) och PDF. Andra filtyper avvisas vid uppladdningen. I konversationer med flera turer spelas de senaste 5 LLM-genererade filerna upp automatiskt som kontext. Endast avbildningar och PDF-filer spelas upp på grund av begränsningar i LLM-tjänstens infrastruktur. |
|
|
Filgenereringsläge
|
file_generation | string | ||
|
Anslutnings-ID
|
connection_id | string |
ID för den Office 365 anslutning som ska användas. Krävs endast för OFFICE365 källa. Om den utelämnas används den första matchande anslutningen. |
|
|
Tidszon
|
time_zone | string |
IANA-tidszonsidentifierare för datummedvetna frågor (t.ex. |
|
|
Aktivera siffror
|
enable_figures | boolean |
När det är sant inkluderas hämtade dokumentfigurer (diagram, bilder) som visuell kontext. Upp till 8 siffror totalt (max 4 per dokument). |
|
|
Store
|
store | boolean |
När det är sant sparas konversationen i chatthistoriken, vilket möjliggör uppföljningar med flera svar. Ställ in på false för tillståndslösa engångsfrågor. |
|
|
AttributionField
|
Include | string |
Fält från DocumentInfo som är berättigade till inkludering i källsvar. Varje värde är en punkt notationssökväg rotad på DocumentInfo. Varje sökväg måste matcha till ett fält som har kommenterats med attribution_eligible = True. |
|
|
BoundCoordinateFormat
|
bound_coordinate_format | string | ||
|
Enabled
|
enabled | boolean |
Aktivera förloppshändelser under strömning. |
|
|
ResponseEventDetail
|
detail | string | ||
|
Svarsuppdateringar
|
answer_updates | boolean |
Strömma det agentiska svaret som det skrivs, som ramar som bär en answer_update (lägg till, sedan slutföra eller misslyckas) i stället för en sista bildruta. Klienten måste tillämpa dessa åtgärder. Ignoreras för icke-strömmande och icke-agentiska begäranden. |
|
|
Exchange ID
|
exchange_id | string |
Klientens identifierare för det här utbytet i konversationen. Lagras med utbytet och returneras i chatthistoriken, så att en klient kan stämma av sin lokala tur med posten: samma fråga som ställs två gånger ger två utbyten, och endast ID:t skiljer dem åt. |
Returer
- QAInferenceResponse
- QAInferenceResponse
Sök dokument (sidnumrerade)
Sök bland dokument i en samling med sidnumrerade rankade resultat.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokumentnamnområde
|
document_namespace | True | string |
Samlingsnamnet på de dokument som ska sökas i. |
|
Filtrera efter
|
filter_by | True | string |
Nyckelordssökningsfråga för att filtrera dokument efter innehåll eller metadata. |
|
Dokument-ID:t
|
document_ids | array of string |
Lista över specifika dokument-ID:t som du vill begränsa sökningen till. Högst 1 000 dokument-ID:t. |
|
|
Key
|
key | True | string |
Taggens identifierare. Alfanumeriska tecken och bindestreck. |
|
Value
|
value | True | string |
Taggvärde. Alfanumeriska tecken och bindestreck. |
|
Sidstorlek
|
page_size | integer |
Antalet resultat som ska returneras per sida. Icke-sidnumrerad sökning returnerar alltid page_size på 10000. |
|
|
Sortera efter
|
order_by | string |
Fältet som resultatet ska sorteras efter. |
|
|
Asc
|
asc | boolean |
Sorteringsordning: Sant för stigande, Falskt för fallande. |
|
|
Sidnumreringsordning
|
pagination_order | string |
Avgör om du vill hämta nästa eller föregående resultatsida. |
|
|
Sidnumrerad nyckel
|
paginated_key | string |
En nyckel som används för sidnumrering. |
Returer
- PaginatedSearchApiResponse
- PaginatedSearchApiResponse
Ta bort bifogad fil
Ta bort en enda bifogad fil med dess UUID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
ID för bifogad fil
|
attachment_id | True | uuid |
UUID för den bifogade filen |
Ta bort dokument
Ta bort ett eller flera dokument från en samling av deras UUID:er.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Dokument-ID:t
|
document_ids | array of uuid4 |
Lista över dokument-UUID:er som ska tas bort. |
|
|
Samlings-ID
|
collection_id | string |
UUID för samlingen som innehåller dokumenten. |
Returer
- DeleteDocumentResponse
- DeleteDocumentResponse
Ta bort samling
Ta bort en samling och alla dess dokument.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Samling-ID
|
collection_id | True | uuid4 |
Unik identifierare för samlingen |
Returer
Fullständig samlingsinformation, inklusive metadata, behörigheter och status.
- NamespaceResponse
- NamespaceResponse
Uppdatera samling
Uppdatera alla egenskaper för en befintlig samling.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Samling-ID
|
collection_id | True | uuid4 |
Unik identifierare för samlingen |
|
Name
|
name | True | string |
Visningsnamn för samlingen. Obligatorisk, maxlängd 100 tecken |
|
Description
|
description | string |
Valfri beskrivning av samlingen. Standardvärdet är tom sträng, maxlängd 500 tecken |
|
|
Är offentligt
|
is_public | boolean |
Om samlingen är offentligt tillgänglig. |
|
|
Är frusen
|
is_frozen | boolean |
Om samlingen är låst och inte kan ändras. |
|
|
Läsa användare
|
read_users | array of string |
Lista över användar-ID:t med läsbehörighet till samlingen. |
|
|
Skriva användare
|
write_users | array of string |
Lista över användar-ID:t med skrivåtkomst till samlingen. |
|
|
Läsgrupper
|
read_groups | array of string |
Lista över grupp-ID:er (UUID) med läsbehörighet till samlingen. |
|
|
Skrivgrupper
|
write_groups | array of string |
Lista över grupp-ID:er (UUID) med skrivåtkomst till samlingen. |
|
|
Metadata
|
metadata | object |
Valfria metadata som är associerade med samlingen. Max längd 1 000 tecken |
|
|
Namnområdes-ID
|
namespace_id | string |
UUID för samlingen som ska uppdateras. |
Returer
Fullständig samlingsinformation, inklusive metadata, behörigheter och status.
- NamespaceResponse
- NamespaceResponse
Visa en lista över bifogade filer
Visa en lista över dokument
Visa en lista över dokumenten i en samling.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Samling-ID
|
collection_id | True | string |
Unik identifierare för samlingen |
||||||||||||
|
Sida
|
page | integer |
Sidnummer (1-baserat) |
|||||||||||||
|
Sidstorlek
|
page_size | integer |
Antal objekt per sida (1–100) |
|||||||||||||
|
Sortera efter
|
order_by | string |
Fält att sortera resultat efter.
|
|||||||||||||
|
Stigande
|
asc | boolean |
Sortera i stigande ordning om |
|||||||||||||
|
Namnet innehåller
|
infix | string |
Sökterm för dokumentnamn (skiftlägesokänslig partiell matchning). |
|||||||||||||
|
Typ av källa
|
source_type | string |
Begränsa resultatet till dokument med den här ursprungskällan. Dokument utan källmetadata undantas när det här filtret anges. |
Returer
- InfoPageApiResponse
- InfoPageApiResponse
Definitioner
AnswerOutcome
Ett svars resultat: ingen, fullständig eller ofullständig med koden för vad som skär den.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Status
|
status | string |
Om det finns ett svar och om dess generation har slutförts. |
|
Reason
|
reason | string |
Avbrottskoden när den är ofullständig, felkoden när den inte finns. aldrig när den är klar. |
AnswerUpdate
En åtgärd på svaret som en strömmande klient visar: lägga till, slutföra eller misslyckas.
complete är ofullständig när reason har angetts, fail bär en felkod och tar aldrig bort den text som visas.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Operation
|
operation | string | |
|
Reason
|
reason | string |
Endast terminal: avbrottskoden vid slutförd (t.ex. response_truncated_deadline), felkoden vid fel (t.ex. budget_exhausted, save_failed). |
|
Ståndaktighet
|
persistence | Persistence |
Om ett utbyte finns på posten; |
AttachmentErrorCode
Felkoder för misslyckade uppladdningar av bifogade filer.
Felkoder för misslyckade uppladdningar av bifogade filer.
- AttachmentErrorCode
- string
AttachmentResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
ID för bifogade filer
|
attachment_id | string | |
|
Namn på bifogad fil
|
attachment_name | string | |
|
Mime-typ för bifogade filer
|
attachment_mime_type | string |
Mime-bildtyp (t.ex. bild/png) |
|
Kontrollsumma för bifogade filer
|
attachment_checksum | string |
MD5-kontrollsumma för avbildningsbyte |
|
Storlek på bifogad fil
|
attachment_size | integer |
Bildens storlek i byte |
|
Status för bifogad fil
|
attachment_status | string |
AttachmentUploadError
Maskinläsbar felinformation för en enda uppladdning av bifogade filer.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
AttachmentErrorCode
|
code | AttachmentErrorCode |
Felkoder för misslyckade uppladdningar av bifogade filer. |
|
Message
|
message | string | |
|
Size
|
size | integer | |
|
Mime-typ
|
mime_type | string |
AttachmentUploadItem
Enhetligt resultat per fil i v2-svaret för uppladdning av bifogade filer.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Filnamn
|
filename | string | |
|
AttachmentUploadItemStatus
|
status | AttachmentUploadItemStatus |
Status per fil för batchuppladdningssvar för v2-bifogade filer. |
|
Statuskod
|
status_code | integer | |
|
AttachmentResponse
|
attachment | AttachmentResponse | |
|
AttachmentUploadError
|
error | AttachmentUploadError |
Maskinläsbar felinformation för en enda uppladdning av bifogade filer. |
AttachmentUploadItemStatus
Status per fil för batchuppladdningssvar för v2-bifogade filer.
Status per fil för batchuppladdningssvar för v2-bifogade filer.
- AttachmentUploadItemStatus
- string
AttachmentUploadsResponse
API-svar för batchuppladdningar med v2-bilagor.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Uploads
|
uploads | array of AttachmentUploadItem |
CollectionPage
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Sida
|
page | integer |
Aktuellt sidnummer (1-baserat). |
|
Size
|
size | integer |
Antal objekt per sida. |
|
Total
|
total | integer |
Totalt antal samlingar som matchar frågan. |
|
Sortera efter
|
order_by | string |
Fält som används för att sortera resultat. |
|
Asc
|
asc | boolean |
Om resultaten sorteras i stigande ordning. |
|
Sidor
|
pages | array of Namespace |
Lista över samlingar på den aktuella sidan. |
DeleteDocumentResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Information
|
details | array of DocumentDeletionStatus |
Resultat för borttagning per dokument. |
DocumentDeletionStatus
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Dokument-ID
|
document_id | string |
UUID för dokumentet. |
|
Status
|
status | Status | |
|
Message
|
message | string |
Mänskligt läsbart meddelande som beskriver resultatet. |
DocumentInfoApiResponse
| Name | Sökväg | Typ | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Dokument-ID
|
document_id | string |
UUID för dokumentet. |
||||||||||||||
|
Dokumentnamn
|
document_name | string |
Visningsnamn för dokumentet (vanligtvis det ursprungliga filnamnet). |
||||||||||||||
|
Dokumentsökväg
|
document_path | string |
Lagringssökvägen för dokumentet i systemet. |
||||||||||||||
|
Dokumentnamnområde
|
document_namespace | string |
Samlingsnamnområdet som det här dokumentet tillhör. |
||||||||||||||
|
Dokumentnamnområdes-ID
|
document_namespace_id | string |
UUID för samlingen som dokumentet tillhör. |
||||||||||||||
|
Dokumentbeskrivning
|
document_description | string |
Beskrivning av dokumentet från användaren. |
||||||||||||||
|
Uppladdad av
|
uploaded_by | string |
E-postadress till den person som laddade upp dokumentet. Null när ingen e-postadress för uppladdning är tillgänglig. |
||||||||||||||
|
Överföringsstatus
|
upload_status | string |
Aktuell uppladdnings-/bearbetningsstatus.
|
||||||||||||||
|
Kontrollsumma
|
checksum | string |
SHA-256-kontrollsumma för dokumentfilen för integritetsverifiering. |
||||||||||||||
|
Mime-typ
|
mime_type | string |
MIME-typ av det ursprungliga källdokumentet. |
||||||||||||||
|
Mime-återgivningstyp
|
rendition_mime_type | string |
MIME-typ av klientåtergivning; externa källor använder |
||||||||||||||
|
Källtyp
|
source_type | string |
Källa till det här dokumentet: |
||||||||||||||
|
DocumentStatus
|
status | DocumentStatus | |||||||||||||||
|
Uppladdad vid
|
uploaded_at | date-time |
Tidsstämpel när dokumentet laddades upp (ISO 8601-format). |
||||||||||||||
|
Uppdaterad kl
|
updated_at | date-time |
Tidsstämpel för den senaste uppdateringen av dokumentposten, om någon. |
||||||||||||||
|
Tas bort
|
is_deleted | boolean |
Om dokumentet har tagits bort mjukt. |
||||||||||||||
|
DocumentMetadata
|
document_metadata | DocumentMetadata |
DocumentMetadata
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Behörigheter
|
permissions | ||
|
Dokumenttaggar
|
document_tags | array of DocumentTag | |
|
Källmetadata
|
source_metadata | ||
|
IngestionMetadata
|
ingestion_metadata | IngestionMetadata |
DocumentStatus
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Status
|
status | string | |
|
Felkod
|
error_code | string |
DocumentTag
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Key
|
key | string |
Taggens identifierare. Alfanumeriska tecken och bindestreck. |
|
Value
|
value | string |
Taggvärde. Alfanumeriska tecken och bindestreck. |
InfoPageApiResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Sida
|
page | integer |
Aktuellt sidnummer (1-baserat). |
|
Size
|
size | integer |
Antal objekt per sida. |
|
Total
|
total | integer |
Totalt antal dokument som matchar frågan. |
|
Sortera efter
|
order_by | string |
Fält som används för att sortera resultat. |
|
Asc
|
asc | boolean |
Om resultaten sorteras i stigande ordning. |
|
Sidor
|
pages | array of DocumentInfoApiResponse |
Lista över dokument på den aktuella sidan. |
IngestionMetadata
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Förtroendepoäng
|
confidence_score | number | |
|
Ocr
|
ocr | boolean | |
|
Felaktiga tecken
|
bad_characters | boolean | |
|
Dolda blad hittades
|
found_hidden_sheets | boolean | |
|
Hittade mycket dolda blad
|
found_very_hidden_sheets | boolean | |
|
Hittade skyddade dolda blad
|
found_protected_hidden_sheets | boolean | |
|
Aktiverade dolda blad
|
enabled_hidden_sheets | boolean | |
|
Aktiverade mycket dolda blad
|
enabled_very_hidden_sheets | boolean | |
|
Datum då dokumentet skapades
|
document_created_date | date-time |
Namespace
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namespace
|
namespace | string |
Unik identifierare för samlingen. Standardvärdet är UUID. Använd det som ett externt ID. |
|
Name
|
name | string |
Valfritt visningsnamn för samlingen. Krävs om "namnområde" inte anges. |
|
Description
|
description | string |
Beskrivning av samlingen som kan läsas av människor. |
|
Är frusen
|
is_frozen | boolean |
Om samlingen är låst och inte kan ändras. |
|
Skapad av
|
created_by | string |
E-post eller ID för samlingens skapare. |
|
Skapad av användar-ID
|
created_by_user_id | string |
Användar-ID för samlingens skapare. |
|
Är offentligt
|
is_public | boolean |
Om samlingen är offentligt tillgänglig. |
|
Läsa användare
|
read_users | array of string |
Lista över användar-ID:t med läsbehörighet. |
|
Skriva användare
|
write_users | array of string |
Lista över användar-ID:t med skrivåtkomst. |
|
Läsgrupper
|
read_groups | array of string |
Lista över grupp-ID:t med läsbehörighet. |
|
Skrivgrupper
|
write_groups | array of string |
Lista över grupp-ID:t med skrivåtkomst. |
|
Metadata
|
metadata | object |
Ytterligare metadata som är associerade med samlingen. |
|
Version
|
version | string |
API-versionen av samlingen. |
|
Namnområdes-ID
|
namespace_id | string |
Unik identifierare för samlingen. |
|
Skapad vid
|
created_at | date-time |
Tidsstämpel när samlingen skapades. |
|
Ändrad vid
|
modified_at | date-time |
Tidsstämpel när samlingen senast ändrades. |
|
Tas bort
|
is_deleted | boolean |
Om samlingen har tagits bort mjukt. |
|
Är aktiv
|
is_active | boolean |
Om samlingen för närvarande är aktiv. |
|
Antal dokument
|
doc_count | integer |
Antal dokument för namnområdet. Exponera som en toppnivåegenskap för namnområde, från metadata.doc_count |
NamespaceResponse
Fullständig samlingsinformation, inklusive metadata, behörigheter och status.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Namnområdes-ID
|
namespace_id | string |
Unik identifierare för samlingen. |
|
Namespace
|
namespace | string |
URL-säker identifierare som används i API-anrop. |
|
Name
|
name | string |
Samlingens visningsnamn. |
|
Description
|
description | string |
Beskrivning av samlingen som kan läsas av människor. |
|
Är frusen
|
is_frozen | boolean |
Om samlingen är låst och inte kan ändras. |
|
Skapad av
|
created_by | string |
Användar-ID för samlingens skapare. |
|
Är offentligt
|
is_public | boolean |
Om samlingen är offentligt tillgänglig. |
|
Läsa användare
|
read_users | array of string |
Lista över användar-ID:t med läsbehörighet. |
|
Skriva användare
|
write_users | array of string |
Lista över användar-ID:t med skrivåtkomst. |
|
Läsgrupper
|
read_groups | array of string |
Lista över grupp-ID:t med läsbehörighet. |
|
Skrivgrupper
|
write_groups | array of string |
Lista över grupp-ID:t med skrivåtkomst. |
|
Avvisade skrivresurser
|
rejected_write_shares | array of string |
Användare av icke-berättigade skrivresurser |
|
Metadata
|
metadata | object |
Ytterligare metadata som är associerade med samlingen. |
|
Version
|
version | string |
API-version för det här svaret. |
|
Skapad vid
|
created_at | date-time |
Tidsstämpel när samlingen skapades. |
|
Ändrad vid
|
modified_at | date-time |
Tidsstämpel när samlingen senast ändrades. |
|
Tas bort
|
is_deleted | boolean |
Om samlingen har tagits bort mjukt. |
|
Är aktiv
|
is_active | boolean |
Om samlingen för närvarande är aktiv. |
|
Antal dokument
|
doc_count | integer |
Antal dokument i samlingen. |
|
Ägare
|
owner | string |
E-post till samlingens ägare. För närvarande den användare som skapade samlingen. |
PaginatedSearchApiResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Totalt dokument
|
totalDocuments | integer |
Totalt antal dokument som matchar sökvillkoren. |
|
Dokumentinfo
|
documentInfo | array of DocumentInfoApiResponse |
Lista över dokument på den aktuella resultatsidan. |
|
Sidnumrerad nyckel
|
paginated_key | string |
Ogenomskinlig sidnumreringstoken. Skicka det här värdet i efterföljande begäranden för att hämta nästa eller föregående sida. |
Ståndaktighet
Om ett utbyte finns på posten; unknown innebär att incheckningen kan ha skett.
Om ett utbyte finns på posten; unknown innebär att incheckningen kan ha skett.
- Ståndaktighet
- string
QAInferenceResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Genererad text
|
generated_text | string |
Det AI-genererade svaret i Markdown-format. |
|
Source
|
source | object |
Källdokument som refereras till i svaret, med numeriska källhänvisningsmarkörer (t.ex. |
|
Strömmen är klar
|
stream_complete | boolean |
Anger om strömningssvaret har slutförts. Alltid sant för icke-strömmande svar. |
|
Källalternativ
|
source_options | array of SourceOptions |
Svarskällans typer som användes för att generera det här svaret. |
|
Bilagor
|
attachments | array of uuid4 |
ID:n för LLM-genererade filbilagor (t.ex. CSV, XLSX, JSON, PDF, bilder) som medföljer svaret. Utdatatyper som stöds är textformat, kalkylblad, dokument och bilder. I konversationer med flera turer spelas de senaste 5 genererade filerna upp automatiskt till modellen. Endast avbildningar och PDF-filer spelas upp som LLM-indata på grund av begränsningar i LLM-tjänstens infrastruktur. |
|
Sammanfattning av resonemang
|
reasoning_summary | string |
En sammanfattning av AI-resonemangsprocessen, som ingår när resonemangsläget är aktiverat. |
|
ResponseEvent
|
response_event | ResponseEvent | |
|
AnswerUpdate
|
answer_update | AnswerUpdate |
En åtgärd på svaret som en strömmande klient visar: lägga till, slutföra eller misslyckas.
|
|
AnswerOutcome
|
answer_outcome | AnswerOutcome |
Ett svars resultat: ingen, fullständig eller ofullständig med koden för vad som skär den. |
ResponseEvent
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Type
|
type | string |
Händelseidentifierare för dot-namespaced efter mönstret |
|
Message
|
message | string |
Användarriktad förloppstext som beskriver det aktuella bearbetningssteget. |
|
Meta
|
meta | object |
Strukturerade metadata för händelsen. Vanliga fält: |
|
Skapad vid
|
created_at | string |
ISO 8601 UTC-tidsstämpel för när den här händelsen skapades. |
SourceOptions
- SourceOptions
- string
Status
- Status
- string
SammanfattningResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Sammanfattning
|
summary | string |
Den AI-genererade dokumentsammanfattningen i Markdown-format. |
|
Source
|
source | object |
Källdokument som används för att skapa sammanfattningen, med hjälp av numerisk källhänvisningsmarkör. |
UploadDocumentResponse
Svaret returnerades för varje uppladdat dokument.
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Användar-ID
|
user_id | string |
ID för användaren som laddade upp dokumentet. |
|
Dokument-ID
|
document_id | string |
Unik identifierare som tilldelats det uppladdade dokumentet. |
|
Dokumentnamn
|
document_name | string |
Ursprungligt filnamn för det uppladdade dokumentet. |
|
Dokumentnamnområde
|
document_namespace | string |
Namnområde (samlingsidentifierare) som dokumentet tillhör. |
|
Dokumentnamnområdes-ID
|
document_namespace_id | string |
UUID för samlingen som dokumentet tillhör. |
|
Status
|
status | string |
Bearbetningsstatus för det uppladdade dokumentet. |
|
Innehållstyp
|
content_type | string |
MIME-typ av det uppladdade dokumentet. |
binary
Det här är den grundläggande datatypen "binär".