Adobe Acrobat Knowledge Base (Vorschau)
Knowledge Base in Adobe Acrobat Studio ermöglicht Benutzern unterhaltungsbasierten Zugriff auf Kenntnisse, die sich in großen, kuratierten Dokumentsammlungen befinden, über multi-turn Q&A, Zusammenfassung, Extraktion und Suche hinweg. Bringen Sie Die Knowledge Base-Funktionen in die Anwendungen und Workflows ein, in denen Sie arbeiten, um In SharePoint und anderen unterstützten Repositorys und Power-Genehmigungen, Benachrichtigungen, Inhaltserstellungs- und Geschäftsprozesse zu verbinden.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Standard | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Adobe |
| URL | https://www.adobe.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | ADOBE INC. |
| Website | https://business.adobe.com/products/acrobat-business/knowledge-base.html |
| Datenschutzrichtlinie | https://www.adobe.com/go/privacy_policy |
| Kategorien | Produktivität |
Knowledge Base in Acrobat
Knowledge Base in Adobe Acrobat Studio ermöglicht Benutzern unterhaltungsbasierten Zugriff auf Kenntnisse, die sich in großen, kuratierten Dokumentsammlungen befinden, über multi-turn Q&A, Zusammenfassung, Extraktion und Suche hinweg. Bringen Sie Die Knowledge Base-Funktionen in die Anwendungen und Workflows ein, in denen Sie arbeiten, um In SharePoint und anderen unterstützten Repositorys und Power-Genehmigungen, Benachrichtigungen, Inhaltserstellungs- und Geschäftsprozesse zu verbinden.
Publisher: Adobe, Inc.
Voraussetzungen
Ein Adobe-Konto mit Zugriff auf Knowledge Base in Acrobat ist erforderlich.
So erhalten Sie Anmeldeinformationen
Melden Sie sich mit Ihrer Adobe ID an, wenn Sie eine Verbindung erstellen. Dieser Connector authentifiziert sich mit Adobe Identity Management System (IMS) mit OAuth 2.0; Sie werden zur Adobe-Anmeldeseite umgeleitet und aufgefordert, den angeforderten Berechtigungen zuzustimmen, bevor die Verbindung erstellt wird.
Erste Schritte mit Ihrem Connector
N/A
Bekannte Probleme und Einschränkungen
N/A
Häufige Fehler und Abhilfemaßnahmen
N/A
FAQ
N/A
Aktionen
| Aktualisieren der Sammlung |
Alle Eigenschaften einer vorhandenen Auflistung aktualisieren. |
| Anhänge hochladen |
Laden Sie eine oder mehrere Anlagen hoch. |
| Anlage abrufen |
Rufen Sie eine einzelne Anlage anhand ihrer UUID ab. |
| Anlage löschen |
Löschen Sie eine einzelne Anlage durch ihre UUID. |
| Anlagen auflisten |
Anlagen auflisten. |
| Anlagendatei abrufen |
Laden Sie den Dateiinhalt einer Anlage durch die UUID herunter. |
| Dokumentdatei abrufen |
Rufen Sie die Metadaten und Inhalte eines einzelnen Dokuments anhand der UUID ab. |
| Dokumente auflisten |
Auflisten der Dokumente in einer Auflistung. |
| Dokumente durchsuchen (paginiert) |
Durchsuchen Sie Dokumente in einer Sammlung mit paginierten Ergebnissen. |
| Dokumente zusammenfassen |
Generieren Sie eine Zusammenfassung eines oder mehrerer Dokumente in einer Auflistung. |
| Dokumentstatus abrufen |
Rufen Sie den Indizierungsstatus eines einzelnen Dokuments anhand der UUID ab. |
| Erstellen der Sammlung |
Erstellen Sie eine Sammlung (einen Namespace, der Dokumente gruppiert und den Zugriff steuert). |
| Fragen stellen |
Stellen Sie eine Natürliche-Sprache-Frage gegen eine Sammlung und erhalten Sie eine Antwort mit Zitaten. |
| Hochladen von Dokumenten |
Laden Sie ein oder mehrere Dokumente in eine Sammlung für die Indizierung hoch. |
| Löschen von Dokumenten |
Löschen Sie ein oder mehrere Dokumente aus einer Sammlung anhand ihrer UUIDs. |
| Sammlung abrufen |
Rufen Sie eine einzelne Sammlung anhand ihrer UUID ab. |
| Sammlung löschen |
Löschen sie eine Auflistung und alle zugehörigen Dokumente. |
| Sammlungen auflisten |
Listet die Sammlungen auf, auf die der Benutzer zugreifen kann. |
Aktualisieren der Sammlung
Alle Eigenschaften einer vorhandenen Auflistung aktualisieren.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sammlungs-ID
|
collection_id | True | uuid4 |
Eindeutiger Bezeichner der Sammlung |
|
Name
|
name | True | string |
Anzeigename für die Auflistung. Erforderlich, maximale Länge 100 Zeichen |
|
Description
|
description | string |
Optionale Beschreibung der Auflistung. Standardmäßig wird eine leere Zeichenfolge mit maximal 500 Zeichen verwendet. |
|
|
Ist öffentlich
|
is_public | boolean |
Gibt an, ob die Sammlung öffentlich zugänglich ist. |
|
|
Ist fixiert
|
is_frozen | boolean |
Gibt an, ob die Auflistung fixiert ist und nicht geändert werden kann. |
|
|
Benutzer lesen
|
read_users | array of string |
Liste der Benutzer-IDs mit Lesezugriff auf die Sammlung. |
|
|
Benutzer schreiben
|
write_users | array of string |
Liste der Benutzer-IDs mit Schreibzugriff auf die Sammlung. |
|
|
Gruppen lesen
|
read_groups | array of string |
Liste der Gruppen-IDs (UUIDs) mit Lesezugriff auf die Sammlung. |
|
|
Schreiben von Gruppen
|
write_groups | array of string |
Liste der Gruppen-IDs (UUIDs) mit Schreibzugriff auf die Auflistung. |
|
|
Metadata
|
metadata | object |
Optionale Metadaten, die der Auflistung zugeordnet sind. Maximale Länge 1000 Zeichen |
|
|
Namespace-ID
|
namespace_id | string |
UUID der zu aktualisierenden Sammlung. |
Gibt zurück
Vollständige Sammlungsdetails, einschließlich Metadaten, Berechtigungen und Status.
- NamespaceResponse
- NamespaceResponse
Anhänge hochladen
Laden Sie eine oder mehrere Anlagen hoch.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datei, die hochgeladen werden soll
|
documents | True | file |
1 bis 10 Bilder oder Dateien. Bilder: image/jpeg, image/png, image/jpg, image/webp, image/gif - ≤10 MB. Dateien: anwendung/pdf - ≤8 MB |
Gibt zurück
API-Antwort für v2-Anlagenbatchuploads.
- AttachmentUploadsResponse
- AttachmentUploadsResponse
Anlage abrufen
Rufen Sie eine einzelne Anlage anhand ihrer UUID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anlagen-ID
|
attachment_id | True | uuid |
UUID der Anlage |
Gibt zurück
- AttachmentResponse
- AttachmentResponse
Anlage löschen
Löschen Sie eine einzelne Anlage durch ihre UUID.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anlagen-ID
|
attachment_id | True | uuid |
UUID der Anlage |
Anlagen auflisten
Anlagendatei abrufen
Laden Sie den Dateiinhalt einer Anlage durch die UUID herunter.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anlagen-ID
|
attachment_id | True | uuid |
UUID der Anlage |
Dokumentdatei abrufen
Rufen Sie die Metadaten und Inhalte eines einzelnen Dokuments anhand der UUID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
document_id | True | uuid |
UUID des Dokuments |
|
Artefaktdateiname
|
filename | string |
Spezifisches gespeichertes Artefakt, das abgerufen werden soll. Wenn sie weggelassen wird, wird die aktuelle Dokumentdarstellung zurückgegeben. |
Gibt zurück
- response
- binary
Dokumente auflisten
Auflisten der Dokumente in einer Auflistung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sammlungs-ID
|
collection_id | True | string |
Eindeutiger Bezeichner der Sammlung |
||||||||||||
|
Seite
|
page | integer |
Seitenzahl (1-basiert) |
|||||||||||||
|
Seitengröße
|
page_size | integer |
Anzahl der Elemente pro Seite (1-100) |
|||||||||||||
|
Sortieren nach
|
order_by | string |
Feld zum Sortieren von Ergebnissen nach.
|
|||||||||||||
|
Aufsteigend
|
asc | boolean |
Sortieren Sie in aufsteigender Reihenfolge, wenn |
|||||||||||||
|
Name enthält
|
infix | string |
Suchbegriff für den Dokumentnamen (teilweise Übereinstimmung zwischen Groß- und Kleinschreibung). |
|||||||||||||
|
Quelltyp
|
source_type | string |
Beschränken Sie die Ergebnisse auf Dokumente mit dieser ursprünglichen Quelle. Dokumente ohne Quellmetadaten werden ausgeschlossen, wenn dieser Filter festgelegt ist. |
Gibt zurück
- InfoPageApiResponse
- InfoPageApiResponse
Dokumente durchsuchen (paginiert)
Durchsuchen Sie Dokumente in einer Sammlung mit paginierten Ergebnissen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokumentnamespace
|
document_namespace | True | string |
Der Sammlungsname der dokumente, in der gesucht werden soll. |
|
Filtern nach
|
filter_by | True | string |
Stichwortsuchabfrage zum Filtern von Dokumenten nach Inhalten oder Metadaten. |
|
Dokument-IDs
|
document_ids | array of string |
Liste bestimmter Dokument-IDs, auf die die Suche beschränkt werden soll. Maximal 1000 Dokument-IDs. |
|
|
Key
|
key | True | string |
Tag-Kennung. Nur alphanumerische Zeichen und Bindestriche. |
|
Wert
|
value | True | string |
Tagwert. Nur alphanumerische Zeichen und Bindestriche. |
|
Seitengröße
|
page_size | integer |
Die Anzahl der Ergebnisse, die pro Seite zurückgegeben werden sollen. Die nicht paginierte Suche gibt immer page_size von 10000 zurück. |
|
|
Sortieren nach
|
order_by | string |
Das Feld, nach dem die Ergebnisse sortiert werden sollen. |
|
|
Asc
|
asc | boolean |
Sortierreihenfolge: True für aufsteigend, False für absteigend. |
|
|
Paginierungsreihenfolge
|
pagination_order | string |
Bestimmt, ob die nächste oder vorherige Seite der Ergebnisse abgerufen werden soll. |
|
|
Paginierter Schlüssel
|
paginated_key | string |
Ein Schlüssel, der für die Paginierung verwendet wird. |
Gibt zurück
- PaginatedSearchApiResponse
- PaginatedSearchApiResponse
Dokumente zusammenfassen
Generieren Sie eine Zusammenfassung eines oder mehrerer Dokumente in einer Auflistung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-IDs
|
document_ids | True | array of string |
UUIDs bestimmter Dokumente, die zusammengefasst werden sollen. Maximal 10 Dokumente pro Anforderung. |
|
Dokumentnamespace
|
document_namespace | True | string |
Sammlungsnamespace, der die Dokumente enthält. |
Gibt zurück
- Antwortzusammenfassdokumente
- array of SummarizationResponse
Dokumentstatus abrufen
Rufen Sie den Indizierungsstatus eines einzelnen Dokuments anhand der UUID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-ID
|
document_id | True | uuid |
UUID des Dokuments |
Gibt zurück
- Dokumentinfo
- DocumentInfoApiResponse
Erstellen der Sammlung
Erstellen Sie eine Sammlung (einen Namespace, der Dokumente gruppiert und den Zugriff steuert).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Anzeigename für die Auflistung. Erforderlich, maximale Länge 100 Zeichen |
|
Description
|
description | string |
Optionale Beschreibung der Auflistung. Standardmäßig wird eine leere Zeichenfolge mit maximal 500 Zeichen verwendet. |
|
|
Ist öffentlich
|
is_public | boolean |
Gibt an, ob die Sammlung öffentlich zugänglich ist. |
|
|
Ist fixiert
|
is_frozen | boolean |
Gibt an, ob die Auflistung fixiert ist und nicht geändert werden kann. |
|
|
Benutzer lesen
|
read_users | array of string |
Liste der Benutzer-IDs mit Lesezugriff auf die Sammlung. |
|
|
Benutzer schreiben
|
write_users | array of string |
Liste der Benutzer-IDs mit Schreibzugriff auf die Sammlung. |
|
|
Gruppen lesen
|
read_groups | array of string |
Liste der Gruppen-IDs (UUIDs) mit Lesezugriff auf die Sammlung. |
|
|
Schreiben von Gruppen
|
write_groups | array of string |
Liste der Gruppen-IDs (UUIDs) mit Schreibzugriff auf die Auflistung. |
|
|
Metadata
|
metadata | object |
Optionale Metadaten, die der Auflistung zugeordnet sind. Maximale Länge 1000 Zeichen |
Gibt zurück
Vollständige Sammlungsdetails, einschließlich Metadaten, Berechtigungen und Status.
- NamespaceResponse
- NamespaceResponse
Fragen stellen
Stellen Sie eine Natürliche-Sprache-Frage gegen eine Sammlung und erhalten Sie eine Antwort mit Zitaten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anforderungs-ID
|
request_id | string |
Eindeutiger Bezeichner für diese Anforderung, der für die Nachverfolgung im Chatverlauf verwendet wird. |
|
|
Dokument-IDs
|
document_ids | array of string |
UUIDs bestimmter Dokumente, auf die die Suche beschränkt werden soll. Wenn leer, werden alle Dokumente in den angegebenen Sammlungen durchsucht. |
|
|
Collections
|
collections | array of string |
Zu durchsuchende Sammlungsnamespaces. Mindestens eine ist für DIE COLLECTION-Quelle erforderlich. |
|
|
Inputs
|
inputs | string |
Die Frage oder Aufforderung, zu beantworten. Unterstützt Abfragen in natürlicher Sprache. |
|
|
Format
|
format | string | ||
|
Weitschweifigkeit
|
style | string | ||
|
Ton
|
tone | string | ||
|
Argumentation
|
reasoning | string | ||
|
Benutzerdefinierte Anweisungen
|
custom_instructions | string |
Freitextanweisungen zum weiteren Anpassen des KI-Antwortverhaltens. |
|
|
SourceOptions
|
Source Options | string | ||
|
Rückschlussmodus
|
inference_mode | string |
Zu verwendende KI-Modellebene. Optionen: |
|
|
Ausführungsstrategie
|
inference_type | string |
Ausführungsstrategie für Rückschlüsse auf Frageantworten. Orthogonal zu InferenceMode (Modellebene): AGENTIC wählt die Multi-Iteration Agent-Schleife aus, DEFAULT den klassischen Single-Inference-RAG-Pfad. Keine fehlende Koersion – unbekannte Werte müssen die Überprüfung fehlschlagen. |
|
|
Key
|
key | True | string |
Tag-Kennung. Nur alphanumerische Zeichen und Bindestriche. |
|
Wert
|
value | True | string |
Tagwert. Nur alphanumerische Zeichen und Bindestriche. |
|
Anlagen-IDs
|
attachment_ids | array of uuid4 |
IDs von zuvor hochgeladenen Dateianlagen, die als visueller Kontext eingeschlossen werden sollen. Maximal 15 pro Anforderung. Akzeptierte Eingabetypen: Bilder (JPEG, PNG, GIF, WebP) und PDF. Andere Dateitypen werden zur Uploadzeit abgelehnt. In Multi-Turn-Unterhaltungen werden die neuesten 5 LLM-generierten Dateien automatisch als Kontext wiedergegeben. Nur Bilder und PDF-Dateien werden aufgrund von Einschränkungen der LLM-Dienstinfrastruktur wiedergegeben. |
|
|
Dateigenerierungsmodus
|
file_generation | string | ||
|
Verbindungs-ID
|
connection_id | string |
ID der zu verwendenden Office 365 Verbindung. Nur für OFFICE365 Quelle erforderlich. Wenn sie weggelassen wird, wird die erste übereinstimmende Verbindung verwendet. |
|
|
Zeitzone
|
time_zone | string |
IANA-Zeitzonenbezeichner für Datumsbezogene Abfragen (z. B |
|
|
Abbildungen aktivieren
|
enable_figures | boolean |
Bei "true" werden abgerufene Dokumentfiguren (Diagramme, Bilder) als visueller Kontext einbezogen. Bis zu 8 Zahlen insgesamt (max. 4 pro Dokument). |
|
|
Filiale
|
store | boolean |
Wenn dies der Fall ist, wird die Unterhaltung im Chatverlauf beibehalten und ermöglicht multi-turn follow-ups. Auf "false" für zustandslose, einmalige Abfragen festgelegt. |
|
|
AttributionField
|
Include | string |
Felder aus DocumentInfo, die für die Aufnahme in Quellantworten berechtigt sind. Jeder Wert ist ein Punktnotationspfad, der bei DocumentInfo verwurzelt ist. Jeder Pfad muss in ein Feld aufgelöst werden, das mit attribution_eligible = True versehen ist. |
|
|
BoundCoordinateFormat
|
bound_coordinate_format | string | ||
|
Enabled
|
enabled | boolean |
Aktivieren Sie Statusereignisse während des Streamings. |
|
|
ResponseEventDetail
|
detail | string | ||
|
Antwortupdates
|
answer_updates | boolean |
Streamen Sie die agentische Antwort, wie sie geschrieben wird, als Frames, die eine answer_update (anfügen, dann schließen oder fehlschlagen) anstelle eines endgültigen Frames. Der Client muss diese Vorgänge anwenden. Wird für nicht-streaming- und nicht-agentische Anforderungen ignoriert. |
|
|
Exchange-ID
|
exchange_id | string |
Der Clientbezeichner dieses Austauschs innerhalb der Unterhaltung. Gespeichert mit dem Austausch und der Rückgabe im Chatverlauf, sodass ein Kunde seine lokale Drehung mit dem Datensatz in Einklang bringen kann: Die gleiche Frage liefert zweimal zwei Austausch, und nur die ID teilt sie auseinander. |
Gibt zurück
- QAInferenceResponse
- QAInferenceResponse
Hochladen von Dokumenten
Laden Sie ein oder mehrere Dokumente in eine Sammlung für die Indizierung hoch.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Sammlungs-ID
|
collection_id | True | uuid4 |
Eindeutiger Bezeichner der Sammlung |
||||||||||||
|
Duplikatbehandlung
|
option | string |
Doppelte Behandlungsstrategie.
|
|||||||||||||
|
OCR-Modus
|
ocr | string |
OCR-Verarbeitungsmodus für PDF- und Bilddokumente. Bilduploads erfordern immer OCR.
|
|||||||||||||
|
Ausgeblendete Blattextraktion
|
hidden_sheets | string |
Steuert den ausgeblendeten Blattextraktionsmodus für Excel Dokumente.
|
|||||||||||||
|
Datei, die hochgeladen werden soll
|
documents | True | file |
Mindestens eine Datei, die hochgeladen werden soll. Unterstützte Formate: PDF, DOC/DOCX, DOT/DOTX, TXT, RTF, XLS/XLSM/XLSX, PPT/PPTX, ODP, ODT, CSV, EML, JSON, MD, HTML, JPEG, PNG, TIFF, GIF, WebP und BMP. |
||||||||||||
|
Dokumenttags
|
document_tags | string |
JSON-Array von Schlüsselwerttags, die an alle hochgeladenen Dokumente angefügt werden sollen. Jedes Tag muss über ein |
|||||||||||||
|
HTML-Quelllinks
|
html_links | string |
JSON-Objektzuordnung HTML-Dateinamen zu ihren ursprünglichen Quell-URLs. Gilt nur für hochgeladene HTML-Dateien. Der Schlüssel ist der Dateiname einer HTML-Datei im Upload, und der Wert ist die ursprüngliche URL, aus der sie gespeichert wurde. |
Gibt zurück
- Antwortuploaddocuments
- array of UploadDocumentResponse
Löschen von Dokumenten
Löschen Sie ein oder mehrere Dokumente aus einer Sammlung anhand ihrer UUIDs.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Dokument-IDs
|
document_ids | array of uuid4 |
Liste der zu löschenden Dokument-UUIDs. |
|
|
Sammlungs-ID
|
collection_id | string |
UUID der Sammlung, die die Dokumente enthält. |
Gibt zurück
- DeleteDocumentResponse
- DeleteDocumentResponse
Sammlung abrufen
Rufen Sie eine einzelne Sammlung anhand ihrer UUID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sammlungs-ID
|
collection_id | True | string |
Eindeutiger Bezeichner der Sammlung |
Gibt zurück
Vollständige Sammlungsdetails, einschließlich Metadaten, Berechtigungen und Status.
- NamespaceResponse
- NamespaceResponse
Sammlung löschen
Löschen sie eine Auflistung und alle zugehörigen Dokumente.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Sammlungs-ID
|
collection_id | True | uuid4 |
Eindeutiger Bezeichner der Sammlung |
Gibt zurück
Vollständige Sammlungsdetails, einschließlich Metadaten, Berechtigungen und Status.
- NamespaceResponse
- NamespaceResponse
Sammlungen auflisten
Listet die Sammlungen auf, auf die der Benutzer zugreifen kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Seite
|
page | integer |
Seitenzahl (1-basiert) |
|||||||||||||
|
Seitengröße
|
page_size | integer |
Anzahl der Elemente pro Seite (1-100) |
|||||||||||||
|
Sortieren nach
|
order_by | string |
Feld zum Sortieren von Ergebnissen nach.
|
|||||||||||||
|
Aufsteigend
|
asc | boolean |
Sortieren Sie in aufsteigender Reihenfolge, wenn |
|||||||||||||
|
Name enthält
|
infix | string |
Suchbegriff für den Auflistungsnamen (teilweise Übereinstimmung zwischen Groß- und Kleinschreibung). |
|||||||||||||
|
Filtern
|
filter_constraint | string |
Filtern sie Sammlungen nach Besitz oder Bereich.
|
Gibt zurück
- CollectionPage
- CollectionPage
Definitionen
AnswerOutcome
Das Ergebnis einer Antwort: keine, vollständig oder unvollständig mit dem Code der Ausschneidung.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Status
|
status | string |
Gibt an, ob eine Antwort vorhanden ist und ob die Generation abgeschlossen ist. |
|
Grund
|
reason | string |
Der Unterbrechungscode, wenn er unvollständig ist, der Fehlercode, wenn keine; Nie festgelegt, wenn sie abgeschlossen ist. |
AnswerUpdate
Ein Vorgang auf der Antwort, die ein Streamingclient anzeigt: Anfügen, Abschließen oder Fehlschlagen.
complete ist unvollständig, wenn reason festgelegt wird; fail trägt einen Fehlercode und zieht den angezeigten Text nie zurück.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Operation
|
operation | string | |
|
Grund
|
reason | string |
Nur Terminal: der unterbrechungscode ist abgeschlossen (z. B. response_truncated_deadline), der Fehlercode beim Fehler (z. B. budget_exhausted, save_failed). |
|
Ausdauer
|
persistence | Persistence |
Gibt an, ob sich ein Austausch im Datensatz befindet; |
AttachmentErrorCode
Fehlercodes für fehlgeschlagene Anlagenuploads.
Fehlercodes für fehlgeschlagene Anlagenuploads.
- AttachmentErrorCode
- string
AttachmentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anlagen-ID
|
attachment_id | string | |
|
Anlagenname
|
attachment_name | string | |
|
Anlagen-MIME-Typ
|
attachment_mime_type | string |
MIME-Bildtyp (z. B. Bild/PNG) |
|
Anlagenprüfsumme
|
attachment_checksum | string |
MD5-Prüfsumme der Bildbytes |
|
Anlagengröße
|
attachment_size | integer |
Größe des Bilds in Byte |
|
Anlagenstatus
|
attachment_status | string |
AttachmentUploadError
Computerlesbare Fehlerdetails für einen einzelnen Anlagenupload.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
AttachmentErrorCode
|
code | AttachmentErrorCode |
Fehlercodes für fehlgeschlagene Anlagenuploads. |
|
Meldung
|
message | string | |
|
Größe
|
size | integer | |
|
MIME-Typ
|
mime_type | string |
AttachmentUploadItem
Einheitliches Ergebnis pro Datei in der v2-Antwort zum Hochladen von Anlagen.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dateiname
|
filename | string | |
|
AttachmentUploadItemStatus
|
status | AttachmentUploadItemStatus |
Dateistatus für V2-Batchuploadantworten pro Datei. |
|
Statuscode
|
status_code | integer | |
|
AttachmentResponse
|
attachment | AttachmentResponse | |
|
AttachmentUploadError
|
error | AttachmentUploadError |
Computerlesbare Fehlerdetails für einen einzelnen Anlagenupload. |
AttachmentUploadItemStatus
Dateistatus für V2-Batchuploadantworten pro Datei.
Dateistatus für V2-Batchuploadantworten pro Datei.
- AttachmentUploadItemStatus
- string
AttachmentUploadsResponse
API-Antwort für v2-Anlagenbatchuploads.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Uploads
|
uploads | array of AttachmentUploadItem |
CollectionPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Aktuelle Seitenzahl (1-basiert). |
|
Größe
|
size | integer |
Anzahl der Elemente pro Seite. |
|
Total
|
total | integer |
Die Gesamtanzahl der Auflistungen, die der Abfrage entsprechen. |
|
Sortieren nach
|
order_by | string |
Feld, das zum Sortieren von Ergebnissen verwendet wird. |
|
Asc
|
asc | boolean |
Gibt an, ob die Ergebnisse in aufsteigender Reihenfolge sortiert werden. |
|
Seiten
|
pages | array of Namespace |
Liste der Sammlungen auf der aktuellen Seite. |
DeleteDocumentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Details
|
details | array of DocumentDeletionStatus |
Löschergebnisse pro Dokument. |
DocumentDeletionStatus
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokument-ID
|
document_id | string |
UUID des Dokuments. |
|
Status
|
status | Status | |
|
Meldung
|
message | string |
Lesbare Nachricht, die das Ergebnis beschreibt. |
DocumentInfoApiResponse
| Name | Pfad | Typ | Beschreibung | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Dokument-ID
|
document_id | string |
UUID des Dokuments. |
||||||||||||||
|
Dokumentname
|
document_name | string |
Anzeigename des Dokuments (in der Regel der ursprüngliche Dateiname). |
||||||||||||||
|
Dokumentpfad
|
document_path | string |
Speicherpfad des Dokuments im System. |
||||||||||||||
|
Dokumentnamespace
|
document_namespace | string |
Der Sammlungsnamespace, zu dem dieses Dokument gehört. |
||||||||||||||
|
Dokumentnamespace-ID
|
document_namespace_id | string |
UUID der Sammlung, zu der das Dokument gehört. |
||||||||||||||
|
Dokumentbeschreibung
|
document_description | string |
Vom Benutzer bereitgestellte Beschreibung des Dokuments. |
||||||||||||||
|
Hochgeladen von
|
uploaded_by | string |
E-Mail-Adresse der Person, die das Dokument hochgeladen hat. Null, wenn keine Uploader-E-Mail verfügbar ist. |
||||||||||||||
|
Uploadstatus
|
upload_status | string |
Aktueller Upload-/Verarbeitungsstatus.
|
||||||||||||||
|
Prüfsumme
|
checksum | string |
SHA-256-Prüfsumme der Dokumentdatei zur Integritätsüberprüfung. |
||||||||||||||
|
MIME-Typ
|
mime_type | string |
MIME-Typ des ursprünglichen Quelldokuments. |
||||||||||||||
|
Mime-Typ der Formatvariante
|
rendition_mime_type | string |
MIME-Typ der Clientdarstellung; Externe Quellen verwenden |
||||||||||||||
|
Quelltyp
|
source_type | string |
Ursprungsquelle dieses Dokuments: |
||||||||||||||
|
DocumentStatus
|
status | DocumentStatus | |||||||||||||||
|
Hochgeladen unter
|
uploaded_at | date-time |
Zeitstempel beim Hochladen des Dokuments (ISO 8601-Format). |
||||||||||||||
|
Aktualisiert am
|
updated_at | date-time |
Zeitstempel der letzten Aktualisierung für den Dokumentdatensatz( falls vorhanden). |
||||||||||||||
|
Ist gelöscht
|
is_deleted | boolean |
Gibt an, ob das Dokument vorläufig gelöscht wurde. |
||||||||||||||
|
DocumentMetadata
|
document_metadata | DocumentMetadata |
DocumentMetadata
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Berechtigungen
|
permissions | ||
|
Dokumenttags
|
document_tags | array of DocumentTag | |
|
Quellmetadaten
|
source_metadata | ||
|
IngestionMetadata
|
ingestion_metadata | IngestionMetadata |
DocumentStatus
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Status
|
status | string | |
|
Fehlercode
|
error_code | string |
DocumentTag
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Key
|
key | string |
Tag-Kennung. Nur alphanumerische Zeichen und Bindestriche. |
|
Wert
|
value | string |
Tagwert. Nur alphanumerische Zeichen und Bindestriche. |
InfoPageApiResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Aktuelle Seitenzahl (1-basiert). |
|
Größe
|
size | integer |
Anzahl der Elemente pro Seite. |
|
Total
|
total | integer |
Die Gesamtanzahl der Dokumente, die der Abfrage entsprechen. |
|
Sortieren nach
|
order_by | string |
Feld, das zum Sortieren von Ergebnissen verwendet wird. |
|
Asc
|
asc | boolean |
Gibt an, ob die Ergebnisse in aufsteigender Reihenfolge sortiert werden. |
|
Seiten
|
pages | array of DocumentInfoApiResponse |
Liste der Dokumente auf der aktuellen Seite. |
IngestionMetadata
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zuverlässigkeitsbewertung
|
confidence_score | number | |
|
Ocr
|
ocr | boolean | |
|
Ungültige Zeichen
|
bad_characters | boolean | |
|
Ausgeblendete Blätter gefunden
|
found_hidden_sheets | boolean | |
|
Sehr ausgeblendete Blätter gefunden
|
found_very_hidden_sheets | boolean | |
|
Geschützte ausgeblendete Blätter gefunden
|
found_protected_hidden_sheets | boolean | |
|
Ausgeblendete Blätter aktiviert
|
enabled_hidden_sheets | boolean | |
|
Sehr ausgeblendete Blätter aktiviert
|
enabled_very_hidden_sheets | boolean | |
|
Erstellungsdatum des Dokuments
|
document_created_date | date-time |
Namespace
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Namespace
|
namespace | string |
Eindeutiger Bezeichner für die Sammlung. Der Standardwert ist UUID. Verwenden Sie sie als externe ID. |
|
Name
|
name | string |
Optionaler Anzeigename für die Auflistung. Erforderlich, wenn "Namespace" nicht angegeben wird. |
|
Description
|
description | string |
Lesbare Beschreibung der Sammlung. |
|
Ist fixiert
|
is_frozen | boolean |
Gibt an, ob die Auflistung fixiert ist und nicht geändert werden kann. |
|
Erstellt von
|
created_by | string |
E-Mail oder ID des Erstellers der Sammlung. |
|
Erstellt von Benutzer-ID
|
created_by_user_id | string |
Benutzer-ID des Erstellers der Sammlung. |
|
Ist öffentlich
|
is_public | boolean |
Gibt an, ob die Sammlung öffentlich zugänglich ist. |
|
Benutzer lesen
|
read_users | array of string |
Liste der Benutzer-IDs mit Lesezugriff. |
|
Benutzer schreiben
|
write_users | array of string |
Liste der Benutzer-IDs mit Schreibzugriff. |
|
Gruppen lesen
|
read_groups | array of string |
Liste der Gruppen-IDs mit Lesezugriff. |
|
Schreiben von Gruppen
|
write_groups | array of string |
Liste der Gruppen-IDs mit Schreibzugriff. |
|
Metadata
|
metadata | object |
Zusätzliche Metadaten, die der Auflistung zugeordnet sind. |
|
Version
|
version | string |
API-Version der Sammlung. |
|
Namespace-ID
|
namespace_id | string |
Eindeutiger Bezeichner für die Sammlung. |
|
Erstellt am
|
created_at | date-time |
Zeitstempel beim Erstellen der Sammlung. |
|
Geändert am
|
modified_at | date-time |
Zeitstempel, zu dem die Sammlung zuletzt geändert wurde. |
|
Ist gelöscht
|
is_deleted | boolean |
Gibt an, ob die Auflistung vorläufig gelöscht wurde. |
|
Ist aktiv
|
is_active | boolean |
Gibt an, ob die Auflistung derzeit aktiv ist. |
|
Doc Count
|
doc_count | integer |
Die Dokumentanzahl für den Namespace. Verfügbarmachen als Eigenschaft auf oberster Ebene für den Namespace aus metadata.doc_count |
NamespaceResponse
Vollständige Sammlungsdetails, einschließlich Metadaten, Berechtigungen und Status.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Namespace-ID
|
namespace_id | string |
Eindeutiger Bezeichner für die Sammlung. |
|
Namespace
|
namespace | string |
URL-sicherer Bezeichner, der in API-Aufrufen verwendet wird. |
|
Name
|
name | string |
Anzeigename der Sammlung. |
|
Description
|
description | string |
Lesbare Beschreibung der Sammlung. |
|
Ist fixiert
|
is_frozen | boolean |
Gibt an, ob die Auflistung fixiert ist und nicht geändert werden kann. |
|
Erstellt von
|
created_by | string |
Benutzer-ID des Erstellers der Sammlung. |
|
Ist öffentlich
|
is_public | boolean |
Gibt an, ob die Sammlung öffentlich zugänglich ist. |
|
Benutzer lesen
|
read_users | array of string |
Liste der Benutzer-IDs mit Lesezugriff. |
|
Benutzer schreiben
|
write_users | array of string |
Liste der Benutzer-IDs mit Schreibzugriff. |
|
Gruppen lesen
|
read_groups | array of string |
Liste der Gruppen-IDs mit Lesezugriff. |
|
Schreiben von Gruppen
|
write_groups | array of string |
Liste der Gruppen-IDs mit Schreibzugriff. |
|
Abgelehnte Schreibfreigaben
|
rejected_write_shares | array of string |
Nicht berechtigter Schreibzugriff auf Benutzerfreigaben |
|
Metadata
|
metadata | object |
Zusätzliche Metadaten, die der Auflistung zugeordnet sind. |
|
Version
|
version | string |
API-Version für diese Antwort. |
|
Erstellt am
|
created_at | date-time |
Zeitstempel beim Erstellen der Sammlung. |
|
Geändert am
|
modified_at | date-time |
Zeitstempel, zu dem die Sammlung zuletzt geändert wurde. |
|
Ist gelöscht
|
is_deleted | boolean |
Gibt an, ob die Auflistung vorläufig gelöscht wurde. |
|
Ist aktiv
|
is_active | boolean |
Gibt an, ob die Auflistung derzeit aktiv ist. |
|
Doc Count
|
doc_count | integer |
Anzahl der Dokumente in der Auflistung. |
|
Owner
|
owner | string |
E-Mail des Sammlungsbesitzers. Derzeit der Benutzer, der die Sammlung erstellt hat. |
PaginatedSearchApiResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Totaldocuments
|
totalDocuments | integer |
Die Gesamtzahl der Dokumente, die den Suchkriterien entsprechen. |
|
Documentinfo
|
documentInfo | array of DocumentInfoApiResponse |
Liste der Dokumente auf der aktuellen Seite der Ergebnisse. |
|
Paginierter Schlüssel
|
paginated_key | string |
Undurchsichtiges Paginierungstoken. Übergeben Sie diesen Wert in nachfolgenden Anforderungen, um die nächste oder vorherige Seite abzurufen. |
Ausdauer
Gibt an, ob sich ein Austausch im Datensatz befindet; unknown bedeutet, dass der Commit möglicherweise geschehen ist.
Gibt an, ob sich ein Austausch im Datensatz befindet; unknown bedeutet, dass der Commit möglicherweise geschehen ist.
- Ausdauer
- string
QAInferenceResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Generierter Text
|
generated_text | string |
Die KI-generierte Antwort im Markdown-Format. |
|
Source
|
source | object |
Quelldokumente, auf die in der Antwort verwiesen wird, durch numerische Zitatmarkierungen (z.B., |
|
Stream abgeschlossen
|
stream_complete | boolean |
Gibt an, ob die Streamingantwort abgeschlossen ist. Gilt immer für Nicht-Streaming-Antworten. |
|
Quelloptionen
|
source_options | array of SourceOptions |
Die Antwortquellentypen, die zum Generieren dieser Antwort verwendet wurden. |
|
Anhänge
|
attachments | array of uuid4 |
IDs von LLM-generierten Dateianlagen (z. B. CSV, XLSX, JSON, PDF, Bilder), die die Antwort begleiten. Unterstützte Ausgabetypen umfassen Textformate, Kalkulationstabellen, Dokumente und Bilder. In Multi-Turn-Unterhaltungen werden die neuesten 5 generierten Dateien automatisch an das Modell wiedergegeben. nur Bilder und PDF-Dateien werden aufgrund von EINSCHRÄNKUNGEN der LLM-Dienstinfrastruktur als LLM-Eingabe wiedergegeben. |
|
Zusammenfassung der Begründung
|
reasoning_summary | string |
Eine Zusammenfassung des KI-Begründungsprozesses, der beim Aktivieren des Begründungsmodus enthalten ist. |
|
ResponseEvent
|
response_event | ResponseEvent | |
|
AnswerUpdate
|
answer_update | AnswerUpdate |
Ein Vorgang auf der Antwort, die ein Streamingclient anzeigt: Anfügen, Abschließen oder Fehlschlagen.
|
|
AnswerOutcome
|
answer_outcome | AnswerOutcome |
Das Ergebnis einer Antwort: keine, vollständig oder unvollständig mit dem Code der Ausschneidung. |
ResponseEvent
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Typ
|
type | string |
Dot-namespaced-Ereignisbezeichner nach dem Muster |
|
Meldung
|
message | string |
Benutzerorientierter Statustext, der den aktuellen Verarbeitungsschritt beschreibt. |
|
Meta
|
meta | object |
Strukturierte Metadaten für das Ereignis. Allgemeine Felder: |
|
Erstellt am
|
created_at | string |
ISO 8601 UTC-Zeitstempel des Zeitpunkts der Erstellung dieses Ereignisses. |
SourceOptions
- SourceOptions
- string
Status
- Status
- string
SummaryzationResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Zusammenfassung
|
summary | string |
Die KI-generierte Dokumentzusammenfassung im Markdown-Format. |
|
Source
|
source | object |
Quelldokumente, die verwendet werden, um die Zusammenfassung zu erstellen, die durch numerische Zitatmarkierung schlüsselt. |
UploadDocumentResponse
Antwort, die für jedes hochgeladene Dokument zurückgegeben wurde.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzer-ID
|
user_id | string |
ID des Benutzers, der das Dokument hochgeladen hat. |
|
Dokument-ID
|
document_id | string |
Eindeutiger Bezeichner, der dem hochgeladenen Dokument zugewiesen ist. |
|
Dokumentname
|
document_name | string |
Originaldateiname des hochgeladenen Dokuments. |
|
Dokumentnamespace
|
document_namespace | string |
Namespace (Sammlungsbezeichner), zu dem das Dokument gehört. |
|
Dokumentnamespace-ID
|
document_namespace_id | string |
UUID der Sammlung, zu der das Dokument gehört. |
|
Status
|
status | string |
Verarbeitungsstatus des hochgeladenen Dokuments. |
|
Inhaltstyp
|
content_type | string |
MIME-Typ des hochgeladenen Dokuments. |
binary
Dies ist der grundlegende Datentyp "binary".