Suggestions

SuggestionsResource

class SuggestionsResource(http: HttpClient, config: ModusConfig)

Bases: object List suggested questions and record suggestion events.

list()

list(*, page_size: int = 5, page_token: str | None = None, scope_id: int | None = None, scope_ids: Sequence[int] | None = None) → Page[SuggestionQuestionDto]

List approved suggested questions for the caller organization.

Parameters:
- page_size – Maximum number of suggestions to return.
- page_token – Cursor from a previous page, if any.
- scope_id – Optional single scope id filter.
- scope_ids – Optional multi-scope id filter (comma-joined on the wire).

record_event()

record_event(suggestion_id: str, *, event_type: SuggestionEventType | str, source: SuggestionEventSource | str | None = None, skill_id: int | None = None, thread_id: str | None = None, metadata: Mapping[str, Any] | None = None) → None

Record that a suggested question was shown, clicked, dismissed, or submitted.

AsyncSuggestionsResource

class AsyncSuggestionsResource(http: AsyncHttpClient, config: ModusConfig)

Bases: object Async suggested-question APIs.

list()

async list(*, page_size: int = 5, page_token: str | None = None, scope_id: int | None = None, scope_ids: Sequence[int] | None = None) → AsyncPage[SuggestionQuestionDto]

List approved suggested questions for the caller organization.

Parameters:
- page_size – Maximum number of suggestions to return.
- page_token – Cursor from a previous page, if any.
- scope_id – Optional single scope id filter.
- scope_ids – Optional multi-scope id filter (comma-joined on the wire).

record_event()

async record_event(suggestion_id: str, *, event_type: SuggestionEventType | str, source: SuggestionEventSource | str | None = None, skill_id: int | None = None, thread_id: str | None = None, metadata: Mapping[str, Any] | None = None) → None

Record that a suggested question was shown, clicked, dismissed, or submitted.

Types

Errors

Getting Started

API Reference

SuggestionsResource

list()

record_event()

AsyncSuggestionsResource

list()

record_event()

​SuggestionsResource

​list()

​record_event()

​AsyncSuggestionsResource

​list()

​record_event()

SuggestionsResource

list()

record_event()

AsyncSuggestionsResource

list()

record_event()