InsightsResource

Insight API methods.

Functions

constructor__init__(client) -> None

Initialize the resource.

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(agent_id, insights, idempotency_key=None) -> list[InsightResponse]

Create a batch of insights for one agent in one shot.

paramagent_iduuid.UUID

Agent the insights belong to.

paraminsightslist[InsightInput]

Insights to create, in input order.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

list

Created insights in input order.

funcget(insight_id) -> InsightResponse

Get an insight by id.

paraminsight_iduuid.UUID

Id of the insight.

Returns

kitaru.api_models.v1.insight.InsightResponse

Stored insight.

funclist(params=None) -> Page[InsightResponse]

List insights.

paramparamsInsightListParams | None

= None

Insight list params.

Returns

kitaru.api_models.v1.base.Page

Page of insights.

funciter(params=None) -> AsyncIterator[InsightResponse]

Iterate over all insights.

paramparamsInsightListParams | None

= None

Insight list params.

Returns

collections.abc.AsyncIterator

Async iterator over every insight.

funcupdate(insight_id, request) -> InsightResponse

Update an insight's title and description.

paraminsight_iduuid.UUID

Id of the insight.

paramrequestInsightUpdateRequest

Insight update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.insight.InsightResponse

Updated insight.

funcdelete(insight_id) -> None

Delete an insight.

paraminsight_iduuid.UUID

Id of the insight.

Returns

None

FunctionsCopy Anchor Link

On this page

Functions