canary_api module

CanaryApi

class edgeimpulse_api.api.canary_api.CanaryApi(
		api_client=None
)

Parameters

• api_client=None

Methods

should_go_on_canary

edgeimpulse_api.api.canary_api.should_go_on_canary(
		self,
		requested_url: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Full url (host included) that is requested', extra={})],
		**kwargs
) ‑> edgeimpulse_api.models.canary_response.CanaryResponse

Get the decision to whether the requested URL goes on canary deployment or not

Get the decision to whether the requested URL goes on canary deployment or not

Parameters

• self

• requested_url: typing_extensions.Annotated[pydantic.types.StrictStr, FieldInfo(default=Ellipsis, description='Full url (host included) that is requested', extra={})]

• **kwargs

Return

edgeimpulse_api.models.canary_response.CanaryResponse