AIServiceConfiguration¶
- pydantic model openapi_client.models.ai_service_configuration.AIServiceConfiguration¶
Configuration for a single AI component. Disabled components, and the catalog component even when enabled, return only ServiceName and Status.
- Fields:
- field service_name: StrictStr [Required] (alias 'ServiceName')¶
Component identifier; Status toggles its owning service (nl2sql maps to SQLAI, knowledgebases to AICore).
- Constraints:
strict = True
- field status: StrictStr [Required] (alias 'Status')¶
Enablement status. Always returned on GET. On PUT, drives enable/disable and whether model/guardrail updates are applied (Enabled only).
- Constraints:
strict = True
- field assigned_models: Optional[List[StrictStr]] = None (alias 'AssignedModels')¶
Assigned/allowed model IDs. Present on GET for enabled model-configurable components. Optional on PUT when updating models.
- field default_model: Optional[StrictStr] = None (alias 'DefaultModel')¶
Default model ID, or the literal N/A when none is stored.
- field assigned_guard_rails: Optional[List[AllowedGuardRail]] = None (alias 'AssignedGuardRails')¶
Guard rails assigned to the component; empty when none are configured.
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of AIServiceConfiguration from a JSON string
- Return type:
Optional[Self]
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True):
None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- Return type:
Dict[str,Any]
- classmethod from_dict(obj)¶
Create an instance of AIServiceConfiguration from a dict
- Return type:
Optional[Self]