Referenční informace k rozhraní REST API ve verzi Preview pro Azure OpenAI v modelech Azure AI Foundry

Tento článek obsahuje podrobnosti o koncových bodech rozhraní REST API pro odvozování pro Azure OpenAI.

Specifikace rozhraní API

Správa modelů a prostředků Azure OpenAI a interakce s nimi je rozdělená mezi tři primární plochy rozhraní API:

• Úroveň řízení
• Rovina dat – vytváření
• Rovina dat – odvozování

Každá povrch/specifikace rozhraní API zapouzdřuje jinou sadu funkcí Azure OpenAI. Každé rozhraní API má svou vlastní jedinečnou sadu verzí Preview a stabilní/obecně dostupné (GA) API. Verze Preview se v současné době obvykle řídí měsíčním tempem.

Důležité

Teď je k dispozici nové náhledové rozhraní API pro odvozování. Další informace najdete v průvodci životním cyklem rozhraní API.

API (rozhraní pro programování aplikací)	Nejnovější verze Preview	Nejnovější verze GA	Specifikace	Popis
Řídicí rovina	2024-06-01-preview	2024-10-01	Soubory specifikace	Azure OpenAI sdílí společnou řídicí rovinu se všemi ostatními službami. Rozhraní API roviny řízení se používá například pro vytváření prostředků Azure OpenAI, nasazení modelu a dalších úloh správy prostředků vyšší úrovně. Řídicí rovina také řídí možnosti, jako je Azure Resource Manager, Bicep, Terraform a Azure CLI.
Rovina dat – vytváření	2025-04-01-preview	2024-10-21	Soubory specifikace	Rozhraní API pro vytváření roviny dat řídí jemné ladění, nahrávání souborů, úlohy příjmu dat, dávky a určité dotazy na úrovni modelu.
Rovina dat – odvozování	2025-04-01-preview	2024-10-21	Soubory specifikace	Rozhraní API pro odvozování roviny dat poskytuje možnosti odvozování a koncové body pro funkce, jako jsou dokončování, dokončování chatu, vkládání, zvuk, data, Dall-e, asistenti atd.

Autentizace

Azure OpenAI poskytuje dvě metody ověřování. Můžete použít klíče rozhraní API nebo ID Microsoft Entra.

• Ověřování pomocí klíče rozhraní API: Pro tento typ ověřování musí všechny požadavky rozhraní API obsahovat klíč rozhraní API v api-key hlavičce HTTP. Rychlý start obsahuje pokyny k volání s tímto typem ověřování.

• Ověřování ID Microsoft Entra: Volání rozhraní API můžete ověřit pomocí tokenu Microsoft Entra. Ověřovací tokeny jsou součástí požadavku jako hlavičky Authorization . Zadaný token musí předcházet Bearernapříklad Bearer YOUR_AUTH_TOKEN. Můžete si přečíst náš návod k ověřování pomocí Microsoft Entra ID.

Správa verzí rozhraní REST API

Rozhraní API služby se označují verzí pomocí parametru dotazu api-version. Všechny verze mají datovou strukturu RRRR-MM-DD. Například:

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

Návrh datové roviny

Zbytek článku popisuje nejnovější verzi Preview specifikace odvozování roviny dat Azure OpenAI. 2025-04-01-preview

Pokud hledáte dokumentaci k nejnovější verzi rozhraní GA API, projděte si nejnovější rozhraní API pro odvozování roviny dat GA.

Batch – seznam

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

Získá seznam všech dávek vlastněných prostředkem Azure OpenAI.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
po	dotaz	Ne	řetězec	Identifikátor poslední události z předchozího požadavku na stránkování
omezení	dotaz	Ne	celočíselný	Počet dávek, které se mají načíst Výchozí hodnota je 20.
$filter	dotaz	Ne	řetězec	Výraz OData popisující podmínky filtrování.
$orderby	dotaz	Ne	řetězec	Výraz OData popisující pořadí řazení.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	BatchesList

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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 – vytvoření

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

Vytvoří a spustí dávku z nahraného souboru požadavků.

Odpověď obsahuje podrobnosti o zřetěděné úloze včetně stavu úlohy.

ID výsledného souboru se po dokončení přidá do odpovědi.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Název	Typ	Popis	Povinné	Výchozí
doba dokončení	řetězec	Časový rámec, ve kterém má být dávka zpracována.	Ano
koncový bod	řetězec	Koncový bod rozhraní API používaný dávkou.	Ano
input_blob	řetězec	Adresa URL objektu blob služby Azure Storage, která se použije jako vstup pro dávku.	Ne
identifikátor_vstupního_souboru	řetězec	ID vstupního souboru pro dávku.	Ne
metadatové informace	objekt	Sada párů klíč-hodnota, které lze připojit k dávce. To může být užitečné pro ukládání dalších informací o dávce ve strukturovaném formátu.	Ne
výstup_vyprší_po	FileExpiresAfter	Definuje vypršení platnosti souboru.	Ne
výstupní_složka	BatchOutputReference	Složka Azure Storage pro uložení výstupu.	Ne

Odpovědi

Stavový kód: 201

Popis: Dávka byla úspěšně vytvořena.

Typ obsahu	Typ	Popis
application/json	Dávka

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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 – Získání

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

Získá podrobnosti pro jednu dávku určenou daným ID dávky.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
batch-id	cesta	Ano	řetězec	Identifikátor dávky.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	Dávka

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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 – Zrušit

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

Zruší zpracování dávky určené daným ID dávky.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
batch-id	cesta	Ano	řetězec	Identifikátor dávky.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Dávka byla úspěšně zrušena.

Typ obsahu	Typ	Popis
application/json	Dávka

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
    }
  }
}

Uložené dokončování – seznam

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

Získá seznam uložených dokončení.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
metadatové informace	dotaz	Ne	řetězec	Filtrování podle páru (klíč, hodnota) v uloženém dokončení
model	dotaz	Ne	řetězec	Filtrujte podle názvu modelu.
po	dotaz	Ne	řetězec	Identifikátor posledního uloženého dokončení z předchozího požadavku na stránkování.
omezení	dotaz	Ne	celočíselný	Počet uložených dokončení, které se mají načíst. Výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec	Pořadí výsledků podle času vytvoření (vzestupně nebo sestupně). Výchozí hodnota je desc.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	UloženýSeznamDokončení

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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
  }
}

Uložené dokončení – Získání

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

Získá uložení dokončení podle daného uloženého ID dokončení.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
uložené-id-dokončení	cesta	Ano	řetězec	Identifikátor uloženého dokončení.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	StoredCompletionResponse

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
      }
    ]
  }
}

Uložené dokončení – Aktualizace

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

Aktualizujte uložené dokončování podle daného uloženého ID dokončení.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
uložené-id-dokončení	cesta	Ano	řetězec	Identifikátor uloženého dokončení.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Název	Typ	Popis	Povinné	Výchozí
metadatové informace	objekt	Další informace potřebujete pomocí libovolných párů klíč-hodnota.	Ne

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	StoredCompletion

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
      }
    ]
  }
}

Uložené dokončování – Odstranit

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

Odstranění uloženého dokončení podle daného uloženého ID dokončení

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
uložené-id-dokončení	cesta	Ano	řetězec	Identifikátor uloženého dokončení.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Uložené dokončení bylo úspěšně odstraněno.

Typ obsahu	Typ	Popis
application/json	StoredCompletionDelete

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 200

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

Uložené dokončování – Getmessages

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

Získá uložené zprávy dokončení podle daného uloženého ID dokončení.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
uložené-id-dokončení	cesta	Ano	řetězec	Identifikátor uloženého dokončení.
po	dotaz	Ne	řetězec	Identifikátor poslední uložené zprávy o dokončení z předchozího požadavku na stránkování
omezení	dotaz	Ne	celočíselný	Počet uložených zpráv dokončení, které se mají načíst. Výchozí hodnota je 20.
objednávka	dotaz	Ne	řetězec	Pořadí výsledků podle indexu zpráv (vzestupně nebo sestupně) Výchozí hodnota je asc.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	UloženéZprávyODokončení

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 200

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

Vyhodnocení – získání seznamu

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

Zobrazení seznamu vyhodnocení projektu

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
po	dotaz	Ne	řetězec	Identifikátor posledního hodnocení z předchozího požadavku na stránkování.
omezení	dotaz	Ne	celočíselný	Počet hodnot, které se mají načíst.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Pořadí řazení pro hodnocení podle časového razítka Slouží asc pro vzestupné nebo desc sestupné pořadí.
seřadit podle	dotaz	Ne	řetězec Možné hodnoty: created_at, updated_at	Hodnocení lze řadit podle času vytvoření nebo času poslední aktualizace. Použijte created_at pro čas vytvoření nebo updated_at pro čas poslední aktualizace.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Seznam hodnocení

Typ obsahu	Typ	Popis
application/json	EvalList

Příklady

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

Odpovědi: Stavový kód: 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
  }
}

Vyhodnocení a vytvoření

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

Vytvořte strukturu vyhodnocení, které lze použít k otestování výkonu modelu. Vyhodnocení je sada testovacích kritérií a zdroje dat. Po vytvoření vyhodnocení ho můžete spustit na různých modelech a parametrech modelu. Podporujeme několik typů graderů a zdrojů dat.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 201

Popis: OK

Typ obsahu	Typ	Popis
application/json	Eval

Příklady

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"
  }
 ]
}

Odpovědi: Stavový kód: 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": {}
  }
}

Vyhodnocení – odstranění

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

Smazat hodnocení

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, které chcete odstranit.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Vyhodnocení bylo úspěšně odstraněno.

Typ obsahu	Typ	Popis
application/json	objekt

Stavový kód: 404

Popis: Vyhodnocení nebylo nalezeno.

Typ obsahu	Typ	Popis
application/json	Chyba

Příklady

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

Odpovědi: Stavový kód: 200

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

Stavový kód: 404

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

Vyhodnocení – získat

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

Získejte vyhodnocení na základě identifikátoru.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, které se má načíst.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Vyhodnocení

Typ obsahu	Typ	Popis
application/json	Eval

Příklady

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

Odpovědi: Stavový kód: 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": {}
  }
}

Vyhodnocení – aktualizace

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

Aktualizujte určité vlastnosti vyhodnocení.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, které se má aktualizovat.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Aktualizované vyhodnocení

Typ obsahu	Typ	Popis
application/json	Eval

Příklady

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

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

Odpovědi: Stavový kód: 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"
    }
  }
}

Vyhodnocení – Getrunlist

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

Získejte seznam spuštění pro vyhodnocení.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
po	dotaz	Ne	řetězec	Identifikátor posledního spuštění z předchozího požadavku na stránkování
omezení	dotaz	Ne	celočíselný	Počet spuštění, která se mají načíst
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Řazení běhů podle časového razítka Slouží asc pro vzestupné nebo desc sestupné pořadí. Výchozí hodnota je asc.
stav	dotaz	Ne	řetězec Možné hodnoty: queued, in_progress, completed, canceled, failed	Filtr se spouští podle stavu. Použijte "ve frontě", "probíhá", "selhalo", "dokončeno", "zrušeno".
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Seznam spuštění pro vyhodnocení

Typ obsahu	Typ	Popis
application/json	EvalRunList

Příklady

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

Odpovědi: Stavový kód: 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
  }
}

Vyhodnocení – Vytvoření spuštění

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

Vytvořte nové zkušební spuštění. Toto je koncový bod, který zahájí známkování.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, pro které se má vytvořit běh.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 201

Popis: Úspěšně byl vytvořen úkol pro vyhodnocení.

Typ obsahu	Typ	Popis
application/json	EvalRun

Stavový kód: 400

Popis: Chybný požadavek (například chybějící objekt hodnocení)

Typ obsahu	Typ	Popis
application/json	Chyba

Příklady

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
  }
 }
}

Odpovědi: Stavový kód: 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": {}
  }
}

Vyhodnocení – smazání provádění

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

Odstranit zkušební běh

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, ze kterého se má běh odstranit.
run-id	cesta	Ano	řetězec	ID spuštění, které chcete odstranit.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěšné odstranění zkušebního spuštění

Typ obsahu	Typ	Popis
application/json	objekt

Stavový kód: 404

Popis: Běh nebyl nalezen.

Typ obsahu	Typ	Popis
application/json	Chyba

Příklady

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

Odpovědi: Stavový kód: 200

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

Stavový kód: 404

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

Vyhodnocení – Spuštění

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

Získejte evaluaci podle ID.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
run-id	cesta	Ano	řetězec	ID spuštění, které se má načíst.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Průběh vyhodnocení

Typ obsahu	Typ	Popis
application/json	EvalRun

Příklady

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

Odpovědi: Stavový kód: 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": {}
  }
}

Vyhodnocení – zrušení spuštění

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

Zrušení probíhajícího zkušebního spuštění

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, jehož spuštění chcete zrušit.
run-id	cesta	Ano	řetězec	ID spuštění, které chcete zrušit.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Zrušený objekt zkušebního vyhodnocení

Typ obsahu	Typ	Popis
application/json	EvalRun

Příklady

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

Odpovědi: Stavový kód: 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": {}
  }
}

Vyhodnocení – Getrunoutputitems

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

Získejte seznam výstupních položek pro spuštění vyhodnocení.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
run-id	cesta	Ano	řetězec	ID spuštění pro načtení výstupních položek.
po	dotaz	Ne	řetězec	Identifikátor poslední výstupní položky z předchozího požadavku na stránkování
omezení	dotaz	Ne	celočíselný	Počet výstupních položek, které se mají získat
stav	dotaz	Ne	řetězec Možné hodnoty: fail, pass	Filtrovat výstupní položky podle stavu Slouží failed k filtrování podle neúspěšných výstupních položek nebo pass filtrování podle předaných výstupních položek.
objednávka	dotaz	Ne	řetězec Možné hodnoty: asc, desc	Řazení výstupních položek podle časového razítka Slouží asc pro vzestupné nebo desc sestupné pořadí. Výchozí hodnota je asc.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Seznam výstupních položek pro spuštění vyhodnocení

Typ obsahu	Typ	Popis
application/json	EvalRunOutputItemList

Příklady

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

Odpovědi: Stavový kód: 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
  }
}

Vyhodnocení – Getrunoutputitem

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

Získejte výstupní položku zkušebního spuštění podle ID.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
eval-id	cesta	Ano	řetězec	ID vyhodnocení, pro které se mají načíst běhy.
run-id	cesta	Ano	řetězec	ID spuštění, které se má načíst.
ID položky výstupu	cesta	Ano	řetězec	ID výstupní položky, která se má načíst.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Výstupní položka zkušebního spuštění

Typ obsahu	Typ	Popis
application/json	EvalRunOutputItem

Příklady

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

Odpovědi: Stavový kód: 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
    }
  }
}

Soubory – seznam

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

Získá seznam všech souborů vlastněných prostředkem Azure OpenAI.

Patří sem obsah odeslaný uživatelem, jako jsou soubory s účelem "vyladění" pro trénování nebo ověřování modelů jemného ladění, a také soubory, které jsou generovány službou, jako je třeba "doladění výsledků", které obsahují různé metriky pro odpovídající úlohu jemného ladění.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
účel	dotaz	Ne	řetězec Možné hodnoty: fine-tune, fine-tune-results, , assistantsassistants_output, batchbatch_output, evalsevals_output	Vrátí pouze soubory s daným účelem.
omezení	dotaz	Ne	celočíselný	Omezení počtu vrácených objektů. Limit může být v rozsahu 1 až 10 000 a výchozí hodnota je 10 000.
after	dotaz	Ne	řetězec	Kurzor pro použití ve stránkování after je ID objektu, které definuje vaše místo v seznamu. Pokud například vytvoříte požadavek na seznam a obdržíte 100 objektů, končící na obj_foo, může následující volání zahrnovat after=obj_foo, aby se načte další stránka seznamu.
objednávka	dotaz	Ne	řetězec	Seřaďte pořadí podle časového razítka created_at objektů. asc pro vzestupné řazení a desc pro sestupné řazení.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	FileList

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Soubory – Nahrání

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

Vytvoří novou entitu souboru tak, že nahraje data z místního počítače. Nahrané soubory se dají například použít k trénování nebo vyhodnocování jemně vyladěných modelů.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: multipart/form-data

Název	Typ	Popis	Povinné	Výchozí
ukotvení	řetězec	Definuje ukotvení vzhledem k času, ze které se má vygenerovat absolutní vypršení platnosti.	Ne
sekundy	celočíselný	Získá relativní čas vypršení platnosti v sekundách.
Rozsah: [1209600 - 2592000].	Ne
soubor	řetězec	Získá nebo nastaví soubor pro nahrání do Azure OpenAI.	Ano
účel	řetězec	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

Odpovědi

Stavový kód: 201

Popis: Soubor byl úspěšně vytvořen.

Typ obsahu	Typ	Popis
application/json	soubor

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Soubory – Import

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

Vytvoří novou entitu souboru importem dat z zadané adresy URL. Nahrané soubory se dají například použít k trénování nebo vyhodnocování jemně vyladěných modelů.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Název	Typ	Popis	Povinné	Výchozí
content_url	řetězec	Adresa URL pro stažení dokumentu (může to být adresa URL SAS objektu blob nebo jakékoli jiné externí adresy URL přístupné prostřednictvím požadavku GET).	Ano
vyprší_po	FileExpiresAfter	Definuje vypršení platnosti souboru.	Ne
jméno souboru	řetězec	Název souboru JSON Lines , který se má nahrát.
Pokud je purpose nastavená na "doladění", každý řádek je záznam JSON s poli výzvy a dokončení představujícími vaše příklady trénování.	Ano
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

Odpovědi

Stavový kód: 201

Popis: Soubor byl úspěšně vytvořen.

Typ obsahu	Typ	Popis
application/json	soubor

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Soubory – Získat

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

Získá podrobnosti o jednom souboru určeném daným ID souboru, včetně stavu, velikosti, účelu atd.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID souboru	cesta	Ano	řetězec	Identifikátor souboru.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	soubor

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 200

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

Soubory – Odstranit

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

Odstraní soubor s daným ID souboru.

Odstranění je také povoleno, pokud byl soubor použit, například jako trénovací soubor v úloze jemného doladění.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID souboru	cesta	Ano	řetězec	Identifikátor souboru.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Soubor byl úspěšně odstraněn.

Typ obsahu	Typ	Popis
application/json	FileDelete

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 200

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

Soubory – Získání obsahu

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

Získá obsah souboru určeného daným ID souboru.

Soubory mohou být nahrané uživatelem nebo vygenerované službou, například jako metriky výsledků úlohy jemného doladění.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
ID souboru	cesta	Ano	řetězec	Identifikátor souboru.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/octet-stream	řetězec
application/json	řetězec

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/octet-stream	ErrorResponse
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 200

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

Vyladění – seznam

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

Získá seznam všech jemně vyladěných úloh vlastněných prostředkem Azure OpenAI. Podrobnosti vrácené pro každou úlohu jemného ladění obsahují kromě identifikátoru základního modelu, trénovacích a ověřovacích souborů, hyperparametrů, časových razítek, stavu a událostí.

Události se vytvoří, když se změní stav úlohy. Například spuštění nebo dokončení a nahrání výsledků.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
po	dotaz	Ne	řetězec	Identifikátor poslední události z předchozího požadavku na stránkování
omezení	dotaz	Ne	celočíselný	Počet událostí, které se mají načíst Výchozí hodnota je 20.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	FineTuningJobList

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Vyladit – Vytvořit

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

Vytvoří úlohu, která jemně naladí zadaný model z daného trénovacího souboru.

Odpověď obsahuje podrobnosti o výčtové úloze, včetně stavu úlohy a parametrů hyper.

Po dokončení se do odpovědi přidá název jemně vyladěného modelu.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Název	Typ	Popis	Povinné	Výchozí
hyperparametry	FineTuningHyperParameters	Nastavení hyperparametru použitého v úloze vyladění.	Ne
integrace	pole	Seznam konfigurací pro integrace podporující jemné doladění úkolu. Plánuje se mnoho integrací, proto nezapomeňte zkontrolovat typ integrace a reagovat na tento typ integrace.	Ne
metoda	objekt	Metoda používaná k jemnému ladění pod dohledem	Ne
└- typ	FineTuningMethodType		Ne
model	řetězec	Identifikátor (ID modelu) základního modelu, který se používá pro tuto vyladění.	Ano
semeno	celočíselný	Semeno použité pro úlohu jemného ladění. Předání stejných počátečních parametrů a parametrů úlohy by mělo vést ke stejným výsledkům, ale ve výjimečných případech se může lišit. Pokud není zadaná počáteční sada, vygeneruje se za vás.	Ne
přípona	řetězec	Přípona použitá k identifikaci jemně vyladěného modelu. Přípona může obsahovat až 40 znaků (a-z, A-Z, 0-9 a _), které se přidají do vašeho jemně vyladěného názvu modelu.	Ne
tréninkový soubor	řetězec	Identita souboru (ID souboru), která se používá k trénování tohoto jemně vyladěného modelu.	Ano
validační_soubor	řetězec	Identita souboru (ID souboru), která se používá k vyhodnocení jemně vyladěného modelu během trénování.	Ne

Odpovědi

Stavový kód: 201

Popis: Ladění bylo úspěšně vytvořeno.

Typ obsahu	Typ	Popis
application/json	FineTuningJob

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Jemné ladění – Získat

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

Získá podrobnosti pro jednu jemně vyladěnou úlohu určenou daným nastavením fine-tune-id.

Podrobnosti obsahují základní model, trénovací a ověřovací soubory, hyperparametry, časové razítka, stav a události.

Události se vytvoří, když se stav úlohy změní, například spuštění nebo dokončení a nahrání výsledků.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
Identifikátor úkolu pro jemné ladění	cesta	Ano	řetězec	Identifikátor úlohy jemného ladění.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	FineTuningJob

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Jemné ladění – Smazání

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

Odstraní úlohu jemného ladění zadanou daným nastavením fine-tune-id.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
Identifikátor úkolu pro jemné ladění	cesta	Ano	řetězec	Identifikátor úlohy jemného ladění.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 204

Popis: Ladění bylo úspěšně odstraněno.

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 204

{
  "headers": {}
}

Vyladění – Zrušení

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

Zruší zpracování úlohy jemného ladění určené daným ID jemného ladění.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
Identifikátor úkolu pro jemné ladění	cesta	Ano	řetězec	Identifikátor úlohy jemného ladění.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Ladění bylo úspěšně zrušeno.

Typ obsahu	Typ	Popis
application/json	FineTuningJob

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Vyladění – získání kontrolních bodů

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

Získá kontrolní body pro úlohu jemného ladění určenou daným nastavením fine-tune-id.

Kontrolní body se vytvářejí na konci úspěšných epoch během trénování.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
Identifikátor úkolu pro jemné ladění	cesta	Ano	řetězec	Identifikátor úlohy jemného ladění.
po	dotaz	Ne	řetězec	Identifikátor posledního ID kontrolního bodu z předchozího požadavku na stránkování
omezení	dotaz	Ne	celočíselný	Počet kontrolních bodů, které se mají načíst Výchozí nastavení je 10.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	Seznam kontrolních bodů úlohy jemného ladění

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Vyladění – Získání událostí

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

Získá události pro jemně vyladěnou úlohu určenou daným nastavením fine-tune-id.

Události se vytvoří, když se stav úlohy změní, například spuštění nebo dokončení a nahrání výsledků.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
Identifikátor úkolu pro jemné ladění	cesta	Ano	řetězec	Identifikátor úlohy jemného ladění.
po	dotaz	Ne	řetězec	Identifikátor poslední události z předchozího požadavku na stránkování
omezení	dotaz	Ne	celočíselný	Počet událostí, které se mají načíst Výchozí hodnota je 20.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	Seznam událostí FineTuningJob

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Doladění – pozastavení

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

Pozastavení zpracování úlohy jemného ladění zadané daným nastavením fine-tune-id

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
Identifikátor úkolu pro jemné ladění	cesta	Ano	řetězec	Identifikátor úlohy jemného ladění.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Ladění bylo úspěšně pozastaveno.

Typ obsahu	Typ	Popis
application/json	FineTuningJob

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Vyladění – pokračování

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

Obnoví zpracování práce doladění specifikované daným fine-tune-id.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
Identifikátor úkolu pro jemné ladění	cesta	Ano	řetězec	Identifikátor úlohy jemného ladění.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Doladění bylo úspěšně obnoveno.

Typ obsahu	Typ	Popis
application/json	FineTuningJob

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Úlohy příjmu dat – Seznam

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

Zobrazí seznam úloh příjmu dat.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.
mgmt-user-token	záhlaví	Ne	řetězec	Token použitý pro přístup k pracovnímu prostoru (potřebný pouze pro výpočetní úlohy uživatele)

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	IngestionJobList

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
      }
    ]
  }
}

Úlohy příjmu dat – Vytvoření

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

Vytvoří úlohu příjmu dat se zadaným ID úlohy.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.
ID úlohy	cesta	Ano	řetězec	ID úlohy, která se vytvoří.
mgmt-user-token	záhlaví	Ne	řetězec	Token použitý pro přístup k pracovnímu prostoru (potřebný pouze pro výpočetní úlohy uživatele)
token uživatele AML	záhlaví	Ne	řetězec	Token použitý pro přístup k prostředkům v rámci úlohy v pracovním prostoru (potřebný pouze pro výpočetní úlohy uživatele).

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Název	Typ	Popis	Povinné	Výchozí
ID úlohy	řetězec		Ne
laskavý	IngestionJobType	Typ úlohy.	Ano

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	Úloha příjmu dat

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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

Odpovědi: Stavový kód: 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"
    }
  }
}

Úlohy příjmu dat – Získání

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

Získá podrobnosti o zadaném ID úlohy.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.
ID úlohy	cesta	Ano	řetězec	ID úlohy.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	Úloha příjmu dat

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
    }
  }
}

Provozní běhy příjmu dat – Seznam

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

Zobrazí seznam spuštění zadaného ID úlohy.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.
ID úlohy	cesta	Ano	řetězec	ID úlohy.
mgmt-user-token	záhlaví	Ne	řetězec	Token použitý pro přístup k pracovnímu prostoru (potřebný pouze pro výpočetní úlohy uživatele)

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	IngestionJobRunList

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
      }
    ]
  }
}

Získání úlohy příjmu dat - Přístup

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

Získá podrobnosti o zadaném ID spuštění jako součást zadaného ID úlohy.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.
ID úlohy	cesta	Ano	řetězec	ID úlohy.
run-id	cesta	Ano	řetězec	ID spuštění.
mgmt-user-token	záhlaví	Ne	řetězec	Token použitý pro přístup k pracovnímu prostoru (potřebný pouze pro výpočetní úlohy uživatele)

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	Spuštění úlohy příjmu dat

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
        }
      ]
    }
  }
}

Modely – seznam

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

Získá seznam všech modelů, které jsou přístupné prostředkem Azure OpenAI.

Patří sem základní modely i všechny úspěšně dokončené jemně vyladěné modely vlastněné prostředkem Azure OpenAI.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	Seznam modelů

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Modely – Získat

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

Získá podrobnosti pro model určený daným ID modelu.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
model-id	cesta	Ano	řetězec	Identifikátor modelu.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	model

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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

Odpovědi: Stavový kód: 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"
  }
}

Nahrání souboru – Start

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

Vytvoří se zprostředkující objekt Upload, který vám umožní přidat do něj části. V současné době může být velikost nahrávání celkem maximálně 9 GB a platnost vyprší 2 hodiny po vytvoření.

Po dokončení nahrávání se vygeneruje objekt File obsahující všechny nahrané části. Tento objekt File se pak dá použít na naší platformě stejně jako jakýkoli jiný soubor.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Název	Typ	Popis	Povinné	Výchozí
bajtů	celočíselný		Ano
jméno souboru	řetězec		Ano
Typ MIME	řetězec		Ano
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

Tělo žádosti

Content-Type: text/json

Název	Typ	Popis	Povinné	Výchozí
bajtů	celočíselný		Ano
jméno souboru	řetězec		Ano
Typ MIME	řetězec		Ano
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

Tělo žádosti

Content-Type: application/*+json

Název	Typ	Popis	Povinné	Výchozí
bajtů	celočíselný		Ano
jméno souboru	řetězec		Ano
Typ MIME	řetězec		Ano
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

Odpovědi

Stavový kód: 200

Popis: Nahrávání bylo úspěšně vytvořeno.

Typ obsahu	Typ	Popis
application/json	UploadResource

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

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

Odpovědi: Stavový kód: 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"
  }
}

Nahrát soubor – Zrušit

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

Zruší nahrávání a asynchronně se odstraní všechny nahrané části.

Po zrušení nahrávání není možné přidat žádné části.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
upload-id	cesta	Ano	řetězec	Identifikátor nahrání.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	UploadResource

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 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"
  }
}

Nahrát soubor – dokončeno

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

Tím se dokončí nahrávání a vrácený objekt Upload obsahuje vnořený objekt File, který je připravený k použití na platformě.

Pořadí částí můžete definovat zadáním seřazeného seznamu ID částí.

Celkový počet nahraných bajtů se musí shodovat s velikostí původně zadanou při vytváření objektu Upload.

Po dokončení nahrávání nelze po dokončení této operace přidat žádné další části.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
upload-id	cesta	Ano	řetězec	Identifikátor nahrání.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: application/json

Název	Typ	Popis	Povinné	Výchozí
md5	řetězec		Ne
part_ids	pole		Ano

Tělo žádosti

Content-Type: text/json

Název	Typ	Popis	Povinné	Výchozí
md5	řetězec		Ne
part_ids	pole		Ano

Tělo žádosti

Content-Type: application/*+json

Název	Typ	Popis	Povinné	Výchozí
md5	řetězec		Ne
part_ids (identifikátory dílů)	pole		Ano

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	UploadResource

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

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

Odpovědi: Stavový kód: 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"
  }
}

Nahrání souboru – část

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

Přidá část do objektu Upload, kde každá část představuje segment souboru, který nahráváte.

Každá část může být až do standardního limitu velikosti pro nahrávání souborů na základě účelu souboru. Můžete pokračovat v přidávání částí, dokud nedosáhnete limitu velikosti nahrávání 9 GB.

Parametry identifikátoru URI

Název	V	Povinné	Typ	Popis
koncový bod	cesta	Ano	řetězec adresa URL	Podporované koncové body Azure OpenAI (protokol a název hostitele, například: https://aoairesource.openai.azure.com. Nahraďte "aoairesource" názvem prostředku Azure OpenAI). https://{název_prostředku}.openai.azure.com
upload-id	cesta	Ano	řetězec	Identifikátor nahrání.
verze API	dotaz	Ano	řetězec	Požadovaná verze rozhraní API.

Hlavička požadavku

Použijte buď ověřování na základě tokenu, nebo klíč rozhraní API. Ověřování pomocí ověřování na základě tokenů se doporučuje a je bezpečnější.

Název	Povinné	Typ	Popis
Autorizace	Pravdivé	řetězec	Příklad:Authorization: Bearer {Azure_OpenAI_Auth_Token} Generování ověřovacího tokenu pomocí Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Adresa URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize rozsah: https://cognitiveservices.azure.com/.default
API klíč	Pravdivé	řetězec	Tady zadejte klíč rozhraní API Azure OpenAI.

Tělo žádosti

Content-Type: multipart/form-data

Název	Typ	Popis	Povinné	Výchozí
údaje	řetězec		Ano

Odpovědi

Stavový kód: 200

Popis: Úspěch

Typ obsahu	Typ	Popis
application/json	UploadPartResource

Stavový kód: výchozí

Popis: Došlo k chybě.

Typ obsahu	Typ	Popis
application/json	ErrorResponse

Příklady

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

Odpovědi: Stavový kód: 200

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

Součásti

AzureAI Vyhledávací Index

Index služby Azure AI Search.

Název	Typ	Popis	Povinné	Výchozí
connectionId	řetězec	ID připojení odkazující na index služby Azure AI Search.	Ne
laskavý	CílovýTyp	Typ cíle.	Ano

BaseConnection

Připojení k prostředku.

Diskriminátor pro BaseConnection

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
laskavý	TypPřipojení	Typ připojení.	Ano

Dávka

Definuje hodnoty dávky.

Název	Typ	Popis	Povinné	Výchozí
zrušeno_v	celočíselný	Časové razítko, kdy byla tato dávka zrušena (v unixových epochách).	Ne
cancelling_at	celočíselný	Časové razítko, kdy tato dávka začala rušovat (v unixových epochách).	Ne
dokončeno v	celočíselný	Časové razítko, kdy byla tato dávka dokončena (v epochách unixu).	Ne
doba dokončení	řetězec	Časový rámec, ve kterém má být dávka zpracována.	Ne
datum_vytvoření	celočíselný	Časové razítko, kdy byla tato dávka vytvořena (v unixových epochách).	Ne
koncový bod	řetězec	Koncový bod rozhraní API používaný dávkou.	Ne
error_blob	řetězec	Adresa URL blobu, který obsahuje výstupy z požadavků s chybnými výsledky.	Ne
ID_chyby_souboru	řetězec	ID souboru obsahujícího výstupy požadavků s chybami.	Ne
chyby	BatchErrors	U dávek, které selhaly, bude obsahovat další informace o příčině selhání.	Ne
vypršelo dne	celočíselný	Časové razítko, kdy tato dávka vypršela (v epochách unixu).	Ne
datum vypršení	celočíselný	Časové razítko, kdy tato dávka vyprší (v unixových epochách).	Ne
selháno_při	celočíselný	Časové razítko, kdy tato dávka selhala (v epochách unixu).	Ne
dokončování_na	celočíselný	Časové razítko, kdy tato dávka začala finalizovat (v unixových epochách).	Ne
identifikační číslo	řetězec	Identita této položky.	Ano
probíhá_v	celočíselný	Časové razítko, kdy tato dávka začala postupovat (v unixových epochách).	Ne
input_blob	řetězec	Blob URL obsahující vstupní soubor pro dávku.	Ne
identifikátor_vstupního_souboru	řetězec	ID vstupního souboru pro dávku.	Ano
metadatové informace	objekt	Sada párů klíč-hodnota, které lze připojit k dávce. To může být užitečné pro ukládání dalších informací o dávce ve strukturovaném formátu.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
output_blob	řetězec	Adresa URL objektu blob obsahující výstupy úspěšně provedených požadavků.	Ne
identifikátor_výstupního_souboru	řetězec	ID souboru obsahujícího výstupy úspěšně provedených požadavků.	Ne
počty žádostí	BatchRequestCounts	Počet požadavků pro různé stavy v dávce.	Ne
stav	BatchStatus	Stav dávky.	Ne

Žádost o hromadné vytvoření

Definuje požadavek na vytvoření dávky.

Název	Typ	Popis	Povinné	Výchozí
doba dokončení	řetězec	Časový rámec, ve kterém má být dávka zpracována.	Ano
koncový bod	řetězec	Koncový bod rozhraní API používaný dávkou.	Ano
input_blob	řetězec	Adresa URL objektu blob služby Azure Storage, která se použije jako vstup pro dávku.	Ne
identifikátor_vstupního_souboru	řetězec	ID vstupního souboru pro dávku.	Ne
metadatové informace	objekt	Sada párů klíč-hodnota, které lze připojit k dávce. To může být užitečné pro ukládání dalších informací o dávce ve strukturovaném formátu.	Ne
výstup_vyprší_po	FileExpiresAfter	Definuje vypršení platnosti souboru.	Ne
výstupní_složka	BatchOutputReference	Složka Azure Storage pro uložení výstupu.	Ne

BatchErrorData

Informace o chybě selhání v dávce

Název	Typ	Popis	Povinné	Výchozí
kód	řetězec	Kód chyby identifikující typ chyby.	Ne
řádek	řetězec	Číslo řádku vstupního souboru, ve kterém došlo k chybě ( může být null).	Ne
zpráva	řetězec	Zpráva čitelná pro člověka s dalšími podrobnostmi o chybě.	Ne
Parametr	řetězec	Název parametru, který způsobil chybu ( může mít hodnotu null).	Ne

BatchErrors

U dávek, které selhaly, bude obsahovat další informace o příčině selhání.

Název	Typ	Popis	Povinné	Výchozí
údaje	BatchErrorData	Informace o chybě selhání v dávce	Ne
objekt	řetězec	Typ objektu chyby. Vždy se jedná o seznam.	Ne

BatchRequestCounts

Počet požadavků pro různé stavy v dávce.

Název	Typ	Popis	Povinné	Výchozí
dokončené	celočíselný	Počet požadavků v dávce, které byly úspěšně dokončeny.	Ne
selhalo	celočíselný	Počet požadavků v dávce, které selhaly.	Ne
totální	celočíselný	Celkový počet požadavků v dávce.	Ne

BatchOutputReference

Složka Azure Storage pro uložení výstupu.

Název	Typ	Popis	Povinné	Výchozí
oddělovač	řetězec	Volitelný. Oddělovač použitý ve výchozím nastavení v cestě ke složce je /.	Ne
adresa URL	řetězec	Adresa URL složky Azure Storage, do které se uloží dávkové výstupy.	Ne

BatchStatus

Stav dávky.

Vlastnictví	Hodnota
Popis	Stav dávky.
Typ	řetězec
Hodnoty	validating failed in_progress finalizing completed expired cancelling cancelled

BatchesList

Představuje seznam šarží.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznampoložekch	Ne
first_id	řetězec	ID první dávky v seznamu vrácených dávek.	Ne
má více	Boolean	Hodnota označující, zda seznam obsahuje více prvků, než je vráceno.	Ne
last_id	řetězec	ID poslední dávky v seznamu vrácených dávek.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne

Schopnosti

Možnosti základního modelu nebo doladění modelu.

Název	Typ	Popis	Povinné	Výchozí
dokončení chatu	Boolean	Hodnota označující, jestli model podporuje dokončování chatu.	Ano
dokončení	Boolean	Hodnota označující, jestli model podporuje dokončování.	Ano
embedování	Boolean	Hodnota označující, jestli model podporuje vkládání.	Ano
fine_tune	Boolean	Hodnota označující, jestli lze model použít k jemnému ladění.	Ano
usuzování	Boolean	Hodnota označující, jestli lze model nasadit.	Ano

Volba

Název	Typ	Popis	Povinné	Výchozí
důvod ukončení	řetězec	Důvod, proč model přestal generovat tokeny	Ne
rejstřík	celočíselný	Index výběru v seznamu voleb.	Ne
protokoly	objekt	Protokolování informací o pravděpodobnosti pro volbu	Ne
zpráva	ChoiceMessage		Ne

ChoiceMessage

Název	Typ	Popis	Povinné	Výchozí
obsah	řetězec	Obsah zprávy.	Ne
úloha	řetězec	Role entity, která vytváří zprávu.	Ne
volání nástrojů	pole	Seznam příslušných volání nástrojů.	Ne

BlokingSettings

Nastavení bloků dat

Název	Typ	Popis	Povinné	Výchozí
maximální velikost bloku v tokenech	celočíselný		Ne

Akce při dokončení

Akce dokončení.

Vlastnictví	Hodnota
Popis	Akce dokončení.
Typ	řetězec
Hodnoty	cleanUpTempAssets keepAllAssets

Typ výpočtu

Typ výpočetních prostředků.

Vlastnictví	Hodnota
Popis	Typ výpočetních prostředků.
Typ	řetězec
Hodnoty	ServerlessCompute CustomCompute

ConnectionStringConnection

Připojení připojovacího řetězce.

Název	Typ	Popis	Povinné	Výchozí
connection string	řetězec	Připojovací řetězec	Ne
laskavý	TypPřipojení	Typ připojení.	Ano

Typ připojení

Typ připojení.

Vlastnictví	Hodnota
Popis	Typ připojení.
Typ	řetězec
Hodnoty	EndpointWithKey ConnectionString EndpointWithManagedIdentity WorkspaceConnection RelativeConnection

CosmosDBIndex

Index Služby Cosmos DB

Název	Typ	Popis	Povinné	Výchozí
název kolekce	řetězec	Název kolekce Cosmos DB.	Ne
connectionId	řetězec	ID připojení odkazujícího na cosmos DB.	Ne
název databáze	řetězec	Název databáze cosmos DB.	Ne
laskavý	CílovýTyp	Typ cíle.	Ano

Nastavení procházení

Nastavení procházení

Název	Typ	Popis	Povinné	Výchozí
maximální hloubka průzkumu	celočíselný		Ne
maxDobaSkenováníVMin	celočíselný		Ne
Maximální doba stahování (v minutách)	celočíselný		Ne
maximální velikost souboru (maxFileSize)	celočíselný		Ne
maxFiles	celočíselný		Ne
maximální počet přesměrování	celočíselný		Ne

VytvořitDatovýZdrojProBěhVyhodnoceníDokončení

Objekt CompletionsRunDataSource popisující konfiguraci vzorkování modelu.

Název	Typ	Popis	Povinné	Výchozí
zprávy_vstupu	objekt		Ne
└ item_reference	řetězec	Odkaz na proměnnou v oboru názvů item, např. "item.name".	Ne
Šablona └─	pole	Seznam chatových zpráv tvořících výzvu nebo kontext Může obsahovat odkazy na proměnné z oboru názvů 'item', jako například {{item.name}}.	Ne
└- typ	výčet	Typ vstupních zpráv. Buď template, nebo item_reference. Možné hodnoty: template, item_reference	Ne
model	řetězec	Název modelu, který se má použít pro generování výstupů (např. 'o3-mini').	Ne
parametry vzorkování	objekt		Ne
└─ maximální_dokončovací_tokeny	celočíselný	Maximální počet tokenů ve vygenerovaném výstupu.	Ne
└semeno	celočíselný	Počáteční hodnota, která inicializuje náhodnost během vzorkování.	Ne	42
└− teplota	číslo	Vyšší teplota zvyšuje náhodnost ve výstupech.	Ne	1
└top_p	číslo	Alternativou k teplotě odběru vzorků z jádra; 1.0 zahrnuje všechny tokeny.	Ne	1
zdroj	objekt		Ano
└- typ	výčet	Typ zdroje. Může to být jeden z EvalJsonlFileContentSource, EvalJsonlFileIdSourcenebo EvalStoredCompletionsSource. Možné hodnoty: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Ne
typ	výčet	Typ spuštění zdroje dat. Vždy completions. Možné hodnoty: completions	Ano

VytvořitEvalVlastníKonfiguraciZdrojeDat

Objekt CustomDataSourceConfig, který definuje schéma pro zdroj dat použitý pro zkušební spuštění. Toto schéma slouží k definování formy dat, která budou: – používána pro stanovení kritérií testování a – která data jsou potřebná při vytváření spuštění.

Název	Typ	Popis	Povinné	Výchozí
zahrnout_vzorek_schématu	Boolean	Určuje, jestli by se měl očekávat, že naplníte ukázkový obor názvů (tj. vygenerováním odpovědí z vašeho zdroje dat).	Ne	Nepravda
schéma položky	objekt	Schéma JSON pro každý řádek ve zdroji dat.	Ano
typ	výčet	Typ zdroje dat. Vždy custom. Možné hodnoty: custom	Ano

VytvořitEvalPoložku

Chatová zpráva, která tvoří výzvu nebo kontext. Může zahrnovat odkazy na proměnné v prostoru názvů "item", tj. {{item.name}}.

Název	Typ	Popis	Povinné	Výchozí
obsah	['string', 'InputTextContent', 'object']	Textové vstupy modelu – mohou obsahovat řetězce šablony.	Ano
úloha	výčet	Role vstupu zprávy. Jeden z user, assistant, systemnebo developer. Možné hodnoty: user, assistant, system, developer	Ano
typ	výčet	Typ vstupu zprávy. Vždy message. Možné hodnoty: message	Ne

CreateEvalJsonlRunDataSource

Objekt JsonlRunDataSource, který určuje JSONL soubor odpovídající hodnotě eval.

Název	Typ	Popis	Povinné	Výchozí
zdroj	objekt		Ano
└- obsah	pole	Obsah souboru jsonl.	Ne
└- ID	řetězec	Identifikátor souboru.	Ne
└- typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ne
typ	výčet	Typ zdroje dat. Vždy jsonl. Možné hodnoty: jsonl	Ano

Vytvořit hodnotící nástroj modelu štítků (CreateEvalLabelModelGrader)

Objekt LabelModelGrader, který používá model k přiřazení popisků ke každé položce v vyhodnocení.

Název	Typ	Popis	Povinné	Výchozí
vstup	pole	Seznam chatových zpráv tvořících výzvu nebo kontext Může zahrnovat odkazy na proměnné v prostoru názvů "item", tj. {{item.name}}.	Ano
štítky	pole	Popisky, které se mají klasifikovat pro každou položku v hodnocení.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení. Musí podporovat strukturované výstupy.	Ano
název	řetězec	Název hodnotitele.	Ano
předávání štítků	pole	Popisky označující úspěšný výsledek. Musí to být podmnožina popisků.	Ano
typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: label_model	Ano

CreateEvalLogsDataSourceConfig

Konfigurace zdroje dat, která určuje vlastnost metadat uloženého dotazu dokončení. Obvykle se jedná o metadata jako usecase=chatbot nebo prompt-version=v2atd.

Název	Typ	Popis	Povinné	Výchozí
metadatové informace	objekt	Filtry metadat pro zdroj dat protokolů	Ne
typ	výčet	Typ zdroje dat. Vždy logs. Možné hodnoty: logs	Ano

VytvořitPožadavekNaHodnocení

Název	Typ	Popis	Povinné	Výchozí
konfigurace_zdroj_dat	objekt	Objekt CustomDataSourceConfig, který definuje schéma pro zdroj dat použitý pro zkušební spuštění. Toto schéma slouží k definování formy dat, která budou: – používána pro stanovení kritérií testování a – která data jsou potřebná při vytváření spuštění.	Ano
└─ zahrnout_vzorek_schématu	Boolean	Určuje, jestli by se měl očekávat, že naplníte ukázkový obor názvů (tj. vygenerováním odpovědí z vašeho zdroje dat).	Ne	Nepravda
└item_schema	objekt	Schéma JSON pro každý řádek ve zdroji dat.	Ne
└– metadata	objekt	Filtry metadat pro zdroj dat protokolů	Ne
└- typ	výčet	Typ zdroje dat. Vždy logs. Možné hodnoty: logs	Ne
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
název	řetězec	Název vyhodnocení.	Ne
testovací_kritéria	pole	Seznam známkovačů pro všechny zkušební běhy v této skupině.	Ano

VytvořitŽádostOProvedeníHodnocení

Název	Typ	Popis	Povinné	Výchozí
zdroj dat	objekt	Objekt JsonlRunDataSource, který určuje JSONL soubor odpovídající hodnotě eval.	Ano
└input_messages	objekt		Ne
└ item_reference	řetězec	Odkaz na proměnnou v oboru názvů item, např. "item.name".	Ne
Šablona └─	pole	Seznam chatových zpráv tvořících výzvu nebo kontext Může obsahovat odkazy na proměnné z oboru názvů 'item', jako například {{item.name}}.	Ne
└- typ	výčet	Typ vstupních zpráv. Buď template, nebo item_reference. Možné hodnoty: template, item_reference	Ne
└model	řetězec	Název modelu, který se má použít pro generování výstupů (např. 'o3-mini').	Ne
└sampling_params	objekt		Ne
└─ maximální_dokončovací_tokeny	celočíselný	Maximální počet tokenů ve vygenerovaném výstupu.	Ne
└semeno	celočíselný	Počáteční hodnota, která inicializuje náhodnost během vzorkování.	Ne	42
└− teplota	číslo	Vyšší teplota zvyšuje náhodnost ve výstupech.	Ne	1
└top_p	číslo	Alternativou k teplotě odběru vzorků z jádra; 1.0 zahrnuje všechny tokeny.	Ne	1
└- zdroj	objekt		Ne
└- typ	výčet	Typ zdroje. Může to být jeden z EvalJsonlFileContentSource, EvalJsonlFileIdSourcenebo EvalStoredCompletionsSource. Možné hodnoty: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Ne
└- typ	výčet	Typ spuštění zdroje dat. Vždy completions. Možné hodnoty: completions	Ne
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
název	řetězec	Název běhu.	Ne

VytvořitZdrojDatUloženéhoHodnoceníKompletacíBěhu

Konfigurace StoredCompletionsRunDataSource popisující sadu filtrů

Název	Typ	Popis	Povinné	Výchozí
vytvořeno po	celočíselný	Volitelné časové razítko unixu pro filtrování položek vytvořených po této době.	Ne
vytvořeno před	celočíselný	Volitelné časové razítko unixu pro filtrování položek vytvořených před tímto časem.	Ne
omezení	celočíselný	Volitelný maximální počet položek, které se mají vrátit.	Ne
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
model	řetězec	Volitelný model pro filtrování podle (např. gpt-4o).	Ne
typ	výčet	Typ zdroje dat. Vždy stored_completions. Možné hodnoty: stored_completions	Ano

CustomCompute

Vlastní výpočetní prostředky.

Název	Typ	Popis	Povinné	Výchozí
computeId	řetězec	ID vlastního výpočetního prostředí	Ne
laskavý	ComputeType	Typ výpočetních prostředků.	Ano

DeploymentConnection

Relativní připojení k nasazení

Název	Typ	Popis	Povinné	Výchozí
laskavý	TypPřipojení	Typ připojení.	Ano

Zavrhování

Definuje data vyřazení pro různé případy použití modelu.

Základní modely obvykle podporují 1 rok vyladění po vytvoření. Odvozování se obvykle podporuje 2 roky po vytvoření základních nebo jemně vyladěných modelů. Přesná data jsou zadána ve vlastnostech.

Název	Typ	Popis	Povinné	Výchozí
fine_tune	celočíselný	Koncové datum vyladění podpory tohoto modelu. Bude null pro vyladění modelů.	Ne
usuzování	celočíselný	Koncové datum podpory odvozování tohoto modelu.	Ano

DpoHyperparamsRequest

Hyperparametry pro metodu vyladění DPO

Název	Typ	Popis	Povinné	Výchozí
velikost dávky	celočíselný	Velikost dávky, která se má použít pro trénování. Velikost dávky je počet trénovacích příkladů použitých k trénování během jednoho průchodu dopředu a zpět. Obecně jsme zjistili, že větší velikosti dávek obvykle fungují lépe u větších datových sad. Výchozí hodnota a maximální hodnota této vlastnosti jsou specifické pro základní model.	Ne
beta	číslo	Hodnota beta DPO	Ne
násobitel L2	číslo	Násobitel regularizace L2	Ne
násobič rychlosti učení	číslo	Násobitel rychlosti učení, který se má použít pro trénování. Míra doladění je původní míra učení používaná pro předtrénování vynásobenou touto hodnotou. Větší rychlost učení obvykle funguje lépe s většími velikostmi dávek. Doporučujeme experimentovat s hodnotami v rozsahu 0,02 až 0,2, abyste zjistili, co vede k dosažení nejlepších výsledků.	Ne
počet epoch	celočíselný	Počet epoch pro trénování modelu. Epocha označuje jeden celý cyklus skrze trénovací datovou sadu.	Ne

DpoMethod

Požadavek na optimalizaci metody DPO

Název	Typ	Popis	Povinné	Výchozí
dpo	DpoMethodConfigRequest	Konfigurace pro metodu jemného doladění dpo. Zahrnuje hyperparametry specifické pro DPO.	Ano
typ	FineTuningMethodType		Ano

DpoMethodConfigRequest

Konfigurace pro metodu jemného doladění dpo. Zahrnuje hyperparametry specifické pro DPO.

Název	Typ	Popis	Povinné	Výchozí
hyperparametry	DpoHyperparamsRequest	Hyperparametry pro metodu vyladění DPO	Ne

DpoMethodRequest

Požadavek na optimalizaci metody DPO

Název	Typ	Popis	Povinné	Výchozí
dpo	DpoMethodConfigRequest	Konfigurace pro metodu jemného doladění dpo. Zahrnuje hyperparametry specifické pro DPO.	Ano
typ	FineTuningMethodType		Ano

EndpointKeyConnection

Připojení klíče koncového bodu

Název	Typ	Popis	Povinné	Výchozí
koncový bod	řetězec	Koncový bod	Ne
klíč	řetězec	Klíč	Ne
laskavý	TypPřipojení	Typ připojení.	Ano

EndpointMIConnection

Připojení spravované identity koncového bodu

Název	Typ	Popis	Povinné	Výchozí
koncový bod	řetězec	Koncový bod	Ne
laskavý	TypPřipojení	Typ připojení.	Ano
identifikátor zdroje	řetězec	ID prostředku	Ne

Chyba

Obsah chyby definovaný v pokynech microsoft REST

Název	Typ	Popis	Povinné	Výchozí
kód	ErrorCode	Kódy chyb definované v pokynech microsoft REST	Ano
Podrobnosti	pole	Podrobnosti o chybě, pokud jsou k dispozici.	Ne
innererror	Vnitřní chyba	Vnitřní chyba definovaná v pokynech microsoft REST.	Ne
zpráva	řetězec	Zpráva o této chybě.	Ano
cíl	řetězec	Umístění, kde k chybě došlo, pokud je k dispozici.	Ne

Chybový kód

Kódy chyb definované v pokynech microsoft REST

Vlastnictví	Hodnota
Popis	Kódy chyb definované v pokynech microsoft REST
Typ	řetězec
Hodnoty	conflict invalidPayload forbidden notFound unexpectedEntityState itemDoesAlreadyExist serviceUnavailable internalFailure quotaExceeded jsonlValidationFailed fileImportFailed tooManyRequests unauthorized contentFilter

Chybová odpověď

Odpověď na chybu definovaná v pokynech microsoft REST

Název	Typ	Popis	Povinné	Výchozí
chyba	Chyba	Obsah chyby definovaný v pokynech microsoft REST	Ano

Vyhodnocení

Objekt Eval s konfiguračními a testovacími kritérii zdroje dat. Eval představuje úkol, který se má provést pro integraci LLM. Jako:

• Zlepšení kvality chatovacího robota
• Podívejte se, jak dobře chatbot zpracovává zákaznickou podporu
• Zkontrolujte, jestli je v mém případu použití lepší o3-mini než gpt-4o.

Název	Typ	Popis	Povinné	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření zkušebního období.	Ano
konfigurace_zdroj_dat	objekt	CustomDataSourceConfig, která určuje schéma vašich item a volitelně sample oborů názvů. Schéma odpovědi definuje tvar dat, která budou: – sloužit k definování testovacích kritérií a – jaká data se vyžadují při vytváření testovacího běhu.	Ano
└– metadata	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
└- schéma	objekt	Schéma JSON pro položky zdroje dat běhu. Tady se dozvíte, jak se vytvářejí schémata JSON.	Ne
└- typ	výčet	Typ zdroje dat. Vždy stored_completions. Možné hodnoty: stored_completions	Ne
identifikační číslo	řetězec	Jedinečný identifikátor pro vyhodnocení.	Ano
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ano
název	řetězec	Název vyhodnocení.	Ano
objekt	výčet	Typ objektu. Možné hodnoty: eval	Ano
testovací_kritéria	pole	Seznam testovacích kritérií.	Ano

Chyba EvalApiError

Objekt představující chybovou odpověď z rozhraní Eval API.

Název	Typ	Popis	Povinné	Výchozí
kód	řetězec	Kód chyby.	Ano
zpráva	řetězec	Chybová zpráva.	Ano

EvalCustomDataSourceConfig

CustomDataSourceConfig, která určuje schéma vašich item a volitelně sample oborů názvů. Schéma odpovědi definuje tvar dat, která budou: – sloužit k definování testovacích kritérií a – jaká data se vyžadují při vytváření testovacího běhu.

Název	Typ	Popis	Povinné	Výchozí
schéma	objekt	Schéma JSON pro položky zdroje dat běhu. Tady se dozvíte, jak se vytvářejí schémata JSON.	Ano
typ	výčet	Typ zdroje dat. Vždy custom. Možné hodnoty: custom	Ano

EvalFileRunDataSource

Konfigurace FileRunDataSource s ID souboru

Název	Typ	Popis	Povinné	Výchozí
ID souboru	řetězec	Identifikátor souboru.	Ano
typ	výčet	Typ zdroje dat. Vždy file. Možné hodnoty: file	Ano

EvalItem

Vstup zprávy do modelu s rolí, která označuje dodržování hierarchie pokynů. Pokyny, které mají roli developer nebo system, mají přednost před pokyny s rolí user. U zpráv s rolí assistant se předpokládá, že byly vygenerovány modelem v předchozích interakcích.

Název	Typ	Popis	Povinné	Výchozí
obsah	objekt	Textový vstup do modelu.	Ano
└- text	řetězec	Textový výstup z modelu.	Ne
└- typ	výčet	Typ výstupního textu. Vždy output_text. Možné hodnoty: output_text	Ne
úloha	výčet	Role vstupu zprávy. Jeden z user, assistant, systemnebo developer. Možné hodnoty: user, assistant, system, developer	Ano
typ	výčet	Typ vstupu zprávy. Vždy message. Možné hodnoty: message	Ne

EvalJsonlFileContentSource

Název	Typ	Popis	Povinné	Výchozí
obsah	pole	Obsah souboru jsonl.	Ano
typ	výčet	Typ zdroje jsonl. Vždy file_content. Možné hodnoty: file_content	Ano

EvalJsonlFileIdSource

Název	Typ	Popis	Povinné	Výchozí
identifikační číslo	řetězec	Identifikátor souboru.	Ano
typ	výčet	Typ zdroje jsonl. Vždy file_id. Možné hodnoty: file_id	Ano

EvalLabelModelGrader

Objekt LabelModelGrader, který používá model k přiřazení popisků ke každé položce v vyhodnocení.

Název	Typ	Popis	Povinné	Výchozí
vstup	pole		Ano
štítky	pole	Popisky, které se mají přiřadit ke každé položce v hodnocení.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení. Musí podporovat strukturované výstupy.	Ano
název	řetězec	Název hodnotitele.	Ano
předávání štítků	pole	Popisky označující úspěšný výsledek. Musí to být podmnožina popisků.	Ano
typ	výčet	Typ objektu, který je vždy label_model. Možné hodnoty: label_model	Ano

EvalList

Objekt představující seznam hodnot.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Pole eval objektů.	Ano
first_id	řetězec	Identifikátor prvního evalu v datovém poli.	Ano
má více	Boolean	Určuje, zda je k dispozici více hodnocení.	Ano
last_id	řetězec	Identifikátor posledního evalu v datovém poli.	Ano
objekt	výčet	Typ tohoto objektu. Vždycky je nastavený na "list". Možné hodnoty: list	Ano

EvalRun

Schéma představující běh vyhodnocení

Název	Typ	Popis	Povinné	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) při vytvoření zkušebního spuštění	Ano
zdroj dat	objekt	Objekt JsonlRunDataSource, který určuje JSONL soubor odpovídající hodnotě eval.	Ano
└input_messages	objekt		Ne
└ item_reference	řetězec	Odkaz na proměnnou v oboru názvů item, např. "item.name".	Ne
Šablona └─	pole	Seznam chatových zpráv tvořících výzvu nebo kontext Může obsahovat odkazy na proměnné z oboru názvů 'item', jako například {{item.name}}.	Ne
└- typ	výčet	Typ vstupních zpráv. Buď template, nebo item_reference. Možné hodnoty: template, item_reference	Ne
└model	řetězec	Název modelu, který se má použít pro generování výstupů (např. 'o3-mini').	Ne
└sampling_params	objekt		Ne
└─ maximální_dokončovací_tokeny	celočíselný	Maximální počet tokenů ve vygenerovaném výstupu.	Ne
└semeno	celočíselný	Počáteční hodnota, která inicializuje náhodnost během vzorkování.	Ne	42
└− teplota	číslo	Vyšší teplota zvyšuje náhodnost ve výstupech.	Ne	1
└top_p	číslo	Alternativou k teplotě odběru vzorků z jádra; 1.0 zahrnuje všechny tokeny.	Ne	1
└- zdroj	objekt		Ne
└- typ	výčet	Typ zdroje. Může to být jeden z EvalJsonlFileContentSource, EvalJsonlFileIdSourcenebo EvalStoredCompletionsSource. Možné hodnoty: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Ne
└- typ	výčet	Typ spuštění zdroje dat. Vždy completions. Možné hodnoty: completions	Ne
chyba	EvalApiError	Objekt představující chybovou odpověď z rozhraní Eval API.	Ano
eval_id	řetězec	Identifikátor přidruženého hodnocení.	Ano
identifikační číslo	řetězec	Jedinečný identifikátor pro spuštění vyhodnocení.	Ano
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ano
model	řetězec	Model, který se vyhodnocuje, pokud je k dispozici.	Ano
název	řetězec	Název zkušebního spuštění.	Ano
objekt	výčet	Typ objektu. Vždy "eval.run". Možné hodnoty: eval.run	Ano
per_model_usage	pole	Statistiky využití pro každý model během zkušebního spuštění	Ano
výsledky podle testovacích kritérií	pole	Výsledky podle kritérií testování uplatněných během vyhodnocovacího běhu.	Ano
report_url	řetězec	Adresa URL vykreslené sestavy spuštění vyhodnocení na řídicím panelu uživatelského rozhraní.	Ano
počet_výsledků	objekt	Shrnutí výsledků vyhodnocovacího běhu pomocí čítačů.	Ano
└- chyba	celočíselný	Počet výstupních položek, které způsobily chybu	Ne
└– selhalo	celočíselný	Počet výstupních položek, které neprošly hodnocením.	Ne
└─ prošlo	celočíselný	Počet výstupních položek, které prošly vyhodnocením	Ne
└- celkem	celočíselný	Celkový počet spuštěných výstupních položek	Ne
stav	řetězec	Stav spuštění vyhodnocení.	Ano

Seznam EvalRun

Objekt představující seznam spuštění pro vyhodnocení.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Pole objektů hodnocení spuštění.	Ano
first_id	řetězec	Identifikátor prvního spuštění hodnocení v poli dat.	Ano
má více	Boolean	Určuje, zda je k dispozici více hodnocení.	Ano
last_id	řetězec	Identifikátor posledního evalučního spuštění v datovém poli.	Ano
objekt	výčet	Typ tohoto objektu. Vždycky je nastavený na "list". Možné hodnoty: list	Ano

EvalRunOutputItem

Schéma představující výstupní položku zkušebního spuštění

Název	Typ	Popis	Povinné	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) při vytvoření zkušebního spuštění	Ano
položka_datového_zdroje	objekt	Podrobnosti o položce vstupního zdroje dat	Ano
ID položky datového zdroje	celočíselný	Identifikátor položky zdroje dat.	Ano
eval_id	řetězec	Identifikátor zkušební skupiny.	Ano
identifikační číslo	řetězec	Jedinečný identifikátor výstupní položky zkušebního spuštění.	Ano
objekt	výčet	Typ objektu. Vždy "eval.run.output_item". Možné hodnoty: eval.run.output_item	Ano
výsledky	pole	Seznam výsledků ze zkušebního spuštění	Ano
run_id	řetězec	Identifikátor zkušebního spuštění přidruženého k této výstupní položce.	Ano
ukázka	objekt	Ukázka obsahující vstup a výstup hodnotícího běhu.	Ano
└─ chyba	EvalApiError	Objekt představující chybovou odpověď z rozhraní Eval API.	Ne
└konec_duvod	řetězec	Důvod, proč bylo generování vzorku dokončeno.	Ne
└─ vstup	pole	Pole vstupních zpráv.	Ne
└─ maximální_dokončovací_tokeny	celočíselný	Maximální počet tokenů povolených k dokončení.	Ne
└model	řetězec	Model použitý k vygenerování ukázky.	Ne
└─ výstup	pole	Pole výstupních zpráv.	Ne
└semeno	celočíselný	Počáteční hodnota použitá k vygenerování vzorku.	Ne
└− teplota	číslo	Použitá teplota vzorkování.	Ne
└top_p	číslo	Hodnota top_p použitá pro vzorkování.	Ne
└─ využití	objekt	Podrobnosti o využití tokenů pro ukázku	Ne
└─ uložené_tokény	celočíselný	Počet tokenů načtených z mezipaměti.	Ne
└─ dokončovací tokeny	celočíselný	Počet vygenerovaných tokenů dokončení	Ne
└prompt_tokens	celočíselný	Počet použitých tokenů výzvy.	Ne
└─ celkem_tokeny	celočíselný	Celkový počet použitých tokenů	Ne
stav	řetězec	Stav spuštění vyhodnocení.	Ano

Seznam položek výstupu EvalRun

Objekt představující seznam výstupních položek pro spuštění vyhodnocení.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Pole objektů položek výstupu z evaluačního spuštění.	Ano
first_id	řetězec	Identifikátor první položky výstupu z evaluačního spuštění v datovém poli.	Ano
má více	Boolean	Určuje, jestli jsou k dispozici další výstupní položky testovacího běhu.	Ano
last_id	řetězec	Identifikátor poslední výstupní položky spuštění zkušební verze v datovém poli.	Ano
objekt	výčet	Typ tohoto objektu. Vždycky je nastavený na "list". Možné hodnoty: list	Ano

EvalScoreModelGrader

A ScoreModelGrader objekt, který používá model k přiřazení skóre vstupu.

Název	Typ	Popis	Povinné	Výchozí
vstup	pole	Vstupní text. To může zahrnovat řetězce vzorů.	Ano
model	řetězec	Model, který se má použít pro vyhodnocení.	Ano
název	řetězec	Název hodnotitele.	Ano
prah průchodu	číslo	Prahová hodnota pro skóre.	Ne
rozmezí	pole	Rozsah skóre. Výchozí hodnota je [0, 1].	Ne
parametry vzorkování	objekt	Parametry vzorkování modelu.	Ne
typ	výčet	Typ objektu, který je vždy score_model. Možné hodnoty: score_model	Ano

VyhodnoceníUloženýchDokončeníZdrojDatKonfigurace

Konfigurace StoredCompletionsDataSourceConfig určující vlastnost metadat uloženého dotazu pro dokončení. Obvykle se jedná o metadata jako usecase=chatbot nebo prompt-version=v2atd. Schéma vrácené touto konfigurací zdroje dat slouží k definování proměnných, které jsou k dispozici ve vašich valech. item a sample jsou definovány při použití této konfigurace zdroje dat.

Název	Typ	Popis	Povinné	Výchozí
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
schéma	objekt	Schéma JSON pro položky zdroje dat běhu. Tady se dozvíte, jak se vytvářejí schémata JSON.	Ano
typ	výčet	Typ zdroje dat. Vždy stored_completions. Možné hodnoty: stored_completions	Ano

EvalStoredCompletionsSource

Konfigurace StoredCompletionsRunDataSource popisující sadu filtrů

Název	Typ	Popis	Povinné	Výchozí
vytvořeno po	celočíselný	Volitelné časové razítko unixu pro filtrování položek vytvořených po této době.	Ne
vytvořeno před	celočíselný	Volitelné časové razítko unixu pro filtrování položek vytvořených před tímto časem.	Ne
omezení	celočíselný	Volitelný maximální počet položek, které se mají vrátit.	Ne
metadatové informace	Metadata	Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.	Ne
model	řetězec	Volitelný model pro filtrování podle (např. gpt-4o).	Ne
typ	výčet	Typ zdroje. Vždy stored_completions. Možné hodnoty: stored_completions	Ano

EvalStringCheckGrader

A StringCheckGrader objekt, který provádí porovnání řetězců mezi vstupem a odkazem pomocí zadané operace.

Název	Typ	Popis	Povinné	Výchozí
vstup	řetězec	Vstupní text. To může zahrnovat řetězce vzorů.	Ano
název	řetězec	Název hodnotitele.	Ano
provoz	výčet	Kontrola řetězce, kterou je třeba provést. Jeden z eq, ne, likenebo ilike. Možné hodnoty: eq, ne, like, ilike	Ano
odkaz	řetězec	Text odkazu. To může zahrnovat řetězce vzorů.	Ano
typ	výčet	Typ objektu, který je vždy string_check. Možné hodnoty: string_check	Ano

HodnotitelPodobnostiTextu

A TextSimilarityGrader objekt, který ohodnotuje text na základě metrik podobnosti.

Název	Typ	Popis	Povinné	Výchozí
hodnotící metrika	výčet	Metrika vyhodnocení, která se má použít. Jeden z fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5, nebo rouge_l. Možné hodnoty: fuzzy_match, bleu, gleu, , meteor, rouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Ano
vstup	řetězec	Text, který se ohodnotuje.	Ano
název	řetězec	Název hodnotitele.	Ne
prah průchodu	číslo	Plovoucí skóre, kde hodnota větší nebo rovna označuje známku.	Ano
odkaz	řetězec	Text, který se hodnotí podle.	Ano
typ	výčet	Typ grejdru. Možné hodnoty: text_similarity	Ano

Typ události

Definuje závažnost výsledku filtru obsahu.

Vlastnictví	Hodnota
Popis	Definuje závažnost výsledku filtru obsahu.
Typ	řetězec
Hodnoty	message metrics

Soubor

Soubor je dokument použitelný pro trénování a ověřování. Může to být také dokument vygenerovaný službou s podrobnostmi o výsledku.

Název	Typ	Popis	Povinné	Výchozí
bajtů	celočíselný	Velikost tohoto souboru, pokud je k dispozici (může mít hodnotu null). Kvůli zajištění kompatibility s celými čísly JavaScriptu se nepodporují velikosti souborů větší než 2^53-1.	Ne
datum_vytvoření	celočíselný	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)	Ne
datum vypršení	celočíselný	Časové razítko unixu (počet sekund, které uplynuly od 1. ledna 1970) při vypršení platnosti souboru.	Ne
jméno souboru	řetězec	Název souboru.	Ano
identifikační číslo	řetězec	Identita této položky.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano
stav	FileState	Stav souboru.	Ne
podrobnosti stavu	řetězec	Chybová zpráva s podrobnostmi v případě, že zpracování tohoto souboru selhalo. Označeno jako zastaralé	Ne

Vytvoření souboru

Definuje dokument, který se má importovat z adresy URL externího obsahu, aby ho bylo možné použít pomocí Azure OpenAI.

Název	Typ	Popis	Povinné	Výchozí
content_url	řetězec	Adresa URL pro stažení dokumentu (může to být adresa URL SAS objektu blob nebo jakékoli jiné externí adresy URL přístupné prostřednictvím požadavku GET).	Ano
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

Smazat soubor

Definuje odpověď pro odstranění souboru.

Název	Typ	Popis	Povinné	Výchozí
smazaný	Boolean	Hodnota označující, zda je soubor odstraněn.	Ano
identifikační číslo	řetězec	ID souboru, které bylo odstraněno.	Ano
objekt	řetězec	Pokud byl soubor odstraněn.	Ano

Podrobnosti o souboru

Detail souboru je dokument, který služba Batch používá k načtení informací objektu blob souboru.

Název	Typ	Popis	Povinné	Výchozí
jméno souboru	řetězec	Název souboru.	Ano
identifikační číslo	řetězec	Identita této položky.	Ne
cesta	řetězec	Relativní cesta k souboru v kontejneru.	Ne
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano
účet_úložiště_uri	řetězec	Adresa URL účtu úložiště tohoto souboru.	Ne
název_kontejneru_pro_úložiště	řetězec	Název kontejneru úložiště tohoto souborového blobu.	Ne

SouborVypršíPo

Definuje vypršení platnosti souboru.

Název	Typ	Popis	Povinné	Výchozí
ukotvení	FileExpiryAnchor	Definuje ukotvení vzhledem k času, ze které se má vygenerovat absolutní vypršení platnosti.	Ne
sekundy	celočíselný	Relativní doba vypršení platnosti v sekundách. Rozsah: [1209600 - 2592000].	Ne

FileExpiryAnchor

Definuje ukotvení vzhledem k času, ze které se má vygenerovat absolutní vypršení platnosti.

Vlastnictví	Hodnota
Popis	Definuje ukotvení vzhledem k času, ze které se má vygenerovat absolutní vypršení platnosti.
Typ	řetězec
Hodnoty	created_at

Import souboru

Definuje dokument, který se má importovat z adresy URL externího obsahu, aby ho bylo možné použít pomocí Azure OpenAI.

Název	Typ	Popis	Povinné	Výchozí
content_url	řetězec	Adresa URL pro stažení dokumentu (může to být adresa URL SAS objektu blob nebo jakékoli jiné externí adresy URL přístupné prostřednictvím požadavku GET).	Ano
vyprší_po	FileExpiresAfter	Definuje vypršení platnosti souboru.	Ne
jméno souboru	řetězec	Název souboru JSON Lines , který se má nahrát. Pokud je purpose nastavená na "doladění", každý řádek je záznam JSON s poli výzvy a dokončení představujícími vaše příklady trénování.	Ano
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

Seznam souborů

Představuje seznam souborů.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznampoložekch	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne

Stav souboru

Stav souboru.

Vlastnictví	Hodnota
Popis	Stav souboru.
Typ	řetězec
Hodnoty	uploaded pending running processed error deleting deleted

FineTuneMethod

Diskriminátor pro FineTuneMethod

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
typ	FineTuningMethodType		Ano

FineTuneMethodRequest

Diskriminátor pro FineTuneMethodRequest

Tato komponenta používá vlastnost type k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
typ	FineTuningMethodType		Ano

DoladěníHyperparametrů

Nastavení hyperparametru použitého v úloze vyladění.

Název	Typ	Popis	Povinné	Výchozí
velikost dávky	celočíselný	Velikost dávky, která se má použít pro trénování. Velikost dávky je počet trénovacích příkladů použitých k trénování během jednoho průchodu dopředu a zpět. Obecně jsme zjistili, že větší velikosti dávek obvykle fungují lépe u větších datových sad. Výchozí hodnota a maximální hodnota této vlastnosti jsou specifické pro základní model.	Ne
násobič rychlosti učení	číslo	Násobitel rychlosti učení, který se má použít pro trénování. Míra doladění je původní míra učení používaná pro předtrénování vynásobenou touto hodnotou. Větší rychlost učení obvykle funguje lépe s většími velikostmi dávek. Doporučujeme experimentovat s hodnotami v rozsahu 0,02 až 0,2, abyste zjistili, co vede k dosažení nejlepších výsledků.	Ne
počet epoch	celočíselný	Počet epoch pro trénování modelu. Epocha označuje jeden celý cyklus skrze trénovací datovou sadu.	Ne

Jemné ladění práce

Definuje hodnoty procesu ladění.

Název	Typ	Popis	Povinné	Výchozí
datum_vytvoření	celočíselný	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)	Ne
chyba	FineTuningJobError	U úloh, které selhaly, se dolaďují, bude obsahovat další informace o příčině selhání.	Ne
odhadované dokončení	celočíselný	Časové razítko unixu (v sekundách) pro dobu, kdy se odhaduje dokončení úlohy jemného ladění. Hodnota bude nulová, pokud není spuštěná úloha jemného ladění.	Ne
jemně vyladěný model	řetězec	Identifikátor (ID modelu) výsledného jemně vyladěného modelu. Tato vlastnost je nastavena pouze pro úspěšně dokončené běhy doladění. Tento identifikátor použijte k vytvoření nasazení pro odvozování.	Ne
dokončeno v	celočíselný	Časové razítko po úspěšném dokončení této úlohy nebo položky (v epochách unixu)	Ne
hyperparametry	FineTuningHyperParameters	Nastavení hyperparametru použitého v úloze vyladění.	Ne
identifikační číslo	řetězec	Identita této položky.	Ne
integrace	pole	Seznam konfigurací pro integrace podporující jemné doladění úkolu. Plánuje se mnoho integrací, proto nezapomeňte zkontrolovat typ integrace a reagovat na tento typ integrace.	Ne
metoda	objekt	Metoda používaná k jemnému ladění pod dohledem	Ne
└- typ	FineTuningMethodType		Ne
model	řetězec	Identifikátor (ID modelu) základního modelu, který se používá pro vyladění.	Ano
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
organizace_id	řetězec	ID organizace této úlohy vyladění. Nepoužívá se v Azure OpenAI; pouze pro OpenAI.	Ne
výsledkové_soubory	pole	Identity výsledného souboru (id souboru) obsahující trénovací a vyhodnocovací metriky ve formátu CSV. Soubor je k dispozici pouze pro úspěšně dokončené běhy jemného ladění.	Ne
semeno	celočíselný	Semeno použité pro úlohu jemného ladění.	Ne
stav	FineTuningState	Stav jemně vyladěného objektu nebo úlohy jemného ladění.	Ne
přípona	řetězec	Přípona použitá k identifikaci jemně vyladěného modelu. Přípona může obsahovat až 40 znaků (a-z, A-Z, 0-9 a _), které se přidají do vašeho jemně vyladěného názvu modelu.	Ne
trénované tokeny	celočíselný	Celkový počet fakturovatelnýchtokench	Ne
tréninkový soubor	řetězec	Soubor, který se používá pro trénování.	Ano
validační_soubor	řetězec	Soubor, který se používá k vyhodnocení jemně vyladěného modelu během trénování.	Ne

Kontrolní bod úlohy ladění

Název	Typ	Popis	Povinné	Výchozí
datum_vytvoření	celočíselný	Časové razítko unixu (v sekundách) pro vytvoření kontrolního bodu.	Ano
kontrolní bod doladěného modelu	řetězec	Název jemně vyladěného modelu kontrolního bodu, který se vytvoří.	Ano
identifikátor_fine_tuning_jobu	řetězec	Název úlohy jemného ladění, ze které byl tento kontrolní bod vytvořen.	Ano
identifikační číslo	řetězec	Identita tohoto kontrolního bodu.	Ne
metriky (specifické měření nebo hodnotící standardy)	objekt	Metriky na čísle kroku během úlohy vyladění.	Ano
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
číslo_kroku	celočíselný	Číslo kroku, na které byl kontrolní bod vytvořen.	Ano

SeznamKontrolníchBodůÚlohyDoladění

Představuje seznam kontrolních bodů.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznampoložekch	Ne
má více	Boolean	Hodnota označující, zda seznam obsahuje více prvků, než je vráceno.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne

FineTuningJobCreation

Definuje hodnoty procesu ladění.

Název	Typ	Popis	Povinné	Výchozí
hyperparametry	FineTuningHyperParameters	Nastavení hyperparametru použitého v úloze vyladění.	Ne
integrace	pole	Seznam konfigurací pro integrace podporující jemné doladění úkolu. Plánuje se mnoho integrací, proto nezapomeňte zkontrolovat typ integrace a reagovat na tento typ integrace.	Ne
metoda	objekt	Metoda používaná k jemnému ladění pod dohledem	Ne
└- typ	FineTuningMethodType		Ne
model	řetězec	Identifikátor (ID modelu) základního modelu, který se používá pro tuto vyladění.	Ano
semeno	celočíselný	Semeno použité pro úlohu jemného ladění. Předání stejných počátečních parametrů a parametrů úlohy by mělo vést ke stejným výsledkům, ale ve výjimečných případech se může lišit. Pokud není zadaná počáteční sada, vygeneruje se za vás.	Ne
přípona	řetězec	Přípona použitá k identifikaci jemně vyladěného modelu. Přípona může obsahovat až 40 znaků (a-z, A-Z, 0-9 a _), které se přidají do vašeho jemně vyladěného názvu modelu.	Ne
tréninkový soubor	řetězec	Identita souboru (ID souboru), která se používá k trénování tohoto jemně vyladěného modelu.	Ano
validační_soubor	řetězec	Identita souboru (ID souboru), která se používá k vyhodnocení jemně vyladěného modelu během trénování.	Ne

Chyba úlohy doladění

U úloh, které selhaly, se dolaďují, bude obsahovat další informace o příčině selhání.

Název	Typ	Popis	Povinné	Výchozí
kód	řetězec	Strojově čitelný kód chyby.	Ne
zpráva	řetězec	Chybová zpráva čitelná pro člověka	Ne
Parametr	řetězec	Parametr, který byl neplatný, obvykle training_file nebo validation_file. Pokud selhání nebylo specifické pro parametr, bude toto pole null.	Ne

FineTuningJobEvent

Název	Typ	Popis	Povinné	Výchozí
datum_vytvoření	celočíselný	Časové razítko, kdy byla tato událost vytvořena (v unixových epochách).	Ano
údaje		Strojově čitelná data této události.	Ne
identifikační číslo	řetězec	Identita této události.	Ne
úroveň	ÚroveňLogu	Úroveň podrobností události.	Ano
zpráva	řetězec	Zpráva popisující událost. Může se jednat o změnu stavu, například zařazení do fronty, spuštění, selhání nebo dokončení nebo jiné události, jako jsou nahrané výsledky.	Ano
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
typ	typ události	Definuje závažnost výsledku filtru obsahu.	Ano

FineTuningJobEventList

Představuje seznam událostí.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznampoložekch	Ne
má více	Boolean	Hodnota označující, zda seznam obsahuje více prvků, než je vráceno.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne

SeznamPracíNaDoladění

Představuje seznam jemných melodií.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznampoložekch	Ne
má více	Boolean	Hodnota označující, zda seznam obsahuje více prvků, než je vráceno.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne

Jemné Nastavení Metody Typ

Vlastnictví	Hodnota
Typ	řetězec
Hodnoty	dpo supervised

Stav doladění

Stav jemně vyladěného objektu nebo úlohy jemného ladění.

Vlastnictví	Hodnota
Popis	Stav jemně vyladěného objektu nebo úlohy jemného ladění.
Typ	řetězec
Hodnoty	created pending running pausing paused resuming succeeded cancelled failed

FunctionCallFunction

Název	Typ	Popis	Povinné	Výchozí
argumenty	řetězec	Argumenty, které model očekává, že funkci předáte.	Ne
název	řetězec	Název funkce.	Ne

Definice funkce

Název	Typ	Popis	Povinné	Výchozí
popis	řetězec	Popis toho, co funkce dělá, kterou model používá k výběru, kdy a jak tuto funkci volat.	Ne
název	řetězec	Název funkce, která se má volat.	Ne
parametry		Parametry, které funkce přijímají, jsou popsané jako objekt schématu JSON.	Ne

ObecnáNastaveníVkládání

Nastavení vkládání připojení

Název	Typ	Popis	Povinné	Výchozí
připojení	BaseConnection	Připojení k prostředku.	Ne
názevNasazení	řetězec		Ne
název modelu	řetězec		Ne

Chyba příjmu dat

Podrobnosti o chybě příjmu dat

Název	Typ	Popis	Povinné	Výchozí
vnitřníChyby	pole		Ne
zpráva	řetězec		Ne

Úloha příjmu dat

Představuje podrobnosti úlohy.

Diskriminátor pro proces zpracování dat

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
ID úlohy	řetězec		Ne
laskavý	IngestionJobType	Typ úlohy.	Ano

Seznam úloh pro příjem dat

Představuje seznam úloh pro zpracování dat.

Název	Typ	Popis	Povinné	Výchozí
nextLink	řetězec	Odkaz na další stránku.	Ne
hodnota	pole	Seznampoložekch	Ne

IngestionJobProgress

Název	Typ	Popis	Povinné	Výchozí
Postup fáze	pole		Ano

Úloha příjmu dat

Podrobnosti o spuštění úlohy

Název	Typ	Popis	Povinné	Výchozí
chyba	Chyba příjmu dat	Podrobnosti o chybě příjmu dat	Ne
ID úlohy	řetězec		Ne
pokrok	IngestionJobProgress		Ne
runId	řetězec		Ne
stav	OperationState	Stav úlohy nebo položky	Ne
varování	pole		Ne

IngestionJobRunList

Představuje seznam běhů úloh zpracování příjmu dat.

Název	Typ	Popis	Povinné	Výchozí
nextLink	řetězec	Odkaz na další stránku.	Ne
hodnota	pole	Seznampoložekch	Ne

IngestionJobStageProgress

Název	Typ	Popis	Povinné	Výchozí
název	řetězec		Ne
zpracované položky	celočíselný		Ne
stav / stát	OperationState	Stav úlohy nebo položky	Ne
pokrok v podstadiu	pole		Ne
celkem položek	celočíselný		Ne

IngestionJobSystemCompute

Název	Typ	Popis	Povinné	Výchozí
dokončení akce	CompletionAction	Akce dokončení.	Ne
intervalAktualizaceDatVhodinách	celočíselný		Ne
zdroj dat	SystemComputeDatasource		Ne
ID úlohy	řetězec		Ne
laskavý	IngestionJobType	Typ úlohy.	Ano
připojení ke službě vyhledávání	BaseConnection	Připojení k prostředku.	Ne

Typ úlohy ingestování

Typ úlohy.

Vlastnictví	Hodnota
Popis	Typ úlohy.
Typ	řetězec
Hodnoty	SystemCompute UserCompute

IngestionJobUserCompute

Název	Typ	Popis	Povinné	Výchozí
počítat	JobCompute	Nastavení výpočetních prostředků úlohy	Ne
intervalAktualizaceDatVhodinách	celočíselný		Ne
zdroj dat	UserComputeDatasource		Ne
ID úlohy	řetězec		Ne
laskavý	IngestionJobType	Typ úlohy.	Ano
cíl	TargetIndex	Informace o indexu, který se má vytvořit.	Ne
ID pracoviště	řetězec		Ne

Vnitřní chyba

Vnitřní chyba definovaná v pokynech microsoft REST.

Název	Typ	Popis	Povinné	Výchozí
kód	InnerErrorCode	Vnitřní kódy chyb definované v pokynech microsoft REST.	Ne
innererror	Vnitřní chyba	Vnitřní chyba definovaná v pokynech microsoft REST.	Ne

Kód vnitřní chyby

Vnitřní kódy chyb definované v pokynech microsoft REST.

Vlastnictví	Hodnota
Popis	Vnitřní kódy chyb definované v pokynech microsoft REST.
Typ	řetězec
Hodnoty	invalidPayload

Zpráva pro vstup

Název	Typ	Popis	Povinné	Výchozí
obsah	řetězec	Obsah zprávy.	Ne
identifikační číslo	řetězec	Identita zprávy.	Ne
název	řetězec	Volitelné jméno účastníka. Poskytuje informace o modelu pro rozlišení mezi účastníky stejné role.	Ne
úloha	řetězec	Role entity, která vytváří zprávu.	Ne

InputTextContent

Textový vstup do modelu.

Název	Typ	Popis	Povinné	Výchozí
Text	řetězec	Textový vstup do modelu.	Ano
typ	výčet	Typ vstupní položky. Vždy input_text. Možné hodnoty: input_text	Ano

Typy integrace

Seznam dostupných integrací s jemným laděním

Vlastnictví	Hodnota
Popis	Seznam dostupných integrací s jemným laděním
Typ	řetězec
Hodnoty	wandb

JobCompute

Nastavení výpočetních prostředků úlohy

Diskriminátor pro jobCompute

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
laskavý	ComputeType	Typ výpočetních prostředků.	Ano

LifeCycleStatus

Stav životního cyklu modelu.

Poznámka: Model může být povýšen z preview na generally-available, ale nikdy od generally-available do preview.

Vlastnictví	Hodnota
Popis	Stav životního cyklu modelu. Poznámka: Model může být povýšen z preview na generally-available, ale nikdy od generally-available do preview.
Typ	řetězec
Hodnoty	preview generally-available deprecating deprecated

LogLevel

Úroveň podrobností události.

Vlastnictví	Hodnota
Popis	Úroveň podrobností události.
Typ	řetězec
Hodnoty	info warning error

Logprob

Název	Typ	Popis	Povinné	Výchozí
logprob	číslo	Pravděpodobnost protokolu tohoto tokenu, pokud je v top 20 nejpravděpodobnějších tokenech. V opačném případě se hodnota -9999.0 používá k označení, že token je velmi nepravděpodobné.	Ne
žeton	řetězec	Token.	Ne

Metadatové informace

Sada 16 párů klíč-hodnota, které lze připojit k objektu. To může být užitečné pro ukládání dalších informací o objektu ve strukturovaném formátu a dotazování na objekty prostřednictvím rozhraní API nebo řídicího panelu. Klíče jsou řetězce s maximální délkou 64 znaků. Hodnoty jsou řetězce s maximální délkou 512 znaků.

Pro tuto komponentu nejsou definovány žádné vlastnosti.

Vzor

Model je buď základní model, nebo výsledek úspěšného procesu vyladění.

Název	Typ	Popis	Povinné	Výchozí
schopnosti	možnosti	Možnosti základního modelu nebo doladění modelu.	Ano
datum_vytvoření	celočíselný	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)	Ne
zavrhování	Zavrhování	Definuje data vyřazení pro různé případy použití modelu. Základní modely obvykle podporují vyladění po dobu 1 roku po svém vytvoření, zatímco odvozování je obvykle podporováno 2 roky po vytvoření základních nebo jemně vyladěných modelů. Přesná data jsou zadána ve vlastnostech.	Ano
fine_tune	řetězec	Pokud se jedná o model jemného ladění, vylaďte identitu úlohy (fine-tune-id). jinak null.	Ne
identifikační číslo	řetězec	Identita této položky.	Ne
stav životního cyklu	LifeCycleStatus	Stav životního cyklu modelu. Poznámka: Model lze povýšit z "náhled" na generally-available, ale nikdy z generally-available na "náhled".	Ano
model	řetězec	Základní identita modelu (ID modelu), pokud se jedná o model vyladění; jinak null.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
stav	FineTuningState	Stav jemně vyladěného objektu nebo úlohy jemného ladění.	Ne

Seznam modelů

Představuje seznam modelů.

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznampoložekch	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne

OperationState

Stav úlohy nebo položky

Vlastnictví	Hodnota
Popis	Stav úlohy nebo položky
Typ	řetězec
Hodnoty	notRunning running succeeded failed

Objednávka

Definuje účel souboru.

Vlastnictví	Hodnota
Popis	Definuje účel souboru.
Typ	řetězec
Hodnoty	desc asc

OrderByOrder

Vlastnictví	Hodnota
Typ	řetězec
Hodnoty	asc desc

PineconeIndex

Borovišový index.

Název	Typ	Popis	Povinné	Výchozí
connectionId	řetězec	ID spojení směřujícího na borovice.	Ne
laskavý	CílovýTyp	Typ cíle.	Ano

Účel

Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.

Vlastnictví	Hodnota
Popis	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.
Typ	řetězec
Hodnoty	fine-tune fine-tune-results assistants assistants_output batch batch_output evals evals_output

Bezserverové výpočty

Bezserverové výpočetní prostředky.

Název	Typ	Popis	Povinné	Výchozí
instanceCount	celočíselný	Počet instancí, na kterých se má úloha spustit.	Ne
laskavý	ComputeType	Typ výpočetních prostředků.	Ano
SKU (identifikátor zboží)	řetězec	Úroveň skladové položky	Ne

Uložené dokončení

Název	Typ	Popis	Povinné	Výchozí
volby	pole	Seznam možností dokončení chatu Pokud je větší než 1, může být více než jedna n .	Ne
vytvořil	celočíselný	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu.	Ne
trest za frekvenci	číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne
identifikační číslo	řetězec	Identita uloženého dokončení.	Ne
uživatel_vstupu	řetězec	Vstupní uživatel pro tento požadavek.	Ne
metadatové informace	objekt	Další informace potřebujete pomocí libovolných párů klíč-hodnota.	Ne
model	řetězec	ID modelu, který se má použít.	Ne
penalizace přítomnosti	číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne
id_požadavku	řetězec	Jedinečný identifikátor požadavku rozhraní API OpenAI. Při kontaktování podpory uveďte toto ID žádosti.	Ne
semeno	celočíselný	Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seed parametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste se obrátit na
system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
úroveň služby	řetězec	Určuje úroveň latence, která se má použít ke zpracování požadavku.	Ne
systémový otisk prstu	řetězec	Tento otisk prstu představuje konfiguraci back-endu, se kterou model běží. Lze použít společně s parametrem seed požadavku, abyste pochopili, kdy byly provedeny změny back-endu, které by mohly ovlivnit determinismus.	Ne
Teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
výběr nástroje	řetězec	Určuje, který (pokud existuje) nástroj, který model volá.	Ne
nářadí	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	Ne
top_p	číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
využití	Využití		Ne

UloženaKompletníSmazání

Název	Typ	Popis	Povinné	Výchozí
smazaný	Boolean	Hodnota označující, jestli dojde k odstranění uloženého dokončení.	Ne
identifikační číslo	řetězec	Uložené ID dokončení, které bylo odstraněno.	Ne
objekt	řetězec	Pokud bylo uložené dokončení odstraněno.	Ano

UloženýSeznamDokončení

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznam načtených objektů.	Ne
first_id	řetězec	První ID načtené list	Ne
má více	Boolean	Vlastnost has_more slouží ke stránkování k označení dalších výsledků.	Ne
last_id	řetězec	Poslední ID načteného list	Ne
objekt	řetězec	Typ objektu, který je vždy list	Ne
totální	celočíselný	Celkový počet položek	Ne

UloženéZprávyOÚkončení

Název	Typ	Popis	Povinné	Výchozí
údaje	pole	Seznam načtených objektů.	Ne
first_id	řetězec	První ID načtené list	Ne
má více	Boolean	Vlastnost has_more slouží ke stránkování k označení dalších výsledků.	Ne
last_id	řetězec	Poslední ID načteného list	Ne
objekt	řetězec	Typ objektu, který je vždy list	Ne
totální	celočíselný	Celkový počet položek	Ne

UloženáOdpověďNaDokončení

Název	Typ	Popis	Povinné	Výchozí
volby	pole	Seznam možností dokončení chatu Pokud je větší než 1, může být více než jedna n .	Ne
vytvořil	celočíselný	Časové razítko unixu (v sekundách) doby vytvoření dokončení chatu.	Ne
trest za frekvenci	číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě jejich stávající frekvence v textu, což snižuje pravděpodobnost opakování stejného doslovného znění řádku modelu.	Ne
identifikační číslo	řetězec	Identita uloženého dokončení.	Ne
uživatel_vstupu	řetězec	Vstupní uživatel pro tento požadavek.	Ne
metadatové informace	objekt	Další informace potřebujete pomocí libovolných párů klíč-hodnota.	Ne
model	řetězec	ID modelu, který se má použít.	Ne
objekt	řetězec	Typ tohoto objektu.	Ne
penalizace přítomnosti	číslo	Číslo mezi -2,0 a 2,0 Kladné hodnoty sankují nové tokeny na základě toho, jestli se zatím zobrazují v textu, což zvyšuje pravděpodobnost, že model mluví o nových tématech.	Ne
id_požadavku	řetězec	Jedinečný identifikátor požadavku rozhraní API OpenAI. Při kontaktování podpory uveďte toto ID žádosti.	Ne
semeno	celočíselný	Pokud je zadáno, náš systém se bude snažit vzorkovat deterministicky, aby opakované požadavky se stejnými seedparametry měly vrátit stejný výsledek. Determinismus není zaručený a měli byste odkazovat na system_fingerprint parametr odpovědi pro monitorování změn v back-endu.	Ne
úroveň služby	řetězec	Určuje úroveň latence, která se má použít ke zpracování požadavku.	Ne
systémový otisk prstu	řetězec	Tento otisk prstu představuje konfiguraci back-endu, se kterou model běží. Lze použít společně s parametrem seed požadavku, abyste pochopili, kdy byly provedeny změny back-endu, které by mohly ovlivnit determinismus.	Ne
Teplota	číslo	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí větší náhodnost výstupu, zatímco nižší hodnoty jako0,2 z něj budou více zaměřené a deterministické. Obecně doporučujeme tuto změnu změnit, top_p ale ne obojí.	Ne
výběr nástroje	řetězec	Určuje, který (pokud existuje) nástroj, který model volá.	Ne
nářadí	pole	Seznam nástrojů, které model může volat. V současné době se jako nástroj podporují jenom funkce. Pomocí tohoto příkazu můžete poskytnout seznam funkcí, pro které může model generovat vstupy JSON. Podporuje se maximálně 128 funkcí.	Ne
top_p	číslo	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme tuto změnu změnit, temperature ale ne obojí.	Ne
využití	Využití		Ne

Metoda pod dohledem

Metoda používaná k jemnému ladění pod dohledem

Název	Typ	Popis	Povinné	Výchozí
typ	FineTuningMethodType		Ano

Pod dohledemMethodRequest

Metoda používaná k jemnému ladění pod dohledem

Název	Typ	Popis	Povinné	Výchozí
typ	FineTuningMethodType		Ano

SystemComputeDatasource

Rozlišovač pro SystemComputeDatasource

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
laskavý	TypZdrojDatVýpočetníhoSystému	Typ zdroje dat.	Ano

TypDatovéhoZdrojeSystémuVýpočtů

Typ zdroje dat.

Vlastnictví	Hodnota
Popis	Typ zdroje dat.
Typ	řetězec
Hodnoty	Storage Urls

Systémový výpočetní úložný prostor

Účet úložiště

Název	Typ	Popis	Povinné	Výchozí
Dělení na části	BlokingSettings	Nastavení bloků dat	Ne
připojení	BaseConnection	Připojení k prostředku.	Ne
názevKontejneru	řetězec	název kontejneru	Ne
embedování	pole		Ne
laskavý	TypZdrojDatVýpočetníhoSystému	Typ zdroje dat.	Ano

AdresaVýpočtovéhoSystému

Adresy URL

Název	Typ	Popis	Povinné	Výchozí
Dělení na části	BlokingSettings	Nastavení bloků dat	Ne
připojení	BaseConnection	Připojení k prostředku.	Ne
názevKontejneru	řetězec	název kontejneru	Ne
plazení	CrawlingSettings	Nastavení procházení	Ne
embedování	pole		Ne
laskavý	TypZdrojDatVýpočetníhoSystému	Typ zdroje dat.	Ano
adresy URL	pole		Ne

Cílový index

Informace o indexu, který se má vytvořit.

Diskriminátor pro TargetIndex

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
laskavý	CílovýTyp	Typ cíle.	Ano

Typ cíle

Typ cíle.

Vlastnictví	Hodnota
Popis	Typ cíle.
Typ	řetězec
Hodnoty	AzureAISearch CosmosDB Pinecone

Nástroj

Název	Typ	Popis	Povinné	Výchozí
funkce	FunctionDefinition		Ne
typ	řetězec	Typ volání nástroje. Toto bude vždy function pro tento typ volání nástroje.	Ne

ToolCall

Název	Typ	Popis	Povinné	Výchozí
funkce	FunctionCallFunction		Ne
identifikační číslo	řetězec	ID volání nástroje.	Ne
typ	řetězec	Typ volání nástroje vyžaduje výstup. Prozatím je to vždy function.	Ne

Type Nábídka

Definuje typ objektu.

Vlastnictví	Hodnota
Popis	Definuje typ objektu.
Typ	řetězec
Hodnoty	list fine_tuning.job file fine_tuning.job.event fine_tuning.job.checkpoint model upload upload.part batch wandb

AktualizovatŽádostOuloženéDokončení

Název	Typ	Popis	Povinné	Výchozí
metadatové informace	objekt	Další informace potřebujete pomocí libovolných párů klíč-hodnota.	Ne

UploadFileCompleteBody

Název	Typ	Popis	Povinné	Výchozí
md5	řetězec		Ne
part_ids (identifikátory dílů)	pole		Ano

UploadFileStartBody

Název	Typ	Popis	Povinné	Výchozí
bajtů	celočíselný		Ano
jméno souboru	řetězec		Ano
Typ MIME	řetězec		Ano
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ano

UploadPartResource

Název	Typ	Popis	Povinné	Výchozí
azure_block_id	řetězec		Ne
datum_vytvoření	celočíselný	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)	Ne
identifikační číslo	řetězec	Identita této položky.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
upload_id	řetězec		Ne

UploadResource

Název	Typ	Popis	Povinné	Výchozí
bajtů	celočíselný		Ne
datum_vytvoření	celočíselný	Časové razítko při vytvoření této úlohy nebo položky (v epochách unixu)	Ne
datum vypršení	celočíselný		Ne
soubor	soubor	Soubor je dokument použitelný pro trénování a ověřování. Může to být také dokument vygenerovaný službou s podrobnostmi o výsledku.	Ne
jméno souboru	řetězec		Ne
identifikační číslo	řetězec	Identita této položky.	Ne
objekt	Typový diferenciátor	Definuje typ objektu.	Ne
účel	Účel	Zamýšlený účel nahraných dokumentů. K jemnému ladění použijte "jemné ladění". To nám umožňuje ověřit formát nahraného souboru.	Ne
stav	UploadStatus		Ne

Stav nahrávání

Vlastnictví	Hodnota
Typ	řetězec
Hodnoty	pending expired completed cancelled

Použití

Název	Typ	Popis	Povinné	Výchozí
dokončovací tokens	celočíselný	Počet tokenů ve vygenerovaném dokončení	Ne
tokeny výzvy	celočíselný	Počet tokenů v příkazovém řádku	Ne
celkový počet tokenů	celočíselný	Celkový počettokench	Ne

Uživatelský výpočetní datový soubor

Účet úložiště

Název	Typ	Popis	Povinné	Výchozí
Dělení na části	BlokingSettings	Nastavení bloků dat	Ne
datasetId	řetězec		Ne
Typ datové sady	řetězec		Ne
embedování	pole		Ne
laskavý	TypUživatelskéhoVýpočetníhoDatovéhoZdroje	Typ zdroje dat.	Ano

UserComputeDatasource

Diskriminátor pro UserComputeDatasource

Tato komponenta používá vlastnost kind k rozlišování mezi různými typy:

Hodnota typu	Schéma

Název	Typ	Popis	Povinné	Výchozí
laskavý	UserComputeDatasourceType	Typ zdroje dat.	Ano

UserComputeDatasourceType

Typ zdroje dat.

Vlastnictví	Hodnota
Popis	Typ zdroje dat.
Typ	řetězec
Hodnoty	Dataset Urls

UserComputeUrl

Adresy URL

Název	Typ	Popis	Povinné	Výchozí
Dělení na části	BlokingSettings	Nastavení bloků dat	Ne
plazení	CrawlingSettings	Nastavení procházení	Ne
embedování	pole		Ne
laskavý	UserComputeDatasourceType	Typ zdroje dat.	Ano
adresy URL	pole		Ne

Žádost o integraci WandB

Název	Typ	Popis	Povinné	Výchozí
entita	řetězec		Ne
název	řetězec		Ne
projekt	řetězec		Ano
štítky	pole		Ne

WandBIntegrationRequestWrapper

Název	Typ	Popis	Povinné	Výchozí
typ	IntegrationTypes	Seznam dostupných integrací s jemným laděním	Ano
wandb	WandBIntegrationRequest		Ano

WorkspaceConnection

Připojení pracovního prostoru AML

Název	Typ	Popis	Povinné	Výchozí
connectionId	řetězec	ConnectionId	Ne
laskavý	TypPřipojení	Typ připojení.	Ano

NastaveníVkládáníPřipojeníPracovníhoProstoru

ID připojení k modelu vkládání

Název	Typ	Popis	Povinné	Výchozí
connectionId	řetězec		Ne
názevNasazení	řetězec		Ne
název modelu	řetězec		Ne

Další kroky

Seznamte se s modely a vyladěním pomocí rozhraní REST API. Zjistěte více o základních modelech, které pohánějí Azure OpenAI.