Schedules
Create or update a schedule
Creates a new schedule or updates an existing schedule with the supplied definition.
クエリ パラメーター
api-version
string
必須
The API version to use for this operation.
パス パラメーター
id
string
必須
Identifier of the schedule.
ヘッダー パラメーター
Foundry-Features
enum
必須
A feature flag opt-in required when using preview operations or modifying persisted preview resources.
要求本文
The resource instance.
id
string
必須
Identifier of the schedule.
displayName
string
Name of the schedule.
description
string
Description of the schedule.
enabled
boolean
必須
Enabled status of the schedule.
provisioningStatus
string | enum
Schedule provisioning status.
enum
trigger
Cron | Recurrence | OneTime
必須
Base model for Trigger of the schedule.
Cron
CronTrigger
Cron based trigger.
type
enum
必須
expression
string
必須
Cron expression that defines the schedule frequency.
timeZone
string
Time zone for the cron schedule. Defaults to UTC.
startTime
string
Start time for the cron schedule in ISO 8601 format.
endTime
string
End time for the cron schedule in ISO 8601 format.
Recurrence
RecurrenceTrigger
Recurrence based trigger.
type
enum
必須
Type of the trigger.
startTime
string
Start time for the recurrence schedule in ISO 8601 format.
endTime
string
End time for the recurrence schedule in ISO 8601 format.
timeZone
string
Time zone for the recurrence schedule. Defaults to UTC.
interval
integer
必須
Interval for the recurrence schedule.
schedule
Hourly | Daily | Weekly | Monthly
必須
Recurrence schedule model.
Hourly
HourlyRecurrenceSchedule
Hourly recurrence schedule.
type
enum
必須
Daily
DailyRecurrenceSchedule
Daily recurrence schedule.
type
enum
必須
Daily recurrence type.
hours
integer[]
必須
Hours for the recurrence schedule.
Weekly
WeeklyRecurrenceSchedule
Weekly recurrence schedule.
type
enum
必須
Weekly recurrence type.
daysOfWeek
DayOfWeek[]
必須
Days of the week for the recurrence schedule.
Monthly
MonthlyRecurrenceSchedule
Monthly recurrence schedule.
type
enum
必須
Monthly recurrence type.
daysOfMonth
integer[]
必須
Days of the month for the recurrence schedule.
OneTime
OneTimeTrigger
One-time trigger.
type
enum
必須
triggerAt
string
必須
Date and time for the one-time trigger in ISO 8601 format.
timeZone
string
Time zone for the one-time trigger. Defaults to UTC.
task
Evaluation | Insight
必須
Schedule task model.
Evaluation
EvaluationScheduleTask
Evaluation task for the schedule.
type
enum
必須
evalId
string
必須
Identifier of the evaluation group.
evalRun
object
必須
The evaluation run payload.
Insight
InsightScheduleTask
Insight task for the schedule.
type
enum
必須
insight
Insight
必須
The response body for cluster insights.
id
string
必須
The unique identifier for the insights report.
metadata
InsightsMetadata
必須
Metadata about the insights.
createdAt
string
必須
The timestamp when the insights were created.
completedAt
string
The timestamp when the insights were completed.
state
enum | string
必須
Enum describing allowed operation states.
enum
displayName
string
必須
User friendly display name for the insight.
request
EvaluationRunClusterInsight | AgentClusterInsight | EvaluationComparison
必須
The request of the insights report.
EvaluationRunClusterInsight
EvaluationRunClusterInsightRequest
Insights on set of Evaluation Results
type
enum
必須
The type of insights request.
evalId
string
必須
Evaluation Id for the insights.
runIds
string[]
必須
List of evaluation run IDs for the insights.
modelConfiguration
InsightModelConfiguration
Configuration of the model used in the insight generation.
modelDeploymentName
string
必須
The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/<modelDeploymentName>'.
AgentClusterInsight
AgentClusterInsightRequest
Insights on set of Agent Evaluation Results
type
enum
必須
The type of request.
agentName
string
必須
Identifier for the agent.
modelConfiguration
InsightModelConfiguration
Configuration of the model used in the insight generation.
modelDeploymentName
string
必須
The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/<modelDeploymentName>'.
EvaluationComparison
EvaluationComparisonInsightRequest
Evaluation Comparison Request
type
enum
必須
The type of request.
evalId
string
必須
Identifier for the evaluation.
baselineRunId
string
必須
The baseline run ID for comparison.
treatmentRunIds
string[]
必須
List of treatment run IDs for comparison.
result
EvaluationComparison | EvaluationRunClusterInsight | AgentClusterInsight
The result of the insights.
EvaluationComparison
EvaluationComparisonInsightResult
Insights from the evaluation comparison.
type
enum
必須
The type of insights result.
comparisons
EvalRunResultComparison[]
必須
Comparison results for each treatment run against the baseline.
method
string
必須
The statistical method used for comparison.
EvaluationRunClusterInsight
EvaluationRunClusterInsightResult
Insights from the evaluation run cluster analysis.
type
enum
必須
The type of insights result.
clusterInsight
ClusterInsightResult
必須
Insights from the cluster analysis.
summary
InsightSummary
必須
Summary of the error cluster analysis.
sampleCount
integer
必須
Total number of samples analyzed.
uniqueSubclusterCount
integer
必須
Total number of unique subcluster labels.
uniqueClusterCount
integer
必須
Total number of unique clusters.
method
string
必須
Method used for clustering.
usage
ClusterTokenUsage
必須
Token usage for cluster analysis
inputTokenUsage
integer
必須
input token usage
outputTokenUsage
integer
必須
output token usage
totalTokenUsage
integer
必須
total token usage
clusters
InsightCluster[]
必須
List of clusters identified in the insights.
coordinates
object
Optional mapping of IDs to 2D coordinates used by the UX for visualization. The map keys are string identifiers (for example, a cluster id or a sample id) and the values are the coordinates and visual size for rendering on a 2D chart. This property is omitted unless the client requests coordinates (for example, by passing includeCoordinates=true as a query parameter). Example: { "cluster-1": { "x": 12, "y": 34, "size": 8 }, "sample-123": { "x": 18, "y": 22, "size": 4 } } Coordinates are intended only for client-side visualization and do not modify the canonical insights results.
[key: string]
ChartCoordinate
Coordinates for the analysis chart.
x
integer
必須
X-axis coordinate.
y
integer
必須
Y-axis coordinate.
size
integer
必須
Size of the chart element.
AgentClusterInsight
AgentClusterInsightResult
Insights from the agent cluster analysis.
type
enum
必須
The type of insights result.
clusterInsight
ClusterInsightResult
必須
Insights from the cluster analysis.
summary
InsightSummary
必須
Summary of the error cluster analysis.
sampleCount
integer
必須
Total number of samples analyzed.
uniqueSubclusterCount
integer
必須
Total number of unique subcluster labels.
uniqueClusterCount
integer
必須
Total number of unique clusters.
method
string
必須
Method used for clustering.
usage
ClusterTokenUsage
必須
Token usage for cluster analysis
inputTokenUsage
integer
必須
input token usage
outputTokenUsage
integer
必須
output token usage
totalTokenUsage
integer
必須
total token usage
clusters
InsightCluster[]
必須
List of clusters identified in the insights.
coordinates
object
Optional mapping of IDs to 2D coordinates used by the UX for visualization. The map keys are string identifiers (for example, a cluster id or a sample id) and the values are the coordinates and visual size for rendering on a 2D chart. This property is omitted unless the client requests coordinates (for example, by passing includeCoordinates=true as a query parameter). Example: { "cluster-1": { "x": 12, "y": 34, "size": 8 }, "sample-123": { "x": 18, "y": 22, "size": 4 } } Coordinates are intended only for client-side visualization and do not modify the canonical insights results.
[key: string]
ChartCoordinate
Coordinates for the analysis chart.
x
integer
必須
X-axis coordinate.
y
integer
必須
Y-axis coordinate.
size
integer
必須
Size of the chart element.
tags
object
Schedule's tags. Unlike properties, tags are fully mutable.
properties
object
Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
systemData
object
必須
System metadata for the resource.
応答
The request has succeeded.
本文
id
string
必須
Identifier of the schedule.
displayName
string
Name of the schedule.
description
string
Description of the schedule.
enabled
boolean
必須
Enabled status of the schedule.
provisioningStatus
string | enum
Schedule provisioning status.
enum
trigger
Cron | Recurrence | OneTime
必須
Base model for Trigger of the schedule.
Cron
CronTrigger
Cron based trigger.
type
enum
必須
expression
string
必須
Cron expression that defines the schedule frequency.
timeZone
string
Time zone for the cron schedule. Defaults to UTC.
startTime
string
Start time for the cron schedule in ISO 8601 format.
endTime
string
End time for the cron schedule in ISO 8601 format.
Recurrence
RecurrenceTrigger
Recurrence based trigger.
type
enum
必須
Type of the trigger.
startTime
string
Start time for the recurrence schedule in ISO 8601 format.
endTime
string
End time for the recurrence schedule in ISO 8601 format.
timeZone
string
Time zone for the recurrence schedule. Defaults to UTC.
interval
integer
必須
Interval for the recurrence schedule.
schedule
Hourly | Daily | Weekly | Monthly
必須
Recurrence schedule model.
Hourly
HourlyRecurrenceSchedule
Hourly recurrence schedule.
type
enum
必須
Daily
DailyRecurrenceSchedule
Daily recurrence schedule.
type
enum
必須
Daily recurrence type.
hours
integer[]
必須
Hours for the recurrence schedule.
Weekly
WeeklyRecurrenceSchedule
Weekly recurrence schedule.
type
enum
必須
Weekly recurrence type.
daysOfWeek
DayOfWeek[]
必須
Days of the week for the recurrence schedule.
Monthly
MonthlyRecurrenceSchedule
Monthly recurrence schedule.
type
enum
必須
Monthly recurrence type.
daysOfMonth
integer[]
必須
Days of the month for the recurrence schedule.
OneTime
OneTimeTrigger
One-time trigger.
type
enum
必須
triggerAt
string
必須
Date and time for the one-time trigger in ISO 8601 format.
timeZone
string
Time zone for the one-time trigger. Defaults to UTC.
task
Evaluation | Insight
必須
Schedule task model.
Evaluation
EvaluationScheduleTask
Evaluation task for the schedule.
type
enum
必須
evalId
string
必須
Identifier of the evaluation group.
evalRun
object
必須
The evaluation run payload.
Insight
InsightScheduleTask
Insight task for the schedule.
type
enum
必須
insight
Insight
必須
The response body for cluster insights.
id
string
必須
The unique identifier for the insights report.
metadata
InsightsMetadata
必須
Metadata about the insights.
createdAt
string
必須
The timestamp when the insights were created.
completedAt
string
The timestamp when the insights were completed.
state
enum | string
必須
Enum describing allowed operation states.
enum
displayName
string
必須
User friendly display name for the insight.
request
EvaluationRunClusterInsight | AgentClusterInsight | EvaluationComparison
必須
The request of the insights report.
EvaluationRunClusterInsight
EvaluationRunClusterInsightRequest
Insights on set of Evaluation Results
type
enum
必須
The type of insights request.
evalId
string
必須
Evaluation Id for the insights.
runIds
string[]
必須
List of evaluation run IDs for the insights.
modelConfiguration
InsightModelConfiguration
Configuration of the model used in the insight generation.
modelDeploymentName
string
必須
The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/<modelDeploymentName>'.
AgentClusterInsight
AgentClusterInsightRequest
Insights on set of Agent Evaluation Results
type
enum
必須
The type of request.
agentName
string
必須
Identifier for the agent.
modelConfiguration
InsightModelConfiguration
Configuration of the model used in the insight generation.
modelDeploymentName
string
必須
The model deployment to be evaluated. Accepts either the deployment name alone or with the connection name as '{connectionName}/<modelDeploymentName>'.
EvaluationComparison
EvaluationComparisonInsightRequest
Evaluation Comparison Request
type
enum
必須
The type of request.
evalId
string
必須
Identifier for the evaluation.
baselineRunId
string
必須
The baseline run ID for comparison.
treatmentRunIds
string[]
必須
List of treatment run IDs for comparison.
result
EvaluationComparison | EvaluationRunClusterInsight | AgentClusterInsight
The result of the insights.
EvaluationComparison
EvaluationComparisonInsightResult
Insights from the evaluation comparison.
type
enum
必須
The type of insights result.
comparisons
EvalRunResultComparison[]
必須
Comparison results for each treatment run against the baseline.
method
string
必須
The statistical method used for comparison.
EvaluationRunClusterInsight
EvaluationRunClusterInsightResult
Insights from the evaluation run cluster analysis.
type
enum
必須
The type of insights result.
clusterInsight
ClusterInsightResult
必須
Insights from the cluster analysis.
summary
InsightSummary
必須
Summary of the error cluster analysis.
sampleCount
integer
必須
Total number of samples analyzed.
uniqueSubclusterCount
integer
必須
Total number of unique subcluster labels.
uniqueClusterCount
integer
必須
Total number of unique clusters.
method
string
必須
Method used for clustering.
usage
ClusterTokenUsage
必須
Token usage for cluster analysis
inputTokenUsage
integer
必須
input token usage
outputTokenUsage
integer
必須
output token usage
totalTokenUsage
integer
必須
total token usage
clusters
InsightCluster[]
必須
List of clusters identified in the insights.
coordinates
object
Optional mapping of IDs to 2D coordinates used by the UX for visualization. The map keys are string identifiers (for example, a cluster id or a sample id) and the values are the coordinates and visual size for rendering on a 2D chart. This property is omitted unless the client requests coordinates (for example, by passing includeCoordinates=true as a query parameter). Example: { "cluster-1": { "x": 12, "y": 34, "size": 8 }, "sample-123": { "x": 18, "y": 22, "size": 4 } } Coordinates are intended only for client-side visualization and do not modify the canonical insights results.
[key: string]
ChartCoordinate
Coordinates for the analysis chart.
x
integer
必須
X-axis coordinate.
y
integer
必須
Y-axis coordinate.
size
integer
必須
Size of the chart element.
AgentClusterInsight
AgentClusterInsightResult
Insights from the agent cluster analysis.
type
enum
必須
The type of insights result.
clusterInsight
ClusterInsightResult
必須
Insights from the cluster analysis.
summary
InsightSummary
必須
Summary of the error cluster analysis.
sampleCount
integer
必須
Total number of samples analyzed.
uniqueSubclusterCount
integer
必須
Total number of unique subcluster labels.
uniqueClusterCount
integer
必須
Total number of unique clusters.
method
string
必須
Method used for clustering.
usage
ClusterTokenUsage
必須
Token usage for cluster analysis
inputTokenUsage
integer
必須
input token usage
outputTokenUsage
integer
必須
output token usage
totalTokenUsage
integer
必須
total token usage
clusters
InsightCluster[]
必須
List of clusters identified in the insights.
coordinates
object
Optional mapping of IDs to 2D coordinates used by the UX for visualization. The map keys are string identifiers (for example, a cluster id or a sample id) and the values are the coordinates and visual size for rendering on a 2D chart. This property is omitted unless the client requests coordinates (for example, by passing includeCoordinates=true as a query parameter). Example: { "cluster-1": { "x": 12, "y": 34, "size": 8 }, "sample-123": { "x": 18, "y": 22, "size": 4 } } Coordinates are intended only for client-side visualization and do not modify the canonical insights results.
[key: string]
ChartCoordinate
Coordinates for the analysis chart.
x
integer
必須
X-axis coordinate.
y
integer
必須
Y-axis coordinate.
size
integer
必須
Size of the chart element.
tags
object
Schedule's tags. Unlike properties, tags are fully mutable.
properties
object
Schedule's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
systemData
object
必須
System metadata for the resource.
要求
PUT /schedules/{id} HTTP/1.1回答
Status: 200
Content-Type: application/jsonStatus: 201
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json