Base de dados de conhecimento do Adobe Acrobat (versão prévia)
A Base de Dados de Conhecimento no Adobe Acrobat Studio permite aos usuários acesso de conversa ao conhecimento que reside em grandes coleções de documentos com curadoria, em Q&A de vários turnos, resumo, extração e pesquisa. Traga recursos da Base de Dados de Conhecimento para os aplicativos e fluxos de trabalho em que você trabalha para conectar o conhecimento armazenado em SharePoint e outros repositórios com suporte e aprovações de energia, notificações, criação de conteúdo e processos de negócios.
Esse conector está disponível nos seguintes produtos e regiões:
| Serviço | Classe | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Azure Governamental regiões - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões Power Apps exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões Power Automate exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Name | Adobe |
| URL | https://www.adobe.com |
| Metadados do conector | |
|---|---|
| Publicador | ADOBE INC. |
| Website | https://business.adobe.com/products/acrobat-business/knowledge-base.html |
| Política de privacidade | https://www.adobe.com/go/privacy_policy |
| Categories | Produtividade |
Base de dados de conhecimento no Acrobat
A Base de Dados de Conhecimento no Adobe Acrobat Studio permite aos usuários acesso de conversa ao conhecimento que reside em grandes coleções de documentos com curadoria, em Q&A de vários turnos, resumo, extração e pesquisa. Traga recursos da Base de Dados de Conhecimento para os aplicativos e fluxos de trabalho em que você trabalha para conectar o conhecimento armazenado em SharePoint e outros repositórios com suporte e aprovações de energia, notificações, criação de conteúdo e processos de negócios.
Publisher: Adobe, Inc.
Prerequisites
Uma conta da Adobe com acesso à Base de Dados de Conhecimento no Acrobat é necessária.
Como obter credenciais
Entre com sua ID do Adobe ao criar uma conexão. Esse conector é autenticado com o Adobe Identity Management System (IMS) usando o OAuth 2.0; você é redirecionado para a página de entrada da Adobe e solicitado a consentir com as permissões solicitadas antes que a conexão seja criada.
Introdução ao conector
N/A
Limitações e problemas conhecidos
N/A
Erros comuns e soluções
N/A
perguntas frequentes
N/A
Ações
| Atualizar coleção |
Atualize todas as propriedades de uma coleção existente. |
| Carregar anexos |
Carregue um ou mais anexos. |
| Carregar documentos |
Carregue um ou mais documentos em uma coleção para indexação. |
| Criar coleção |
Crie uma coleção (um namespace que agrupa documentos e controles de acesso). |
| Excluir anexo |
Exclua um único anexo por sua UUID. |
| Excluir coleção |
Exclua uma coleção e todos os seus documentos. |
| Excluir documentos |
Exclua um ou mais documentos de uma coleção por seus UUIDs. |
| Faça uma pergunta |
Faça uma pergunta de linguagem natural em uma coleção e obtenha uma resposta com citações. |
| Listar anexos |
Listar anexos. |
| Listar coleções |
Liste as coleções que o usuário pode acessar. |
| Listar documentos |
Liste os documentos em uma coleção. |
| Obter anexo |
Obtenha um único anexo por sua UUID. |
| Obter arquivo de anexo |
Baixe o conteúdo do arquivo de um anexo por sua UUID. |
| Obter arquivo de documento |
Obtenha os metadados e o conteúdo de um único documento por sua UUID. |
| Obter coleção |
Obtenha uma única coleção por sua UUID. |
| Obter o status do documento |
Obtenha o status de indexação de um único documento por sua UUID. |
| Pesquisar documentos (paginado) |
Pesquise em documentos em uma coleção com resultados paginados classificados. |
| Resumir documentos |
Gere um resumo de um ou mais documentos em uma coleção. |
Atualizar coleção
Atualize todas as propriedades de uma coleção existente.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collection_id | True | uuid4 |
Identificador exclusivo da coleção |
|
Name
|
name | True | string |
Nome de exibição da coleção. Obrigatório, comprimento máximo de 100 caracteres |
|
Description
|
description | string |
Descrição opcional da coleção. Padrão para cadeia de caracteres vazia, comprimento máximo de 500 caracteres |
|
|
É público
|
is_public | boolean |
Se a coleção é publicamente acessível. |
|
|
Está congelado
|
is_frozen | boolean |
Se a coleção está congelada e não pode ser modificada. |
|
|
Ler Usuários
|
read_users | array of string |
Lista de IDs de usuário com acesso de leitura à coleção. |
|
|
Gravar Usuários
|
write_users | array of string |
Lista de IDs de usuário com acesso de gravação à coleção. |
|
|
Grupos de Leitura
|
read_groups | array of string |
Lista de IDs de grupo (UUIDs) com acesso de leitura à coleção. |
|
|
Grupos de Gravação
|
write_groups | array of string |
Lista de IDs de grupo (UUIDs) com acesso de gravação à coleção. |
|
|
Metadata
|
metadata | object |
Metadados opcionais associados à coleção. Comprimento máximo de 1000 caracteres |
|
|
Namespace Id
|
namespace_id | string |
UUID da coleção a ser atualizada. |
Retornos
Conclua os detalhes da coleção, incluindo metadados, permissões e status.
- NamespaceResponse
- NamespaceResponse
Carregar anexos
Carregue um ou mais anexos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Arquivo a ser carregado
|
documents | True | file |
1 a 10 imagens ou arquivos. Imagens: image/jpeg, image/png, image/jpg, image/webp, image/gif - ≤10 MB cada. Arquivos: aplicativo/pdf – ≤8 MB cada |
Retornos
Resposta de API para uploads de lote de anexo v2.
- AttachmentUploadsResponse
- AttachmentUploadsResponse
Carregar documentos
Carregue um ou mais documentos em uma coleção para indexação.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ID da coleção
|
collection_id | True | uuid4 |
Identificador exclusivo da coleção |
||||||||||||
|
Manipulação de duplicatas
|
option | string |
Estratégia de tratamento duplicada.
|
|||||||||||||
|
Modo OCR
|
ocr | string |
Modo de processamento OCR para documentos PDF e de imagem. Os uploads de imagem sempre exigem OCR.
|
|||||||||||||
|
Extração de planilha oculta
|
hidden_sheets | string |
Controla o modo de extração de planilha oculta para documentos Excel.
|
|||||||||||||
|
Arquivo a ser carregado
|
documents | True | file |
Um ou mais arquivos a serem carregados. Formatos com suporte: PDF, DOC/DOCX, DOT/DOTX, TXT, RTF, XLS/XLSM/XLSX, PPT/PPTX, ODP, ODT, CSV, EML, JSON, MD, HTML, JPEG, PNG, TIFF, GIF, WebP e BMP. |
||||||||||||
|
Marcas de documento
|
document_tags | string |
Matriz JSON de marcas chave-valor a serem anexadas a todos os documentos carregados. Cada marca deve ter um |
|||||||||||||
|
Links de origem HTML
|
html_links | string |
Nomes de arquivo HTML de mapeamento de objeto JSON para suas URLs de origem originais. Aplica-se somente a arquivos HTML carregados. A chave é o nome do arquivo de um arquivo HTML no upload e o valor é a URL original da qual foi salvo. |
Retornos
- Uploaddocuments de resposta
- array of UploadDocumentResponse
Criar coleção
Crie uma coleção (um namespace que agrupa documentos e controles de acesso).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Name
|
name | True | string |
Nome de exibição da coleção. Obrigatório, comprimento máximo de 100 caracteres |
|
Description
|
description | string |
Descrição opcional da coleção. Padrão para cadeia de caracteres vazia, comprimento máximo de 500 caracteres |
|
|
É público
|
is_public | boolean |
Se a coleção é publicamente acessível. |
|
|
Está congelado
|
is_frozen | boolean |
Se a coleção está congelada e não pode ser modificada. |
|
|
Ler Usuários
|
read_users | array of string |
Lista de IDs de usuário com acesso de leitura à coleção. |
|
|
Gravar Usuários
|
write_users | array of string |
Lista de IDs de usuário com acesso de gravação à coleção. |
|
|
Grupos de Leitura
|
read_groups | array of string |
Lista de IDs de grupo (UUIDs) com acesso de leitura à coleção. |
|
|
Grupos de Gravação
|
write_groups | array of string |
Lista de IDs de grupo (UUIDs) com acesso de gravação à coleção. |
|
|
Metadata
|
metadata | object |
Metadados opcionais associados à coleção. Comprimento máximo de 1000 caracteres |
Retornos
Conclua os detalhes da coleção, incluindo metadados, permissões e status.
- NamespaceResponse
- NamespaceResponse
Excluir anexo
Exclua um único anexo por sua UUID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | uuid |
UUID do anexo |
Excluir coleção
Exclua uma coleção e todos os seus documentos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collection_id | True | uuid4 |
Identificador exclusivo da coleção |
Retornos
Conclua os detalhes da coleção, incluindo metadados, permissões e status.
- NamespaceResponse
- NamespaceResponse
Excluir documentos
Exclua um ou mais documentos de uma coleção por seus UUIDs.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de documento
|
document_ids | array of uuid4 |
Lista de UUIDs de documento a serem excluídos. |
|
|
ID da coleção
|
collection_id | string |
UUID da coleção que contém os documentos. |
Retornos
- DeleteDocumentResponse
- DeleteDocumentResponse
Faça uma pergunta
Faça uma pergunta de linguagem natural em uma coleção e obtenha uma resposta com citações.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da solicitação
|
request_id | string |
Identificador exclusivo para essa solicitação, usado para acompanhamento no histórico de chat. |
|
|
IDs de documento
|
document_ids | array of string |
UUIDs de documentos específicos aos quais restringir a pesquisa. Quando vazios, todos os documentos nas coleções especificadas são pesquisados. |
|
|
Collections
|
collections | array of string |
Namespaces de coleção a serem pesquisados. Pelo menos um é necessário para a origem COLLECTION. |
|
|
Inputs
|
inputs | string |
A pergunta ou solicitação para responder. Dá suporte a consultas de linguagem natural. |
|
|
Formato
|
format | string | ||
|
Verbosidade
|
style | string | ||
|
Tom
|
tone | string | ||
|
Reasoning
|
reasoning | string | ||
|
Instruções Personalizadas
|
custom_instructions | string |
Instruções de texto livre para personalizar ainda mais o comportamento de resposta de IA. |
|
|
SourceOptions
|
Source Options | string | ||
|
Modo de Inferência
|
inference_mode | string |
Camada de modelo de IA a ser usada. Opções: |
|
|
Estratégia de execução
|
inference_type | string |
Estratégia de execução para inferência de pergunta-resposta. Orthogonal to InferenceMode (camada de modelo): AGENTIC seleciona o loop de agente de várias iterações, DEFAULT o caminho clássico de RAG de inferência única. Nenhuma coerção ausente – valores desconhecidos devem falhar na validação. |
|
|
Key
|
key | True | string |
Identificador de tag. Somente caracteres alfanuméricos e hifens. |
|
Value
|
value | True | string |
Valor da marca. Somente caracteres alfanuméricos e hifens. |
|
IDs de anexo
|
attachment_ids | array of uuid4 |
IDs de anexos de arquivo carregados anteriormente para incluir como contexto visual. Máximo de 15 por solicitação. Tipos de entrada aceitos: imagens (JPEG, PNG, GIF, WebP) e PDF. Outros tipos de arquivo são rejeitados no momento do upload. Em conversas de vários turnos, os 5 arquivos mais recentes gerados por LLM são reproduzidos automaticamente como contexto; somente imagens e PDFs são reproduzidos devido a limitações de infraestrutura de serviço LLM. |
|
|
Modo de Geração de Arquivo
|
file_generation | string | ||
|
ID de conexão
|
connection_id | string |
ID da conexão Office 365 a ser usada. Necessário apenas para OFFICE365 fonte. Se omitida, a primeira conexão correspondente será usada. |
|
|
Fuso horário
|
time_zone | string |
Identificador de fuso horário IANA para consultas com reconhecimento de data (por exemplo, |
|
|
Habilitar números
|
enable_figures | boolean |
Quando true, as figuras de documento recuperadas (gráficos, imagens) são incluídas como contexto visual. Total de até 8 dígitos (máximo de 4 por documento). |
|
|
Store
|
store | boolean |
Quando true, a conversa é mantida para o histórico de chat, permitindo acompanhamentos de várias voltas. Definido como false para consultas sem estado e pontuais. |
|
|
AttributionField
|
Include | string |
Campos do DocumentInfo qualificados para inclusão em respostas de origem. Cada valor é um caminho de notação de ponto com raiz no DocumentInfo. Cada caminho deve ser resolvido para um campo anotado com attribution_eligible = True. |
|
|
BoundCoordinateFormat
|
bound_coordinate_format | string | ||
|
Enabled
|
enabled | boolean |
Habilite eventos de progresso durante o streaming. |
|
|
ResponseEventDetail
|
detail | string | ||
|
Atualizações de resposta
|
answer_updates | boolean |
Transmita a resposta agente conforme ela é escrita, como quadros que carregam um answer_update (acrescentar, em seguida, concluir ou falhar) em vez de um quadro final. O cliente deve aplicar essas operações. Ignorado para solicitações não-streaming e não agente. |
|
|
Exchange ID
|
exchange_id | string |
O identificador do cliente dessa troca dentro da conversa. Armazenado com a troca e retornado no histórico de chat, para que um cliente possa reconciliar sua virada local com o registro: a mesma pergunta feita duas vezes gera duas trocas e apenas a ID os diferencia. |
Retornos
- QAInferenceResponse
- QAInferenceResponse
Listar anexos
Listar coleções
Liste as coleções que o usuário pode acessar.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Página
|
page | integer |
Número da página (baseado em 1) |
|||||||||||||
|
Tamanho da página
|
page_size | integer |
Número de itens por página (1 a 100) |
|||||||||||||
|
Classificar por
|
order_by | string |
Campo pelo qual classificar os resultados.
|
|||||||||||||
|
Crescente
|
asc | boolean |
Classificar em ordem crescente se |
|||||||||||||
|
O nome contém
|
infix | string |
Termo de pesquisa para o nome da coleção (correspondência parcial que não diferencia maiúsculas de minúsculas). |
|||||||||||||
|
Filtro
|
filter_constraint | string |
Filtrar coleções por propriedade ou escopo.
|
Retornos
- CollectionPage
- CollectionPage
Listar documentos
Liste os documentos em uma coleção.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ID da coleção
|
collection_id | True | string |
Identificador exclusivo da coleção |
||||||||||||
|
Página
|
page | integer |
Número da página (baseado em 1) |
|||||||||||||
|
Tamanho da página
|
page_size | integer |
Número de itens por página (1 a 100) |
|||||||||||||
|
Classificar por
|
order_by | string |
Campo pelo qual classificar os resultados.
|
|||||||||||||
|
Crescente
|
asc | boolean |
Classificar em ordem crescente se |
|||||||||||||
|
O nome contém
|
infix | string |
Termo de pesquisa para o nome do documento (correspondência parcial que não diferencia maiúsculas de minúsculas). |
|||||||||||||
|
Tipo de origem
|
source_type | string |
Restrinja os resultados a documentos com essa fonte de origem. Documentos sem metadados de origem são excluídos quando esse filtro é definido. |
Retornos
- InfoPageApiResponse
- InfoPageApiResponse
Obter anexo
Obtenha um único anexo por sua UUID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | uuid |
UUID do anexo |
Retornos
- AttachmentResponse
- AttachmentResponse
Obter arquivo de anexo
Baixe o conteúdo do arquivo de um anexo por sua UUID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do anexo
|
attachment_id | True | uuid |
UUID do anexo |
Obter arquivo de documento
Obtenha os metadados e o conteúdo de um único documento por sua UUID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
document_id | True | uuid |
UUID do documento |
|
Nome do arquivo de artefato
|
filename | string |
Artefato armazenado específico a ser recuperado. Se omitido, a representação do documento atual será retornada. |
Retornos
- response
- binary
Obter coleção
Obtenha uma única coleção por sua UUID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID da coleção
|
collection_id | True | string |
Identificador exclusivo da coleção |
Retornos
Conclua os detalhes da coleção, incluindo metadados, permissões e status.
- NamespaceResponse
- NamespaceResponse
Obter o status do documento
Obtenha o status de indexação de um único documento por sua UUID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do documento
|
document_id | True | uuid |
UUID do documento |
Retornos
- Informações do documento
- DocumentInfoApiResponse
Pesquisar documentos (paginado)
Pesquise em documentos em uma coleção com resultados paginados classificados.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Namespace do documento
|
document_namespace | True | string |
O nome da coleção dos documentos a serem pesquisados. |
|
Filtrar por
|
filter_by | True | string |
Consulta de pesquisa de palavra-chave para filtrar documentos por conteúdo ou metadados. |
|
IDs de documento
|
document_ids | array of string |
Lista de IDs de documento específicas às quais restringir a pesquisa. Máximo de 1000 IDs de documento. |
|
|
Key
|
key | True | string |
Identificador de tag. Somente caracteres alfanuméricos e hifens. |
|
Value
|
value | True | string |
Valor da marca. Somente caracteres alfanuméricos e hifens. |
|
Tamanho da Página
|
page_size | integer |
O número de resultados a serem retornados por página. A pesquisa não paginada sempre retorna page_size de 10000. |
|
|
Ordenar por
|
order_by | string |
O campo pelo qual classificar os resultados. |
|
|
Cresc
|
asc | boolean |
Ordem de classificação: True para crescente, False para decrescente. |
|
|
Ordem de Paginação
|
pagination_order | string |
Determina se a próxima página de resultados ou anterior deve ser exibida. |
|
|
Chave paginada
|
paginated_key | string |
Uma chave usada para paginação. |
Retornos
- PaginatedSearchApiResponse
- PaginatedSearchApiResponse
Resumir documentos
Gere um resumo de um ou mais documentos em uma coleção.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
IDs de documento
|
document_ids | True | array of string |
UUIDs de documentos específicos a serem resumidos. Máximo de 10 documentos por solicitação. |
|
Namespace do documento
|
document_namespace | True | string |
Namespace de coleção que contém os documentos. |
Retornos
- Resumos de resposta
- array of SummarizationResponse
Definições
RespostaResultado
O resultado de uma resposta: nenhum, completo ou incompleto com o código do que o cortou.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | string |
Se existe uma resposta e se sua geração terminou. |
|
Reason
|
reason | string |
O código de interrupção quando incompleto, o código de falha quando nenhum; nunca definido quando concluído. |
AnswerUpdate
Uma operação na resposta que um cliente de streaming mostra: acrescentar, concluir ou falhar.
complete está incompleto quando reason está definido; fail carrega um código de falha e nunca retira o texto mostrado.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Operation
|
operation | string | |
|
Reason
|
reason | string |
Somente terminal: o código de interrupção concluído (por exemplo, response_truncated_deadline), o código de falha ao falhar (por exemplo, budget_exhausted, save_failed). |
|
Persistência
|
persistence | Persistence |
Se uma troca está registrada; |
AttachmentErrorCode
Códigos de erro para uploads de anexo com falha.
Códigos de erro para uploads de anexo com falha.
- AttachmentErrorCode
- string
AttachmentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do anexo
|
attachment_id | string | |
|
Nome do anexo
|
attachment_name | string | |
|
Tipo mime de anexo
|
attachment_mime_type | string |
Tipo MIME de imagem (por exemplo, image/png) |
|
Soma de verificação de anexo
|
attachment_checksum | string |
Soma de verificação MD5 dos bytes de imagem |
|
Tamanho do anexo
|
attachment_size | integer |
Tamanho da imagem em bytes |
|
Status do anexo
|
attachment_status | string |
AttachmentUploadError
Detalhes de falha legíveis pelo computador para um único upload de anexo.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
AttachmentErrorCode
|
code | AttachmentErrorCode |
Códigos de erro para uploads de anexo com falha. |
|
Message
|
message | string | |
|
Size
|
size | integer | |
|
Tipo mime
|
mime_type | string |
AttachmentUploadItem
Resultado unificado por arquivo na resposta de upload do anexo v2.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome do Arquivo
|
filename | string | |
|
AttachmentUploadItemStatus
|
status | AttachmentUploadItemStatus |
Status por arquivo para respostas de upload em lote de anexo v2. |
|
Código de Status
|
status_code | integer | |
|
AttachmentResponse
|
attachment | AttachmentResponse | |
|
AttachmentUploadError
|
error | AttachmentUploadError |
Detalhes de falha legíveis pelo computador para um único upload de anexo. |
AttachmentUploadItemStatus
Status por arquivo para respostas de upload em lote de anexo v2.
Status por arquivo para respostas de upload em lote de anexo v2.
- AttachmentUploadItemStatus
- string
AttachmentUploadsResponse
Resposta de API para uploads de lote de anexo v2.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Uploads
|
uploads | array of AttachmentUploadItem |
CollectionPage
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Página
|
page | integer |
Número da página atual (baseado em 1). |
|
Size
|
size | integer |
Número de itens por página. |
|
Total
|
total | integer |
Número total de coleções correspondentes à consulta. |
|
Ordenar por
|
order_by | string |
Campo usado para classificar resultados. |
|
Cresc
|
asc | boolean |
Se os resultados são classificados em ordem crescente. |
|
Páginas
|
pages | array of Namespace |
Lista de coleções na página atual. |
DeleteDocumentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Detalhes
|
details | array of DocumentDeletionStatus |
Resultados da exclusão por documento. |
DocumentDeletionStatus
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID do documento
|
document_id | string |
UUID do documento. |
|
Status
|
status | Status | |
|
Message
|
message | string |
Mensagem legível por humanos que descreve o resultado. |
DocumentInfoApiResponse
| Nome | Caminho | Tipo | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
ID do documento
|
document_id | string |
UUID do documento. |
||||||||||||||
|
Nome do documento
|
document_name | string |
Nome de exibição do documento (normalmente o nome do arquivo original). |
||||||||||||||
|
Caminho do documento
|
document_path | string |
Caminho de armazenamento do documento dentro do sistema. |
||||||||||||||
|
Namespace do documento
|
document_namespace | string |
O namespace da coleção ao qual este documento pertence. |
||||||||||||||
|
ID do namespace do documento
|
document_namespace_id | string |
UUID da coleção à qual o documento pertence. |
||||||||||||||
|
Descrição do documento
|
document_description | string |
Descrição fornecida pelo usuário do documento. |
||||||||||||||
|
Carregado por
|
uploaded_by | string |
Endereço de email da pessoa que carregou o documento. Nulo quando nenhum email de upload está disponível. |
||||||||||||||
|
Upload Status
|
upload_status | string |
Status atual de upload/processamento.
|
||||||||||||||
|
Checksum
|
checksum | string |
Soma de verificação SHA-256 do arquivo de documento para verificação de integridade. |
||||||||||||||
|
Tipo mime
|
mime_type | string |
Tipo MIME do documento de origem original. |
||||||||||||||
|
Tipo mime de representação
|
rendition_mime_type | string |
Tipo MIME da representação do cliente; uso de fontes externas |
||||||||||||||
|
Tipo de Fonte
|
source_type | string |
Fonte de origem deste documento: |
||||||||||||||
|
DocumentStatus
|
status | DocumentStatus | |||||||||||||||
|
Carregado em
|
uploaded_at | date-time |
Carimbo de data/hora quando o documento foi carregado (formato ISO 8601). |
||||||||||||||
|
Atualizado em
|
updated_at | date-time |
Carimbo de data/hora da última atualização para o registro do documento, se houver. |
||||||||||||||
|
Está Excluído
|
is_deleted | boolean |
Se o documento foi excluído suavemente. |
||||||||||||||
|
DocumentMetadata
|
document_metadata | DocumentMetadata |
DocumentMetadata
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Permissões
|
permissions | ||
|
Marcas de documento
|
document_tags | array of DocumentTag | |
|
Metadados de origem
|
source_metadata | ||
|
IngestionMetadata
|
ingestion_metadata | IngestionMetadata |
DocumentStatus
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Status
|
status | string | |
|
Código do erro
|
error_code | string |
DocumentTag
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Key
|
key | string |
Identificador de tag. Somente caracteres alfanuméricos e hifens. |
|
Value
|
value | string |
Valor da marca. Somente caracteres alfanuméricos e hifens. |
InfoPageApiResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Página
|
page | integer |
Número da página atual (baseado em 1). |
|
Size
|
size | integer |
Número de itens por página. |
|
Total
|
total | integer |
Número total de documentos correspondentes à consulta. |
|
Ordenar por
|
order_by | string |
Campo usado para classificar resultados. |
|
Cresc
|
asc | boolean |
Se os resultados são classificados em ordem crescente. |
|
Páginas
|
pages | array of DocumentInfoApiResponse |
Lista de documentos na página atual. |
IngestionMetadata
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Pontuação de confiança
|
confidence_score | number | |
|
Ocr
|
ocr | boolean | |
|
Caracteres inválidos
|
bad_characters | boolean | |
|
Folhas ocultas encontradas
|
found_hidden_sheets | boolean | |
|
Folhas muito ocultas encontradas
|
found_very_hidden_sheets | boolean | |
|
Folhas ocultas protegidas encontradas
|
found_protected_hidden_sheets | boolean | |
|
Planilhas Ocultas Habilitadas
|
enabled_hidden_sheets | boolean | |
|
Planilhas muito ocultas habilitadas
|
enabled_very_hidden_sheets | boolean | |
|
Data de Criação do Documento
|
document_created_date | date-time |
Namespace
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Namespace
|
namespace | string |
Identificador exclusivo para a coleção. O padrão é UUID. Use-o como uma ID externa. |
|
Name
|
name | string |
Nome de exibição opcional para a coleção. Obrigatório se 'namespace' não for fornecido. |
|
Description
|
description | string |
Descrição legível por humanos da coleção. |
|
Está congelado
|
is_frozen | boolean |
Se a coleção está congelada e não pode ser modificada. |
|
Criado por
|
created_by | string |
Email ou ID do criador da coleção. |
|
Criado por ID do Usuário
|
created_by_user_id | string |
ID do usuário do criador da coleção. |
|
É público
|
is_public | boolean |
Se a coleção é publicamente acessível. |
|
Ler Usuários
|
read_users | array of string |
Lista de IDs de usuário com acesso de leitura. |
|
Gravar Usuários
|
write_users | array of string |
Lista de IDs de usuário com acesso de gravação. |
|
Grupos de Leitura
|
read_groups | array of string |
Lista de IDs de grupo com acesso de leitura. |
|
Grupos de Gravação
|
write_groups | array of string |
Lista de IDs de grupo com acesso de gravação. |
|
Metadata
|
metadata | object |
Metadados adicionais associados à coleção. |
|
Versão
|
version | string |
Versão da API da coleção. |
|
Namespace Id
|
namespace_id | string |
Identificador exclusivo para a coleção. |
|
Criado em
|
created_at | date-time |
Carimbo de data/hora quando a coleção foi criada. |
|
Modificado em
|
modified_at | date-time |
Carimbo de data/hora quando a coleção foi modificada pela última vez. |
|
Está Excluído
|
is_deleted | boolean |
Se a coleção foi excluída suavemente. |
|
Está ativo
|
is_active | boolean |
Se a coleção está ativa no momento. |
|
Contagem de documentos
|
doc_count | integer |
Contagem de documentos para o namespace. Expor como uma propriedade de nível superior para namespace, de metadata.doc_count |
NamespaceResponse
Conclua os detalhes da coleção, incluindo metadados, permissões e status.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Namespace Id
|
namespace_id | string |
Identificador exclusivo para a coleção. |
|
Namespace
|
namespace | string |
Identificador seguro de URL usado em chamadas à API. |
|
Name
|
name | string |
Nome de exibição da coleção. |
|
Description
|
description | string |
Descrição legível por humanos da coleção. |
|
Está congelado
|
is_frozen | boolean |
Se a coleção está congelada e não pode ser modificada. |
|
Criado por
|
created_by | string |
ID do usuário do criador da coleção. |
|
É público
|
is_public | boolean |
Se a coleção é publicamente acessível. |
|
Ler Usuários
|
read_users | array of string |
Lista de IDs de usuário com acesso de leitura. |
|
Gravar Usuários
|
write_users | array of string |
Lista de IDs de usuário com acesso de gravação. |
|
Grupos de Leitura
|
read_groups | array of string |
Lista de IDs de grupo com acesso de leitura. |
|
Grupos de Gravação
|
write_groups | array of string |
Lista de IDs de grupo com acesso de gravação. |
|
Compartilhamentos de gravação rejeitados
|
rejected_write_shares | array of string |
Usuários de compartilhamento de gravação não autorizados |
|
Metadata
|
metadata | object |
Metadados adicionais associados à coleção. |
|
Versão
|
version | string |
Versão da API para essa resposta. |
|
Criado em
|
created_at | date-time |
Carimbo de data/hora quando a coleção foi criada. |
|
Modificado em
|
modified_at | date-time |
Carimbo de data/hora quando a coleção foi modificada pela última vez. |
|
Está Excluído
|
is_deleted | boolean |
Se a coleção foi excluída suavemente. |
|
Está ativo
|
is_active | boolean |
Se a coleção está ativa no momento. |
|
Contagem de documentos
|
doc_count | integer |
Número de documentos na coleção. |
|
Proprietário
|
owner | string |
Email do proprietário da coleção. Atualmente, o usuário que criou a coleção. |
PaginatedSearchApiResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Totaldocuments
|
totalDocuments | integer |
Número total de documentos que correspondem aos critérios de pesquisa. |
|
Documentinfo
|
documentInfo | array of DocumentInfoApiResponse |
Lista de documentos na página atual de resultados. |
|
Chave paginada
|
paginated_key | string |
Token de paginação opaca. Passe esse valor em solicitações subsequentes para recuperar a página seguinte ou anterior. |
Persistência
Se uma troca está registrada; unknown significa que a confirmação pode ter acontecido.
Se uma troca está registrada; unknown significa que a confirmação pode ter acontecido.
- Persistência
- string
QAInferenceResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Texto Gerado
|
generated_text | string |
A resposta gerada por IA no formato Markdown. |
|
Source
|
source | object |
Documentos de origem referenciados na resposta, chaveados por marcadores de citação numéricos (por exemplo, , |
|
Fluxo Concluído
|
stream_complete | boolean |
Indica se a resposta de streaming foi concluída. Sempre verdadeiro para respostas que não são de streaming. |
|
Opções de origem
|
source_options | array of SourceOptions |
Os tipos de origem de resposta que foram usados para gerar essa resposta. |
|
Anexos
|
attachments | array of uuid4 |
IDs de anexos de arquivo gerados por LLM (por exemplo, CSV, XLSX, JSON, PDF, imagens) que acompanham a resposta. Os tipos de saída com suporte incluem formatos de texto, planilhas, documentos e imagens. Em conversas de vários turnos, os 5 arquivos mais recentes gerados são reproduzidos automaticamente no modelo; somente imagens e PDFs são reproduzidos como entrada LLM devido a limitações de infraestrutura de serviço llm. |
|
Resumo do raciocínio
|
reasoning_summary | string |
Um resumo do processo de raciocínio de IA, incluído quando o modo de raciocínio está habilitado. |
|
ResponseEvent
|
response_event | ResponseEvent | |
|
AnswerUpdate
|
answer_update | AnswerUpdate |
Uma operação na resposta que um cliente de streaming mostra: acrescentar, concluir ou falhar.
|
|
RespostaResultado
|
answer_outcome | AnswerOutcome |
O resultado de uma resposta: nenhum, completo ou incompleto com o código do que o cortou. |
ResponseEvent
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Tipo
|
type | string |
Identificador de evento com nomes de ponto seguindo o padrão |
|
Message
|
message | string |
Texto de progresso voltado para o usuário que descreve a etapa de processamento atual. |
|
Meta
|
meta | object |
Metadados estruturados para o evento. Campos comuns: |
|
Criado em
|
created_at | string |
ISO 8601 UTC carimbo de data/hora de quando este evento foi produzido. |
SourceOptions
- SourceOptions
- string
Status
- Status
- string
SummarizationResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Resumo
|
summary | string |
O resumo do documento gerado por IA no formato Markdown. |
|
Source
|
source | object |
Documentos de origem usados para produzir o resumo, chaveado pelo marcador de citação numérica. |
UploadDocumentResponse
Resposta retornada para cada documento carregado.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Id do usuário
|
user_id | string |
ID do usuário que carregou o documento. |
|
ID do documento
|
document_id | string |
Identificador exclusivo atribuído ao documento carregado. |
|
Nome do documento
|
document_name | string |
Nome de arquivo original do documento carregado. |
|
Namespace do documento
|
document_namespace | string |
Namespace (identificador de coleção) ao qual o documento pertence. |
|
ID do namespace do documento
|
document_namespace_id | string |
UUID da coleção à qual o documento pertence. |
|
Status
|
status | string |
Status de processamento do documento carregado. |
|
Tipo de conteúdo
|
content_type | string |
Tipo MIME do documento carregado. |
binário
Esse é o tipo de dados básico 'binary'.