Zu Hauptinhalt wechseln

Dieser Browser wird nicht mehr unterstützt.

Führen Sie ein Upgrade auf Microsoft Edge durch, um die neuesten Features, Sicherheitsupdates und den technischen Support zu nutzen.

Microsoft Edge herunterladen Weitere Informationen zu Internet Explorer und Microsoft Edge
microsoft-foundry.rest.security.o-auth2-auth

AgentOptimizationJobs

Get an agent optimization job

GET /agent_optimization_jobs/{jobId}

Retrieves an optimization job by its identifier.

Pfadparameter

jobId string Erforderlich

The ID of the job.

Abfrageparameter

api-version string Erforderlich

The API version to use for this operation.

Antworten

The request has succeeded.

Header

Retry-After integer

Recommended number of seconds to wait before polling again.

Text

Content-Type: application/json
id string Erforderlich

Server-assigned unique identifier.

result AgentOptimizationJobResult

Partial or terminal result produced by an agent optimization job.

candidate_summary AgentOptimizationResultCandidateSummary

Summary of candidates produced by an agent optimization job.

completed_candidate_count integer Erforderlich

Number of completed candidates. Does not include the baseline.

baseline_id string

Candidate ID of the original baseline. Omitted until the baseline candidate is available.

best_id string

Candidate ID of the highest-scoring candidate for evaluated jobs, or the selected transformed output for non-comparative jobs. Omitted until a candidate has been selected.

baseline_score number

Normalized score of the baseline candidate from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until baseline evaluation completes.

best_score number

Best normalized score observed from 0.0 to 1.0 for a comparatively evaluated job. Omitted otherwise and until a candidate completes evaluation.

latest_promoted_candidate AgentOptimizationCandidatePromotionInfo

Promotion metadata recorded for a candidate.

promoted_at integer Erforderlich
promoted_agent AgentReference Erforderlich
type enum Erforderlich
agent_reference
name string Erforderlich

The name of the agent.

version string

The version identifier of the agent.

token_usage AgentOptimizationJobTokenUsage[] Erforderlich

Aggregate token usage per stage and model. Always present; empty array when no calls were measured.

latency_metrics AgentOptimizationJobLatency[] Erforderlich

Aggregate latency per stage and model. Always present; empty when no server-measured latency is available.

termination_reason string | enum

Reason the optimization process ended. Early termination reasons still indicate a successful job; completed candidates remain available.

Eines der folgenden Elemente:
string
enum
completedbudget_exhaustedcandidate_screening_stalled
status string | enum Erforderlich

Extensible status values shared by Foundry jobs.

Eines der folgenden Elemente:
string
enum
queuedin_progresssucceededfailedcancelled
error OpenAI.Error
code string | null Erforderlich
message string Erforderlich
param string | null
type string
misalignment OpenAI.MisalignmentErrorDetailsResource
review_target string | null
error_type string | enum
Eines der folgenden Elemente:
string
enum
potentially_unintended_data_transferpotentially_unintended_data_accesspotentially_unintended_destructive_activityother
detailed_explanation string

The public explanation for this block.

steer OpenAI._MisalignmentSteer
message string Erforderlich

The public continuation instruction.

details OpenAI.Error[]
additionalInfo object
debugInfo object
display_name string

Human-readable label. Omitted when no label is needed; it has no uniqueness, routing, or idempotency semantics.

target_configuration foundry_agent

Base target configuration for an optimization job.

Eins der folgenden:
foundry_agent AgentOptimizationFoundryAgentTargetConfiguration

Identifies the Foundry agent that owns the configuration being optimized.

type enum Erforderlich

Foundry-agent target discriminator.

foundry_agent
name string Erforderlich

Registered Foundry agent name.

version string

Pinned agent version. Omitted to resolve and pin the latest version.

optimization_model_configuration AgentOptimizationModelConfiguration Erforderlich

Identifies a model used by an optimization or evaluation step.

model string Erforderlich

A non-empty Foundry model name or existing deployment name.

optimization_configuration agent_optimization | prompt_optimization Erforderlich

Base model for type-specific optimization configuration.

Eins der folgenden:
agent_optimization AgentOptimizationConfiguration

Configuration for optimizing an agent for measured quality.

type enum Erforderlich

Optimization type discriminator.

agent_optimization
goal string | enum

Goal for an agent-optimization job.

Eines der folgenden Elemente:
string
enum
improve_quality
evaluation_configuration AgentOptimizationEvaluationConfiguration Erforderlich

Reusable quality-measurement configuration.

training_set target_completion | user_conversation_simulation Erforderlich

Base discriminated model for an optimization evaluation set.

Eins der folgenden:
target_completion AgentOptimizationTargetCompletionEvaluationSet

Evaluation set containing independent single-turn inputs.

type enum Erforderlich

Target-completion set discriminator.

target_completion
source inline | dataset_reference Erforderlich

Base source for a target-completion optimization evaluation set.

Eins der folgenden:
inline AgentOptimizationTargetCompletionInlineDataSource

Supplies single-turn rows directly in the optimization request.

type enum Erforderlich

Inline source discriminator.

inline
test_cases AgentOptimizationTargetCompletionTestCase[] Erforderlich

Target-completion test cases.

dataset_reference AgentOptimizationTargetCompletionDatasetReferenceDataSource

References an explicitly versioned registered Foundry dataset for target-completion evaluation.

type enum Erforderlich

Registered dataset source discriminator.

dataset_reference
name string Erforderlich

Registered dataset name.

version string Erforderlich

Registered dataset version.

user_conversation_simulation AgentOptimizationUserConversationSimulationEvaluationSet

Evaluation set containing scenarios for simulated conversations.

type enum Erforderlich

User-conversation-simulation set discriminator.

user_conversation_simulation
source inline | dataset_reference Erforderlich

Base source for a user-conversation-simulation optimization evaluation set.

Eins der folgenden:
inline AgentOptimizationUserConversationSimulationInlineDataSource

Supplies Evals user-conversation simulation test cases directly in the optimization request.

type enum Erforderlich

Inline source discriminator.

inline
test_cases UserConversationSimulationTestCase[] Erforderlich

Conversation test scenarios.

dataset_reference AgentOptimizationUserConversationSimulationDatasetReferenceDataSource

References an explicitly versioned registered Foundry dataset for user-conversation-simulation evaluation.

type enum Erforderlich

Registered dataset source discriminator.

dataset_reference
name string Erforderlich

Registered dataset name.

version string Erforderlich

Registered dataset version.

default_simulation_configuration UserConversationSimulationConfiguration

Configures the number, length, audio effects, and simulated user behavior of conversations.

max_num_turns integer

Hard limit on turns in each conversation. When omitted, the service defaults to 20.

conversation_repetitions integer

Number of independent conversation repetitions for each test case. Defaults to 1 when not specified at either the data-source or test-case level.

desired_num_turns integer

Target number of turns in each conversation. The effective value cannot exceed the effective max_num_turns. When omitted, no target is set and the simulation model determines the conversation length dynamically from the scenario.

audio_effects UserConversationSimulationAudioEffectsConfiguration

Configures effects applied to simulated conversation audio.

effects UserConversationSimulationAudioEffect[]

Effects to apply to simulated audio.

volume_percentage integer

Volume of the configured audio effects, as a percentage from 1 through 100. When omitted, the service defaults to 15.

user_behavior UserConversationSimulationUserBehaviorConfiguration

Configures conversation behavior for the simulated user.

interruption default

Configuration for simulated user interruption behavior.

Eins der folgenden:
default UserConversationSimulationDefaultInterruptionConfiguration

Configures the default interruption behavior for the simulated user.

type enum Erforderlich

The interruption type, always default.

default
validation_set target_completion | user_conversation_simulation

Base discriminated model for an optimization evaluation set.

Eins der folgenden:
target_completion AgentOptimizationTargetCompletionEvaluationSet

Evaluation set containing independent single-turn inputs.

type enum Erforderlich

Target-completion set discriminator.

target_completion
source inline | dataset_reference Erforderlich

Base source for a target-completion optimization evaluation set.

Eins der folgenden:
inline AgentOptimizationTargetCompletionInlineDataSource

Supplies single-turn rows directly in the optimization request.

type enum Erforderlich

Inline source discriminator.

inline
test_cases AgentOptimizationTargetCompletionTestCase[] Erforderlich

Target-completion test cases.

dataset_reference AgentOptimizationTargetCompletionDatasetReferenceDataSource

References an explicitly versioned registered Foundry dataset for target-completion evaluation.

type enum Erforderlich

Registered dataset source discriminator.

dataset_reference
name string Erforderlich

Registered dataset name.

version string Erforderlich

Registered dataset version.

user_conversation_simulation AgentOptimizationUserConversationSimulationEvaluationSet

Evaluation set containing scenarios for simulated conversations.

type enum Erforderlich

User-conversation-simulation set discriminator.

user_conversation_simulation
source inline | dataset_reference Erforderlich

Base source for a user-conversation-simulation optimization evaluation set.

Eins der folgenden:
inline AgentOptimizationUserConversationSimulationInlineDataSource

Supplies Evals user-conversation simulation test cases directly in the optimization request.

type enum Erforderlich

Inline source discriminator.

inline
test_cases UserConversationSimulationTestCase[] Erforderlich

Conversation test scenarios.

dataset_reference AgentOptimizationUserConversationSimulationDatasetReferenceDataSource

References an explicitly versioned registered Foundry dataset for user-conversation-simulation evaluation.

type enum Erforderlich

Registered dataset source discriminator.

dataset_reference
name string Erforderlich

Registered dataset name.

version string Erforderlich

Registered dataset version.

default_simulation_configuration UserConversationSimulationConfiguration

Configures the number, length, audio effects, and simulated user behavior of conversations.

max_num_turns integer

Hard limit on turns in each conversation. When omitted, the service defaults to 20.

conversation_repetitions integer

Number of independent conversation repetitions for each test case. Defaults to 1 when not specified at either the data-source or test-case level.

desired_num_turns integer

Target number of turns in each conversation. The effective value cannot exceed the effective max_num_turns. When omitted, no target is set and the simulation model determines the conversation length dynamically from the scenario.

audio_effects UserConversationSimulationAudioEffectsConfiguration

Configures effects applied to simulated conversation audio.

effects UserConversationSimulationAudioEffect[]

Effects to apply to simulated audio.

volume_percentage integer

Volume of the configured audio effects, as a percentage from 1 through 100. When omitted, the service defaults to 15.

user_behavior UserConversationSimulationUserBehaviorConfiguration

Configures conversation behavior for the simulated user.

interruption default

Configuration for simulated user interruption behavior.

Eins der folgenden:
default UserConversationSimulationDefaultInterruptionConfiguration

Configures the default interruption behavior for the simulated user.

type enum Erforderlich

The interruption type, always default.

default
evaluators AgentOptimizationEvaluator[] Erforderlich

Evaluator references used to score candidate quality.

evaluation_model EvaluationModelConfiguration Erforderlich

Configures the model that plays the simulated user. This model is separate from the evaluated target.

model string Erforderlich

Model deployment that generates simulated user turns, in the format {connectionName}/modelDeploymentName.

sampling_params ModelSamplingParams

Represents a set of parameters used to control the sampling behavior of a language model during text generation.

temperature number

The temperature parameter for sampling. Defaults to 1.0.

top_p number

The top-p parameter for nucleus sampling. Defaults to 1.0.

seed integer

The random seed for reproducibility. Defaults to 42.

max_completion_tokens integer

The maximum number of tokens allowed in the completion.

voice_model azure-standard

Voice configuration used to convert text to speech for evaluation through the Voice Live endpoint.

Eins der folgenden:
azure-standard EvaluationAzureStandardVoiceModelConfiguration

Configures an Azure standard neural voice used to convert text to speech for evaluation through the Voice Live endpoint.

type enum Erforderlich

The voice kind. Always azure-standard.

azure-standard
name string Erforderlich

The Azure neural voice name.

temperature number

The synthesis temperature, from 0 to 1. When omitted, the service defaults to the underlying voice model's default temperature.

max_concurrent_agent_runs integer

Maximum number of target-agent runs executed concurrently during each single-turn evaluation. If omitted, the service defaults to 1. Conversation evaluation supports only 1.

candidate_search_configuration AgentOptimizationCandidateSearchConfiguration Erforderlich

Candidate search settings.

max_candidates integer

Maximum number of non-baseline candidates to fully evaluate. If omitted, the service defaults to 1.

baseline_agent_configuration AgentOptimizationBaselineAgentConfiguration

Caller-supplied baseline agent values that cannot be resolved from the target agent.

system_prompt string

Caller-supplied baseline system prompt. Omitted to resolve the baseline from the target; a prompt agent's stored definition is authoritative.

current_model string

A non-empty Foundry model name or existing deployment name.

skills AgentOptimizationSkill[]

Skills available for optimization. Omitted when no manual skill surface is supplied.

tools OpenAI.ChatCompletionTool[]

Function tools available for optimization. Omitted when no manual tool surface is supplied. The optimizer may change function and argument descriptions while preserving names and parameter JSON Schema.

agent_optimization_space AgentOptimizationSpace Erforderlich

The agent attributes and alternative values available to an agent-optimization search.

target_attributes TargetAttribute[]

Agent attributes the optimizer may change. If omitted, the service defaults to instructions.

model_search_space AgentOptimizationModelName[]

Alternative model names or existing deployment names available when model is an optimization target.

prompt_optimization PromptOptimizationConfiguration

Configuration for a one-shot prompt transformation without comparative evaluation.

type enum Erforderlich

Optimization type discriminator.

prompt_optimization
context OptimizationContext[]

Context used to steer prompt optimization. Omitted when no context is supplied.

run_duration_ms integer Erforderlich

A duration encoded as an integer number of milliseconds.

created_at integer Erforderlich
updated_at integer Erforderlich
warnings string[]

Non-fatal warnings emitted during optimization. Omitted when no warnings were produced.

Client error

Text

Content-Type: application/json
error OpenAI.Error Erforderlich
code string | null Erforderlich
message string Erforderlich
param string | null
type string
misalignment OpenAI.MisalignmentErrorDetailsResource
review_target string | null
error_type string | enum
Eines der folgenden Elemente:
string
enum
potentially_unintended_data_transferpotentially_unintended_data_accesspotentially_unintended_destructive_activityother
detailed_explanation string

The public explanation for this block.

steer OpenAI._MisalignmentSteer
message string Erforderlich

The public continuation instruction.

details OpenAI.Error[]
additionalInfo object
debugInfo object

Server error

Text

Content-Type: application/json
error OpenAI.Error Erforderlich
code string | null Erforderlich
message string Erforderlich
param string | null
type string
misalignment OpenAI.MisalignmentErrorDetailsResource
review_target string | null
error_type string | enum
Eines der folgenden Elemente:
string
enum
potentially_unintended_data_transferpotentially_unintended_data_accesspotentially_unintended_destructive_activityother
detailed_explanation string

The public explanation for this block.

steer OpenAI._MisalignmentSteer
message string Erforderlich

The public continuation instruction.

details OpenAI.Error[]
additionalInfo object
debugInfo object

Anfordern

GET /agent_optimization_jobs/{jobId} HTTP/1.1

Antwort

Status: 200
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json
de-de
Ihre Datenschutzoptionen
  • KI-Haftungsausschluss
  • Frühere Versionen
  • Blog
  • Mitwirken
  • Datenschutz
  • Consumer Health Privacy
  • Nutzungsbedingungen
  • Impressum
  • Marken
  • © Microsoft 2026