gen_ai_hub.orchestration.models.template_ref
index
/home/jenkins/agent/workspace/ation_generative-ai-hub-sdk_main/gen_ai_hub/orchestration/models/template_ref.py

 
Classes
       
gen_ai_hub.orchestration.models.base.JSONSerializable(abc.ABC)
TemplateRef

 
class TemplateRef(gen_ai_hub.orchestration.models.base.JSONSerializable)
    TemplateRef(**kwargs)
 
Represents a prompt template reference for generating prompts or conversations.
 
This is a factory class for creating a reference to a prompt template.
It is used to reference a template by id, or the tuple: scenario, name, version
 
 
Method resolution order:
TemplateRef
gen_ai_hub.orchestration.models.base.JSONSerializable
abc.ABC
builtins.object

Methods defined here:
__init__(self, **kwargs)
Initializes a TemplateRef instance with dynamic attributes.
to_dict(self)
Converts the TemplateRef instance to a dictionary representation.
 
:return: A dictionary representation of the TemplateRef instance.
:rtype: dict

Class methods defined here:
from_id(prompt_template_id: str) from abc.ABCMeta
Creates a TemplateRef instance from a prompt template ID.
 
:param prompt_template_id: The ID of the prompt template.
:type prompt_template_id: str
:return: A TemplateRef instance with the specified ID.
:rtype: TemplateRef
from_tuple(scenario: str, name: str, version: str) from abc.ABCMeta
Creates a TemplateRef instance from a scenario, name, and version.
 
:param scenario: The scenario of the prompt template.
:type scenario: str
:param name: The name of the prompt template.
:type name: str
:param version: The version of the prompt template.
:type version: str
:return: A TemplateRef instance with the specified scenario, name, and version.
:rtype: TemplateRef

Data and other attributes defined here:
__abstractmethods__ = frozenset()
__annotations__ = {}

Data descriptors inherited from gen_ai_hub.orchestration.models.base.JSONSerializable:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)