Aller au contenu principal

enterprise_ai.multimodal

Source : sdks/python/src/enterprise_ai/multimodal/__init__.py. Retour à l'index de la référence du SDK Python.

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 MultimodalClient​

Multimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.

Resource

Attributs :

NomTypeRequisDescription
audioAudioClientouiMultimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.
imageImageClientouiMultimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.
sttSttClientouiMultimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.
ttsTtsClientouiMultimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.
videoVideoClientouiMultimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.
visionVisionClientouiMultimodal. Médias et traitement multimodal : stockage chiffré de médias et travaux de vision, génération et retouche d'images, traitement et génération de vidéos, transcription de la parole, diarisation, synthèse vocale et DLP multimodale.

Constructeur MultimodalClient​

MultimodalClient(transport: Any, client: Any = None) -> None

Construit le client et ses aides par modalité vision, image, video, audio, stt et tts sur le même transport.

NomTypeDéfautRequisDescription
transportAnyouiTransport partagé par les sous-clients d'un même client.
clientAnyNonenonClient parent.

MultimodalClient.complete_job​

complete_job(job_id: str, status: str, output: dict[str, Any] | None = None, error: str | None = None, units: dict[str, Any] | None = None) -> Any

Signaler le résultat d'un travail en file. Appelé par les workers GPU (identités d'agent ou de service) pour signaler le résultat d'un travail en file : statut running, succeeded, failed ou cancelled (sinon 400 invalid_request), avec sortie, erreur et unités mesurées ; la réservation de quota est validée ou libérée. Un travail terminé répond 409 conflict. Demande agent ou tenant_admin. 404 not_found.

Route : /v1/multimodal/jobs/{job_id}/complete (POST).

NomTypeDéfautRequisDescription
job_idstrouiIdentifiant (UUID) du travail.
statusstrouirunning, succeeded, failed ou cancelled.
outputdict[str, Any] | NoneNonenonSortie de l'opération (transcription, références d'images...).
errorstr | NoneNonenonMessage d'erreur d'un travail en échec.
unitsdict[str, Any] | NoneNonenonUnités d'usage mesurées, par exemple {"audio_seconds": 12.5}.

Retour : Any. Réponse JSON décodée de l'opération « Signaler le résultat d'un travail en file ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MultimodalClient.delete_media​

delete_media(media_id: str) -> Any

Supprimer un média. Supprime le média et son contenu stocké. Permis pour son créateur, tenant_admin ou security_officer (403 forbidden). Un média sous conservation légale répond 409 legal_hold. Audité sous media.delete.

Route : /v1/media/{media_id} (DELETE).

NomTypeDéfautRequisDescription
media_idstrouiIdentifiant (UUID) du média.

Retour : Any. Réponse JSON décodée de l'opération « Supprimer un média ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MultimodalClient.get_media​

get_media(media_id: str, include_content: bool = False) -> Any

Lire un média. Renvoie le document Multimodal Contract du média. Avec include_content=true, la réponse est {media, content_base64} avec le contenu déchiffré ; cela demande une habilitation au moins égale à la classification du média (403 policy_denied) et est audité sous media.read.

Route : /v1/media/{media_id} (GET).

NomTypeDéfautRequisDescription
media_idstrouiIdentifiant (UUID) du média.
include_contentboolFalsenonSi vrai, renvoie aussi le contenu déchiffré, encodé en base64. Faux par défaut.

Retour : Any. Réponse JSON décodée de l'opération « Lire un média ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MultimodalClient.job​

job(job_id: str) -> Any

Lire un travail multimodal. Renvoie le travail : opération, statut, paramètres d'entrée, sortie, erreur, adaptateur, unités et coût. 404 not_found.

Route : /v1/multimodal/jobs/{job_id} (GET).

NomTypeDéfautRequisDescription
job_idstrouiIdentifiant (UUID) du travail.

Retour : Any. Réponse JSON décodée de l'opération « Lire un travail multimodal ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MultimodalClient.jobs​

jobs(status: str | None = None, operation: str | None = None, **page: Any) -> Any

Lister les travaux multimodaux. Travaux du tenant, du plus récent au plus ancien, paginés avec cursor, filtrables par statut et opération.

Route : /v1/multimodal/jobs (GET).

NomTypeDéfautRequisDescription
statusstr | NoneNonenonSeulement ce statut : queued, running, succeeded, failed ou cancelled.
operationstr | NoneNonenonSeulement cette opération, par exemple stt ou image_generation.
**pageAnynonOptions de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

Retour : Any. Réponse JSON décodée de l'opération « Lister les travaux multimodaux ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MultimodalClient.list_media​

list_media(**page: Any) -> Any

Lister les médias. Médias du tenant (documents Multimodal Contract), paginés par clé avec cursor, filtrés par media_type et classification (400 invalid_request pour une valeur inconnue).

Route : /v1/media (GET).

NomTypeDéfautRequisDescription
**pageAnynonOptions de pagination transmises à la liste : limit (nombre maximal d'éléments par page) et cursor (le next_cursor de la page précédente). Itérer sur la page renvoyée suit tous les curseurs.

Retour : Any. Réponse JSON décodée de l'opération « Lister les médias ».

Erreurs levées : les erreurs typées du transport (Erreurs).

MultimodalClient.upload​

upload(content: bytes, filename: str, content_type: str = 'application/octet-stream', classification: str | None = None) -> Any

Téléverser un média. Enregistre un média (201) à partir de JSON {content_base64, mime_type, filename?, operation?, dlp_mode?, retention_days?, classification?} ou de multipart/form-data avec une partie file et les mêmes champs. Tout principal du tenant peut l'appeler. Étapes : 1. Taille contrôlée par rapport au maximum de la plateforme (50 Mio sauf configuration ; 413 media_too_large). 2. Analyse du fichier par ClamAV et YARA-X (422 file_blocked, 503 file_scan_unavailable). 3. Extraction du texte et DLP avec dlp_mode (detect par défaut ; block répond 422 dlp_blocked quand des données personnelles sont trouvées) ; la classification est relevée en conséquence. 4. Le contenu est chiffré avec une clé du tenant et enregistré. Renvoie le document Multimodal Contract.

Route : /v1/media (POST).

NomTypeDéfautRequisDescription
contentbytesouiOctets du fichier à téléverser.
filenamestrouiNom du fichier téléversé, envoyé avec la partie multipart.
content_typestr'application/octet-stream'nonType de contenu transmis au stockage lors de la signature de l'URL (le type que l'envoi doit transmettre) ; 200 caractères au plus.
classificationstr | NoneNonenonSeulement cette classification : public, internal, confidential, restricted ou secret.

Retour : Any. Réponse JSON décodée de l'opération « Téléverser un média ».

Erreurs levées : les erreurs typées du transport (Erreurs).