Documents Plugin

Search the organization knowledge (hybrid lexical + vector, RRF).

POST

http://localhost:3000/api/plugins/docs/knowledge/search

curl -X POST 'http://localhost:3000/api/plugins/docs/knowledge/search' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "query": "string",
  "topK": 1,
  "documentIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "kinds": [
    "string"
  ],
  "entity": "Broadcast",
  "entityId": "string"
}'

const body = `{
  "query": "string",
  "topK": 1,
  "documentIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "kinds": [
    "string"
  ],
  "entity": "Broadcast",
  "entityId": "string"
}`;

const response = await fetch('http://localhost:3000/api/plugins/docs/knowledge/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "query": "string",
  "topK": 1,
  "documentIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "kinds": [
    "string"
  ],
  "entity": "Broadcast",
  "entityId": "string"
}'''

response = requests.post(
    'http://localhost:3000/api/plugins/docs/knowledge/search',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "query": "string",
  "topK": 1,
  "documentIds": [
    "string"
  ],
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "kinds": [
    "string"
  ],
  "entity": "Broadcast",
  "entityId": "string"
}

Body

application/json

querystringrequired

The search query (2–500 characters)

topKnumber[1, 12]

documentIdsArray<string>

categoryIdsArray<string>

tagIdsArray<string>

kindsArray<string>

entitystringBroadcastCandidateCommentContactCurrencyDailyPlanDashboardDashboardWidgetDocumentEmployeeExpenseInvoiceIncomeLanguageOrganizationOrganizationContactOrganizationDepartmentOrganizationDocumentOrganizationProjectOrganizationTeamOrganizationProjectModuleOrganizationSprintOrganizationVendorResourceLinkScreeningTaskOrganizationStrategicInitiativeTaskTaskLinkedIssueTaskViewUserTenant

entityIdstring

Response

200OK

Ranked chunk hits with citation locators.

Stack Overflow Website Demo