ToolsRunOptionalParams interface

Pacote:
@azure/ai-discovery

Parâmetros opcionais.

Extends
OperationOptions

Propriedades

command

Comando para passar para o ponto de entrada do contentor da ferramenta.

Se a ferramenta tiver vários contentores definidos, este comando é executado em todos eles.

Se forem omitidos, todos os contentores executam os seus pontos de entrada brutos.

Este comando é analisado numa lista de argumentos que é passada para o tempo de execução do contentor subjacente. Por exemplo, se o comando for "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", então o tempo de execução do contentor receberá a seguinte lista de argumentos: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

O ponto de entrada do contentor não é ultrapassado. Na terminologia Docker, a lista de argumentos acima torna-se o CMD, e não o PONTO de ENTRADA do contentor lançado.

A nossa análise inclui a seguinte interpretação limitada de caracteres especiais:

  • Os únicos caracteres especiais são " ' e .
  • Barras \ inversas escapam do próximo carácter se esse personagem for especial, preservando o seu valor literal.
  • As aspas " duplas preservam tudo dentro delas literalmente, com exceção dos caracteres " e , que devem ser evitados com uma barra diagonal ''. Citações não correspondidas podem gerar um erro.
  • As citações ' individuais preservam tudo dentro de si literalmente. Uma citação única não pode ocorrer dentro de aspas simples. Citações não correspondidas podem gerar um erro.

Se quiser executar um comando que dependa de características do shell como globbing ou redirecionamento de saída, precisa de:

  • Use um contentor com um ponto de entrada que seja um shell (por exemplo, /bin/sh ou /bin/bash) e passe um comando válido para esse shell, por exemplo. -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Use um contentor que tenha uma concha instalada e inclua a concha no comando, por exemplo. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
environmentVariables

Variáveis de ambiente opcionais para definir no contentor de ferramentas. Isto não deve conter segredos.
infraOverrides

Sobrepor os requisitos de infraestrutura nas definições da ferramenta.
inlineFiles

Ficheiros inline codificados para serem montados no contentor, por exemplo, para código gerado.
inputData

Referências de dados de entrada e caminhos de montagem.
outputData

Referencias de dados de saída e caminhos de montagem.
updateIntervalInMs

Adie para esperar até a próxima votação, em milissegundos.

Propriedades Herdadas

abortSignal

O sinal que pode ser usado para abortar solicitações.
onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.
requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.
tracingOptions

Opções usadas quando o rastreamento está habilitado.

Detalhes de Propriedade

command

Comando para passar para o ponto de entrada do contentor da ferramenta.

Se a ferramenta tiver vários contentores definidos, este comando é executado em todos eles.

Se forem omitidos, todos os contentores executam os seus pontos de entrada brutos.

Este comando é analisado numa lista de argumentos que é passada para o tempo de execução do contentor subjacente. Por exemplo, se o comando for "python /code/wrapper.py --input /inputs/abcdef-input-1/input.txt --output /outputs/abcdef-output-1", então o tempo de execução do contentor receberá a seguinte lista de argumentos: ["python", "/code/wrapper.py", "--input", "/inputs/abcdef-input-1/input.txt", "--output", "/outputs/abcdef-output-1"]

O ponto de entrada do contentor não é ultrapassado. Na terminologia Docker, a lista de argumentos acima torna-se o CMD, e não o PONTO de ENTRADA do contentor lançado.

A nossa análise inclui a seguinte interpretação limitada de caracteres especiais:

  • Os únicos caracteres especiais são " ' e .
  • Barras \ inversas escapam do próximo carácter se esse personagem for especial, preservando o seu valor literal.
  • As aspas " duplas preservam tudo dentro delas literalmente, com exceção dos caracteres " e , que devem ser evitados com uma barra diagonal ''. Citações não correspondidas podem gerar um erro.
  • As citações ' individuais preservam tudo dentro de si literalmente. Uma citação única não pode ocorrer dentro de aspas simples. Citações não correspondidas podem gerar um erro.

Se quiser executar um comando que dependa de características do shell como globbing ou redirecionamento de saída, precisa de:

  • Use um contentor com um ponto de entrada que seja um shell (por exemplo, /bin/sh ou /bin/bash) e passe um comando válido para esse shell, por exemplo. -c 'python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1'
  • Use um contentor que tenha uma concha instalada e inclua a concha no comando, por exemplo. sh -c "python /code/wrapper.py --input /inputs/abcdef-input-1/* --output /outputs/abcdef-output-1"
command?: string

Valor de Propriedade

string

environmentVariables

Variáveis de ambiente opcionais para definir no contentor de ferramentas. Isto não deve conter segredos.

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

Valor de Propriedade

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

infraOverrides

Sobrepor os requisitos de infraestrutura nas definições da ferramenta.

infraOverrides?: InfraOverrides

Valor de Propriedade

InfraOverrides

inlineFiles

Ficheiros inline codificados para serem montados no contentor, por exemplo, para código gerado.

inlineFiles?: InlineFile[]

Valor de Propriedade

InlineFile[]

inputData

Referências de dados de entrada e caminhos de montagem.

inputData?: InputDataMount[]

Valor de Propriedade

InputDataMount[]

outputData

Referencias de dados de saída e caminhos de montagem.

outputData?: OutputDataMount[]

Valor de Propriedade

OutputDataMount[]

updateIntervalInMs

Adie para esperar até a próxima votação, em milissegundos.

updateIntervalInMs?: number

Valor de Propriedade

number

Detalhes da Propriedade Herdada

abortSignal

O sinal que pode ser usado para abortar solicitações.

abortSignal?: AbortSignalLike

Valor de Propriedade

AbortSignalLike

herdado de OperationOptions.abortSignal

onResponse

Uma função a ser chamada cada vez que uma resposta é recebida do servidor durante a execução da operação solicitada. Pode ser chamado várias vezes.

onResponse?: RawResponseCallback

Valor de Propriedade

RawResponseCallback

herdado de OperationOptions.onResponse

requestOptions

Opções usadas ao criar e enviar solicitações HTTP para esta operação.

requestOptions?: OperationRequestOptions

Valor de Propriedade

OperationRequestOptions

herdado de OperationOptions.requestOptions

tracingOptions

Opções usadas quando o rastreamento está habilitado.

tracingOptions?: OperationTracingOptions

Valor de Propriedade

OperationTracingOptions

herdado de OperationOptions.tracingOptions