`helpjuice.api.search`

Helpjuice Search API.

https://help.helpjuice.com/en_US/api-v3/api-v3#search

Module Contents

Classes

`SearchResult`	Search result resource.
`Search`	Search result resource collection.

class helpjuice.api.search.SearchResult

Bases: helpjuice.api.article.Article

Search result resource.

Identifier of the article.

Type: int

name

Name of the article.

Type: str

slug

URL slug of the article.

Type: str

tag_names

Tag names of the article.

Type: list

answer_sample

Short answer of the article in a few words.

Type: str

long_answer_sample

Longer answer of the article but not a full article.

Type: str

categories

Categories that the article will appear in.

Type: dict

last_published_date

Last published date of the article.

Type: str

last_published_user_name

Last publisher of the article.

Type: str

is_published

Whether the article is published or not.

Type: bool

is_internal

Whether the article is internal or not.

Type: bool

url

Url of the article.

Type: str

class helpjuice.api.search.Search

Bases: helpjuice.api.schema.Collection

Search result resource collection.

https://help.helpjuice.com/en_US/api-v3/api-v3#search

resource

get(query, *args, **kwargs)

Search the Knowledge Base.

https://help.helpjuice.com/en_US/api-v3/api-v3#search-the-knowledge-base

Parameters: query (str) – Search query.
Returns: Search results.
Return type: helpjuice.api.Search