Pesquisar conteúdo da base de conhecimento

{
  "results": [
    {
      "document": {
        "access_info": {
          "access_source": "creator",
          "creator_email": "john.doe@example.com",
          "creator_name": "John Doe",
          "is_creator": true,
          "role": "admin"
        },
        "auto_sync_info": {
          "auto_discover": false,
          "auto_remove": false,
          "consec_failures": 0,
          "minimum_frequency_days": 7,
          "next_refresh_by": 1
        },
        "dependent_agents": [
          {
            "access_level": "admin",
            "created_at_unix_secs": 1,
            "id": "string",
            "name": "string",
            "referenced_resource_ids": [
              "string"
            ],
            "type": "available"
          }
        ],
        "folder_parent_id": "string",
        "folder_path": [
          {
            "id": "string"
          }
        ],
        "id": "string",
        "metadata": {
          "created_at_unix_secs": 1,
          "last_updated_at_unix_secs": 1,
          "size_bytes": 1
        },
        "name": "string",
        "supported_usages": [
          "auto"
        ],
        "type": "string",
        "url": "string"
      },
      "score": 1.1,
      "search_snippet": [
        {
          "value": "string",
          "is_hit": true
        }
      ]
    }
  ],
  "next_cursor": "string"
}

Pesquisa de texto aproximada no conteúdo de documentos da base de conhecimento

Parâmetros de consulta

querystringObrigatório

O texto da consulta de pesquisa

page_sizeintegerOpcional1-100Padrão é 30

Quantidade máxima de documentos a retornar. Não pode exceder 100; o padrão é 30.

typeslist of enums or nullOpcional

Se presente, o endpoint retornará apenas documentos dos tipos informados.

Valores permitidos:

cursorstring or nullOpcional

Usado para buscar a próxima página. O cursor é retornado na resposta.

Resposta

Resposta bem-sucedida

resultslist of objects

next_cursorstring or nullOpcional

Erros

422

Unprocessable Entity Error

Cabeçalhos

Parâmetros de consulta

Resposta

Erros