Skip to main content

aip_sdk.templates

Built-in dimension templates for common use cases.

Templates are transparent, static bundles retrieved from the API. Users can inspect and modify them before creating a project.

aip_sdk.templates.Template​

aip_sdk.templates.Template(name: str, display_name: str, schema_name: str, task_type: str | None, description: str, dimensions: builtins.list[Dimension])

A built-in dimension template.

aip_sdk.templates.Template.description​

aip_sdk.templates.Template.description = description

No docstring is defined in the source.

aip_sdk.templates.Template.dimensions​

aip_sdk.templates.Template.dimensions = dimensions

No docstring is defined in the source.

aip_sdk.templates.Template.display_name​

aip_sdk.templates.Template.display_name = display_name

No docstring is defined in the source.

aip_sdk.templates.Template.name​

aip_sdk.templates.Template.name = name

No docstring is defined in the source.

aip_sdk.templates.Template.schema_name​

aip_sdk.templates.Template.schema_name = schema_name

No docstring is defined in the source.

aip_sdk.templates.Template.task_type​

aip_sdk.templates.Template.task_type = task_type

No docstring is defined in the source.

aip_sdk.templates.describe​

aip_sdk.templates.describe(name: str, client: APIClient | None = None) -> Template

Get full template detail including dimensions.

Parameters

  • name str: Template name (e.g., "customer_service_chatbot")
  • client APIClient | None: Optional API client

Returns

  • Template: Template instance with full dimension list

Raises

aip_sdk.templates.dimensions​

aip_sdk.templates.dimensions(name: str, client: APIClient | None = None) -> builtins.list[Dimension]

Get dimension list for a template (transparent access).

This is a convenience wrapper around describe() that returns just the dimension list. Users can inspect and modify these before passing to Project.create().

Parameters

  • name str: Template name
  • client APIClient | None: Optional API client

Returns

  • builtins.list[Dimension]: List of Dimension instances

aip_sdk.templates.list​

aip_sdk.templates.list(client: APIClient | None = None) -> builtins.list[dict[str, Any]]

List all available templates (summary view).

Returns

  • builtins.list[dict[str, Any]]: List of template summaries with name, display_name, schema_name, task_type, description