Nesta página
> recursos > documentação > api > Referência da API: Pesquisa

Referência da API: Pesquisa

O endpoint de pesquisa realiza uma pesquisa global (semântica) no conteúdo do ambiente.

Pesquisa global nas funções, processos, elementos, documentação, versões e comentários do ambiente

Limitado por ambiente; uma resposta 429 contém o corpo de mensagem compartilhado ({“message”: “Muitas solicitações de pesquisa. Diminua o ritmo.”}).

Endpoint: POST /v1/tenant/{tenantId}/search

Autenticação: Chave de API com escopo do ambiente · escopo read

Parâmetros:

Nome Tipo Localização Obrigatório Descrição
tenantId string path Sim Formato: uuid

Corpo da solicitação:

{
	"query": "string",
	"mode": "semantic",
	"categories": [
		"role"
	],
	"processId": "00000000-0000-0000-0000-000000000000",
	"k": 0
}
Campo Tipo Obrigatório Descrição
query string Sim Consulta de pesquisa
Comprimento máximo: 1000
mode semantic | exact | hybrid Não semantic = embeddings, exact = literal, hybrid = ambos
Valores permitidos: semantic, exact, hybrid
Padrão: hybrid
categories role | process | element | documentation | version | comment[] Não Restringir os resultados a estas categorias
processId string Não Restringir os resultados a um único processo
Formato: uuid
k integer Não Número de resultados a retornar
Padrão: 20
Mínimo: 1
Máximo: 50

Resposta (200):

Resultados da pesquisa (ocorrências, contagens, total, sugestões)

{
	"hits": [
		{
			"category": "role",
			"entityType": "role",
			"entityId": "string",
			"subKey": "string",
			"title": "string",
			"snippet": "string",
			"score": 0,
			"processId": "00000000-0000-0000-0000-000000000000",
			"processDisplayName": "string",
			"elementType": "string",
			"docSection": "string",
			"url": "string"
		}
	],
	"counts": {},
	"total": 0,
	"suggestions": [
		"string"
	]
}
Campo Tipo Obrigatório Descrição
hits object[] Sim
counts object Sim
total number Sim
suggestions string[] Sim

Erros:

  • 401 Chave de API ausente, inválida, desativada ou expirada
  • 429 Limite de taxa atingido: consulte o limite de taxa documentado do endpoint

Documentação relacionada