Base de Conhecimento do Adobe Acrobat (Pré-visualização)

A Base de Conhecimento no Adobe Acrobat Studio permite aos utilizadores acesso conversacional a conhecimento que reside em grandes coleções de documentos curadas, através de perguntas e respostas em múltiplas turnos, resumo, extração e pesquisa. Implemente capacidades da Base de Conhecimento para as aplicações e fluxos de trabalho onde trabalha para ligar o conhecimento armazenado no SharePoint e outros repositórios suportados e alimentar aprovações, notificações, criação de conteúdos e processos de negócio.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regions
Estúdio Copiloto Premium Todas as regiões Power Automate exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões Azure Government
     - 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 (CCG)
     - 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 (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Entrar em contato
Name Adobe
URL https://www.adobe.com
Metadados do conector
Publisher ADOBE INC.
Sítio Web https://business.adobe.com/products/acrobat-business/knowledge-base.html
Política de privacidade https://www.adobe.com/go/privacy_policy
Categorias Productivity

Base de Conhecimento em Acrobat

A Base de Conhecimento no Adobe Acrobat Studio permite aos utilizadores acesso conversacional a conhecimento que reside em grandes coleções de documentos curadas, através de perguntas e respostas em múltiplas turnos, resumo, extração e pesquisa. Implemente capacidades da Base de Conhecimento para as aplicações e fluxos de trabalho onde trabalha para ligar o conhecimento armazenado no SharePoint e outros repositórios suportados e alimentar aprovações, notificações, criação de conteúdos e processos de negócio.

Editora: Adobe, Inc.

Prerequisites

É necessária uma conta Adobe com acesso à Base de Conhecimento no Acrobat.

Como obter credenciais

Inicie sessão com o seu Adobe ID quando criar uma ligação. Este conector autentica-se com o Adobe Identity Management System (IMS) usando o OAuth 2.0; é redirecionado para a página de início de sessão da Adobe e solicita-lhe o consentimento para as permissões solicitadas antes de a ligação ser criada.

Introdução ao conector

N/A

Problemas e limitações conhecidos

N/A

Erros e soluções comuns

N/A

FAQ

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 para uma coleção para indexação.

Criar coleção

Crie uma coleção (um namespace que agrupe documentos e controla o acesso).

Eliminar coleção

Apague uma coleção e todos os seus documentos.

Eliminar documentos

Apague um ou mais documentos de uma coleção pelos seus UUIDs.

Excluir anexo

Eliminar um único anexo pelo seu UUID.

Fazer uma pergunta

Faça uma pergunta em linguagem natural contra uma coleção e obtenha uma resposta com citações.

Listar anexos

Listar anexos.

Listar coleções

Liste as coleções a que o utilizador pode aceder.

Listar documentos

Liste os documentos numa coleção.

Obter anexo

Obtém um único anexo pelo UUID.

Obter coleção

Obtenha uma única coleção pelo UUID.

Obter ficheiro anexo

Descarregue o conteúdo do ficheiro de um anexo pelo seu UUID.

Obter ficheiro de documentos

Obtenha os metadados e o conteúdo de um único documento pelo seu UUID.

Obter o status do documento

Obtenha o estado de indexação de um único documento pelo seu UUID.

Pesquise documentos (paginados)

Pesquise entre documentos numa coleção com resultados classificados paginados.

Resumir documentos

Gere um resumo de um ou mais documentos de uma coleção.

Atualizar coleção

Atualize todas as propriedades de uma coleção existente.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID da coleção
collection_id True uuid4

Identificador único da coleção

Name
name True string

Nome de exibição para a coleção. Obrigatório, comprimento máximo 100 caracteres

Description
description string

Descrição opcional da coleção. Por defeito, string vazio, comprimento máximo 500 caracteres

É público
is_public boolean

Se a coleção é acessível ao público.

Está Congelado
is_frozen boolean

Se a coleção está congelada e não pode ser modificada.

Ler Utilizadores
read_users array of string

Lista de IDs de utilizador com acesso de leitura à coleção.

Utilizadores de Escrita
write_users array of string

Lista de IDs de utilizador com acesso de escrita à coleção.

Grupos de Leitura
read_groups array of string

Lista de IDs de grupo (UUIDs) com acesso de leitura à coleção.

Grupos de Escrita
write_groups array of string

Lista de IDs de grupo (UUIDs) com acesso de escrita à coleção.

Metadata
metadata object

Metadados opcionais associados à coleção. Comprimento máximo: 1000 caracteres

ID de espaço de nomes
namespace_id string

UUID da coleção para atualizar.

Devoluções

Detalhes completos da coleção, incluindo metadados, permissões e estado.

NamespaceResponse
NamespaceResponse

Carregar anexos

Carregue um ou mais anexos.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Ficheiro a carregar
documents True file

1–10 imagens ou ficheiros. Imagens: imagem/jpeg, imagem/png, image/jpg, image/webp, image/gif - ≤10 MB cada. Ficheiros: aplicação/pdf - ≤8 MB cada

Devoluções

Resposta API para carregamentos lotados de anexos v2.

AttachmentUploadsResposta
AttachmentUploadsResponse

Carregar documentos

Carregue um ou mais documentos para uma coleção para indexação.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID da coleção
collection_id True uuid4

Identificador único da coleção

Gestão de duplicados
option string

Estratégia de manipulação duplicada.

Value Comportamento
FILE_NAME Substitua qualquer documento existente pelo mesmo nome de ficheiro
FILE_CHECKSUM Substitui o ficheiro apenas quando o nome do ficheiro coincidir, mas o hash de conteúdo (MD5) for diferente.
SKIP_DUPLICATES Ignorar silenciosamente ficheiros que já existem (por soma de verificação)
REJECT_REQUEST_ON_DUPLICATE Devolva um erro 400 se for detetado um duplicado
(omitido) Permitir uploads duplicados
Modo OCR
ocr string

Modo de processamento OCR para documentos PDF e imagens. O carregamento de imagens exige sempre OCR.

Value Comportamento
AUTO Aplicar OCR quando necessário; os carregamentos de imagens são sempre processados (por defeito)
FORCE Rasterize sempre e processa OCR cada página
NONE Ignorar o OCR para documentos que não sejam imagens; os carregamentos de imagens continuam a ser processados
REJECT_BAD Aplicar OCR automaticamente e rejeitar páginas que não passem nas verificações de qualidade
Extração com folhas ocultas
hidden_sheets string

Controla o modo de extração de folhas ocultas para documentos Excel.

Value Comportamento
ALL extrair todas as folhas, incluindo as ocultas e as muito ocultas (por defeito)
NONE extrair apenas folhas visíveis
HIDDEN extrair folhas visíveis e ocultas
VERY_HIDDEN extrair folhas visíveis e muito escondidas
Ficheiro a carregar
documents True file

Um ou mais ficheiros para carregar. Formatos suportados: 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.

Tags de documento
document_tags string

Array JSON de etiquetas-chave-valor para anexar a todos os documentos carregados. Cada etiqueta deve ter um key (1-127 caracteres, alfanumérico minúsculo e hífen) e um value (1-256 caracteres).

Ligações de origem HTML
html_links string

Objetos JSON que mapeiam nomes de ficheiros HTML para as suas URLs originais. Aplica-se apenas a ficheiros HTML carregados. A chave é o nome de ficheiro de um ficheiro HTML no upload, e o valor é a URL original de onde foi guardado.

Devoluções

Documentos de Upload de Resposta
array of UploadDocumentResponse

Criar coleção

Crie uma coleção (um namespace que agrupe documentos e controla o acesso).

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Name
name True string

Nome de exibição para a coleção. Obrigatório, comprimento máximo 100 caracteres

Description
description string

Descrição opcional da coleção. Por defeito, string vazio, comprimento máximo 500 caracteres

É público
is_public boolean

Se a coleção é acessível ao público.

Está Congelado
is_frozen boolean

Se a coleção está congelada e não pode ser modificada.

Ler Utilizadores
read_users array of string

Lista de IDs de utilizador com acesso de leitura à coleção.

Utilizadores de Escrita
write_users array of string

Lista de IDs de utilizador com acesso de escrita à coleção.

Grupos de Leitura
read_groups array of string

Lista de IDs de grupo (UUIDs) com acesso de leitura à coleção.

Grupos de Escrita
write_groups array of string

Lista de IDs de grupo (UUIDs) com acesso de escrita à coleção.

Metadata
metadata object

Metadados opcionais associados à coleção. Comprimento máximo: 1000 caracteres

Devoluções

Detalhes completos da coleção, incluindo metadados, permissões e estado.

NamespaceResponse
NamespaceResponse

Eliminar coleção

Apague uma coleção e todos os seus documentos.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID da coleção
collection_id True uuid4

Identificador único da coleção

Devoluções

Detalhes completos da coleção, incluindo metadados, permissões e estado.

NamespaceResponse
NamespaceResponse

Eliminar documentos

Apague um ou mais documentos de uma coleção pelos seus UUIDs.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
IDs do documento
document_ids array of uuid4

Lista de UUIDs de documentos a eliminar.

ID da coleção
collection_id string

UUID da coleção que contém os documentos.

Devoluções

DeleteDocumentResponse
DeleteDocumentResponse

Excluir anexo

Eliminar um único anexo pelo seu UUID.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do anexo
attachment_id True uuid

UUID do anexo

Fazer uma pergunta

Faça uma pergunta em linguagem natural contra uma coleção e obtenha uma resposta com citações.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do pedido
request_id string

Identificador único para este pedido, usado para rastreamento no histórico de conversas.

IDs do documento
document_ids array of string

UUIDs de documentos específicos para restringir a pesquisa a. Quando vazios, todos os documentos das coleções especificadas são revistados.

Collections
collections array of string

Espaços de nomes de coleções para pesquisar. Pelo menos um é obrigatório para a COLLECTION source.

Inputs
inputs string

A pergunta ou o prompt para responder. Suporta consultas em linguagem natural.

Format
format string
Verbosity
style string
Tom
tone string
Raciocínio
reasoning string
Instruções Personalizadas
custom_instructions string

Instruções em texto livre para personalizar ainda mais o comportamento de resposta da IA.

SourceOptions
Source Options string
Modo de Inferência
inference_mode string

Modelo de IA para usar. Opções: STANDARD (velocidade e qualidade equilibradas), FAST_REASONING (otimizado para velocidade com raciocínio), ADVANCED (qualidade máxima), LITE (rápido, de menor custo — apenas não COLLECTION), NANO (mais rápido, custo mais baixo, apenas não-COLLECTION). Pois inference_type=AGENTIC este é o nível do agente que escreve a resposta; o trabalho que delega pode correr num nível mais rápido escolhido pelo serviço.

Estratégia de Execução
inference_type string

Estratégia de execução para inferência pergunta-resposta.

Ortogonal ao InferenceMode (nível modelo): AGENTIC seleciona o ciclo agente multi-iteração, DEFAULT o clássico caminho RAG de inferência única. Sem falta de coerção — valores desconhecidos têm de falhar na validação.

Key
key True string

Identificador de tag. Apenas caracteres alfanuméricos e hífens.

Value
value True string

Valor da tag. Apenas caracteres alfanuméricos e hífens.

IDs de anexos
attachment_ids array of uuid4

IDs de anexos de ficheiros previamente carregados para incluir como contexto visual. Máximo 15 por pedido. Tipos de entrada aceites: imagens (JPEG, PNG, GIF, WebP) e PDF. Outros tipos de ficheiros são rejeitados no momento do carregamento. Em conversas com múltiplas voltas, os 5 ficheiros gerados pelo LLM mais recentes são automaticamente reproduzidos como contexto; apenas imagens e PDFs são reproduzidos devido a limitações da infraestrutura do serviço LLM.

Modo de Geração de Ficheiros
file_generation string
ID da conexão
connection_id string

ID da ligação do Office 365 a usar. É obrigatório apenas para OFFICE365 fonte. Se for omitido, é usada a primeira ligação correspondente.

Fuso Horário
time_zone string

Identificador de fuso horário IANA para consultas datas (por exemplo, America/Los_Angeles, UTC).

Valores de Ativação
enable_figures boolean

Quando verdade, figuras de documentos recuperadas (gráficos, imagens) são incluídas como contexto visual. Até 8 dígitos no total (máximo 4 por documento).

Store
store boolean

Quando é verdade, a conversa é mantida no histórico de conversas, permitindo seguimentos com múltiplos turnos. Definido como falso para consultas sem estado, pontuais.

AtribuiçãoCampo
Include string

Campos do DocumentInfo elegíveis para inclusão nas respostas da Fonte.

Cada valor é um caminho de notação de pontos enraizado no DocumentInfo. Cada caminho deve ser resolvido para um campo anotado com attribution_eligible = Verdadeiro.

BoundCoordinateFormat
bound_coordinate_format string
Ativado
enabled boolean

Ativa os eventos de progresso durante o streaming.

RespostaDetalheEvento
detail string
Atualizações da Resposta
answer_updates boolean

Transmita a resposta agentical à medida que está escrita, como frames que transportam um answer_update (acrescentar, depois completar ou falhar) em vez de um frame final. O cliente deve aplicar essas operações. Ignorado por pedidos não relacionados com streaming e sem agência.

Exchange Id
exchange_id string

O identificador do cliente desta troca dentro da conversa. Armazenado com a troca e devolvido no histórico do chat, para que um cliente possa conciliar o seu turno local com o registo: a mesma pergunta feita duas vezes gera duas trocas, e só o id os distingue.

Devoluções

QAInferenceResponse
QAInferenceResponse

Listar anexos

Listar anexos.

Devoluções

Anexos da Lista de Respostas
array of AttachmentResponse

Listar coleções

Liste as coleções a que o utilizador pode aceder.

Parâmetros

Nome Chave Obrigatório Tipo Descriçã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-100)

Encomendar por
order_by string

Campo pelo qual ordenar os resultados.

Value Ordenar por
name Nome de exibição da coleção (por defeito)
created_at Data e hora de criação
modified_at Carimbo temporal da última modificação
Ascendente
asc boolean

Ordenar por ordem crescente se true, descendente se false.

Nome contém
infix string

Termo de pesquisa para o nome da coleção (correspondência parcial insensível a maiúsculas e maiúsculas).

Filtrar
filter_constraint string

Filtrar as coleções por propriedade ou âmbito.

Value Returns
created_by:me Coleções que criaste
shared_by:me Coleções que partilhou com outros
shared_by:others Coleções que outros partilharam consigo
scope:org Todas as coleções da sua organização (apenas administradores da organização)
scope:system Todas as coleções em todas as organizações (apenas administrador de sistemas)

Devoluções

Página da Coleção.
CollectionPage

Listar documentos

Liste os documentos numa coleção.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID da coleção
collection_id True string

Identificador único 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-100)

Encomendar por
order_by string

Campo pelo qual ordenar os resultados.

Value Ordenar por
document_name Nome do ficheiro do documento (por defeito)
updated_at Carimbo temporal da última modificação
upload_status Estado do processamento
uploaded_at Carimbo temporal de upload
uploaded_by Carregador
Ascendente
asc boolean

Ordenar por ordem crescente se true, descendente se false.

Nome contém
infix string

Termo de pesquisa para o nome do documento (correspondência parcial insensível a maiúsculas e minúsculas).

Tipo de fonte
source_type string

Restringa os resultados a documentos com esta fonte de origem. Documentos sem metadados de origem são excluídos quando este filtro é definido.

Devoluções

InfoPageApiResponse
InfoPageApiResponse

Obter anexo

Obtém um único anexo pelo UUID.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do anexo
attachment_id True uuid

UUID do anexo

Devoluções

AttachmentResponse
AttachmentResponse

Obter coleção

Obtenha uma única coleção pelo UUID.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID da coleção
collection_id True string

Identificador único da coleção

Devoluções

Detalhes completos da coleção, incluindo metadados, permissões e estado.

NamespaceResponse
NamespaceResponse

Obter ficheiro anexo

Descarregue o conteúdo do ficheiro de um anexo pelo seu UUID.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do anexo
attachment_id True uuid

UUID do anexo

Obter ficheiro de documentos

Obtenha os metadados e o conteúdo de um único documento pelo seu UUID.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
document_id True uuid

UUID do documento

Nome do ficheiro do artefacto
filename string

Artefacto armazenado específico para recuperar. Se for omitido, a entrega atual do documento é devolvida.

Devoluções

response
binary

Obter o status do documento

Obtenha o estado de indexação de um único documento pelo seu UUID.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
ID do documento
document_id True uuid

UUID do documento

Devoluções

Informações do documento
DocumentInfoApiResponse

Pesquise documentos (paginados)

Pesquise entre documentos numa coleção com resultados classificados paginados.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
Namespace do documento
document_namespace True string

O nome da coleção dos documentos para pesquisar.

Filtrar por
filter_by True string

Consulta de pesquisa por palavras-chave para filtrar documentos por conteúdo ou metadados.

IDs do documento
document_ids array of string

Lista de IDs específicos de documentos para restringir a pesquisa. Máximo de 1000 IDs de Documento.

Key
key True string

Identificador de tag. Apenas caracteres alfanuméricos e hífens.

Value
value True string

Valor da tag. Apenas caracteres alfanuméricos e hífens.

Tamanho da Página
page_size integer

O número de resultados a serem retornados por página. A pesquisa não paginada retorna sempre page_size de 10000.

Ordenar por
order_by string

O campo para ordenar os resultados.

Asc
asc boolean

Ordem de ordenação: Verdadeiro para ascendência, Falso para descida.

Ordem de Paginação
pagination_order string

Determina se recebe a página seguinte ou a página anterior dos resultados.

Chave Paginada
paginated_key string

Uma chave usada para paginação.

Devoluções

PaginadoPesquisaApiResposta
PaginatedSearchApiResponse

Resumir documentos

Gere um resumo de um ou mais documentos de uma coleção.

Parâmetros

Nome Chave Obrigatório Tipo Descrição
IDs do documento
document_ids True array of string

UUIDs de documentos específicos para resumir. Máximo 10 documentos por pedido.

Namespace do documento
document_namespace True string

Espaço de nomes da coleção que contém os documentos.

Devoluções

Resumo de Respostas
array of SummarizationResponse

Definições

RespostaResultado

Uma resposta é o resultado: nenhuma, completa ou incompleta com o código do que a resolveu.

Nome Caminho Tipo Descrição
Status
status string

Se existe uma resposta e se a 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 está completo.

RespostaAtualização

Uma operação na resposta que um cliente de streaming mostra: adicionar, concluir ou falhar.

complete é incompleto quando reason está definido; fail carrega um código de falha e nunca retira o texto mostrado.

Nome Caminho Tipo Descrição
Funcionamento
operation string
Reason
reason string

Apenas no terminal: o código de interrupção ao completar (por exemplo, response_truncated_deadline), o código de falha ao falhar (ex. budget_exhausted, save_failed).

Persistência
persistence Persistence

Se uma troca está registada; unknown significa que o commit pode ter ocorrido.

AttachmentErrorCode

Códigos de erro para carregamento falhado de anexos.

Códigos de erro para carregamento falhado de anexos.

AttachmentErrorCode
string

AttachmentResponse

Nome Caminho Tipo Descrição
ID do anexo
attachment_id string
Nome do anexo
attachment_name string
Tipo de mímica de anexo
attachment_mime_type string

Tipo MIME de imagem (ex.: image/png)

Soma de Verificação de Anexo
attachment_checksum string

Soma de verificação MD5 dos bytes da imagem

Tamanho do anexo
attachment_size integer

Tamanho da imagem em bytes

Estado do anexo
attachment_status string

AttachmentUploadError

Detalhes de falha legíveis por máquina para um único carregamento de anexo.

Nome Caminho Tipo Descrição
AttachmentErrorCode
code AttachmentErrorCode

Códigos de erro para carregamento falhado de anexos.

Message
message string
Size
size integer
Tipo de mímica
mime_type string

AttachmentUploadItem

O resultado unificado por ficheiro resulta na resposta de upload de anexos v2.

Nome Caminho Tipo Descrição
Nome do ficheiro
filename string
AnexoUploadItemStatus
status AttachmentUploadItemStatus

Estado por ficheiro para respostas de upload em lote de anexos v2.

Código de estado
status_code integer
AttachmentResponse
attachment AttachmentResponse
AttachmentUploadError
error AttachmentUploadError

Detalhes de falha legíveis por máquina para um único carregamento de anexo.

AnexoUploadItemStatus

Estado por ficheiro para respostas de upload em lote de anexos v2.

Estado por ficheiro para respostas de upload em lote de anexos v2.

AnexoUploadItemStatus
string

AttachmentUploadsResposta

Resposta API para carregamentos lotados de anexos v2.

Nome Caminho Tipo Descrição
Uploads
uploads array of AttachmentUploadItem

Página da Coleção.

Nome Caminho Tipo Descrição
Página
page integer

Número de 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 que correspondem à consulta.

Ordenar por
order_by string

Campo usado para ordenar resultados.

Asc
asc boolean

Se os resultados estão ordenados por ordem crescente.

Páginas
pages array of Namespace

Lista de coleções na página atual.

DeleteDocumentResponse

Nome Caminho Tipo Descrição
Informações
details array of DocumentDeletionStatus

Resultados de eliminação por documento.

DocumentDeletionStatus

Nome Caminho Tipo Descrição
ID do documento
document_id string

UUID do documento.

Status
status Status
Message
message string

Mensagem legível para humanos a descrever o resultado.

DocumentInfoApiResponse

Nome Caminho Tipo Descrição
ID do documento
document_id string

UUID do documento.

Nome do documento
document_name string

Nome de exibição do documento (normalmente o nome original do ficheiro).

Caminho do Documento
document_path string

Caminho de armazenamento do documento dentro do sistema.

Namespace do documento
document_namespace string

Espaço de nomes da coleção a que este documento pertence.

ID do Espaço de Nomes do Documento
document_namespace_id string

UUID da coleção a que o documento pertence.

Descrição do Documento
document_description string

Descrição fornecida pelo utilizador do documento.

Enviado por
uploaded_by string

Endereço de email da pessoa que carregou o documento. Nulo quando não há email disponível para quem faz upload.

Estado do Carregamento
upload_status string

Estado atual de upload/processamento.

Value Meaning
UPLOADED Ficheiro recebido, à espera de processamento
IN_PROGRESS O processamento já começou
CONVERTING Conversão para formato indexável
INDEXING Índice de pesquisa de edifícios
COMPLETE Pronto para consultas
FAILED Falha no processamento
Soma de verificação
checksum string

Soma de verificação SHA-256 do ficheiro do documento para verificação de integridade.

Tipo de mímica
mime_type string

Tipo MIME do documento original.

Tipo de Mimo de Interpretação
rendition_mime_type string

Tipo MIME da versão cliente; fontes externas usam text/uri-list.

Tipo de fonte
source_type string

Fonte originária deste documento: SHAREPOINT, SHAREPOINT_SITE, GOOGLE_DRIVE, ou UPLOAD. null para documentos sem metadados de origem.

DocumentStatus
status DocumentStatus
Carregado em
uploaded_at date-time

Carimbo temporal quando o documento foi carregado (formato ISO 8601).

Atualizado em
updated_at date-time

Carimbo temporal da última atualização do registo do documento, se existir.

É suprimido
is_deleted boolean

Se o documento foi apagado de forma automática.

DocumentMetadata
document_metadata DocumentMetadata

DocumentMetadata

Nome Caminho Tipo Descrição
Permissões
permissions
Etiquetas de Documento
document_tags array of DocumentTag
Metadados de Origem
source_metadata
IngestãoMetadados
ingestion_metadata IngestionMetadata

DocumentStatus

Nome Caminho Tipo Descrição
Status
status string
Código de Erro
error_code string

Etiqueta do Documento

Nome Caminho Tipo Descrição
Key
key string

Identificador de tag. Apenas caracteres alfanuméricos e hífens.

Value
value string

Valor da tag. Apenas caracteres alfanuméricos e hífens.

InfoPageApiResponse

Nome Caminho Tipo Descrição
Página
page integer

Número de página atual (baseado em 1).

Size
size integer

Número de itens por página.

Total
total integer

Número total de documentos que correspondem à consulta.

Ordenar por
order_by string

Campo usado para ordenar resultados.

Asc
asc boolean

Se os resultados estão ordenados por ordem crescente.

Páginas
pages array of DocumentInfoApiResponse

Lista de documentos na página atual.

IngestãoMetadados

Nome Caminho Tipo Descrição
Pontuação de Confiança
confidence_score number
OCR
ocr boolean
Personagens Más
bad_characters boolean
Encontrei Folhas Escondidas
found_hidden_sheets boolean
Encontrei folhas muito escondidas
found_very_hidden_sheets boolean
Encontrei Folhas Escondidas Protegidas
found_protected_hidden_sheets boolean
Folhas Ocultas Ativadas
enabled_hidden_sheets boolean
Ativaram Folhas Muito Ocultas
enabled_very_hidden_sheets boolean
Data de Criação do Documento
document_created_date date-time

Namespace

Nome Caminho Tipo Descrição
Namespace
namespace string

Identificador exclusivo da coleção. Por defeito é UUID. Usa-o como um ID externo.

Name
name string

Nome de exibição opcional para a coleção. É obrigatório se não for fornecido 'namespace'.

Description
description string

Descrição legível para 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 de usuário
created_by_user_id string

ID de utilizador do criador da coleção.

É público
is_public boolean

Se a coleção é acessível ao público.

Ler Utilizadores
read_users array of string

Lista de IDs de utilizador com acesso de leitura.

Utilizadores de Escrita
write_users array of string

Lista de IDs de utilizador com acesso de escrita.

Grupos de Leitura
read_groups array of string

Lista de IDs de grupo com acesso de leitura.

Grupos de Escrita
write_groups array of string

Lista de IDs de grupo com acesso de escrita.

Metadata
metadata object

Metadados adicionais associados à coleção.

Versão
version string

Versão API da coleção.

ID de espaço de nomes
namespace_id string

Identificador exclusivo da coleção.

Criado em
created_at date-time

Carimbo temporal em que a coleção foi criada.

Modificado em
modified_at date-time

Carimbo temporal da última modificação da coleção.

É suprimido
is_deleted boolean

Se a coleção foi apagada de forma suave.

Está ativo
is_active boolean

Se a coleção está atualmente ativa.

Contagem de documentos
doc_count integer

Contagem de documentos para o namespace. Expose como propriedade de topo para namespace, a partir de metadata.doc_count

NamespaceResponse

Detalhes completos da coleção, incluindo metadados, permissões e estado.

Nome Caminho Tipo Descrição
ID de espaço de nomes
namespace_id string

Identificador exclusivo da coleção.

Namespace
namespace string

Identificador seguro de URL usado em chamadas API.

Name
name string

Nome para exibição da coleção.

Description
description string

Descrição legível para 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 de utilizador do criador da coleção.

É público
is_public boolean

Se a coleção é acessível ao público.

Ler Utilizadores
read_users array of string

Lista de IDs de utilizador com acesso de leitura.

Utilizadores de Escrita
write_users array of string

Lista de IDs de utilizador com acesso de escrita.

Grupos de Leitura
read_groups array of string

Lista de IDs de grupo com acesso de leitura.

Grupos de Escrita
write_groups array of string

Lista de IDs de grupo com acesso de escrita.

Ações Escritas Rejeitadas
rejected_write_shares array of string

Utilizadores de partilha de escrita sem direito

Metadata
metadata object

Metadados adicionais associados à coleção.

Versão
version string

Versão da API para esta resposta.

Criado em
created_at date-time

Carimbo temporal em que a coleção foi criada.

Modificado em
modified_at date-time

Carimbo temporal da última modificação da coleção.

É suprimido
is_deleted boolean

Se a coleção foi apagada de forma suave.

Está ativo
is_active boolean

Se a coleção está atualmente ativa.

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 utilizador que criou a coleção.

PaginadoPesquisaApiResposta

Nome Caminho Tipo Descrição
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 opaco. Passe este valor em pedidos subsequentes para recuperar a página seguinte ou anterior.

Persistência

Se uma troca está registada; unknown significa que o commit pode ter ocorrido.

Se uma troca está registada; unknown significa que o commit pode ter ocorrido.

Persistência
string

QAInferenceResponse

Nome Caminho Tipo Descrição
Texto gerado
generated_text string

A resposta gerada por IA em formato Markdown.

Source
source object

Documentos fonte referenciados na resposta, codificados por marcadores numéricos de citação (por exemplo, 1, 2). As citações aparecem no texto gerado como [1], [2], etc.

Stream Concluído
stream_complete boolean

Indica se a resposta ao streaming terminou. É sempre verdade para respostas que não são streaming.

Opções de Fonte
source_options array of SourceOptions

Os tipos de fontes de resposta que foram usados para gerar esta resposta.

Anexos
attachments array of uuid4

IDs de anexos de ficheiros gerados por LLM (por exemplo, CSV, XLSX, JSON, PDF, imagens) que acompanham a resposta. Os tipos de saída suportados incluem formatos de texto, folhas de cálculo, documentos e imagens. Em conversas com múltiplas voltas, os 5 ficheiros gerados mais recentes são automaticamente reproduzidos para o modelo; apenas imagens e PDFs são reproduzidos como entrada do LLM devido a limitações da infraestrutura do serviço LLM.

Resumo do Raciocínio
reasoning_summary string

Um resumo do processo de raciocínio da IA, incluído quando o modo de raciocínio está ativado.

ResponseEvent
response_event ResponseEvent
RespostaAtualização
answer_update AnswerUpdate

Uma operação na resposta que um cliente de streaming mostra: adicionar, concluir ou falhar.

complete é incompleto quando reason está definido; fail carrega um código de falha e nunca retira o texto mostrado.

RespostaResultado
answer_outcome AnswerOutcome

Uma resposta é o resultado: nenhuma, completa ou incompleta com o código do que a resolveu.

ResponseEvent

Nome Caminho Tipo Descrição
Tipo
type string

Identificador de evento com espaço de nomes de pontos seguindo o padrão response.status.{phase}.{state}. Eventos do ciclo de vida: response.created, response.in_progress, response.error. Eventos de estado: context.loading (carregar o histórico de conversas para perguntas de seguimento), question.analyzing (compreender a pergunta), documents.searching (pesquisar na coleção por documentos relevantes), documents.found (recuperação completa, documentos identificados), sources.linking (mapear evidências de resposta para documentos de origem), figures.analyzing (analisar figuras e gráficos do documento), context.preparing (montar o contexto do documento para o modelo), answer.generating (o modelo está a gerar a resposta), answer.streaming (primeiro token de resposta recebido, fluxo em curso).

Message
message string

Texto de progresso voltado para o utilizador que descreve a etapa de processamento atual.

Meta
meta object

Metadados estruturados para o evento. Campos comuns: collection_names (lista de nomes de exibição da coleção), doc_count (número de documentos encontrados), question (o texto da pergunta analisada), document_names (nomes de documentos solicitados específicos), is_follow_up (verdade para perguntas de seguimento com vários turnos).

Criado em
created_at string

Carimbo temporal ISO 8601 UTC de quando este evento foi produzido.

SourceOptions

SourceOptions
string

Status

Status
string

ResumiçãoResposta

Nome Caminho Tipo Descrição
Resumo
summary string

O resumo do documento gerado por IA em formato Markdown.

Source
source object

Documentos fonte usados para produzir o resumo, codificados por marcador numérico de citação.

UploadDocumentResponse

Resposta devolvida para cada documento carregado.

Nome Caminho Tipo Descrição
ID do Utilizador
user_id string

ID do utilizador que carregou o documento.

ID do documento
document_id string

Identificador único atribuído ao documento carregado.

Nome do documento
document_name string

Nome original do ficheiro do documento carregado.

Namespace do documento
document_namespace string

Namespace (identificador da coleção) a que pertence o documento.

ID do Espaço de Nomes do Documento
document_namespace_id string

UUID da coleção a que o documento pertence.

Status
status string

Processamento do estado do documento carregado.

Tipo de conteúdo
content_type string

Tipo MIME do documento carregado.

binário

Este é o tipo de dados básico 'binário'.