ToolsRunOptionalParams interface

Paket:
@azure/ai-discovery

Valfria parametrar.

Extends
OperationOptions

Egenskaper

command

Kommando för att passa till verktygscontaineringångspunkten.

Om verktyget har flera containrar definierade utförs detta kommando på alla.

Om de utelämnas utför alla behållare sina råa ingångspunkter.

Detta kommando tolkas till en argumentlista som skickas till den underliggande containerruntimen. Till exempel, om kommandot är "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", så kommer containerruntimen att få följande argumentlista: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Containerns ingångspunkt är inte överstyrd. I Docker-terminologi blir argumentlistan ovanstående CMD, inte ENTRYPOINT för den uppskjutna containern.

Vår tolkning inkluderar följande begränsade tolkning av specialtecken:

  • De enda specialtecknen är " ' och .
  • Bakslag \ undgår nästa karaktär om den karaktären är en speciell karaktär, vilket bevarar dess bokstavliga värde.
  • Dubbla citattecken " bevarar bokstavligen allt inuti dem, med undantag för tecknen " och , som måste undvikas med en bakåtslängd "". Omatchade citater ger ett fel.
  • Enskilda citat ' bevarar bokstavligen allt i dem. Ett enda citat kan inte förekomma inom enkla citattecken. Omatchade citater ger ett fel.

Om du vill köra ett kommando som bygger på skalfunktioner som globbing eller utgångsomdirigering måste du antingen:

  • Använd en container med en ingångspunkt som är ett skal (t.ex. /bin/sh eller /bin/bash) och skicka ett kommando som är giltigt för det skalet, t.ex. -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Använd en container som har ett skal installerat och inkludera skalet i kommandot, t.ex. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
environmentVariables

Valfria miljövariabler att ställa in i verktygscontainern. Detta får inte innehålla några hemligheter.
infraOverrides

Åsidosätt infrastrukturkraven i verktygsdefinitionerna.
inlineFiles

Kodade inline-filer som monteras i containern, t.ex. för genererad kod.
inputData

Inmatningsdatareferenser och monteringsvägar.
outputData

Utdata referenser och monteringsvägar.
updateIntervalInMs

Vänta till nästa omröstning, i millisekunder.

Ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.
onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.
requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.
tracingOptions

Alternativ som används när spårning är aktiverat.

Egenskapsinformation

command

Kommando för att passa till verktygscontaineringångspunkten.

Om verktyget har flera containrar definierade utförs detta kommando på alla.

Om de utelämnas utför alla behållare sina råa ingångspunkter.

Detta kommando tolkas till en argumentlista som skickas till den underliggande containerruntimen. Till exempel, om kommandot är "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", så kommer containerruntimen att få följande argumentlista: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Containerns ingångspunkt är inte överstyrd. I Docker-terminologi blir argumentlistan ovanstående CMD, inte ENTRYPOINT för den uppskjutna containern.

Vår tolkning inkluderar följande begränsade tolkning av specialtecken:

  • De enda specialtecknen är " ' och .
  • Bakslag \ undgår nästa karaktär om den karaktären är en speciell karaktär, vilket bevarar dess bokstavliga värde.
  • Dubbla citattecken " bevarar bokstavligen allt inuti dem, med undantag för tecknen " och , som måste undvikas med en bakåtslängd "". Omatchade citater ger ett fel.
  • Enskilda citat ' bevarar bokstavligen allt i dem. Ett enda citat kan inte förekomma inom enkla citattecken. Omatchade citater ger ett fel.

Om du vill köra ett kommando som bygger på skalfunktioner som globbing eller utgångsomdirigering måste du antingen:

  • Använd en container med en ingångspunkt som är ett skal (t.ex. /bin/sh eller /bin/bash) och skicka ett kommando som är giltigt för det skalet, t.ex. -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Använd en container som har ett skal installerat och inkludera skalet i kommandot, t.ex. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
command?: string

Egenskapsvärde

string

environmentVariables

Valfria miljövariabler att ställa in i verktygscontainern. Detta får inte innehålla några hemligheter.

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

Egenskapsvärde

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

infraOverrides

Åsidosätt infrastrukturkraven i verktygsdefinitionerna.

infraOverrides?: InfraOverrides

Egenskapsvärde

InfraOverrides

inlineFiles

Kodade inline-filer som monteras i containern, t.ex. för genererad kod.

inlineFiles?: InlineFile[]

Egenskapsvärde

InlineFile[]

inputData

Inmatningsdatareferenser och monteringsvägar.

inputData?: InputDataMount[]

Egenskapsvärde

InputDataMount[]

outputData

Utdata referenser och monteringsvägar.

outputData?: OutputDataMount[]

Egenskapsvärde

OutputDataMount[]

updateIntervalInMs

Vänta till nästa omröstning, i millisekunder.

updateIntervalInMs?: number

Egenskapsvärde

number

Information om ärvda egenskaper

abortSignal

Den signal som kan användas för att avbryta begäranden.

abortSignal?: AbortSignalLike

Egenskapsvärde

AbortSignalLike

ärvd från OperationOptions.abortSignal

onResponse

En funktion som ska anropas varje gång ett svar tas emot från servern när den begärda åtgärden utförs. Kan anropas flera gånger.

onResponse?: RawResponseCallback

Egenskapsvärde

RawResponseCallback

ärvd från OperationOptions.onResponse

requestOptions

Alternativ som används när du skapar och skickar HTTP-begäranden för den här åtgärden.

requestOptions?: OperationRequestOptions

Egenskapsvärde

OperationRequestOptions

ärvd från OperationOptions.requestOptions

tracingOptions

Alternativ som används när spårning är aktiverat.

tracingOptions?: OperationTracingOptions

Egenskapsvärde

OperationTracingOptions

ärvd från OperationOptions.tracingOptions