Aller au contenu principal

io.enterpriseai.contracts.ContractValidator

Source : sdks/java/enterprise-ai-java/src/main/java/io/enterpriseai/contracts/ContractValidator.java. Retour à l'index de la référence du SDK Java.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Classe ContractValidator​

Validation côté client avec la copie embarquée de contracts/v1 (JSON Schema 2020-12). Les manifestes sont reconnus par leur kind (Agent, Model, Tool, Skill, Plugin, Connector, Channel, ManagedComponent).

Attributs :

NomTypeRequisDescription
BASE_URIStringouiURI de base des schémas, https://schemas.enterprise-ai.io/v1/, redirigée vers les copies embarquées.

Constructeur ContractValidator​

ContractValidator(Locale locale)

Crée un validateur qui lit l'index embarqué des contrats et rédige ses messages dans la langue donnée.

NomTypeDéfautRequisDescription
localeLocaleouiLangue des messages d'erreur de validation, par exemple Locale.FRENCH.

ContractValidator.contracts​

List<String> contracts()

Noms des contrats connus de l'index embarqué.

Cet élément ne prend aucun paramètre.

Retour : List<String>. La liste non modifiable des noms de contrats, par exemple tool-manifest.

ContractValidator.schema​

JsonNode schema(String name)

Lit le JSON Schema embarqué d'un contrat.

NomTypeDéfautRequisDescription
nameStringouiNom d'un contrat de l'index ; un nom inconnu lève IllegalArgumentException.

Retour : JsonNode. Le JSON Schema du contrat, en JsonNode.

Erreurs levées : IllegalStateException.

ContractValidator.validate​

ValidationResult validate(String name, Object document)

Valide une valeur quelconque (JsonNode, Map, record) avec un contrat nommé.

NomTypeDéfautRequisDescription
nameStringouiNom du contrat, par exemple tool-manifest ; un nom inconnu lève IllegalArgumentException.
documentObjectouiValeur à valider : un JsonNode, une Map ou un record converti en JSON.

Retour : ValidationResult. Un ValidationResult : résultat de la validation, avec le nom du contrat et les erreurs.

ContractValidator.validateManifest​

ValidationResult validateManifest(Object manifest)

Valide un manifeste en choisissant le contrat d'après son kind.

NomTypeDéfautRequisDescription
manifestObjectouiManifeste à valider ; son kind choisit le contrat, un genre inconnu donne un résultat invalide pour le contrat unknown.

Retour : ValidationResult. Un ValidationResult : résultat de la validation, avec le nom du contrat et les erreurs.