Security AI Assistant API
Finds Knowledge Base Entries that match the given query.
Spaces method and path for this operation:
<div><span class="operation-verb get">get</span> <span class="operation-path">/s/{space_id}/api/security_ai_assistant/knowledge_base/entries/_find</span></div>Refer to Spaces for more information.
Finds Knowledge Base Entries that match the given query.
get/api/security_ai_assistant/knowledge_base/entries/_find
Query parameters
fieldsstring[]
A list of fields to include in the response. If not provided, all fields will be included.
[ "name", "created_at" ]
filterstring
Example:error handling
Search query to filter Knowledge Base Entries by specific criteria.
sort_field'created_at' | 'is_default' | 'title' | 'updated_at'
Fields available for sorting Knowledge Base Entries.
Example:title
Field to sort the Knowledge Base Entries by.
sort_order'asc' | 'desc'
The order in which results are sorted.
Example:asc
Sort order for the results, either asc or desc.
pageinteger
Example:2
Page number for paginated results. Defaults to 1.
per_pageinteger
Example:10
Number of Knowledge Base Entries to return per page. Defaults to 20.
Response
Successful response containing the paginated Knowledge Base Entries.
Example response
{
"data": [
{
"name": "Example Entry",
"namespace": "default",
"users": [
{
"id": "user123",
"name": "John Doe"
}
],
"createdAt": "2023-01-01T12:00:00Z",
"createdBy": "admin",
"id": "I am a string",
"updatedAt": "2023-01-02T12:00:00Z",
"updatedBy": "editor",
"kbResource": "security_labs",
"source": "/documents/example.txt",
"text": "This is the content of the document.",
"type": "document",
"vector": {
"modelId": "bert-base-uncased",
"tokens": {
"token1": 0.123,
"token2": 0.456
}
}
}
],
"page": 1,
"perPage": 20,
"total": 100
}