Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions specification/ai/Azure.AI.Projects/connections/models.tsp
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,10 @@ union ConnectionType {

@doc("Generic connection that uses API Key authentication")
APIKey: "ApiKey",

@doc("Application Insights")
ApplicationInsights: "AppInsights",

@doc("Custom Keys")
Custom: "CustomKeys",
}
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,9 @@
"AzureBlob",
"CognitiveSearch",
"CosmosDB",
"ApiKey"
"ApiKey",
"AppInsights",
"CustomKeys"
],
"x-ms-enum": {
"name": "ConnectionType",
Expand Down Expand Up @@ -376,6 +378,16 @@
"name": "APIKey",
"value": "ApiKey",
"description": "Generic connection that uses API Key authentication"
},
{
"name": "ApplicationInsights",
"value": "AppInsights",
"description": "Application Insights"
},
{
"name": "Custom",
"value": "CustomKeys",
"description": "Custom Keys"
}
]
},
Expand Down Expand Up @@ -914,10 +926,10 @@
}
}
},
"/evaluations": {
"/evaluations/runs": {
"get": {
"operationId": "Evaluations_List",
"description": "List evaluations",
"description": "List evaluation runs",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
Expand All @@ -930,13 +942,23 @@
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedEvaluation"
},
"headers": {
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
}
}
},
"default": {
Expand All @@ -957,29 +979,37 @@
}
}
},
"/evaluations/{id}": {
"/evaluations/runs/{name}": {
"get": {
"operationId": "Evaluations_Get",
"description": "Get an evaluation.",
"description": "Get an evaluation run by name.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "id",
"name": "name",
"in": "path",
"description": "Identifier of the evaluation.",
"required": true,
"type": "string",
"maxLength": 254,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-_]*$"
"type": "string"
},
{
"$ref": "#/parameters/Azure.Core.ClientRequestIdHeader"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/Evaluation"
},
"headers": {
"x-ms-client-request-id": {
"type": "string",
"format": "uuid",
"description": "An opaque, globally-unique, client-generated string identifier for the request."
}
}
},
"default": {
Expand All @@ -997,27 +1027,27 @@
}
}
},
"/evaluations:create": {
"/evaluations/runs:run": {
"post": {
"operationId": "Evaluations_Create",
"description": "Creates an evaluation.",
"operationId": "Evaluations_CreateRun",
"description": "Creates an evaluation run.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "body",
"name": "evaluation",
"in": "body",
"description": "Properties of Evaluation.",
"description": "Evalution to be run",
"required": true,
"schema": {
"$ref": "#/definitions/Evaluation"
}
}
],
"responses": {
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/Evaluation"
}
Expand Down Expand Up @@ -9357,7 +9387,9 @@
"AzureBlob",
"CognitiveSearch",
"CosmosDB",
"ApiKey"
"ApiKey",
"AppInsights",
"CustomKeys"
],
"x-ms-enum": {
"name": "ConnectionType",
Expand Down Expand Up @@ -9387,6 +9419,16 @@
"name": "APIKey",
"value": "ApiKey",
"description": "Generic connection that uses API Key authentication"
},
{
"name": "ApplicationInsights",
"value": "AppInsights",
"description": "Application Insights"
},
{
"name": "Custom",
"value": "CustomKeys",
"description": "Custom Keys"
}
]
}
Expand Down Expand Up @@ -9472,25 +9514,6 @@
],
"x-ms-discriminator-value": "DataPath"
},
"Dataset": {
"type": "object",
"description": "Dataset as source for evaluation.",
"properties": {
"id": {
"type": "string",
"description": "Evaluation input data"
}
},
"required": [
"id"
],
"allOf": [
{
"$ref": "#/definitions/InputData"
}
],
"x-ms-discriminator-value": "dataset"
},
"DatasetType": {
"type": "string",
"description": "Enum to determine the type of data.",
Expand Down Expand Up @@ -9665,15 +9688,16 @@
"properties": {
"id": {
"type": "string",
"description": "Identifier of the evaluation."
"description": "Identifier of the evaluation.",
"readOnly": true
},
"data": {
"$ref": "#/definitions/InputData",
"description": "Data for evaluation."
},
"displayName": {
"type": "string",
"description": "Update stage to 'Archive' to archive the asset. Default is Development, which means the asset is under development."
"description": "Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique."
},
"description": {
"type": "string",
Expand Down Expand Up @@ -9712,6 +9736,7 @@
}
},
"required": [
"id",
"data",
"evaluators"
]
Expand Down Expand Up @@ -9889,6 +9914,25 @@
"type"
]
},
"InputDataset": {
"type": "object",
"description": "Dataset as source for evaluation.",
"properties": {
"id": {
"type": "string",
"description": "Evaluation input data"
}
},
"required": [
"id"
],
"allOf": [
{
"$ref": "#/definitions/InputData"
}
],
"x-ms-discriminator-value": "dataset"
},
"ListSortOrder": {
"type": "string",
"description": "The available sorting options when requesting a list of response objects.",
Expand Down Expand Up @@ -10072,15 +10116,14 @@
},
"PagedEvaluation": {
"type": "object",
"description": "Paged evaluation items",
"description": "Paged collection of Evaluation items",
"properties": {
"value": {
"type": "array",
"description": "The list of Evaluations.",
"description": "The Evaluation items on this page",
"items": {
"$ref": "#/definitions/Evaluation"
},
"x-ms-identifiers": []
}
},
"nextLink": {
"type": "string",
Expand Down
Loading