ToolsRunOptionalParams interface

Pakket:
@azure/ai-discovery

Optionele parameters.

Uitbreiding
OperationOptions

Eigenschappen

command

Commando om naar het entry point van tool container te gaan.

Als de tool meerdere containers heeft gedefinieerd, wordt dit commando op allemaal uitgevoerd.

Als deze wordt weggelaten, voeren alle containers hun ruwe instappunten uit.

Dit commando wordt geparsed in een argumentlijst die wordt doorgegeven aan de onderliggende containerruntime. Als het commando bijvoorbeeld is "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", dan ontvangt de containerruntime de volgende argumentlijst: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Het toegangspunt van de container wordt niet overschreven. In Docker-terminologie wordt bovenstaande argumentenlijst de CMD, niet het ENTRYPOINT van de gelanceerde container.

Onze parsing omvat de volgende beperkte interpretatie van speciale tekens:

  • De enige speciale tekens zijn " ' en .
  • Terugslagen \ ontsnappen aan het volgende personage als dat personage een speciaal personage is, waardoor zijn letterlijke waarde behouden blijft.
  • Dubbele aanhalingstekens " behouden letterlijk alles erin, met uitzondering van de tekens " en , die met een backslash moeten worden overschreden. Niet-gematchte citaten geven een foutmelding.
  • Enkele citaten ' bewaren letterlijk alles erin. Een enkele quote kan niet voorkomen binnen enkele aanhalingstekens. Niet-gematchte citaten geven een foutmelding.

Als je een commando wilt uitvoeren dat afhankelijk is van shellfuncties zoals globbing of output redirection, moet je ofwel:

  • Gebruik een container met een entrypoint dat een shell is (bijv. /bin/sh of /bin/bash) en geef een commando door dat geldig is voor die shell, bijvoorbeeld -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Gebruik een container met een shell geïnstalleerd en neem de shell op in het commando, bijvoorbeeld. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
environmentVariables

Optionele omgevingsvariabelen om in de toolcontainer in te stellen. Dit mag geen geheimen bevatten.
infraOverrides

Overschrijf de infrastructuurvereisten in de tooldefinities.
inlineFiles

Gecodeerde inline-bestanden die in de container worden gemount, bijvoorbeeld voor gegenereerde code.
inputData

Invoer datareferenties en mountpaden.
outputData

Output datareferenties en mountpaden.
updateIntervalInMs

Wacht tot de volgende poll, in milliseconden.

Overgenomen eigenschappen

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

command

Commando om naar het entry point van tool container te gaan.

Als de tool meerdere containers heeft gedefinieerd, wordt dit commando op allemaal uitgevoerd.

Als deze wordt weggelaten, voeren alle containers hun ruwe instappunten uit.

Dit commando wordt geparsed in een argumentlijst die wordt doorgegeven aan de onderliggende containerruntime. Als het commando bijvoorbeeld is "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", dan ontvangt de containerruntime de volgende argumentlijst: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Het toegangspunt van de container wordt niet overschreven. In Docker-terminologie wordt bovenstaande argumentenlijst de CMD, niet het ENTRYPOINT van de gelanceerde container.

Onze parsing omvat de volgende beperkte interpretatie van speciale tekens:

  • De enige speciale tekens zijn " ' en .
  • Terugslagen \ ontsnappen aan het volgende personage als dat personage een speciaal personage is, waardoor zijn letterlijke waarde behouden blijft.
  • Dubbele aanhalingstekens " behouden letterlijk alles erin, met uitzondering van de tekens " en , die met een backslash moeten worden overschreden. Niet-gematchte citaten geven een foutmelding.
  • Enkele citaten ' bewaren letterlijk alles erin. Een enkele quote kan niet voorkomen binnen enkele aanhalingstekens. Niet-gematchte citaten geven een foutmelding.

Als je een commando wilt uitvoeren dat afhankelijk is van shellfuncties zoals globbing of output redirection, moet je ofwel:

  • Gebruik een container met een entrypoint dat een shell is (bijv. /bin/sh of /bin/bash) en geef een commando door dat geldig is voor die shell, bijvoorbeeld -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Gebruik een container met een shell geïnstalleerd en neem de shell op in het commando, bijvoorbeeld. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
command?: string

Waarde van eigenschap

string

environmentVariables

Optionele omgevingsvariabelen om in de toolcontainer in te stellen. Dit mag geen geheimen bevatten.

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

Waarde van eigenschap

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

infraOverrides

Overschrijf de infrastructuurvereisten in de tooldefinities.

infraOverrides?: InfraOverrides

Waarde van eigenschap

InfraOverrides

inlineFiles

Gecodeerde inline-bestanden die in de container worden gemount, bijvoorbeeld voor gegenereerde code.

inlineFiles?: InlineFile[]

Waarde van eigenschap

InlineFile[]

inputData

Invoer datareferenties en mountpaden.

inputData?: InputDataMount[]

Waarde van eigenschap

InputDataMount[]

outputData

Output datareferenties en mountpaden.

outputData?: OutputDataMount[]

Waarde van eigenschap

OutputDataMount[]

updateIntervalInMs

Wacht tot de volgende poll, in milliseconden.

updateIntervalInMs?: number

Waarde van eigenschap

number

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions