AgentsOperations interface

Pakiet:

@azure/ai-projects

Interfejs reprezentujący operacje agentów.

Właściwości

cancelOptimizationJob	Żąda anulowania działającego lub kolejkowego zadania. Zwraca konflikt 409, jeśli zadanie jest już w stanie terminalnym.
createOptimizationJob	Tworzy zadanie optymalizacyjne i zwraca zadanie w kolejce. Wyróżnienie Operation-Id za ponowną próbę idempotenta. Klienci generują adres URL Operation-Location za pomocą operacji get.
createSession	Tworzy nową sesję dla endpointu agenta. Punkt końcowy rozwiązuje wersję agenta wspierającego i version_indicator wymusza własność sesji za pomocą dostarczonego klucza izolacyjnego dla operacji mutujących sesję.
createVersionFromCode	Tworzy nową wersję agenta z kodu. Przesyła kod pocztowy i tworzy nową wersję dla istniejącego agenta. W nagłówku x-ms-code-zip-sha256 znajduje się hex digest SHA-256 dla integralności i duplikacji. Ciało żądania składa się z danych wieloczęściowych/formowych z częścią metadanych JSON oraz częścią kodu binarnego (kolejność części nie ma znaczenia). Maksymalny rozmiar wysyłania to 250 MB.
delete	Usuwa agenta. Dla hostowanych agentów, jeśli jakaś wersja ma aktywne sesje, żądanie jest odrzucane za pomocą HTTP 409, chyba że force jest ustawione na true. Gdy force jest prawdziwy, wszystkie powiązane sesje są kaskadowo usuwane wraz z agentem i jego wersjami.
deleteOptimizationJob	Anuluje aktywne zadania, a następnie usuwa stanowisko oraz artefakty kandydatów.
deleteSession	Usuwa sesję synchronicznie. Zwraca 204 Brak treści, gdy sesja zostanie usunięta lub nie istnieje.
deleteSessionFile	Usuwa określony plik lub katalog z piaskownicy sesji. Gdy recursive jest false, usunięcie niepustego katalogu zwraca 409 Conflict.
deleteVersion	Usuwa określoną wersję agenta. Dla hostowanych agentów, jeśli wersja ma aktywne sesje, żądanie jest odrzucane za pomocą HTTP 409, chyba że force jest ustawione na true. Gdy wysiłek jest prawdziwy, wszystkie sesje związane z tą wersją są kaskadowo usuwane.
disable	Wyłącza wskazanego agenta, uniemożliwiając mu przyjmowanie nowych sesji lub przetwarzanie żądań. Istniejące aktywne sesje mogą się spokojnie odprowadzać, ale nie można tworzyć nowych sesji. Ta operacja jest idempotentna — unieruchomienie już niepełnosprawnego czynnika przynosi sukces bez skutków ubocznych.
downloadAgentCode	Pobiera kod pocztowy agenta hostowanego na bazie kodu. Zwraca wcześniej przesłany zip (application/zip). Jeśli agent_version jest podany, zwraca kod pocztowe tej wersji; w przeciwnym razie zwraca kod pocztowy najnowszej wersji. Digest SHA-256 zwróconych bajtów odpowiada wersji content_hashcode_configurationrozdzielonej.
downloadSessionFile	Pobiera plik na określonej ścieżce piaskownicy jako strumień binarny. Ścieżka jest rozstrzygana względem katalogu sesji macierzystej.
enable	Umożliwia wskazanego agenta, umożliwiając mu przyjmowanie nowych sesji i przetwarzanie żądań. Ta operacja jest idempotentna — umożliwiając, aby już aktywowany agent przynosił sukces bez skutków ubocznych.
estimateOptimizationJob	Szacuje wiersze zestawu walidacyjnego, wolumeny wywołań modelu na etap oraz przedziały kosztów bez przesłania zadania.
get	Pobiera agenta.
getMicrosoft365Package	Generuje pakiet aplikacji Microsoft Teams (zip) dla agenta Foundry z dostarczonego żądania publikacji, bez jego publikowania. Zwraca pakiet aplikacji jako application/zip.
getMicrosoft365PublishDefaults	Zwraca wartości domyślne oraz wcześniej opublikowane użyte do wstępnego wypełnienia żądania publikacji Microsoft 365 dla agenta Foundry.
getOptimizationCandidate	Odzyskuje jednego kandydata. Wartości mutacji są zawsze uwzględniane.
getOptimizationJob	Pobiera zadanie optymalizacyjne na podstawie jego identyfikatora.
getSession	Pobiera szczegóły sesji hostowanego agenta według nazwy agenta i identyfikatora sesji.
getSessionLogStream	Streamuje logi konsolowe (stdout / stderr) dla konkretnej hostowanej sesji agenta jako strumień Server-Sent Events (SSE). Każda ramka SSE zawiera: event: zawsze "log" data: linia logu w formacie zwykłego tekstu (obecnie w formacie JSON, ale schemat nie jest kontraktowy i może zawierać dodatkowe klucze lub zmieniać format z czasem — klienci powinni traktować go jako nieprzezroczysty ciąg danych) Przykładowe ramki 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"} Strumień pozostaje otwarty, dopóki klient się nie rozłączy lub serwer nie zakończy połączenia. Klienci powinni zajmować się ponownym połączeniem w razie potrzeby.
getVersion	Pobiera określoną wersję agenta.
list	Zwraca listę wszystkich agentów.
listOptimizationCandidates	Lista kandydatów do danego zadania optymalizacyjnego z kursorem paginacji, w tym oryginalną bazę i wygenerowanych kandydatów. Każdy output.mutations element identyfikuje zmieniony atrybut za pomocą type; pola mutacji value są pomijane, chyba że klient przekaże expand=mutations.
listOptimizationJobs	Lista zadań optymalizacyjnych z kursorem paginacją oraz opcjonalnymi filtrami statusu lub nazw agentów.
listSessionFiles	Zwraca pliki i katalogi na wyznaczonej ścieżce w piaskownicy sesji. Odpowiedź zawiera tylko bezpośrednie dzieci katalogu docelowego i domyślnie przyjmuje katalog sesji, gdy nie zostanie dostarczona żadna ścieżka.
listSessions	Zwraca stronicowaną kolekcję sesji powiązanych z określonym punktem końcowym agenta.
listVersions	Zwraca listę wersji agenta.
patchAgentObject	Modyfikuje istniejącego agenta.
promoteOptimizationCandidate	Awansuje kandydata na agenta Foundry przechowywanego w docelowej konfiguracji zadania nadrzędnego. Awans jest niemożliwy, gdy stanowisko nie target_configuration. Promocja agenta promptowego tworzy nową wersję agenta. Promocja agentów hostowanych obecnie rejestruje metadane promocyjne bez wdrażania nowej wersji agenta hostowanego.
publishToMicrosoft365	Publikuje agenta Foundry do Microsoft 365 / Microsoft Teams i zwraca opublikowany tytuł oraz identyfikatory aplikacji Teams.
stopSession	Kończy określoną sesję hostowanego agenta i zwraca 204 No Content po pomyślnym zakończeniu żądania.
updateAgent	Stosuje aktualizację merge-patch do określonej konfiguracji endpoint agenta.
uploadSessionFile	Przesyła zawartość pliku binarnego na określoną ścieżkę w sandboxie sesji. Usługa przechowuje plik względem katalogu sesji macierzystej i odrzuca ładunki większe niż 50 MB.

Metody

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	Tworzy agenta.
create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)	Tworzy agenta na podstawie manifestu.
createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)	Utwórz nową wersję agenta.
createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)	Utwórz nową wersję agenta na podstawie manifestu.
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	Aktualizuje agenta, dodając nową wersję, jeśli nastąpią jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.
update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)	Aktualizuje agenta z manifestu, dodając nową wersję, jeśli istnieją jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.

Szczegóły właściwości

cancelOptimizationJob

Żąda anulowania działającego lub kolejkowego zadania. Zwraca konflikt 409, jeśli zadanie jest już w stanie terminalnym.

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

Wartość właściwości

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

createOptimizationJob

Tworzy zadanie optymalizacyjne i zwraca zadanie w kolejce. Wyróżnienie Operation-Id za ponowną próbę idempotenta. Klienci generują adres URL Operation-Location za pomocą operacji get.

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

Wartość właściwości

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

createSession

Tworzy nową sesję dla endpointu agenta. Punkt końcowy rozwiązuje wersję agenta wspierającego i version_indicator wymusza własność sesji za pomocą dostarczonego klucza izolacyjnego dla operacji mutujących sesję.

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

Wartość właściwości

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

createVersionFromCode

Tworzy nową wersję agenta z kodu. Przesyła kod pocztowy i tworzy nową wersję dla istniejącego agenta. W nagłówku x-ms-code-zip-sha256 znajduje się hex digest SHA-256 dla integralności i duplikacji. Ciało żądania składa się z danych wieloczęściowych/formowych z częścią metadanych JSON oraz częścią kodu binarnego (kolejność części nie ma znaczenia). Maksymalny rozmiar wysyłania to 250 MB.

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

Wartość właściwości

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

delete

Usuwa agenta. Dla hostowanych agentów, jeśli jakaś wersja ma aktywne sesje, żądanie jest odrzucane za pomocą HTTP 409, chyba że force jest ustawione na true. Gdy force jest prawdziwy, wszystkie powiązane sesje są kaskadowo usuwane wraz z agentem i jego wersjami.

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

Wartość właściwości

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

deleteOptimizationJob

Anuluje aktywne zadania, a następnie usuwa stanowisko oraz artefakty kandydatów.

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

Wartość właściwości

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

deleteSession

Usuwa sesję synchronicznie. Zwraca 204 Brak treści, gdy sesja zostanie usunięta lub nie istnieje.

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

Wartość właściwości

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

deleteSessionFile

Usuwa określony plik lub katalog z piaskownicy sesji. Gdy recursive jest false, usunięcie niepustego katalogu zwraca 409 Conflict.

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

Wartość właściwości

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

deleteVersion

Usuwa określoną wersję agenta. Dla hostowanych agentów, jeśli wersja ma aktywne sesje, żądanie jest odrzucane za pomocą HTTP 409, chyba że force jest ustawione na true. Gdy wysiłek jest prawdziwy, wszystkie sesje związane z tą wersją są kaskadowo usuwane.

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

Wartość właściwości

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

disable

Wyłącza wskazanego agenta, uniemożliwiając mu przyjmowanie nowych sesji lub przetwarzanie żądań. Istniejące aktywne sesje mogą się spokojnie odprowadzać, ale nie można tworzyć nowych sesji. Ta operacja jest idempotentna — unieruchomienie już niepełnosprawnego czynnika przynosi sukces bez skutków ubocznych.

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

Wartość właściwości

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

downloadAgentCode

Pobiera kod pocztowy agenta hostowanego na bazie kodu. Zwraca wcześniej przesłany zip (application/zip).

Jeśli agent_version jest podany, zwraca kod pocztowe tej wersji; w przeciwnym razie zwraca kod pocztowy najnowszej wersji.

Digest SHA-256 zwróconych bajtów odpowiada wersji content_hashcode_configurationrozdzielonej.

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

Wartość właściwości

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

downloadSessionFile

Pobiera plik na określonej ścieżce piaskownicy jako strumień binarny. Ścieżka jest rozstrzygana względem katalogu sesji macierzystej.

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

Wartość właściwości

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

enable

Umożliwia wskazanego agenta, umożliwiając mu przyjmowanie nowych sesji i przetwarzanie żądań. Ta operacja jest idempotentna — umożliwiając, aby już aktywowany agent przynosił sukces bez skutków ubocznych.

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

Wartość właściwości

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

estimateOptimizationJob

Szacuje wiersze zestawu walidacyjnego, wolumeny wywołań modelu na etap oraz przedziały kosztów bez przesłania zadania.

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

Wartość właściwości

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

get

Pobiera agenta.

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

Wartość właściwości

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

getMicrosoft365Package

Generuje pakiet aplikacji Microsoft Teams (zip) dla agenta Foundry z dostarczonego żądania publikacji, bez jego publikowania. Zwraca pakiet aplikacji jako application/zip.

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

Wartość właściwości

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

getMicrosoft365PublishDefaults

Zwraca wartości domyślne oraz wcześniej opublikowane użyte do wstępnego wypełnienia żądania publikacji Microsoft 365 dla agenta Foundry.

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

Wartość właściwości

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

getOptimizationCandidate

Odzyskuje jednego kandydata. Wartości mutacji są zawsze uwzględniane.

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

Wartość właściwości

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

getOptimizationJob

Pobiera zadanie optymalizacyjne na podstawie jego identyfikatora.

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

Wartość właściwości

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

getSession

Pobiera szczegóły sesji hostowanego agenta według nazwy agenta i identyfikatora sesji.

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

Wartość właściwości

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

getSessionLogStream

Streamuje logi konsolowe (stdout / stderr) dla konkretnej hostowanej sesji agenta jako strumień Server-Sent Events (SSE).

Każda ramka SSE zawiera:

• event: zawsze "log"
• data: linia logu w formacie zwykłego tekstu (obecnie w formacie JSON, ale schemat nie jest kontraktowy i może zawierać dodatkowe klucze lub zmieniać format z czasem — klienci powinni traktować go jako nieprzezroczysty ciąg danych)

Przykładowe ramki 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"}

Strumień pozostaje otwarty, dopóki klient się nie rozłączy lub serwer nie zakończy połączenia. Klienci powinni zajmować się ponownym połączeniem w razie potrzeby.

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

Wartość właściwości

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

getVersion

Pobiera określoną wersję agenta.

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

Wartość właściwości

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

list

Zwraca listę wszystkich agentów.

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

Wartość właściwości

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

listOptimizationCandidates

Lista kandydatów do danego zadania optymalizacyjnego z kursorem paginacji, w tym oryginalną bazę i wygenerowanych kandydatów. Każdy output.mutations element identyfikuje zmieniony atrybut za pomocą type; pola mutacji value są pomijane, chyba że klient przekaże expand=mutations.

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

Wartość właściwości

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

listOptimizationJobs

Lista zadań optymalizacyjnych z kursorem paginacją oraz opcjonalnymi filtrami statusu lub nazw agentów.

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

Wartość właściwości

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

listSessionFiles

Zwraca pliki i katalogi na wyznaczonej ścieżce w piaskownicy sesji. Odpowiedź zawiera tylko bezpośrednie dzieci katalogu docelowego i domyślnie przyjmuje katalog sesji, gdy nie zostanie dostarczona żadna ścieżka.

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

Wartość właściwości

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

listSessions

Zwraca stronicowaną kolekcję sesji powiązanych z określonym punktem końcowym agenta.

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

Wartość właściwości

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

listVersions

Zwraca listę wersji agenta.

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

Wartość właściwości

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

patchAgentObject

Modyfikuje istniejącego agenta.

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

Wartość właściwości

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

promoteOptimizationCandidate

Awansuje kandydata na agenta Foundry przechowywanego w docelowej konfiguracji zadania nadrzędnego. Awans jest niemożliwy, gdy stanowisko nie target_configuration. Promocja agenta promptowego tworzy nową wersję agenta. Promocja agentów hostowanych obecnie rejestruje metadane promocyjne bez wdrażania nowej wersji agenta hostowanego.

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

Wartość właściwości

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

publishToMicrosoft365

Publikuje agenta Foundry do Microsoft 365 / Microsoft Teams i zwraca opublikowany tytuł oraz identyfikatory aplikacji Teams.

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

Wartość właściwości

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

stopSession

Kończy określoną sesję hostowanego agenta i zwraca 204 No Content po pomyślnym zakończeniu żądania.

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

Wartość właściwości

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

updateAgent

Stosuje aktualizację merge-patch do określonej konfiguracji endpoint agenta.

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

Wartość właściwości

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

uploadSessionFile

Przesyła zawartość pliku binarnego na określoną ścieżkę w sandboxie sesji. Usługa przechowuje plik względem katalogu sesji macierzystej i odrzuca ładunki większe niż 50 MB.

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

Wartość właściwości

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

Szczegóły metody

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

Tworzy agenta.

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

Parametry

name

string

definition

AgentDefinitionUnion

options

AgentsCreateOptionalParams

Zwraca

Promise<Agent>

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

Tworzy agenta na podstawie manifestu.

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

Parametry

name

string

manifestId

string

parameterValues

Record<string, unknown>

options

AgentsCreateAgentFromManifestOptionalParams

Zwraca

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateVersionOptionalParams)

Utwórz nową wersję agenta.

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

Parametry

agentName

string

definition

AgentDefinitionUnion

options

AgentsCreateVersionOptionalParams

Zwraca

Promise<AgentVersion>

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

Utwórz nową wersję agenta na podstawie manifestu.

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

Parametry

agentName

string

manifestId

string

parameterValues

Record<string, unknown>

options

AgentsCreateAgentVersionFromManifestOptionalParams

Zwraca

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

Aktualizuje agenta, dodając nową wersję, jeśli nastąpią jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.

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

Parametry

agentName

string

definition

AgentDefinitionUnion

options

AgentsUpdateOptionalParams

Zwraca

Promise<Agent>

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

Aktualizuje agenta z manifestu, dodając nową wersję, jeśli istnieją jakiekolwiek zmiany w definicji agenta. Jeśli nie ma zmian, zwraca istniejącą wersję agenta.

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

Parametry

agentName

string

manifestId

string

parameterValues

Record<string, unknown>

options

AgentsUpdateAgentFromManifestOptionalParams

Zwraca

Promise<Agent>