Registros são os trechos de texto que compõem um conhecimento.
Criar registro
Adiciona um texto ao conhecimento. Textos longos são divididos automaticamente em vários registros, conforme o tamanho máximo de registro do conhecimento (padrão de 512 tokens).
A resposta não traz o ID do registro; para obtê-lo, use [Listar registros].
path Parameters
conhecimentoidstring · requiredID do conhecimento.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
namestring · requiredNome do registro.
topicstring · requiredAssunto do registro.
textstring · requiredConteúdo.
Responses
Registro criado.
messagestring · required
Listar registros
Lista os registros do conhecimento. Para paginar, informe limit e, nas páginas seguintes, reenvie cursor, currentPage, total e totalPages. Com search, a busca é por semelhança de significado e devolve uma única página.
Registros sem indexação vêm com o nome prefixado por [falha].
path Parameters
conhecimentoidstring · requiredID do conhecimento.
query Parameters
limitinteger · min: 0Itens por página. Sem
limit(ou0), vêm todos.cursorstringValor de
cursorrecebido na página anterior. Omita na primeira requisição.currentPageinteger · min: 1Valor de
currentPagerecebido na página anterior. Envie junto comcursor; a resposta devolve o número seguinte.totalinteger · min: 0Valor de
totalrecebido na primeira página. Reenvie junto comcursorpara a resposta continuar informando o total.totalPagesinteger · min: 0Valor de
totalPagesrecebido na primeira página. Reenvie junto comcursor.filestringSó os registros gerados a partir deste arquivo (ID do arquivo).
statusstring · enumokpara registros indexados,falhapara os sem indexação.Enum values:okfalhasearchstringBusca por semelhança de significado.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Lista de registros.
totalinteger | nulllimitintegercurrentPageinteger | nulltotalPagesinteger | nullcursorstringCursor da próxima página; vazio quando não há mais.
maxtokensintegerTamanho máximo de registro do conhecimento, em tokens.
recordsobject[]
Excluir registro
Exclui um registro do conhecimento.
Atenção: o status de sucesso é
210.
path Parameters
conhecimentoidstring · requiredID do conhecimento.
recordidstring · requiredID do registro.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Registro excluído.
messagestring · required