BetaAgentsOperations interface

Pakiet:: @azure/ai-projects

Interfejs reprezentujący operacje BetaAgents.

Właściwości

cancelOptimizationJob	Prośba o anulowanie. Idempotent w stanach terminalnych.
createOptimizationJob	Stwórz zadanie optymalizacji. Zwraca 201 z zadaniem w kolejce. Wyróżnienia `Operation-Id` za ponowną próbę idempotenta.
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 zawartości kodu i udostępnia ją do hostingu. Zwraca utworzoną wersję, która może być w `provisioning` stanie — klienci powinni sprawdzać `getVersion` do momentu, aż status się pojawi, `active` przed utworzeniem sesji lub pobraniem kodu.
deleteOptimizationJob	Usuń stanowisko i artefakty kandydatów. Anuluje najpierw, jeśli nie jest terminalna.
deleteSession	Usuwa sesję synchronicznie. Zwraca 204 Brak treści, gdy sesja zostanie usunięta lub nie istnieje.
deleteSessionFile	Usuń plik lub katalog z sandboxu sesji. Jeśli `recursive` jest fałszywe (domyślnie), a celem jest niepusty katalog, API zwraca konflikt 409.
downloadAgentCode	Pobierz kod pocztowy dla hostowanego agenta opartego na kodzie. 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_configuration`rozdzielonej.
downloadSessionFile	Pobierz plik z sandboxu sesji jako strumień binarny.
getCandidateFile	Streamuj konkretny plik z katalogu blob kandydata.
getOptimizationCandidate	Zdobądź metadane, manifest i informacje o awansu pojedynczego kandydata.
getOptimizationCandidateConfig	Pobierz JSON konfiguracji wdrożenia kandydata. Do pisania `agents.create_version(...)` z kandydata.
getOptimizationCandidateResults	Uzyskaj pełne wyniki oceny każdego zadania dla kandydata.
getOptimizationJob	Zdobądź pracę optymalizacji według ID. Zwraca 202 podczas działania, 200 w stanie terminalnym.
getSession	Pobiera sesję przez ID.
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.
listOptimizationCandidates	Wystaw kandydatów wyprodukowanych przez stanowisko.
listOptimizationJobs	Oferty pracy w optymalizacji list. Obsługuje paginację kursorów oraz opcjonalne filtry statusu / agent_name.
listSessionFiles	Umieść pliki i katalogi na danej ścieżce w sandboxie sesji. Zwraca tylko bezpośrednie dzieci określonego katalogu (nierekurencyjne). Jeśli ścieżka nie jest podana, wyświetla katalog sesji macierzysty.
listSessions	Zwraca listę sesji dla określonego agenta.
promoteCandidate	Awansuje kandydata, rejestrując znacznik czasu wdrożenia oraz wersję docelowego agenta.
stopSession	To przerywa sesję. Zwraca 204 Brak zawartości, gdy zatrzymanie się powiedzie.
updateAgent	Aktualizuje endpoint agenta.
uploadSessionFile	Prześlij plik do sandboxu sesji przez strumień binarny. Maksymalny rozmiar pliku to 50 MB. Przesyłanie przekraczające ten limit zwraca 413 Ładunek Za Duży.

Szczegóły właściwości

cancelOptimizationJob

Prośba o anulowanie. Idempotent w stanach terminalnych.

cancelOptimizationJob: (jobId: string, options?: BetaAgentsCancelOptimizationJobOptionalParams) => Promise<OptimizationJob>

Wartość właściwości

(jobId: string, options?: BetaAgentsCancelOptimizationJobOptionalParams) => Promise<OptimizationJob>

createOptimizationJob

Stwórz zadanie optymalizacji. Zwraca 201 z zadaniem w kolejce. Wyróżnienia Operation-Id za ponowną próbę idempotenta.

createOptimizationJob: (inputs: OptimizationJobInputs, options?: BetaAgentsCreateOptimizationJobOptionalParams) => Promise<OptimizationJob>

Wartość właściwości

(inputs: OptimizationJobInputs, options?: BetaAgentsCreateOptimizationJobOptionalParams) => Promise<OptimizationJob>

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?: BetaAgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

Wartość właściwości

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

createVersionFromCode

Tworzy nową wersję agenta z zawartości kodu i udostępnia ją do hostingu. Zwraca utworzoną wersję, która może być w provisioning stanie — klienci powinni sprawdzać getVersion do momentu, aż status się pojawi, active przed utworzeniem sesji lub pobraniem kodu.

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

Wartość właściwości

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

deleteOptimizationJob

Usuń stanowisko i artefakty kandydatów. Anuluje najpierw, jeśli nie jest terminalna.

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

Wartość właściwości

(jobId: string, options?: BetaAgentsDeleteOptimizationJobOptionalParams) => 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?: BetaAgentsDeleteSessionOptionalParams) => Promise<void>

Wartość właściwości

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

deleteSessionFile

Usuń plik lub katalog z sandboxu sesji. Jeśli recursive jest fałszywe (domyślnie), a celem jest niepusty katalog, API zwraca konflikt 409.

deleteSessionFile: (agentName: string, agentSessionId: string, path: string, options?: BetaAgentsDeleteSessionFileOptionalParams) => Promise<void>

Wartość właściwości

(agentName: string, agentSessionId: string, path: string, options?: BetaAgentsDeleteSessionFileOptionalParams) => Promise<void>

downloadAgentCode

Pobierz kod pocztowy dla hostowanego agenta opartego na kodzie. 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?: BetaAgentsDownloadAgentCodeOptionalParams) => Promise<BetaAgentsDownloadAgentCodeResponse>

Wartość właściwości

(agentName: string, options?: BetaAgentsDownloadAgentCodeOptionalParams) => Promise<BetaAgentsDownloadAgentCodeResponse>

downloadSessionFile

Pobierz plik z sandboxu sesji jako strumień binarny.

downloadSessionFile: (agentName: string, agentSessionId: string, path: string, options?: BetaAgentsDownloadSessionFileOptionalParams) => Promise<BetaAgentsDownloadSessionFileResponse>

Wartość właściwości

(agentName: string, agentSessionId: string, path: string, options?: BetaAgentsDownloadSessionFileOptionalParams) => Promise<BetaAgentsDownloadSessionFileResponse>

getCandidateFile

Streamuj konkretny plik z katalogu blob kandydata.

getCandidateFile: (jobId: string, candidateId: string, path: string, options?: BetaAgentsGetCandidateFileOptionalParams) => Promise<BetaAgentsGetCandidateFileResponse>

Wartość właściwości

(jobId: string, candidateId: string, path: string, options?: BetaAgentsGetCandidateFileOptionalParams) => Promise<BetaAgentsGetCandidateFileResponse>

getOptimizationCandidate

Zdobądź metadane, manifest i informacje o awansu pojedynczego kandydata.

getOptimizationCandidate: (jobId: string, candidateId: string, options?: BetaAgentsGetOptimizationCandidateOptionalParams) => Promise<CandidateMetadata>

Wartość właściwości

(jobId: string, candidateId: string, options?: BetaAgentsGetOptimizationCandidateOptionalParams) => Promise<CandidateMetadata>

getOptimizationCandidateConfig

Pobierz JSON konfiguracji wdrożenia kandydata. Do pisania agents.create_version(...) z kandydata.

getOptimizationCandidateConfig: (jobId: string, candidateId: string, options?: BetaAgentsGetOptimizationCandidateConfigOptionalParams) => Promise<CandidateDeployConfig>

Wartość właściwości

(jobId: string, candidateId: string, options?: BetaAgentsGetOptimizationCandidateConfigOptionalParams) => Promise<CandidateDeployConfig>

getOptimizationCandidateResults

Uzyskaj pełne wyniki oceny każdego zadania dla kandydata.

getOptimizationCandidateResults: (jobId: string, candidateId: string, options?: BetaAgentsGetOptimizationCandidateResultsOptionalParams) => Promise<CandidateResults>

Wartość właściwości

(jobId: string, candidateId: string, options?: BetaAgentsGetOptimizationCandidateResultsOptionalParams) => Promise<CandidateResults>

getOptimizationJob

Zdobądź pracę optymalizacji według ID. Zwraca 202 podczas działania, 200 w stanie terminalnym.

getOptimizationJob: (jobId: string, options?: BetaAgentsGetOptimizationJobOptionalParams) => Promise<OptimizationJob>

Wartość właściwości

(jobId: string, options?: BetaAgentsGetOptimizationJobOptionalParams) => Promise<OptimizationJob>

getSession

Pobiera sesję przez ID.

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

Wartość właściwości

(agentName: string, sessionId: string, options?: BetaAgentsGetSessionOptionalParams) => 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?: BetaAgentsGetSessionLogStreamOptionalParams) => Promise<BetaAgentsDownloadSessionFileResponse>

Wartość właściwości

(agentName: string, agentVersion: string, sessionId: string, options?: BetaAgentsGetSessionLogStreamOptionalParams) => Promise<BetaAgentsDownloadSessionFileResponse>

listOptimizationCandidates

Wystaw kandydatów wyprodukowanych przez stanowisko.

listOptimizationCandidates: (jobId: string, options?: BetaAgentsListOptimizationCandidatesOptionalParams) => Promise<AgentsPagedResultOptimizationCandidate>

Wartość właściwości

(jobId: string, options?: BetaAgentsListOptimizationCandidatesOptionalParams) => Promise<AgentsPagedResultOptimizationCandidate>

listOptimizationJobs

Oferty pracy w optymalizacji list. Obsługuje paginację kursorów oraz opcjonalne filtry statusu / agent_name.

listOptimizationJobs: (options?: BetaAgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<OptimizationJob, OptimizationJob[], PageSettings>

Wartość właściwości

(options?: BetaAgentsListOptimizationJobsOptionalParams) => PagedAsyncIterableIterator<OptimizationJob, OptimizationJob[], PageSettings>

listSessionFiles

Umieść pliki i katalogi na danej ścieżce w sandboxie sesji. Zwraca tylko bezpośrednie dzieci określonego katalogu (nierekurencyjne). Jeśli ścieżka nie jest podana, wyświetla katalog sesji macierzysty.

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

Wartość właściwości

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

listSessions

Zwraca listę sesji dla określonego agenta.

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

Wartość właściwości

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

promoteCandidate

Awansuje kandydata, rejestrując znacznik czasu wdrożenia oraz wersję docelowego agenta.

promoteCandidate: (jobId: string, candidateId: string, candidateRequest: PromoteCandidateRequest, options?: BetaAgentsPromoteCandidateOptionalParams) => Promise<PromoteCandidateResponse>

Wartość właściwości

(jobId: string, candidateId: string, candidateRequest: PromoteCandidateRequest, options?: BetaAgentsPromoteCandidateOptionalParams) => Promise<PromoteCandidateResponse>

stopSession

To przerywa sesję. Zwraca 204 Brak zawartości, gdy zatrzymanie się powiedzie.

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

Wartość właściwości

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

updateAgent

Aktualizuje endpoint agenta.

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

Wartość właściwości

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

uploadSessionFile

Prześlij plik do sandboxu sesji przez strumień binarny. Maksymalny rozmiar pliku to 50 MB. Przesyłanie przekraczające ten limit zwraca 413 Ładunek Za Duży.

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

Wartość właściwości

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