ToolsRunOptionalParams interface

Pacchetto:
@azure/ai-discovery

Parametri facoltativi.

Extends
OperationOptions

Proprietà

command

Comando da passare al punto di ingresso del contenitore degli utensili.

Se lo strumento ha più container definiti, questo comando viene eseguito su tutti.

Se omesso, tutti i contenitori eseguono i loro punti di ingresso grezzi.

Questo comando viene analizzato in una lista di argomenti che viene passata al runtime del container sottostante. Ad esempio, se il comando è "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", allora l'esecuzione del container riceverà la seguente lista di argomenti: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Il punto di ingresso del container non viene sovrascritto. In termini Docker, la lista degli argomenti sopra diventa il CMD, non il punto INGRESSO del container lanciato.

La nostra analisi comprende la seguente interpretazione limitata dei caratteri speciali:

  • Gli unici caratteri speciali sono " ' e .
  • Le barre \ diagonali sfuggono al carattere successivo se questo è un personaggio speciale, preservando il suo valore letterale.
  • Le virgolette " doppie conservano tutto ciò che contiene letteralmente, ad eccezione dei caratteri " e , che devono essere evitati con una barra inversa ''. Preventivi non abbinati generano errori.
  • Le virgolette ' singole conservano tutto ciò che contengono letteralmente. Una singola citazione non può avvenire all'interno di virgolette singole. Preventivi non abbinati generano errori.

Se desideri eseguire un comando che si basa su caratteristiche della shell come il globbing o la redirezione di output, devi o fare:

  • Usa un contenitore con un punto d'ingresso che è uno shell (ad esempio /bin/sh o /bin/bash) e passa un comando valido per quel shell, ad esempio -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Usa un contenitore che abbia un guscio installato e includi il guscio nel comando, ad esempio sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
environmentVariables

Variabili di ambiente opzionali da impostare nel contenitore degli strumenti. Questo non deve contenere segreti.
infraOverrides

Sovrascrivi i requisiti infrastrutturali nelle definizioni degli strumenti.
inlineFiles

File inline codificati da montare nel container, ad esempio per il codice generato.
inputData

Riferimenti ai dati di ingresso e percorsi di montatura.
outputData

Output di riferimenti dati e percorsi di montaggio.
updateIntervalInMs

Attendere fino al polling successivo, espresso in millisecondi.

Proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.
onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.
requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.
tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

command

Comando da passare al punto di ingresso del contenitore degli utensili.

Se lo strumento ha più container definiti, questo comando viene eseguito su tutti.

Se omesso, tutti i contenitori eseguono i loro punti di ingresso grezzi.

Questo comando viene analizzato in una lista di argomenti che viene passata al runtime del container sottostante. Ad esempio, se il comando è "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", allora l'esecuzione del container riceverà la seguente lista di argomenti: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Il punto di ingresso del container non viene sovrascritto. In termini Docker, la lista degli argomenti sopra diventa il CMD, non il punto INGRESSO del container lanciato.

La nostra analisi comprende la seguente interpretazione limitata dei caratteri speciali:

  • Gli unici caratteri speciali sono " ' e .
  • Le barre \ diagonali sfuggono al carattere successivo se questo è un personaggio speciale, preservando il suo valore letterale.
  • Le virgolette " doppie conservano tutto ciò che contiene letteralmente, ad eccezione dei caratteri " e , che devono essere evitati con una barra inversa ''. Preventivi non abbinati generano errori.
  • Le virgolette ' singole conservano tutto ciò che contengono letteralmente. Una singola citazione non può avvenire all'interno di virgolette singole. Preventivi non abbinati generano errori.

Se desideri eseguire un comando che si basa su caratteristiche della shell come il globbing o la redirezione di output, devi o fare:

  • Usa un contenitore con un punto d'ingresso che è uno shell (ad esempio /bin/sh o /bin/bash) e passa un comando valido per quel shell, ad esempio -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Usa un contenitore che abbia un guscio installato e includi il guscio nel comando, ad esempio sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
command?: string

Valore della proprietà

string

environmentVariables

Variabili di ambiente opzionali da impostare nel contenitore degli strumenti. Questo non deve contenere segreti.

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

Valore della proprietà

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

infraOverrides

Sovrascrivi i requisiti infrastrutturali nelle definizioni degli strumenti.

infraOverrides?: InfraOverrides

Valore della proprietà

InfraOverrides

inlineFiles

File inline codificati da montare nel container, ad esempio per il codice generato.

inlineFiles?: InlineFile[]

Valore della proprietà

InlineFile[]

inputData

Riferimenti ai dati di ingresso e percorsi di montatura.

inputData?: InputDataMount[]

Valore della proprietà

InputDataMount[]

outputData

Output di riferimenti dati e percorsi di montaggio.

outputData?: OutputDataMount[]

Valore della proprietà

OutputDataMount[]

updateIntervalInMs

Attendere fino al polling successivo, espresso in millisecondi.

updateIntervalInMs?: number

Valore della proprietà

number

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

AbortSignalLike

Ereditato da OperationOptions.abortSignal

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

onResponse?: RawResponseCallback

Valore della proprietà

RawResponseCallback

Ereditato da OperationOptions.onResponse

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

requestOptions?: OperationRequestOptions

Valore della proprietà

OperationRequestOptions

Ereditato da OperationOptions.requestOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

OperationTracingOptions

Ereditato da OperationOptions.tracingOptions