gen_ai_hub.orchestration_v2.models.template_ref module¶

Module for template reference models.

class gen_ai_hub.orchestration_v2.models.template_ref.TemplateRef(*, template_ref: TemplateRefByID | TemplateRefByScenarioNameVersion)¶

Bases: ABCBaseModel

template_ref: TemplateRefByID | TemplateRefByScenarioNameVersion¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'frozen': False}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gen_ai_hub.orchestration_v2.models.template_ref.TemplateRefByID(*, id: str, scope: Literal['resource_group', 'tenant'] | None = 'tenant')¶

Bases: ABCBaseModel

Represents a prompt template reference for generating prompts or conversations. :param id: ID of the template in prompt registry :type id: str :param scope: Defines the scope that is searched

for the referenced template. ‘tenant’ indicates the template is shared across all resource groups within the tenant, while ‘resource_group’ indicates the template is only accessible within the specific resource group. Defaults to ‘tenant’.

id: str¶

scope: Literal['resource_group', 'tenant'] | None¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'frozen': False}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class gen_ai_hub.orchestration_v2.models.template_ref.TemplateRefByScenarioNameVersion(*, scenario: str, name: str, version: str, scope: Literal['resource_group', 'tenant'] | None = 'tenant')¶

Bases: ABCBaseModel

Represents a prompt template reference for generating prompts or conversations. :param scenario: Scenario name :type scenario: str :param name: Name of template :type name: str :param version: Version of template :type version: str :param scope: Defines the scope that is searched

for the referenced template. ‘tenant’ indicates the template is shared across all resource groups within the tenant, while ‘resource_group’ indicates the template is only accessible within the specific resource group. Defaults to ‘tenant’.

scenario: str¶

name: str¶

version: str¶

scope: Literal['resource_group', 'tenant'] | None¶

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'frozen': False}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].