AIServiceConfigurationInput

pydantic model openapi_client.models.ai_service_configuration_input.AIServiceConfigurationInput

A single component update. Model and guard rail changes are applied only when Status is Enabled and the component is model-configurable (not catalog).

Fields:
field service_name: StrictStr [Required] (alias 'ServiceName')

Component to update - one of knowledgebases, agents, jobs, datalabs, nl2sql, data-pipelines, datasets, chats, catalog. Any other value is rejected.

Constraints:
  • strict = True

field status: Optional[StrictStr] = None (alias 'Status')

Target state for the component’s owning service. Omit to leave enablement unchanged and update only models or guard rails.

field assigned_models: Optional[List[StrictStr]] = None (alias 'AssignedModels')

Replacement model IDs. Every model must be enabled. Modality compatibility is only checked for knowledgebases, SQL AI (nl2sql) and chats - the other components accept any model. SQL AI additionally accepts Anthropic models only.

field default_model: Optional[StrictStr] = None (alias 'DefaultModel')

Default model for the component. If supplied, AssignedModels must be supplied in the same entry, and the value must be one of them. Defaults to the first entry in AssignedModels when omitted. Must be N/A when AssignedModels is empty.

field assigned_guard_rails: Optional[List[AllowedGuardRail]] = None (alias 'AssignedGuardRails')

Replacement guard rails. Each must be an existing global system guard rail version; guard rails since deleted are skipped rather than failing.

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 AIServiceConfigurationInput 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 AIServiceConfigurationInput from a dict

Return type:

Optional[Self]