BetaAgentsOperations interface

BetaAgent işlemlerini temsil eden arayüz.

Özellikler

cancelOptimizationJob

İptal talebi. Terminal durumlar üzerinde idempotent.

createOptimizationJob

Bir optimizasyon işi oluşturun. Kuyruklanan işle birlikte 201 döndürüyor. İdempotent yeniden deneme için onur Operation-Id .

createSession

Bir ajan uç noktası için yeni bir oturum oluşturur. Uç nokta, oturum mutasyona uğratma işlemleri için sağlanan izolasyon anahtarını kullanarak destekleyici ajan versiyonunu version_indicator çözer ve oturum sahipliğini uygular.

createVersionFromCode

Kod içeriğinden yeni bir ajan sürümü oluşturuyor ve barındırmaya açık hale getiriyor. Oluşturulan sürümü döndürür, bu durum durumda provisioning olabilir — istemciler oturum oluşturmadan veya kod indirmeden önce durum olana active kadar anket yapmalıdırgetVersion.

deleteOptimizationJob

İşi ve aday eserlerini sil. Terminal değilse önce iptal edilir.

deleteSession

Bir oturumu senkronize olarak siler. Oturum silindiğinde veya mevcut olmadığında 204 İçerik Yok döner.

deleteSessionFile

Oturum kum kutusundan bir dosya veya dizini sil. Eğer recursive yanlış (varsayılmış) ve hedef boş olmayan bir dizinse, API 409 Çatışma döndürür.

downloadAgentCode

Kod tabanlı barındırılan bir ajanın zip kodunu indirin. Daha önce yüklenen zip dosyasını geri döndürüyor (application/zip).

Eğer agent_version verilirse, o sürümün kod zip'ini döndürür; aksi takdirde en son sürümün kod zip'ini döndürür.

Geri dönen baytların SHA-256 özeti, çözülen versiyonun code_configuration'daki özetiyle eşleşiyorcontent_hash.

downloadSessionFile

Oturum sandbox'tan bir dosyayı ikili akış olarak indirin.

getCandidateFile

Adayın blob dizininden belirli bir dosyayı yayınlayın.

getOptimizationCandidate

Tek bir adayın meta verilerini, manifestosunu ve terfi bilgilerini alın.

getOptimizationCandidateConfig

Adayın deploy config JSON'unu alın. Bir adaydan beste agents.create_version(...) yapmak için kullanılır.

getOptimizationCandidateResults

Bir aday için tam görev başına değerlendirme sonuçlarını alın.

getOptimizationJob

id ile bir optimizasyon işi alın. Devam ederken 202, terminal halde 200 döndürüyor.

getSession

Bir oturumu ID ile alır.

getSessionLogStream

Belirli bir hosted agent oturumu için konsol loglarını (stdout / stderr) Server-Sent Events (SSE) akışı olarak yayınlar.

Her SSE çerçevesi şunları içerir:

  • event: her zaman "log"
  • data: düz metin log satırı (şu anda JSON formatında, ancak şema sözleşmeli değildir ve ek anahtarlar içerebilir veya zamanla format değişebilir — müşteriler bunu opak bir dizi olarak kabul etmelidir)

Örnek SSE kareleri:

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"}

Akış, istemci bağlantıyı koparana veya sunucu bağlantıyı sonlandırana kadar açık kalır. Müşteriler gerektiğinde yeniden bağlantı kurmaları gerekir.

listOptimizationCandidates

Bir iş tarafından üretilen adayları listeleyin.

listOptimizationJobs

Optimizasyon işlerini listeleyin. İmleç sayfalamasını ve isteğe bağlı durum / agent_name filtrelerini destekler.

listSessionFiles

Oturum sandbox'ta belirli bir yolda dosyaları ve dizinleri listeleyin. Yalnızca belirtilen dizinin hemen çocuklarını döndürür (özyineleme olmayan). Yol sağlanmadıysa, oturum ana dizini listeler.

listSessions

Belirtilen ajan için oturum listesini döndürür.

promoteCandidate

Bir adayı tanıtır, konuşlandırma zaman damgasını ve hedef ajan versiyonunu kaydeder.

stopSession

Bir seansı durduruyor. Durdurma başarılı olduğunda 204 İçerik Yok döner.

updateAgent

Bir ajanın uç noktasını güncelliyor.

uploadSessionFile

Oturum kum kutusuna ikili akış üzerinden bir dosya yükleyin. Maksimum dosya boyutu 50 MB'dır. Bu sınırı aşan yüklemeler 413 Yük Fazla Büyük döndürür.

Özellik Ayrıntıları

cancelOptimizationJob

İptal talebi. Terminal durumlar üzerinde idempotent.

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

Özellik Değeri

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

createOptimizationJob

Bir optimizasyon işi oluşturun. Kuyruklanan işle birlikte 201 döndürüyor. İdempotent yeniden deneme için onur Operation-Id .

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

Özellik Değeri

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

createSession

Bir ajan uç noktası için yeni bir oturum oluşturur. Uç nokta, oturum mutasyona uğratma işlemleri için sağlanan izolasyon anahtarını kullanarak destekleyici ajan versiyonunu version_indicator çözer ve oturum sahipliğini uygular.

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

Özellik Değeri

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

createVersionFromCode

Kod içeriğinden yeni bir ajan sürümü oluşturuyor ve barındırmaya açık hale getiriyor. Oluşturulan sürümü döndürür, bu durum durumda provisioning olabilir — istemciler oturum oluşturmadan veya kod indirmeden önce durum olana active kadar anket yapmalıdırgetVersion.

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

Özellik Değeri

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

deleteOptimizationJob

İşi ve aday eserlerini sil. Terminal değilse önce iptal edilir.

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

Özellik Değeri

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

deleteSession

Bir oturumu senkronize olarak siler. Oturum silindiğinde veya mevcut olmadığında 204 İçerik Yok döner.

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

Özellik Değeri

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

deleteSessionFile

Oturum kum kutusundan bir dosya veya dizini sil. Eğer recursive yanlış (varsayılmış) ve hedef boş olmayan bir dizinse, API 409 Çatışma döndürür.

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

Özellik Değeri

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

downloadAgentCode

Kod tabanlı barındırılan bir ajanın zip kodunu indirin. Daha önce yüklenen zip dosyasını geri döndürüyor (application/zip).

Eğer agent_version verilirse, o sürümün kod zip'ini döndürür; aksi takdirde en son sürümün kod zip'ini döndürür.

Geri dönen baytların SHA-256 özeti, çözülen versiyonun code_configuration'daki özetiyle eşleşiyorcontent_hash.

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

Özellik Değeri

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

downloadSessionFile

Oturum sandbox'tan bir dosyayı ikili akış olarak indirin.

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

Özellik Değeri

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

getCandidateFile

Adayın blob dizininden belirli bir dosyayı yayınlayın.

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

Özellik Değeri

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

getOptimizationCandidate

Tek bir adayın meta verilerini, manifestosunu ve terfi bilgilerini alın.

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

Özellik Değeri

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

getOptimizationCandidateConfig

Adayın deploy config JSON'unu alın. Bir adaydan beste agents.create_version(...) yapmak için kullanılır.

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

Özellik Değeri

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

getOptimizationCandidateResults

Bir aday için tam görev başına değerlendirme sonuçlarını alın.

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

Özellik Değeri

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

getOptimizationJob

id ile bir optimizasyon işi alın. Devam ederken 202, terminal halde 200 döndürüyor.

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

Özellik Değeri

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

getSession

Bir oturumu ID ile alır.

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

Özellik Değeri

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

getSessionLogStream

Belirli bir hosted agent oturumu için konsol loglarını (stdout / stderr) Server-Sent Events (SSE) akışı olarak yayınlar.

Her SSE çerçevesi şunları içerir:

  • event: her zaman "log"
  • data: düz metin log satırı (şu anda JSON formatında, ancak şema sözleşmeli değildir ve ek anahtarlar içerebilir veya zamanla format değişebilir — müşteriler bunu opak bir dizi olarak kabul etmelidir)

Örnek SSE kareleri:

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"}

Akış, istemci bağlantıyı koparana veya sunucu bağlantıyı sonlandırana kadar açık kalır. Müşteriler gerektiğinde yeniden bağlantı kurmaları gerekir.

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

Özellik Değeri

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

listOptimizationCandidates

Bir iş tarafından üretilen adayları listeleyin.

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

Özellik Değeri

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

listOptimizationJobs

Optimizasyon işlerini listeleyin. İmleç sayfalamasını ve isteğe bağlı durum / agent_name filtrelerini destekler.

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

Özellik Değeri

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

listSessionFiles

Oturum sandbox'ta belirli bir yolda dosyaları ve dizinleri listeleyin. Yalnızca belirtilen dizinin hemen çocuklarını döndürür (özyineleme olmayan). Yol sağlanmadıysa, oturum ana dizini listeler.

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

Özellik Değeri

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

listSessions

Belirtilen ajan için oturum listesini döndürür.

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

Özellik Değeri

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

promoteCandidate

Bir adayı tanıtır, konuşlandırma zaman damgasını ve hedef ajan versiyonunu kaydeder.

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

Özellik Değeri

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

stopSession

Bir seansı durduruyor. Durdurma başarılı olduğunda 204 İçerik Yok döner.

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

Özellik Değeri

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

updateAgent

Bir ajanın uç noktasını güncelliyor.

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

Özellik Değeri

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

uploadSessionFile

Oturum kum kutusuna ikili akış üzerinden bir dosya yükleyin. Maksimum dosya boyutu 50 MB'dır. Bu sınırı aşan yüklemeler 413 Yük Fazla Büyük döndürür.

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

Özellik Değeri

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