ToolsRunOptionalParams interface

Paquet:
@azure/ai-discovery

Paramètres facultatifs.

Extends
OperationOptions

Propriétés

command

Commande à passer au point d’entrée du conteneur d’outils.

Si l’outil a plusieurs conteneurs définis, cette commande est exécutée sur tous.

Si elles sont omises, toutes les conteneurs exécutent leurs points d’entrée bruts.

Cette commande est analysée en une liste d’arguments qui est transmise au runtime du conteneur sous-jacent. Par exemple, si la commande est « python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1 », alors l’exécution du conteneur recevra la liste d’arguments suivante : ["python », « /code/wrapper.py », « --input », « /inputs/abcdef-input-1/input.txt« , « --output », « /outputs/abcdef-output-1"]

Le point d’entrée du conteneur n’est pas dépassé. En terminologie Docker, la liste d’arguments ci-dessus devient le CMD, et non le POINT d’ENTRÉE du conteneur lancé.

Notre analyse comprend l’interprétation limitée suivante des caractères spéciaux :

  • Les seuls caractères spéciaux sont " ' et .
  • Les barres \ obliques s’échappent du caractère suivant si ce personnage est un personnage spécial, préservant ainsi sa valeur littérale.
  • Les guillemets " doubles préservent littéralement tout ce qu’ils contenent, à l’exception des caractères « et , qui doivent être évités par une barre oblique ». Les devis non appariés peuvent générer une erreur.
  • Les guillemets ' simples conservent tout ce qu’ils contiennent littéralement. Une citation unique ne peut pas apparaître dans des guillemets simples. Les devis non appariés peuvent générer une erreur.

Si vous souhaitez exécuter une commande qui s’appuie sur des caractéristiques de shell telles que le globbing ou la redirection de sortie, vous devez soit :

  • Utilisez un conteneur dont le point d’entrée est un shell (par /bin/sh exemple ou /bin/bash) et passez une commande valide pour ce shell, par exemple -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Utilisez un conteneur avec une coquille installée, et incluez la coque dans la commande, par exemple sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
environmentVariables

Variables d’environnement optionnelles à définir dans le conteneur d’outils. Cela ne doit contenir aucun secret.
infraOverrides

Supplantez les exigences d’infrastructure dans les définitions des outils.
inlineFiles

Fichiers en ligne encodés à monter dans le conteneur, par exemple pour du code généré.
inputData

Références aux données d’entrée et chemins de monture.
outputData

Références de données de sortie et chemins de montage.
updateIntervalInMs

Délai d’attente jusqu’à l’interrogation suivante, en millisecondes.

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.
onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.
requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.
tracingOptions

Options utilisées lorsque le suivi est activé.

Détails de la propriété

command

Commande à passer au point d’entrée du conteneur d’outils.

Si l’outil a plusieurs conteneurs définis, cette commande est exécutée sur tous.

Si elles sont omises, toutes les conteneurs exécutent leurs points d’entrée bruts.

Cette commande est analysée en une liste d’arguments qui est transmise au runtime du conteneur sous-jacent. Par exemple, si la commande est « python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1 », alors l’exécution du conteneur recevra la liste d’arguments suivante : ["python », « /code/wrapper.py », « --input », « /inputs/abcdef-input-1/input.txt« , « --output », « /outputs/abcdef-output-1"]

Le point d’entrée du conteneur n’est pas dépassé. En terminologie Docker, la liste d’arguments ci-dessus devient le CMD, et non le POINT d’ENTRÉE du conteneur lancé.

Notre analyse comprend l’interprétation limitée suivante des caractères spéciaux :

  • Les seuls caractères spéciaux sont " ' et .
  • Les barres \ obliques s’échappent du caractère suivant si ce personnage est un personnage spécial, préservant ainsi sa valeur littérale.
  • Les guillemets " doubles préservent littéralement tout ce qu’ils contenent, à l’exception des caractères « et , qui doivent être évités par une barre oblique ». Les devis non appariés peuvent générer une erreur.
  • Les guillemets ' simples conservent tout ce qu’ils contiennent littéralement. Une citation unique ne peut pas apparaître dans des guillemets simples. Les devis non appariés peuvent générer une erreur.

Si vous souhaitez exécuter une commande qui s’appuie sur des caractéristiques de shell telles que le globbing ou la redirection de sortie, vous devez soit :

  • Utilisez un conteneur dont le point d’entrée est un shell (par /bin/sh exemple ou /bin/bash) et passez une commande valide pour ce shell, par exemple -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Utilisez un conteneur avec une coquille installée, et incluez la coque dans la commande, par exemple sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
command?: string

Valeur de propriété

string

environmentVariables

Variables d’environnement optionnelles à définir dans le conteneur d’outils. Cela ne doit contenir aucun secret.

environmentVariables?: { name: string, value?: string }[]

Valeur de propriété

{ name: string, value?: string }[]

infraOverrides

Supplantez les exigences d’infrastructure dans les définitions des outils.

infraOverrides?: InfraOverrides

Valeur de propriété

InfraOverrides

inlineFiles

Fichiers en ligne encodés à monter dans le conteneur, par exemple pour du code généré.

inlineFiles?: InlineFile[]

Valeur de propriété

InlineFile[]

inputData

Références aux données d’entrée et chemins de monture.

inputData?: InputDataMount[]

Valeur de propriété

InputDataMount[]

outputData

Références de données de sortie et chemins de montage.

outputData?: OutputDataMount[]

Valeur de propriété

OutputDataMount[]

updateIntervalInMs

Délai d’attente jusqu’à l’interrogation suivante, en millisecondes.

updateIntervalInMs?: number

Valeur de propriété

number

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour abandonner les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

héritée de OperationOptions.abortSignal

onResponse

Fonction à appeler chaque fois qu’une réponse est reçue du serveur lors de l’exécution de l’opération demandée. Peut être appelé plusieurs fois.

onResponse?: RawResponseCallback

Valeur de propriété

RawResponseCallback

héritée de OperationOptions.onResponse

requestOptions

Options utilisées lors de la création et de l’envoi de requêtes HTTP pour cette opération.

requestOptions?: OperationRequestOptions

Valeur de propriété

OperationRequestOptions

héritée de OperationOptions.requestOptions

tracingOptions

Options utilisées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

héritée de OperationOptions.tracingOptions