gen_ai_hub.orchestration_v2.models.orchestration_request module¶

class gen_ai_hub.orchestration_v2.models.orchestration_request.CompletionPostRequest(*, config: OrchestrationConfig | None = None, config_ref: CompletionRequestConfigurationReferenceByIdConfigRef | CompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef | None = None, placeholder_values: dict[str, str] | None = None, messages_history: List[SystemMessage | UserMessage | AssistantMessage | ToolChatMessage | DeveloperChatMessage | ResponseChatMessage] | None = None)¶

Represents a request for the orchestration process, including configuration, template values, and message history.

config_ref: CompletionRequestConfigurationReferenceByIdConfigRef | CompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef | None¶

messages_history: List[SystemMessage | UserMessage | AssistantMessage | ToolChatMessage | DeveloperChatMessage | ResponseChatMessage] | None¶

validate_config_or_ref()¶

validates that exactly one of ‘config’ or ‘config_ref’ is provided.

Raises:: ValueError – If neither or both ‘config’ and ‘config_ref’ are provided.
Returns:: The validated OrchestrationRequest instance.
Return type:: CompletionPostRequest

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