Usage Limits

class Usage_Limits(session_kwargs, client, return_type='raw')

Methods

get_llm(id)	Get a LLM Usage Limit
get_matching(id)	Get a Matching Usage Limit
list_llm(*[, organization_id])	List LLM Usage Limits
list_matching(*[, task])	List Matching Usage Limits

Examples

>>> import civis
>>> client = civis.APIClient()
>>> client.usage_limits.list_matching(...)

get_llm(id: int) → Response

Get a LLM Usage Limit

Parameters:

idint

The ID for the limit.

Returns:

civis.Response

• idint

  The ID for the limit.

• organization_idint

  The ID of the organization to which this limit belongs.

• created_atstr (time)

  The time this limit was created.

• updated_atstr (time)

  The time the limit was last updated.

• hard_limitint

  The limit value. One of 1000, 10000, 50000, and 100000.

get_matching(id: int) → Response

Get a Matching Usage Limit

Parameters:

idint

The ID for the limit.

Returns:

civis.Response

• idint

  The ID for the limit.

• organization_idint

  The ID of the organization to which this limit belongs.

• created_atstr (time)

  The time this limit was created.

• updated_atstr (time)

  The time the limit was last updated.

• hard_limitint

  The limit value. One of 50000000, 200000000, 500000000, 1000000000, and 2000000000.

• taskstr

  The category of this limit. One of ‘IDR’ or ‘CDM’.

• notification_emailsList[str]

  Addresses to notify by e-mail when the limit is reached.

list_llm(*, organization_id: int = None) → Response

List LLM Usage Limits

Parameters:

organization_idint, optional

If specified, return limits for this organization only.

Returns:

civis.Response

• idint

  The ID for the limit.

• organization_idint

  The ID of the organization to which this limit belongs.

• created_atstr (time)

  The time this limit was created.

• updated_atstr (time)

  The time the limit was last updated.

• hard_limitint

  The limit value. One of 1000, 10000, 50000, and 100000.

list_matching(*, task: str = None) → Response

List Matching Usage Limits

Parameters:

taskstr, optional

If specified, return limits for this task type only. One of ‘IDR’ or ‘CDM’.

Returns:

civis.Response

• idint

  The ID for the limit.

• organization_idint

  The ID of the organization to which this limit belongs.

• created_atstr (time)

  The time this limit was created.

• updated_atstr (time)

  The time the limit was last updated.

• hard_limitint

  The limit value. One of 50000000, 200000000, 500000000, 1000000000, and 2000000000.

• taskstr

  The category of this limit. One of ‘IDR’ or ‘CDM’.

• notification_emailsList[str]

  Addresses to notify by e-mail when the limit is reached.