Azure OpenAI i Microsoft Foundry Models som författar REST API förhandsgranskningsreferens

Denna artikel ger detaljer om slutpunkterna för REST API för Azure OpenAI.

API specs

Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelad över tre huvudsakliga API-ytor:

• Control plane
• Dataplan – författarskap
• Dataplan – inferens

Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har sin egen unika uppsättning förhandsvisningar och stabila/allmänt tillgängliga (GA) API-releaser. Förhandsvisningar följer för närvarande en månatlig rytm.

Authentication

Azure OpenAI erbjuder två metoder för autentisering. Du kan använda antingen API-nycklar eller Microsoft Entra ID.

• API-nyckelautentisering: För denna typ av autentisering måste alla API-förfrågningar inkludera API-nyckeln i api-key HTTP-headern. Quickstart ger vägledning för hur man gör samtal med denna typ av autentisering.

• Microsoft Entra ID autentisering: Du kan autentisera ett API-anrop med en Microsoft Entra-token. Autentiseringstoken ingår i en förfrågan som Authorization header. Den givna token måste föregås av Bearer, till exempel Bearer YOUR_AUTH_TOKEN. Du kan läsa vår guide om autentisera med Microsoft Entra ID.

REST API-versionshantering

Tjänste-API:erna versioneras med hjälp av frågeparametern api-version . Alla versioner följer YYYY-MM-DD datumstrukturen. For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Dataplansförfattning

Resten av artikeln täcker förhandsversionen av Azure OpenAI:s dataplansinferensspecifikation, 2025-04-01-preview.

Om du letar efter dokumentation om den senaste GA API-releasen, se det senaste GA data plane inference API

Batch - Lista

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

Får en lista över alla batcher som ägs av Azure OpenAI-resursen.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/batches?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "object": "batch",
        "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
        "endpoint": "/chat/completions",
        "errors": null,
        "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
        "completion_window": "24h",
        "status": "completed",
        "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
        "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
        "created_at": 1646126127,
        "in_progress_at": 1646126130,
        "expires_at": 1646126170,
        "finalizing_at": 1646126134,
        "completed_at": 1646126136,
        "failed_at": null,
        "expired_at": null,
        "cancelling_at": null,
        "cancelled_at": null,
        "request_counts": {
          "total": 500,
          "completed": 400,
          "failed": 100
        },
        "first_id": "batch_abc123",
        "last_id": "batch_abc456",
        "metadata": {
          "batch_description": "Evaluation job"
        }
      }
    ],
    "object": "list"
  }
}

Batch - Skapa

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

Skapar och kör en batch från en uppladdad fil med förfrågningar.

Svaret innehåller detaljer om det köade jobbet inklusive jobbstatus.

ID:t för resultatfilen läggs till svaret när det är klart.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: application/json

Responses

Statuskod: 201

Beskrivning: Batchen har framgångsrikt skapats.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/batches?api-version=2025-04-01-preview

Svar: Statuskod: 201

{
  "headers": {
    "deployment-enqueued-tokens": 1000,
    "deployment-maximum-enqueued-tokens": 5000
  },
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "validating",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": null,
    "expires_at": null,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 0,
      "completed": 0,
      "failed": 0
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Batch - Hämta

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

Hämtar detaljer för en enskild batch specificerad av det givna batch-id.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/batches/{batch-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "completed",
    "output_file_id": "file-f2ddaf43-b48b-46dd-b264-90da10c7a85b",
    "error_file_id": "file-c3b563b0-ebc7-47da-93e3-a2fa694aef0c",
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": 1646126134,
    "completed_at": 1646126136,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": null,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 400,
      "failed": 100
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Batch - Avbryt

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

Avbryter bearbetningen av batchen som specificerats av det givna batch-id:et.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Batchen har framgångsrikt avbokats.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/batches/{batch-id}/cancel?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "batch",
    "id": "batch_72a2792ef7d24ba7b82c7fe4a37e379f",
    "endpoint": "/chat/completions",
    "errors": null,
    "input_file_id": "file-b4fa7277f3eb4722ac18b90f46102c3f",
    "completion_window": "24h",
    "status": "cancelling",
    "output_file_id": null,
    "error_file_id": null,
    "created_at": 1646126127,
    "in_progress_at": 1646126130,
    "expires_at": 1646126170,
    "finalizing_at": null,
    "completed_at": null,
    "failed_at": null,
    "expired_at": null,
    "cancelling_at": 1646126138,
    "cancelled_at": null,
    "request_counts": {
      "total": 500,
      "completed": 100,
      "failed": 5
    },
    "metadata": {
      "batch_description": "Evaluation job"
    }
  }
}

Lagrad komplettering - Lista

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

Får en lista över lagrade kompletteringar.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/chat/completions?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
        "model": "gpt-4o-mini-2024-07-18",
        "created": 1738193475,
        "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
        "usage": {
          "total_tokens": 25,
          "completion_tokens": 7,
          "prompt_tokens": 18
        },
        "seed": 123,
        "top_p": 1,
        "temperature": 1,
        "presence_penalty": 0,
        "frequency_penalty": 0,
        "system_fingerprint": "fp_f3927aa00d",
        "metadata": {
          "key_1": "val_1",
          "key_2": "val_2"
        },
        "choices": [
          {
            "index": 0,
            "message": {
              "content": "Hello, how are you?",
              "role": "assistant"
            },
            "finish_reason": "stop"
          }
        ]
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

Lagrad komplettering - Hämta

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Får lagrad komplettering av det givna lagrede fullbordan-id.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

Lagrad komplettering - Uppdatering

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Uppdatera lagrad komplettering med det givna lagrede fullbordandets id.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: application/json

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "model": "gpt-4o-mini-2024-07-18",
    "created": 1738193475,
    "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
    "usage": {
      "total_tokens": 25,
      "completion_tokens": 7,
      "prompt_tokens": 18
    },
    "seed": 123,
    "top_p": 1,
    "temperature": 1,
    "presence_penalty": 0,
    "frequency_penalty": 0,
    "system_fingerprint": "fp_f3927aa00d",
    "metadata": {
      "key_1": "val_1",
      "key_2": "val_2"
    },
    "choices": [
      {
        "index": 0,
        "message": {
          "content": "Hello, how are you?",
          "role": "assistant"
        },
        "finish_reason": "stop"
      }
    ]
  }
}

Lagrad komplettering - Ta bort

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Ta bort lagrad komplettering med det givna lagrede kompletterings-id:et.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Den lagrade fulländningen raderades framgångsrikt.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

DELETE {endpoint}/openai/chat/completions/{stored-completion-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "chat.completion.deleted",
    "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "deleted": true
  }
}

Lagrad komplettering - Getmessages

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

Får meddelanden om lagrad komplettering från det givna lagrede fullföljnings-id:et.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/chat/completions/{stored-completion-id}/messages?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "role": "user",
        "content": "Hello"
      }
    ],
    "total": 1,
    "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
    "has_more": false
  }
}

Utvärdering – Hämta lista

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

Lista utvärderingar för ett projekt.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: En lista över utvärderingar

Examples

GET {endpoint}/openai/evals?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval",
        "id": "eval_6801694950848190b10968bb628b651d",
        "data_source_config": {
          "type": "custom",
          "schema": {
            "type": "object",
            "properties": {
              "item": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string"
                  },
                  "A": {
                    "type": "string"
                  },
                  "B": {
                    "type": "string"
                  },
                  "C": {
                    "type": "string"
                  },
                  "D": {
                    "type": "string"
                  },
                  "answer": {
                    "type": "string"
                  }
                }
              }
            },
            "required": [
              "item"
            ]
          }
        },
        "testing_criteria": [
          {
            "name": "string check",
            "type": "string_check",
            "input": "{{sample.output_text}}",
            "reference": "{{item.answer}}",
            "operation": "eq"
          }
        ],
        "name": "Math Quiz",
        "created_at": 1744922953,
        "metadata": {}
      }
    ],
    "first_id": "eval_6801694950848190b10968bb628b651d",
    "last_id": "eval_6801694950848190b10968bb628b651d",
    "has_more": false
  }
}

Utvärdering - Skapa

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

Skapa strukturen för en utvärdering som kan användas för att testa en modells prestanda. En utvärdering är en uppsättning testkriterier och en datakälla. Efter att ha skapat en utvärdering kan du köra den på olika modeller och modellparametrar. Vi stödjer flera typer av bedömare och datakällor.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 201

Description: OK

Examples

POST {endpoint}/openai/evals?api-version=2025-04-01-preview

{
 "name": "Math Quiz",
 "data_source_config": {
  "type": "custom",
  "include_sample_schema": true,
  "item_schema": {
   "type": "object",
   "properties": {
    "question": {
     "type": "string"
    },
    "A": {
     "type": "string"
    },
    "B": {
     "type": "string"
    },
    "C": {
     "type": "string"
    },
    "D": {
     "type": "string"
    },
    "answer": {
     "type": "string"
    }
   }
  }
 },
 "testing_criteria": [
  {
   "type": "string_check",
   "reference": "{{item.answer}}",
   "input": "{{sample.output_text}}",
   "operation": "eq",
   "name": "string check"
  }
 ]
}

Svar: Statuskod: 201

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

Utvärdering - Ta bort

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Ta bort en utvärdering.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Tog bort utvärderingen framgångsrikt.

Statuskod: 404

Beskrivning: Utvärdering ej hittad.

Examples

DELETE {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "eval_id": "eval_6801694950848190b10968bb628b651d"
  }
}

Statuskod: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation with ID eval_6801694950848190b10968bb628b651d not found."
  }
}

Utvärdering - Hämta

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Skaffa en utvärdering genom ID.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Utvärderingen

Examples

GET {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Math Quiz",
    "created_at": 1744922953,
    "metadata": {}
  }
}

Utvärdering - Uppdatering

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

Uppdatera vissa egenskaper i en utvärdering.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Den uppdaterade utvärderingen

Examples

POST {endpoint}/openai/evals/{eval-id}?api-version=2025-04-01-preview

{
 "name": "Updated Math Quiz",
 "metadata": {
  "description": "Updated description"
 }
}

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "eval",
    "id": "eval_6801694950848190b10968bb628b651d",
    "data_source_config": {
      "type": "custom",
      "schema": {
        "type": "object",
        "properties": {
          "item": {
            "type": "object",
            "properties": {
              "question": {
                "type": "string"
              },
              "A": {
                "type": "string"
              },
              "B": {
                "type": "string"
              },
              "C": {
                "type": "string"
              },
              "D": {
                "type": "string"
              },
              "answer": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "item"
        ]
      }
    },
    "testing_criteria": [
      {
        "name": "string check",
        "type": "string_check",
        "input": "{{sample.output_text}}",
        "reference": "{{item.answer}}",
        "operation": "eq"
      }
    ],
    "name": "Updated Math Quiz",
    "created_at": 1744922953,
    "metadata": {
      "description": "Updated description"
    }
  }
}

Utvärdering - Getrunlist

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Skaffa en lista med genomgångar för en utvärdering.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: En lista över körningar för utvärderingen

Examples

GET {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run",
        "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "report_url": "https://ai.azure.com/resource/evaluation",
        "status": "queued",
        "model": "gpt-4o-mini",
        "name": "Math quiz",
        "created_at": 1744923141,
        "result_counts": {
          "total": 0,
          "errored": 0,
          "failed": 0,
          "passed": 0
        },
        "per_model_usage": null,
        "per_testing_criteria_results": null,
        "data_source": {
          "type": "completions",
          "source": {
            "type": "file_content",
            "content": [
              {
                "item": {
                  "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
                  "A": "0",
                  "B": "4",
                  "C": "2",
                  "D": "6",
                  "answer": "B"
                }
              },
              {
                "item": {
                  "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
                  "A": "8",
                  "B": "2",
                  "C": "24",
                  "D": "120",
                  "answer": "C"
                }
              }
            ]
          },
          "input_messages": {
            "template": [
              {
                "type": "message",
                "role": "system",
                "content": {
                  "text": "Answer the question's with A, B, C, or D."
                }
              },
              {
                "type": "message",
                "role": "user",
                "content": {
                  "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
                }
              }
            ]
          },
          "model": "gpt-4o-mini",
          "sampling_params": {
            "seed": 42,
            "temperature": 1,
            "top_p": 1
          }
        },
        "error": null,
        "metadata": {}
      }
    ],
    "first_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "last_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "has_more": false
  }
}

Utvärdering – Skapa körning

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

Skapa en ny utvärderingskörning. Detta är slutpunkten som startar rättningen.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 201

Beskrivning: Skapade framgångsrikt en körning för utvärderingen

Statuskod: 400

Beskrivning: Dålig förfrågan (till exempel saknat utvärderingsobjekt)

Examples

POST {endpoint}/openai/evals/{eval-id}/runs?api-version=2025-04-01-preview

{
 "name": "Math quiz",
 "data_source": {
  "type": "completions",
  "source": {
   "type": "file_content",
   "content": [
    {
     "item": {
      "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
      "A": "0",
      "B": "4",
      "C": "2",
      "D": "6",
      "answer": "B"
     }
    },
    {
     "item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
     }
    }
   ]
  },
  "input_messages": {
   "type": "template",
   "template": [
    {
     "type": "message",
     "role": "system",
     "content": {
      "text": "Answer the question's with A, B, C, or D."
     }
    },
    {
     "type": "message",
     "role": "user",
     "content": {
      "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
     }
    }
   ]
  },
  "model": "gpt-4o-mini",
  "sampling_params": {
   "temperature": 1,
   "top_p": 1,
   "seed": 42
  }
 }
}

Svar: Statuskod: 201

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Utvärdering - Radera kör

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Ta bort en utvärderingsrunda.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Tog bort utvärderingsrundan framgångsrikt

Statuskod: 404

Beskrivning: Run ej hittad

Examples

DELETE {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "eval.deleted",
    "deleted": true,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3"
  }
}

Statuskod: 404

{
  "headers": {},
  "body": {
    "code": "notFound",
    "message": "Evaluation Run with ID evalrun_68016a056f0481909b9774447bdd1aa3 not found."
  }
}

Utvärdering – Kör

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Gör en utvärdering med ID.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Utvärderingsrundan

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "queued",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Utvärdering - Avbryt körning

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Avbryt en pågående utvärderingsrunda.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Det avbrutna utvärderingskörningsobjektet

Examples

POST {endpoint}/openai/evals/{eval-id}/runs/{run-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "eval.run",
    "id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "report_url": "https://ai.azure.com/resource/evaluation",
    "status": "canceled",
    "model": "gpt-4o-mini",
    "name": "Math quiz",
    "created_at": 1744923141,
    "result_counts": {
      "total": 0,
      "errored": 0,
      "failed": 0,
      "passed": 0
    },
    "per_model_usage": null,
    "per_testing_criteria_results": null,
    "data_source": {
      "type": "completions",
      "source": {
        "type": "file_content",
        "content": [
          {
            "item": {
              "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
              "A": "0",
              "B": "4",
              "C": "2",
              "D": "6",
              "answer": "B"
            }
          },
          {
            "item": {
              "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
              "A": "8",
              "B": "2",
              "C": "24",
              "D": "120",
              "answer": "C"
            }
          }
        ]
      },
      "input_messages": {
        "type": "template",
        "template": [
          {
            "type": "message",
            "role": "system",
            "content": {
              "text": "Answer the question's with A, B, C, or D."
            }
          },
          {
            "type": "message",
            "role": "user",
            "content": {
              "text": "Question: {{item.question}} A: {{item.A}} B: {{item.B}} C: {{item.C}} D: {{item.D}}."
            }
          }
        ]
      },
      "model": "gpt-4o-mini",
      "sampling_params": {
        "seed": 42,
        "temperature": 1,
        "top_p": 1
      }
    },
    "error": null,
    "metadata": {}
  }
}

Utvärdering - Getrunoutputitems

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

Skaffa en lista över utdata för en utvärderingsrunda.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: En lista över utdata för utvärderingskörningen

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "list",
    "data": [
      {
        "object": "eval.run.output_item",
        "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
        "created_at": 1744925265,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 1,
        "datasource_item": {
          "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
          "A": "8",
          "B": "2",
          "C": "24",
          "D": "120",
          "answer": "C"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. ",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 627,
            "completion_tokens": 546,
            "prompt_tokens": 81,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      },
      {
        "object": "eval.run.output_item",
        "id": "outputitem_6801724f54888190942ec66a197309dd",
        "created_at": 1744925263,
        "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
        "eval_id": "eval_6801694950848190b10968bb628b651d",
        "status": "fail",
        "datasource_item_id": 0,
        "datasource_item": {
          "question": "Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q.",
          "A": "0",
          "B": "4",
          "C": "2",
          "D": "6",
          "answer": "B"
        },
        "results": [
          {
            "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
            "sample": null,
            "passed": false,
            "score": 0
          }
        ],
        "sample": {
          "input": [
            {
              "role": "system",
              "content": "Answer the question's with A, B, C, or D.",
              "function_call": null
            },
            {
              "role": "user",
              "content": "Question: Find the degree for the given field extension Q(sqrt(2), sqrt(3), sqrt(18)) over Q. A: 0 B: 4 C: 2 D: 6.",
              "function_call": null
            }
          ],
          "output": [
            {
              "role": "assistant",
              "content": "To find the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\), we can simplify \\(\\sqrt{18}\\) since \\(\\sqrt{18} = \\sqrt{9 \\cdot 2} = 3\\sqrt{2}\\). \n\nThus, the field can be rewritten as \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\).\n\nNext, we calculate the degree of the extensions step by step:\n\n1. The extension \\(\\mathbb{Q}(\\sqrt{2})\\) over \\(\\mathbb{Q}\\) has degree 2, since \\(\\sqrt{2}\\) is not in \\(\\mathbb{Q}\\) and satisfies the polynomial \\(x^2 - 2\\).\n\n2. Next, we consider the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\). The element \\(\\sqrt{3}\\) is also not in \\(\\mathbb{Q}(\\sqrt{2})\\) and satisfies the polynomial \\(x^2 - 3\\), which is irreducible over \\(\\mathbb{Q}(\\sqrt{2})\\). Hence, the degree of the extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3})\\) over \\(\\mathbb{Q}(\\sqrt{2})\\) is also 2.\n\nNow we can combine these degrees:\n\n\\[\n[\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}] = [\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}) : \\mathbb{Q}(\\sqrt{2})] \\times [\\mathbb{Q}(\\sqrt{2}) : \\mathbb{Q}] = 2 \\times 2 = 4.\n\\]\n\nThus, the degree of the field extension \\(\\mathbb{Q}(\\sqrt{2}, \\sqrt{3}, \\sqrt{18})\\) over \\(\\mathbb{Q}\\) is 4.\n\nTherefore, the answer is:\n\n**B: 4**.",
              "function_call": null
            }
          ],
          "finish_reason": "stop",
          "model": "gpt-4o-mini-2024-07-18",
          "usage": {
            "total_tokens": 556,
            "completion_tokens": 487,
            "prompt_tokens": 69,
            "cached_tokens": 0
          },
          "error": null,
          "temperature": 1,
          "top_p": 1,
          "seed": 42
        }
      }
    ],
    "first_id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "last_id": "outputitem_6801724f54888190942ec66a197309dd",
    "has_more": false
  }
}

Utvärdering - Getrunoutputitem

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

Få en utvärdering, kör utdata efter ID.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Utvärderingskörningsobjektet

Examples

GET {endpoint}/openai/evals/{eval-id}/runs/{run-id}/output_items/{output-item-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "eval.run.output_item",
    "id": "outputitem_68017251ff3881908bf5096bf4cd91c6",
    "created_at": 1744925265,
    "run_id": "evalrun_68016a056f0481909b9774447bdd1aa3",
    "eval_id": "eval_6801694950848190b10968bb628b651d",
    "status": "fail",
    "datasource_item_id": 1,
    "datasource_item": {
      "question": "Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5.",
      "A": "8",
      "B": "2",
      "C": "24",
      "D": "120",
      "answer": "C"
    },
    "results": [
      {
        "name": "string check-63b1fffa-bee6-4c37-ae77-ed46e3dce2b7",
        "sample": null,
        "passed": false,
        "score": 0
      }
    ],
    "sample": {
      "input": [
        {
          "role": "system",
          "content": "Answer the question's with A, B, C, or D."
        },
        {
          "role": "user",
          "content": "Question: Let p = (1, 2, 5, 4)(2, 3) in S_5 . Find the index of <p> in S_5. A: 8 B: 2 C: 24 D: 120."
        }
      ],
      "output": [
        {
          "role": "assistant",
          "content": "To find the index of the subgroup generated by the permutation \\( p = (1, 2, 5, 4)(2, 3) \\) in \\( S_5 \\), we first need to determine the order of \\( p \\).\n\n1. The cycle \\( (1, 2, 5, 4) \\) has length 4.\n2. The cycle \\( (2, 3) \\) has length 2.\n3. The least common multiple (LCM) of these lengths gives the order of the permutation \\( p \\).\n\nCalculating the LCM:\n\\[\n\\text{lcm}(4, 2) = 4\n\\]\nThus, the order of \\( p \\) is 4.\n\nNext, we find the size of the subgroup \\( \\langle p \\rangle \\):\n- The size of \\( \\langle p \\rangle \\) is equal to the order of \\( p \\), which is 4.\n\nNow, we know the size of \\( S_5 \\):\n\\[\n|S_5| = 5! = 120\n\\]\n\nFinally, to find the index of \\( \\langle p \\rangle \\) in \\( S_5 \\), we use the formula:\n\\[\n\\text{index} = \\frac{|S_5|}{|\\langle p \\rangle|} = \\frac{120}{4} = 30\n\\]\n\nHowever, the available answer choices do not include 30. There may be a mistake because the question expects an answer among A, B, C, and D.\n\nLet\u00e2\u20ac\u2122s assume we misunderstood \\( \\langle p \\rangle \\), and instead, we can deduce based solely on given answers looking for a relation to \\( S_5 \\) without delving into detailed subgroup tracks. \n\nSince \\( S_5 \\) has 30 different elements in a subgroup configuration, the closest answer physically relating as long as \\( p \\) covers two elements effectively would logically fit an answer of 120 / 60 which has no direct relationship.\n\nGiven the option choices and specific rank formulations as often made regarding elements in specific construct the subgroup at best reflects around a viable ratio of parts allowed through available indices. \n\nThus, after reasoning through which aligns most structurally geometrically yielding across all configurations possible integrated yet arrives leading \\( p \\) through neighborhood distributions leaving reflections outstanding:\n\n\n\nThe correct answer is:\n**C: 24**\n\nHowever per the discussion migrating \\( p \\) may leave various pathways leading ultimately toward that framing in modeling. Always a good suggestion confirming the elements group generating any possible in outputs rationales. "
        }
      ],
      "finish_reason": "stop",
      "model": "gpt-4o-mini-2024-07-18",
      "usage": {
        "total_tokens": 627,
        "completion_tokens": 546,
        "prompt_tokens": 81,
        "cached_tokens": 0
      },
      "error": null,
      "temperature": 1,
      "top_p": 1,
      "seed": 42
    }
  }
}

Filer - Lista

GET {endpoint}/openai/files?api-version=2025-04-01-preview

Får en lista över alla filer som ägs av Azure OpenAI-resursen.

Dessa inkluderar användaruppladdat innehåll, som filer med syftet att "finjustera" för träning eller validering av finjusteringsmodeller, samt filer som genereras av tjänsten, såsom "finjusteringsresultat" som innehåller olika mätvärden för motsvarande finjusteringsjobb.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/files?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "processed",
        "bytes": 140,
        "purpose": "fine-tune",
        "filename": "puppy.jsonl",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      },
      {
        "status": "processed",
        "bytes": 32423,
        "purpose": "fine-tune-results",
        "filename": "results.csv",
        "id": "file-181a1cbdcdcf4677ada87f63a0928099",
        "created_at": 1646126127,
        "object": "file"
      }
    ],
    "object": "list"
  }
}

Filer - Ladda upp

POST {endpoint}/openai/files?api-version=2025-04-01-preview

Skapar en ny filentitet genom att ladda upp data från en lokal maskin. Uppladdade filer kan till exempel användas för träning eller utvärdering av finjusterade modeller.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: multipart/form-data

Responses

Statuskod: 201

Beskrivning: Filen har framgångsrikt skapats.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/files?api-version=2025-04-01-preview

Svar: Statuskod: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Filer - Importera

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

Skapar en ny filentitet genom att importera data från en tillhandahållen URL. Uppladdade filer kan till exempel användas för träning eller utvärdering av finjusterade modeller.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: application/json

Responses

Statuskod: 201

Beskrivning: Filen har framgångsrikt skapats.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/files/import?api-version=2025-04-01-preview

Svar: Statuskod: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099"
  },
  "body": {
    "status": "pending",
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Filer - Hämta

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Får detaljer för en enskild fil specificerad av det givna fil-ID:t, inklusive status, storlek, syfte osv.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "status": "processed",
    "bytes": 140,
    "purpose": "fine-tune",
    "filename": "puppy.jsonl",
    "id": "file-181a1cbdcdcf4677ada87f63a0928099",
    "created_at": 1646126127,
    "object": "file"
  }
}

Filer - Radera

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Tar bort filen med det givna fil-ID:t.

Radering är också tillåten om en fil har använts, t.ex. som träningsfil i ett finjusteringsjobb.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Filen raderades framgångsrikt.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

DELETE {endpoint}/openai/files/{file-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "object": "file",
    "deleted": true,
    "id": "file-181a1cbdcdcf4677ada87f63a0928099"
  }
}

Filer – Hämta innehåll

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

Hämtar innehållet i filen som specificeras av det givna fil-id:t.

Filer kan vara användaruppladdat innehåll eller genereras av tjänsten, som resultatmått för ett finjusteringsjobb.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/files/{file-id}/content?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": "raw file content"
}

Finjustering - Lista

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Får en lista över alla finjusteringsjobb som ägs av Azure OpenAI-resursen. De detaljer som returneras för varje finjusteringsjobb innehåller förutom dess identifierare basmodellen, tränings- och valideringsfiler, hyperparametrar, tidsstämplar, status och händelser.

Händelser skapas när jobbstatusen ändras. Till exempel kör eller komplett, och när resultat laddas upp.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "hyperparameters": {
          "n_epochs": -1
        },
        "integrations": [
          {
            "type": "wandb",
            "wandb": {
              "project": "custom-wandb-project",
              "tags": [
                "project:tag",
                "lineage"
              ]
            }
          }
        ],
        "method": {
          "type": "supervised"
        },
        "status": "succeeded",
        "model": "curie",
        "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
        "result_files": [
          "file-181a1cbdcdcf4677ada87f63a0928099"
        ],
        "finished_at": 1646127311,
        "trained_tokens": 2342,
        "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "fine_tuning.job"
      }
    ],
    "object": "list"
  }
}

Finjustering - Skapa

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Skapar ett jobb som finjusterar en specificerad modell från en given träningsfil.

Svaret innehåller detaljer om det köade jobbet, inklusive jobbstatus och hyperparametrar.

Namnet på den finjusterade modellen läggs till i svaret när det är klart.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: application/json

Responses

Statuskod: 201

Beskrivning: Finjusteringen har framgångsrikt skapats.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/fine_tuning/jobs?api-version=2025-04-01-preview

Svar: Statuskod: 201

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/fine_tuning/jobs/ft-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "pending",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Finjustering - Hämta

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Får detaljer för ett enda finjusteringsjobb specificerat av det givna finjusterings-id.

Detaljerna innehåller basmodellen, tränings- och valideringsfiler, hyperparametrar, tidsstämplar, status och händelser.

Händelser skapas när jobbstatusen ändras, t.ex. körs eller slutförs, och när resultat laddas upp.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "succeeded",
    "model": "curie",
    "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "result_files": [
      "file-181a1cbdcdcf4677ada87f63a0928099"
    ],
    "finished_at": 1646127311,
    "trained_tokens": 2342,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Finjustering - Ta bort

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Tar bort finjusteringsjobbet som specificerats av det givna finjusterings-id:et.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 204

Beskrivning: Finjusteringen raderades framgångsrikt.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

DELETE {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}?api-version=2025-04-01-preview

Svar: Statuskod: 204

{
  "headers": {}
}

Finjustering - Avbryt

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

Avbryter bearbetningen av finjusteringsjobbet som specificeras av det givna finjusterings-id:et.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Finjusteringen har framgångsrikt avbokats

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/cancel?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "cancelled",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Finjustering – Skaffa checkpoints

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

Hämtar kontrollpunkterna för finjusteringsjobbet som specificeras av det givna finjusterings-id:et.

Kontrollpunkter skapas i slutet av framgångsrika epoker under träningen.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/checkpoints?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftckpt_qtZ5Gyk4BLq1SfLFWp3RtO3P",
        "created_at": 1646126127,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-10",
        "step_number": 10,
        "metrics": {
          "step": 10,
          "train_loss": 0.478,
          "train_mean_token_accuracy": 0.924,
          "valid_loss": 10.112,
          "valid_mean_token_accuracy": 0.145,
          "full_valid_loss": 0.567,
          "full_valid_mean_token_accuracy": 0.944
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_frtXDR2453C4FG67t03MLPs5",
        "created_at": 1646126137,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-20",
        "step_number": 20,
        "metrics": {
          "step": 20,
          "train_loss": 0.355,
          "train_mean_token_accuracy": 0.947,
          "valid_loss": 11.32,
          "valid_mean_token_accuracy": 0.122,
          "full_valid_loss": 0.317,
          "full_valid_mean_token_accuracy": 0.955
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      },
      {
        "id": "ftckpt_agLk6Gio560ORp14gl123fgd",
        "created_at": 1646126147,
        "fine_tuned_model_checkpoint": "gpt-35-turbo-0613.ft-72a2792ef7d24ba7b82c7fe4a37e379f:ckpt-step-30",
        "step_number": 30,
        "metrics": {
          "step": 30,
          "train_loss": 0.155,
          "train_mean_token_accuracy": 0.975,
          "valid_loss": 9.31,
          "valid_mean_token_accuracy": 0.092,
          "full_valid_loss": 0.114,
          "full_valid_mean_token_accuracy": 0.963
        },
        "fine_tuning_job_id": "ftjob-72a2792ef7d24ba7b82c7fe4a37e379f",
        "object": "fine_tuning.job.checkpoint"
      }
    ],
    "object": "list"
  }
}

Finjustering – Hämta händelser

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

Får händelserna för finjusteringsjobbet som specificerats av det givna finjusterings-id:et.

Händelser skapas när jobbstatusen ändras, t.ex. körs eller slutförs, och när resultat laddas upp.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/events?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "has_more": false,
    "data": [
      {
        "id": "ftevent-363dcd7cb4c74539bc53293c1dceef05",
        "created_at": 1646126127,
        "level": "info",
        "message": "Job enqueued. Waiting for jobs ahead to complete.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-8c2a44999790437cb3230e543fa2cf0f",
        "created_at": 1646126169,
        "level": "info",
        "message": "Job started.",
        "type": "message",
        "object": "fine_tuning.job.event"
      },
      {
        "id": "ftevent-2d47d651d2f3484c8187c88c00078147",
        "created_at": 1646126192,
        "level": "info",
        "message": "Job succeeded.",
        "type": "message",
        "object": "fine_tuning.job.event"
      }
    ],
    "object": "list"
  }
}

Finjustering - Paus

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

Pausar bearbetningen av finjusteringsjobbet som specificeras av det givna finjusterings-id:et.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Finjusteringen har framgångsrikt pausats.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/pause?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "paused",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Finjustering – CV

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

Återupptar bearbetningen av finjusteringsjobbet som specificerats av det givna finjusterings-id:et.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Beskrivning: Finjusteringen har framgångsrikt återupptagits.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/fine_tuning/jobs/{fine-tuning-job-id}/resume?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "hyperparameters": {
      "n_epochs": -1
    },
    "integrations": [
      {
        "type": "wandb",
        "wandb": {
          "project": "custom-wandb-project",
          "tags": [
            "project:tag",
            "lineage"
          ]
        }
      }
    ],
    "method": {
      "type": "supervised"
    },
    "status": "resuming",
    "model": "curie",
    "training_file": "file-181a1cbdcdcf4677ada87f63a0928099",
    "finished_at": 1646127311,
    "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "fine_tuning.job"
  }
}

Intagningsjobb - Lista

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

Listar intagningsjobben.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/ingestion/jobs?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "body": {
    "value": [
      {
        "jobId": "usercompute-ingestion-job",
        "kind": "UserCompute",
        "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev"
      },
      {
        "jobId": "syscompute-ingestion-job",
        "kind": "SystemCompute"
      }
    ]
  }
}

Intagningsjobb – Skapa

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Skapar ett insamlingsjobb med det angivna jobb-ID:t.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: application/json

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "SystemCompute",
    "jobId": "ingestion-job",
    "searchServiceConnection": {
      "kind": "EndpointWithManagedIdentity",
      "endpoint": "https://aykame-dev-search.search.windows.net"
    },
    "datasource": {
      "kind": "Storage",
      "connection": {
        "kind": "EndpointWithManagedIdentity",
        "endpoint": "https://mystorage.blob.core.windows.net/",
        "resourceId": "/subscriptions/1234567-abcd-1234-5678-1234abcd/resourceGroups/my-resource/providers/Microsoft.Storage/storageAccounts/mystorage"
      },
      "containerName": "container",
      "chunking": {
        "maxChunkSizeInTokens": 2048
      },
      "embeddings": [
        {
          "connection": {
            "kind": "RelativeConnection"
          },
          "deploymentName": "Ada"
        }
      ]
    },
    "dataRefreshIntervalInHours": 24,
    "completionAction": "keepAllAssets"
  }
}

PUT {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {
    "operation-location": "https://aoairesource.openai.azure.com/openai/ingestion/jobs/ingestion-job/runs/72a2792ef7d24ba7b82c7fe4a37e379f?api-version=2025-04-01-preview"
  },
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Intagsjobb – Skaffa

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Får detaljerna i det angivna jobb-ID:t.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "body": {
    "kind": "UserCompute",
    "jobId": "ingestion-job",
    "workspaceId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev",
    "compute": {
      "kind": "ServerlessCompute"
    },
    "target": {
      "kind": "AzureAISearch",
      "connectionId": "/subscriptions/f375b912-331c-4fc5-8e9f-2d7205e3e036/resourceGroups/adrama-copilot-demo/providers/Microsoft.MachineLearningServices/workspaces/adrama-rag-dev/connections/search-connection"
    },
    "datasource": {
      "kind": "Dataset",
      "datasetId": "azureml://locations/centraluseuap/workspaces/83317fe6-efa6-4e4a-b020-d0edd11ec382/data/PlainText/versions/1",
      "datasetType": "uri_folder"
    }
  }
}

Intagningsjobb - Lista

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

Listar körningarna av det angivna jobb-ID:t.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "body": {
    "value": [
      {
        "jobId": "ingestion-job",
        "runId": "f375b912-331c-4fc5-8e9f-2d7205e3e036",
        "status": "succeeded"
      },
      {
        "jobId": "ingestion-job",
        "runId": "07f2d192-add7-4202-a2e3-858c2577f4fd",
        "status": "failed"
      },
      {
        "jobId": "ingestion-job",
        "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
        "status": "running"
      }
    ]
  }
}

Intagsjobb – Få

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

Hämtar detaljerna om det angivna kör-id som en del av det angivna jobb-ID:t.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/ingestion/jobs/{job-id}/runs/{run-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "body": {
    "jobId": "ingestion-job",
    "runId": "5ef7a436-1147-4cbb-82e0-3d502bcc6a7b",
    "status": "running",
    "progress": {
      "stageProgress": [
        {
          "name": "Preprocessing",
          "totalItems": 14,
          "processedItems": 0,
          "state": "notRunning"
        },
        {
          "name": "Indexing",
          "state": "notRunning"
        }
      ]
    }
  }
}

Modeller - Lista

GET {endpoint}/openai/models?api-version=2025-04-01-preview

Får en lista över alla modeller som är tillgängliga via Azure OpenAI-resursen.

Dessa inkluderar basmodeller samt alla framgångsrikt färdigställda finjusterade modeller som ägs av Azure OpenAI-resursen.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/models?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "data": [
      {
        "status": "succeeded",
        "capabilities": {
          "fine_tune": true,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "fine_tune": 1677662127,
          "inference": 1709284527
        },
        "id": "curie",
        "created_at": 1646126127,
        "object": "model"
      },
      {
        "status": "succeeded",
        "model": "curie",
        "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "capabilities": {
          "fine_tune": false,
          "inference": true,
          "completion": true,
          "chat_completion": false,
          "embeddings": false
        },
        "lifecycle_status": `generally-available`,
        "deprecation": {
          "inference": 1709284527
        },
        "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
        "created_at": 1646126127,
        "object": "model"
      }
    ],
    "object": "list"
  }
}

Modeller - Hämta

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Får detaljer för modellen som specificeras av den givna modelId.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "capabilities": {
      "fine_tune": true,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "fine_tune": 1677662127,
      "inference": 1709284527
    },
    "id": "curie",
    "created_at": 1646126127,
    "object": "model"
  }
}

GET {endpoint}/openai/models/{model-id}?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "status": "succeeded",
    "model": "curie",
    "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "capabilities": {
      "fine_tune": false,
      "inference": true,
      "completion": true,
      "chat_completion": false,
      "embeddings": false
    },
    "lifecycle_status": `generally-available`,
    "deprecation": {
      "inference": 1709284527
    },
    "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "model"
  }
}

Ladda upp fil - Starta

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

Ett mellanliggande Upload-objekt skapas, vilket gör att du kan lägga till Parts till det. För närvarande kan en uppladdningsstorlek vara maximalt 9 GB totalt och den går ut två timmar efter att den skapats.

Efter att uppladdningen är klar genereras ett filobjekt som innehåller alla uppladdade delar. Detta filobjekt kan sedan användas över hela vår plattform precis som vilken annan fil som helst.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Statuskod: 200

Beskrivning: Uppladdningen har framgångsrikt skapats.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/uploads?api-version=2025-04-01-preview

{
 "purpose": "fine-tune",
 "filename": "training_data_v21.jsonl",
 "bytes": 2097152,
 "mime_type": "application/json"
}

Svar: Statuskod: 200

{
  "headers": {
    "location": "https://aoairesource.openai.azure.com/openai/uploads/runs/fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f"
  },
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "pending",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Ladda upp fil - Avbryt

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

Avbryter uppladdningen, och det leder till att alla uppladdade delar raderas asynkront.

Inga delar kan läggas till efter att en uppladdning har avbrutets.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/uploads/{upload-id}/cancel?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "cancelled",
    "expires_at": 1646133327,
    "file": {
      "status": "pending",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Uppladdningsfil - Fullständig

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

Detta slutför uppladdningen, och det returnerade Upload-objektet innehåller ett nästlatat filobjekt som är redo att användas över hela plattformen.

Du kan definiera ordningen på delarna genom att tillhandahålla en ordnad lista med del-ID:n.

Det totala antalet byte som laddas upp måste matcha den ursprungligen specificerade storleken vid skapandet av Upload-objektet.

Efter denna operation kan inga ytterligare delar läggas till när uppladdningen är klar.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: application/json

Request Body

Content-Type: text/json

Request Body

Content-Type: application/*+json

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/uploads/{upload-id}/complete?api-version=2025-04-01-preview

{
 "part_ids": [
  "LnmictL3p0u4LH/ko343nw==",
  "LmmictL3p0u4LH/ko343nw=="
 ]
}

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "bytes": 2097152,
    "filename": "training_data_v21.jsonl",
    "purpose": "fine-tune",
    "status": "completed",
    "expires_at": 1646133327,
    "file": {
      "status": "processed",
      "bytes": 140,
      "purpose": "fine-tune",
      "filename": "puppy.jsonl",
      "id": "file-181a1cbdcdcf4677ada87f63a0928099",
      "created_at": 1646126127,
      "object": "file"
    },
    "id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload"
  }
}

Ladda upp fil - Del

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

Lägger till en Del till ett Upload-objekt, där varje Del representerar ett segment av filen du laddar upp.

Varje del kan vara upp till standardstorleksgränsen för filuppladdning, baserat på filens syfte. Du kan fortsätta lägga till delar tills du når uppladdningsgränsen på 9 GB.

URI Parameters

Request Header

Använd antingen tokenbaserad autentisering eller API-nyckel. Autentifikation med tokenbaserad autentisering rekommenderas och är säkrare.

Request Body

Content-Type: multipart/form-data

Responses

Statuskod: 200

Description: Success

Statuskod: standard

Beskrivning: Ett fel uppstod.

Examples

POST {endpoint}/openai/uploads/{upload-id}/parts?api-version=2025-04-01-preview

Svar: Statuskod: 200

{
  "headers": {},
  "body": {
    "upload_id": "fine-tune-72a2792ef7d24ba7b82c7fe4a37e379f",
    "azure_block_id": "LnmictL3p0u4LH/ko343nw==",
    "id": "uplprt-72a2792ef7d24ba7b82c7fe4a37e379f",
    "created_at": 1646126127,
    "object": "upload.part"
  }
}

Components

AzureAISearchIndex

Azure AI-sökning Index.

BaseConnection

En koppling till en resurs.

Diskriminator för BaseConnection

Denna komponent använder egenskapen kind för att skilja mellan olika typer:

Batch

Definierar värdena för en batch.

BatchCreateRequest

Definierar förfrågan om att skapa en batch.

BatchErrorData

Felinformation för ett misslyckande i batch.

BatchErrors

För batcher som har misslyckats kommer detta att innehålla mer information om orsaken till felen.

BatchRequestCounts

Förfrågan räknas för olika statusar inom batchen.

BatchOutputReference

Azure Storage-mappen för att lagra output.

BatchStatus

Status för en batch.

BatchesList

Representerar en lista över batcher.

Capabilities

Möjligheterna hos en bas- eller finjusteringsmodell.

Choice

ChoiceMessage

ChunkingSettings

Chunking settings

CompletionAction

Fullbordandeåtgärden.

ComputeType

Beräkningstypen.

ConnectionStringConnection

Anslutningssträngsanslutning.

ConnectionType

Anslutningstypen.

CosmosDBIndex

CosmosDB Index.

CrawlingSettings

Crawling settings

CreateEvalCompletionsRunDataSource

Ett CompletionsRunDataSource-objekt som beskriver en modellprovskonfiguration.

CreateEvalCustomDataSourceConfig

Ett CustomDataSourceConfig-objekt som definierar schemat för datakällan som används för utvärderingen körs. Detta schema används för att definiera formen på datan som ska vara: - Används för att definiera dina testkriterier och - Vilken data som krävs vid skapandet av en körning

CreateEvalItem

Ett chattmeddelande som utgör prompten eller kontexten. Kan inkludera variabelreferenser till "objekt"-namnrymden, dvs. {{item.name}}.

CreateEvalJsonlRunDataSource

Ett JsonlRunDataSource-objekt med som specificerar en JSONL-fil som matchar evalet

CreateEvalLabelModelGrader

Ett LabelModelGrader-objekt som använder en modell för att tilldela etiketter till varje objekt i utvärderingen.

CreateEvalLogsDataSourceConfig

En datakällaskonfiguration som specificerar metadata-egenskapen för din sparade kompletteringsfråga. Detta är oftast metadata som usecase=chatbot eller prompt-version=v2, osv.

CreateEvalRequest

CreateEvalRunRequest

CreateEvalStoredCompletionsRunDataSource

En StoredCompletionsRunDataSource-konfiguration som beskriver en uppsättning filter

CustomCompute

Custom compute.

DeploymentConnection

Relativ utplaceringskoppling.

Deprecation

Definierar datumen för avskrivning för modellens olika användningsområden.

Vanligtvis stödjer basmodeller 1 års finjustering efter skapandet. Inferens stöds vanligtvis två år efter skapandet av bas- eller finjusterade modeller. De exakta datumen anges i fastigheterna.

DpoHyperparamsRequest

Hyperparametrar för DPO-metoden för finjustering

DpoMethod

Begäran om finjustering av DPO-metoden

DpoMethodConfigRequest

Konfiguration för dpo finjusteringsmetoden. Inkluderar DPO-specifika hyperparametrar

DpoMethodRequest

Begäran om finjustering av DPO-metoden

EndpointKeyConnection

Slutpunktsnyckelanslutning.

EndpointMIConnection

Endpoint Managed Identity-anslutning.

Error

Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna.

ErrorCode

Felkoder enligt definitionen i Microsoft REST-riktlinjerna.

ErrorResponse

Felsvar enligt definitionen i Microsoft REST-riktlinjerna.

Eval

Ett utvärderingsobjekt med en datakällaskonfiguration och testkriterier. En utvärdering representerar en uppgift som ska utföras för din LLM-integration. Like:

• Förbättra kvaliteten på min chatbot
• Se hur bra min chatbot hanterar kundsupport
• Kolla om O3-mini är bättre för mitt användningsområde än GPT-4O

EvalApiError

Ett objekt som representerar ett felsvar från Eval API:et.

EvalCustomDataSourceConfig

En CustomDataSourceConfig som specificerar schemat för dina item och eventuellt sample namnrymder. Responsschemat definierar formen på datan som ska vara: - Används för att definiera dina testkriterier och - Vilken data som krävs vid skapandet av en körning

EvalFileRunDataSource

En FileRunDataSource-konfiguration med ett fil-id

EvalItem

Ett meddelande som matas in i modellen med en roll som anger instruktion som följer hierarkin. Instruktioner som ges med developer rollen system har företräde framför instruktioner som ges med user rollen. Meddelanden med rollen assistant antas ha genererats av modellen i tidigare interaktioner.

EvalJsonlFileContentSource

EvalJsonlFileIdSource

EvalLabelModelGrader

Ett LabelModelGrader-objekt som använder en modell för att tilldela etiketter till varje objekt i utvärderingen.

EvalList

Ett objekt som representerar en lista över utvärderingar.