Aller au contenu principal

Référence des modèles (extra)

Version : 1.9.0

contracts.BillableConsumption​

Hérite de : contracts.ContractModel

Une quantité facturable utilisée par un agent pour un job Studio.

Champs du modèle​

ChampTypeValeur par défautDescription
skustrobligatoireSKU déclaré dans le billing_catalog de l'agent.
quantityDecimalobligatoireQuantité positive de unit, avec au plus 18 chiffres dont 6 décimales ; envoyée sous forme de chaîne décimale.
unitstrobligatoireUnité de la quantité.
job_idstrobligatoireJob Studio que l'enregistrement facture.
case_idstrNoneCase Studio, le cas échéant.
idempotency_keystrobligatoireUne clé par unité de travail et par SKU. Studio comptabilise une clé une seule fois ; un renvoi reçoit la réponse duplicate.
agent_cost_usdDecimalNoneIndication facultative de ce que l'agent a payé, en USD. Non facturé.
descriptionstrNoneTexte brut court ; aucune donnée personnelle.
occurred_atAwareDatetimeobligatoireMoment où la consommation a eu lieu ; ISO 8601 avec fuseau horaire.

contracts.ConsumptionReceipt​

Hérite de : contracts.ContractModel

Réponse de Studio pour un enregistrement d'un rapport de consommation.

Champs du modèle​

ChampTypeValeur par défautDescription
idempotency_keystrobligatoire
statusLiteral['accepted', 'duplicate', 'rejected']obligatoireaccepted : comptabilisé. duplicate : la clé a déjà été reçue ; rien n'est comptabilisé à nouveau. rejected : définitif, ne renvoyez pas.
reasonstrNoneRaison du rejet d'un enregistrement, par exemple unknown_sku.

common.SvBaseModel​

Modèle de base de tous les modèles Supervaize.

Aucun champ trouvé.

telemetry.Telemetry​

Hérite de : telemetry.TelemetryModel

Classe de base de toutes les données de télémétrie du système de contrôle Supervaize.

La télémétrie représente les données de supervision et d'observabilité envoyées par les agents au système de contrôle. Cela comprend les logs, métriques, événements, traces, exceptions, diagnostics et la télémétrie personnalisée.

Hérite de TelemetryModel, qui définit les attributs de base de la télémétrie :

  • agentId : l'ID de l'agent qui envoie la télémétrie
  • type : l'enum TelemetryType indiquant la catégorie de télémétrie (logs, metrics, etc.)
  • category : l'enum TelemetryCategory pour le domaine fonctionnel (system, application, etc.)
  • severity : l'enum TelemetrySeverity indiquant l'importance (debug, info, warning, etc.)
  • details : un dictionnaire contenant les détails propres à la télémétrie

Aucun champ supplémentaire par rapport à la classe parente.

contracts.ConsumptionReport​

Hérite de : contracts.ContractModel

Corps de POST /w/<workspace>/api/v1/billing/consumption/.

Champs du modèle​

ChampTypeValeur par défautDescription
agent_slugstrobligatoireSlug de l'agent qui envoie le rapport.
recordslist[contracts.BillableConsumption]obligatoire

contracts.ConsumptionReportResponse​

Hérite de : contracts.ContractModel

Réponse de Studio à un rapport de consommation : un accusé par enregistrement, dans l'ordre.

Champs du modèle​

ChampTypeValeur par défautDescription
resultslist[contracts.ConsumptionReceipt]obligatoire

agent.AgentCustomMethodParams​

Hérite de : agent.AgentMethodParams

Champs du modèle​

ChampTypeValeur par défautDescription
method_namestrobligatoire

agent.AgentJobContextBase​

Modèle de base des paramètres de contexte de job de l'agent

ChampTypeValeur par défautDescription
job_contextJobContextobligatoire
job_fieldsdict[str, Any]obligatoire

agent.AgentMethodParams​

Paramètres de méthode pour les opérations de l'agent.

ChampTypeValeur par défautDescription
paramsdict[str, Any]—Un dictionnaire simple clé-valeur des paramètres qui seront transmis à AgentMethod.method sous forme de kwargs

agent.AgentMethods​

Hérite de : agent.AgentMethodsAbstract

Aucun champ supplémentaire par rapport à la classe parente.

agent.AgentMethodsAbstract​

Classe de base pour créer des modèles Pydantic.

ChampTypeValeur par défautDescription
job_startAgentMethodobligatoire
job_stopAgentMethodNone
job_statusAgentMethodNone
human_answerAgentMethodNone
chatAgentMethodNone
customdict[str, supervaizer.agent.AgentMethod]None

agent.AgentResponse​

Modèle de réponse des endpoints d'agent, valeurs fournies par Agent.registration_info

ChampTypeValeur par défautDescription
namestrobligatoire
idstrobligatoire
authorstrNone
developerstrNone
maintainerstrNone
editorstrNone
versionstrobligatoire
release_notes_urlstrNone
api_pathstrobligatoire
descriptionstrobligatoire
tagslist[str]None
methodsAgentMethodsNone
parameters_setuplist[dict[str, typing.Any]]None
server_agent_idstrNone
server_agent_statusstrNone
server_agent_onboarding_statusstrNone

contracts.BillingCatalogItem​

Hérite de : contracts.ContractModel

Un SKU facturable qu'un agent déclare à l'enregistrement.

Le catalogue ne contient aucun prix : l'espace de travail propriétaire fixe le prix de chaque SKU dans Studio.

Champs du modèle​

ChampTypeValeur par défautDescription
skustrobligatoireIdentifiant du SKU : 1 à 64 lettres minuscules, chiffres ou tirets bas.
unitstrobligatoireUnité que compte une quantité, comme minute ou token (1 à 32).
descriptionstr''Texte brut affiché avec le SKU.

case.CaseNodes​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
nodeslist[case.CaseNode][]

data_resource.DataResource​

Hérite de : common.SvBaseModel

Déclare une ressource de données nommée que l'agent expose pour l'accès CRUD de Studio.

L'agent fournit des fonctions de rappel pour chaque opération. Le SDK génère automatiquement les routes FastAPI correspondantes.

Exemple ::

contacts_resource = DataResource( name="contacts", display_name="Contacts", fields=[ DataResourceField(name="id", editable=Editable.NEVER, visible_on=["list", "detail"]), DataResourceField(name="email", field_type=FieldType.EMAIL, required=True), ], on_list=lambda: repo.list_all(), on_get=lambda item_id: repo.get(item_id), on_create=lambda data: repo.create(data), on_update=lambda item_id, data: repo.update(item_id, data), on_delete=lambda item_id: repo.delete(item_id), )

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoireIdentifiant de ressource sûr pour une URL, par exemple 'contacts'. Lettres minuscules, chiffres, tirets bas et traits d'union uniquement ; doit commencer par une lettre ou un chiffre.
display_namestr''
descriptionstr''
fieldslist[data_resource.DataResourceField]—
read_onlyboolFalse
importableboolFalseActive la route d'import CSV en masse
scopeLiteral['workspace', 'mission', 'job']'workspace'Périmètre de contexte Studio pour cette ressource.
requires_contextlist[str]—Clés de contexte que Studio doit envoyer pour le contrôle d'accès à la ressource.
on_listcollections.abc.Callable[..., list[dict[str, typing.Any]]]None
on_get`collections.abc.Callable[..., dict[str, typing.Any]None]`None
on_createcollections.abc.Callable[..., dict[str, typing.Any]]None
on_update`collections.abc.Callable[..., dict[str, typing.Any]None]`None
on_deletecollections.abc.Callable[..., bool]None
on_importcollections.abc.Callable[..., dict[str, typing.Any]]None

job.Job​

Hérite de : job.AbstractJob

Les jobs sont généralement créés par la plateforme, et non par l'agent.

Arguments : id (str) : identifiant unique du job, fourni par la plateforme agent_name (str) : nom (slug) de l'agent qui exécute le job status (EntityStatus) : statut actuel du job job_context (JobContext) : informations de contexte du job payload (Any, optional) : données de payload du job. Valeur par défaut : None result (Any, optional) : données de résultat du job. Valeur par défaut : None error (str, optional) : message d'erreur si le job a échoué. Valeur par défaut : None responses (list[JobResponse], optional) : liste des réponses du job. Valeur par défaut : liste vide finished_at (datetime, optional) : date de fin du job. Valeur par défaut : None created_at (datetime, optional) : date de création du job. Valeur par défaut : None

Aucun champ supplémentaire par rapport à la classe parente.

job.JobContext​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
workspace_idstrobligatoire
job_idstrobligatoire
started_bystrobligatoire
started_atdatetimeobligatoire
mission_idstrobligatoire
mission_namestrobligatoire
mission_contextAnyNone
job_instructionsJobInstructionsNone

job.JobResponse​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
job_idstrobligatoire
status<enum 'EntityStatus'>obligatoire
messagestrobligatoire
payloaddict[str, typing.Any]None
error_messagestrNone
error_tracebackstrNone

event.JobStartConfirmationEvent​

Hérite de : event.Event

Aucun champ supplémentaire par rapport à la classe parente.

contracts.SupervaizerV2AgentRegistrationContract​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
supervaizer_contract_versionLiteral[2]2
agentV2AgentIdentityobligatoire
versionsV2ProtocolVersionsobligatoire
a2aV2A2AControllerobligatoire
capabilitiesV2AgentCapabilities—
job_policyV2JobPolicy—
resourceslist[contracts.V2ResourceDefinition]—
datasetslist[contracts.V2DatasetDefinition]—
dashboardslist[contracts.V2DashboardDefinition]—
workspace_bindingV2WorkspaceBindingDefinitionNone

contracts.V2ActionDefinition​

Hérite de : contracts.ContractModel

Métadonnées déclarées pour une action d'agent invocable.

Les consommateurs autorisent, regroupent et filtrent les actions à partir de ces champs. Ils ne doivent jamais être déduits de la chaîne d'identifiant : id est fourni par l'appelant à l'invocation ; l'analyser par motif transforme une décision d'autorisation en quelque chose que l'appelant contrôle.

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoireAction identifier used to invoke the action.
mutatingboolTrueIndique si l'invocation de l'action modifie l'état côté agent. Vaut True par défaut, de sorte qu'une action non déclarée exige une permission d'écriture.
scopeLiteral['workspace', 'mission', 'job']'job'Contexte dans lequel l'action s'exécute.
labelstrNoneCourte légende qu'un consommateur peut afficher à la place d'une légende déduite de l'identifiant. Texte brut ; affichage uniquement, jamais utilisé pour une autorisation.
descriptionstrNoneUne ou deux phrases en langage clair qu'un consommateur peut afficher comme texte d'aide, par exemple dans une infobulle. Texte brut ; affichage uniquement, jamais utilisé pour une autorisation.
kindLiteral['command', 'help']'command'Les actions help proposent ou vérifient un brouillon pour target_field et doivent déclarer mutating=False. Omis lorsque la valeur est command.
target_fieldstrNoneIdentifiant du champ de configuration dont le brouillon est renseigné par le résultat d'une action help.
dry_runboolFalseExécution de test définie par son résultat : peut créer des données temporaires côté agent et entraîner un coût de modèle, n'envoie jamais de communication externe et n'apparaît jamais dans les résultats ni dans les compteurs de synchronisation. Omis lorsque la valeur est False.

contracts.V2ActionRequest​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
request_idstrobligatoire
actorV2ActorContextobligatoire
workspaceV2WorkspaceContextobligatoire
mission_idstrobligatoire
agent_slugstrobligatoire
surfacestrobligatoire
actionstrobligatoire
inputdict[str, Any]—
idempotency_keystrNone
draft_session_idstrNone
job_idstrNone
case_idstrNone
step_idstrNone
missionV2MissionContextNone
workspace_authorizationV2VerifiedWorkspaceContextNone

contracts.V2AgentFullDescription​

Hérite de : contracts.ContractModel

Description longue qu'un consommateur affiche sur la page de détail de l'agent.

Le SDK se limite à typer le contenu et à en borner la taille. Le consommateur nettoie le HTML (et le HTML qu'il produit à partir du markdown) avant l'affichage.

Champs du modèle​

ChampTypeValeur par défautDescription
formatLiteral['markdown', 'html']'markdown'Balisage de content.
contentstrobligatoireCorps en Markdown ou HTML, de 1 à 100 000 caractères, sans être uniquement des espaces. Non nettoyé par le SDK ; le consommateur le nettoie.

contracts.V2AgentIntroduction​

Hérite de : contracts.ContractModel

Bloc de présentation en texte brut qu'un consommateur affiche avant qu'aucun job n'existe.

Champs du modèle​

ChampTypeValeur par défautDescription
taglinestrobligatoire
summarystrobligatoireCe que fait l'agent, en une ou deux phrases.
example_goalslist[str]obligatoirePremières demandes suggérées qu'un consommateur peut proposer telles quelles.
avatar_urlstrNone

contracts.V2AgentMethod​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
methodstrobligatoire
paramsdict[str, Any]—
descriptionstrNone
is_asyncboolFalse
timeoutint600

contracts.V2AgentMethods​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
refreshV2AgentMethodNone
customdict[str, contracts.V2AgentMethod]—

case.Case​

Hérite de : case.CaseAbstractModel

Aucun champ supplémentaire par rapport à la classe parente.

case.CaseAbstractModel​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
job_idstrobligatoire
namestrobligatoire
accountForwardRef('Account')obligatoire
descriptionstrobligatoire
status<enum 'EntityStatus'>obligatoire
updateslist[case.CaseNodeUpdate][]
total_costfloat0.0
final_deliverydict[str, typing.Any]None
finished_atdatetimeNone
metadatadict[str, Any]—Métadonnées métier fournies par l'agent (par ex. contexte du contact)

case.CaseNode​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoire
type<enum 'CaseNodeType'>obligatoire
factoryAnyNone
descriptionstr''
can_be_confirmedboolFalse

case.CaseNodeUpdate​

Hérite de : common.SvBaseModel

CaseNodeUpdate est une classe qui représente une mise à jour d'un nœud de case.

Retourne : CaseNodeUpdate : objet CaseNodeUpdate

Champs du modèle​

ChampTypeValeur par défautDescription
indexintNone
costfloatNone
namestrNone
payloaddict[str, typing.Any]None
is_finalboolFalse
upsertboolFalse
errorstrNone
scheduled_atdatetimeNone
scheduled_methodstrNone
scheduled_paramsdict[str, typing.Any]None
scheduled_statusstrNone

context.ContextCitation​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
refstrobligatoire
titlestrobligatoire
source_typestrobligatoire
versionintobligatoire

context.ContextOpenResponse​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
refstrobligatoire
titlestrobligatoire
scopeLiteral['workspace', 'mission']obligatoire
source_typestrobligatoire
versionintobligatoire
instructionsstr''
tagslist[str]—
contentstrobligatoire
citationslist[context.ContextCitation]—

context.ContextSearchResponse​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
querystrobligatoire
resultslist[context.ContextSearchResult]—

context.ContextSearchResult​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
refstrobligatoire
titlestrobligatoire
scopeLiteral['workspace', 'mission']obligatoire
source_typestrobligatoire
versionintobligatoire
tagslist[str]—
excerptstr''
scoreint0
citationContextCitationNone

contracts.AgentMethodContract​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoire
methodstrobligatoire
paramsdict[str, typing.Any]None
fields`list[supervaizer.contracts.AgentMethodFieldContractdict[str, typing.Any]]`None
descriptionstrNone
is_asyncboolFalse
timeoutint600
nodesdict[str, typing.Any]None

contracts.AgentMethodFieldContract​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoire
typestrNone
field_typestr'CharField'
descriptionstrNone
choiceslist[typing.Any]None
defaultAnyNone
widgetstrNone
requiredboolFalse

contracts.AgentMethodsContract​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
job_startAgentMethodContractobligatoire
job_stopAgentMethodContractNone
job_statusAgentMethodContractNone
human_answerAgentMethodContractNone
chatAgentMethodContractNone
customdict[str, supervaizer.contracts.AgentMethodContract]None

contracts.AgentRegistrationContract​

Hérite de : contracts.ContractModel

Schéma minimal des payloads d'enregistrement d'agent consommés par Studio.

Champs du modèle​

ChampTypeValeur par défautDescription
idstrNone
slugstrobligatoire
namestrobligatoire
api_pathstrobligatoire
release_notes_urlstrNone
methodsAgentMethodsContract | dict[str, typing.Any]—
parameters_setuplist[dict[str, Any]]—
data_resources`list[contracts.DataResourceContractdict[str, Any]]`—
introduction`ForwardRef('V2AgentIntroductionNone')`None
full_description`ForwardRef('V2AgentFullDescriptionNone')`None
billing_catalog`ForwardRef('list[BillingCatalogItem]None')`None

contracts.CaseUpdateEvent​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoire
payloaddict[str, Any]—
costfloat0.0
indexintNone
is_finalboolFalse

contracts.CaseUpdateRequest​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
answerdict[str, Any]obligatoire
messagestrNone

contracts.ContractModel​

Classe de base des modèles de contrat de transmission gérés par le SDK.

Aucun champ trouvé.

contracts.ControllerContract​

Hérite de : contracts.ContractModel

Surface canonique du contrôleur annoncée par un serveur Supervaizer.

Champs du modèle​

ChampTypeValeur par défautDescription
controller_contract_versionstr'1.0'
api_base_pathstr'/api'
endpointsdict[str, str]—

contracts.DataResourceContextContract​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
workspace_idstrNone
workspace_slugstrNone
mission_idstrNone
missionV2MissionContextNone
agent_slugstrNone
request_idstrNone

contracts.DataResourceContract​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoire
display_namestrobligatoire
descriptionstr''
fieldslist[contracts.DataResourceFieldContract]—
read_onlyboolFalse
importableboolFalse
operationsdict[str, bool]—
scopeLiteral['workspace', 'mission', 'job']'workspace'
requires_contextlist[str]—

contracts.DataResourceFieldContract​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoire
field_typestr'string'
labelstrNone
requiredboolFalse
editablestr'always'
visible_onlist[str]—
descriptionstrNone
related_resourcestrNone
sensitiveboolFalse
display_labelstrNone

contracts.DataResourceListResponse​

Hérite de : contracts.ContractModel

Forme de réponse structurée pour les opérations de liste de DataResource.

Champs du modèle​

ChampTypeValeur par défautDescription
itemslist[dict[str, Any]]—

contracts.JobStartRequest​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
job_contextdict[str, Any]obligatoire
job_fieldsdict[str, Any]—
encrypted_agent_parametersstrNone
rule_snapshot`ForwardRef('RuleCheckpointSnapshotNone')`None

contracts.RuleCheckpointRequest​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
occurrence_idstrobligatoire
phaseLiteral['before', 'after']obligatoire
snapshot_hashstrobligatoire
job_idstrobligatoire
case_idstrobligatoire
step_idstrobligatoire
contextdict[str, Any]obligatoire
secret_refslist[str]—

contracts.RuleCheckpointResponse​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
checkpoint_idstrobligatoire
statusLiteral['allow', 'pause', 'stop']obligatoire
snapshot_hashstrobligatoire
input_hashstrobligatoire

contracts.RuleCheckpointResume​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
checkpoint_idstrobligatoire
job_idstrobligatoire
case_idstrobligatoire
agent_slugstrobligatoire
occurrence_idstrobligatoire
phaseLiteral['before', 'after']obligatoire
statusLiteral['allow', 'stop']obligatoire
snapshot_hashstrobligatoire
input_hashstrobligatoire
decision_idstrobligatoire

contracts.RuleCheckpointSnapshot​

Hérite de : contracts.ContractModel

Instantané figé et opaque des règles fourni par Studio pour un job encadré.

Champs du modèle​

ChampTypeValeur par défautDescription
hashstrobligatoire
checkpoint_urlstrobligatoire
versionLiteral[1]obligatoire
checkpoint_tokenstrobligatoire

contracts.ServerRegistrationContract​

Hérite de : contracts.ControllerContract

Schéma minimal des détails de server.register.

Champs du modèle​

ChampTypeValeur par défautDescription
server_idstrobligatoire
urlstrobligatoire
uristrobligatoire
api_versionstrobligatoire
controller_versionstrNone
environmentstrNone
agentslist[contracts.AgentRegistrationContract]—

contracts.V2A2AController​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
agent_card_urlstrobligatoire
controller_urlstrobligatoire
transportV2A2ATransport—
external_interopV2A2AExternalInterop—

contracts.V2A2AExternalInterop​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
inbound_tasksboolFalse
outbound_delegationboolFalse

contracts.V2A2ATransport​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
json_rpcboolTrue
sseboolTrue
push_notificationsboolFalse

contracts.V2A2UIResourceImportColumn​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrNone
typestr'string'
requiredboolFalse

contracts.V2A2UIResourceImportDocument​

Hérite de : contracts.ContractModel

Surface d'import de ressources au format A2UI, consommée par Studio.

Champs du modèle​

ChampTypeValeur par défautDescription
typeLiteral['ResourceImport']'ResourceImport'
idstrobligatoire
titlestrobligatoire
resourcestrobligatoire
accepted_formatslist[Literal['csv', 'xlsx']]—
fieldslist[contracts.V2ResourceFieldDefinition]—
columnslist[contracts.V2A2UIResourceImportColumn]—
submitV2A2UISubmitDefinitionobligatoire
statedict[str, Any]—

contracts.V2A2UISubmitDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
actionstrobligatoire
labelstrNone

contracts.V2ActionResult​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
statusLiteral['ok', 'error']obligatoire
effectslist[contracts.V2Effect]—
job_state`ForwardRef('V2JobStateSnapshotNone')`None
replay_safetyV2ReplaySafetyMetadataNone
setup_plandict[str, typing.Any] | V2SetupPlanNone
draftV2FieldDraftNone
dry_runV2DryRunOutcomeNone

contracts.V2ActorContext​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
user_idstrobligatoire

contracts.V2AgentCapabilities​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
surfaceslist[str]—
surface_definitionslist[contracts.V2SurfaceDefinition]—Textes d'affichage des surfaces déclarées, au plus un par identifiant. Omis de l'enregistrement sérialisé lorsque la liste est vide.
actionslist[contracts.V2ActionDefinition]—
case_laneslist[contracts.V2CaseLaneDefinition]—
artifact_typeslist[contracts.V2ArtifactTypeDefinition]—
rule_checkpoints`ForwardRef('V2RuleCheckpointCapabilityNone')`None
scheduled_startboolFalse

contracts.V2AgentIdentity​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
slugstrobligatoire
display_namestrobligatoire

contracts.V2ArtifactRef​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
typestrobligatoire
titlestrNone
external_idstrNone
media_typestrNone

contracts.V2ArtifactTypeDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
typestrobligatoire
labelstrobligatoire
renderer_surfacestrNone

contracts.V2AwaitingFieldDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrobligatoire
typestr'boolean'
requiredboolFalse
item_fieldslist[supervaizer.contracts.V2SetupFieldDefinition]None
defaultAnyNone
descriptionstrNone
placeholderstrNone
multilineboolFalse
min_rowsintNone
optionslist[supervaizer.contracts.V2FieldOption]None
options_sourceV2ResourceFieldOptionsSourceNone
depends_onV2FieldDependsOnNone
validationV2FieldValidationNone

contracts.V2AwaitingState​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
reasonstrobligatoire
surfacestrobligatoire
actionstrobligatoire
fieldslist[contracts.V2AwaitingFieldDefinition]—
reopenableboolFalseIndique si une étape déjà traitée peut être rouverte et soumise à nouveau avec des valeurs modifiées.

contracts.V2CaseLaneDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrobligatoire
defaultboolFalse

contracts.V2CaseSnapshot​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
lanestr'work'
titlestrNone
statusstrNone
external_idstrNone
metadatadict[str, Any]—
stepslist[contracts.V2StepSnapshot]—

contracts.V2ContextAssignment​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
itemslist[contracts.V2ContextAssignmentItem]obligatoire
mission_idstrNone
job_idstrobligatoire
assigned_atstrobligatoire

contracts.V2ContextAssignmentItem​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
refstrobligatoire
versionintobligatoire
scopeLiteral['workspace', 'mission']obligatoire
titlestrobligatoire

contracts.V2CostEstimate​

Hérite de : contracts.ContractModel

Une fourchette de coût ou un inconnu explicite, jamais un nombre unique.

Champs du modèle​

ChampTypeValeur par défautDescription
statusLiteral['estimated', 'unknown']obligatoire
unitstrNoneLibellé libre affiché tel quel, par exemple USD, tokens ou crédits.
minfloatNone
maxfloatNone
basisstrNoneTexte brut, par exemple 'for 50 responses'.

contracts.V2DashboardDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrobligatoire
surfacestr'mission.analytics'
widgetslist[contracts.V2DashboardWidgetDefinition]—

contracts.V2DashboardWidgetDataRef​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
modeLiteral['ref', 'action', 'inline']'ref'
datasetIdstrNone
actionstrNone
inputdict[str, Any]—
valueslist[dict[str, typing.Any]] | dict[str, typing.Any]None

contracts.V2DashboardWidgetDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
titlestrobligatoire
dataV2DashboardWidgetDataRefNone
layoutdict[str, Any]—
visualizationV2DashboardWidgetVisualization—

contracts.V2DashboardWidgetVisualization​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
typeLiteral['table', 'metric', 'vega-lite', 'custom']'table'
specdict[str, typing.Any]None

contracts.V2DatasetDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrobligatoire
auto_surfaceboolFalse
scopeLiteral['workspace', 'mission', 'job']'workspace'
displayV2ResourceDisplayDefinitionNone

contracts.V2DryRunOutcome​

Hérite de : contracts.ContractModel

Ce qu'une action en mode dry-run a laissé derrière elle.

Champs du modèle​

ChampTypeValeur par défautDescription
expires_atdatetimeNone
deletableboolobligatoire
cost_incurredV2CostEstimateNone

contracts.V2Effect​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
typestrobligatoire
job_idstrNone
case_idstrNone
step_idstrNone
resourcestrNone
datasetstrNone
artifact_idstrNone
statusstrNone
messagestrNone
countintNone
itemdict[str, typing.Any]None
itemslist[dict[str, typing.Any]]None
rowslist[dict[str, typing.Any]]None
errorslist[dict[str, typing.Any]]None
gapslist[dict[str, typing.Any]]None
summarydict[str, typing.Any]None
casedict[str, typing.Any]None
datadict[str, typing.Any]None

contracts.V2FieldDependsOn​

Hérite de : contracts.ContractModel

Active un champ uniquement tant qu'un champ parent contient l'une des valeurs listées.

Champs du modèle​

ChampTypeValeur par défautDescription
fieldstrobligatoireIdentifiant du champ parent ; les parents peuvent s'enchaîner.
in_list[str]obligatoireValeurs du parent, converties en chaînes, qui activent ce champ.

contracts.V2FieldDraft​

Hérite de : contracts.ContractModel

Sortie d'une action d'aide : une valeur proposée pour un champ de configuration, jamais appliquée automatiquement.

Champs du modèle​

ChampTypeValeur par défautDescription
fieldstrobligatoireIdentifiant du champ de configuration cible.
valueAnyNoneValeur proposée ; None pour un résultat de validation seule.
suggestionslist[contracts.V2Suggestion]—

contracts.V2FieldOption​

Hérite de : contracts.ContractModel

Un choix sélectionnable. Les chaînes seules sont rejetées afin que les libellés restent explicites.

Champs du modèle​

ChampTypeValeur par défautDescription
valuestrobligatoire
labelstrobligatoire

contracts.V2FieldValidation​

Hérite de : contracts.ContractModel

Règles qu'un consommateur applique avant la soumission. Chaque règle doit convenir au type du champ.

Champs du modèle​

ChampTypeValeur par défautDescription
min_lengthintNone
max_lengthintNone
patternstrNoneExpression régulière, sous-ensemble compatible avec ECMAScript.
minfloatNone
maxfloatNone
min_itemsintNone
max_itemsintNone
messagestrNoneAffiché à la place de l'erreur de validation générique.

contracts.V2JobPolicy​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
default_timeout_secondsintNone
offline_start_policyLiteral['block']'block'
offline_running_policyLiteral['fail_in_studio']'fail_in_studio'
syncV2JobSyncPolicyNone
setupV2JobSetupPolicyNone

contracts.V2JobSetupPolicy​

Hérite de : contracts.ContractModel

Actions génériques de configuration de job déclarées par l'agent.

Champs du modèle​

ChampTypeValeur par défautDescription
preview_actionstr'job.start.preview'
start_actionstr'job.start'
submit_actionstr'step.awaiting.submit'
action_scopeslist[Literal['workspace', 'job', 'case', 'step']]—
plan`ForwardRef('dict[str, Any]V2SetupPlanNone')`

contracts.V2JobSnapshot​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
agent_slugstrobligatoire
mission_idstrobligatoire
statusstrobligatoire
sourceV2JobSourceobligatoire

contracts.V2JobSource​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
typeLiteral['fresh_start', 'external']obligatoire
external_refstrNone
previous_job_idstrNone
target_typestrNoneType d'objet métier déclaré par l'agent pour les sources externes (par ex. project). Vocabulaire ouvert, contrairement aux champs fixés par le protocole comme l'activity d'une étape.

contracts.V2JobStateSnapshot​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
jobV2JobSnapshotobligatoire
caseslist[contracts.V2CaseSnapshot]—

contracts.V2JobSyncPolicy​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
actionstr'job.sync'
supported_statuseslist[str]—

contracts.V2JobSyncResult​

Hérite de : contracts.V2ActionResult

Champs du modèle​

ChampTypeValeur par défautDescription
external_refstrNone
external_versionstrNone
sync_cursorstrNone
observed_atstrNone

contracts.V2MissionContext​

Hérite de : contracts.ContractModel

Mission Studio envoyée avec une requête. Le SDK ne lit pas les clés de metadata.

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
namestrNone
metadatadict[str, Any]—

contracts.V2MountedResourceViewDefinition​

Hérite de : contracts.ContractModel

Surcharge d'agent qui monte une surface A2UI sur une vue de ressource complète.

Champs du modèle​

ChampTypeValeur par défautDescription
viewstrobligatoireVue de ressource générée remplacée par le montage (par ex. import, edit).
surfacestrobligatoireIdentifiant de la surface A2UI enregistrée servie pour cette vue de ressource.

contracts.V2ProtocolVersions​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
a2ui_versionstrobligatoire
a2ui_catalog_versionstrobligatoire
a2a_versionstrobligatoire
ag_ui_versionstrNone

contracts.V2ReplaySafetyMetadata​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
dedupe_keyslist[str]—
stable_external_ids_requiredboolTrue
strictly_idempotent_responseboolFalse
convergentboolTrue

contracts.V2ResourceDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrobligatoire
auto_surfaceboolFalse
scopeLiteral['workspace', 'mission', 'job']'workspace'
requires_contextlist[str]—
operationslist[str]—
displayV2ResourceDisplayDefinitionNone
fieldslist[contracts.V2ResourceFieldDefinition]—
mounted_viewslist[contracts.V2MountedResourceViewDefinition]—

contracts.V2ResourceDisplayDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
title_fieldstrNone
columnslist[str]—
search_fieldslist[str]—

contracts.V2ResourceFieldDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrobligatoire
typestr'string'
requiredboolFalse
read_onlyboolFalse
multilineboolFalse
options_sourceV2ResourceFieldOptionsSourceNone
item_fieldslist[supervaizer.contracts.V2SetupFieldDefinition]None
defaultAnyNone
descriptionstrNone
placeholderstrNone
min_rowsintNone
optionslist[supervaizer.contracts.V2FieldOption]None
depends_onV2FieldDependsOnNone
validationV2FieldValidationNone

contracts.V2ResourceFieldOptionsSource​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
typeLiteral['resource']'resource'
resourcestrobligatoire
value_fieldstr'id'
label_fieldstrNone

contracts.V2RuleCheckpointCapability​

Hérite de : contracts.ContractModel

Prise en charge facultative des points de contrôle de règles avant/après de Studio.

Champs du modèle​

ChampTypeValeur par défautDescription
versionLiteral[1]1
phaseslist[Literal['before', 'after']]obligatoire
secret_refslist[str]—

contracts.V2SetupFieldDefinition​

Hérite de : contracts.ContractModel

Un champ de saisie qu'un consommateur affiche pendant la configuration guidée.

Types connus : string, text, boolean, integer, number, date, select, multi_select, resource_ref, file, list. Les types inconnus sont affichés comme string. Un champ list déclare item_fields (un seul niveau d'imbrication) et sa valeur est une liste de dicts indexés par l'identifiant du champ d'élément, jamais du texte libre.

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
labelstrobligatoire
typestr'string'
item_fieldslist[supervaizer.contracts.V2SetupFieldDefinition]None
requiredboolFalse
defaultAnyNone
descriptionstrNone
placeholderstrNone
multilineboolFalse
min_rowsintNone
optionslist[supervaizer.contracts.V2FieldOption]None
options_sourceV2ResourceFieldOptionsSourceNone
depends_onV2FieldDependsOnNone
validationV2FieldValidationNone

contracts.V2SetupPlan​

Hérite de : contracts.ContractModel

Plan de configuration typé ; il se sérialise en confirmation_required et steps[].

Champs du modèle​

ChampTypeValeur par défautDescription
confirmation_requiredboolTrue
stepslist[contracts.V2SetupStep]—
cost_estimateV2CostEstimateNone

contracts.V2SetupStep​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
titlestrobligatoire
descriptionstrNone
statusLiteral['pending', 'awaiting', 'done', 'skipped']'pending'
fieldslist[contracts.V2SetupFieldDefinition]—
help_actionslist[str]—Identifiants des actions déclarées avec kind='help' dans l'enregistrement.

contracts.V2StepSnapshot​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
activityLiteral['operation', 'delegation']obligatoire
statusstrobligatoire
titlestrNone
external_idstrNone
awaitingV2AwaitingStateNone
outputslist[contracts.V2ArtifactRef]—

contracts.V2Suggestion​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
messagestrobligatoire
severityLiteral['info', 'warning', 'error']obligatoire
fieldstrNone
proposed_valueAnyNone

contracts.V2SurfaceDefinition​

Hérite de : contracts.ContractModel

Texte d'affichage pour une surface déclarée.

capabilities.surfaces reste une liste d'identifiants, de sorte que les consommateurs continuent de faire correspondre les surfaces par chaîne ; une définition ajoute seulement un texte lisible pour l'un de ces identifiants.

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoireIdentifiant de la surface, tel qu'il figure dans capabilities.surfaces.
labelstrNoneCourte légende qu'un consommateur peut afficher à la place d'une légende déduite de l'identifiant. Texte brut ; affichage uniquement, jamais utilisé pour une autorisation.
descriptionstrNoneUne ou deux phrases en langage clair qu'un consommateur peut afficher comme texte d'aide, par exemple dans une infobulle. Texte brut ; affichage uniquement, jamais utilisé pour une autorisation.

contracts.V2SurfaceRequest​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
request_idstrobligatoire
actorV2ActorContextobligatoire
workspaceV2WorkspaceContextobligatoire
mission_idstrobligatoire
agent_slugstrobligatoire
surfacestrobligatoire
inputdict[str, Any]—
draft_session_idstrNone
job_idstrNone
case_idstrNone
step_idstrNone
missionV2MissionContextNone
workspace_authorizationV2VerifiedWorkspaceContextNone

contracts.V2SurfaceResult​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
surfacestrobligatoire
a2ui_versionstrNone
a2ui_catalog_versionstrNone
documentdict[str, Any]—

contracts.V2VerifiedWorkspaceContext​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
grant_idstrobligatoire
workspace_idstrobligatoire
workspace_slugstrNone
agent_idstrobligatoire
agent_slugstrobligatoire
server_idstrobligatoire
scopeslist[str]—
agent_workspace_refstrNone

contracts.V2WorkspaceAuthorizationSettings​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
enabledboolFalse
issuerstrNone
audiencestrNone
public_key_pemstrNone
jwks_urlstrNone
leeway_secondsint30

contracts.V2WorkspaceBindingCreateDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
surfacestr'workspace_binding.create'
actionstr'workspace_binding.create'
fieldslist[contracts.V2ResourceFieldDefinition]—

contracts.V2WorkspaceBindingDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
requiredboolFalse
modeslist[Literal['bind_existing', 'create_and_bind']]—
reference_labelstr'Agent workspace reference'
reference_helpstr'Select or create the agent-side record this Studio workspace may access.'
reference_placeholderstr'Example: workspace-prod'
existingV2WorkspaceBindingExistingDefinitionNone
createV2WorkspaceBindingCreateDefinitionNone

contracts.V2WorkspaceBindingExistingDefinition​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
actionstr'workspace_binding.options'
value_fieldstr'agent_workspace_ref'
label_fieldstr'display_name'

contracts.V2WorkspaceContext​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
slugstrNone

data_resource.DataResourceContext​

Hérite de : common.SvBaseModel

Contexte de requête Studio transmis aux callbacks de DataResource.

Champs du modèle​

ChampTypeValeur par défautDescription
workspace_idstrNone
workspace_slugstrNone
mission_idstrNone
missionV2MissionContextNone
agent_slugstrobligatoire
request_idstrNone
workspace_authorizationV2VerifiedWorkspaceContextNone

data_resource.DataResourceField​

Hérite de : common.SvBaseModel

Décrit un champ unique d'une DataResource pour l'affichage dans Studio.

Champs du modèle​

ChampTypeValeur par défautDescription
namestrobligatoireNom de colonne ou d'attribut
field_type<enum 'FieldType'>stringUne valeur parmi : string, integer, boolean, date, datetime, text, email, url
labelstrNoneLibellé lisible ; par défaut name.title()
requiredboolFalseObligatoire dans le formulaire de création
editable<enum 'Editable'>always
visible_onlist[str]—Vues qui affichent ce champ : list, detail, create, edit
descriptionstrNoneTexte d'aide affiché dans Studio
related_resourcestrNoneNom d'une autre DataResource que ce champ référence par clé étrangère
sensitiveboolFalseTrue lorsque Studio doit masquer ce champ pour les utilisateurs non gestionnaires

deploy.drivers.base.DeploymentPlan​

Plan de déploiement contenant toutes les actions à effectuer.

ChampTypeValeur par défautDescription
platformstrobligatoire
service_namestrobligatoire
environmentstrobligatoire
regionstrobligatoire
project_idstrNone
actionslist[deploy.drivers.base.ResourceAction][]
total_cost_estimatestrNone
estimated_durationstrNone
current_imagestrNone
current_urlstrNone
current_statusstrNone
target_imagestrobligatoire
target_portint8000
target_env_varsdict[str, str]
target_secretsdict[str, str]

deploy.drivers.base.DeploymentResult​

Résultat d'une opération de déploiement.

ChampTypeValeur par défautDescription
successboolobligatoire
service_urlstrNone
service_idstrNone
revisionstrNone
image_digeststrNone
statusstr'unknown'
health_statusstr'unknown'
deployment_timefloatNone
error_messagestrNone
error_detailsdict[str, typing.Any]None

deploy.state.DeploymentState​

Modèle d'état du déploiement.

ChampTypeValeur par défautDescription
versionint2Version du format du fichier d'état
service_namestrobligatoireNom du service déployé
platformstrobligatoirePlateforme cible (cloud-run
environmentstrobligatoireEnvironnement (dev
regionstrobligatoireRégion du fournisseur
project_idstrNoneProjet GCP / compte AWS / projet DO
image_tagstrobligatoireTag de l'image Docker
image_digeststrNoneEmpreinte (digest) de l'image Docker
service_urlstrNoneURL publique du service
revisionstrNoneRévision ou version du service
created_atdatetime—Date de création du déploiement
updated_atdatetime—Date de dernière mise à jour
statusstr'unknown'Statut du déploiement
health_statusstr'unknown'Statut du contrôle de santé
portint8000Port de l'application
api_key_generatedboolFalseIndique si la clé d'API a été générée
rsa_key_generatedboolFalseIndique si la clé RSA a été générée
provider_datadict[str, Any]—Données propres à la plateforme

deploy.drivers.base.ResourceAction​

Représente une action à effectuer sur une ressource.

ChampTypeValeur par défautDescription
resource_type<enum 'ResourceType'>obligatoire
action_type<enum 'ActionType'>obligatoire
resource_namestrobligatoire
descriptionstrobligatoire
cost_estimatestrNone
metadatadict[str, typing.Any]None

deploy.health.HealthCheckConfig​

Configuration des opérations de contrôle de santé.

ChampTypeValeur par défautDescription
timeoutint60
max_retriesint5
base_delayfloat1.0
max_delayfloat30.0
backoff_multiplierfloat2.0
success_thresholdint1
endpointslist[str]None

deploy.health.HealthCheckResult​

Résultat d'une opération de contrôle de santé.

ChampTypeValeur par défautDescription
status<enum 'HealthStatus'>obligatoire
response_timefloatobligatoire
status_codeintNone
error_messagestrNone
endpointstrNone
timestampfloat0.0

event.AbstractEvent​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
sourcedict[str, Any]obligatoire
accountAnyobligatoire
type<enum 'EventType'>obligatoire
object_typestrobligatoire
detailsdict[str, Any]obligatoire

event.AgentRegisterEvent​

Hérite de : event.Event

Événement envoyé lorsqu'un agent s'enregistre auprès du système de contrôle.

Test dans tests/test_agent_register_event.py

Aucun champ supplémentaire par rapport à la classe parente.

event.CaseStartEvent​

Hérite de : event.Event

Aucun champ supplémentaire par rapport à la classe parente.

event.CaseUpdateEvent​

Hérite de : event.Event

Aucun champ supplémentaire par rapport à la classe parente.

event.Event​

Hérite de : event.AbstractEvent

Classe de base de tous les événements du système de contrôle Supervaize.

Les événements représentent des messages envoyés par les agents au système de contrôle pour communiquer des statuts, des anomalies, des livrables et d'autres informations.

Hérite de AbstractEvent, qui définit les attributs de base de l'événement :

  • source : la source ou l'origine de l'événement (par ex. URI de l'agent ou du serveur)
  • type : l'enum EventType indiquant la catégorie de l'événement
  • account : le compte auquel l'événement appartient
  • details : un dictionnaire contenant les détails propres à l'événement

Tests dans tests/test_event.py

Aucun champ supplémentaire par rapport à la classe parente.

event.JobFinishedEvent​

Hérite de : event.Event

Aucun champ supplémentaire par rapport à la classe parente.

event.ServerRegisterEvent​

Hérite de : event.Event

Aucun champ supplémentaire par rapport à la classe parente.

job.AbstractJob​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
idstrobligatoire
namestrobligatoire
agent_namestrobligatoire
status<enum 'EntityStatus'>obligatoire
job_contextJobContextobligatoire
payloadAnyNone
resultAnyNone
errorstrNone
responseslist[job.JobResponse][]
finished_atdatetimeNone
created_atdatetimeNone
agent_parameterslist[dict[str, typing.Any]]None
case_idslist[str][]
metadatadict[str, Any]—Métadonnées métier fournies par l'agent (par ex. contexte de l'objet source)

job.JobInstructions​

Hérite de : common.SvBaseModel

Champs du modèle​

ChampTypeValeur par défautDescription
max_casesintNone
max_durationintNone
max_costfloatNone
stop_on_warningboolFalse
stop_on_errorboolTrue
job_start_timefloatNone

protocol.a2a.controller.JsonRpcError​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
codeintobligatoire
messagestrobligatoire
datadict[str, typing.Any]None

protocol.a2a.controller.JsonRpcRequest​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
jsonrpcLiteral['2.0']'2.0'
idstr | intNone
methodstrobligatoire
paramsdict[str, Any]—

protocol.a2a.controller.JsonRpcResponse​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
jsonrpcLiteral['2.0']'2.0'
idstr | intNone
resultdict[str, typing.Any]None
errorJsonRpcErrorNone

routes.CaseUpdateRequest​

Hérite de : common.SvBaseModel

Modèle de requête pour mettre à jour un case avec la réponse à une question.

Champs du modèle​

ChampTypeValeur par défautDescription
answerdict[str, Any]obligatoire
messagestrNone

server_utils.ErrorResponse​

Modèle de réponse d'erreur standard

ChampTypeValeur par défautDescription
errorstrobligatoire
error_type<enum 'ErrorType'>obligatoire
detailstrNone
timestampdatetimedatetime.datetime(2026, 10, 30, 9, 9, 43, 241638)
status_codeintobligatoire

routes.RegistrationRefreshRequest​

Hérite de : common.SvBaseModel

Modèle de requête pour renvoyer l'événement d'enregistrement du serveur.

Champs du modèle​

ChampTypeValeur par défautDescription
reasonstrNone
requested_atstrNone

server_info.ServerInfo​

Informations complètes du serveur pour le stockage.

ChampTypeValeur par défautDescription
idstr'server_instance'
hoststrobligatoire
portintobligatoire
api_versionstrobligatoire
environmentstrobligatoire
agentslist[dict[str, str]]obligatoire
start_timefloatobligatoire
created_atstrobligatoire
updated_atstrobligatoire

telemetry.TelemetryModel​

Classe de base pour créer des modèles Pydantic.

ChampTypeValeur par défautDescription
agentIdstrobligatoire
type<enum 'TelemetryType'>obligatoire
category<enum 'TelemetryCategory'>obligatoire
severity<enum 'TelemetrySeverity'>obligatoire
detailsdict[str, Any]obligatoire

workspace_authorization.WorkspaceAuthorizationClaims​

Hérite de : contracts.ContractModel

Champs du modèle​

ChampTypeValeur par défautDescription
issstrobligatoire
audstr | list[str]obligatoire
substrNone
grant_idstrobligatoire
workspace_idstrobligatoire
workspace_slugstrNone
agent_idstrobligatoire
agent_slugstrobligatoire
server_idstrobligatoire
scopeslist[str]—
agent_workspace_refstrNone
iatintNone
expintobligatoire
jtistrNone

Téléversé le 2026-10-30 09:09:43