Baza wiedzy Adobe Acrobat (wersja zapoznawcza)

Baza wiedzy w programie Adobe Acrobat Studio umożliwia użytkownikom konwersacyjny dostęp do wiedzy, która znajduje się w dużych, wyselekcjonowanych kolekcjach dokumentów, w wielu zestawach pytań i odpowiedzi, podsumowaniach, wyodrębnieniu i wyszukiwaniu. Umożliwia korzystanie z funkcji bazy wiedzy w aplikacjach i przepływach pracy, w których pracujesz, aby połączyć wiedzę przechowywaną w SharePoint i innych obsługiwanych repozytoriach oraz zatwierdzeniach zasilania, powiadomieniach, tworzeniu zawartości i procesach biznesowych.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa	Class	Regions
Copilot Studio	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Logic Apps	Standard	Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD)
Power Apps	Premium	Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)
Power Automate - narzędzie do automatyzacji procesów	Premium	Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD)

Kontakt biznesowy
Name	Adobe
adres URL	https://www.adobe.com

Metadane łącznika
Publisher	ADOBE INC.
Witryna internetowa	https://business.adobe.com/products/acrobat-business/knowledge-base.html
Zasady ochrony prywatności	https://www.adobe.com/go/privacy_policy
Kategorie	Produktywność

Baza wiedzy w programie Acrobat

Wydawca: Adobe, Inc.

Prerequisites

Wymagane jest konto Adobe z dostępem do bazy wiedzy w programie Acrobat.

Jak uzyskać poświadczenia

Zaloguj się przy użyciu identyfikatora Adobe ID podczas tworzenia połączenia. Ten łącznik uwierzytelnia się w programie Adobe Identity Management System (IMS) przy użyciu protokołu OAuth 2.0; Nastąpi przekierowanie do strony logowania adobe i prośba o wyrażenie zgody na żądane uprawnienia przed utworzeniem połączenia.

Wprowadzenie do łącznika

N/A

Znane problemy i ograniczenia

N/A

Typowe błędy i środki zaradcze

N/A

Często zadawane pytania

N/A

Akcje

Aktualizowanie kolekcji	Zaktualizuj wszystkie właściwości istniejącej kolekcji.
Listy kolekcji	Wyświetl listę kolekcji, do których użytkownik może uzyskać dostęp.
Pobieranie pliku dokumentu	Pobierz metadane i zawartość pojedynczego dokumentu według identyfikatora UUID.
Pobieranie pliku załącznika	Pobierz zawartość pliku załącznika za pomocą identyfikatora UUID.
Pobieranie stanu dokumentu	Pobierz stan indeksowania pojedynczego dokumentu według identyfikatora UUID.
Pobieranie załącznika	Pobierz pojedynczy załącznik według identyfikatora UUID.
Pobierz kolekcję	Pobierz pojedynczą kolekcję według identyfikatora UUID.
Podsumowywanie dokumentów	Wygeneruj podsumowanie co najmniej jednego dokumentu w kolekcji.
Przekaż dokumenty	Przekaż co najmniej jeden dokument do kolekcji na potrzeby indeksowania.
Przekaż załączniki	Przekaż co najmniej jeden załącznik.
Tworzenie kolekcji	Utwórz kolekcję (przestrzeń nazw, która grupuje dokumenty i kontroluje dostęp).
Usuwanie dokumentów	Usuń co najmniej jeden dokument z kolekcji według identyfikatorów UUID.
Usuwanie kolekcji	Usuń kolekcję i wszystkie jej dokumenty.
Usuń załącznik	Usuń pojedynczy załącznik według identyfikatora UUID.
Wyszukiwanie dokumentów (podzielonych na strony)	Wyszukiwanie między dokumentami w kolekcji przy użyciu wyników sklasyfikowanych na strony.
Wyświetlanie listy dokumentów	Wyświetl listę dokumentów w kolekcji.
Wyświetlanie listy załączników	Wyświetlanie listy załączników.
Zadaj pytanie	Zadaj pytanie w języku naturalnym w kolekcji i uzyskaj odpowiedź z cytatami.

Aktualizowanie kolekcji

Identyfikator operacji:: UpdateCollectionById

Zaktualizuj wszystkie właściwości istniejącej kolekcji.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator kolekcji	collection_id	True	uuid4	Unikatowy identyfikator kolekcji
Name	name	True	string	Nazwa wyświetlana kolekcji. Wymagana, maksymalna długość 100 znaków
Description	description		string	Opcjonalny opis kolekcji. Wartości domyślne do pustego ciągu, maksymalna długość 500 znaków
Jest publiczny	is_public		boolean	Czy kolekcja jest publicznie dostępna.
Jest zamrożona	is_frozen		boolean	Czy kolekcja jest zamrożona i nie można jej modyfikować.
Odczytywanie użytkowników	read_users		array of string	Lista identyfikatorów użytkowników z dostępem do odczytu do kolekcji.
Pisanie użytkowników	write_users		array of string	Lista identyfikatorów użytkowników z dostępem do zapisu do kolekcji.
Odczytywanie grup	read_groups		array of string	Lista identyfikatorów grup (UUID) z dostępem do odczytu do kolekcji.
Pisanie grup	write_groups		array of string	Lista identyfikatorów grup (UUID) z dostępem do zapisu do kolekcji.
Metadata	metadata		object	Opcjonalne metadane skojarzone z kolekcją. Maksymalna długość 1000 znaków
Identyfikator przestrzeni nazw	namespace_id		string	Identyfikator UUID kolekcji do zaktualizowania.

Zwraca

Pełne szczegóły kolekcji, w tym metadane, uprawnienia i stan.

Przestrzeń nazwResponse: NamespaceResponse

Listy kolekcji

Identyfikator operacji:: ListCollections

Wyświetl listę kolekcji, do których użytkownik może uzyskać dostęp.

Parametry

Nazwisko Klucz Wymagane Typ Opis

Strona

page

integer

Numer strony (oparty na 1)

Rozmiar strony

page_size

integer

Liczba elementów na stronę (1–100)

Zamów według

order_by

string

Pole do sortowania wyników według.

Value	Sortuje według
`name`	Nazwa wyświetlana kolekcji (wartość domyślna)
`created_at`	Sygnatura czasowa tworzenia
`modified_at`	Sygnatura czasowa ostatniej modyfikacji

Rosnąco

asc

boolean

Sortuj w kolejności rosnącej, jeśli true, malejąco, jeśli false.

Nazwa zawiera

infix

string

Wyszukaj termin nazwy kolekcji (dopasowanie częściowe bez uwzględniania wielkości liter).

Filter

filter_constraint

string

Filtrowanie kolekcji według własności lub zakresu.

Value	Returns
`created_by:me`	Utworzone kolekcje
`shared_by:me`	Kolekcje udostępnione innym osobom
`shared_by:others`	Kolekcje udostępnione Tobie przez inne osoby
`scope:org`	Wszystkie kolekcje w organizacji (tylko administrator organizacji)
`scope:system`	Wszystkie kolekcje we wszystkich organizacjach (tylko administrator systemu)

Zwraca

KolekcjaStrona: CollectionPage

Pobieranie pliku dokumentu

Identyfikator operacji:: GetDocument

Pobierz metadane i zawartość pojedynczego dokumentu według identyfikatora UUID.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator dokumentu	document_id	True	uuid	Identyfikator UUID dokumentu
Nazwa pliku artefaktu	filename		string	Określony przechowywany artefakt do pobrania. W przypadku pominięcia zostanie zwrócone bieżące odwzorowanie dokumentu.

Zwraca

response: binary

Pobieranie pliku załącznika

Identyfikator operacji:: GetAttachmentFile

Pobierz zawartość pliku załącznika za pomocą identyfikatora UUID.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator załącznika	attachment_id	True	uuid	Identyfikator UUID załącznika

Pobieranie stanu dokumentu

Identyfikator operacji:: GetDocumentStatus

Pobierz stan indeksowania pojedynczego dokumentu według identyfikatora UUID.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator dokumentu	document_id	True	uuid	Identyfikator UUID dokumentu

Zwraca

Informacje o dokumencie: DocumentInfoApiResponse

Pobieranie załącznika

Identyfikator operacji:: GetAttachment

Pobierz pojedynczy załącznik według identyfikatora UUID.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator załącznika	attachment_id	True	uuid	Identyfikator UUID załącznika

Zwraca

AttachmentResponse: AttachmentResponse

Pobierz kolekcję

Identyfikator operacji:: GetCollection

Pobierz pojedynczą kolekcję według identyfikatora UUID.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator kolekcji	collection_id	True	string	Unikatowy identyfikator kolekcji

Zwraca

Pełne szczegóły kolekcji, w tym metadane, uprawnienia i stan.

Przestrzeń nazwResponse: NamespaceResponse

Podsumowywanie dokumentów

Identyfikator operacji:: SummarizeDocuments

Wygeneruj podsumowanie co najmniej jednego dokumentu w kolekcji.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikatory dokumentów	document_ids	True	array of string	Identyfikatory UUID określonych dokumentów do podsumowania. Maksymalnie 10 dokumentów na żądanie.
Przestrzeń nazw dokumentu	document_namespace	True	string	Przestrzeń nazw kolekcji zawierająca dokumenty.

Zwraca

Dokumenty podsumowania odpowiedzi: array of SummarizationResponse

Przekaż dokumenty

Identyfikator operacji:: UploadDocuments

Przekaż co najmniej jeden dokument do kolekcji na potrzeby indeksowania.

Parametry

Nazwisko Klucz Wymagane Typ Opis

Identyfikator kolekcji

collection_id

True

uuid4

Unikatowy identyfikator kolekcji

Obsługa duplikatów

option

string

Strategia obsługi duplikatów.

Value	Behavior
`FILE_NAME`	Zastąp dowolny istniejący dokument tą samą nazwą pliku
`FILE_CHECKSUM`	Zastąp plik tylko wtedy, gdy nazwa pliku jest zgodna, ale skrót zawartości (MD5) jest inny.
`SKIP_DUPLICATES`	Dyskretne pomijanie już istniejących plików (według sumy kontrolnej)
`REJECT_REQUEST_ON_DUPLICATE`	Zwraca błąd 400, jeśli wykryto duplikat
(pominięto)	Zezwalaj na zduplikowane przekazywanie

Tryb OCR

ocr

string

Tryb przetwarzania OCR dla dokumentów PDF i obrazów. Przekazywanie obrazów zawsze wymaga OCR.

Value	Behavior
`AUTO`	Zastosuj OCR w razie potrzeby; Przekazywanie obrazów jest zawsze przetwarzane (ustawienie domyślne)
`FORCE`	Zawsze rasteryzuj i przetwarzaj OCR na każdej stronie
`NONE`	Pomiń OCR dla dokumentów niezwiązanych z obrazami; Przekazywanie obrazów jest nadal przetwarzane
`REJECT_BAD`	Automatycznie zastosuj funkcję OCR i odrzuć strony, które nie sprawdzają jakości

Wyodrębnianie ukrytych arkuszy

hidden_sheets

string

Steruje trybem wyodrębniania ukrytych arkuszy dla dokumentów Excel.

Value	Behavior
`ALL`	wyodrębnianie wszystkich arkuszy, w tym ukrytych i bardzo ukrytych arkuszy (ustawienie domyślne)
`NONE`	wyodrębnianie tylko widocznych arkuszy
`HIDDEN`	wyodrębnianie widocznych i ukrytych arkuszy
`VERY_HIDDEN`	wyodrębnianie widocznych i bardzo ukrytych arkuszy

Plik do przekazania

documents

True

file

Co najmniej jeden plik do przekazania. Obsługiwane formaty: PDF, DOC/DOCX, DOT/DOTX, TXT, RTF, XLSM/XLSM/XLSX, PPT/PPTX, ODP, ODT, CSV, EML, JSON, MD, HTML, JPEG, PNG, TIFF, GIF, WebP i BMP.

Tagi dokumentów

document_tags

string

Tablica JSON tagów klucz-wartość do dołączenia do wszystkich przekazanych dokumentów. Każdy tag musi mieć key znaki (1–127 znaków, małe litery alfanumeryczne i łączniki) i value (1–256 znaków).

Linki źródłowe HTML

html_links

string

Obiekt JSON mapuje nazwy plików HTML na ich oryginalne adresy URL źródłowe. Dotyczy tylko przekazanych plików HTML. Klucz jest nazwą pliku HTML w przekazaniu, a wartość to oryginalny adres URL, z którego został zapisany.

Zwraca

Przekazywanie odpowiedzidokumentów: array of UploadDocumentResponse

Przekaż załączniki

Identyfikator operacji:: UploadAttachments

Przekaż co najmniej jeden załącznik.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Plik do przekazania	documents	True	file	1–10 obrazów lub plików. Obrazy: image/jpeg, image/png, image/jpg, image/webp, image/gif - ≤10 MB każdy. Pliki: application/pdf — ≤8 MB każdy

Zwraca

Odpowiedź interfejsu API dla przekazywania wsadowego załącznika w wersji 2.

AttachmentUploadsResponse: AttachmentUploadsResponse

Tworzenie kolekcji

Identyfikator operacji:: CreateCollection

Utwórz kolekcję (przestrzeń nazw, która grupuje dokumenty i kontroluje dostęp).

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Name	name	True	string	Nazwa wyświetlana kolekcji. Wymagana, maksymalna długość 100 znaków
Description	description		string	Opcjonalny opis kolekcji. Wartości domyślne do pustego ciągu, maksymalna długość 500 znaków
Jest publiczny	is_public		boolean	Czy kolekcja jest publicznie dostępna.
Jest zamrożona	is_frozen		boolean	Czy kolekcja jest zamrożona i nie można jej modyfikować.
Odczytywanie użytkowników	read_users		array of string	Lista identyfikatorów użytkowników z dostępem do odczytu do kolekcji.
Pisanie użytkowników	write_users		array of string	Lista identyfikatorów użytkowników z dostępem do zapisu do kolekcji.
Odczytywanie grup	read_groups		array of string	Lista identyfikatorów grup (UUID) z dostępem do odczytu do kolekcji.
Pisanie grup	write_groups		array of string	Lista identyfikatorów grup (UUID) z dostępem do zapisu do kolekcji.
Metadata	metadata		object	Opcjonalne metadane skojarzone z kolekcją. Maksymalna długość 1000 znaków

Zwraca

Pełne szczegóły kolekcji, w tym metadane, uprawnienia i stan.

Przestrzeń nazwResponse: NamespaceResponse

Usuwanie dokumentów

Identyfikator operacji:: DeleteDocuments

Usuń co najmniej jeden dokument z kolekcji według identyfikatorów UUID.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikatory dokumentów	document_ids		array of uuid4	Lista identyfikatorów UUID dokumentu do usunięcia.
Identyfikator kolekcji	collection_id		string	UUID kolekcji zawierającej dokumenty.

Zwraca

DeleteDocumentResponse: DeleteDocumentResponse

Usuwanie kolekcji

Identyfikator operacji:: DeleteCollection

Usuń kolekcję i wszystkie jej dokumenty.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator kolekcji	collection_id	True	uuid4	Unikatowy identyfikator kolekcji

Zwraca

Pełne szczegóły kolekcji, w tym metadane, uprawnienia i stan.

Przestrzeń nazwResponse: NamespaceResponse

Usuń załącznik

Identyfikator operacji:: DeleteAttachment

Usuń pojedynczy załącznik według identyfikatora UUID.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator załącznika	attachment_id	True	uuid	Identyfikator UUID załącznika

Wyszukiwanie dokumentów (podzielonych na strony)

Identyfikator operacji:: SearchDocumentsPaginated

Wyszukiwanie między dokumentami w kolekcji przy użyciu wyników sklasyfikowanych na strony.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Przestrzeń nazw dokumentu	document_namespace	True	string	Nazwa kolekcji dokumentów do wyszukania.
Filtruj według	filter_by	True	string	Zapytanie wyszukiwania słów kluczowych w celu filtrowania dokumentów według zawartości lub metadanych.
Identyfikatory dokumentów	document_ids		array of string	Lista określonych identyfikatorów dokumentów, do których ma być ograniczona funkcja wyszukiwania. Maksymalnie 1000 identyfikatorów dokumentów.
Key	key	True	string	Identyfikator tagu. Tylko znaki alfanumeryczne i łączniki.
Value	value	True	string	Wartość tagu. Tylko znaki alfanumeryczne i łączniki.
Rozmiar strony	page_size		integer	Liczba wyników do zwrócenia na stronę. Wyszukiwanie niezwiązane z podziałem na strony zawsze zwraca page_size 10000.
Sortuj według	order_by		string	Pole do sortowania wyników według.
Asc	asc		boolean	Kolejność sortowania: prawda dla rosnąco, Fałsz dla malejących.
Kolejność stronicowania	pagination_order		string	Określa, czy uzyskać następną, czy poprzednią stronę wyników.
Klucz podzielony na strony	paginated_key		string	Klucz używany do stronicowania.

Zwraca

PaginatedSearchApiResponse: PaginatedSearchApiResponse

Wyświetlanie listy dokumentów

Identyfikator operacji:: ListDocuments

Wyświetl listę dokumentów w kolekcji.

Parametry

Nazwisko Klucz Wymagane Typ Opis

Identyfikator kolekcji

collection_id

True

string

Unikatowy identyfikator kolekcji

Strona

page

integer

Numer strony (oparty na 1)

Rozmiar strony

page_size

integer

Liczba elementów na stronę (1–100)

Zamów według

order_by

string

Pole do sortowania wyników według.

Value	Sortuje według
`document_name`	Nazwa pliku dokumentu (wartość domyślna)
`updated_at`	Sygnatura czasowa ostatniej modyfikacji
`upload_status`	Stan przetwarzania
`uploaded_at`	Sygnatura czasowa przekazywania
`uploaded_by`	Uploader

Rosnąco

asc

boolean

Sortuj w kolejności rosnącej, jeśli true, malejąco, jeśli false.

Nazwa zawiera

infix

string

Wyszukiwany termin dla nazwy dokumentu (dopasowanie częściowe bez uwzględniania wielkości liter).

Typ źródła

source_type

string

Ogranicz wyniki do dokumentów przy użyciu tego źródła źródłowego. Dokumenty bez metadanych źródłowych są wykluczane po ustawieniu tego filtru.

Zwraca

InfoPageApiResponse: InfoPageApiResponse

Wyświetlanie listy załączników

Identyfikator operacji:: ListAttachments

Wyświetlanie listy załączników.

Zwraca

Lista odpowiedzittachments: array of AttachmentResponse

Zadaj pytanie

Identyfikator operacji:: CreateQuestionAnswer

Zadaj pytanie w języku naturalnym w kolekcji i uzyskaj odpowiedź z cytatami.

Parametry

Nazwisko	Klucz	Wymagane	Typ	Opis
Identyfikator żądania	request_id		string	Unikatowy identyfikator tego żądania używany do śledzenia w historii czatów.
Identyfikatory dokumentów	document_ids		array of string	Identyfikatory UUID określonych dokumentów w celu ograniczenia wyszukiwania do. Gdy są puste, przeszukiwane są wszystkie dokumenty w określonych kolekcjach.
Collections	collections		array of string	Przestrzenie nazw kolekcji do wyszukiwania. Co najmniej jeden jest wymagany dla źródła KOLEKCJI.
Inputs	inputs		string	Pytanie lub monit o udzielenie odpowiedzi. Obsługuje zapytania języka naturalnego.
Format	format		string
Rozwlekłość	style		string
Ton	tone		string
Reasoning	reasoning		string
Instrukcje niestandardowe	custom_instructions		string	Instrukcje dotyczące wolnego tekstu w celu dalszego dostosowywania zachowania odpowiedzi sztucznej inteligencji.
SourceOptions	Source Options		string
Tryb wnioskowania	inference_mode		string	Warstwa modelu sztucznej inteligencji do użycia. Opcje: `STANDARD` (zrównoważona szybkość i jakość), `FAST_REASONING` (zoptymalizowana pod kątem szybkości z rozumowaniem), (najwyższa jakość), `ADVANCEDLITE` (szybki, niższy koszt — tylko `NANO` kolekcja), (najszybszy, najniższy koszt, tylko bez kolekcji). W tym przypadku `inference_type=AGENTIC` warstwa agenta, który zapisuje odpowiedź, może działać w szybszej warstwie wybranej przez usługę.
Strategia wykonywania	inference_type		string	Strategia wykonywania wnioskowania odpowiedzi na pytania. Ortogonal to InferenceMode (warstwa modelu): AGENTIC wybiera pętlę agenta z wieloma iteracjami— DOMYŚLNa klasyczna ścieżka RAG z pojedynczym wnioskowaniem. Brak braku przymusu — nieznane wartości muszą zakończyć się niepowodzeniem.
Key	key	True	string	Identyfikator tagu. Tylko znaki alfanumeryczne i łączniki.
Value	value	True	string	Wartość tagu. Tylko znaki alfanumeryczne i łączniki.
Identyfikatory załączników	attachment_ids		array of uuid4	Identyfikatory wcześniej przekazanych załączników plików do uwzględnienia jako kontekstu wizualnego. Maksymalnie 15 na żądanie. Zaakceptowane typy danych wejściowych: obrazy (JPEG, PNG, GIF, WebP) i PDF. Inne typy plików są odrzucane podczas przekazywania. W wielu konwersacjach najnowsze 5 plików generowanych przez llm są automatycznie odtwarzane jako kontekst; tylko obrazy i pliki PDF są odtwarzane z powodu ograniczeń infrastruktury usługi LLM.
Tryb generowania plików	file_generation		string
Identyfikator połączenia	connection_id		string	Identyfikator połączenia Office 365 do użycia. Wymagane tylko dla źródła OFFICE365. W przypadku pominięcia zostanie użyte pierwsze zgodne połączenie.
Strefa czasowa	time_zone		string	Identyfikator strefy czasowej IANA dla zapytań obsługujących datę (np. `America/Los_Angeles`, `UTC`).
Włącz rysunki	enable_figures		boolean	Gdy wartość true, pobrane dane dokumentu (wykresy, obrazy) są dołączane jako kontekst wizualny. Maksymalnie 8 liczb (maksymalnie 4 na dokument).
Store	store		boolean	Jeśli to prawda, konwersacja jest utrwalana w historii czatów, co umożliwia wykonywanie kolejnych czynności. Ustaw wartość false dla bezstanowych zapytań jednorazowych.
Pole autorstwa	Include		string	Pola z tabeli DocumentInfo kwalifikują się do dołączeń w odpowiedziach źródłowych. Każda wartość jest ścieżką notacji kropkowej zakorzenionej w dokumencie DocumentInfo. Każda ścieżka musi być rozpoznawana jako pole z adnotacjami z wartością attribution_eligible = True.
BoundCoordinateFormat	bound_coordinate_format		string
Enabled	enabled		boolean	Włącz zdarzenia postępu podczas przesyłania strumieniowego.
ResponseEventDetail	detail		string
Aktualizacje odpowiedzi	answer_updates		boolean	Przesyłaj strumieniowo odpowiedź agenta, ponieważ ramki niosące answer_update (dołączanie, a następnie kończenie lub niepowodzenie) zamiast jednej ostatniej ramki. Klient musi zastosować te operacje. Ignorowane w przypadku żądań nieprzesyłania strumieniowego i nie agenta.
identyfikator Exchange	exchange_id		string	Identyfikator klienta tej wymiany w ramach konwersacji. Przechowywane z wymianą i zwracane w historii czatu, więc klient może uzgodnić jego lokalny zwrot z rekordem: to samo pytanie zadane dwa razy daje dwie wymiany, a tylko identyfikator mówi im od siebie.

Zwraca

QAInferenceResponse: QAInferenceResponse

Definicje

AnswerOutcome

Wynik jednej odpowiedzi: brak, ukończenie lub niekompletne z kodem tego, co go wyciąć.

Nazwisko	Ścieżka	Typ	Opis
Status	status	string	Czy istnieje odpowiedź i czy jej generacja została zakończona.
Powód	reason	string	Kod przerwania, gdy jest niekompletny, kod błędu, jeśli nie; nigdy nie ustawia się po zakończeniu.

AnswerUpdate

Jedna operacja na odpowiedzi klienta przesyłania strumieniowego pokazuje: dołączanie, ukończenie lub niepowodzenie.

complete jest niekompletna, gdy reason jest ustawiona; fail zawiera kod błędu i nigdy nie wycofuje wyświetlanego tekstu.

Nazwisko	Ścieżka	Typ	Opis
Operation	operation	string
Powód	reason	string	Tylko terminal: kod przerwania po zakończeniu (np. response_truncated_deadline), kod błędu po awarii (np. budget_exhausted, save_failed).
Wytrwałość	persistence	Persistence	Czy wymiana jest w rekordzie; `unknown` oznacza, że mogło się zdarzyć zatwierdzenie.

AttachmentErrorCode

Kody błędów dotyczące przekazywania nieudanych załączników.

AttachmentErrorCode: string

AttachmentResponse

Nazwisko	Ścieżka	Typ	Opis
Identyfikator załącznika	attachment_id	string
Nazwa załącznika	attachment_name	string
Typ mime załącznika	attachment_mime_type	string	Typ MIME obrazu (np. image/png)
Suma kontrolna załącznika	attachment_checksum	string	Md5 suma kontrolna bajtów obrazu
Rozmiar załącznika	attachment_size	integer	Rozmiar obrazu w bajtach
Stan załącznika	attachment_status	string

AttachmentUploadError

Szczegóły błędu możliwego do odczytu maszyny w przypadku przekazywania pojedynczego załącznika.

Nazwisko	Ścieżka	Typ	Opis
AttachmentErrorCode	code	AttachmentErrorCode	Kody błędów dotyczące przekazywania nieudanych załączników.
Message	message	string
Size	size	integer
Typ mime	mime_type	string

AttachmentUploadItem

Ujednolicony wynik na plik w odpowiedzi przekazywania załącznika w wersji 2.

Nazwisko	Ścieżka	Typ	Opis
Nazwa pliku	filename	string
AttachmentUploadItemStatus	status	AttachmentUploadItemStatus	Stan poszczególnych plików dla odpowiedzi przekazywania wsadowego załącznika w wersji 2.
Kod stanu	status_code	integer
AttachmentResponse	attachment	AttachmentResponse
AttachmentUploadError	error	AttachmentUploadError	Szczegóły błędu możliwego do odczytu maszyny w przypadku przekazywania pojedynczego załącznika.

AttachmentUploadItemStatus

Stan poszczególnych plików dla odpowiedzi przekazywania wsadowego załącznika w wersji 2.

AttachmentUploadItemStatus: string

AttachmentUploadsResponse

Odpowiedź interfejsu API dla przekazywania wsadowego załącznika w wersji 2.

Nazwisko	Ścieżka	Typ	Opis
Przesłane	uploads	array of AttachmentUploadItem

KolekcjaStrona

Nazwisko	Ścieżka	Typ	Opis
Strona	page	integer	Bieżący numer strony (oparty na 1).
Size	size	integer	Liczba elementów na stronie.
Total	total	integer	Łączna liczba kolekcji pasujących do zapytania.
Sortuj według	order_by	string	Pole używane do sortowania wyników.
Asc	asc	boolean	Czy wyniki są sortowane w kolejności rosnącej.
Strony	pages	array of Namespace	Lista kolekcji na bieżącej stronie.

DeleteDocumentResponse

Nazwisko	Ścieżka	Typ	Opis
Szczegóły	details	array of DocumentDeletionStatus	Wyniki usuwania poszczególnych dokumentów.

DocumentDeletionStatus

Nazwisko	Ścieżka	Typ	Opis
Identyfikator dokumentu	document_id	string	Identyfikator UUID dokumentu.
Status	status	Status
Message	message	string	Czytelny dla człowieka komunikat opisujący wynik.

DocumentInfoApiResponse

Nazwisko Ścieżka Typ Opis

Identyfikator dokumentu

document_id

string

Identyfikator UUID dokumentu.

Nazwa dokumentu

document_name

string

Nazwa wyświetlana dokumentu (zazwyczaj oryginalna nazwa pliku).

Ścieżka dokumentu

document_path

string

Ścieżka magazynu dokumentu w systemie.

Przestrzeń nazw dokumentu

document_namespace

string

Przestrzeń nazw kolekcji, do którego należy ten dokument.

Identyfikator przestrzeni nazw dokumentu

document_namespace_id

string

UUID kolekcji, do którego należy dokument.

Opis dokumentu

document_description

string

Podany przez użytkownika opis dokumentu.

Przekazane przez

uploaded_by

string

Adres e-mail osoby, która wysłała dokument. Wartość null, gdy nie jest dostępna żadna wiadomość e-mail przekazującego.

Stan przekazywania

upload_status

string

Bieżący stan przekazywania/przetwarzania.

Value	Meaning
`UPLOADED`	Odebrano plik, oczekiwanie na przetwarzanie
`IN_PROGRESS`	Rozpoczęto przetwarzanie
`CONVERTING`	Konwertowanie na format indeksowalny
`INDEXING`	Kompilowanie indeksu wyszukiwania
`COMPLETE`	Gotowe do obsługi zapytań
`FAILED`	Przetwarzanie nie powiodło się

Suma kontrolna

checksum

string

Sha-256 suma kontrolna pliku dokumentu na potrzeby weryfikacji integralności.

Typ mime

mime_type

string

Typ MIME oryginalnego dokumentu źródłowego.

Typ mime odwzorowania

rendition_mime_type

string

Typ MIME odwzorowania klienta; źródła zewnętrzne używają elementu text/uri-list.

Typ źródła

source_type

string

Źródło źródłowe tego dokumentu: SHAREPOINT, , SHAREPOINT_SITEGOOGLE_DRIVElub UPLOAD. null dla dokumentów bez metadanych źródłowych.

DocumentStatus

status

DocumentStatus

Przekazano o

uploaded_at

date-time

Sygnatura czasowa przekazywania dokumentu (format ISO 8601).

Zaktualizowano:

updated_at

date-time

Sygnatura czasowa ostatniej aktualizacji rekordu dokumentu, jeśli istnieje.

Jest usuwany

is_deleted

boolean

Czy dokument został usunięty nietrwale.

DocumentMetadata

document_metadata

DocumentMetadata

Nazwisko	Ścieżka	Typ
Uprawnienia	permissions
Tagi dokumentów	document_tags	array of DocumentTag
Metadane źródłowe	source_metadata
IngestionMetadata	ingestion_metadata	IngestionMetadata

DocumentStatus

Nazwisko	Ścieżka	Typ	Opis
Status	status	string
Kod błędu	error_code	string

DocumentTag

Nazwisko	Ścieżka	Typ	Opis
Key	key	string	Identyfikator tagu. Tylko znaki alfanumeryczne i łączniki.
Value	value	string	Wartość tagu. Tylko znaki alfanumeryczne i łączniki.

InfoPageApiResponse

Nazwisko	Ścieżka	Typ	Opis
Strona	page	integer	Bieżący numer strony (oparty na 1).
Size	size	integer	Liczba elementów na stronie.
Total	total	integer	Łączna liczba dokumentów pasujących do zapytania.
Sortuj według	order_by	string	Pole używane do sortowania wyników.
Asc	asc	boolean	Czy wyniki są sortowane w kolejności rosnącej.
Strony	pages	array of DocumentInfoApiResponse	Lista dokumentów na bieżącej stronie.

IngestionMetadata

Nazwisko	Ścieżka	Typ
Współczynnik ufności	confidence_score	number
Ocr	ocr	boolean
Nieprawidłowe znaki	bad_characters	boolean
Odnalezione ukryte arkusze	found_hidden_sheets	boolean
Znaleziono bardzo ukryte arkusze	found_very_hidden_sheets	boolean
Odnaleziono chronione ukryte arkusze	found_protected_hidden_sheets	boolean
Włączone ukryte arkusze	enabled_hidden_sheets	boolean
Włączone bardzo ukryte arkusze	enabled_very_hidden_sheets	boolean
Data utworzenia dokumentu	document_created_date	date-time

Namespace

Nazwisko	Ścieżka	Typ	Opis
Namespace	namespace	string	Unikatowy identyfikator kolekcji. Wartość domyślna to UUID. Użyj go jako identyfikatora zewnętrznego.
Name	name	string	Opcjonalna nazwa wyświetlana kolekcji. Wymagane, jeśli "przestrzeń nazw" nie jest podana.
Description	description	string	Czytelny dla człowieka opis kolekcji.
Jest zamrożona	is_frozen	boolean	Czy kolekcja jest zamrożona i nie można jej modyfikować.
Stworzone przez	created_by	string	Adres e-mail lub identyfikator twórcy kolekcji.
Utworzone przez identyfikator użytkownika	created_by_user_id	string	Identyfikator użytkownika twórcy kolekcji.
Jest publiczny	is_public	boolean	Czy kolekcja jest publicznie dostępna.
Odczytywanie użytkowników	read_users	array of string	Lista identyfikatorów użytkowników z dostępem do odczytu.
Pisanie użytkowników	write_users	array of string	Lista identyfikatorów użytkowników z dostępem do zapisu.
Odczytywanie grup	read_groups	array of string	Lista identyfikatorów grup z dostępem do odczytu.
Pisanie grup	write_groups	array of string	Lista identyfikatorów grup z dostępem do zapisu.
Metadata	metadata	object	Dodatkowe metadane skojarzone z kolekcją.
Wersja	version	string	Wersja interfejsu API kolekcji.
Identyfikator przestrzeni nazw	namespace_id	string	Unikatowy identyfikator kolekcji.
Data utworzenia	created_at	date-time	Sygnatura czasowa utworzenia kolekcji.
Zmodyfikowano o	modified_at	date-time	Sygnatura czasowa ostatniej modyfikacji kolekcji.
Jest usuwany	is_deleted	boolean	Czy kolekcja została usunięta nietrwale.
Jest aktywny	is_active	boolean	Czy kolekcja jest obecnie aktywna.
Liczba dokumentów	doc_count	integer	Liczba dokumentów dla przestrzeni nazw. Uwidaczniaj jako właściwość najwyższego poziomu dla przestrzeni nazw z metadata.doc_count

Przestrzeń nazwResponse

Pełne szczegóły kolekcji, w tym metadane, uprawnienia i stan.

Nazwisko	Ścieżka	Typ	Opis
Identyfikator przestrzeni nazw	namespace_id	string	Unikatowy identyfikator kolekcji.
Namespace	namespace	string	Bezpieczny identyfikator adresu URL używany w wywołaniach interfejsu API.
Name	name	string	Nazwa wyświetlana kolekcji.
Description	description	string	Czytelny dla człowieka opis kolekcji.
Jest zamrożona	is_frozen	boolean	Czy kolekcja jest zamrożona i nie można jej modyfikować.
Stworzone przez	created_by	string	Identyfikator użytkownika twórcy kolekcji.
Jest publiczny	is_public	boolean	Czy kolekcja jest publicznie dostępna.
Odczytywanie użytkowników	read_users	array of string	Lista identyfikatorów użytkowników z dostępem do odczytu.
Pisanie użytkowników	write_users	array of string	Lista identyfikatorów użytkowników z dostępem do zapisu.
Odczytywanie grup	read_groups	array of string	Lista identyfikatorów grup z dostępem do odczytu.
Pisanie grup	write_groups	array of string	Lista identyfikatorów grup z dostępem do zapisu.
Odrzucone udziały zapisu	rejected_write_shares	array of string	Użytkownicy niebędący uprawnionymi do zapisu
Metadata	metadata	object	Dodatkowe metadane skojarzone z kolekcją.
Wersja	version	string	Wersja interfejsu API dla tej odpowiedzi.
Data utworzenia	created_at	date-time	Sygnatura czasowa utworzenia kolekcji.
Zmodyfikowano o	modified_at	date-time	Sygnatura czasowa ostatniej modyfikacji kolekcji.
Jest usuwany	is_deleted	boolean	Czy kolekcja została usunięta nietrwale.
Jest aktywny	is_active	boolean	Czy kolekcja jest obecnie aktywna.
Liczba dokumentów	doc_count	integer	Liczba dokumentów w kolekcji.
Właściciel	owner	string	Adres e-mail właściciela kolekcji. Obecnie użytkownik, który utworzył kolekcję.

PaginatedSearchApiResponse

Nazwisko	Ścieżka	Typ	Opis
Totaldocuments	totalDocuments	integer	Łączna liczba dokumentów spełniających kryteria wyszukiwania.
Informacje o dokumencie	documentInfo	array of DocumentInfoApiResponse	Lista dokumentów na bieżącej stronie wyników.
Klucz podzielony na strony	paginated_key	string	Nieprzezroczystym tokenem stronicowania. Przekaż tę wartość w kolejnych żądaniach, aby pobrać następną lub poprzednią stronę.

Wytrwałość

Czy wymiana jest w rekordzie; unknown oznacza, że mogło się zdarzyć zatwierdzenie.

Wytrwałość: string

QAInferenceResponse

Nazwisko	Ścieżka	Typ	Opis
Wygenerowany tekst	generated_text	string	Odpowiedź wygenerowana przez sztuczną inteligencję w formacie Markdown.
Source	source	object	Dokumenty źródłowe, do których odwołuje się odpowiedź, kluczem według znaczników cytatu liczbowego (np. `1`, `2`). Cytaty są wyświetlane w wygenerowanych tekstach jako `[1]`, `[2]`itp.
Ukończono przesyłanie strumieniowe	stream_complete	boolean	Wskazuje, czy odpowiedź przesyłania strumieniowego została zakończona. Zawsze ma wartość true w przypadku odpowiedzi nieprzesyłania strumieniowego.
Opcje źródła	source_options	array of SourceOptions	Typy źródeł odpowiedzi, które zostały użyte do wygenerowania tej odpowiedzi.
Attachments	attachments	array of uuid4	Identyfikatory załączników plików generowanych przez llM (np. CSV, XLSX, JSON, PDF, images), które towarzyszą odpowiedzi. Obsługiwane typy danych wyjściowych obejmują formaty tekstu, arkusze kalkulacyjne, dokumenty i obrazy. W wielu rozmowach najnowsze 5 wygenerowanych plików jest automatycznie odtwarzanych do modelu; tylko obrazy i pliki PDF są odtwarzane jako dane wejściowe LLM z powodu ograniczeń infrastruktury usługi LLM.
Podsumowanie rozumowania	reasoning_summary	string	Podsumowanie procesu rozumowania sztucznej inteligencji uwzględnione podczas włączania trybu rozumowania.
ResponseEvent	response_event	ResponseEvent
AnswerUpdate	answer_update	AnswerUpdate	Jedna operacja na odpowiedzi klienta przesyłania strumieniowego pokazuje: dołączanie, ukończenie lub niepowodzenie. `complete` jest niekompletna, gdy `reason` jest ustawiona; `fail` zawiera kod błędu i nigdy nie wycofuje wyświetlanego tekstu.
AnswerOutcome	answer_outcome	AnswerOutcome	Wynik jednej odpowiedzi: brak, ukończenie lub niekompletne z kodem tego, co go wyciąć.

ResponseEvent

Nazwisko	Ścieżka	Typ	Opis
Typ	type	string	Identyfikator zdarzenia dot-namespaced zgodnie ze wzorcem `response.status.{phase}.{state}`. Zdarzenia cyklu życia: `response.created`, `response.in_progress`, `response.error`. Zdarzenia stanu: `context.loading` (ładowanie historii konwersacji na potrzeby pytań następczych), `question.analyzing` (zrozumienie pytania), `documents.searching` (wyszukiwanie kolekcji odpowiednich dokumentów), `documents.found` (ukończenie pobierania, zidentyfikowane dokumenty), `sources.linking` (mapowanie dowodów odpowiedzi na dokumenty źródłowe), `figures.analyzing` (analizowanie rysunków i wykresów dokumentów), `context.preparing` (tworzenie kontekstu dokumentu dla modelu), (model generuje odpowiedź), `answer.generatinganswer.streaming` (pierwszy token odpowiedzi odebrany, przesyłanie strumieniowe w toku).
Message	message	string	Tekst postępu dostępny dla użytkownika opisujący bieżący krok przetwarzania.
Meta	meta	object	Metadane ustrukturyzowane dla zdarzenia. Typowe pola: `collection_names` (lista nazw wyświetlanych kolekcji), `doc_count` (liczba znalezionych dokumentów), `question` (przeanalizowany tekst pytania), `document_names` (nazwy określonych żądanych dokumentów), `is_follow_up` (prawda w przypadku pytań z wieloma monitami).
Data utworzenia	created_at	string	Sygnatura czasowa ISO 8601 UTC, kiedy to zdarzenie zostało wygenerowane.

SourceOptions

SourceOptions: string

Status

Status: string

PodsumowanieResponse

Nazwisko	Ścieżka	Typ	Opis
Podsumowanie	summary	string	Podsumowanie dokumentu wygenerowanego przez sztuczną inteligencję w formacie Markdown.
Source	source	object	Dokumenty źródłowe używane do tworzenia podsumowania, kluczem według znacznika cytatu liczbowego.

UploadDocumentResponse

Odpowiedź zwrócona dla każdego przekazanego dokumentu.

Nazwisko	Ścieżka	Typ	Opis
Identyfikator użytkownika	user_id	string	Identyfikator użytkownika, który przesłał dokument.
Identyfikator dokumentu	document_id	string	Unikatowy identyfikator przypisany do przekazanego dokumentu.
Nazwa dokumentu	document_name	string	Oryginalna nazwa pliku przekazanego dokumentu.
Przestrzeń nazw dokumentu	document_namespace	string	Przestrzeń nazw (identyfikator kolekcji), do którego należy dokument.
Identyfikator przestrzeni nazw dokumentu	document_namespace_id	string	UUID kolekcji, do którego należy dokument.
Status	status	string	Stan przetwarzania przekazanego dokumentu.
Typ zawartości	content_type	string	Typ MIME przekazanego dokumentu.

binarny

Jest to podstawowy typ danych "binary".