@azure/ai-projects 2.7.1 → 2.8.0

package/dist/browser/api/agents/operations.js

@@ -1,13 +1,14 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import { getBinaryStreamResponse } from "../../static-helpers/serialization/get-binary-stream-response.js";
-import { agentDeserializer, agentVersionDeserializer, agentDefinitionUnionSerializer, agentBlueprintReferenceUnionSerializer, agentEndpointConfigSerializer, agentCardSerializer, apiErrorResponseDeserializer, deleteAgentResponseDeserializer, _agentsPagedResultAgentObjectDeserializer, deleteAgentVersionResponseDeserializer, _agentsPagedResultAgentVersionObjectDeserializer, createAgentVersionFromCodeContentSerializer, versionIndicatorUnionSerializer, agentSessionResourceDeserializer, _agentsPagedResultAgentSessionResourceDeserializer, sessionFileWriteResponseDeserializer, sessionDirectoryListResponseDeserializer, microsoft365PublishDefaultsDeserializer, microsoft365PermissionScopesArraySerializer, microsoft365PublishResponseDeserializer, } from "../../models/models.js";
+import { agentDeserializer, agentVersionDeserializer, agentDefinitionUnionSerializer, agentBlueprintReferenceUnionSerializer, agentEndpointConfigSerializer, agentCardSerializer, apiErrorResponseDeserializer, deleteAgentResponseDeserializer, _agentsPagedResultAgentObjectDeserializer, deleteAgentVersionResponseDeserializer, _agentsPagedResultAgentVersionObjectDeserializer, createAgentVersionFromCodeContentSerializer, versionIndicatorUnionSerializer, agentSessionResourceDeserializer, _agentsPagedResultAgentSessionResourceDeserializer, microsoft365PermissionScopesArraySerializer, microsoft365PublishResponseDeserializer, microsoft365PublishDefaultsDeserializer, sessionFileWriteResponseDeserializer, sessionDirectoryListResponseDeserializer, agentOptimizationJobSerializer, agentOptimizationJobDeserializer, agentOptimizationJobResultDeserializer, agentOptimizationEstimateInputsSerializer, agentOptimizationEstimateResultDeserializer, _agentsPagedResultAgentOptimizationJobDeserializer, _agentsPagedResultAgentOptimizationCandidateDeserializer, agentOptimizationCandidateDeserializer, } from "../../models/models.js";
 import { buildPagedAsyncIterator } from "../../static-helpers/pagingHelpers.js";
 import { expandUrlTemplate } from "../../static-helpers/urlTemplate.js";
 import { createRestError, operationOptionsToRequestParameters } from "@azure-rest/core-client";
+import { getBinaryStreamResponse } from "../../static-helpers/serialization/get-binary-stream-response.js";
 import { traceAgentCreate, traceAgentVersionCreate } from "../../tracing/agentTracing.js";
+import { getJobPoller } from "../../static-helpers/pollingHelpers.js";
 export function _deleteSessionFileSend(context, agentName, agentSessionId, path, options = { requestOptions: {} }) {
-    const path_1 = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files{?path,recursive,api-version}", {
+    const path_1 = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files{?api-version,path,recursive}", {
         agent_name: agentName,
         agent_session_id: agentSessionId,
         path: path,
@@ -43,7 +44,7 @@ export async function deleteSessionFile(context, agentName, agentSessionId, path
     return _deleteSessionFileDeserialize(result);
 }
 export function _listSessionFilesSend(context, agentName, agentSessionId, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files{?path,limit,order,after,before,api-version}", {
+    const path = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files{?after,api-version,before,limit,order,path}", {
         agent_name: agentName,
         agent_session_id: agentSessionId,
         path: options?.path,
@@ -87,7 +88,7 @@ export function listSessionFiles(context, agentName, agentSessionId, options = {
     });
 }
 export function _downloadSessionFileSend(context, agentName, agentSessionId, path, options = { requestOptions: {} }) {
-    const path_1 = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content{?path,api-version}", {
+    const path_1 = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content{?api-version,path}", {
         agent_name: agentName,
         agent_session_id: agentSessionId,
         path: path,
@@ -124,7 +125,7 @@ export async function downloadSessionFile(context, agentName, agentSessionId, pa
     return _downloadSessionFileDeserialize(result);
 }
 export function _uploadSessionFileSend(context, agentName, agentSessionId, path, content, options = { requestOptions: {} }) {
-    const path_1 = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content{?path,api-version}", {
+    const path_1 = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions/{agent_session_id}/files/content{?api-version,path}", {
         agent_name: agentName,
         agent_session_id: agentSessionId,
         path: path,
@@ -162,10 +163,10 @@ export async function uploadSessionFile(context, agentName, agentSessionId, path
     return _uploadSessionFileDeserialize(result);
 }
 export function _getMicrosoft365PublishDefaultsSend(context, agentName, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}/microsoft365/publishdefaults{?publishAsDigitalWorker,api%2Dversion}", {
+    const path = expandUrlTemplate("/agents/{agent_name}/microsoft365/publishdefaults{?api-version,publishAsDigitalWorker}", {
         agent_name: agentName,
         publishAsDigitalWorker: options?.publishAsDigitalWorker,
-        "api%2Dversion": context.apiVersion ?? "v1",
+        "api-version": context.apiVersion ?? "v1",
     }, {
         allowReserved: options?.requestOptions?.skipUrlEncoding,
     });
@@ -194,9 +195,9 @@ export async function getMicrosoft365PublishDefaults(context, agentName, options
     return _getMicrosoft365PublishDefaultsDeserialize(result);
 }
 export function _getMicrosoft365PackageSend(context, agentName, publishScope, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}/microsoft365/zip{?api%2Dversion}", {
+    const path = expandUrlTemplate("/agents/{agent_name}/microsoft365/zip{?api-version}", {
         agent_name: agentName,
-        "api%2Dversion": context.apiVersion ?? "v1",
+        "api-version": context.apiVersion ?? "v1",
     }, {
         allowReserved: options?.requestOptions?.skipUrlEncoding,
     });
@@ -251,9 +252,9 @@ export async function getMicrosoft365Package(context, agentName, publishScope, o
     return _getMicrosoft365PackageDeserialize(result);
 }
 export function _publishToMicrosoft365Send(context, agentName, publishScope, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}/microsoft365/publish{?api%2Dversion}", {
+    const path = expandUrlTemplate("/agents/{agent_name}/microsoft365/publish{?api-version}", {
         agent_name: agentName,
-        "api%2Dversion": context.apiVersion ?? "v1",
+        "api-version": context.apiVersion ?? "v1",
     }, {
         allowReserved: options?.requestOptions?.skipUrlEncoding,
     });
@@ -306,6 +307,306 @@ export async function publishToMicrosoft365(context, agentName, publishScope, op
     const result = await _publishToMicrosoft365Send(context, agentName, publishScope, options);
     return _publishToMicrosoft365Deserialize(result);
 }
+export function _promoteOptimizationCandidateSend(context, jobId, candidateId, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs/{jobId}/candidates/{candidateId}:promote{?api-version}", {
+        jobId: jobId,
+        candidateId: candidateId,
+        "api-version": context.apiVersion ?? "v1",
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).post({
+        ...operationOptionsToRequestParameters(options),
+        headers: { accept: "application/json", ...options.requestOptions?.headers },
+    });
+}
+export async function _promoteOptimizationCandidateDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return agentOptimizationCandidateDeserializer(result.body);
+}
+/** Promotes a candidate to the Foundry agent stored in the parent job's target configuration. Promotion is unavailable when the job omitted target_configuration. Prompt-agent promotion creates a new agent version. Hosted-agent promotion currently records promotion metadata without deploying a new hosted-agent version. */
+export async function promoteOptimizationCandidate(context, jobId, candidateId, options = { requestOptions: {} }) {
+    const result = await _promoteOptimizationCandidateSend(context, jobId, candidateId, options);
+    return _promoteOptimizationCandidateDeserialize(result);
+}
+export function _getOptimizationCandidateSend(context, jobId, candidateId, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs/{jobId}/candidates/{candidateId}{?api-version}", {
+        jobId: jobId,
+        candidateId: candidateId,
+        "api-version": context.apiVersion ?? "v1",
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).get({
+        ...operationOptionsToRequestParameters(options),
+        headers: { accept: "application/json", ...options.requestOptions?.headers },
+    });
+}
+export async function _getOptimizationCandidateDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return agentOptimizationCandidateDeserializer(result.body);
+}
+/** Retrieves a single candidate. Mutation values are always included. */
+export async function getOptimizationCandidate(context, jobId, candidateId, options = { requestOptions: {} }) {
+    const result = await _getOptimizationCandidateSend(context, jobId, candidateId, options);
+    return _getOptimizationCandidateDeserialize(result);
+}
+export function _listOptimizationCandidatesSend(context, jobId, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs/{jobId}/candidates{?after,api-version,before,expand,limit,order}", {
+        jobId: jobId,
+        expand: !options?.expand
+            ? options?.expand
+            : options?.expand.map((p) => {
+                return p;
+            }),
+        limit: options?.limit,
+        order: options?.order,
+        after: options?.after,
+        before: options?.before,
+        "api-version": context.apiVersion ?? "v1",
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).get({
+        ...operationOptionsToRequestParameters(options),
+        headers: { accept: "application/json", ...options.requestOptions?.headers },
+    });
+}
+export async function _listOptimizationCandidatesDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return _agentsPagedResultAgentOptimizationCandidateDeserializer(result.body);
+}
+/** Lists candidates for the given optimization job with cursor pagination, including the original baseline and generated candidates. Each `output.mutations` item identifies a changed attribute by `type`; mutation `value` fields are omitted unless the client passes `expand=mutations`. */
+export function listOptimizationCandidates(context, jobId, options = { requestOptions: {} }) {
+    return buildPagedAsyncIterator(context, () => _listOptimizationCandidatesSend(context, jobId, options), _listOptimizationCandidatesDeserialize, ["200"], {
+        itemName: "data",
+        apiVersion: context.apiVersion ?? "v1",
+        cursorFieldName: "last_id",
+        hasMoreFieldName: "has_more",
+        nextPageRequestOptions: {
+            ...operationOptionsToRequestParameters(options),
+            headers: { accept: "application/json", ...options.requestOptions?.headers },
+        },
+    });
+}
+export function _deleteOptimizationJobSend(context, jobId, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs/{jobId}{?api-version}", {
+        jobId: jobId,
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).delete({ ...operationOptionsToRequestParameters(options) });
+}
+export async function _deleteOptimizationJobDeserialize(result) {
+    const expectedStatuses = ["204"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return;
+}
+/** Delete the job and its candidate artifacts. Cancels first if non-terminal. */
+export async function deleteOptimizationJob(context, jobId, options = { requestOptions: {} }) {
+    const result = await _deleteOptimizationJobSend(context, jobId, options);
+    return _deleteOptimizationJobDeserialize(result);
+}
+export function _cancelOptimizationJobSend(context, jobId, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs/{jobId}:cancel{?api-version}", {
+        jobId: jobId,
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).post({
+        ...operationOptionsToRequestParameters(options),
+        headers: { accept: "application/json", ...options.requestOptions?.headers },
+    });
+}
+export async function _cancelOptimizationJobDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return agentOptimizationJobDeserializer(result.body);
+}
+/** Request cancellation of a running or queued job. Returns an error if the job is already in a terminal state. */
+export async function cancelOptimizationJob(context, jobId, options = { requestOptions: {} }) {
+    const result = await _cancelOptimizationJobSend(context, jobId, options);
+    return _cancelOptimizationJobDeserialize(result);
+}
+export function _listOptimizationJobsSend(context, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs{?after,agent_name,api-version,before,limit,order,status}", {
+        limit: options?.limit,
+        order: options?.order,
+        after: options?.after,
+        before: options?.before,
+        status: options?.status,
+        agent_name: options?.agentName,
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).get({
+        ...operationOptionsToRequestParameters(options),
+        headers: { accept: "application/json", ...options.requestOptions?.headers },
+    });
+}
+export async function _listOptimizationJobsDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return _agentsPagedResultAgentOptimizationJobDeserializer(result.body);
+}
+/** List optimization jobs. Supports cursor pagination and optional status / agent_name filters. */
+export function listOptimizationJobs(context, options = { requestOptions: {} }) {
+    return buildPagedAsyncIterator(context, () => _listOptimizationJobsSend(context, options), _listOptimizationJobsDeserialize, ["200"], {
+        itemName: "data",
+        apiVersion: context.apiVersion,
+        cursorFieldName: "last_id",
+        hasMoreFieldName: "has_more",
+        nextPageRequestOptions: {
+            ...operationOptionsToRequestParameters(options),
+            headers: { accept: "application/json", ...options.requestOptions?.headers },
+        },
+    });
+}
+export function _getOptimizationJobSend(context, jobId, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs/{jobId}{?api-version}", {
+        jobId: jobId,
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).get({
+        ...operationOptionsToRequestParameters(options),
+        headers: { accept: "application/json", ...options.requestOptions?.headers },
+    });
+}
+export async function _getOptimizationJobDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return agentOptimizationJobDeserializer(result.body);
+}
+/** Get an optimization job by id. */
+export async function getOptimizationJob(context, jobId, options = { requestOptions: {} }) {
+    const result = await _getOptimizationJobSend(context, jobId, options);
+    return _getOptimizationJobDeserialize(result);
+}
+export function _estimateOptimizationJobSend(context, inputs, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs:estimate{?api-version}", {
+        "api-version": context.apiVersion ?? "v1",
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).post({
+        ...operationOptionsToRequestParameters(options),
+        contentType: "application/json",
+        headers: { accept: "application/json", ...options.requestOptions?.headers },
+        body: agentOptimizationEstimateInputsSerializer(inputs),
+    });
+}
+export async function _estimateOptimizationJobDeserialize(result) {
+    const expectedStatuses = ["200"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    return agentOptimizationEstimateResultDeserializer(result.body);
+}
+/** Estimates validation-set rows, per-stage model call volumes, and cost bands without submitting the job. */
+export async function estimateOptimizationJob(context, inputs, options = { requestOptions: {} }) {
+    const result = await _estimateOptimizationJobSend(context, inputs, options);
+    return _estimateOptimizationJobDeserialize(result);
+}
+export function _createOptimizationJobSend(context, job, options = { requestOptions: {} }) {
+    const path = expandUrlTemplate("/agent_optimization_jobs{?api-version}", {
+        "api-version": context.apiVersion,
+    }, {
+        allowReserved: options?.requestOptions?.skipUrlEncoding,
+    });
+    return context.path(path).post({
+        ...operationOptionsToRequestParameters(options),
+        contentType: "application/json",
+        headers: {
+            ...(options?.operationId !== undefined ? { "operation-id": options?.operationId } : {}),
+            accept: "application/json",
+            ...options.requestOptions?.headers,
+        },
+        body: agentOptimizationJobSerializer(job),
+    });
+}
+export async function _createOptimizationJobDeserialize(result) {
+    const expectedStatuses = ["201", "200", "202"];
+    if (!expectedStatuses.includes(result.status)) {
+        const error = createRestError(result);
+        if (result.body) {
+            error.details = apiErrorResponseDeserializer(result.body);
+        }
+        throw error;
+    }
+    if (result?.body?.result === undefined) {
+        throw createRestError(`Expected a result in the response at position "result.body.result"`, result);
+    }
+    return agentOptimizationJobResultDeserializer(result.body.result);
+}
+/** Create an optimization job. Returns the queued job. Honours `Operation-Id` for idempotent retry. */
+export function createOptimizationJob(context, job, options = { requestOptions: {} }) {
+    // CUSTOMIZATION: SDK-IMPROVEMENT: `getJobPoller` exposes the queued job id on the poller state.
+    return getJobPoller(context, _createOptimizationJobDeserialize, ["201", "200", "202"], {
+        updateIntervalInMs: options?.updateIntervalInMs,
+        abortSignal: options?.abortSignal,
+        getInitialResponse: () => _createOptimizationJobSend(context, job, options),
+        resourceLocationConfig: "operation-location",
+        apiVersion: context.apiVersion ?? "v1",
+        pollHeaders: Object.fromEntries(Object.entries(options?.requestOptions?.headers ?? {}).map(([name, value]) => [
+            name,
+            String(value),
+        ])),
+    });
+}
 export function _getSessionLogStreamSend(context, agentName, agentVersion, sessionId, options = { requestOptions: {} }) {
     const path = expandUrlTemplate("/agents/{agent_name}/versions/{agent_version}/sessions/{session_id}:logstream{?api-version}", {
         agent_name: agentName,
@@ -361,7 +662,7 @@ export async function getSessionLogStream(context, agentName, agentVersion, sess
     return _getSessionLogStreamDeserialize(result);
 }
 export function _listSessionsSend(context, agentName, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions{?limit,order,after,before,api-version}", {
+    const path = expandUrlTemplate("/agents/{agent_name}/endpoint/sessions{?after,api-version,before,limit,order}", {
         agent_name: agentName,
         limit: options?.limit,
         order: options?.order,
@@ -707,12 +1008,8 @@ export async function updateAgentObject(context, agentName, options = { requestO
     const result = await _patchAgentObjectSend(context, agentName, options);
     return _patchAgentObjectDeserialize(result);
 }
-/** Modifies an existing agent. */
-export async function patchAgentObject(context, agentName, options = { requestOptions: {} }) {
-    return updateAgentObject(context, agentName, options);
-}
 export function _listVersionsSend(context, agentName, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}/versions{?limit,order,after,before,include_drafts,api-version}", {
+    const path = expandUrlTemplate("/agents/{agent_name}/versions{?after,api-version,before,include_drafts,limit,order}", {
         agent_name: agentName,
         limit: options?.limit,
         order: options?.order,
@@ -765,7 +1062,7 @@ export function listVersions(context, agentName, options = { requestOptions: {}
     });
 }
 export function _deleteVersionSend(context, agentName, agentVersion, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}/versions/{agent_version}{?force,api-version}", {
+    const path = expandUrlTemplate("/agents/{agent_name}/versions/{agent_version}{?api-version,force}", {
         agent_name: agentName,
         agent_version: agentVersion,
         force: options?.force,
@@ -912,7 +1209,7 @@ export async function createVersion(context, agentName, definition, options = {
     });
 }
 export function _listSend(context, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents{?kind,limit,order,after,before,api-version}", {
+    const path = expandUrlTemplate("/agents{?after,api-version,before,kind,limit,order}", {
         kind: options?.kind,
         limit: options?.limit,
         order: options?.order,
@@ -948,7 +1245,7 @@ export function list(context, options = { requestOptions: {} }) {
     });
 }
 export function _$deleteSend(context, agentName, options = { requestOptions: {} }) {
-    const path = expandUrlTemplate("/agents/{agent_name}{?force,api-version}", {
+    const path = expandUrlTemplate("/agents/{agent_name}{?api-version,force}", {
         agent_name: agentName,
         force: options?.force,
         "api-version": context.apiVersion,
@@ -1183,4 +1480,8 @@ export async function get(context, agentName, options = { requestOptions: {} })
     const result = await _getSend(context, agentName, options);
     return _getDeserialize(result);
 }
+/** Modifies an existing agent. */
+export async function patchAgentObject(context, agentName, options = { requestOptions: {} }) {
+    return updateAgentObject(context, agentName, options);
+}
 //# sourceMappingURL=operations.js.map