Azure OpenAI i Azure AI Foundry Models authoring REST API preview reference

Den här artikeln innehåller information om rest-API-slutpunkterna för inferens för Azure OpenAI.

API-specifikationer

Hantering och interaktion med Azure OpenAI-modeller och resurser är uppdelade på tre primära API-ytor:

• Kontrollplan
• Dataplan – redigering
• Dataplan – slutsatsdragning

Varje API-yta/specifikation kapslar in en annan uppsättning Azure OpenAI-funktioner. Varje API har en egen unik uppsättning förhandsversioner och stabila/allmänt tillgängliga API-versioner (GA). Förhandsversioner tenderar för närvarande att följa en månatlig takt.

Viktigt!

Det finns ett nytt API för förhandsvisningsprognos nu. Läs mer i vår livscykelguide för API.

API (gränssnitt för programmering av applikationer)	Senaste förhandsversion	Senaste GA-versionen	Specifikationer	Beskrivning
Kontrollplan	2024-06-01-preview	2024-10-01	Spec-filer	Azure OpenAI delar ett gemensamt kontrollplan med alla andra tjänster. Kontrollplans-API:et används för saker som att skapa Azure OpenAI-resurser, modelldistribution och andra resurshanteringsuppgifter på högre nivå. Kontrollplanet styr också vad som är möjligt att göra med funktioner som Azure Resource Manager, Bicep, Terraform och Azure CLI.
Dataplan – redigering	2025-04-01-preview	2024-10-21	Spec-filer	API:et för redigering av dataplanet styr finjustering, filuppladdning, inmatningsjobb, batchfrågor och vissa frågor på modellnivå
Dataplan – slutsatsdragning	2025-04-01-preview	2024-10-21	Spec-filer	API:et för dataplansinferens ger slutsatsdragningsfunktioner/slutpunkter för funktioner som slutföranden, chattavslut, inbäddningar, ljud, på dina data, Dall-e, assistenter osv.

Autentisering

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

• API-nyckelautentisering: För den här typen av autentisering måste alla API-begäranden innehålla API-nyckeln i api-key HTTP-huvudet. Snabbstarten innehåller vägledning för hur du gör anrop med den här typen av autentisering.

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

REST API-versionshantering

Tjänst-API:erna versionshanteras med frågeparametern api-version. Alla versioner följer datumstrukturen ÅÅÅÅÅ-MM-DD. Till exempel:

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

Redigering av dataplan

Resten av artikeln beskriver den senaste förhandsversionen av inferensspecifikationen för Azure OpenAI-dataplanet, 2025-04-01-preview.

Om du letar efter dokumentation om den senaste GA API-versionen läser du det senaste API:et för ga-dataplansinferens

Batch – Lista

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

Hämtar en lista över alla batchar som ägs av Azure OpenAI-resursen.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
efter	förfrågan	Nej	snöre	Identifierare för den senaste händelsen från föregående sidnumreringsbegäran.
gräns	förfrågan	Nej	integer	Antal batchar som ska hämtas. Standardinställningen är 20.
$filter	förfrågan	Nej	snöre	OData-uttrycket för att beskriva filtreringsvillkoren.
$orderby	förfrågan	Nej	snöre	OData-uttrycket för att beskriva sorteringsordningen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	BatchesList

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Batch – Skapa

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

Skapar och kör en batch från en uppladdad fil med begäranden.

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

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Namn	Typ	Beskrivning	Krävs	Förinställning
slutförandefönster	snöre	Den tidsram inom vilken batchen ska bearbetas.	Ja
Slutpunkt	snöre	API-slutpunkten som används av batchen.	Ja
input_blob	snöre	URL:en för en Azure Storage-blob som ska användas som indata för batchen.	Nej
input_file_id	snöre	ID för indatafilen för batchen.	Nej
metainformation	objekt	En uppsättning nyckel/värde-par som kan kopplas till batchen. Detta kan vara användbart för att lagra ytterligare information om batchen i ett strukturerat format.	Nej
utgången förfaller efter	FileExpiresAfter	Definierar en förfallotid för filen.	Nej
utmatningsmapp	BatchOutputReference	Azure Storage-mappen som ska lagra utdata.	Nej

Svaren

Statuskod: 201

Beskrivning: Batchen har skapats framgångsrikt.

Innehållstyp	Typ	Beskrivning
application/json	Batch

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 201

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

Batch – Hämta

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

Hämtar information om en enskild batch som anges av det angivna batch-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
batch-id	väg	Ja	snöre	Identifieraren för batchen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	Batch

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Batch – Avbryt

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

Avbryter bearbetningen av batchen som anges av det angivna batch-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
batch-id	väg	Ja	snöre	Identifieraren för batchen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Batchen har avbrutits.

Innehållstyp	Typ	Beskrivning
application/json	Batch

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Lagrat slutförande – lista

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

Hämtar en lista över lagrade slutföranden.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
metainformation	förfrågan	Nej	snöre	Filtrera efter paret (nyckel, värde) i lagrad slutförande.
modell	förfrågan	Nej	snöre	Filtrera efter modellnamn.
efter	förfrågan	Nej	snöre	Identifierare för den senaste lagrade slutförandet från föregående sidnumreringsbegäran.
gräns	förfrågan	Nej	integer	Antal lagrade slutföranden som ska hämtas. Standardinställningen är 20.
beställning	förfrågan	Nej	snöre	Resultatordning efter skapad tid (stigande eller fallande). Standardvärdet är desc.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	SparadSlutförandelista

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Lagrad slutförande – Hämta

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

Hämtar lagrat slutförande av det angivna lagrade slutförande-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
lagrad-kompletterings-id	väg	Ja	snöre	Identifieraren för det lagrade slutförandet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	StoredCompletionResponse

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Lagrad slutförande – Uppdatering

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

Uppdatera lagrad slutförande av det angivna lagrade slutförande-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
lagrad-kompletterings-id	väg	Ja	snöre	Identifieraren för det lagrade slutförandet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Namn	Typ	Beskrivning	Krävs	Förinställning
metainformation	objekt	Godtyckliga nyckel/värde-par för ytterligare information.	Nej

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	StoredCompletion

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Lagrat fullbordande – Ta bort

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

Ta bort lagrat slutförande av det angivna lagrade slutförande-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
lagrad-kompletterings-id	väg	Ja	snöre	Identifieraren för det lagrade slutförandet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Det lagrade slutresultatet har tagits bort.

Innehållstyp	Typ	Beskrivning
application/json	StoredCompletionDelete

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Lagrad slutföring – Hämta meddelanden

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

Hämtar lagrade slutförandemeddelanden med det angivna lagrade slutförande-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
lagrad-kompletterings-id	väg	Ja	snöre	Identifieraren för det lagrade slutförandet.
efter	förfrågan	Nej	snöre	Identifierare för det senast lagrade slutförandemeddelandet från föregående sidnumreringsbegäran.
gräns	förfrågan	Nej	integer	Antal lagrade slutförandemeddelanden som ska hämtas. Standardinställningen är 20.
beställning	förfrågan	Nej	snöre	Resultatordning efter meddelandeindex (stigande eller fallande). Standardvärdet är asc.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	SparadeKompletteringsmeddelanden

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Utvärdering – Hämta lista

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

Lista utvärderingar för ett projekt.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
efter	förfrågan	Nej	snöre	Identifierare för den senaste utvärderingen från föregående begäran om sidnumrering.
gräns	förfrågan	Nej	integer	Antal eval som ska hämtas.
beställning	förfrågan	Nej	snöre Möjliga värden: asc, desc	Sorteringsordningen för utvärderingar efter tidsstämpel. Använd asc för stigande ordning eller desc för fallande ordning.
sortera_efter	förfrågan	Nej	snöre Möjliga värden: created_at, updated_at	Evals kan ordnas efter skapandetid eller senast uppdaterad tid. Använd created_at för att skapa tid eller updated_at för senast uppdaterad tid.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: En lista med utvärderingar

Innehållstyp	Typ	Beskrivning
application/json	EvalList

Exempel

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

Svar: Statuskod: 200

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

Utvärdering – Skapa

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

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 201

Beskrivning: OK

Innehållstyp	Typ	Beskrivning
application/json	Eval

Exempel

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

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

Svar: Statuskod: 201

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

Utvärdering – Ta bort

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

Ta bort en utvärdering.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som ska tas bort.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Utvärderingen har tagits bort.

Innehållstyp	Typ	Beskrivning
application/json	objekt

Statuskod: 404

Beskrivning: Det gick inte att hitta utvärderingen.

Innehållstyp	Typ	Beskrivning
application/json	Fel

Exempel

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

Svar: Statuskod: 200

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

Statuskod: 404

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

Utvärdering – Hämta

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

Få en utvärdering baserat på ID.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som ska hämtas.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Utvärderingen

Innehållstyp	Typ	Beskrivning
application/json	Eval

Exempel

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

Svar: Statuskod: 200

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

Utvärdering – Uppdatera

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

Uppdatera vissa egenskaper för en utvärdering.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som ska uppdateras.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Den uppdaterade utvärderingen

Innehållstyp	Typ	Beskrivning
application/json	Eval

Exempel

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

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

Svar: Statuskod: 200

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

Utvärdering – Getrunlist

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

Hämta en lista över körningar för en utvärdering.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som ska hämtas för.
efter	förfrågan	Nej	snöre	Identifier för den senaste sökningen från föregående pagineringsbegäran.
gräns	förfrågan	Nej	integer	Antal körningar som ska hämtas.
beställning	förfrågan	Nej	snöre Möjliga värden: asc, desc	Sorteringsordning för exekveringar efter tidsstämpel. Använd asc för stigande ordning eller desc för fallande ordning. Standardinställningen är asc.
tillstånd	förfrågan	Nej	snöre Möjliga värden: queued, in_progress, completed, , canceledfailed	Filtrera körningar efter status. Använd "köad", "pågående", "misslyckades", "slutförd", "avbruten".
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

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

Innehållstyp	Typ	Beskrivning
application/json	EvalRunList

Exempel

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

Svar: Statuskod: 200

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

Utvärdering – Skapa körning

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

Skapa en ny utvärderingskörning. Det här är slutpunkten som startar klassificeringen.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som du vill skapa en körning för.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 201

Beskrivning: En körning har framgångsrikt skapats för utvärderingen

Innehållstyp	Typ	Beskrivning
application/json	EvalRun

Statuskod: 400

Beskrivning: Felaktig begäran (till exempel eval-objekt saknas)

Innehållstyp	Typ	Beskrivning
application/json	Fel

Exempel

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

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

Svar: Statuskod: 201

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

Utvärdering – Ta bort körning

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

Ta bort en utvärderingskörning.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som körningen ska tas bort från.
run-id	väg	Ja	snöre	ID för den körning som ska tas bort.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Eval-körningen har på ett framgångsrikt sätt tagits bort

Innehållstyp	Typ	Beskrivning
application/json	objekt

Statuskod: 404

Beskrivning: Det går inte att hitta körningen

Innehållstyp	Typ	Beskrivning
application/json	Fel

Exempel

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

Svar: Statuskod: 200

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

Statuskod: 404

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

Utvärdering – Utför körning

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

Hämta en utvärdering med hjälp av ID.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som ska hämtas för.
run-id	väg	Ja	snöre	ID:t för körningen som ska hämtas.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Utvärderingskörningen

Innehållstyp	Typ	Beskrivning
application/json	EvalRun

Exempel

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

Svar: Statuskod: 200

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

Utvärdering – Avbryt körning

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

Avbryt en pågående utvärderingskörning.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för den utvärdering vars körning du vill avbryta.
run-id	väg	Ja	snöre	ID för körningen som ska avbrytas.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Det avbrutna eval-körningsobjektet

Innehållstyp	Typ	Beskrivning
application/json	EvalRun

Exempel

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

Svar: Statuskod: 200

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

Utvärdering – Getrunoutputitems

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

Hämta en lista över resultat för en utvärdering.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som ska hämtas för.
run-id	väg	Ja	snöre	ID för körningen för att hämta utdataobjekt för.
efter	förfrågan	Nej	snöre	Identifierare för det sista utdataobjektet från föregående sidnumreringsbegäran.
gräns	förfrågan	Nej	integer	Antal utdataobjekt som ska hämtas.
tillstånd	förfrågan	Nej	snöre Möjliga värden: fail, pass	Filtrera utdataobjekt efter status. Använd failed för att filtrera efter misslyckade utdataobjekt eller pass filtrera efter skickade utdataobjekt.
beställning	förfrågan	Nej	snöre Möjliga värden: asc, desc	Sorteringsordning för utdataobjekt efter tidsstämpel. Använd asc för stigande ordning eller desc för fallande ordning. Standardinställningen är asc.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

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

Innehållstyp	Typ	Beskrivning
application/json	EvalRunOutputItemList

Exempel

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

Svar: Statuskod: 200

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

Utvärdering – Getrunoutputitem

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

Hämta ett resultatobjekt för utvärderingskörning med ID.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
eval-ID	väg	Ja	snöre	ID:t för utvärderingen som ska hämtas för.
run-id	väg	Ja	snöre	ID:t för körningen som ska hämtas.
utdataartikel-id	väg	Ja	snöre	ID:t för utdataobjektet som ska hämtas.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Utdataobjektet för utvärderingskörningen

Innehållstyp	Typ	Beskrivning
application/json	EvalRunOutputItem

Exempel

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

Svar: Statuskod: 200

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

Filer – översikt

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

Hämtar en lista över alla filer som ägs av Azure OpenAI-resursen.

Dessa inkluderar användaruppladdat innehåll som filer med syftet "finjustera" för träning eller validering av finjusterande modeller samt filer som genereras av tjänsten, till exempel "finjustera resultat" som innehåller olika mått för motsvarande finjusteringsjobb.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
avsikt	förfrågan	Nej	snöre Möjliga värden: fine-tune, fine-tune-results, assistants, assistants_output, batch, batch_output, , , evalsevals_output	Returnera endast filer med det angivna syftet.
gräns	förfrågan	Nej	integer	En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 10 000 och standardvärdet är 10 000.
after	förfrågan	Nej	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt, som slutar med obj_foo, kan ditt efterföljande anrop inkludera after=obj_foo för att hämta nästa sida i listan.
beställning	förfrågan	Nej	snöre	Sortera ordning efter objektens created_at tidsstämpel. asc för stigande ordning och desc för fallande ordning.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	Fillista

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Filer – Ladda upp

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

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: flera delar/formulärdata

Namn	Typ	Beskrivning	Krävs	Förinställning
ankare	snöre	Definierar fästpunkten i förhållande till vilken tid den absoluta förfallotiden ska genereras från.	Nej
Sekunder	integer	Hämtar den relativa förfallotiden i sekunder.
Intervall: [1209600 - 2592000].	Nej
fil	snöre	Hämtar eller ställer in filen som ska laddas upp till Azure OpenAI.	Ja
avsikt	snöre	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

Svaren

Statuskod: 201

Beskrivning: Filen har skapats.

Innehållstyp	Typ	Beskrivning
application/json	Arkiv

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 201

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

Filer – Importera

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

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Namn	Typ	Beskrivning	Krävs	Förinställning
content_url	snöre	Url:en som dokumentet ska laddas ned från (kan vara SAS-URL för en blob eller någon annan extern URL som är tillgänglig med en GET-begäran).	Ja
går ut efter	FileExpiresAfter	Definierar en förfallotid för filen.	Nej
filnamn	snöre	Namnet på JSON Lines-filen som ska laddas upp.
Om purpose är inställt på "finjustera" är varje rad en JSON-post med fälten "prompt" och "completion" som representerar dina träningsexempel.	Ja
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

Svaren

Statuskod: 201

Beskrivning: Filen har skapats.

Innehållstyp	Typ	Beskrivning
application/json	Arkiv

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 201

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

Filer – Hämta

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

Hämtar information om en enskild fil som anges av det angivna fil-ID:t, inklusive status, storlek, syfte osv.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
fil-id	väg	Ja	snöre	Identifieraren för filen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	Arkiv

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Filer – Ta bort

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

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

Borttagning tillåts också om en fil användes, t.ex. som träningsfil i ett finjusteringsjobb.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
fil-id	väg	Ja	snöre	Identifieraren för filen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Filen har tagits bort.

Innehållstyp	Typ	Beskrivning
application/json	FileDelete

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Filer – Hämta innehåll

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

Hämtar innehållet i filen som anges av det angivna fil-ID:t.

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
fil-id	väg	Ja	snöre	Identifieraren för filen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/octet-stream	snöre
application/json	snöre

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/octet-stream	ErrorResponse (Fel Svar)
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Anpassning – lista

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

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

Händelser skapas när jobbstatusen ändras. Du kan till exempel köra eller slutföra och när resultaten laddas upp.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
efter	förfrågan	Nej	snöre	Identifierare för den senaste händelsen från föregående sidnumreringsbegäran.
gräns	förfrågan	Nej	integer	Antal händelser som ska hämtas. Standardinställningen är 20.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	FineTuningJobList

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Finjustering – Skapa

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

Skapar ett jobb som finjusterar en angiven modell från en viss träningsfil.

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

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Namn	Typ	Beskrivning	Krävs	Förinställning
hyperparametrar	FineTuningHyperParameters	Hyperparameterinställningarna som används i ett finjusterat jobb.	Nej
Integrationer	array	En lista över konfigurationer för integreringar som stöder finjusteringsjobbet. Det finns många planerade integreringar, så se till att kontrollera och agera på integrationstypen.	Nej
metod	objekt	Metod som används för övervakad finjustering	Nej
└– typ	Finjusteringsmetodtyp		Nej
modell	snöre	Identifieraren (modell-ID) för basmodellen som används för den här finjusteraren.	Ja
frö	integer	Det frö som används för finjusteringsjobbet. Att skicka in samma parametrar för start- och jobb bör ge samma resultat, men kan skilja sig i sällsynta fall. Om ett frö inte har angetts genereras ett för dig.	Nej
suffix	snöre	Suffixet som används för att identifiera den finjusterade modellen. Suffixet kan innehålla upp till 40 tecken (a-z, A-Z, 0-9 och _) som läggs till i ditt finjusterade modellnamn.	Nej
utbildningsfil	snöre	Den filidentitet (fil-ID) som används för att träna den här finjusterade modellen.	Ja
validation_file	snöre	Den filidentitet (fil-ID) som används för att utvärdera den finjusterade modellen under träningen.	Nej

Svaren

Statuskod: 201

Beskrivning: Finjusteringen har skapats framgångsrikt.

Innehållstyp	Typ	Beskrivning
application/json	FineTuningJob

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 201

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

Finjustering – Hämta

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

Hämtar information om ett enda finjusteringsjobb som anges av det angivna finjusterings-ID:t.

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

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
finjusteringsjobb-id	väg	Ja	snöre	Identifieraren för finjusteringsjobbet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	FineTuningJob

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Finjustering – Ta bort

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

Tar bort det finjusteringsjobb som anges av det angivna finjusterings-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
finjusteringsjobb-id	väg	Ja	snöre	Identifieraren för finjusteringsjobbet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 204

Beskrivning: Finjusteringen har tagits bort.

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 204

{
  "headers": {}
}

Finjustering – Avbryt

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

Avbryter bearbetningen av den finjusteringsuppgift som anges av den angivna identifieraren för finjustering.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
finjusteringsjobb-id	väg	Ja	snöre	Identifieraren för finjusteringsjobbet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Finjusteringen har avbrutits

Innehållstyp	Typ	Beskrivning
application/json	FineTuningJob

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Finjustering – Hämta kontrollpunkter

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

Hämtar kontrollpunkterna för det finjusteringsjobb som anges av det angivna finjusterings-ID:t.

Kontrollpunkter skapas i slutet av lyckade epoker under träningen.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
finjusteringsjobb-id	väg	Ja	snöre	Identifieraren för finjusteringsjobbet.
efter	förfrågan	Nej	snöre	Identifierare för det senaste kontrollpunkts-ID:t från föregående sidnumreringsbegäran.
gräns	förfrågan	Nej	integer	Antal kontrollpunkter som ska hämtas. Standardvärdet är 10.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	FineTuningJobCheckpointList

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Justera inställningar – Hämta händelser

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

Hämtar händelserna för det finjusteringsjobb som anges av den angivna finjusteringsidentifieraren.

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
finjusteringsjobb-id	väg	Ja	snöre	Identifieraren för finjusteringsjobbet.
efter	förfrågan	Nej	snöre	Identifierare för den senaste händelsen från föregående sidnumreringsbegäran.
gräns	förfrågan	Nej	integer	Antal händelser som ska hämtas. Standardinställningen är 20.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	Lista över finjusteringsjobbshändelser

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Finjustering – Pausa

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

Pausar bearbetningen av finjusteringsjobbet som specificerats av det angivna finjusterings-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
finjusteringsjobb-id	väg	Ja	snöre	Identifieraren för finjusteringsjobbet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Finjusteringen har framgångsrikt pausats.

Innehållstyp	Typ	Beskrivning
application/json	FineTuningJob

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Finjustering – Återuppta

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

Återupptar bearbetningen av det finjusteringsjobb som anges av det angivna finjusterings-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
finjusteringsjobb-id	väg	Ja	snöre	Identifieraren för finjusteringsjobbet.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Finjusteringen har återupptagits.

Innehållstyp	Typ	Beskrivning
application/json	FineTuningJob

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Inmatningsjobb – lista

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

Visar en lista över inmatningsjobben.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.
mgmt-användartoken	rubrik	Nej	snöre	Den token som används för att komma åt arbetsytan (behövs endast för användarberäkningsjobb).

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	IngestionJobList

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Inmatningsjobb – Skapa

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

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.
jobb-ID	väg	Ja	snöre	ID:t för jobbet som ska skapas.
mgmt-användartoken	rubrik	Nej	snöre	Den token som används för att komma åt arbetsytan (behövs endast för användarberäkningsjobb).
aml-användartoken	rubrik	Nej	snöre	Den token som används för att komma åt resurserna i jobbet på arbetsytan (behövs endast för användarberäkningsjobb).

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Namn	Typ	Beskrivning	Krävs	Förinställning
jobId	snöre		Nej
typ	TypAvInmatningsjobb	Jobbtypen.	Ja

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	IngestionJob

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

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

Svar: Statuskod: 200

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

Inmatningsjobb – Hämta

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

Hämtar information om det angivna jobb-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.
jobb-ID	väg	Ja	snöre	Jobbets ID.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	IngestionJob

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Ingestionjobruns – lista

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

Visar en lista över körningarna av det angivna jobb-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.
jobb-ID	väg	Ja	snöre	Jobbets ID.
mgmt-användartoken	rubrik	Nej	snöre	Den token som används för att komma åt arbetsytan (behövs endast för användarberäkningsjobb).

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	IngestionJobRunList

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Ingestionjobruns – Hämta

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

Hämtar information om det angivna körnings-ID:t som en del av det angivna jobb-ID:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.
jobb-ID	väg	Ja	snöre	Jobbets ID.
run-id	väg	Ja	snöre	Körningens ID.
mgmt-användartoken	rubrik	Nej	snöre	Den token som används för att komma åt arbetsytan (behövs endast för användarberäkningsjobb).

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	IngestionJobRun

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Modeller – lista

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

Hämtar en lista över alla modeller som är tillgängliga för Azure OpenAI-resursen.

Dessa inkluderar basmodeller och alla lyckade finjusterade modeller som ägs av Azure OpenAI-resursen.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	Modelllista

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Modeller – Hämta

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

Hämtar information om den modell som anges av det angivna modelId:t.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
modell-ID	väg	Ja	snöre	Modellens identifierare.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	Modell

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

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

Svar: Statuskod: 200

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

Ladda upp fil – Starta

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

Ett mellanliggande uppladdningsobjekt skapas så att du kan lägga till delar i det. För närvarande kan en uppladdningsstorlek vara högst 9 GB totalt och upphör att gälla två timmar efter att den har skapats.

När uppladdningen är klar genereras ett filobjekt som innehåller alla uppladdade delar. Det här filobjektet kan sedan användas på vår plattform precis som andra filer.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Namn	Typ	Beskrivning	Krävs	Förinställning
byte	integer		Ja
filnamn	snöre		Ja
MIME-typ	snöre		Ja
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

Begärandekropp

Innehållstyp: text/json

Namn	Typ	Beskrivning	Krävs	Förinställning
byte	integer		Ja
filnamn	snöre		Ja
MIME-typ	snöre		Ja
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

Begärandekropp

Innehållstyp: program/*+json

Namn	Typ	Beskrivning	Krävs	Förinställning
byte	integer		Ja
filnamn	snöre		Ja
MIME-typ	snöre		Ja
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

Svaren

Statuskod: 200

Beskrivning: Uppladdningen har skapats.

Innehållstyp	Typ	Beskrivning
application/json	UploadResource

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

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

Svar: Statuskod: 200

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

Ladda upp fil – Avbryt

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

Avbryter uppladdningen och leder till att alla uppladdade delar tas bort asynkront.

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
uppladdnings-ID	väg	Ja	snöre	Identifieraren för uppladdningen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	UploadResource

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Ladda upp fil – slutförd

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

Detta slutför uppladdningen och det returnerade uppladdningsobjektet innehåller ett kapslat filobjekt som är redo att användas över hela plattformen.

Du kan definiera ordningen på delarna genom att ange en ordnad lista över del-ID:t.

Det totala antalet uppladdade byte måste matcha den storlek som ursprungligen angavs när objektet Överför skapades.

Efter den här åtgärden kan inga ytterligare delar läggas till när uppladdningen har slutförts.

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
uppladdnings-ID	väg	Ja	snöre	Identifieraren för uppladdningen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: program/json

Namn	Typ	Beskrivning	Krävs	Förinställning
md5	snöre		Nej
part_ids	array		Ja

Begärandekropp

Innehållstyp: text/json

Namn	Typ	Beskrivning	Krävs	Förinställning
md5	snöre		Nej
part_ids	array		Ja

Begärandekropp

Innehållstyp: program/*+json

Namn	Typ	Beskrivning	Krävs	Förinställning
md5	snöre		Nej
part_ids	array		Ja

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	UploadResource

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

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

Svar: Statuskod: 200

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

Ladda upp fil – del

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

Lägger till en del i ett uppladdningsobjekt, där varje del representerar ett segment av filen som du laddar upp.

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

URI parametrar

Namn	I	Krävs	Typ	Beskrivning
Slutpunkt	väg	Ja	snöre URL	Azure OpenAI-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://aoairesource.openai.azure.com. Ersätt "aoairesource" med ditt Azure OpenAI-resursnamn). https://{your-resource-name}.openai.azure.com
uppladdnings-ID	väg	Ja	snöre	Identifieraren för uppladdningen.
API-version	förfrågan	Ja	snöre	Den begärda API-versionen.

Begärandehuvud

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

Namn	Krävs	Typ	Beskrivning
Auktorisering	Sann	snöre	Exempel:Authorization: Bearer {Azure_OpenAI_Auth_Token} Så här genererar du en autentiseringstoken med Hjälp av Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Typ: oauth2 Auktoriserings-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize omfattning: https://cognitiveservices.azure.com/.default
API-nyckel	Sann	snöre	Ange Azure OpenAI API-nyckel här

Begärandekropp

Innehållstyp: flera delar/formulärdata

Namn	Typ	Beskrivning	Krävs	Förinställning
data	snöre		Ja

Svaren

Statuskod: 200

Beskrivning: Lyckades

Innehållstyp	Typ	Beskrivning
application/json	UploadPartResource

Statuskod: standard

Beskrivning: Ett fel uppstod.

Innehållstyp	Typ	Beskrivning
application/json	ErrorResponse (Fel Svar)

Exempel

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

Svar: Statuskod: 200

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

Komponenter

AzureAISearchIndex

Azure AI Search Index.

Namn	Typ	Beskrivning	Krävs	Förinställning
connectionId	snöre	ID:t för anslutningen som pekar på Azure AI Search Index.	Nej
typ	MålTyp	Måltypen.	Ja

BaseConnection

En anslutning till en resurs.

Diskriminerande för BaseConnection

Den här komponenten använder egenskapen kind för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	Typ av anslutning	Anslutningstypen.	Ja

Omgång

Definierar värdena för en batch.

Namn	Typ	Beskrivning	Krävs	Förinställning
avbruten_vid	integer	En tidsstämpel när den här batchen avbröts (i unix-epoker).	Nej
avbokning_vid	integer	En tidsstämpel när den här batchen började avbrytas (i unix-epoker).	Nej
klarad_vid	integer	En tidsstämpel när den här batchen slutfördes (i unix-epoker).	Nej
slutförandefönster	snöre	Den tidsram inom vilken batchen ska bearbetas.	Nej
skapad_tid	integer	En tidsstämpel när den här batchen skapades (i unix-epoker).	Nej
Slutpunkt	snöre	API-slutpunkten som används av batchen.	Nej
error_blob	snöre	Blob-URL:en som innehåller utdata från begäranden med fel.	Nej
error_file_id	snöre	ID:t för filen som innehåller utdata från begäranden med fel.	Nej
Felaktigheter	BatchErrors	För batchar som har misslyckats innehåller detta mer information om orsaken till felen.	Nej
utgången_till	integer	En tidsstämpel när den här batchen upphörde att gälla (i unix-epoker).	Nej
utgår_den	integer	En tidsstämpel när den här batchen upphör att gälla (i unix-epoker).	Nej
misslyckades_vid	integer	En tidsstämpel när den här batchen misslyckades (i unix-epoker).	Nej
slutförande_vid	integer	En tidsstämpel när den här batchen började slutföras (i unix-epoker).	Nej
Id-nummer	snöre	Identiteten för det här objektet.	Ja
i_gång_vid	integer	En tidsstämpel när denna batch började bearbetas (i unix-epoker).	Nej
input_blob	snöre	Blob-URL:en som innehåller indatafilen för batchen.	Nej
input_file_id	snöre	ID för indatafilen för batchen.	Ja
metainformation	objekt	En uppsättning nyckel/värde-par som kan kopplas till batchen. Detta kan vara användbart för att lagra ytterligare information om batchen i ett strukturerat format.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
output_blob	snöre	Blob-URL som innehåller utdata från framgångsrikt utförda begäranden.	Nej
output_file_id	snöre	ID:t för filen som innehåller utdata från begäranden som har körts.	Nej
begäran_antal	BatchRequestCounts	Begäran räknas för olika statusar i batchen.	Nej
tillstånd	BatchStatus	Status för en batch.	Nej

Batchcreatebegäran

Definierar begäran om att skapa en batch.

Namn	Typ	Beskrivning	Krävs	Förinställning
slutförandefönster	snöre	Den tidsram inom vilken batchen ska bearbetas.	Ja
Slutpunkt	snöre	API-slutpunkten som används av batchen.	Ja
input_blob	snöre	URL:en för en Azure Storage-blob som ska användas som indata för batchen.	Nej
input_file_id	snöre	ID för indatafilen för batchen.	Nej
metainformation	objekt	En uppsättning nyckel/värde-par som kan kopplas till batchen. Detta kan vara användbart för att lagra ytterligare information om batchen i ett strukturerat format.	Nej
utgången förfaller efter	FileExpiresAfter	Definierar en förfallotid för filen.	Nej
utmatningsmapp	BatchOutputReference	Azure Storage-mappen som ska lagra utdata.	Nej

BatchErrorData

Felinformation för ett fel i batchen.

Namn	Typ	Beskrivning	Krävs	Förinställning
kod	snöre	En felkod som identifierar feltypen.	Nej
linje	snöre	Radnumret för indatafilen där felet inträffade, om tillämpligt (kan vara null).	Nej
meddelande	snöre	Ett meddelande som kan läsas av människor med mer information om felet.	Nej
Param	snöre	Namnet på parametern som orsakade felet, om tillämpligt (kan vara null).	Nej

BatchErrors

För batchar som har misslyckats innehåller detta mer information om orsaken till felen.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	BatchErrorData	Felinformation för ett fel i batchen.	Nej
objekt	snöre	Typ av felobjekt. Det här är alltid "lista".	Nej

Batchförfrågningsantal

Begäran räknas för olika statusar i batchen.

Namn	Typ	Beskrivning	Krävs	Förinställning
slutförd	integer	Antalet begäranden i batchen som har slutförts.	Nej
Misslyckades	integer	Antalet begäranden i batchen som har misslyckats.	Nej
summa	integer	Det totala antalet begäranden i batchen.	Nej

BatchOutputReference

Azure Storage-mappen som ska lagra utdata.

Namn	Typ	Beskrivning	Krävs	Förinställning
avgränsare	snöre	Valfritt. Avgränsaren som används i mappsökvägen är som standard /.	Nej
URL	snöre	URL:en för den Azure Storage-mapp där batchutdata skulle sparas.	Nej

BatchStatus

Status för en batch.

Fastighet	Värde
Beskrivning	Status för en batch.
Typ	snöre
Värden	validating failed in_progress finalizing completed expired cancelling cancelled

BatchesList

Representerar en lista över batchar.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över objekt.	Nej
first_id	snöre	ID:t för den första batchen i listan över batchar som returneras.	Nej
har_mer	booleskt	Ett värde som anger om listan innehåller fler element än vad som returneras.	Nej
last_id	snöre	ID:t för den sista batchen i listan över batchar som returneras.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej

Förmågor

Funktionerna i en bas- eller finjusteringsmodell.

Namn	Typ	Beskrivning	Krävs	Förinställning
chattavslutning	booleskt	Ett värde som anger om en modell stöder chattens slutförande.	Ja
avslutning	booleskt	Ett värde som anger om en modell stöder slutförande.	Ja
inbäddningar	booleskt	Ett värde som anger om en modell stöder inbäddningar.	Ja
fine_tune	booleskt	Ett värde som anger om en modell kan användas för finjustering.	Ja
slutledning	booleskt	Ett värde som anger om en modell kan distribueras.	Ja

Alternativ

Namn	Typ	Beskrivning	Krävs	Förinställning
avslutningsorsak	snöre	Anledningen till att modellen slutade generera token.	Nej
Innehållsförteckning	integer	Valfritt index i listan med alternativ.	Nej
logprobs	objekt	Logga sannolikhetsinformation för valet.	Nej
meddelande	ChoiceMessage		Nej

ChoiceMessage

Namn	Typ	Beskrivning	Krävs	Förinställning
innehåll	snöre	Innehållet i meddelandet.	Nej
None needed, as the translation is already accurate and fluent.	snöre	Rollen för den entitet som skapar meddelandet.	Nej
verktygsanrop	array	En lista över relevanta verktygsanrop.	Nej

Inställningar för Chunking

Segmenteringsinställningar

Namn	Typ	Beskrivning	Krävs	Förinställning
maxChunkSizeInTokens	integer		Nej

Slutförandåtgärd

Slutförandeåtgärden.

Fastighet	Värde
Beskrivning	Slutförandeåtgärden.
Typ	snöre
Värden	cleanUpTempAssets keepAllAssets

BeräkningsTyp

Beräkningstypen.

Fastighet	Värde
Beskrivning	Beräkningstypen.
Typ	snöre
Värden	ServerlessCompute CustomCompute

ConnectionStringAnslutning

Anslutningssträngsanslutning.

Namn	Typ	Beskrivning	Krävs	Förinställning
anslutningssträng	snöre	Anslutningssträng	Nej
typ	Typ av anslutning	Anslutningstypen.	Ja

Anslutningstyp

Anslutningstypen.

Fastighet	Värde
Beskrivning	Anslutningstypen.
Typ	snöre
Värden	EndpointWithKey ConnectionString EndpointWithManagedIdentity WorkspaceConnection RelativeConnection

CosmosDBIndex

CosmosDB-index.

Namn	Typ	Beskrivning	Krävs	Förinställning
samlingensNamn	snöre	Namnet på cosmos DB-samlingen.	Nej
connectionId	snöre	ID:t för anslutningen som pekar på cosmos DB.	Nej
databasNamn	snöre	Namnet på cosmos DB-databasen.	Nej
typ	MålTyp	Måltypen.	Ja

Genomsökningsinställningar

Crawlningsinställningar

Namn	Typ	Beskrivning	Krävs	Förinställning
maximal krypdjup	integer		Nej
maxGenomsökningstidIMinuter	integer		Nej
maxLaddningstidIMinuter	integer		Nej
Maxfilstorlek	integer		Nej
maxFiles	integer		Nej
maxOmdirigeringar	integer		Nej

SkapaEvalSlutförandenKörDataKälla

Ett CompletionsRunDataSource-objekt som beskriver en modellsamplingskonfiguration.

Namn	Typ	Beskrivning	Krävs	Förinställning
inmatningsmeddelanden	objekt		Nej
└– item_reference	snöre	En referens till en variabel i namnområdet "objekt", t.ex. "item.name".	Nej
└– mall	array	En lista över chattmeddelanden som utgör prompten eller kontexten. Kan innehålla variabelreferenser till namnområdet "objekt", t.ex. {{item.name}}.	Nej
└– typ	enum	Typ av indatameddelanden. Antingen template eller item_reference. Möjliga värden: template, item_reference	Nej
modell	snöre	Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini").	Nej
provtagning_parametrar	objekt		Nej
└– max_completion_tokens	integer	Det maximala antalet token i de genererade utdata.	Nej
└– frö	integer	Ett frövärde för att initiera slumpmässigheten under samplingen.	Nej	42
└– temperatur	nummer	En högre temperatur ökar slumpmässigheten i utdata.	Nej	1
└– top_p	nummer	Ett alternativ till temperatur för kärnprovtagning. 1.0 innehåller alla token.	Nej	1
källa	objekt		Ja
└– typ	enum	Typ av källa. Kan vara en av EvalJsonlFileContentSource, EvalJsonlFileIdSourceeller EvalStoredCompletionsSource. Möjliga värden: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Nej
typ	enum	Typen av körningsdatakälla. Alltid completions. Möjliga värden: completions	Ja

SkapaEvalCustomDataKällaKonfiguration

Ett CustomDataSourceConfig-objekt som definierar schemat för datakällan som används för utvärderingskörningarna. Det här schemat används för att definiera formen på de data som ska: – användas för att fastställa dina testvillkor och – de data som krävs när du skapar ett test.

Namn	Typ	Beskrivning	Krävs	Förinställning
inkludera_exempelschema	booleskt	Om utvärderingen ska förutsätta att du fyller exempelnamnområdet (dvs. genom att generera svar från din datakälla)	Nej	Falsk
objektschema	objekt	Json-schemat för varje rad i datakällan.	Ja
typ	enum	Typen av datakälla. Alltid custom. Möjliga värden: custom	Ja

SkapaUtvärderingsobjekt

Ett chattmeddelande som utgör prompten eller kontexten. Kan innehålla variabelreferenser till namnområdet "item", dvs{{item.name}}.

Namn	Typ	Beskrivning	Krävs	Förinställning
innehåll	['string', 'InputTextContent', 'object']	Textindata till modellen – kan innehålla mallsträngar.	Ja
None needed, as the translation is already accurate and fluent.	enum	Rollen för meddelandets inmatning. En av user, assistant, systemeller developer. Möjliga värden: user, assistant, system, developer	Ja
typ	enum	Typ av meddelandeindata. Alltid message. Möjliga värden: message	Nej

Skapa EvalJsonlKörDataKälla

Ett JsonlRunDataSource-objekt som anger en JSONL-fil som matchar eval

Namn	Typ	Beskrivning	Krävs	Förinställning
källa	objekt		Ja
└– innehåll	array	Innehållet i jsonl-filen.	Nej
└– id	snöre	Identifieraren för filen.	Nej
└– typ	enum	Typen av jsonl-källa. Alltid file_id. Möjliga värden: file_id	Nej
typ	enum	Typen av datakälla. Alltid jsonl. Möjliga värden: jsonl	Ja

CreateEvalLabelModelGrader

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

Namn	Typ	Beskrivning	Krävs	Förinställning
input	array	En lista över chattmeddelanden som utgör prompten eller kontexten. Kan innehålla variabelreferenser till namnområdet "item", dvs{{item.name}}.	Ja
Etiketter	array	Etiketterna som ska klassificeras för varje objekt i utvärderingen.	Ja
modell	snöre	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	Ja
namn	snöre	Namnet på bedömaren.	Ja
godkända_etiketter	array	Etiketterna som anger ett godkänt resultat. Måste vara en delmängd av etiketter.	Ja
typ	enum	Objekttypen, som alltid label_modelär . Möjliga värden: label_model	Ja

SkapaEvalLogsDataSourceKonfig

En datakällskonfiguration som anger metadataegenskapen för frågeavslutningar om lagrade data. Det här är vanligtvis metadata som usecase=chatbot eller prompt-version=v2osv.

Namn	Typ	Beskrivning	Krävs	Förinställning
metainformation	objekt	Metadatafilter för loggdatakällan.	Nej
typ	enum	Typen av datakälla. Alltid logs. Möjliga värden: logs	Ja

SkapaUtvärderingsbegäran

Namn	Typ	Beskrivning	Krävs	Förinställning
datakällkonfiguration	objekt	Ett CustomDataSourceConfig-objekt som definierar schemat för datakällan som används för utvärderingskörningarna. Det här schemat används för att definiera formen på de data som ska: – användas för att fastställa dina testvillkor och – de data som krävs när du skapar ett test.	Ja
└– include_sample_schema	booleskt	Om utvärderingen ska förutsätta att du fyller exempelnamnområdet (dvs. genom att generera svar från din datakälla)	Nej	Falsk
└– item_schema	objekt	Json-schemat för varje rad i datakällan.	Nej
└– metadata	objekt	Metadatafilter för loggdatakällan.	Nej
└– typ	enum	Typen av datakälla. Alltid logs. Möjliga värden: logs	Nej
metainformation	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Nej
namn	snöre	Namnet på utvärderingen.	Nej
testkriterier	array	En lista över bedömare för alla utvärderingskörningar i den här gruppen.	Ja

CreateEvalRunRequest

Namn	Typ	Beskrivning	Krävs	Förinställning
datakälla	objekt	Ett JsonlRunDataSource-objekt som anger en JSONL-fil som matchar eval	Ja
└– input_messages	objekt		Nej
└– item_reference	snöre	En referens till en variabel i namnområdet "objekt", t.ex. "item.name".	Nej
└– mall	array	En lista över chattmeddelanden som utgör prompten eller kontexten. Kan innehålla variabelreferenser till namnområdet "objekt", t.ex. {{item.name}}.	Nej
└– typ	enum	Typ av indatameddelanden. Antingen template eller item_reference. Möjliga värden: template, item_reference	Nej
└– modell	snöre	Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini").	Nej
└– sampling_params	objekt		Nej
└– max_completion_tokens	integer	Det maximala antalet token i de genererade utdata.	Nej
└– frö	integer	Ett frövärde för att initiera slumpmässigheten under samplingen.	Nej	42
└– temperatur	nummer	En högre temperatur ökar slumpmässigheten i utdata.	Nej	1
└– top_p	nummer	Ett alternativ till temperatur för kärnprovtagning. 1.0 innehåller alla token.	Nej	1
└– källa	objekt		Nej
└– typ	enum	Typ av källa. Kan vara en av EvalJsonlFileContentSource, EvalJsonlFileIdSourceeller EvalStoredCompletionsSource. Möjliga värden: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Nej
└– typ	enum	Typen av körningsdatakälla. Alltid completions. Möjliga värden: completions	Nej
metainformation	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Nej
namn	snöre	Namnet på körningen.	Nej

CreateEvalStoredCompletionsRunDataSource

En StoredCompletionsRunDataSource-konfiguration som beskriver en uppsättning filter

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_efter	integer	En valfri Unix-tidsstämpel för att filtrera objekt som skapats efter den här tiden.	Nej
skapat_före	integer	En valfri Unix-tidsstämpel för att filtrera objekt som skapats före den här tiden.	Nej
gräns	integer	Ett valfritt maximalt antal objekt som ska returneras.	Nej
metainformation	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Nej
modell	snöre	En valfri modell att filtrera efter (t.ex. "gpt-4o").	Nej
typ	enum	Typen av datakälla. Alltid stored_completions. Möjliga värden: stored_completions	Ja

CustomCompute-tjänst

Anpassad beräkning.

Namn	Typ	Beskrivning	Krävs	Förinställning
computeId	snöre	ID för den anpassade beräkningen	Nej
typ	ComputeType	Beräkningstypen.	Ja

DeploymentConnection

Relativ distributionsanslutning.

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	Typ av anslutning	Anslutningstypen.	Ja

Avveckling

Definierar datum för utfasning för de olika användningsfallen för en modell.

Vanligtvis har basmodeller stöd för 1 års finjustering efter skapandet. Slutsatsdragning stöds vanligtvis 2 år efter skapandet av bas- eller finjusterade modeller. De exakta datumen anges i egenskaperna.

Namn	Typ	Beskrivning	Krävs	Förinställning
fine_tune	integer	Slutdatumet för finjusteringsstöd för den här modellen. Kommer att vara null för finjustera modeller.	Nej
slutledning	integer	Slutdatumet för slutsatsdragningsstöd för den här modellen.	Ja

DpoHyperparamsFörfrågan

Hyperparametrar för DPO-metoden för finjustering

Namn	Typ	Beskrivning	Krävs	Förinställning
batchstorlek	integer	Storleken på batchen som ska användas för träning. Batchstorleken är antalet träningsprover som används för att träna ett enskilt framåt- och bakåtpass. I allmänhet har vi upptäckt att större batchstorlekar tenderar att fungera bättre för större datamängder. Standardvärdet samt det maximala värdet för den här egenskapen är specifika för en basmodell.	Nej
beta	nummer	DPO betavärde.	Nej
l2-multiplikator	nummer	L2-multiplikator för reglering	Nej
inlärningshastighetsmultiplikator	nummer	Den inlärningsfrekvensmultiplikator som ska användas för träning. Inlärningshastigheten för finjustering är den ursprungliga inlärningshastigheten som används för förträning multiplicerad med detta värde. Större inlärningsfrekvenser tenderar att fungera bättre med större batchstorlekar. Vi rekommenderar att du experimenterar med värden i intervallet 0,02 till 0,2 för att se vad som ger bäst resultat.	Nej
antal epoker	integer	Antalet epoker som modellen ska tränas i. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	Nej

DpoMetod

Begäran om finjustering av DPO-metod

Namn	Typ	Beskrivning	Krävs	Förinställning
dpo	DpoMethodConfigRequest	Konfiguration för dpo finjusteringsmetod. Innehåller DPO-specifika hyperparametrar	Ja
typ	Finjusteringsmetodtyp		Ja

DpoMetodKonfigBegäran

Konfiguration för dpo finjusteringsmetod. Innehåller DPO-specifika hyperparametrar

Namn	Typ	Beskrivning	Krävs	Förinställning
hyperparametrar	DpoHyperparamsRequest	Hyperparametrar för DPO-metoden för finjustering	Nej

DpoMethodRequest

Begäran om finjustering av DPO-metod

Namn	Typ	Beskrivning	Krävs	Förinställning
dpo	DpoMethodConfigRequest	Konfiguration för dpo finjusteringsmetod. Innehåller DPO-specifika hyperparametrar	Ja
typ	Finjusteringsmetodtyp		Ja

Slutpunktsnyckelanslutning

Slutpunktsnyckelanslutning.

Namn	Typ	Beskrivning	Krävs	Förinställning
Slutpunkt	snöre	Slutpunkt	Nej
nyckel	snöre	Nyckel	Nej
typ	Typ av anslutning	Anslutningstypen.	Ja

EndpointMIConnection

Slutpunktshanterad identitetsanslutning.

Namn	Typ	Beskrivning	Krävs	Förinställning
Slutpunkt	snöre	Slutpunkt	Nej
typ	Typ av anslutning	Anslutningstypen.	Ja
resursId	snöre	Resurs-ID	Nej

Fel

Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna.

Namn	Typ	Beskrivning	Krävs	Förinställning
kod	ErrorCode-	Felkoder enligt definitionen i Microsoft REST-riktlinjerna.	Ja
Detaljer	array	Felinformationen om den är tillgänglig.	Nej
innererror	InnerError	Inre fel enligt definitionen i Microsoft REST-riktlinjerna.	Nej
meddelande	snöre	Meddelandet om det här felet.	Ja
mål	snöre	Platsen där felet inträffade om det var tillgängligt.	Nej

Felkod

Felkoder enligt definitionen i Microsoft REST-riktlinjerna.

Fastighet	Värde
Beskrivning	Felkoder enligt definitionen i Microsoft REST-riktlinjerna.
Typ	snöre
Värden	conflict invalidPayload forbidden notFound unexpectedEntityState itemDoesAlreadyExist serviceUnavailable internalFailure quotaExceeded jsonlValidationFailed fileImportFailed tooManyRequests unauthorized contentFilter

Felmeddelande

Felsvar enligt definitionen i Microsoft REST-riktlinjerna.

Namn	Typ	Beskrivning	Krävs	Förinställning
fel	Fel	Felinnehåll enligt definitionen i Microsoft REST-riktlinjerna.	Ja

Utvärdering

Ett Eval-objekt med ett konfigurations- och testvillkor för datakällan. En Eval representerar en uppgift som ska utföras för DIN LLM-integrering. Tycka om:

• Förbättra kvaliteten på min chattrobot
• Se hur bra min chattrobot hanterar kundsupport
• Kontrollera om o3-mini är bättre på mitt användningsfall än gpt-4o

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när eval skapades.	Ja
datakällkonfiguration	objekt	En CustomDataSourceConfig som anger schemat för dina item och eventuellt sample namnområden. Svarsschemat definierar formen på de data som ska vara: – Används för att definiera dina testvillkor och – Vilka data som krävs när du skapar en körning	Ja
└– metadata	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Nej
└– schema	objekt	Json-schemat för körningen av datakällans objekt. Lär dig hur du skapar JSON-scheman här.	Nej
└– typ	enum	Typen av datakälla. Alltid stored_completions. Möjliga värden: stored_completions	Nej
Id-nummer	snöre	Unik identifierare för utvärderingen.	Ja
metainformation	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Ja
namn	snöre	Namnet på utvärderingen.	Ja
objekt	enum	Objekttypen. Möjliga värden: eval	Ja
testkriterier	array	En lista över testkriterier.	Ja

EvalApiError

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

Namn	Typ	Beskrivning	Krävs	Förinställning
kod	snöre	Felkoden.	Ja
meddelande	snöre	Felmeddelandet.	Ja

UtvärderaAnpassadDatakällKonfiguration

En CustomDataSourceConfig som anger schemat för dina item och eventuellt sample namnområden. Svarsschemat definierar formen på de data som ska vara: – Används för att definiera dina testvillkor och – Vilka data som krävs när du skapar en körning

Namn	Typ	Beskrivning	Krävs	Förinställning
Schemat	objekt	Json-schemat för körningen av datakällans objekt. Lär dig hur du skapar JSON-scheman här.	Ja
typ	enum	Typen av datakälla. Alltid custom. Möjliga värden: custom	Ja

EvalFileRunDataSource

En FileRunDataSource-konfiguration med ett fil-ID

Namn	Typ	Beskrivning	Krävs	Förinställning
file_id	snöre	Identifieraren för filen.	Ja
typ	enum	Typen av datakälla. Alltid file. Möjliga värden: file	Ja

EvalItem

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

Namn	Typ	Beskrivning	Krävs	Förinställning
innehåll	objekt	En textinmatning till modellen.	Ja
└– text	snöre	Textutdata från modellen.	Nej
└– typ	enum	Typ av utdatatext. Alltid output_text. Möjliga värden: output_text	Nej
None needed, as the translation is already accurate and fluent.	enum	Rollen för meddelandets inmatning. En av user, assistant, systemeller developer. Möjliga värden: user, assistant, system, developer	Ja
typ	enum	Typ av meddelandeindata. Alltid message. Möjliga värden: message	Nej

EvalJsonlFilInnehållKälla

Namn	Typ	Beskrivning	Krävs	Förinställning
innehåll	array	Innehållet i jsonl-filen.	Ja
typ	enum	Typen av jsonl-källa. Alltid file_content. Möjliga värden: file_content	Ja

EvalJsonlFilIdKälla

Namn	Typ	Beskrivning	Krävs	Förinställning
Id-nummer	snöre	Identifieraren för filen.	Ja
typ	enum	Typen av jsonl-källa. Alltid file_id. Möjliga värden: file_id	Ja

EvalLabelModelGrader

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

Namn	Typ	Beskrivning	Krävs	Förinställning
input	array		Ja
Etiketter	array	Etiketterna som ska tilldelas till varje objekt i utvärderingen.	Ja
modell	snöre	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	Ja
namn	snöre	Namnet på bedömaren.	Ja
godkända_etiketter	array	Etiketterna som anger ett godkänt resultat. Måste vara en delmängd av etiketter.	Ja
typ	enum	Objekttypen, som alltid label_modelär . Möjliga värden: label_model	Ja

EvalList

Ett objekt som representerar en lista över evals.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	En matris med eval-objekt.	Ja
first_id	snöre	Identifieraren för den första evalen i datamatrisen.	Ja
har_mer	booleskt	Anger om det finns fler utvärderingar tillgängliga.	Ja
last_id	snöre	Identifieraren för den senaste evalen i datamatrisen.	Ja
objekt	enum	Typen av det här objektet. Den är alltid inställd på "lista". Möjliga värden: list	Ja

EvalRun

Ett schema som representerar en utvärderingskörning.

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades.	Ja
datakälla	objekt	Ett JsonlRunDataSource-objekt som anger en JSONL-fil som matchar eval	Ja
└– input_messages	objekt		Nej
└– item_reference	snöre	En referens till en variabel i namnområdet "objekt", t.ex. "item.name".	Nej
└– mall	array	En lista över chattmeddelanden som utgör prompten eller kontexten. Kan innehålla variabelreferenser till namnområdet "objekt", t.ex. {{item.name}}.	Nej
└– typ	enum	Typ av indatameddelanden. Antingen template eller item_reference. Möjliga värden: template, item_reference	Nej
└– modell	snöre	Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini").	Nej
└– sampling_params	objekt		Nej
└– max_completion_tokens	integer	Det maximala antalet token i de genererade utdata.	Nej
└– frö	integer	Ett frövärde för att initiera slumpmässigheten under samplingen.	Nej	42
└– temperatur	nummer	En högre temperatur ökar slumpmässigheten i utdata.	Nej	1
└– top_p	nummer	Ett alternativ till temperatur för kärnprovtagning. 1.0 innehåller alla token.	Nej	1
└– källa	objekt		Nej
└– typ	enum	Typ av källa. Kan vara en av EvalJsonlFileContentSource, EvalJsonlFileIdSourceeller EvalStoredCompletionsSource. Möjliga värden: EvalJsonlFileContentSource, EvalJsonlFileIdSource, EvalStoredCompletionsSource	Nej
└– typ	enum	Typen av körningsdatakälla. Alltid completions. Möjliga värden: completions	Nej
fel	EvalApiError	Ett objekt som representerar ett felsvar från Eval-API:et.	Ja
eval_id	snöre	Identifieraren för den associerade utvärderingen.	Ja
Id-nummer	snöre	Unik identifierare för utvärderingskörningen.	Ja
metainformation	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Ja
modell	snöre	Den modell som utvärderas, om tillämpligt.	Ja
namn	snöre	Namnet på utvärderingskörningen.	Ja
objekt	enum	Typ av objekt. Alltid "eval.run". Möjliga värden: eval.run	Ja
per modellanvändning	array	Användningsstatistik för varje modell under utvärderingskörningen.	Ja
per_testkriterier_resultat	array	Resultat per testkriterier som tillämpades under utvärderingen.	Ja
report_url	snöre	URL:en till den renderade utvärderingskörningsrapporten på instrumentpanelen för användargränssnittet.	Ja
antalresultat	objekt	Räknare som sammanfattar resultatet av utvärderingsprocessen.	Ja
└– felaktig	integer	Antal utdataobjekt som resulterade i ett fel.	Nej
└– misslyckades	integer	Antal utdataobjekt som inte klarade utvärderingen.	Nej
└– godkänd	integer	Antal utdataobjekt som klarade utvärderingen.	Nej
└— totalt	integer	Totalt antal utförda utdataobjekt.	Nej
tillstånd	snöre	Status för utvärderingskörningen.	Ja

Förteckning över utvärderingskörningar

Ett objekt som representerar en lista över exekveringar för en utvärdering.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	En matris med eval-körningsobjekt.	Ja
first_id	snöre	Identifieraren för den första eval-körningen i datamatrisen.	Ja
har_mer	booleskt	Anger om det finns fler utvärderingar tillgängliga.	Ja
last_id	snöre	Identifierare för den senaste eval-körningen i dataarrayen.	Ja
objekt	enum	Typen av det här objektet. Den är alltid inställd på "lista". Möjliga värden: list	Ja

EvalRunOutputItem

Ett schema som representerar ett utdataobjekt för utvärderingskörning.

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades.	Ja
datasource-objekt	objekt	Information om indatakällans objekt.	Ja
datakälla_objekt_id	integer	Identifieraren för datakällans objekt.	Ja
eval_id	snöre	Identifieraren för utvärderingsgruppen.	Ja
Id-nummer	snöre	Unik identifierare för output-objektet vid utvärderingskörningen.	Ja
objekt	enum	Typ av objekt. Alltid "eval.run.output_item". Möjliga värden: eval.run.output_item	Ja
Resultat	array	En lista över resultat från utvärderingskörningen.	Ja
run_id	snöre	Identifieraren för utvärderingskörningen som är associerad med det här utdataobjektet.	Ja
exempel	objekt	Ett exempel som innehåller indata och utdata från utvärderingskörningen.	Ja
└– fel	EvalApiError	Ett objekt som representerar ett felsvar från Eval-API:et.	Nej
└– avslutnings_anledning	snöre	Anledningen till att exempelgenereringen slutfördes.	Nej
└– indata	array	En matris med indatameddelanden.	Nej
└– max_completion_tokens	integer	Det maximala antalet token som tillåts för slutförande.	Nej
└– modell	snöre	Den modell som används för att generera exemplet.	Nej
└– utdata	array	En matris med utdatameddelanden.	Nej
└– frö	integer	Det frö som används för att generera exemplet.	Nej
└– temperatur	nummer	Den samplingstemperatur som används.	Nej
└– top_p	nummer	Det top_p värde som används för sampling.	Nej
└— användning	objekt	Information om tokenanvändning för exemplet.	Nej
└– cached_tokens	integer	Antalet token som hämtats från cacheminnet.	Nej
└– completion_tokens	integer	Antalet slutförandetoken som genererats.	Nej
└– prompt_tokens	integer	Antalet prompttoken som används.	Nej
└– totalt_antal_tokenar	integer	Det totala antalet token som används.	Nej
tillstånd	snöre	Status för utvärderingskörningen.	Ja

Lista över utmatningsobjekt för evalueringsexekvering

Ett objekt som representerar en lista över utdataobjekt för en utvärderingskörning.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	En matris med objekt för eval-körning av utdataobjekt.	Ja
first_id	snöre	Identifieraren för utdataobjektet från första eval-körningen i datamatrisen.	Ja
har_mer	booleskt	Anger om det finns mer utvärderingskörningsutdata tillgänglig.	Ja
last_id	snöre	Identifieraren för utdataobjektet för den senaste eval-körningen i datamatrisen.	Ja
objekt	enum	Typen av det här objektet. Den är alltid inställd på "lista". Möjliga värden: list	Ja

EvalScoreModelGrader

Ett ScoreModelGrader-objekt som använder en modell för att tilldela en poäng till indata.

Namn	Typ	Beskrivning	Krävs	Förinställning
input	array	Inmatningstexten. Detta kan innehålla mallsträngar.	Ja
modell	snöre	Den modell som ska användas för utvärderingen.	Ja
namn	snöre	Namnet på bedömaren.	Ja
passera gränsvärde	nummer	Tröskelvärdet för poängen.	Nej
omfång	array	Poängintervallet. Standardinställningen är [0, 1].	Nej
provtagning_parametrar	objekt	Samplingsparametrarna för modellen.	Nej
typ	enum	Objekttypen, som alltid score_modelär . Möjliga värden: score_model	Ja

UtvärderaLagradeSlutförandenDatakällKonfiguration

En StoredCompletionsDataSourceConfig som anger egenskapen metadata för den lagrade kompletteringsfrågan. Det här är vanligtvis metadata som usecase=chatbot eller prompt-version=v2osv. Schemat som returneras av den här datakällans konfiguration används för att definiera vilka variabler som är tillgängliga i dina evals. item och sample definieras båda när du använder den här datakällans konfiguration.

Namn	Typ	Beskrivning	Krävs	Förinställning
metainformation	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Nej
Schemat	objekt	Json-schemat för körningen av datakällans objekt. Lär dig hur du skapar JSON-scheman här.	Ja
typ	enum	Typen av datakälla. Alltid stored_completions. Möjliga värden: stored_completions	Ja

EvalStoredCompletionsSource

En StoredCompletionsRunDataSource-konfiguration som beskriver en uppsättning filter

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_efter	integer	En valfri Unix-tidsstämpel för att filtrera objekt som skapats efter den här tiden.	Nej
skapat_före	integer	En valfri Unix-tidsstämpel för att filtrera objekt som skapats före den här tiden.	Nej
gräns	integer	Ett valfritt maximalt antal objekt som ska returneras.	Nej
metainformation	Metadata	Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.	Nej
modell	snöre	En valfri modell att filtrera efter (t.ex. "gpt-4o").	Nej
typ	enum	Typ av källa. Alltid stored_completions. Möjliga värden: stored_completions	Ja

EvalStringCheckGrader

Ett StringCheckGrader-objekt som utför en strängjämförelse mellan indata och referens med en angiven åtgärd.

Namn	Typ	Beskrivning	Krävs	Förinställning
input	snöre	Inmatningstexten. Detta kan innehålla mallsträngar.	Ja
namn	snöre	Namnet på bedömaren.	Ja
Operation	enum	Strängkontrollprocessen som ska utföras. En av eq, ne, likeeller ilike. Möjliga värden: eq, ne, like, ilike	Ja
hänvisning	snöre	Referenstexten. Detta kan innehålla mallsträngar.	Ja
typ	enum	Objekttypen, som alltid string_checkär . Möjliga värden: string_check	Ja

EvalTextSimilarityGrader

Ett TextSimilarityGrader-objekt som betygsätter text baserat på likhetsmått.

Namn	Typ	Beskrivning	Krävs	Förinställning
utvärderingsmetrik	enum	Det utvärderingsmått som ska användas. En av fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, rouge_5eller rouge_l. Möjliga värden: fuzzy_match, bleu, gleu, meteor, rouge_1, rouge_2, rouge_3, rouge_4, , , rouge_5rouge_l	Ja
input	snöre	Texten som bedöms.	Ja
namn	snöre	Namnet på bedömaren.	Nej
passera gränsvärde	nummer	En flyttalspoäng där ett värde som är större än eller lika indikerar ett godkänt betyg.	Ja
hänvisning	snöre	Texten som betygsätts och jämförs med.	Ja
typ	enum	Typ av väghyvel. Möjliga värden: text_similarity	Ja

Evenemangstyp

Definierar allvarlighetsgraden för ett resultat av ett innehållsfilter.

Fastighet	Värde
Beskrivning	Definierar allvarlighetsgraden för ett resultat av ett innehållsfilter.
Typ	snöre
Värden	message metrics

Fil

En fil är ett dokument som kan användas för träning och validering. Det kan också vara ett tjänstgenererat dokument med resultatinformation.

Namn	Typ	Beskrivning	Krävs	Förinställning
byte	integer	Storleken på den här filen när den är tillgänglig (kan vara null). Filstorlekar som är större än 2^53-1 stöds inte för att säkerställa kompatibilitet med JavaScript-heltal.	Nej
skapad_tid	integer	En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).	Nej
utgår_den	integer	En unix-tidsstämpel (antalet sekunder som har förflutit sedan den 1 januari 1970) när filen har upphört att gälla.	Nej
filnamn	snöre	Namnet på filen.	Ja
Id-nummer	snöre	Identiteten för det här objektet.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja
tillstånd	FileState	Tillståndet för en fil.	Nej
statusdetaljer	snöre	Felmeddelandet med information om bearbetningen av den här filen misslyckades. Avrådd.	Nej

SkapaFil

Definierar ett dokument som ska importeras från en extern innehålls-URL så att det kan användas med Azure OpenAI.

Namn	Typ	Beskrivning	Krävs	Förinställning
content_url	snöre	Url:en som dokumentet ska laddas ned från (kan vara SAS-URL för en blob eller någon annan extern URL som är tillgänglig med en GET-begäran).	Ja
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

FileDelete

Definierar svaret för Filborttagning.

Namn	Typ	Beskrivning	Krävs	Förinställning
borttagen	booleskt	Ett värde som anger om filen har tagits bort.	Ja
Id-nummer	snöre	Fil-ID:t som togs bort.	Ja
objekt	snöre	Om filen har tagits bort.	Ja

Filinformation

En detaljerad fil är ett dokument som används av batchtjänsten för att hämta information om filblobb.

Namn	Typ	Beskrivning	Krävs	Förinställning
filnamn	snöre	Namnet på filen.	Ja
Id-nummer	snöre	Identiteten för det här objektet.	Nej
väg	snöre	Den relativa sökvägen till filen i containern.	Nej
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja
lagringskonto_uri	snöre	Lagringskontots URL för den här filen.	Nej
lagringsbehållarens namn	snöre	Lagringscontainerns namn på den här filbloben.	Nej

FilGårUtEfter

Definierar en förfallotid för filen.

Namn	Typ	Beskrivning	Krävs	Förinställning
ankare	FileExpiryAnchor	Definierar fästpunkten i förhållande till vilken tid den absoluta förfallotiden ska genereras från.	Nej
Sekunder	integer	Den relativa förfallotiden i sekunder. Intervall: [1209600 - 2592000].	Nej

FileExpiryAnchor

Definierar fästpunkten i förhållande till vilken tid den absoluta förfallotiden ska genereras från.

Fastighet	Värde
Beskrivning	Definierar fästpunkten i förhållande till vilken tid den absoluta förfallotiden ska genereras från.
Typ	snöre
Värden	created_at

Filimport

Definierar ett dokument som ska importeras från en extern innehålls-URL så att det kan användas med Azure OpenAI.

Namn	Typ	Beskrivning	Krävs	Förinställning
content_url	snöre	Url:en som dokumentet ska laddas ned från (kan vara SAS-URL för en blob eller någon annan extern URL som är tillgänglig med en GET-begäran).	Ja
går ut efter	FileExpiresAfter	Definierar en förfallotid för filen.	Nej
filnamn	snöre	Namnet på JSON Lines-filen som ska laddas upp. Om purpose är inställt på "finjustera" är varje rad en JSON-post med fälten "prompt" och "completion" som representerar dina träningsexempel.	Ja
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

Fillista

Representerar en lista med filer.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över objekt.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej

Filstatus

Tillståndet för en fil.

Fastighet	Värde
Beskrivning	Tillståndet för en fil.
Typ	snöre
Värden	uploaded pending running processed error deleting deleted

FineTuneMethod

Diskriminator för FineTuneMethod

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	Finjusteringsmetodtyp		Ja

Begäran om Finjusteringsmetod

Diskriminator för FineTuneMethodRequest

Den här komponenten använder egenskapen type för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	Finjusteringsmetodtyp		Ja

Finjustering av hyperparametrar

Hyperparameterinställningarna som används i ett finjusterat jobb.

Namn	Typ	Beskrivning	Krävs	Förinställning
batchstorlek	integer	Storleken på batchen som ska användas för träning. Batchstorleken är antalet träningsprover som används för att träna ett enskilt framåt- och bakåtpass. I allmänhet har vi upptäckt att större batchstorlekar tenderar att fungera bättre för större datamängder. Standardvärdet samt det maximala värdet för den här egenskapen är specifika för en basmodell.	Nej
inlärningshastighetsmultiplikator	nummer	Den inlärningsfrekvensmultiplikator som ska användas för träning. Inlärningshastigheten för finjustering är den ursprungliga inlärningshastigheten som används för förträning multiplicerad med detta värde. Större inlärningsfrekvenser tenderar att fungera bättre med större batchstorlekar. Vi rekommenderar att du experimenterar med värden i intervallet 0,02 till 0,2 för att se vad som ger bäst resultat.	Nej
antal epoker	integer	Antalet epoker som modellen ska tränas i. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	Nej

Finjustera jobbet

Definierar värdena för ett finjusteringsjobb.

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_tid	integer	En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).	Nej
fel	FineTuningJobError	För finjusteringsjobb som har misslyckats innehåller detta mer information om orsaken till felet.	Nej
beräknad avslutning	integer	Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet beräknas vara klart. Värdet kommer att vara nullvärde om finkalibreringsjobbet inte körs.	Nej
finjusterad modell	snöre	Identifieraren (modell-ID) för den resulterande finjusterade modellen. Den här egenskapen fylls bara i för framgångsrikt slutförda finjusteringskörningar. Använd den här identifieraren för att skapa en distribution för slutsatsdragning.	Nej
avslutad_vid	integer	En tidsstämpel när det här jobbet eller objektet har slutförts (i unix-epoker).	Nej
hyperparametrar	FineTuningHyperParameters	Hyperparameterinställningarna som används i ett finjusterat jobb.	Nej
Id-nummer	snöre	Identiteten för det här objektet.	Nej
Integrationer	array	En lista över konfigurationer för integreringar som stöder finjusteringsjobbet. Det finns många planerade integreringar, så se till att kontrollera och agera på integrationstypen.	Nej
metod	objekt	Metod som används för övervakad finjustering	Nej
└– typ	Finjusteringsmetodtyp		Nej
modell	snöre	Identifieraren (modell-ID) för basmodellen som används för finjusteringen.	Ja
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
organisations-ID	snöre	Organisations-ID för det här finjusteringsjobbet. Används inte i Azure OpenAI. endast för OpenAI.	Nej
resultatfiler	array	Resultatfilidentiteterna (fil-ID) som innehåller tränings- och utvärderingsmått i csv-format. Filen är endast tillgänglig för slutförda finjusteringskörningar.	Nej
frö	integer	Det frö som används för finjusteringsjobbet.	Nej
tillstånd	FineTuningState	Tillståndet för ett finjusteringsobjekt eller finjusteringsuppgift.	Nej
suffix	snöre	Suffixet som används för att identifiera den finjusterade modellen. Suffixet kan innehålla upp till 40 tecken (a-z, A-Z, 0-9 och _) som läggs till i ditt finjusterade modellnamn.	Nej
tränade_token	integer	Det totala antalet fakturerbara token som bearbetas av det här finjusteringsjobbet.	Nej
utbildningsfil	snöre	Filen som används för träning.	Ja
validation_file	snöre	Filen som används för att utvärdera den finjusterade modellen under träningen.	Nej

KontrollpunktFörFinjusteringsjobb

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när kontrollpunkten skapades.	Ja
Fintjusterad modellkontrollpunkt	snöre	Namnet på den finjusterade kontrollpunktsmodellen som skapas.	Ja
finjusteringsjobb_id	snöre	Namnet på det finjusteringsjobb från vilket denna kontrollpunkt skapades.	Ja
Id-nummer	snöre	Identiteten för den här kontrollpunkten.	Nej
mätvärden	objekt	Måtten vid stegnumret under finjusteringsjobbet.	Ja
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
stegnummer	integer	Det stegnummer som kontrollpunkten skapades vid.	Ja

Finjusteringsjobbs Kontrollpunktslista

Representerar en lista över kontrollpunkter.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över objekt.	Nej
har_mer	booleskt	Ett värde som anger om listan innehåller fler element än vad som returneras.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej

FineTuningJobCreation

Definierar värdena för ett finjusteringsjobb.

Namn	Typ	Beskrivning	Krävs	Förinställning
hyperparametrar	FineTuningHyperParameters	Hyperparameterinställningarna som används i ett finjusterat jobb.	Nej
Integrationer	array	En lista över konfigurationer för integreringar som stöder finjusteringsjobbet. Det finns många planerade integreringar, så se till att kontrollera och agera på integrationstypen.	Nej
metod	objekt	Metod som används för övervakad finjustering	Nej
└– typ	Finjusteringsmetodtyp		Nej
modell	snöre	Identifieraren (modell-ID) för basmodellen som används för den här finjusteraren.	Ja
frö	integer	Det frö som används för finjusteringsjobbet. Att skicka in samma parametrar för start- och jobb bör ge samma resultat, men kan skilja sig i sällsynta fall. Om ett frö inte har angetts genereras ett för dig.	Nej
suffix	snöre	Suffixet som används för att identifiera den finjusterade modellen. Suffixet kan innehålla upp till 40 tecken (a-z, A-Z, 0-9 och _) som läggs till i ditt finjusterade modellnamn.	Nej
utbildningsfil	snöre	Den filidentitet (fil-ID) som används för att träna den här finjusterade modellen.	Ja
validation_file	snöre	Den filidentitet (fil-ID) som används för att utvärdera den finjusterade modellen under träningen.	Nej

Fel vid finjusteringsjobb

För finjusteringsjobb som har misslyckats innehåller detta mer information om orsaken till felet.

Namn	Typ	Beskrivning	Krävs	Förinställning
kod	snöre	Felkoden som kan läsas av datorn.	Nej
meddelande	snöre	Det mänskliga läsbara felmeddelandet.	Nej
Param	snöre	Parametern som var ogiltig, vanligtvis training_file eller validation_file. Det här fältet är null om felet inte var parameterspecifikt.	Nej

Finjusteringsjobbhändelse

Namn	Typ	Beskrivning	Krävs	Förinställning
skapad_tid	integer	En tidsstämpel när den här händelsen skapades (i unix-epoker).	Ja
data		Maskinläsbara data för den här händelsen.	Nej
Id-nummer	snöre	Identiteten för den här händelsen.	Nej
nivå	Loggnivå	Utförlighetsnivån för en händelse.	Ja
meddelande	snöre	Meddelandet som beskriver händelsen. Det kan vara en tillståndsändring, t.ex. enqueued, started, failed eller completed eller andra händelser som uppladdade resultat.	Ja
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
typ	EventType	Definierar allvarlighetsgraden för ett resultat av ett innehållsfilter.	Ja

FinjusteringsjobbHändelselista

Representerar en lista över händelser.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över objekt.	Nej
har_mer	booleskt	Ett värde som anger om listan innehåller fler element än vad som returneras.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej

Finjusteringsjobblista

Representerar en lista med fina låtar.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över objekt.	Nej
har_mer	booleskt	Ett värde som anger om listan innehåller fler element än vad som returneras.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej

Justeringsmetodtyp

Fastighet	Värde
Typ	snöre
Värden	dpo supervised

Finjusteringsläge

Tillståndet för ett finjusteringsobjekt eller finjusteringsuppgift.

Fastighet	Värde
Beskrivning	Tillståndet för ett finjusteringsobjekt eller finjusteringsuppgift.
Typ	snöre
Värden	created pending running pausing paused resuming succeeded cancelled failed

FunktionsAnropFunktion

Namn	Typ	Beskrivning	Krävs	Förinställning
Argumenten	snöre	Argumenten som modellen förväntar sig att du skickar till funktionen.	Nej
namn	snöre	Namnet på funktionen.	Nej

Funktionsdefinition

Namn	Typ	Beskrivning	Krävs	Förinställning
beskrivning	snöre	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej
namn	snöre	Namnet på den funktion som ska anropas.	Nej
parametrar		Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt.	Nej

Generella inbäddningsinställningar

Inställningar för inbäddning av anslutningar

Namn	Typ	Beskrivning	Krävs	Förinställning
anslutning	BaseConnection	En anslutning till en resurs.	Nej
utplaceringsnamn	snöre		Nej
modellnamn	snöre		Nej

Inmatningsfel

Information om inmatningsfelet

Namn	Typ	Beskrivning	Krävs	Förinställning
innerErrors	array		Nej
meddelande	snöre		Nej

IngestionJob

Representerar information om ett jobb.

Diskriminerande för IngestionJob

Den här komponenten använder egenskapen kind för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
jobId	snöre		Nej
typ	TypAvInmatningsjobb	Jobbtypen.	Ja

Lista över Ingestionsjobb

Representerar en lista över inmatningsjobb.

Namn	Typ	Beskrivning	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida.	Nej
värde	array	Listan över objekt.	Nej

IngestionJobProgress

Namn	Typ	Beskrivning	Krävs	Förinställning
stageProgress	array		Ja

IngestionJobRun

Information om en jobbkörning

Namn	Typ	Beskrivning	Krävs	Förinställning
fel	IngestionError	Information om inmatningsfelet	Nej
jobId	snöre		Nej
Förlopp	IngestionJobProgress		Nej
runId	snöre		Nej
tillstånd	OperationState	Tillståndet för ett jobb eller objekt.	Nej
Varningar	array		Nej

IngestionJobRunList

Representerar en lista över inmatningsjobbkörningar.

Namn	Typ	Beskrivning	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida.	Nej
värde	array	Listan över objekt.	Nej

IngestionJobStageProgress

Namn	Typ	Beskrivning	Krävs	Förinställning
namn	snöre		Nej
bearbetade produkter	integer		Nej
stat / tillstånd	OperationState	Tillståndet för ett jobb eller objekt.	Nej
delstegsförlopp	array		Nej
totaltAntalArtiklar	integer		Nej

IngestionJobSystemCompute

Namn	Typ	Beskrivning	Krävs	Förinställning
slutförandeÅtgärd	CompletionAction	Slutförandeåtgärden.	Nej
dataUppdateringsIntervallIttimmar	integer		Nej
datakälla	SystemComputeDatasource		Nej
jobId	snöre		Nej
typ	TypAvInmatningsjobb	Jobbtypen.	Ja
Söktjänstanslutning	BaseConnection	En anslutning till en resurs.	Nej

Typ av Inmatningsarbete

Jobbtypen.

Fastighet	Värde
Beskrivning	Jobbtypen.
Typ	snöre
Värden	SystemCompute UserCompute

InmatningsjobbAnvändarBeräkning

Namn	Typ	Beskrivning	Krävs	Förinställning
beräkna	JobCompute	Beräkningsinställningarna för jobbet.	Nej
dataUppdateringsIntervallIttimmar	integer		Nej
datakälla	UserComputeDatasource		Nej
jobId	snöre		Nej
typ	TypAvInmatningsjobb	Jobbtypen.	Ja
mål	TargetIndex	Information om det index som ska skapas.	Nej
arbetsyta-id	snöre		Nej

InnerError

Inre fel enligt definitionen i Microsoft REST-riktlinjerna.

Namn	Typ	Beskrivning	Krävs	Förinställning
kod	InnerErrorCode	Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna.	Nej
innererror	InnerError	Inre fel enligt definitionen i Microsoft REST-riktlinjerna.	Nej

InnerErrorCode

Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna.

Fastighet	Värde
Beskrivning	Inre felkoder enligt definitionen i Microsoft REST-riktlinjerna.
Typ	snöre
Värden	invalidPayload

Inmatningsmeddelande

Namn	Typ	Beskrivning	Krävs	Förinställning
innehåll	snöre	Innehållet i meddelandet.	Nej
Id-nummer	snöre	Identiteten för meddelandet.	Nej
namn	snöre	Ett valfritt namn för deltagaren. Tillhandahåller modellinformation för att skilja mellan deltagare med samma roll.	Nej
None needed, as the translation is already accurate and fluent.	snöre	Rollen för den entitet som skapar meddelandet.	Nej

Innehållstext

En textinmatning till modellen.

Namn	Typ	Beskrivning	Krävs	Förinställning
texten	snöre	Textinmatningen till modellen.	Ja
typ	enum	Typ av indataobjekt. Alltid input_text. Möjliga värden: input_text	Ja

Integrationstyper

Lista över de finjusteringsintegreringar som är tillgängliga.

Fastighet	Värde
Beskrivning	Lista över de finjusteringsintegreringar som är tillgängliga.
Typ	snöre
Värden	wandb

JobCompute

Beräkningsinställningarna för jobbet.

Diskriminator för JobCompute

Den här komponenten använder egenskapen kind för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	ComputeType	Beräkningstypen.	Ja

LifeCycleStatus

Livscykelstatus för en modell.

Obs! En modell kan höjas upp från preview till generally-available, men aldrig från generally-available till preview.

Fastighet	Värde
Beskrivning	Livscykelstatus för en modell. Obs! En modell kan höjas upp från preview till generally-available, men aldrig från generally-available till preview.
Typ	snöre
Värden	preview generally-available deprecating deprecated

Loggnivå

Utförlighetsnivån för en händelse.

Fastighet	Värde
Beskrivning	Utförlighetsnivån för en händelse.
Typ	snöre
Värden	info warning error

Logprob

Namn	Typ	Beskrivning	Krävs	Förinställning
logprob	nummer	Loggens sannolikhet för den här token, om den ligger inom de 20 mest sannolika token. Annars används värdet -9999.0 för att ange att token är mycket osannolik.	Nej
tecken	snöre	Token.	Nej

Metainformation

Uppsättning med 16 nyckel/värde-par som kan kopplas till ett objekt. Detta kan vara användbart för att lagra ytterligare information om objektet i ett strukturerat format och fråga efter objekt via API eller instrumentpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med en maximal längd på 512 tecken.

Inga egenskaper har definierats för den här komponenten.

Modell

En modell är antingen en basmodell eller resultatet av ett lyckat finjusterande jobb.

Namn	Typ	Beskrivning	Krävs	Förinställning
Kapacitet	Kapaciteter	Funktionerna i en bas- eller finjusteringsmodell.	Ja
skapad_tid	integer	En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).	Nej
föråldring	Avskrivningar	Definierar datum för utfasning för de olika användningsfallen för en modell. Vanligtvis har basmodeller stöd för 1 års finjustering efter skapandet. Inferens stöds vanligtvis i 2 år efter skapandet av basmodeller eller finjusterade modeller. De exakta datumen anges i egenskaperna.	Ja
fine_tune	snöre	Finjustera jobbidentiteten (finjustera id) om det här är en finjusteringsmodell. annars null.	Nej
Id-nummer	snöre	Identiteten för det här objektet.	Nej
livscykelstatus	LifeCycleStatus	Livscykelstatus för en modell. Obs! En modell kan höjas upp från "förhandsversion" till generally-available, men aldrig från generally-available till "förhandsversion".	Ja
modell	snöre	Basmodellidentiteten (modell-ID) om det här är en finjusteringsmodell. annars null.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
tillstånd	FineTuningState	Tillståndet för ett finjusteringsobjekt eller finjusteringsuppgift.	Nej

Modelllista

Representerar en lista över modeller.

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över objekt.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej

OperationState

Tillståndet för ett jobb eller objekt.

Fastighet	Värde
Beskrivning	Tillståndet för ett jobb eller objekt.
Typ	snöre
Värden	notRunning running succeeded failed

Beställning

Definierar syftet med en fil.

Fastighet	Värde
Beskrivning	Definierar syftet med en fil.
Typ	snöre
Värden	desc asc

OrdnaEfterOrdning

Fastighet	Värde
Typ	snöre
Värden	asc desc

PineconeIndex

Pinecone Index.

Namn	Typ	Beskrivning	Krävs	Förinställning
connectionId	snöre	ID:t för anslutningen som pekar på tallkotten.	Nej
typ	MålTyp	Måltypen.	Ja

Avsikt

Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.

Fastighet	Värde
Beskrivning	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.
Typ	snöre
Värden	fine-tune fine-tune-results assistants assistants_output batch batch_output evals evals_output

ServerlösBeräkning

Serverlös beräkning.

Namn	Typ	Beskrivning	Krävs	Förinställning
antal instanser	integer	Antalet instanser som jobbet ska köras på.	Nej
typ	ComputeType	Beräkningstypen.	Ja
Sku	snöre	SKU-nivå	Nej

StoredCompletion

Namn	Typ	Beskrivning	Krävs	Förinställning
Val	array	En lista över alternativ för chattens slutförande. Kan vara mer än en om n är större än 1.	Nej
skapad	integer	Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades.	Nej
frekvensstraff	nummer	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant.	Nej
Id-nummer	snöre	Identiteten för lagrat slutförande.	Nej
användarinmatning	snöre	Indataanvändaren för den här begäran.	Nej
metainformation	objekt	Godtyckliga nyckel/värde-par för ytterligare information.	Nej
modell	snöre	ID för modellen som ska användas.	Nej
närvarostraff	nummer	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på om de visas i texten hittills, vilket ökar modellens sannolikhet att prata om nya ämnen.	Nej
förfrågan_id	snöre	En unik identifierare för OpenAI API-begäran. Inkludera det här begärande-ID:t när du kontaktar supporten.	Nej
frö	integer	Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma seed och parametrar ska returnera samma resultat. Determinism är inte garanterad, och du bör referera till
system_fingerprint svarsparameter för att övervaka ändringar i serverdelen.	Nej
servicenivå	snöre	Anger svarstidsnivån som ska användas för bearbetning av begäran.	Nej
systemavtryck	snöre	Det här fingeravtrycket representerar serverdelskonfigurationen som modellen körs med. Kan användas tillsammans med parametern seed för begäran för att förstå när serverdelsändringar har gjorts som kan påverka determinismen.	Nej
temperatur	nummer	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.	Nej
verktygsval	snöre	Styr vilket (om något) verktyg som anropas av modellen.	Nej
verktyg	array	En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som ett verktyg. Använd detta för att ange en lista över funktioner som modellen kan generera JSON-indata för. Högst 128 funktioner stöds.	Nej
top_p	nummer	Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.	Nej
användning	Användning		Nej

LagradeKompletteringBorttagning

Namn	Typ	Beskrivning	Krävs	Förinställning
borttagen	booleskt	Ett värde som anger om hämtar om den lagrade slutförandet har tagits bort.	Nej
Id-nummer	snöre	Det lagrade slutförande-ID som togs bort.	Nej
objekt	snöre	Om den lagrade slutförandet har tagits bort.	Ja

LagratKomplettLista

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över hämtade objekt.	Nej
first_id	snöre	Det första ID:t i den hämtade list	Nej
har_mer	booleskt	Egenskapen has_more används för sidnumrering för att indikera att det finns ytterligare resultat.	Nej
last_id	snöre	Det sista ID:t i den hämtade list	Nej
objekt	snöre	Objekttypen, som alltid är list	Nej
summa	integer	Totalt antal objekt.	Nej

LagratSlutförandemeddelanden

Namn	Typ	Beskrivning	Krävs	Förinställning
data	array	Listan över hämtade objekt.	Nej
first_id	snöre	Det första ID:t i den hämtade list	Nej
har_mer	booleskt	Egenskapen has_more används för sidnumrering för att indikera att det finns ytterligare resultat.	Nej
last_id	snöre	Det sista ID:t i den hämtade list	Nej
objekt	snöre	Objekttypen, som alltid är list	Nej
summa	integer	Totalt antal objekt.	Nej

StoredCompletionResponse

Namn	Typ	Beskrivning	Krävs	Förinställning
Val	array	En lista över alternativ för chattens slutförande. Kan vara mer än en om n är större än 1.	Nej
skapad	integer	Unix-tidsstämpeln (i sekunder) för när chatten slutfördes skapades.	Nej
frekvensstraff	nummer	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på deras befintliga frekvens i texten hittills, vilket minskar modellens sannolikhet att upprepa samma rad ordagrant.	Nej
Id-nummer	snöre	Identiteten för lagrat slutförande.	Nej
användarinmatning	snöre	Indataanvändaren för den här begäran.	Nej
metainformation	objekt	Godtyckliga nyckel/värde-par för ytterligare information.	Nej
modell	snöre	ID för modellen som ska användas.	Nej
objekt	snöre	Typen av det här objektet.	Nej
närvarostraff	nummer	Tal mellan -2.0 och 2.0. Positiva värden straffar nya token baserat på om de visas i texten hittills, vilket ökar modellens sannolikhet att prata om nya ämnen.	Nej
förfrågan_id	snöre	En unik identifierare för OpenAI API-begäran. Inkludera det här begärande-ID:t när du kontaktar supporten.	Nej
frö	integer	Om det anges gör vårt system bästa för att sampla deterministiskt, så att upprepade begäranden med samma seedoch parametrar ska returnera samma resultat. Determinism är inte garanterad och du bör referera till svarsparametern system_fingerprint för att övervaka ändringar i serverdelen.	Nej
servicenivå	snöre	Anger svarstidsnivån som ska användas för bearbetning av begäran.	Nej
systemavtryck	snöre	Det här fingeravtrycket representerar serverdelskonfigurationen som modellen körs med. Kan användas tillsammans med parametern seed för begäran för att förstå när serverdelsändringar har gjorts som kan påverka determinismen.	Nej
temperatur	nummer	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som0.2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.	Nej
verktygsval	snöre	Styr vilket (om något) verktyg som anropas av modellen.	Nej
verktyg	array	En lista över verktyg som modellen kan anropa. För närvarande stöds endast funktioner som ett verktyg. Använd detta för att ange en lista över funktioner som modellen kan generera JSON-indata för. Högst 128 funktioner stöds.	Nej
top_p	nummer	Ett alternativ till sampling med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhetsmassa. Så 0,1 innebär att endast token som består av den översta 10 % sannolikhetsmassan beaktas. Vi rekommenderar vanligtvis att du ändrar detta eller temperature men inte båda.	Nej
användning	Användning		Nej

ÖvervakadMetod

Metod som används för övervakad finjustering

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	Finjusteringsmetodtyp		Ja

Begäran om övervakad metod

Metod som används för övervakad finjustering

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	Finjusteringsmetodtyp		Ja

SystemComputeDatasource

Discriminator för SystemComputeDatasource

Den här komponenten använder egenskapen kind för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	SystemComputeDatakälltyp	Datakällans typ.	Ja

SystemBeräknaDatakällaTyp

Datakällans typ.

Fastighet	Värde
Beskrivning	Datakällans typ.
Typ	snöre
Värden	Storage Urls

SystemComputeStorage

Lagringskonto

Namn	Typ	Beskrivning	Krävs	Förinställning
Spaltning	Inställningar för segmentering	Segmenteringsinställningar	Nej
anslutning	BaseConnection	En anslutning till en resurs.	Nej
containerNamn	snöre	containernamn	Nej
inbäddningar	array		Nej
typ	SystemComputeDatakälltyp	Datakällans typ.	Ja

SystemComputeUrl

Url:ar

Namn	Typ	Beskrivning	Krävs	Förinställning
Spaltning	Inställningar för segmentering	Segmenteringsinställningar	Nej
anslutning	BaseConnection	En anslutning till en resurs.	Nej
containerNamn	snöre	containernamn	Nej
Krypa	CrawlingSettings	Crawlningsinställningar	Nej
inbäddningar	array		Nej
typ	SystemComputeDatakälltyp	Datakällans typ.	Ja
URL:er	array		Nej

Målindex

Information om det index som ska skapas.

Avgränsare för TargetIndex

Den här komponenten använder egenskapen kind för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	MålTyp	Måltypen.	Ja

Måltyp

Måltypen.

Fastighet	Värde
Beskrivning	Måltypen.
Typ	snöre
Värden	AzureAISearch CosmosDB Pinecone

Verktyg

Namn	Typ	Beskrivning	Krävs	Förinställning
funktion	FunctionDefinition		Nej
typ	snöre	Typ av verktygsanrop. Detta kommer alltid att vara function för den här typen av verktygsanrop.	Nej

ToolCall

Namn	Typ	Beskrivning	Krävs	Förinställning
funktion	FunctionCallFunction		Nej
Id-nummer	snöre	ID:t för verktygsanropet.	Nej
typ	snöre	Typ av verktygsanrop som utdata krävs för. För tillfället är detta alltid function.	Nej

Typdiskriminator

Definierar typen av ett objekt.

Fastighet	Värde
Beskrivning	Definierar typen av ett objekt.
Typ	snöre
Värden	list fine_tuning.job file fine_tuning.job.event fine_tuning.job.checkpoint model upload upload.part batch wandb

UppdateraLagratAvslutsningsBegäran

Namn	Typ	Beskrivning	Krävs	Förinställning
metainformation	objekt	Godtyckliga nyckel/värde-par för ytterligare information.	Nej

UploadFileCompleteBody

Namn	Typ	Beskrivning	Krävs	Förinställning
md5	snöre		Nej
part_ids	array		Ja

UploadFileStartBody

Namn	Typ	Beskrivning	Krävs	Förinställning
byte	integer		Ja
filnamn	snöre		Ja
MIME-typ	snöre		Ja
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Ja

UploadPartResource

Namn	Typ	Beskrivning	Krävs	Förinställning
azure_block_id	snöre		Nej
skapad_tid	integer	En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).	Nej
Id-nummer	snöre	Identiteten för det här objektet.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
upload_id	snöre		Nej

UploadResource

Namn	Typ	Beskrivning	Krävs	Förinställning
byte	integer		Nej
skapad_tid	integer	En tidsstämpel när det här jobbet eller objektet skapades (i unix-epoker).	Nej
utgår_den	integer		Nej
fil	Arkiv	En fil är ett dokument som kan användas för träning och validering. Det kan också vara ett tjänstgenererat dokument med resultatinformation.	Nej
filnamn	snöre		Nej
Id-nummer	snöre	Identiteten för det här objektet.	Nej
objekt	TypeDiscriminator	Definierar typen av ett objekt.	Nej
avsikt	Avsikt	Det avsedda syftet med de uppladdade dokumenten. Använd "finjustera" för finjustering. På så sätt kan vi verifiera formatet på den uppladdade filen.	Nej
tillstånd	UploadStatus		Nej

Uppladdningsstatus

Fastighet	Värde
Typ	snöre
Värden	pending expired completed cancelled

Användning

Namn	Typ	Beskrivning	Krävs	Förinställning
kompletteringstoken	integer	Antal token i det genererade slutförandet.	Nej
uppmaningstoken	integer	Antal token i prompten.	Nej
total_tokens	integer	Totalt antal token som används i begäran (fråga + slutförande).	Nej

Användarberäkningsdatamängd

Lagringskonto

Namn	Typ	Beskrivning	Krävs	Förinställning
Spaltning	Inställningar för segmentering	Segmenteringsinställningar	Nej
datasetId	snöre		Nej
Datauppsättningstyp	snöre		Nej
inbäddningar	array		Nej
typ	AnvändarComputeDatakällTyp	Datakällans typ.	Ja

Användarberäkningsdatakälla

Differentierare för UserComputeDatasource

Den här komponenten använder egenskapen kind för att skilja mellan olika typer:

Typvärde	Schemat

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	UserComputeDatasourceType	Datakällans typ.	Ja

AnvändarBeräknaDatakällaTyp

Datakällans typ.

Fastighet	Värde
Beskrivning	Datakällans typ.
Typ	snöre
Värden	Dataset Urls

UserComputeUrl

Url:ar

Namn	Typ	Beskrivning	Krävs	Förinställning
Spaltning	Inställningar för segmentering	Segmenteringsinställningar	Nej
Krypa	CrawlingSettings	Crawlningsinställningar	Nej
inbäddningar	array		Nej
typ	UserComputeDatasourceType	Datakällans typ.	Ja
URL:er	array		Nej

WandBIntegrationsFörfrågan

Namn	Typ	Beskrivning	Krävs	Förinställning
entitet	snöre		Nej
namn	snöre		Nej
projekt	snöre		Ja
Taggar	array		Nej

WandBIntegrationRequestWrapper

Namn	Typ	Beskrivning	Krävs	Förinställning
typ	IntegrationTypes	Lista över finjusteringsintegreringar som är tillgängliga.	Ja
wandb	WandBIntegrationsförfrågan		Ja

ArbetsytaAnslutning

Anslutning till AML-arbetsyta.

Namn	Typ	Beskrivning	Krävs	Förinställning
connectionId	snöre	ConnectionId	Nej
typ	Typ av anslutning	Anslutningstypen.	Ja

Arbetsplatsanslutningsinbäddningsinställningar

Anslutnings-ID till inbäddningsmodellen

Namn	Typ	Beskrivning	Krävs	Förinställning
connectionId	snöre		Nej
utplaceringsnamn	snöre		Nej
modellnamn	snöre		Nej

Nästa steg

Lär dig mer om modeller och finjustering med REST-API:et. Läs mer om de underliggande modeller som driver Azure OpenAI.