ToolsRunOptionalParams interface

Pakiet:
@azure/ai-discovery

Parametry opcjonalne.

Rozszerzenie
OperationOptions

Właściwości

command

Polecenie do przekazania do punktu wejścia kontenera narzędzi.

Jeśli narzędzie ma zdefiniowanych wiele kontenerów, to polecenie jest wykonywane na wszystkich.

Jeśli zostanie pominięty, wszystkie kontenery wykonują swoje surowe punkty wejścia.

To polecenie jest parsowane na listę argumentów, która jest przekazywana do bazowego poziomu uruchomieniowego kontenera. Na przykład, jeśli polecenie to "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", to czas uruchomienia kontenera otrzyma następującą listę argumentów: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Punkt wejścia do kontenera nie jest nadpisywany. W terminologii Dockera powyższa lista argumentów staje się CMD, a nie PUNKTEM ENTRY uruchomionego kontenera.

Nasze parsowanie obejmuje następujące ograniczone interpretacje znaków specjalnych:

  • Jedynymi znakami specjalnymi są " ' i .
  • Ukośniki \ wsteczne wychodzą z następnego znaku, jeśli ten znak jest znakiem specjalnym, zachowując jego dosłowną wartość.
  • Podwójne cudzysły " dosłownie zachowują wszystko w środku, z wyjątkiem znaków " i , które trzeba wykonywać kośnicą wsteczną ''. Niedopasowane cytaty mogą wywołać błąd.
  • Pojedyncze cudzysłowy ' dosłownie zachowują wszystko w sobie. Pojedynczy cytat nie może występować w ramach pojedynczych cytatów. Niedopasowane cytaty mogą wywołać błąd.

Jeśli chcesz uruchomić polecenie oparte na cechach powłoki, takich jak globbing lub przekierowanie wyjścia, musisz albo:

  • Użyj kontenera z punktem wejścia, który jest powłoką (np. /bin/sh lub /bin/bash) i przekaż polecenie ważne dla tej powłoki, np. -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • użyj kontenera, w którym zainstalowano powłokę, i uwzględnij powłokę w komendze, np. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
environmentVariables

Opcjonalne zmienne środowiskowe do ustawienia w kontenerze narzędzi. To nie może skrywać żadnych tajemnic.
infraOverrides

Nadpisz wymagania infrastrukturalne w definicjach narzędzi.
inlineFiles

Zakodowane pliki inline do zamontowania w kontenerze, np. dla wygenerowanego kodu.
inputData

Referencje danych wejściowych i ścieżki montażu.
outputData

Odniesienia do danych wyjściowych i ścieżki montażu.
updateIntervalInMs

Opóźnienie oczekiwania na następną ankietę w milisekundach.

Właściwości dziedziczone

abortSignal

Sygnał, który może służyć do przerwania żądań.
onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.
requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.
tracingOptions

Opcje używane podczas śledzenia są włączone.

Szczegóły właściwości

command

Polecenie do przekazania do punktu wejścia kontenera narzędzi.

Jeśli narzędzie ma zdefiniowanych wiele kontenerów, to polecenie jest wykonywane na wszystkich.

Jeśli zostanie pominięty, wszystkie kontenery wykonują swoje surowe punkty wejścia.

To polecenie jest parsowane na listę argumentów, która jest przekazywana do bazowego poziomu uruchomieniowego kontenera. Na przykład, jeśli polecenie to "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", to czas uruchomienia kontenera otrzyma następującą listę argumentów: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

Punkt wejścia do kontenera nie jest nadpisywany. W terminologii Dockera powyższa lista argumentów staje się CMD, a nie PUNKTEM ENTRY uruchomionego kontenera.

Nasze parsowanie obejmuje następujące ograniczone interpretacje znaków specjalnych:

  • Jedynymi znakami specjalnymi są " ' i .
  • Ukośniki \ wsteczne wychodzą z następnego znaku, jeśli ten znak jest znakiem specjalnym, zachowując jego dosłowną wartość.
  • Podwójne cudzysły " dosłownie zachowują wszystko w środku, z wyjątkiem znaków " i , które trzeba wykonywać kośnicą wsteczną ''. Niedopasowane cytaty mogą wywołać błąd.
  • Pojedyncze cudzysłowy ' dosłownie zachowują wszystko w sobie. Pojedynczy cytat nie może występować w ramach pojedynczych cytatów. Niedopasowane cytaty mogą wywołać błąd.

Jeśli chcesz uruchomić polecenie oparte na cechach powłoki, takich jak globbing lub przekierowanie wyjścia, musisz albo:

  • Użyj kontenera z punktem wejścia, który jest powłoką (np. /bin/sh lub /bin/bash) i przekaż polecenie ważne dla tej powłoki, np. -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • użyj kontenera, w którym zainstalowano powłokę, i uwzględnij powłokę w komendze, np. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
command?: string

Wartość właściwości

string

environmentVariables

Opcjonalne zmienne środowiskowe do ustawienia w kontenerze narzędzi. To nie może skrywać żadnych tajemnic.

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

Wartość właściwości

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

infraOverrides

Nadpisz wymagania infrastrukturalne w definicjach narzędzi.

infraOverrides?: InfraOverrides

Wartość właściwości

InfraOverrides

inlineFiles

Zakodowane pliki inline do zamontowania w kontenerze, np. dla wygenerowanego kodu.

inlineFiles?: InlineFile[]

Wartość właściwości

InlineFile[]

inputData

Referencje danych wejściowych i ścieżki montażu.

inputData?: InputDataMount[]

Wartość właściwości

InputDataMount[]

outputData

Odniesienia do danych wyjściowych i ścieżki montażu.

outputData?: OutputDataMount[]

Wartość właściwości

OutputDataMount[]

updateIntervalInMs

Opóźnienie oczekiwania na następną ankietę w milisekundach.

updateIntervalInMs?: number

Wartość właściwości

number

Szczegóły właściwości dziedziczonej

abortSignal

Sygnał, który może służyć do przerwania żądań.

abortSignal?: AbortSignalLike

Wartość właściwości

AbortSignalLike

dziedziczone z OperationOptions.abortSignal

onResponse

Funkcja, która ma być wywoływana za każdym razem, gdy odpowiedź jest odbierana z serwera podczas wykonywania żądanej operacji. Może być wywoływana wiele razy.

onResponse?: RawResponseCallback

Wartość właściwości

RawResponseCallback

dziedziczone z OperationOptions.onResponse

requestOptions

Opcje używane podczas tworzenia i wysyłania żądań HTTP dla tej operacji.

requestOptions?: OperationRequestOptions

Wartość właściwości

OperationRequestOptions

dziedziczone z OperationOptions.requestOptions

tracingOptions

Opcje używane podczas śledzenia są włączone.

tracingOptions?: OperationTracingOptions

Wartość właściwości

OperationTracingOptions

dziedziczone z OperationOptions.tracingOptions