AgentsOperations interface

Interface que representa uma operação de agentes.

Propriedades

cancelOptimizationJob	Solicita o cancelamento de um trabalho em execução ou em fila. Devolve 409 Conflito se o trabalho já estiver em estado terminal.
createOptimizationJob	Cria um trabalho de otimização e devolve o trabalho em fila. Honras `Operation-Id` por retentativa idempotente. Os clientes consultam a URL `Operation-Location` usando a operação get.
createSession	Cria uma nova sessão para um endpoint agente. O endpoint resolve a versão do agente de backup a partir `version_indicator` e faz cumprir a propriedade da sessão usando a chave de isolamento fornecida para operações de mutação de sessão.
createVersionFromCode	Cria uma nova versão do agente a partir do código. Carrega o código postal e cria uma nova versão para um agente existente. O digest hexadecimal SHA-256 do zip é fornecido no `x-ms-code-zip-sha256` cabeçalho para integridade e deduplicação. O corpo do pedido é multipart/form-data com uma parte de metadados JSON e uma parte de código binário (a ordem das peças é irrelevante). O tamanho máximo de upload é de 250 MB.
delete	Exclui um agente. Para agentes alojados, se alguma versão tiver sessões ativas, o pedido é rejeitado com HTTP 409, a menos que `force` esteja definido como true. Quando a força é verdadeira, todas as sessões associadas são eliminadas em cascata, juntamente com o agente e as suas versões.
deleteOptimizationJob	Cancela trabalho ativo, depois apaga o trabalho e os artefactos do candidato.
deleteSession	Apaga uma sessão de forma síncrona. Devolve 204 Sem Conteúdo quando a sessão é eliminada ou não existe.
deleteSessionFile	Apaga o ficheiro ou diretório especificado do sandbox da sessão. Quando `recursive` é falso, eliminar um diretório não vazio devolve 409 Conflito.
deleteVersion	Exclui uma versão específica de um agente. Para agentes alojados, se a versão tiver sessões ativas, o pedido é rejeitado com HTTP 409, a menos que `force` esteja definido como true. Quando a força é verdadeira, todas as sessões associadas a esta versão são eliminadas em cascata.
disable	Desativa o agente especificado, impedindo-o de aceitar novas sessões ou processar pedidos. As sessões ativas existentes podem drenar com graça, mas não podem ser criadas novas sessões. Esta operação é idempotente — desativar um agente já incapacitado traz sucesso sem efeitos secundários.
downloadAgentCode	Descarrega o código postal de um agente hospedado baseado em código. Devolve o código postal previamente carregado (`application/zip`). Se `agent_version` for fornecido, devolve o código zip dessa versão; caso contrário, devolve o código zip da versão mais recente. O resumo SHA-256 dos bytes devolvidos corresponde ao `content_hash` da versão `code_configuration`resolvida .
downloadSessionFile	Descarrega o ficheiro pelo caminho sandbox especificado como um fluxo binário. O caminho é resolvido em relação ao diretório inicial da sessão.
enable	Ativa o agente especificado, permitindo-lhe aceitar novas sessões e processar pedidos. Esta operação é idempotente — permitir que um agente já habilitado retorne sucesso sem efeitos secundários.
estimateOptimizationJob	Estima linhas de conjunto de validação, volumes de chamadas por estágio do modelo e faixas de custo sem submeter o trabalho.
get	Recupera o agente.
getMicrosoft365Package	Gera o pacote de aplicação Microsoft Teams (zip) para um agente Foundry a partir do pedido de publicação fornecido, sem o publicar. Devolve o pacote da aplicação como `application/zip`.
getMicrosoft365PublishDefaults	Devolve valores por defeito e anteriormente publicados usados para pré-preencher um pedido de publicação do Microsoft 365 para um agente Foundry.
getOptimizationCandidate	Recupera um único candidato. Os valores de mutação estão sempre incluídos.
getOptimizationJob	Recupera um trabalho de otimização pelo seu identificador.
getSession	Recupera os detalhes de uma sessão de agente hospedada pelo nome do agente e identificador da sessão.
getSessionLogStream	Transmite logs de consola (stdout / stderr) para uma sessão de agente alojada específica como um fluxo de Server-Sent Eventos (SSE). Cada quadro SSE contém: `event`: sempre `"log"` `data`: uma linha de registo em texto simples (atualmente formatada em JSON, mas o esquema não é contratual e pode incluir chaves adicionais ou alterar o formato ao longo do tempo — os clientes devem tratá-la como uma cadeia opaca) Exemplos de quadros SSE: `event: log data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"} event: log data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."} event: log data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"} event: log data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"}` O fluxo permanece aberto até que o cliente se desconecte ou que o servidor termine a ligação. Os clientes devem tratar da reconexão conforme necessário.
getVersion	Recupera uma versão específica de um agente.
list	Retorna a lista de todos os agentes.
listOptimizationCandidates	Lista os candidatos para o trabalho de otimização dado com paginação por cursor, incluindo a linha base original e os candidatos gerados. Cada `output.mutations` item identifica um atributo alterado por `type`; os campos de mutação `value` são omitidos a menos que o cliente passe `expand=mutations`por .
listOptimizationJobs	Lista trabalhos de otimização com paginação de cursor e filtros opcionais de estado ou nome de agente.
listSessionFiles	Devolve ficheiros e diretórios no caminho especificado no sandbox da sessão. A resposta inclui apenas os filhos imediatos do diretório de destino e passa por defeito ao diretório principal da sessão quando não há caminho fornecido.
listSessions	Devolve uma coleção paginada de sessões associadas ao endpoint do agente especificado.
listVersions	Retorna a lista de versões de um agente.
patchAgentObject	Modifica um agente existente.
promoteOptimizationCandidate	Promove um candidato ao agente Foundry armazenado na configuração de destino do trabalho principal. A promoção não está disponível quando o emprego é omitido target_configuration. A promoção por agente de prompts cria uma nova versão de agente. A promoção de agente hospedado regista atualmente os metadados da promoção sem implementar uma nova versão de agente hospedado.
publishToMicrosoft365	Publica um agente Foundry para Microsoft 365 / Microsoft Teams e devolve o título publicado e os IDs da aplicação Teams.
stopSession	Termina a sessão do agente hospedado especificada e devolve 204 Sem Conteúdo quando o pedido tem sucesso.
updateAgent	Aplica uma atualização de fusão e patch à configuração de endpoint agente especificada.
uploadSessionFile	Carrega o conteúdo binário do ficheiro para o caminho especificado no sandbox da sessão. O serviço armazena o ficheiro em relação ao diretório principal da sessão e rejeita cargas úteis superiores a 50 MB.

Métodos

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Cria o agente.
create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)	Cria um agente a partir de um manifesto.
createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)	Crie uma nova versão do agente.
createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)	Crie uma nova versão do agente a partir de um manifesto.
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	Atualiza o agente adicionando uma nova versão se houver alterações na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.
update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)	Atualiza o agente a partir de um manifesto adicionando uma nova versão caso haja alterações na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

cancelOptimizationJob

Solicita o cancelamento de um trabalho em execução ou em fila. Devolve 409 Conflito se o trabalho já estiver em estado terminal.

cancelOptimizationJob: (jobId: string, options?: AgentsCancelOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Valor de Propriedade

(jobId: string, options?: AgentsCancelOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

createOptimizationJob

Cria um trabalho de otimização e devolve o trabalho em fila. Honras Operation-Id por retentativa idempotente. Os clientes consultam a URL Operation-Location usando a operação get.

createOptimizationJob: (job: AgentOptimizationJob, options?: AgentsCreateOptimizationJobOptionalParams) => JobPoller<AgentOptimizationJobResult>

Valor de Propriedade

(job: AgentOptimizationJob, options?: AgentsCreateOptimizationJobOptionalParams) => JobPoller<AgentOptimizationJobResult>

createSession

Cria uma nova sessão para um endpoint agente. O endpoint resolve a versão do agente de backup a partir version_indicator e faz cumprir a propriedade da sessão usando a chave de isolamento fornecida para operações de mutação de sessão.

createSession: (agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

Valor de Propriedade

(agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

createVersionFromCode

Cria uma nova versão do agente a partir do código. Carrega o código postal e cria uma nova versão para um agente existente. O digest hexadecimal SHA-256 do zip é fornecido no x-ms-code-zip-sha256 cabeçalho para integridade e deduplicação. O corpo do pedido é multipart/form-data com uma parte de metadados JSON e uma parte de código binário (a ordem das peças é irrelevante). O tamanho máximo de upload é de 250 MB.

createVersionFromCode: (agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

Valor de Propriedade

(agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

delete

Exclui um agente. Para agentes alojados, se alguma versão tiver sessões ativas, o pedido é rejeitado com HTTP 409, a menos que force esteja definido como true. Quando a força é verdadeira, todas as sessões associadas são eliminadas em cascata, juntamente com o agente e as suas versões.

delete: (agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

Valor de Propriedade

(agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

deleteOptimizationJob

Cancela trabalho ativo, depois apaga o trabalho e os artefactos do candidato.

deleteOptimizationJob: (jobId: string, options?: AgentsDeleteOptimizationJobOptionalParams) => Promise<void>

Valor de Propriedade

(jobId: string, options?: AgentsDeleteOptimizationJobOptionalParams) => Promise<void>

deleteSession

Apaga uma sessão de forma síncrona. Devolve 204 Sem Conteúdo quando a sessão é eliminada ou não existe.

deleteSession: (agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

Valor de Propriedade

(agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

deleteSessionFile

Apaga o ficheiro ou diretório especificado do sandbox da sessão. Quando recursive é falso, eliminar um diretório não vazio devolve 409 Conflito.

deleteSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

Valor de Propriedade

(agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

deleteVersion

Exclui uma versão específica de um agente. Para agentes alojados, se a versão tiver sessões ativas, o pedido é rejeitado com HTTP 409, a menos que force esteja definido como true. Quando a força é verdadeira, todas as sessões associadas a esta versão são eliminadas em cascata.

deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

Valor de Propriedade

(agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

disable

Desativa o agente especificado, impedindo-o de aceitar novas sessões ou processar pedidos. As sessões ativas existentes podem drenar com graça, mas não podem ser criadas novas sessões. Esta operação é idempotente — desativar um agente já incapacitado traz sucesso sem efeitos secundários.

disable: (agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

Valor de Propriedade

(agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

downloadAgentCode

Descarrega o código postal de um agente hospedado baseado em código. Devolve o código postal previamente carregado (application/zip).

Se agent_version for fornecido, devolve o código zip dessa versão; caso contrário, devolve o código zip da versão mais recente.

O resumo SHA-256 dos bytes devolvidos corresponde ao content_hash da versão code_configurationresolvida .

downloadAgentCode: (agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

Valor de Propriedade

(agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

downloadSessionFile

Descarrega o ficheiro pelo caminho sandbox especificado como um fluxo binário. O caminho é resolvido em relação ao diretório inicial da sessão.

downloadSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Valor de Propriedade

(agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

enable

Ativa o agente especificado, permitindo-lhe aceitar novas sessões e processar pedidos. Esta operação é idempotente — permitir que um agente já habilitado retorne sucesso sem efeitos secundários.

enable: (agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

Valor de Propriedade

(agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

estimateOptimizationJob

Estima linhas de conjunto de validação, volumes de chamadas por estágio do modelo e faixas de custo sem submeter o trabalho.

estimateOptimizationJob: (inputs: AgentOptimizationEstimateInputs, options?: AgentsEstimateOptimizationJobOptionalParams) => Promise<AgentOptimizationEstimateResult>

Valor de Propriedade

(inputs: AgentOptimizationEstimateInputs, options?: AgentsEstimateOptimizationJobOptionalParams) => Promise<AgentOptimizationEstimateResult>

get

Recupera o agente.

get: (agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

Valor de Propriedade

(agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

getMicrosoft365Package

Gera o pacote de aplicação Microsoft Teams (zip) para um agente Foundry a partir do pedido de publicação fornecido, sem o publicar. Devolve o pacote da aplicação como application/zip.

getMicrosoft365Package: (agentName: string, publishScope: Microsoft365PublishScope, options?: GetMicrosoft365PackageOptionalParams) => Promise<GetMicrosoft365PackageResponse>

Valor de Propriedade

(agentName: string, publishScope: Microsoft365PublishScope, options?: GetMicrosoft365PackageOptionalParams) => Promise<GetMicrosoft365PackageResponse>

getMicrosoft365PublishDefaults

Devolve valores por defeito e anteriormente publicados usados para pré-preencher um pedido de publicação do Microsoft 365 para um agente Foundry.

getMicrosoft365PublishDefaults: (agentName: string, options?: GetMicrosoft365PublishDefaultsOptionalParams) => Promise<Microsoft365PublishDefaults>

Valor de Propriedade

(agentName: string, options?: GetMicrosoft365PublishDefaultsOptionalParams) => Promise<Microsoft365PublishDefaults>

getOptimizationCandidate

Recupera um único candidato. Os valores de mutação estão sempre incluídos.

getOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsGetOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Valor de Propriedade

(jobId: string, candidateId: string, options?: AgentsGetOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

getOptimizationJob

Recupera um trabalho de otimização pelo seu identificador.

getOptimizationJob: (jobId: string, options?: AgentsGetOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

Valor de Propriedade

(jobId: string, options?: AgentsGetOptimizationJobOptionalParams) => Promise<AgentOptimizationJob>

getSession

Recupera os detalhes de uma sessão de agente hospedada pelo nome do agente e identificador da sessão.

getSession: (agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

Valor de Propriedade

(agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

getSessionLogStream

Transmite logs de consola (stdout / stderr) para uma sessão de agente alojada específica como um fluxo de Server-Sent Eventos (SSE).

Cada quadro SSE contém:

event: sempre "log"
data: uma linha de registo em texto simples (atualmente formatada em JSON, mas o esquema não é contratual e pode incluir chaves adicionais ou alterar o formato ao longo do tempo — os clientes devem tratá-la como uma cadeia opaca)

Exemplos de quadros SSE:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"}

event: log
data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}

event: log
data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"}

O fluxo permanece aberto até que o cliente se desconecte ou que o servidor termine a ligação. Os clientes devem tratar da reconexão conforme necessário.

getSessionLogStream: (agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

Valor de Propriedade

(agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

getVersion

Recupera uma versão específica de um agente.

getVersion: (agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

Valor de Propriedade

(agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

list

Retorna a lista de todos os agentes.

list: (options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

Valor de Propriedade

(options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

listOptimizationCandidates

Lista os candidatos para o trabalho de otimização dado com paginação por cursor, incluindo a linha base original e os candidatos gerados. Cada output.mutations item identifica um atributo alterado por type; os campos de mutação value são omitidos a menos que o cliente passe expand=mutationspor .

listOptimizationCandidates: (jobId: string, options?: AgentsListOptimizationCandidatesOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationCandidate, AgentOptimizationCandidate[], PageSettings>

Valor de Propriedade

(jobId: string, options?: AgentsListOptimizationCandidatesOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationCandidate, AgentOptimizationCandidate[], PageSettings>

listOptimizationJobs

Lista trabalhos de otimização com paginação de cursor e filtros opcionais de estado ou nome de agente.

listOptimizationJobs: (options?: AgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationJob, AgentOptimizationJob[], PageSettings>

Valor de Propriedade

(options?: AgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<AgentOptimizationJob, AgentOptimizationJob[], PageSettings>

listSessionFiles

Devolve ficheiros e diretórios no caminho especificado no sandbox da sessão. A resposta inclui apenas os filhos imediatos do diretório de destino e passa por defeito ao diretório principal da sessão quando não há caminho fornecido.

listSessionFiles: (agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

Valor de Propriedade

(agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

listSessions

Devolve uma coleção paginada de sessões associadas ao endpoint do agente especificado.

listSessions: (agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

Valor de Propriedade

(agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

listVersions

Retorna a lista de versões de um agente.

listVersions: (agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

Valor de Propriedade

(agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

patchAgentObject

Modifica um agente existente.

patchAgentObject: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Valor de Propriedade

(agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

promoteOptimizationCandidate

Promove um candidato ao agente Foundry armazenado na configuração de destino do trabalho principal. A promoção não está disponível quando o emprego é omitido target_configuration. A promoção por agente de prompts cria uma nova versão de agente. A promoção de agente hospedado regista atualmente os metadados da promoção sem implementar uma nova versão de agente hospedado.

promoteOptimizationCandidate: (jobId: string, candidateId: string, options?: AgentsPromoteOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

Valor de Propriedade

(jobId: string, candidateId: string, options?: AgentsPromoteOptimizationCandidateOptionalParams) => Promise<AgentOptimizationCandidate>

publishToMicrosoft365

Publica um agente Foundry para Microsoft 365 / Microsoft Teams e devolve o título publicado e os IDs da aplicação Teams.

publishToMicrosoft365: (agentName: string, publishScope: Microsoft365PublishScope, options?: PublishToMicrosoft365OptionalParams) => Promise<Microsoft365PublishResponse>

Valor de Propriedade

(agentName: string, publishScope: Microsoft365PublishScope, options?: PublishToMicrosoft365OptionalParams) => Promise<Microsoft365PublishResponse>

stopSession

Termina a sessão do agente hospedado especificada e devolve 204 Sem Conteúdo quando o pedido tem sucesso.

stopSession: (agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

Valor de Propriedade

(agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

updateAgent

Aplica uma atualização de fusão e patch à configuração de endpoint agente especificada.

updateAgent: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

Valor de Propriedade

(agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

uploadSessionFile

Carrega o conteúdo binário do ficheiro para o caminho especificado no sandbox da sessão. O serviço armazena o ficheiro em relação ao diretório principal da sessão e rejeita cargas úteis superiores a 50 MB.

uploadSessionFile: (agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

Valor de Propriedade

(agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Cria o agente.

function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<Agent>

Parâmetros

name: string

definition: AgentDefinitionUnion

options: AgentsCreateOptionalParams

Devoluções

Promise<Agent>

create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)

Cria um agente a partir de um manifesto.

function create(name: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>

Parâmetros

name: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentFromManifestOptionalParams

Devoluções

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Crie uma nova versão do agente.

function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateVersionOptionalParams): Promise<AgentVersion>

Parâmetros

agentName: string

definition: AgentDefinitionUnion

options: AgentsCreateVersionOptionalParams

Devoluções

Promise<AgentVersion>

createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)

Crie uma nova versão do agente a partir de um manifesto.

function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>

Parâmetros

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsCreateAgentVersionFromManifestOptionalParams

Devoluções

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Atualiza o agente adicionando uma nova versão se houver alterações na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateOptionalParams): Promise<Agent>

Parâmetros

agentName: string

definition: AgentDefinitionUnion

options: AgentsUpdateOptionalParams

Devoluções

Promise<Agent>

update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)

Atualiza o agente a partir de um manifesto adicionando uma nova versão caso haja alterações na definição do agente. Se nenhuma alteração, retorna a versão existente do agente.

function update(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

Parâmetros

agentName: string

manifestId: string

parameterValues: Record<string, unknown>

options: AgentsUpdateAgentFromManifestOptionalParams

Devoluções

Promise<Agent>

AgentsOperations interface

Propriedades

Métodos

Detalhes de Propriedade

cancelOptimizationJob

Valor de Propriedade

createOptimizationJob

Valor de Propriedade

createSession

Valor de Propriedade

createVersionFromCode

Valor de Propriedade

delete

Valor de Propriedade

deleteOptimizationJob

Valor de Propriedade

deleteSession

Valor de Propriedade

deleteSessionFile

Valor de Propriedade

deleteVersion

Valor de Propriedade

disable

Valor de Propriedade

downloadAgentCode

Valor de Propriedade

downloadSessionFile

Valor de Propriedade

enable

Valor de Propriedade

estimateOptimizationJob

Valor de Propriedade

get

Valor de Propriedade

getMicrosoft365Package

Valor de Propriedade

getMicrosoft365PublishDefaults

Valor de Propriedade

getOptimizationCandidate

Valor de Propriedade

getOptimizationJob

Valor de Propriedade

getSession

Valor de Propriedade

getSessionLogStream

Valor de Propriedade

getVersion

Valor de Propriedade

list

Valor de Propriedade

listOptimizationCandidates

Valor de Propriedade

listOptimizationJobs

Valor de Propriedade

listSessionFiles

Valor de Propriedade

listSessions

Valor de Propriedade

listVersions

Valor de Propriedade

patchAgentObject

Valor de Propriedade

promoteOptimizationCandidate

Valor de Propriedade

publishToMicrosoft365

Valor de Propriedade

stopSession

Valor de Propriedade

updateAgent

Valor de Propriedade

uploadSessionFile

Valor de Propriedade

Detalhes de Método

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Parâmetros

Devoluções

create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)

Parâmetros

Devoluções

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)