Recommendations

A recommendation is a group of articles NeetoKB suggests for a given page, used to surface contextual help. For fields and response details, see the API reference.

List recommendations

This command returns the recommended articles for a page. Use this when you want to preview what your in-app help widget would show for a URL, or to build your own contextual help surface.

neetokb recommendations list
neetokb recommendations list --match-uri feedback

Flag	Type	Default	Description
`--match-uri`	`string`		Filter recommendations by URI
`--page`	`int`	`0`	Page number
`--page-size`	`int`	`0`	Items per page (max 100)

--match-uri is the relative or full URL of the page you want suggestions for. Omit it to get the default recommendations.

Sample output (--json)

{
  "data": [
    {
      "title": "Feedback",
      "articles": [
        {
          "id": "a1b2c3d4-1111-2222-3333-444455556666",
          "title": "Collecting customer feedback",
          "category": {
            "id": "b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a",
            "name": "Getting Started"
          }
        }
      ]
    }
  ],
  "breadcrumbs": [
    { "label": "List articles", "command": "neetokb articles list" }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

Each entry is a titled group holding the articles recommended for it. Pass an article id to neetokb articles show to read the full content.

Show a recommendation

This command shows a recommendation with the articles and categories it points to.

neetokb recommendations show 6f0c3e84-d12a-4b79-9e58-a1b7c4d2e093

Required arguments:

<id> - Recommendation ID from recommendations list

Create a recommendation

This command creates a recommendation that suggests articles or categories on pages whose URL matches. Changing recommendations needs the Manage recommendations permission.

neetokb recommendations create --title Refunds --url /refund \
  --entity Article:a1b2c3d4-1111-2222-3333-444455556666 \
  --entity Category:b7e91c2a-8f43-4d0e-9a15-6c2d8e7f1b3a

Flag	Type	Required	Default	Description
`--entity`	`stringArray`		`[]`	Article or category to recommend as Article:<id> or Category:<id>; repeat for several
`--matching-criteria`	`string`			How the URL is matched: contains, exact_match or regex
`--title`	`string`	Yes		Recommendation title, unique ignoring case
`--url`	`string`	Yes		URL or regular expression the recommendation applies to

--matching-criteria takes contains (the default), exact_match or regex. With regex, --url must be a valid regular expression. The title and the URL are each unique in the workspace.

Update a recommendation

This command changes a recommendation. Only the flags you pass change.

neetokb recommendations update 6f0c3e84-d12a-4b79-9e58-a1b7c4d2e093 --url /refunds
neetokb recommendations update 6f0c3e84-d12a-4b79-9e58-a1b7c4d2e093 --clear-entities

Required arguments:

<id> - Recommendation ID from recommendations list

Flag	Type	Default	Description
`--clear-entities`	`bool`	`false`	Remove all entities from the recommendation
`--entity`	`stringArray`	`[]`	Article or category to recommend as Article:<id> or Category:<id>; repeat for several
`--matching-criteria`	`string`		How the URL is matched: contains, exact_match or regex
`--title`	`string`		Recommendation title, unique ignoring case
`--url`	`string`		URL or regular expression the recommendation applies to

--entity replaces all entities. --clear-entities removes them all. Leave both out to keep them.

Delete a recommendation

This command deletes a recommendation.

neetokb recommendations delete 6f0c3e84-d12a-4b79-9e58-a1b7c4d2e093

Required arguments:

<id> - Recommendation ID from recommendations list

Getting started

Commands

List recommendations

Show a recommendation

Create a recommendation

Update a recommendation

Delete a recommendation

​List recommendations

​Show a recommendation

​Create a recommendation

​Update a recommendation

​Delete a recommendation

List recommendations

Show a recommendation

Create a recommendation

Update a recommendation

Delete a recommendation