Search knowledge base

GET

/v1/convai/knowledge-base/search

GET

/v1/convai/knowledge-base/search

curl -G https://api.elevenlabs.io/v1/convai/knowledge-base/search \
     -d cursor=cursor \
     -d page_size=1 \
     -d query=query \
     -d types=file

{
  "results": [
    {
      "document": {
        "type": "file",
        "access_info": {
          "is_creator": true,
          "creator_name": "John Doe",
          "creator_email": "john.doe@example.com",
          "role": "admin",
          "access_source": "creator"
        },
        "id": "id",
        "metadata": {
          "created_at_unix_secs": 1,
          "last_updated_at_unix_secs": 1,
          "size_bytes": 1
        },
        "name": "name",
        "supported_usages": [
          "prompt"
        ],
        "dependent_agents": [
          {
            "type": "available",
            "access_level": "admin",
            "created_at_unix_secs": 1,
            "id": "id",
            "name": "name"
          }
        ]
      },
      "score": 1.1,
      "search_snippet": [
        {
          "value": "value",
          "is_hit": true
        }
      ]
    }
  ],
  "next_cursor": "next_cursor"
}

Fuzzy text search over knowledge base document content

クエリパラメータ

querystring必須

The search query text

page_sizeintegerオプション1-100デフォルト値 30

How many documents to return at maximum. Can not exceed 100, defaults to 30.

typesenumオプション

If present, the endpoint will return only documents of the given types.

許可された値:

cursorstringオプション

Used for fetching next page. Cursor is returned in the response.

レスポンス

Successful Response

resultslist of objects

next_cursorstringオプション

エラー

422

Knowledge Base Search Request Unprocessable Entity Error

ヘッダー

クエリパラメータ

レスポンス

エラー