Microsoft Foundry

API-version: v1

Authentication

Flöde: implicit

Auktoriserings-URL:https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scope:

https://ai.azure.com/.default

Agents

Agenter – skapa agent

POST {endpoint}/agents?api-version=v1

Skapar agenten.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Det unika namn som identifierar agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. – Måste börja och sluta med alfanumeriska tecken. - Kan innehålla bindestreck i mitten – Får inte överstiga 63 tecken. Begränsningar: maxLength: 63	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – listagenter

GET {endpoint}/agents?api-version=v1

Returnerar listan över alla agenter.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Typ	query	No	string Möjliga värden: `prompt`, `hosted`, `container_app`, `workflow`	Filtrera agenter efter typ. Om det inte anges returneras alla agenter.
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – hämta agent

GET {endpoint}/agents/{agent_name}?api-version=v1

Hämtar agenten.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten som ska hämtas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – uppdateringsagent

POST {endpoint}/agents/{agent_name}?api-version=v1

Uppdaterar agenten genom att lägga till en ny version om det finns några ändringar i agentdefinitionen. Om inga ändringar görs returneras den befintliga agentversionen.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten som ska hämtas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – ta bort agent

DELETE {endpoint}/agents/{agent_name}?api-version=v1

Tar bort en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten som ska tas bort.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DeleteAgentResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – uppdatera agenten från manifestet

POST {endpoint}/agents/{agent_name}/import?api-version=v1

Uppdaterar agenten från ett manifest genom att lägga till en ny version om det finns några ändringar i agentdefinitionen. Om inga ändringar görs returneras den befintliga agentversionen.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten som ska uppdateras.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
manifest_id	string	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
parameter_values	object	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – skapa agentversion

POST {endpoint}/agents/{agent_name}/versions?api-version=v1

Skapa en ny agentversion.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Det unika namn som identifierar agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. – Måste börja och sluta med alfanumeriska tecken. - Kan innehålla bindestreck i mitten – Får inte överstiga 63 tecken.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`, `HostedAgents=V1Preview`, `WorkflowAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentVersionObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – lista agentversioner

GET {endpoint}/agents/{agent_name}/versions?api-version=v1

Returnerar listan över versioner av en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten som du vill hämta versioner för.
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – hämta agentversion

GET {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Hämtar en specifik version av en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten som ska hämtas.
agent_version	path	Ja	string	Den version av agenten som ska hämtas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentVersionObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – ta bort agentversion

DELETE {endpoint}/agents/{agent_name}/versions/{agent_version}?api-version=v1

Tar bort en specifik version av en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten som ska tas bort.
agent_version	path	Ja	string	Den version av agenten som ska tas bort
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DeleteAgentVersionResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – skapa agentversion från manifest

POST {endpoint}/agents/{agent_name}/versions:import?api-version=v1

Skapa en ny agentversion från ett manifest.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Det unika namn som identifierar agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. – Måste börja och sluta med alfanumeriska tecken. - Kan innehålla bindestreck i mitten – Får inte överstiga 63 tecken.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
manifest_id	string	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
parameter_values	object	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentVersionObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agenter – skapa agent från manifest

POST {endpoint}/agents:import?api-version=v1

Skapar en agent från ett manifest.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
manifest_id	string	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Det unika namn som identifierar agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. – Måste börja och sluta med alfanumeriska tecken. - Kan innehålla bindestreck i mitten – Får inte överstiga 63 tecken. Begränsningar: maxLength: 63	Ja
parameter_values	object	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar

Agentcontainrar – listagentcontaineråtgärder

GET {endpoint}/agents/{agent_name}/operations?api-version=v1

Lista containeråtgärder för en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – hämta agentcontaineråtgärd

GET {endpoint}/agents/{agent_name}/operations/{operation_id}?api-version=v1

Hämta status för en containeråtgärd för en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
operation_id	path	Ja	string	Åtgärds-ID:t.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentContainerOperationObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – hämta agentcontainer

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default?api-version=v1

Hämta en container för en specifik version av en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
agent_version	path	Ja	string	Versionen av agenten.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentContainerObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – lista agentversionscontaineråtgärder

GET {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default/operations?api-version=v1

Lista containeråtgärder för en specifik version av en agent.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
agent_version	path	Ja	string	Versionen av agenten.
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – ta bort agentcontainer

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:delete?api-version=v1

Ta bort en container för en specifik version av en agent. Om behållaren inte existerar kommer operationen att vara no-op. Åtgärden är en tidskrävande åtgärd. Följ designriktlinjerna för långvariga åtgärder i Azure REST-API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
agent_version	path	Ja	string	Versionen av agenten.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 202

Beskrivning: Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentContainerOperationObject

Svarshuvuden:

Header	Type	Description
Operationsplats	string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – strömma agentcontainerloggar

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:logstream?api-version=v1

Containerloggposten strömmas från containern som textsegment. Varje segment är en UTF-8-sträng som kan vara antingen en oformaterad loggrad eller en JSON-formaterad loggpost, beroende på vilken typ av containerlogg som strömmas. Klienter bör behandla varje segment som ogenomskinlig text och vid behov försöka parsa det som JSON baserat på deras loggningskrav.

För systemloggar, formatet är JSON med följande struktur: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Ansluta till händelseinsamlaren...","Orsak":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Lyckat ansluten till händelser server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

För konsolloggar är formatet oformaterad text som genereras av containerns stdout/stderr. 2025-12-15T08:43:48.72656 Ansluter till containern "agent-container"... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
agent_version	path	Ja	string	Versionen av agenten.
Typ	query	No	string Möjliga värden: `console`, `system`	-konsolen returnerar container stdout/stderr, systemet returnerar containerappens händelseström. standardinställningar för konsolen
replica_name	query	No	string	Om det utelämnas väljer servern den första repliken för konsolloggar. Krävs för att rikta in sig på en specifik replik.
svans	query	No	integer	Antal eftersläpande rader som returneras. Framtvingas till 1–300. Standardvärdet är 20
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – startagentcontainer

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:start?api-version=v1

Starta en container för en specifik version av en agent. Om behållaren redan körs kommer operationen att vara no-op. Åtgärden är en tidskrävande åtgärd. Följ designriktlinjerna för långvariga åtgärder i Azure REST-API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
agent_version	path	Ja	string	Versionen av agenten.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
max_replicas	integer	Det maximala antalet repliker. Standardvärdet är 1.	No	1
min_replicas	integer	Det minsta antalet repliker. Standardvärdet är 1.	No	1

Responses

Statuskod: 202

Beskrivning: Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentContainerOperationObject

Svarshuvuden:

Header	Type	Description
Operationsplats	string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – stoppa agentcontainer

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:stop?api-version=v1

Stoppa en container för en specifik version av en agent. Om behållaren inte körs, eller redan är stoppad, kommer operationen att vara no-op. Åtgärden är en tidskrävande åtgärd. Följ designriktlinjerna för långvariga åtgärder i Azure REST-API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
agent_version	path	Ja	string	Versionen av agenten.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 202

Beskrivning: Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentContainerOperationObject

Svarshuvuden:

Header	Type	Description
Operationsplats	string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Agentcontainrar – uppdatera agentcontainer

POST {endpoint}/agents/{agent_name}/versions/{agent_version}/containers/default:update?api-version=v1

Uppdatera en container för en specifik version av en agent. Om behållaren inte körs kommer operationen att vara no-op. Åtgärden är en tidskrävande åtgärd. Följ designriktlinjerna för långvariga åtgärder i Azure REST-API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Ja	string	Namnet på agenten.
agent_version	path	Ja	string	Versionen av agenten.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `ContainerAgents=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
max_replicas	integer	Det maximala antalet repliker.	No
min_replicas	integer	Det minsta antalet repliker.	No

Responses

Statuskod: 202

Beskrivning: Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Innehållstyp	Type	Beskrivning
application/json	AgentContainerOperationObject

Svarshuvuden:

Header	Type	Description
Operationsplats	string

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Anslutningar

Anslutningar – lista

GET {endpoint}/connections?api-version=v1

Visa en lista över alla anslutningar i projektet, utan att fylla i autentiseringsuppgifterna för anslutningen

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
connectionType	query	No	string Möjliga värden: `AzureOpenAI`, `AzureBlob`, `AzureStorageAccount`, `CognitiveSearch`, `CosmosDB`, `ApiKey`, `AppConfig`, `AppInsights`, , , `CustomKeysRemoteTool_Preview`	Visa en lista över anslutningar av den här specifika typen
defaultConnection	query	No	boolean	Lista anslutningar som är standardanslutningar

Begärandehuvud

Name	Obligatoriskt	Type	Description
x-ms-client-request-id	Falsk	string	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedConnection

Svarshuvuden:

Header	Type	Description
x-ms-client-request-id		En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Anslutningar – hämta

GET {endpoint}/connections/{name}?api-version=v1

Hämta en anslutning efter namn, utan att fylla i autentiseringsuppgifterna för anslutningen

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Det egna namnet på anslutningen, som tillhandahålls av användaren.

Begärandehuvud

Name	Obligatoriskt	Type	Description
x-ms-client-request-id	Falsk	string	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Connection

Svarshuvuden:

Header	Type	Description
x-ms-client-request-id		En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Anslutningar – hämta med autentiseringsuppgifter

POST {endpoint}/connections/{name}/getConnectionWithCredentials?api-version=v1

Hämta en anslutning efter namn med dess autentiseringsuppgifter för anslutningen

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Det egna namnet på anslutningen, som tillhandahålls av användaren.

Begärandehuvud

Name	Obligatoriskt	Type	Description
x-ms-client-request-id	Falsk	string	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Connection

Svarshuvuden:

Header	Type	Description
x-ms-client-request-id		En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Datasets

Datauppsättningar – lista senaste

GET {endpoint}/datasets?api-version=v1

Visa en lista över den senaste versionen av varje DatasetVersion

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedDatasetVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Datauppsättningar – listversioner

GET {endpoint}/datasets/{name}/versions?api-version=v1

Visa en lista över alla versioner av angiven DatasetVersion

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedDatasetVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Datauppsättningar – hämta version

GET {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Hämta den specifika versionen av DatasetVersion. Tjänsten returnerar felet 404 Hittades inte om DatasetVersion inte finns.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Det specifika versions-ID för DatasetVersion som ska hämtas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DatasetVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Datauppsättningar – ta bort version

DELETE {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Ta bort den specifika versionen av DatasetVersion. Tjänsten returnerar 204 Inget innehåll om DatasetVersion har tagits bort eller om DatasetVersion inte finns.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Den version av DatasetVersion som ska tas bort.

Responses

Statuskod: 204

Beskrivning: Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Datauppsättningar – skapa eller uppdatera version

PATCH {endpoint}/datasets/{name}/versions/{version}?api-version=v1

Skapa en ny eller uppdatera en befintlig DatasetVersion med det angivna versions-ID:t

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Det specifika versions-ID:t för DatasetVersion för att skapa eller uppdatera.

Begärandekropp

Innehållstyp: application/merge-patch+json

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	DatasetType	Räkna upp för att fastställa typen av data.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DatasetVersion

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	DatasetVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Datauppsättningar – hämta autentiseringsuppgifter

POST {endpoint}/datasets/{name}/versions/{version}/credentials?api-version=v1

Hämta SAS-autentiseringsuppgifterna för att få åtkomst till lagringskontot som är associerat med en datauppsättningsversion.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Det specifika versions-ID för DatasetVersion som ska användas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	AssetCredentialResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Datauppsättningar – starta väntande uppladdningsversion

POST {endpoint}/datasets/{name}/versions/{version}/startPendingUpload?api-version=v1

Starta en ny eller hämta en befintlig väntande uppladdning av en datauppsättning för en viss version.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Det specifika versions-ID för DatasetVersion som ska användas.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
connectionName	string	Anslutningsnamn för Azure Storage-konto som ska användas för att generera tillfällig SAS-token	No
pendingUploadId	string	Om PendingUploadId inte anges används ett slumpmässigt GUID.	No
pendingUploadType	enum	BlobReference är den enda typ som stöds. Möjliga värden: `BlobReference`	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PendingUploadResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Driftsättningar

Distributioner – lista

GET {endpoint}/deployments?api-version=v1

Visa en lista över alla distribuerade modeller i projektet

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
modelPublisher	query	No	string	Modellutgivare för att filtrera modeller efter
modelName	query	No	string	Modellnamn (utgivarens specifika namn) för att filtrera modeller efter
deploymentType	query	No	string Möjliga värden: `ModelDeployment`	Typ av distribution som ska filtreras efter

Begärandehuvud

Name	Obligatoriskt	Type	Description
x-ms-client-request-id	Falsk	string	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedDeployment

Svarshuvuden:

Header	Type	Description
x-ms-client-request-id		En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Distributioner – hämta

GET {endpoint}/deployments/{name}?api-version=v1

Hämta en distribuerad modell.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namn på distributionen

Begärandehuvud

Name	Obligatoriskt	Type	Description
x-ms-client-request-id	Falsk	string	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Deployment

Svarshuvuden:

Header	Type	Description
x-ms-client-request-id		En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingstaxonomier

Utvärderingstaxonomier – lista

GET {endpoint}/evaluationtaxonomies?api-version=v1

Lista taxonomier för utvärdering

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
inputName	query	No	string	Filtrera efter utvärderingsindatanamnet.
inputType	query	No	string	Filtrera efter taxonomiindatatyp.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedEvaluationTaxonomy

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingstaxonomier – get

GET {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Hämta en utvärderingskörning efter namn.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvaluationTaxonomy

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingstaxonomier – ta bort

DELETE {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Ta bort en utvärderingstaxonomi efter namn.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 204

Beskrivning: Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingstaxonomier – skapa

PUT {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Skapa en utvärderingstaxonomi.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på utvärderingstaxonomi.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
properties	object	Ytterligare egenskaper för utvärderingstaxonomi.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	No
taxonomyInput	EvaluationTaxonomyInput	Indatakonfiguration för utvärderingstaxonomin.	Ja
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomi.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvaluationTaxonomy

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	EvaluationTaxonomy

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingstaxonomier – uppdatering

PATCH {endpoint}/evaluationtaxonomies/{name}?api-version=v1

Uppdatera en utvärderingstaxonomi.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på utvärderingstaxonomi.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
properties	object	Ytterligare egenskaper för utvärderingstaxonomi.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Indatakonfiguration för utvärderingstaxonomin.	No
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomi.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvaluationTaxonomy

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingsregler

Utvärderingsregler – lista

GET {endpoint}/evaluationrules?api-version=v1

Visa en lista över alla utvärderingsregler.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
actionType	query	No	string Möjliga värden: `continuousEvaluation`, `humanEvaluationPreview`	Filtrera efter typ av utvärderingsregel.
agentName (agentnamn)	query	No	string	Filtrera efter handläggarens namn.
enabled	query	No	boolean	Filtrera efter aktiverad status.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedEvaluationRule

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingsregler – hämta

GET {endpoint}/evaluationrules/{id}?api-version=v1

Hämta en utvärderingsregel.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Unik identifierare för utvärderingsregeln.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvaluationRule

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingsregler – ta bort

DELETE {endpoint}/evaluationrules/{id}?api-version=v1

Ta bort en utvärderingsregel.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Unik identifierare för utvärderingsregeln.

Responses

Statuskod: 204

Beskrivning: Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderingsregler – skapa eller uppdatera

PUT {endpoint}/evaluationrules/{id}?api-version=v1

Skapa eller uppdatera en utvärderingsregel.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Unik identifierare för utvärderingsregeln.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	Falsk	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
åtgärd	EvaluationRuleAction	Åtgärdsmodell för utvärdering.	Ja
└– typ	EvaluationRuleActionType	Typ av utvärderingsåtgärd.	Ja
beskrivning	string	Beskrivning av utvärderingsregeln.	No
displayName	string	Visningsnamn för utvärderingsregeln.	No
enabled	boolean	Anger om utvärderingsregeln är aktiverad. Standardvärdet är sant.	Ja
eventType	EvaluationRuleEventType	Typ av utvärderingsregelhändelse.	Ja
filter	EvaluationRuleFilter	Modell för utvärderingsfilter.	No
└– agentName	string	Filtrera efter agentnamn.	Ja
id	sträng (skrivskyddad)	Unik identifierare för utvärderingsregeln.	Ja
systemData	objekt (skrivskyddat)	Systemmetadata för utvärderingsregeln.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvaluationRule

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	EvaluationRule

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderarna

Utvärderare – lista de senaste versionerna

GET {endpoint}/evaluators?api-version=v1

Visa en lista över den senaste versionen av varje utvärderare

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
type	query	No	string Möjliga värden: `builtin`, `custom`, `all`	Filtrera utvärderare efter typ. Möjliga värden: "all", "custom", "builtin".
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedEvaluatorVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderare – listversioner

GET {endpoint}/evaluators/{name}/versions?api-version=v1

Visa en lista över alla versioner av den angivna utvärderaren

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
type	query	No	string Möjliga värden: `builtin`, `custom`, `all`	Filtrera utvärderare efter typ. Möjliga värden: "all", "custom", "builtin".
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan vara mellan 1 och 100 och standardvärdet är 20.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedEvaluatorVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderare – skapa version

POST {endpoint}/evaluators/{name}/versions?api-version=v1

Skapa en ny EvaluatorVersion med automatiskt ökat versions-ID

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
categories	matris med EvaluatorCategory	Utvärderarens kategorier	Ja
definitionen	EvaluatorDefinition	Konfiguration av basutvärderare med diskriminator	Ja
└– data_schema	object	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
└– init_parameters	object	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
└– mått	object	Förteckning över utfallsmått som tagits fram av den här utvärderaren	No
└– typ	EvaluatorDefinitionType	Definition av typ av utvärderare	Ja
beskrivning	string	Texten för tillgångsbeskrivningen.	No
display_name	string	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	No
evaluator_type	EvaluatorType	Typ av utvärderare	Ja
metadata	object	Metadata om utvärderaren	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No

Responses

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	EvaluatorVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderare – hämta version

GET {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Hämta den specifika versionen av EvaluatorVersion. Tjänsten returnerar felet 404 Not Found om EvaluatorVersion inte finns.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Det specifika versions-ID för EvaluatorVersion som ska hämtas.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvaluatorVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderare – ta bort version

DELETE {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Ta bort den specifika versionen av EvaluatorVersion. Tjänsten returnerar 204 Inget innehåll om EvaluatorVersion har tagits bort eller om EvaluatorVersion inte finns.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Den version av EvaluatorVersion som ska tas bort.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 204

Beskrivning: Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Utvärderare – uppdateringsversion

PATCH {endpoint}/evaluators/{name}/versions/{version}?api-version=v1

Uppdatera en befintlig EvaluatorVersion med det angivna versions-ID:t

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Den version av EvaluatorVersion som ska uppdateras.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Evaluations=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
categories	matris med EvaluatorCategory	Utvärderarens kategorier	No
beskrivning	string	Texten för tillgångsbeskrivningen.	No
display_name	string	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	No
metadata	object	Metadata om utvärderaren	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvaluatorVersion

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Indexen

Index – lista senaste

GET {endpoint}/indexes?api-version=v1

Visa en lista över den senaste versionen av varje index

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedIndex

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Index – listversioner

GET {endpoint}/indexes/{name}/versions?api-version=v1

Visa en lista över alla versioner av det angivna indexet

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedIndex

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Index – hämta version

GET {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Hämta den specifika versionen av indexet. Tjänsten returnerar felet 404 Hittades inte om indexet inte finns.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Det specifika versions-ID för indexet som ska hämtas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Index

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Index – ta bort version

DELETE {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Ta bort den specifika versionen av indexet. Tjänsten returnerar 204 Inget innehåll om indexet har tagits bort eller om indexet inte finns.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Den version av indexet som ska tas bort.

Responses

Statuskod: 204

Beskrivning: Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Index – skapa eller uppdatera version

PATCH {endpoint}/indexes/{name}/versions/{version}?api-version=v1

Skapa ett nytt eller uppdatera ett befintligt index med det angivna versions-ID:t

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Namnet på resursen
version	path	Ja	string	Det specifika versions-ID för indexet som ska skapas eller uppdateras.

Begärandekropp

Innehållstyp: application/merge-patch+json

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	IndexType		Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Index

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	Index

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Insights

Insikter – generera

POST {endpoint}/insights?api-version=v1

Generera insikter

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Insights=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.
Repeterbarhet –Request-ID	Falsk	string	Unik, klientgenererad identifierare för att säkerställa idempotens för begäran. Använd samma ID för återförsök för att förhindra duplicerade utvärderingar.
Repeterbarhet –First-Sent	Falsk	string	Tidsstämpel som anger när den här begäran först initierades. Används tillsammans med repeterbarhetsbegäran-id för idempotenskontroll.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
displayName	string	Användarvänligt visningsnamn för insikten.	Ja
id	sträng (skrivskyddad)	Den unika identifieraren för insiktsrapporten.	Ja
metadata	InsightsMetadata (skrivskyddad)	Metadata om insikterna.	Ja
└– slutfördAt	string	Tidsstämpeln när insikterna slutfördes.	No
└– skapadAt	string	Tidsstämpeln när insikterna skapades.	Ja
request	InsightRequest	Begäran om insiktsrapporten.	Ja
└– typ	InsightType	Typ av begäran.	Ja
result	InsightResult (skrivskyddad)	Resultatet av insikterna.	No
└– typ	InsightType	Typen av insikter resultat.	Ja
state	Azure. Core.Foundations.OperationState (skrivskyddad)	Uppräkning som beskriver tillåtna åtgärdstillstånd.	Ja

Responses

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	Insikt

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Insikter – lista

GET {endpoint}/insights?api-version=v1

Visa en lista över alla insikter i omvänd kronologisk ordning (den senaste först).

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
type	query	No	string Möjliga värden: `EvaluationRunClusterInsight`, `AgentClusterInsight`, `EvaluationComparison`	Filtrera efter typ av analys.
evalId	query	No	string	Filtrera efter utvärderings-ID.
runId	query	No	string	Filtrera efter utvärderingskörnings-ID:t.
agentName (agentnamn)	query	No	string	Filtrera efter handläggarens namn.
includeCoordinates	query	No	boolean	Om du vill inkludera koordinater för visualisering i svaret. Standardvärdet är falskt.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Insights=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedInsight

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Insikter – hämta

GET {endpoint}/insights/{id}?api-version=v1

Få en specifik insikt per ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Den unika identifieraren för insiktsrapporten.
includeCoordinates	query	No	boolean	Om du vill inkludera koordinater för visualisering i svaret. Standardvärdet är falskt.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Insights=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Insikt

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Minneslager

Skapa minneslager

POST {endpoint}/memory_stores?api-version=v1

Skapa ett minneslager.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
definitionen	MemoryStoreDefinition	Grundläggande definition för minneslagringskonfigurationer.	Ja
└– typ	MemoryStoreKind	Den typ av minneslagring.	Ja
beskrivning	string	En beskrivning av minnesarkivet som kan läsas av människor. Begränsningar: maxLength: 512	No
metadata	object	Godtyckliga nyckelvärdesmetadata som ska associeras med minnesarkivet.	No
name	string	Namnet på minnesarkivet. Begränsningar: maxLength: 256	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	MemoryStoreObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Lista minnesenheter

GET {endpoint}/memory_stores?api-version=v1

Visa en lista över alla minneslager.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Uppdatera minnesarkiv

POST {endpoint}/memory_stores/{name}?api-version=v1

Uppdatera ett minneslager.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Ja	string	Namnet på minnesarkivet som ska uppdateras.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
beskrivning	string	En beskrivning av minnesarkivet som kan läsas av människor. Begränsningar: maxLength: 512	No
metadata	object	Godtyckliga nyckelvärdesmetadata som ska associeras med minnesarkivet.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	MemoryStoreObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Hämta minnesarkiv

GET {endpoint}/memory_stores/{name}?api-version=v1

Hämta ett minneslager.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Ja	string	Namnet på minnesarkivet som ska hämtas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	MemoryStoreObject

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Ta bort minnesarkiv

DELETE {endpoint}/memory_stores/{name}?api-version=v1

Ta bort ett minneslager.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Ja	string	Namnet på minnesarkivet som ska tas bort.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DeleteMemoryStoreResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Hämta uppdateringsresultat

GET {endpoint}/memory_stores/{name}/updates/{update_id}?api-version=v1

Hämta uppdateringsresultat för minneslagret.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Ja	string	Namnet på minnesarkivet.
update_id	path	Ja	string	ID för minnesuppdateringsåtgärden.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	MemoryStoreUpdateResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Ta bort omfångsminnen

POST {endpoint}/memory_stores/{name}:delete_scope?api-version=v1

Ta bort alla minnen som är associerade med ett specifikt omfång från ett minneslager.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Ja	string	Namnet på minnesarkivet.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
scope	string	Namnområdet som logiskt grupperar och isolerar minnen att ta bort, till exempel ett användar-ID.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	MemoryStoreDeleteScopeResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Sökminnen

POST {endpoint}/memory_stores/{name}:search_memories?api-version=v1

Sök efter relevanta minnen från ett minneslager baserat på konversationskontext.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Ja	string	Namnet på minnesarkivet som ska sökas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
items	matris med OpenAI.InputItem	Objekt som du kan söka efter relevanta minnen för.	No
options	MemorySearchOptions	Alternativ för minnessökning.	No
└max_memories	integer	Maximalt antal minnesobjekt som ska returneras.	No
previous_search_id	string	Det unika ID:t för den tidigare sökbegäran, vilket möjliggör inkrementell minnessökning där den senaste åtgärden slutade.	No
scope	string	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	MemoryStoreSearchResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Uppdatera minnen

POST {endpoint}/memory_stores/{name}:update_memories?api-version=v1

Uppdatera minneslagret med konversationsminnen.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
name	path	Ja	string	Namnet på minnesarkivet som ska uppdateras.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `MemoryStores=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
items	matris med OpenAI.InputItem	Konversationsobjekt som du kan extrahera minnen från.	No
previous_update_id	string	Det unika ID:t för den tidigare uppdateringsbegäran, vilket aktiverar inkrementella minnesuppdateringar där den senaste åtgärden slutade.	No
scope	string	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja
update_delay	integer	Tidsgränsperiod innan minnesuppdateringen bearbetas i sekunder. Om en ny uppdateringsbegäran tas emot under den här perioden avbryts den aktuella begäran och tidsgränsen återställs. Ange till 0 för att omedelbart utlösa uppdateringen utan fördröjning. Standardvärdet är 300 (5 minuter).	No	300

Responses

Statuskod: 202

Beskrivning: Begäran har godkänts för bearbetning, men bearbetningen har ännu inte slutförts.

Innehållstyp	Type	Beskrivning
application/json	MemoryStoreUpdateResponse

Svarshuvuden:

Header	Type	Description
Operationsplats	string	Platsen för övervakning av åtgärdstillståndet.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Konversationer

Skapa konversation

POST {endpoint}/openai/v1/conversations

Skapa en konversation.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
items	matris med OpenAI.InputItem		No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ConversationResource

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Lista konversationer

GET {endpoint}/openai/v1/conversations

Returnerar listan över alla konversationer.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
agent_name	query	No	string	Filtrera efter agentnamn. Om det tillhandahålls returneras endast objekt som är associerade med den angivna agenten.
agent_id	query	No	string	Filtrera efter agent-ID i formatet `name:version`. Om detta anges returneras endast objekt som är associerade med det angivna agent-ID:t.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Uppdatera konversation

POST {endpoint}/openai/v1/conversations/{conversation_id}

Uppdatera en konversation.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	string	ID:t för konversationen som ska uppdateras.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ConversationResource

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Hämta konversation

GET {endpoint}/openai/v1/conversations/{conversation_id}

Hämtar en konversation.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	string	ID för konversationen som ska hämtas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ConversationResource

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Ta bort konversation

DELETE {endpoint}/openai/v1/conversations/{conversation_id}

Tar bort en konversation.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	string	ID:t för konversationen som ska tas bort.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.DeletedConversationResource

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Skapa konversationsobjekt

POST {endpoint}/openai/v1/conversations/{conversation_id}/items

Skapa objekt i en konversation med det angivna ID:t.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	string	ID för konversationen där objektet måste skapas.
include	query	No	Array	Ytterligare fält som ska inkluderas i svaret. Mer information finns i parametern `include` för att visa konversationsobjekt.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
items	matris med OpenAI.Item	De objekt som ska läggas till i konversationen. Du kan lägga till upp till 20 objekt åt gången.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ConversationItemList

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Lista konversationsobjekt

GET {endpoint}/openai/v1/conversations/{conversation_id}/items

Visa en lista över alla objekt för en konversation med det angivna ID:t.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	string	ID:t för konversationen där objekten måste visas.
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
item_type	query	No	string Möjliga värden: `message`, `output_message`, `file_search_call`, `computer_call`, `computer_call_output`, `web_search_call`, `function_call`, `function_call_output`, `reasoning`, `compaction`, , `image_generation_call`, `code_interpreter_calllocal_shell_call`, , `local_shell_call_outputshell_callshell_call_outputapply_patch_call`, `apply_patch_call_output`, `mcp_list_tools`, `mcp_approval_request`, `mcp_approval_responsemcp_call`, `custom_tool_call_output`, `custom_tool_call`, `structured_outputs`, `oauth_consent_request`, , , `memory_search_callworkflow_action`	Filtrera efter objekttyp. Om det anges returneras endast objekt av den angivna typen.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Hämta konversationsobjekt

GET {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Hämta ett enskilt objekt från en konversation med de angivna ID:na.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	string	ID för konversationen som innehåller objektet.
item_id	path	Ja	string	ID:t för konversationsobjektet som ska hämtas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.OutputItem

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Ta bort konversationsobjekt

DELETE {endpoint}/openai/v1/conversations/{conversation_id}/items/{item_id}

Ta bort ett objekt från en konversation med de angivna ID:na.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Ja	string	ID:t för konversationen som objektet måste tas bort från.
item_id	path	Ja	string	ID:t för konversationsobjektet som ska tas bort.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ConversationResource

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals

Evals – lista evals

GET {endpoint}/openai/v1/evals

Lista alla utvärderingar Lista utvärderingar för ett projekt.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Efter	query	No	string	Identifier för den senaste sökningen från föregående pagineringsbegäran.
limit	query	No	integer	Antal körningar som ska hämtas.
order	query	No	string 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`.
sortera_efter	query	No	string 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.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – skapa eval

POST {endpoint}/openai/v1/evals

Skapa utvärdering 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 konfigurationen för en datakälla, som avgör schemat för de data som används i utvärderingen. 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. Mer information finns i

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
datakällkonfiguration	OpenAI.CreateEvalCustomDataSourceConfig eller OpenAI.CreateEvalLogsDataSourceConfig eller OpenAI.CreateEvalStoredCompletionsDataSourceConfig eller AzureAIDataSourceConfig	Konfigurationen för den datakälla som används för utvärderingen körs. Avgör schemat för de data som används i utvärderingen.	Ja
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Namnet på utvärderingen.	No
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No
testkriterier	matris med OpenAI.EvalGraderLabelModel eller OpenAI.EvalGraderStringCheck eller OpenAI.EvalGraderTextSimilarity eller OpenAI.EvalGraderPython eller OpenAI.EvalGraderScoreModel eller EvalGraderAzureAIEvaluator	En lista över bedömare för alla utvärderingskörningar i den här gruppen. Graders kan referera till variabler i datakällan med hjälp av dubbla klammerparenteser, till exempel `{{item.variable_name}}`. Om du vill referera till modellens utdata använder du `sample` namnområdet (dvs. `{{sample.output_text}}`).	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Eval

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – ta bort eval

DELETE {endpoint}/openai/v1/evals/{eval_id}

Ta bort en utvärdering Ta bort en utvärdering.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som ska tas bort.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DeleteEvalResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – hämta eval

GET {endpoint}/openai/v1/evals/{eval_id}

Hämta en utvärdering Få en utvärdering efter ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som ska hämtas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Eval

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – uppdatera eval

POST {endpoint}/openai/v1/evals/{eval_id}

Uppdatera en utvärdering Uppdatera vissa egenskaper för en utvärdering.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som ska uppdateras.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string		No
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Eval

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – listkörningar

GET {endpoint}/openai/v1/evals/{eval_id}/runs

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

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som ska hämtas för.
Efter	query	No	string	Identifier för den senaste sökningen från föregående pagineringsbegäran.
limit	query	No	integer	Antal körningar som ska hämtas.
order	query	No	string 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`.
status	query	No	string Möjliga värden: `queued`, `in_progress`, `completed`, `canceled`, `failed` . Filtrera körningar efter status. En av `queued`, `in_progress`, `failed`, `completed`, `canceled`.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – skapa eval-körning

POST {endpoint}/openai/v1/evals/{eval_id}/runs

Skapa utvärderingskörning

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som du vill skapa en körning för.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
datakälla	OpenAI.CreateEvalJsonlRunDataSource eller OpenAI.CreateEvalCompletionsRunDataSource eller OpenAI.CreateEvalResponsesRunDataSource eller EvalRunDataSource	Information om körningens datakälla.	Ja
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Namnet på körningen.	No
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvalRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – ta bort eval-körning

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Ta bort utvärderingskörning Ta bort en eval-körning.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som körningen ska tas bort från.
run_id	path	Ja	string	ID för den körning som ska tas bort.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DeleteEvalRunResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – hämta eval-körning

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

Hämta en utvärderingskörning Hämta en utvärdering som körs med ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som ska hämtas för.
run_id	path	Ja	string	ID:t för körningen som ska hämtas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvalRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – avbryt eval-körning

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

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

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för den utvärdering vars körning du vill avbryta.
run_id	path	Ja	string	ID för körningen som ska avbrytas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvalRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – hämta utdataobjekt för eval-körning

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

Hämta utdataobjekt för utvärderingskörning Hämta en lista över utdataobjekt för en utvärderingskörning.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string
run_id	path	Ja	string	ID för körningen för att hämta utdataobjekt för.
Efter	query	No	string	Identifier för den senaste sökningen från föregående pagineringsbegäran.
limit	query	No	integer	Antal körningar som ska hämtas.
order	query	No	string 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`.
status	query	No	string Möjliga värden: `fail`, `pass`	Filtrera utdataobjekt efter status. Använd `failed` för att filtrera efter misslyckade utdata objekt eller `pass` för att filtrera efter skickade utdataobjekt.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Evals – hämta utdataobjekt för eval-körning

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

Hämta ett utdataobjekt från en utvärderingskörning Hämta ett utdataobjekt för utvärderingskörning efter ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Ja	string	ID:t för utvärderingen som ska hämtas för.
run_id	path	Ja	string	ID:t för körningen som ska hämtas.
utdata_objekt_id	path	Ja	string	ID:t för utdataobjektet som ska hämtas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	EvalRunOutputItem

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Fine-Tuning

Skapa finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

Skapar ett finjusteringsjobb som påbörjar processen med att skapa en ny modell från en viss datauppsättning.

Svaret innehåller information om det köade jobbet, inklusive jobbstatus och namnen på de finjusterade modellerna när de är klara.

Läs mer om finjustering

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
hyperparametrar	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└– batch_size	string eller OpenAI.integer		No	bil
└– inlärningshastighetsmultiplikator	string eller OpenAI.numeric		No
└– n_epochs	string eller OpenAI.integer		No	bil
Integrationer	matris med OpenAI.CreateFineTuningJobRequestIntegrations	En lista över integreringar som ska aktiveras för ditt finjusteringsjobb.	No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
method	OpenAI.FineTuneMethod	Metoden som används för finjustering.	No
model	sträng (se giltiga modeller nedan)	Namnet på modellen som ska finjusteras. Du kan välja en av de modeller som stöds.	Ja
seed	OpenAI.integer (nullbar)		No
Suffix	sträng (nullbar)	En sträng på upp till 64 tecken som läggs till i ditt finjusterade modellnamn. Till exempel skulle en `suffix` av "custom-model-name" generera ett modellnamn som `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Begränsningar: minLength: 1, maxLength: 64	No
utbildningsfil	string	ID för en uppladdad fil som innehåller träningsdata. Se ladda upp en fil för att ladda upp en fil. Datamängden måste formateras som en JSONL-fil. Dessutom måste du ladda upp filen med syftet `fine-tune`. Innehållet i filen bör variera beroende på om modellen använder chattformatet, slutförandeformatet eller om finjusteringsmetoden använder inställningsformatet. Mer information finns i finjusteringsguiden .	Ja
validation_file	sträng (nullbar)	ID för en uppladdad fil som innehåller valideringsdata. Om du anger den här filen används data för att generera validering mätvärden under finjusteringen regelbundet. Dessa mått kan visas i finjusteringsresultatfilen. Samma data bör inte finnas i både tränings- och valideringsfiler. Datamängden måste formateras som en JSONL-fil. Du måste ladda upp filen med syftet `fine-tune`. Mer information finns i finjusteringsguiden .	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Lista sidnumrerade finjusteringsjobb

GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1

Visa en lista över organisationens finjusteringsjobb

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
Efter	query	No	string	Identifikator för det senaste jobbet från föregående pagineringsförfrågan.
limit	query	No	integer	Antal finjusteringsjobb som ska hämtas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Hämta finjusteringsjobb

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1

Få information om ett finjusteringsjobb.

Läs mer om finjustering

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finjusteringsjobb_id	path	Ja	string	ID för finjusteringsjobbet.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Avbryt finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1

Avbryt finjusteringsjobb omedelbart.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finjusteringsjobb_id	path	Ja	string	ID:t för det finjusteringsjobb som ska avbrytas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Visa en lista över finjusteringsjobbkontrollpunkter

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1

Lista kontrollpunkter för ett finjusteringsjobb.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finjusteringsjobb_id	path	Ja	string	ID:t för det finjusteringsjobb som du vill hämta kontrollpunkter för.
Efter	query	No	string	Identifierare för det senaste kontrollpunkts-ID:t från föregående sidnumreringsbegäran.
limit	query	No	integer	Antal kontrollpunkter som ska hämtas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Visa en lista över finjusterande jobbhändelser

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1

Få detaljerade statusuppdateringar för ett finjusteringsjobb.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finjusteringsjobb_id	path	Ja	string	ID:t för det finjusteringsjobb som händelser ska hämtas för.
Efter	query	No	string	Identifierare för den senaste händelsen från föregående sidnumreringsbegäran.
limit	query	No	integer	Antal händelser som ska hämtas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.ListFineTuningJobEventsResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Pausa finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1

Pausa ett finjusterat jobb som körs.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finjusteringsjobb_id	path	Ja	string	ID för den finjusteringsuppgift som ska pausas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Återuppta finjusteringsjobb

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1

Återuppta ett pausat finjusteringsjobb.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
finjusteringsjobb_id	path	Ja	string	ID:t för det finjusteringsjobb som ska återupptas.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.FineTuningJob

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Responses

Skapa svar – skapa svarsström

POST {endpoint}/openai/v1/responses

Skapar ett modellsvar. Skapar ett modellsvar (direktuppspelningssvar).

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
bakgrund	boolesk (nullbar)		No
konversation	OpenAI.ConversationParam (nullbar)	Konversationen som det här svaret tillhör. Objekt från den här konversationen förbereds för `input_items` den här svarsbegäran. Indataobjekt och utdataobjekt från det här svaret läggs automatiskt till i den här konversationen när det här svaret har slutförts.	No
include	matris med OpenAI.IncludeEnum		No
Input	OpenAI.InputParam	Text, bild eller filindata till modellen, som används för att generera ett svar. Lära sig mer: - Textindata och utdata - Bildindata - Filindata - Konversationstillstånd - Funktionsanrop	No
instructions	sträng (nullbar)		No
max_output_tokens	OpenAI.integer (nullbar)		No
max_verktygs_anrop	OpenAI.integer (nullbar)		No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
model	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
parallella verktygsanrop	boolesk (nullbar)		No	True
previous_response_id	sträng (nullbar)		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
reasoning	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└— insats	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
└– generate_summary	enum	Möjliga värden: `auto`, `concise`, `detailed`	No
└— sammanfattning	enum	Möjliga värden: `auto`, `concise`, `detailed`	No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
servicenivå	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
Lagra	boolesk (nullbar)		No	True
stream	boolesk (nullbar)		No
stream_options	OpenAI.ResponseStreamOptions (nullbar)	Alternativ för direktuppspelningssvar. Ange endast detta när du anger `stream: true`.	No
└– include_obfuscation	boolean	När det är sant aktiveras fördunkling av dataströmmar. Dataströmfördunkling lägger till slumpmässiga tecken till ett `obfuscation` fält vid strömmande deltahändelser till normalisera nyttolaststorlekar som en åtgärd för vissa sidokanalattacker. Dessa fördunklingsfält ingår som standard, men lägger till en liten mängd omkostnader för dataströmmen. Du kan ställa in `include_obfuscation` på false för att optimera bandbredden om du litar på nätverkslänkarna mellan ditt program och OpenAI-API:et.	No
structured_inputs	object	Strukturerade indata till svaret som kan delta i frågemallsersättning eller verktygsargumentbindningar.	No
Temperatur	OpenAI.numeric (nullbar)		No	1
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
top_logprobs	OpenAI.integer (nullbar)		No
top_p	OpenAI.numeric (nullbar)		No	1
truncation	enum	Möjliga värden: `auto`, `disabled`	No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Lista svar

GET {endpoint}/openai/v1/responses

Returnerar listan över alla svar.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.
agent_name	query	No	string	Filtrera efter agentnamn. Om det tillhandahålls returneras endast objekt som är associerade med den angivna agenten.
agent_id	query	No	string	Filtrera efter agent-ID i formatet `name:version`. Om detta anges returneras endast objekt som är associerade med det angivna agent-ID:t.
conversation_id	query	No	string	Filtrera efter konversations-ID. Om det tillhandahålls returneras endast svar som är associerade med den angivna konversationen.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Kompakt svarskonversation

POST {endpoint}/openai/v1/responses/compact

Genererar en komprimering av en svarskonversation.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
Input	sträng eller matris med OpenAI.InputItem		No
instructions	sträng (nullbar)		No
model	OpenAI.ModelIdsCompaction	Modell-ID som används för att generera svaret, till exempel `gpt-5` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestandaegenskaper och prispunkter. Se modellguiden för att bläddra bland och jämföra tillgängliga modeller.	Ja
previous_response_id	sträng (nullbar)		No

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.CompactResource

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Hämta svar – hämta svarsström

GET {endpoint}/openai/v1/responses/{response_id}

Hämtar ett modellsvar med angivet ID. Hämtar ett modellsvar med angivet ID (direktuppspelningssvar).

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	string
include[]	query	No	Array
stream	query	No	boolean
starting_after	query	No	integer

Begärandehuvud

Name	Obligatoriskt	Type	Description
acceptera	Falsk	string Möjliga värden: `text/event-stream`

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Ta bort svar

DELETE {endpoint}/openai/v1/responses/{response_id}

Tar bort ett modellsvar.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	string	ID:t för svaret som ska tas bort.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	DeleteResponseResult

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Avbryt svar

POST {endpoint}/openai/v1/responses/{response_id}/cancel

Avbryter ett modellsvar.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	string	ID:t för svaret som ska avbrytas.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	OpenAI.Response

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Lista indataobjekt

GET {endpoint}/openai/v1/responses/{response_id}/input_items

Returnerar en lista över indataobjekt för ett givet svar.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Ja	string
limit	query	No	integer	En gräns för hur många objekt som ska returneras. Gränsen kan sträcka sig mellan 1 och 100, och standardvärdet är 20.
order	query	No	string Möjliga värden: `asc`, `desc`	Sortera ordning efter `created_at` tidsstämpeln för objekten. `asc` för stigande ordning och`desc` för fallande ordning.
Efter	query	No	string	En markör för användning i paginering. `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 efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	No	string	En markör för användning i paginering. `before` ä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 efterföljande anrop kan innehålla before=obj_foo för att hämta föregående sida i listan.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	object	Svarsdata för en begärd lista över objekt.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Redteams

Redteams – lista

GET {endpoint}/redTeams/runs?api-version=v1

Lista ett redteam efter namn.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `RedTeams=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedRedTeam

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Redteams – ta

GET {endpoint}/redTeams/runs/{name}?api-version=v1

Hämta ett redteam efter namn.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
name	path	Ja	string	Identifierare för den röda teamkörningen.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `RedTeams=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	RedTeam

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Redteams – skapa

POST {endpoint}/redTeams/runs:run?api-version=v1

Skapar en redteam-körning.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `RedTeams=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt	Standardinställning
applicationScenario	string	Programscenario för den röda teamåtgärden för att generera scenariospecifika attacker.	No
attackStrategies	matris med AttackStrategy	Lista över attackstrategier eller kapslade listor över attackstrategier.	No
displayName	string	Namnet på red-team-körningen.	No
id	sträng (skrivskyddad)	Identifierare för den röda teamkörningen.	Ja
numTurns	integer	Antal simuleringsrundor.	No
properties	object	Red-teamets egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	No
riskCategories	matris med RiskCategory	Lista över riskkategorier som ska generera attackmål för.	No
simulationOnly	boolean	Endast simulering eller simulering + utvärdering. Standard falskt, om sant genomsökningen utdata konversationen inte utvärderingsresultat.	No	Falsk
status	sträng (skrivskyddad)	Status för det röda teamet. Den anges efter tjänst och är skrivskyddad.	No
tags	object	Röda teamets taggar. Till skillnad från egenskaper är taggar helt föränderliga.	No
target	TargetConfig	Abstrakt klass för målkonfiguration.	Ja
└– typ	string	Typ av modellkonfiguration.	Ja

Responses

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	RedTeam

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Schedules

Scheman – lista

GET {endpoint}/schedules?api-version=v1

Visa en lista över alla scheman.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
type	query	No	string Möjliga värden: `Evaluation`, `Insight`	Filtrera efter typ av schema.
enabled	query	No	boolean	Filtrera efter aktiverad status.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Schedules=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedSchedule

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Scheman – ta bort

DELETE {endpoint}/schedules/{id}?api-version=v1

Ta bort ett schema.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Identifierare för schemat.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Schedules=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 204

Beskrivning: Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Scheman – hämta

GET {endpoint}/schedules/{id}?api-version=v1

Hämta ett schema efter ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Identifierare för schemat.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Schedules=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Schedule

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Scheman – skapa eller uppdatera

PUT {endpoint}/schedules/{id}?api-version=v1

Skapa eller uppdatera åtgärdsmall.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Identifierare för schemat.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Schedules=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Begärandekropp

Innehållstyp: program/json

Name	Type	Description	Obligatoriskt
beskrivning	string	Beskrivning av schemat.	No
displayName	string	Namnet på schemat.	No
enabled	boolean	Aktiverat status för schemat.	Ja
id	sträng (skrivskyddad)	Identifierare för schemat.	Ja
properties	object	Schemans egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	No
Provisioneringsstatus	ScheduleProvisioningStatus (skrivskyddad)	Status för schemaläggning av etablering.	No
systemData	objekt (skrivskyddat)	Systemmetadata för resursen.	Ja
tags	object	Schemataggar. Till skillnad från egenskaper är taggar helt föränderliga.	No
uppgift	ScheduleTask	Schemalägg uppgiftsmodell.	Ja
└– konfiguration	object	Konfiguration för uppgiften.	No
└– typ	ScheduleTaskType	Typ av uppgift.	Ja
trigger	Trigger	Basmodell för utlösare av schemat.	Ja
└– typ	TriggerType	Typ av utlösare.	Ja

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	Schedule

Statuskod: 201

Beskrivning: Begäran har slutförts och en ny resurs har skapats som ett resultat.

Innehållstyp	Type	Beskrivning
application/json	Schedule

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Scheman – listkörningar

GET {endpoint}/schedules/{id}/runs?api-version=v1

Visa en lista över alla schemakörningar.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.
id	path	Ja	string	Identifierare för schemat.
type	query	No	string Möjliga värden: `Evaluation`, `Insight`	Filtrera efter typ av schema.
enabled	query	No	boolean	Filtrera efter aktiverad status.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Schedules=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	PagedScheduleRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	Azure. Core.Foundations.ErrorResponse

Svarshuvuden:

Header	Type	Description
x-ms-error-code	string	Kod för strängfel som anger vad som gick fel.

Scheman – hämta körning

GET {endpoint}/schedules/{schedule_id}/runs/{run_id}?api-version=v1

Hämta ett schema som körs med ID.

URI parametrar

Name	In	Obligatoriskt	Type	Description
endpoint	path	Ja	string	Foundry Project slutpunkt i formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Om du bara har en Project i din Foundry Hub eller för att rikta in dig på standard-Project i hubben använder du formuläret "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	path	Ja	string	Den unika identifieraren för schemat.
run_id	path	Ja	string	Den unika identifieraren för schemakörningen.
API-version	query	Ja	string	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatoriskt	Type	Description
Foundry-Features	True	string Möjliga värden: `Schedules=V1Preview`	En funktionsflagga krävs när du använder förhandsgranskningsåtgärder eller ändrar resurser för bevarad förhandsversion.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	ScheduleRun

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Components

A2APreviewTool

En agent som implementerar A2A-protokollet.

Name	Type	Description	Obligatoriskt
agent_card_path	string	Sökvägen till handläggarkortet i förhållande till `base_url`. Om det inte anges är standardvärdet `/.well-known/agent-card.json`	No
base_url	string	Bas-URL för agenten.	No
project_connection_id	string	Anslutnings-ID:t i project för A2A-servern. Anslutningen lagrar autentisering och annan anslutningsinformation som behövs för att ansluta till A2A-servern.	No
type	enum	Verktygets typ. Alltid `"a2a_preview`. Möjliga värden: `a2a_preview`	Ja

AISearchIndexResource

En resurs för AI-sökindex.

Name	Type	Description	Obligatoriskt
filter	string	filtersträng för sökresurs. Mer information finns här.	No
index_asset_id	string	Indextillgångs-ID för sökresurs.	No
indexnamn	string	Namnet på ett index i ett IndexResource som är kopplat till den här agenten.	No
project_connection_id	string	Ett indexanslutnings-ID i ett IndexResource som är kopplat till den här agenten.	No
frågetyp	AzureAISearchQueryType	Tillgängliga frågetyper för Azure AI-sökning-verktyget.	No
top_k	integer	Antal dokument som ska hämtas från sökningen och presenteras för modellen.	No

AgentClusterInsightRequest

Insikter om resultaten av agentutvärderingen

Name	Type	Description	Obligatoriskt
agentName (agentnamn)	string	Identifierare för agenten.	Ja
modelConfiguration	InsightModelConfiguration	Konfiguration av modellen som används i insiktsgenereringen.	No
└– modelDeploymentName	string	Modelldistributionen som ska utvärderas. Accepterar antingen distributionsnamnet ensamt eller med anslutningsnamnet som `{connectionName}/<modelDeploymentName>`.	Ja
type	enum	Typ av begäran. Möjliga värden: `AgentClusterInsight`	Ja

AgentClusterInsightResult

Insikter från agentklusteranalysen.

Name	Type	Description	Obligatoriskt	Standardinställning
clusterInsight	ClusterInsightResult	Insikter från klusteranalysen.	Ja
type	enum	Typen av insikter resultat. Möjliga värden: `AgentClusterInsight`	Ja

AgentContainerObject

Information om containern för en specifik version av en agent.

Name	Type	Description	Obligatoriskt
container	ContainerDetails (skrivskyddad)	Detaljerad information om containern.	No
└– health_state	string	Hälsotillståndet för containern.	Ja
└– provisioning_error	string	Om det finns ett etableringsfel för containern.	No
└– provisioning_state	string	Containerns etableringstillstånd.	Ja
└– repliker	matris med ContainerReplica	Listan över repliker i containern.	Ja
└— tillstånd	string	Containerns tillstånd.	Ja
└– updated_on	string	Den senaste uppdateringstiden för containern.	Ja
skapad_tid	string	Skapandetiden för containern.	Ja
error_message	sträng (skrivskyddad)	Felmeddelandet om containern inte kunde fungera, om det finns några.	No
id	sträng (skrivskyddad)	Containerns identifierare.	No
max_replicas	integer	Det maximala antalet repliker för containern. Standard är 1.	No
min_replicas	integer	Det minsta antalet repliker för containern. Standard är 1.	No
object	enum	Objekttypen, som alltid är "agent.container". Möjliga värden: `agent.container`	Ja
status	AgentContainerStatus (skrivskyddad)	Status för containern för en viss version av en agent.	Ja
updated_at	string	Den senaste uppdateringstiden för containern.	Ja

AgentContainerOperationError

Om det finns felinformation om containeråtgärden.

Name	Type	Description	Obligatoriskt
code	string	Om det finns någon felkod för containeråtgärden.	Ja
message	string	Felmeddelandet för containeråtgärden, om det finns något.	Ja
type	string	Om det finns någon feltyp för containeråtgärden.	Ja

AgentContainerOperationObject

Containeråtgärden för en specifik version av en agent.

Name	Type	Description	Obligatoriskt
agent_id	string	ID på agenten.	Ja
agent_version_id	string	ID för agentversionen.	Ja
container	AgentContainerObject	Information om containern för en specifik version av en agent.	No
└– container	ContainerDetails (skrivskyddad)	Den detaljerade containerinformationen.	No
└– created_at	sträng (skrivskyddad)	Skapandetiden för containern.	Ja
└– error_message	sträng (skrivskyddad)	Felmeddelandet om containern inte kunde fungera, om det finns några.	No
└– id	sträng (skrivskyddad)	Containerns identifierare.	No
└– max_replicas	integer	Det maximala antalet repliker för containern. Standard är 1.	No
└– min_replicas	integer	Det minsta antalet repliker för containern. Standard är 1.	No
└– objekt	enum	Objekttypen, som alltid är "agent.container". Möjliga värden: `agent.container`	Ja
└─ Status	AgentContainerStatus (skrivskyddad)	Status för containern för en specifik version av en agent.	Ja
└– updated_at	sträng (skrivskyddad)	Den senaste uppdateringstiden för containern.	Ja
fel	AgentContainerOperationError	Om det finns felinformation om containeråtgärden.	No
└– kod	string	Om det finns någon felkod för containeråtgärden.	Ja
└– meddelande	string	Felmeddelandet för containeråtgärden, om det finns något.	Ja
└– typ	string	Om det finns någon feltyp för containeråtgärden.	Ja
id	string	ID för containeråtgärden. Det här ID:t är en unik identifierare i hela systemet.	Ja
status	AgentContainerOperationStatus	Status för containeråtgärden för en specifik version av en agent.	Ja

AgentContainerOperationStatus

Status för containeråtgärden för en specifik version av en agent.

Property	Value
Type	string
Värden	`NotStarted` `InProgress` `Succeeded` `Failed`

AgentContainerStatus

Status för containern för en viss version av en agent.

Property	Value
Type	string
Värden	`Starting` `Running` `Stopping` `Stopped` `Failed` `Deleting` `Deleted` `Updating`

AgentDefinition

Diskriminerande för AgentDefinition

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

Typvärde	Schema
`prompt`	PromptAgentDefinition
`workflow`	WorkflowAgentDefinition
`hosted`	HostedAgentDefinition
`container_app`	ContainerAppAgentDefinition

Name	Type	Description	Obligatoriskt
Typ	AgentKind		Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
└– rai_policy_name	string	Namnet på DEN RAI-princip som ska tillämpas.	Ja

AgentKind

Property	Value
Type	string
Värden	`prompt` `hosted` `container_app` `workflow`

AgentObject

Name	Type	Description	Obligatoriskt
id	string	Agentens unika identifierare.	Ja
name	string	Namnet på agenten. Begränsningar: maxLength: 63	Ja
object	enum	Objekttypen, som alltid är "agent". Möjliga värden: `agent`	Ja
versions	object	Den senaste versionen av agenten.	Ja
└— senaste	AgentVersionObject		Ja

AgentProtocol

Property	Value
Type	string
Värden	`activity_protocol` `responses`

AgentReference

Name	Type	Description	Obligatoriskt
name	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
type	enum	Möjliga värden: `agent_reference`	Ja
version	string	Agentens versionsidentifierare.	No

AgentTaxonomyInput

Indatakonfiguration för utvärderingstaxonomin när indatatypen är agent.

Name	Type	Description	Obligatoriskt
riskCategories	matris med RiskCategory	Lista över riskkategorier att utvärdera mot.	Ja
target	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	string	Typ av mål.	Ja
type	enum	Indatatyp för utvärderingstaxonomi. Möjliga värden: `agent`	Ja

AgentTaxonomyInputUpdate

Indatakonfiguration för utvärderingstaxonomin när indatatypen är agent.

Name	Type	Description	Obligatoriskt
riskCategories	matris med RiskCategory	Lista över riskkategorier att utvärdera mot.	No
target	TargetUpdate	Basklass för mål med stöd för diskriminator.	No
└– typ	string	Typ av mål.	Ja
type	enum	Indatatyp för utvärderingstaxonomi. Möjliga värden: `agent`	Ja

AgentVersionObject

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpeln (sekunder) när agenten skapades.	Ja
definitionen	AgentDefinition		Ja
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
id	string	Den unika identifieraren för agentversionen.	Ja
metadata	objekt (nullbart)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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
name	string	Namnet på agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. Begränsningar: maxLength: 256	Ja
object	enum	Objekttypen, som alltid är "agent.version". Möjliga värden: `agent.version`	Ja
version	string	Agentens versionsidentifierare. Agenter är oföränderliga och varje uppdatering skapar en ny version samtidigt som namnet är detsamma.	Ja

AgenticIdentityPreviewCredentials

Definition av autentiseringsuppgifter för agentidentitet

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av autentiseringsuppgifter Möjliga värden: `AgenticIdentityToken_Preview`	Ja

ApiErrorResponse

Felsvar för API-fel.

Name	Type	Description	Obligatoriskt	Standardinställning
fel	OpenAI.Error		Ja

ApiKeyCredentials

Definition av API-nyckelautentiseringsuppgifter

Name	Type	Description	Obligatoriskt	Standardinställning
key	sträng (skrivskyddad)	API-nyckel	No
type	enum	Typ av autentiseringsuppgifter Möjliga värden: `ApiKey`	Ja

AssetCredentialResponse

Representerar en referens till en blob för förbrukning

Name	Type	Description	Obligatoriskt
blobReference	BlobReference	Information om blobreferens.	Ja
└– blobUri	string	Blob-URI-sökväg för klienten för att ladda upp data. Exempel: `https://blob.windows.core.net/Container/Path`	Ja
└– autentiseringsuppgifter	SasCredential	Information om autentiseringsuppgifter för åtkomst till lagringskontot.	Ja
└– storageAccountArmId	string	ARM-ID för lagringskontot som ska användas.	Ja

AssetId

Identifierare för en sparad tillgång.

Typ: sträng

AttackStrategy

Strategier för attacker.

Property	Value
Beskrivning	Strategier för attacker.
Type	string
Värden	`easy` `moderate` `difficult` `ascii_art` `ascii_smuggler` `atbash` `base64` `binary` `caesar` `character_space` `jailbreak` `ansi_attack` `character_swap` `suffix_append` `string_join` `unicode_confusable` `unicode_substitution` `diacritic` `flip` `leetspeak` `rot13` `morse` `url` `baseline` `indirect_jailbreak` `tense` `multi_turn` `crescendo`

Azure. Core.Foundations.Error

Felobjektet.

Name	Type	Description	Obligatoriskt
code	string	En av en serverdefinierad uppsättning felkoder.	Ja
details	matris med Azure. Core.Foundations.Error	En matris med information om specifika fel som ledde till det rapporterade felet.	No
innererror	Azure. Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└– kod	string	En av en serverdefinierad uppsättning felkoder.	No
└– innererror	Azure. Core.Foundations.InnerError	Inre fel.	No
message	string	En mänsklig läsbar representation av felet.	Ja
target	string	Målet för felet.	No

Azure. Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Name	Type	Description	Obligatoriskt
fel	Azure. Core.Foundations.Error	Felobjektet.	Ja
└– kod	string	En av en serverdefinierad uppsättning felkoder.	Ja
└— detaljer	matris med Azure. Core.Foundations.Error	En matris med information om specifika fel som ledde till det rapporterade felet.	No
└– innererror	Azure. Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.	No
└– meddelande	string	En mänsklig läsbar representation av felet.	Ja
└– mål	string	Målet för felet.	No

Azure. Core.Foundations.InnerError

Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description	Obligatoriskt
code	string	En av en serverdefinierad uppsättning felkoder.	No
innererror	Azure. Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information om felet. Enligt Azure REST API-riktlinjer - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└– kod	string	En av en serverdefinierad uppsättning felkoder.	No
└– innererror	Azure. Core.Foundations.InnerError	Inre fel.	No

Azure. Core.Foundations.OperationState

Uppräkning som beskriver tillåtna åtgärdstillstånd.

Property	Value
Beskrivning	Uppräkning som beskriver tillåtna åtgärdstillstånd.
Type	string
Värden	`NotStarted` `Running` `Succeeded` `Failed` `Canceled`

Azure. Core.uuid

Universellt unik identifierare

Typ: sträng

Format: uuid

AzureAIAgentTarget

Representerar ett mål som specificerar en Azure AI-agent.

Name	Type	Description	Obligatoriskt
name	string	Den unika identifieraren för Azure AI-agenten.	Ja
tool_descriptions	matris med ToolDescription	De parametrar som används för att styra agentens samplingsbeteende under textgenerering.	No
type	enum	Typen av mål, alltid `azure_ai_agent`. Möjliga värden: `azure_ai_agent`	Ja
version	string	Versionen av Azure AI-agenten.	No

AzureAIAgentTargetUpdate

Representerar ett mål som specificerar en Azure AI-agent.

Name	Type	Description	Obligatoriskt
name	string	Den unika identifieraren för Azure AI-agenten.	No
tool_descriptions	matris med ToolDescription	De parametrar som används för att styra agentens samplingsbeteende under textgenerering.	No
type	enum	Typen av mål, alltid `azure_ai_agent`. Möjliga värden: `azure_ai_agent`	Ja
version	string	Versionen av Azure AI-agenten.	No

AzureAIDataSourceConfig

Name	Type	Description	Obligatoriskt
scenarie	enum	Scenario för dataschema. Möjliga värden: `red_team`, `responses`, `traces_preview`, `synthetic_data_gen_preview`	Ja
schema	object	JSON-schemat för det övergripande objektet för körningen av datakällans objekt.	Ja
type	enum	Objekttypen, som alltid är `azure_ai_source`. Möjliga värden: `azure_ai_source`	Ja

AzureAIModelTarget

Representerar ett mål som specificerar en Azure AI-modell för operationer som kräver modellval.

Name	Type	Description	Obligatoriskt
model	string	Den unika identifieraren för Azure AI-modellen.	No
provtagning_parametrar	ModelSamplingParams	Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.	No
└– max_completion_tokens	integer	Det maximala antalet token som tillåts i slutförandet.	Ja
└– frö	integer	Det slumpmässiga fröet för reproducerbarhet.	Ja
└– temperatur	number	Temperaturparametern för sampling.	Ja
└– top_p	number	Parametern top-p för kärnsampling.	Ja
type	enum	Typen av mål, alltid `azure_ai_model`. Möjliga värden: `azure_ai_model`	Ja

AzureAIModelTargetUpdate

Representerar ett mål som specificerar en Azure AI-modell för operationer som kräver modellval.

Name	Type	Description	Obligatoriskt
model	string	Den unika identifieraren för Azure AI-modellen.	No
provtagning_parametrar	ModelSamplingParamsUpdate	Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.	No
└– max_completion_tokens	integer	Det maximala antalet token som tillåts i slutförandet.	No
└– frö	integer	Det slumpmässiga fröet för reproducerbarhet.	No
└– temperatur	number	Temperaturparametern för sampling.	No
└– top_p	number	Parametern top-p för kärnsampling.	No
type	enum	Typen av mål, alltid `azure_ai_model`. Möjliga värden: `azure_ai_model`	Ja

AzureAIResponsesEvalRunDataSource

Representerar en datakälla för utvärderingskörningar som är specifika för scenarier med kontinuerlig utvärdering.

Name	Type	Description	Obligatoriskt
event_configuration_id	string	Händelsekonfigurationsnamnet som är associerat med den här utvärderingskörningen.	Ja
item_generation_params	ResponseRetrievalItemGenerationParams	Representerar parametrarna för generering av svarshämtningsobjekt.	Ja
└– data_mapping	object	Mappning från källfält till response_id fält som krävs för att hämta chatthistorik.	Ja
└– max_num_turns	integer	Det maximala antalet chatthistoriker som ska utvärderas.	Ja
└– källa	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource	Källan som JSONL-innehåll läss från.	Ja
└– typ	enum	Typ av objektgenereringsparametrar, alltid `response_retrieval`. Möjliga värden: `response_retrieval`	Ja
max_runs_hourly	integer	Maximalt antal utvärderingskörningar som tillåts per timme.	Ja
type	enum	Typen av datakälla, alltid `azure_ai_responses`. Möjliga värden: `azure_ai_responses`	Ja

AzureAISearchIndex

Azure AI-sökning indexdefinition

Name	Type	Description	Obligatoriskt
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
type	enum	Typ av index Möjliga värden: `AzureSearch`	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

AzureAISearchIndexUpdate

Azure AI-sökning indexdefinition

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	enum	Typ av index Möjliga värden: `AzureSearch`	Ja

AzureAISearchQueryType

Tillgängliga frågetyper för Azure AI-sökning-verktyget.

Property	Value
Beskrivning	Tillgängliga frågetyper för Azure AI-sökning-verktyget.
Type	string
Värden	`simple` `semantic` `vector` `vector_simple_hybrid` `vector_semantic_hybrid`

AzureAISearchTool

Indatadefinitionsinformationen för ett Azure AI-sökverktyg som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
azure_ai_search	AzureAISearchToolResource	En uppsättning indexresurser som används av verktyget `azure_ai_search`.	Ja
└— index	matris med AISearchIndexResource	Indexen som är kopplade till den här agenten. Det kan finnas högst 1 index resurs som är kopplad till agenten. Begränsningar: maxItems: 1	Ja
type	enum	Objekttypen, som alltid är "azure_ai_search". Möjliga värden: `azure_ai_search`	Ja

AzureAISearchToolResource

En uppsättning indexresurser som används av verktyget azure_ai_search.

Name	Type	Description	Obligatoriskt	Standardinställning
Index	matris med AISearchIndexResource	Indexen som är kopplade till den här agenten. Det kan finnas högst 1 index resurs som är kopplad till agenten.	Ja

AzureFunctionBinding

Strukturen för att behålla storage könamn och URI.

Name	Type	Description	Obligatoriskt
storage_queue	AzureFunctionStorageQueue	Strukturen för att behålla storage könamn och URI.	Ja
└– queue_name	string	Namnet på en Azure funktionslagringskö.	Ja
└– queue_service_endpoint	string	URI till Azure Storage Queue-tjänsten så att du kan ändra en kö.	Ja
type	enum	Typen av bindning, som alltid är "storage_queue". Möjliga värden: `storage_queue`	Ja

AzureFunctionDefinition

Definitionen av Azure-funktionen.

Name	Type	Description	Obligatoriskt
function	object	Definitionen av azure-funktionen och dess parametrar.	Ja
└— beskrivning	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
└— namn	string	Namnet på den funktion som ska anropas.	Ja
└— parametrar	object	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt.	Ja
input_binding	AzureFunctionBinding	Strukturen för att behålla storage könamn och URI.	Ja
└– storage_queue	AzureFunctionStorageQueue	Lagringskö.	Ja
└– typ	enum	Typen av bindning, som alltid är "storage_queue". Möjliga värden: `storage_queue`	Ja
output_binding	AzureFunctionBinding	Strukturen för att behålla storage könamn och URI.	Ja
└– storage_queue	AzureFunctionStorageQueue	Lagringskö.	Ja
└– typ	enum	Typen av bindning, som alltid är "storage_queue". Möjliga värden: `storage_queue`	Ja

AzureFunctionStorageQueue

Strukturen för att behålla storage könamn och URI.

Name	Type	Description	Obligatoriskt	Standardinställning
queue_name	string	Namnet på en Azure funktionslagringskö.	Ja
queue_service_endpoint	string	URI till Azure Storage Queue-tjänsten så att du kan ändra en kö.	Ja

AzureFunctionTool

Indatadefinitionsinformationen för ett Azure Function Tool, som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
azure_function	AzureFunctionDefinition	Definitionen av Azure-funktionen.	Ja
└– funktion	object	Definitionen av azure-funktionen och dess parametrar.	Ja
└— beskrivning	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
└— namn	string	Namnet på den funktion som ska anropas.	Ja
└— parametrar	object	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt.	Ja
└– input_binding	AzureFunctionBinding	Lagringskö för indata. Kölagringsutlösaren kör en funktion när meddelanden läggs till i den.	Ja
└output_binding	AzureFunctionBinding	Utdatalagringskö. Funktionen skriver utdata till den här kön när indataobjekten bearbetas.	Ja
type	enum	Objekttypen, som alltid är "browser_automation". Möjliga värden: `azure_function`	Ja

AzureOpenAIModelConfiguration

Azure Konfiguration av OpenAI-modell. API-versionen väljs av tjänsten för att fråga modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
modelDeploymentName	string	Distributionsnamn för AOAI-modell. Exempel: gpt-4o om i AIServices eller anslutningsbaserad `connection_name/deployment_name` (t.ex. `my-aoai-connection/gpt-4o`).	Ja
type	enum	Möjliga värden: `AzureOpenAIModel`	Ja

BaseCredentials

En basklass för autentiseringsuppgifter för anslutning

Diskriminerande för BaseCredentials

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

Typvärde	Schema
`ApiKey`	ApiKeyCredentials
`AAD`	EntraIDCredentials
`CustomKeys`	CustomCredential
`SAS`	SASCredentials
`None`	NoAuthenticationCredentials
`AgenticIdentityToken_Preview`	AgenticIdentityPreviewCredentials

Name	Type	Description	Obligatoriskt	Standardinställning
type	CredentialType (skrivskyddad)	Typen av autentiseringsuppgifter som används av anslutningen	Ja

BingCustomSearchConfiguration

En bing anpassad sökkonfiguration.

Name	Type	Description	Obligatoriskt
count	integer	Antalet sökresultat som ska returneras i bing api-svaret	No
freshness	string	Filtrera sökresultat efter ett visst tidsintervall. Se accepterade värden här.	No
instance_name	string	Namnet på den anpassade konfigurationsinstans som angetts för konfigurationen.	Ja
Marknaden	string	Marknaden där resultaten kommer ifrån.	No
project_connection_id	string	Project anslutnings-ID för jordning med bing-sökning	Ja
set_lang	string	Språket som ska användas för användargränssnittssträngar när du anropar Bing API.	No

BingCustomSearchPreviewTool

Information om indatadefinitionen för ett Bing anpassat sökverktyg som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
bing_custom_search_preview	BingCustomSearchToolParameters	Parametrarna för det bing anpassade sökverktyget.	Ja
└– search_configurations	matris med BingCustomSearchConfiguration	De project anslutningar som är anslutna till det här verktyget. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget. Begränsningar: maxItems: 1	Ja
type	enum	Objekttypen, som alltid är 'bing_custom_search_preview'. Möjliga värden: `bing_custom_search_preview`	Ja

BingCustomSearchToolParameters

Parametrarna för det bing anpassade sökverktyget.

Name	Type	Description	Obligatoriskt	Standardinställning
search_configurations	matris med BingCustomSearchConfiguration	De project anslutningar som är anslutna till det här verktyget. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget.	Ja

BingGroundingSearchConfiguration

Sökkonfiguration för Bing grounding

Name	Type	Description	Obligatoriskt
count	integer	Antalet sökresultat som ska returneras i bing api-svaret	No
freshness	string	Filtrera sökresultat efter ett visst tidsintervall. Se accepterade värden här.	No
Marknaden	string	Marknaden där resultaten kommer ifrån.	No
project_connection_id	string	Project anslutnings-ID för jordning med bing-sökning	Ja
set_lang	string	Språket som ska användas för användargränssnittssträngar när du anropar Bing API.	No

BingGroundingSearchToolParameters

Parametrarna för bing grundsökningsverktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
search_configurations	matris med BingGroundingSearchConfiguration	Sökkonfigurationerna som är kopplade till det här verktyget. Det kan finnas högst 1 sökkonfigurationsresurs som är kopplad till verktyget.	Ja

BingGroundingTool

Information om indatadefinitionen för ett bing grundsökningsverktyg som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
bing_grounding	BingGroundingSearchToolParameters	Parametrarna för bing grundsökningsverktyg.	Ja
└– search_configurations	matris med BingGroundingSearchConfiguration	Sökkonfigurationerna som är kopplade till det här verktyget. Det kan finnas högst 1 sökkonfigurationsresurs som är kopplad till verktyget. Begränsningar: maxItems: 1	Ja
type	enum	Objekttypen, som alltid är "bing_grounding". Möjliga värden: `bing_grounding`	Ja

BlobReference

Information om blobreferens.

Name	Type	Description	Obligatoriskt
blobUri	string	Blob-URI-sökväg för klienten för att ladda upp data. Exempel: `https://blob.windows.core.net/Container/Path`	Ja
credential	SasCredential	Definition av SAS-autentiseringsuppgifter	Ja
└– sasUri	sträng (skrivskyddad)	SAS-URI	Ja
└– typ	enum	Typ av autentiseringsuppgifter Möjliga värden: `SAS`	Ja
storageAccountArmId	string	ARM-ID för lagringskontot som ska användas.	Ja

BrowserAutomationPreviewTool

Information om indatadefinitionen för ett webbläsarautomatiseringsverktyg, som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
browser_automation_preview	BrowserAutomationToolParameters	Definition av inmatningsparametrar för Browser Automation Tool.	Ja
└– anslutning	BrowserAutomationToolConnectionParameters	De projektanslutningsparametrar som är associerade med verktyget Webbläsarautomatisering.	Ja
type	enum	Objekttypen, som alltid är 'browser_automation_preview'. Möjliga värden: `browser_automation_preview`	Ja

BrowserAutomationToolConnectionParameters

Definition av indataparametrar för anslutningen som används av Browser Automation Tool.

Name	Type	Description	Obligatoriskt	Standardinställning
project_connection_id	string	ID:t för projektanslutningen till resursen Azure Playwright.	Ja

BrowserAutomationToolParameters

Definition av inmatningsparametrar för Browser Automation Tool.

Name	Type	Description	Obligatoriskt	Standardinställning
anslutning	BrowserAutomationToolConnectionParameters	Definition av indataparametrar för anslutningen som används av Browser Automation Tool.	Ja
└– project_connection_id	string	ID:t för projektanslutningen till resursen Azure Playwright.	Ja

CaptureStructuredOutputsTool

Ett verktyg för att fånga strukturerade resultat

Name	Type	Description	Obligatoriskt
outputs	StructuredOutputDefinition	Strukturerade utdata som kan skapas av agenten.	Ja
└— beskrivning	string	En beskrivning av de utdata som ska genereras. Används av modellen för att avgöra när utdata ska genereras.	Ja
└— namn	string	Namnet på de strukturerade utdata.	Ja
└– schema	object	JSON-schemat för de strukturerade utdata.	Ja
└– strikt	boolesk (nullbar)	Om du vill framtvinga strikt validering. Standard `true`.	Ja
type	enum	Verktygets typ. Alltid `capture_structured_outputs`. Möjliga värden: `capture_structured_outputs`	Ja

ChartCoordinate

Koordinater för analysdiagrammet.

Name	Type	Description	Obligatoriskt
storlek	integer	Diagramelementets storlek.	Ja
x	integer	X-axelkoordinat.	Ja
y	integer	Y-axelkoordinat.	Ja

ChatSummaryMemoryItem

Ett minnesobjekt som innehåller en sammanfattning som extraherats från konversationer.

Name	Type	Description	Obligatoriskt
innehåll	string	Innehållet i minnet.	Ja
Typ	enum	Typ av minnesobjekt. Möjliga värden: `chat_summary`	Ja
memory_id	string	Det unika ID:t för minnesobjektet.	Ja
scope	string	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja
updated_at	integer	Den senaste uppdateringstiden för minnesobjektet.	Ja

ClusterInsightResult

Insikter från klusteranalysen.

Name	Type	Description	Obligatoriskt
clusters	matris med InsightCluster	Lista över kluster som identifieras i insikterna.	Ja
Koordinater	object	Valfri mappning av ID:er till 2D-koordinater som används av UX för visualisering. Kartnycklarna är strängidentifierare (till exempel ett kluster-ID eller ett exempel-ID) och värdena är koordinaterna och den visuella storleken för återgivning i ett 2D-diagram. Den här egenskapen utelämnas om inte klientbegäranden samordnas (till exempel genom att skicka `includeCoordinates=true` som en frågeparameter). Exempel: `<br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br>` Koordinater är endast avsedda för visualisering på klientsidan och inte ändra resultatet av kanoniska insikter.	No
summary	InsightSummary	Sammanfattning av felklusteranalysen.	Ja
└— metod	string	Metod som används för klustring.	Ja
└– sampleCount	integer	Totalt antal prover som analyserats.	Ja
└— uniqueClusterCount	integer	Totalt antal unika kluster.	Ja
└— uniqueSubclusterCount	integer	Totalt antal unika underklusteretiketter.	Ja
└— användning	ClusterTokenUsage	Tokenanvändning vid klusteranalys	Ja

ClusterTokenUsage

Tokenanvändning för klusteranalys

Name	Type	Description	Obligatoriskt
inputTokenUsage	integer	användning av indatatoken	Ja
outputTokenUsage	integer	användning av utdatatoken	Ja
totalTokenUsage	integer	total tokenanvändning	Ja

CodeBasedEvaluatorDefinition

Kodbaserad utvärderardefinition med hjälp av python-kod

Name	Type	Description	Obligatoriskt
code_text	string	Infogad kodtext för utvärderaren	Ja
data_schema	object	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
init_parameters	object	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
metrics	object	Förteckning över utfallsmått som tagits fram av den här utvärderaren	No
type	enum	Möjliga värden: `code`	Ja

CompletionMessageToolCallChunk

Information om knappanrop i ett meddelande.

Name	Type	Description	Obligatoriskt
function	FunctionToolCall	Information om ett funktionsverktygsanrop.	No
└─ argument	string	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format.	Ja
└— namn	string	Namnet på funktionen som ska anropas.	Ja
id	string	ID:t för verktygsanropet.	Ja
type	enum	Typ av verktygsanrop, som alltid är "funktion". Möjliga värden: `function`	Ja

Anslutning

Åtgärder för svar från listan och hämta anslutningar

Name	Type	Description	Obligatoriskt
credentials	BaseCredentials (skrivskyddad)	En basklass för autentiseringsuppgifter för anslutning	Ja
└– typ	CredentialType (skrivskyddad)	Typen av autentiseringsuppgifter som används av anslutningen	Ja
id	sträng (skrivskyddad)	En unik identifierare för anslutningen som genereras av tjänsten	Ja
isDefault	booleskt värde (skrivskyddat)	Om anslutningen är taggad som standardanslutning av dess typ	Ja
metadata	objekt (skrivskyddat)	Metadata för anslutningen	Ja
name	sträng (skrivskyddad)	Det egna namnet på anslutningen, som tillhandahålls av användaren.	Ja
target	sträng (skrivskyddad)	Anslutnings-URL:en som ska användas för den här tjänsten	Ja
type	ConnectionType (skrivskyddad)	Typ (eller kategori) för anslutningen	Ja

ConnectionType

Typ (eller kategori) för anslutningen

Property	Value
Beskrivning	Typ (eller kategori) för anslutningen
Type	string
Värden	`AzureOpenAI` `AzureBlob` `AzureStorageAccount` `CognitiveSearch` `CosmosDB` `ApiKey` `AppConfig` `AppInsights` `CustomKeys` `RemoteTool_Preview`

ContainerAppAgentDefinition

Containerappens agentdefinition.

Name	Type	Description	Obligatoriskt
container_app_resource_id	string	Resurs-ID för Azure Container App som är värd för den här agenten. Kan inte ändras mellan olika versioner.	Ja
container_protocol_versions	matris med ProtocolVersionRecord	De protokoll som agenten stöder för inkommande kommunikation av containrarna.	Ja
ingress_subdomain_suffix	string	Suffixet som ska tillämpas på appens underdomän när ingress skickas till agenten. Det kan vara en etikett (t.ex. "---aktuell", en specifik revision (t.ex. "--0000001") eller tom för att använda standardslutpunkten för containerappen.	Ja
Typ	enum	Möjliga värden: `container_app`	Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
└– rai_policy_name	string	Namnet på DEN RAI-princip som ska tillämpas.	Ja

ContainerDetails

Detaljerad information om containern.

Name	Type	Description	Obligatoriskt
health_state	string	Hälsotillståndet för containern.	Ja
provisioning_error	string	Om det finns ett etableringsfel för containern.	No
provisioning_state	string	Containerns etableringstillstånd.	Ja
replicas	matris med ContainerReplica	Listan över repliker i containern.	Ja
state	string	Containerns tillstånd.	Ja
updated_on	string	Den senaste uppdateringstiden för containern.	Ja

ContainerLogKind

Typen av loggar som ska strömmas från en container.

Property	Value
Type	string
Värden	`console` `system`

ContainerReplica

Information om en containerreplik.

Name	Type	Description	Obligatoriskt
container_state	string	Containertillståndet för repliken.	Ja
name	string	Namnet på repliken.	Ja
state	string	Replikens tillstånd.	Ja

ContinuousEvaluationRuleAction

Åtgärd för utvärderingsregel för kontinuerlig utvärdering.

Name	Type	Description	Obligatoriskt
evalId	string	Eval-ID för att lägga till kontinuerliga utvärderingskörningar till.	Ja
maxHourlyRuns	integer	Maximalt antal utvärderingskörningar som tillåts per timme.	No
type	enum	Möjliga värden: `continuousEvaluation`	Ja

CosmosDBIndex

Definition av CosmosDB Vector Store-index

Name	Type	Description	Obligatoriskt
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
type	enum	Typ av index Möjliga värden: `CosmosDBNoSqlVectorStore`	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

CosmosDBIndexUpdate

Definition av CosmosDB Vector Store-index

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	enum	Typ av index Möjliga värden: `CosmosDBNoSqlVectorStore`	Ja

CreateAgentFromManifestRequest

Name	Type	Description	Obligatoriskt
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
manifest_id	string	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Det unika namn som identifierar agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. – Måste börja och sluta med alfanumeriska tecken. - Kan innehålla bindestreck i mitten – Får inte överstiga 63 tecken. Begränsningar: maxLength: 63	Ja
parameter_values	object	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

CreateAgentRequest

Name	Type	Description	Obligatoriskt
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Det unika namn som identifierar agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. – Måste börja och sluta med alfanumeriska tecken. - Kan innehålla bindestreck i mitten – Får inte överstiga 63 tecken. Begränsningar: maxLength: 63	Ja

CreateAgentVersionFromManifestRequest

Name	Type	Description	Obligatoriskt
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
manifest_id	string	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
parameter_values	object	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

CreateAgentVersionRequest

Name	Type	Description	Obligatoriskt
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No

SkapaUtvärderingsbegäran

Name	Type	Description	Obligatoriskt
datakällkonfiguration	OpenAI.CreateEvalCustomDataSourceConfig eller OpenAI.CreateEvalLogsDataSourceConfig eller OpenAI.CreateEvalStoredCompletionsDataSourceConfig eller AzureAIDataSourceConfig	Konfigurationen för den datakälla som används för utvärderingen körs. Avgör schemat för de data som används i utvärderingen.	Ja
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Namnet på utvärderingen.	No
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No
testkriterier	matris med OpenAI.EvalGraderLabelModel eller OpenAI.EvalGraderStringCheck eller OpenAI.EvalGraderTextSimilarity eller OpenAI.EvalGraderPython eller OpenAI.EvalGraderScoreModel eller EvalGraderAzureAIEvaluator	En lista över bedömare för alla utvärderingskörningar i den här gruppen. Graders kan referera till variabler i datakällan med hjälp av dubbla klammerparenteser, till exempel `{{item.variable_name}}`. Om du vill referera till modellens utdata använder du `sample` namnområdet (dvs. `{{sample.output_text}}`).	Ja

CreateEvalRunRequest

Name	Type	Description	Obligatoriskt
datakälla	OpenAI.CreateEvalJsonlRunDataSource eller OpenAI.CreateEvalCompletionsRunDataSource eller OpenAI.CreateEvalResponsesRunDataSource eller EvalRunDataSource	Information om körningens datakälla.	Ja
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string	Namnet på körningen.	No
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No

CredentialType

Typen av autentiseringsuppgifter som används av anslutningen

Property	Value
Beskrivning	Typen av autentiseringsuppgifter som används av anslutningen
Type	string
Värden	`ApiKey` `AAD` `SAS` `CustomKeys` `None` `AgenticIdentityToken_Preview`

CronTrigger

Cron-baserad utlösare.

Name	Type	Description	Obligatoriskt	Standardinställning
endTime	string	Sluttid för cron-schemat i ISO 8601-format.	No
expression	string	Cron-uttryck som definierar schemafrekvensen.	Ja
startTime	string	Starttid för cron-schemat i ISO 8601-format.	No
timeZone	string	Tidszon för cron-schemat.	No	UTC
type	enum	Möjliga värden: `Cron`	Ja

CustomCredential

Definition av anpassade autentiseringsuppgifter

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av autentiseringsuppgifter Möjliga värden: `CustomKeys`	Ja

Det här objektet accepterar även ytterligare egenskaper av typen: sträng

DailyRecurrenceSchedule

Dagligt upprepningsschema.

Name	Type	Description	Obligatoriskt	Standardinställning
hours	matris med heltal	Timmar för upprepningsschemat.	Ja
type	enum	Daglig upprepningstyp. Möjliga värden: `Daily`	Ja

DataSourceConfig

Basklass för körning av datakällor med diskriminerande stöd.

Diskriminerande för DataSourceConfig

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

Typvärde	Schema

Name	Type	Description	Obligatoriskt	Standardinställning
schema	object	JSON-schemat för det övergripande objektet för körningen av datakällans objekt.	Ja
type	string	Datakällans typdiskriminering.	Ja

DatasetType

Räkna upp för att fastställa typen av data.

Property	Value
Beskrivning	Räkna upp för att fastställa typen av data.
Type	string
Värden	`uri_file` `uri_folder`

DatasetVersion

DatasetVersionsdefinition

Diskriminerande för DatasetVersion

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

Typvärde	Schema
`uri_file`	FileDatasetVersion
`uri_folder`	FolderDatasetVersion

Name	Type	Description	Obligatoriskt
connectionName	string	Anslutningsnamnet för Azure Storage konto. Krävs om startPendingUploadVersion inte anropades innan datauppsättningen skapades	No
dataUri	string	URI för data (exempel) Begränsningar: minLength: 1, mönster: `[a-zA-Z0-9_]`	Ja
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
isReference	booleskt värde (skrivskyddat)	Anger om datauppsättningen innehåller en referens till lagringen, eller om datauppsättningen hanterar själva lagringen. Om det är sant tas inte underliggande data bort när datamängdsversionen tas bort	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
type	DatasetType	Räkna upp för att fastställa typen av data.	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

DatasetVersionUpdate

DatasetVersionsdefinition

Diskriminerande för DatasetVersionUpdate

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

Typvärde	Schema
`uri_file`	FileDatasetVersionUpdate
`uri_folder`	FolderDatasetVersionUpdate

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	DatasetType	Räkna upp för att fastställa typen av data.	Ja

Veckodag

Dagar i veckan för upprepningsschema.

Property	Value
Beskrivning	Dagar i veckan för upprepningsschema.
Type	string
Värden	`Sunday` `Monday` `Tuesday` `Wednesday` `Thursday` `Friday` `Saturday`

DeleteAgentResponse

Ett borttaget agentobjekt

Name	Type	Description	Obligatoriskt
borttagen	boolean	Om agenten har tagits bort.	Ja
name	string	Namnet på agenten.	Ja
object	enum	Objekttypen. Alltid "agent.deleted". Möjliga värden: `agent.deleted`	Ja

DeleteAgentVersionResponse

Ett borttaget agentversionsobjekt

Name	Type	Description	Obligatoriskt
borttagen	boolean	Om agenten har tagits bort.	Ja
name	string	Namnet på agenten.	Ja
object	enum	Objekttypen. Alltid "agent.version.deleted". Möjliga värden: `agent.version.deleted`	Ja
version	string	Agentens versionsidentifierare.	Ja

DeleteEvalResponse

Ett borttaget utvärderingsobjekt

Name	Type	Description	Obligatoriskt
borttagen	boolean	Om evalen har tagits bort.	Ja
eval_id	string	id för eval.	Ja
object	enum	Objekttypen. Alltid "eval.deleted". Möjliga värden: `eval.deleted`	Ja

DeleteEvalRunResponse

Ett borttaget utvärderingskörningsobjekt.

Name	Type	Description	Obligatoriskt
borttagen	boolean	Om evalen har tagits bort.	No
object	enum	Objekttypen. Alltid "eval.deleted". Möjliga värden: `eval.deleted`	No
run_id	string	id för eval.	No

DeleteMemoryStoreResponse

Name	Type	Description	Obligatoriskt
borttagen	boolean	Om minnesarkivet har tagits bort.	Ja
name	string	Namnet på minnesarkivet.	Ja
object	enum	Objekttypen. Alltid "memory_store.deleted". Möjliga värden: `memory_store.deleted`	Ja

DeleteResponseResult

Resultatet av en borttagningsåtgärd.

Name	Type	Description	Obligatoriskt
borttagen	enum	Returnera alltid sant Möjliga värden: `True`	Ja
id	string	Åtgärds-ID:t.	Ja
object	enum	Returnera alltid "svar". Möjliga värden: `response`	Ja

Driftsättning

Definition av modelldistribution

Diskriminerande för distribution

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

Typvärde	Schema
`ModelDeployment`	ModelDeployment

Name	Type	Description	Obligatoriskt	Standardinställning
name	sträng (skrivskyddad)	Namn på distributionen	Ja
type	DeploymentType		Ja

DeploymentType

Property	Value
Type	string
Värden	`ModelDeployment`

EntraIDCredentials

Entra ID-legitimationsdefinition

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av autentiseringsuppgifter Möjliga värden: `AAD`	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 o4-mini är bättre på min usecase än gpt-4o

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när eval skapades.	Ja
skapad av	string	namnet på den person som skapade körningen.	No
datakällkonfiguration	OpenAI.CreateEvalCustomDataSourceConfig eller OpenAI.CreateEvalLogsDataSourceConfig eller OpenAI.CreateEvalStoredCompletionsDataSourceConfig eller AzureAIDataSourceConfig	Konfiguration av datakällor som används i körningar av utvärderingen.	Ja
id	string	Unik identifierare för utvärderingen.	Ja
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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
modified_at	heltal		No
name	string	Namnet på utvärderingen.	Ja
object	enum	Objekttypen. Möjliga värden: `eval`	Ja
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No
testkriterier	matris med OpenAI.EvalGraderLabelModel eller OpenAI.EvalGraderStringCheck eller OpenAI.EvalGraderTextSimilarity eller OpenAI.EvalGraderPython eller OpenAI.EvalGraderScoreModel eller EvalGraderAzureAIEvaluator	En lista över testkriterier.	Ja

EvalCsvFileIdSource

Representerar en referens till en uppladdad CSV-fil som används som källa för utvärderingsdata.

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	Identifieraren för den uppladdade CSV-filen.	Ja
type	enum	Typen av källa, alltid `file_id`. Möjliga värden: `file_id`	Ja

EvalCsvRunDataSource

Representerar en CSV-datakälla för utvärderingskörningar.

Name	Type	Description	Obligatoriskt
source	EvalCsvFileIdSource	Representerar en referens till en uppladdad CSV-fil som används som källa för utvärderingsdata.	Ja
└– id	string	Identifieraren för den uppladdade CSV-filen.	Ja
└– typ	enum	Typen av källa, alltid `file_id`. Möjliga värden: `file_id`	Ja
type	enum	Typen av datakälla, alltid `csv`. Möjliga värden: `csv`	Ja

EvalGraderAzureAIEvaluator

Name	Type	Description	Obligatoriskt
data_mapping	object	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	No
evaluator_name	string	Namnet på utvärderaren.	Ja
evaluator_version	string	Utvärderarens version. Senaste versionen om den inte har angetts.	No
initialization_parameters	object	Initieringsparametrarna för utvärderingen. Måste ha stöd för strukturerade utdata.	No
name	string	Namnet på bedömaren.	Ja
type	enum	Objekttypen, som alltid är `azure_ai_evaluator`. Möjliga värden: `azure_ai_evaluator`	Ja

EvalResult

Resultat av utvärderingen.

Name	Type	Description	Obligatoriskt
name	string	namnet på kontrollen	Ja
Passerade	boolean	anger om kontrollen skickades eller misslyckades	Ja
Poäng	number	Poäng	Ja
type	string	typ av kontroll	Ja

EvalRun

Ett schema som representerar en utvärderingskörning.

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades.	Ja
skapad av	string	namnet på den person som skapade körningen.	No
datakälla	OpenAI.CreateEvalJsonlRunDataSource eller OpenAI.CreateEvalCompletionsRunDataSource eller OpenAI.CreateEvalResponsesRunDataSource eller EvalRunDataSource	Information om körningens datakälla.	Ja
fel	OpenAI.EvalApiError	Ett objekt som representerar ett felsvar från Eval-API:et.	Ja
eval_id	string	Identifieraren för den associerade utvärderingen.	Ja
id	string	Unik identifierare för utvärderingskörningen.	Ja
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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
model	string	Den modell som utvärderas, om tillämpligt.	Ja
modified_at	heltal		No
name	string	Namnet på utvärderingsomgången.	Ja
object	enum	Typ av objekt. Alltid "eval.run". Möjliga värden: `eval.run`	Ja
per modellanvändning	matris med OpenAI.EvalRunPerModelUsage	Användningsstatistik för varje modell under utvärderingskörningen.	Ja
per_testkriterier_resultat	matris med OpenAI.EvalRunPerTestingCriteriaResults	Resultat per testkriterier som tillämpades under utvärderingen.	Ja
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No
report_url	string	URL:en till den renderade utvärderingskörningsrapporten på instrumentpanelen för användargränssnittet.	Ja
antalresultat	OpenAI.EvalRunResultCounts		Ja
└– felaktig	OpenAI.integer		Ja
└– misslyckades	OpenAI.integer		Ja
└– godkänd	OpenAI.integer		Ja
└— totalt	OpenAI.integer		Ja
status	string	Status för utvärderingskörningen.	Ja

EvalRunDataSource

Basklass för körning av datakällor med diskriminerande stöd.

Diskriminerande för EvalRunDataSource

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

Typvärde	Schema
`azure_ai_traces_preview`	TracesPreviewEvalRunDataSource
`azure_ai_synthetic_data_gen_preview`	SyntheticDataGenerationPreviewEvalRunDataSource
`azure_ai_responses`	AzureAIResponsesEvalRunDataSource
`azure_ai_target_completions`	TargetCompletionEvalRunDataSource
`csv`	EvalCsvRunDataSource
`azure_ai_red_team`	RedTeamEvalRunDataSource

Name	Type	Description	Obligatoriskt	Standardinställning
type	string	Datakällans typdiskriminering.	Ja

EvalRunOutputItem

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

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades.	Ja
datasource-objekt	object	Information om indatakällans objekt.	Ja
datakälla_objekt_id	OpenAI.integer		Ja
eval_id	string	Identifieraren för utvärderingsgruppen.	Ja
id	string	Unik identifierare för output-objektet vid utvärderingskörningen.	Ja
object	enum	Typ av objekt. Alltid "eval.run.output_item". Möjliga värden: `eval.run.output_item`	Ja
results	matris med EvalRunOutputItemResult	En lista över graderresultat för det här utdataobjektet.	Ja
run_id	string	Identifieraren för utvärderingskörningen som är associerad med det här utdataobjektet.	Ja
exempel	OpenAI.EvalRunOutputItemSample		Ja
└– fel	OpenAI.EvalApiError	Ett objekt som representerar ett felsvar från Eval-API:et.	Ja
└– avslutnings_anledning	string		Ja
└– indata	matris med EvalRunOutputItemSampleInput		Ja
└– max_completion_tokens	OpenAI.integer		Ja
└– modell	string		Ja
└– utdata	matris med EvalRunOutputItemSampleOutput		Ja
└– frö	OpenAI.integer		Ja
└– temperatur	OpenAI.numeric		Ja
└– top_p	OpenAI.numeric		Ja
└— användning	OpenAI.EvalRunOutputItemSampleUsage		Ja
status	string	Status för utvärderingskörningen.	Ja

EvalRunOutputItemResult

Ett resultat av en enskild väghyvel för ett utdataobjekt för utvärderingskörning.

Name	Type	Description	Obligatoriskt
etikett	string	Etiketten som är associerad med testvillkorsmåttet (t.ex. "pass", "fail", "good", "bad").	No
metric	string	Namnet på måttet (t.ex. "fluency", "f1_score").	No
name	string	Namnet på bedömaren.	Ja
Passerade	boolean	Om väghyveln ansåg att utdata var ett pass.	Ja
properties	object	Ytterligare information om testvillkorsmåttet.	No
reason	string	Orsaken till testvillkorsmåttet.	No
exempel	objekt (nullbart)	Valfritt exempel eller mellanliggande data som genereras av väghyveln.	No
Poäng	OpenAI.numeric		Ja
threshold	number	Tröskelvärdet som används för att fastställa pass/fail för det här testvillkoren, om det är numeriskt.	No
type	string	Typ av väghyvel (till exempel "string-check-grader").	No

Det här objektet accepterar även ytterligare egenskaper.

EvalRunOutputItemSampleInput

Ett meddelande i utvärderingskörningen.

Name	Type	Description	Obligatoriskt
innehåll	string		Ja
role	string		Ja
tool_calls	matris med CompletionMessageToolCallChunk	Eventuella verktygsanrop som görs i meddelandet.	Ja

EvalRunOutputItemSampleOutput

Ett meddelande i utvärderingskörningen.

Name	Type	Description	Obligatoriskt
innehåll	string		No
role	string		No
tool_calls	matris med CompletionMessageToolCallChunk	Eventuella verktygsanrop som görs i meddelandet.	Ja

EvalRunResultCompareItem

Metrisk jämförelse för en behandling mot baslinjen.

Name	Type	Description	Obligatoriskt
deltaEstimate	number	Uppskattad skillnad mellan behandling och baslinje.	Ja
pValue	number	P-värde för behandlingseffekten.	Ja
treatmentEffect	TreatmentEffectType	Typ av behandlingseffekt.	Ja
treatmentRunId	string	Behandlingskörningens ID.	Ja
treatmentRunSummary	EvalRunResultSummary	Sammanfattande statistik för ett mått i en utvärderingskörning.	Ja
└– genomsnitt	number	Genomsnittligt värde för måttet i utvärderingskörningen.	Ja
└— runId	string	Utvärderingskörnings-ID.	Ja
└– sampleCount	integer	Antal exempel i utvärderingskörningen.	Ja
└– standardAvvikelse	number	Standardavvikelse för måttet i utvärderingskörningen.	Ja

EvalRunResultComparison

Jämförelseresultat för behandling körs mot baslinjen.

Name	Type	Description	Obligatoriskt
baselineRunSummary	EvalRunResultSummary	Sammanfattande statistik för ett mått i en utvärderingskörning.	Ja
└– genomsnitt	number	Genomsnittligt värde för måttet i utvärderingskörningen.	Ja
└— runId	string	Utvärderingskörnings-ID.	Ja
└– sampleCount	integer	Antal exempel i utvärderingskörningen.	Ja
└– standardAvvikelse	number	Standardavvikelse för måttet i utvärderingskörningen.	Ja
compareItems	matris med EvalRunResultCompareItem	Lista över jämförelseresultat för varje behandlingskörning.	Ja
Utvärderaren	string	Namnet på utvärderaren för det här testkriterierna.	Ja
metric	string	Mått som utvärderas.	Ja
testingCriteria	string	Namnet på testkriterierna.	Ja

EvalRunResultSummary

Sammanfattande statistik för ett mått i en utvärderingskörning.

Name	Type	Description	Obligatoriskt
genomsnitt	number	Genomsnittligt värde för måttet i utvärderingskörningen.	Ja
runId	string	Utvärderingskörnings-ID.	Ja
sampleCount	integer	Antal exempel i utvärderingskörningen.	Ja
standardDeviation	number	Standardavvikelse för måttet i utvärderingskörningen.	Ja

EvaluationComparisonInsightRequest

Begäran om utvärderingsjämförelse

Name	Type	Description	Obligatoriskt
baselineRunId	string	Baslinjekörnings-ID:t för jämförelse.	Ja
evalId	string	Identifierare för utvärderingen.	Ja
treatmentRunIds	strängmatris	Lista över behandlingskörnings-ID:er för jämförelse.	Ja
type	enum	Typ av begäran. Möjliga värden: `EvaluationComparison`	Ja

EvaluationComparisonInsightResult

Insikter från utvärderingsjämförelsen.

Name	Type	Description	Obligatoriskt
Jämförelser	matris med EvalRunResultComparison	Jämförelseresultat för varje behandling körs mot baslinjen.	Ja
method	string	Den statistiska metod som används för jämförelse.	Ja
type	enum	Typen av insikter resultat. Möjliga värden: `EvaluationComparison`	Ja

EvaluationResultSample

Ett exempel från utvärderingsresultatet.

Name	Type	Description	Obligatoriskt
correlationInfo	object	Information om korrelationen för analysexemplet.	Ja
evaluationResult	EvalResult	Resultat av utvärderingen.	Ja
└— namn	string	namnet på kontrollen	Ja
└– godkänd	boolean	anger om kontrollen skickades eller misslyckades	Ja
└– poäng	number	Poäng	Ja
└– typ	string	typ av kontroll	Ja
features	object	Funktioner som hjälper till med ytterligare filtrering av data i UX.	Ja
id	string	Den unika identifieraren för analysexemplet.	Ja
type	enum	Exempeltyp för utvärderingsresultat Möjliga värden: `EvaluationResultSample`	Ja

EvaluationRule (Utvärderingsregel)

Modell för utvärderingsregel.

Name	Type	Description	Obligatoriskt
åtgärd	EvaluationRuleAction	Åtgärdsmodell för utvärdering.	Ja
└– typ	EvaluationRuleActionType	Typ av utvärderingsåtgärd.	Ja
beskrivning	string	Beskrivning av utvärderingsregeln.	No
displayName	string	Visningsnamn för utvärderingsregeln.	No
enabled	boolean	Anger om utvärderingsregeln är aktiverad. Standardvärdet är sant.	Ja
eventType	EvaluationRuleEventType	Typ av utvärderingsregelhändelse.	Ja
filter	EvaluationRuleFilter	Modell för utvärderingsfilter.	No
└– agentName	string	Filtrera efter agentnamn.	Ja
id	sträng (skrivskyddad)	Unik identifierare för utvärderingsregeln.	Ja
systemData	objekt (skrivskyddat)	Systemmetadata för utvärderingsregeln.	Ja

EvaluationRuleAction

Åtgärdsmodell för utvärdering.

Diskriminerande för EvaluationRuleAction

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

Typvärde	Schema
`continuousEvaluation`	ContinuousEvaluationRuleAction
`humanEvaluationPreview`	HumanEvaluationPreviewRuleAction

Name	Type	Description	Obligatoriskt	Standardinställning
type	EvaluationRuleActionType	Typ av utvärderingsåtgärd.	Ja

EvaluationRuleActionType

Typ av utvärderingsåtgärd.

Property	Value
Beskrivning	Typ av utvärderingsåtgärd.
Type	string
Värden	`continuousEvaluation` `humanEvaluationPreview`

EvaluationRuleEventType

Typ av utvärderingsregelhändelse.

Property	Value
Beskrivning	Typ av utvärderingsregelhändelse.
Type	string
Värden	`responseCompleted` `manual`

EvaluationRuleFilter

Modell för utvärderingsfilter.

Name	Type	Description	Obligatoriskt	Standardinställning
agentName (agentnamn)	string	Filtrera efter agentnamn.	Ja

EvaluationRunClusterInsightRequest

Insikter om uppsättningen av utvärderingsresultat

Name	Type	Description	Obligatoriskt
evalId	string	Utvärderings-ID för insikterna.	Ja
modelConfiguration	InsightModelConfiguration	Konfiguration av modellen som används i insiktsgenereringen.	No
└– modelDeploymentName	string	Modelldistributionen som ska utvärderas. Accepterar antingen distributionsnamnet ensamt eller med anslutningsnamnet som `{connectionName}/<modelDeploymentName>`.	Ja
runIds	strängmatris	Lista över utvärderingskörnings-ID:t för insikterna.	Ja
type	enum	Typ av insiktsbegäran. Möjliga värden: `EvaluationRunClusterInsight`	Ja

EvaluationRunClusterInsightResult

Insikter från utvärderingen kör klusteranalys.

Name	Type	Description	Obligatoriskt	Standardinställning
clusterInsight	ClusterInsightResult	Insikter från klusteranalysen.	Ja
type	enum	Typen av insikter resultat. Möjliga värden: `EvaluationRunClusterInsight`	Ja

EvaluationScheduleTask

Utvärderingsuppgift för schemat.

Name	Type	Description	Obligatoriskt
configuration	object	Konfiguration för uppgiften.	No
evalId	string	Identifierare för utvärderingsgruppen.	Ja
evalRun	object	Utvärderingskörningens nyttolast.	Ja
type	enum	Möjliga värden: `Evaluation`	Ja

EvaluationTaxonomy

Definition av taxonomi för utvärdering

Name	Type	Description	Obligatoriskt
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
properties	object	Ytterligare egenskaper för utvärderingstaxonomi.	No
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	No
taxonomyInput	EvaluationTaxonomyInput	Indatakonfiguration för utvärderingstaxonomin.	Ja
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomi.	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

EvaluationTaxonomyCreateOrUpdate

Definition av taxonomi för utvärdering

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
properties	object	Ytterligare egenskaper för utvärderingstaxonomi.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	No
taxonomyInput	EvaluationTaxonomyInput	Indatakonfiguration för utvärderingstaxonomin.	Ja
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomi.	Ja

EvaluationTaxonomyInput

Indatakonfiguration för utvärderingstaxonomin.

Diskriminerande för EvaluationTaxonomyInput

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

Typvärde	Schema
`agent`	AgentTaxonomyInput

Name	Type	Description	Obligatoriskt	Standardinställning
type	EvaluationTaxonomyInputType	Typ av indata från utvärderingstaxonomin.	Ja

EvaluationTaxonomyInputType

Typ av indata från utvärderingstaxonomin.

Property	Value
Beskrivning	Typ av indata från utvärderingstaxonomin.
Type	string
Värden	`agent` `policy`

EvaluationTaxonomyInputUpdate

Indatakonfiguration för utvärderingstaxonomin.

Diskriminerande för EvaluationTaxonomyInputUpdate

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

Typvärde	Schema
`agent`	AgentTaxonomyInputUpdate

Name	Type	Description	Obligatoriskt	Standardinställning
type	EvaluationTaxonomyInputType	Typ av indata från utvärderingstaxonomin.	Ja

EvaluationTaxonomyUpdate

Definition av taxonomi för utvärdering

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
properties	object	Ytterligare egenskaper för utvärderingstaxonomi.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	No
taxonomyInput	EvaluationTaxonomyInputUpdate	Indatakonfiguration för utvärderingstaxonomin.	No
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomi.	Ja

EvaluatorCategory

Utvärderarens kategori

Property	Value
Beskrivning	Utvärderarens kategori
Type	string
Värden	`quality` `safety` `agents`

EvaluatorDefinition

Konfiguration av basutvärderare med diskriminator

Diskriminerande för EvaluatorDefinition

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

Typvärde	Schema
`code`	CodeBasedEvaluatorDefinition
`prompt`	PromptBasedEvaluatorDefinition

Name	Type	Description	Obligatoriskt
data_schema	object	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
init_parameters	object	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
metrics	object	Förteckning över utfallsmått som tagits fram av den här utvärderaren	No
type	EvaluatorDefinitionType	Definition av typ av utvärderare	Ja

EvaluatorDefinitionType

Definition av typ av utvärderare

Property	Value
Beskrivning	Definition av typ av utvärderare
Type	string
Värden	`prompt` `code` `prompt_and_code` `service` `openai_graders`

EvaluatorMetric

Utvärderare Metriska mått

Name	Type	Description	Obligatoriskt
desirable_direction	EvaluatorMetricDirection	Måttenhetens riktning som anger om ett högre värde är bättre, ett lägre värde är bättre eller neutralt	No
is_primary	boolean	Anger om det här måttet är primärt när det finns flera mått.	No
max_value	number	Maximalt värde för måttet. Om det inte anges antas det vara obundet.	No
min_value	number	Minsta värde för måttet	No
type	EvaluatorMetricType	Typ av utvärderare	No

EvaluatorMetricDirection

Måttenhetens riktning som anger om ett högre värde är bättre, ett lägre värde är bättre eller neutralt

Property	Value
Beskrivning	Måttenhetens riktning som anger om ett högre värde är bättre, ett lägre värde är bättre eller neutralt
Type	string
Värden	`increase` `decrease` `neutral`

EvaluatorMetricType

Typ av utvärderare

Property	Value
Beskrivning	Typ av utvärderare
Type	string
Värden	`ordinal` `continuous` `boolean`

EvaluatorType

Typ av utvärderare

Property	Value
Beskrivning	Typ av utvärderare
Type	string
Värden	`builtin` `custom`

EvaluatorVersion

Definition av utvärderare

Name	Type	Description	Obligatoriskt
categories	matris med EvaluatorCategory	Utvärderarens kategorier	Ja
skapad_tid	sträng (skrivskyddad)	Skapandedatum/-tid för utvärderaren	Ja
skapad av	sträng (skrivskyddad)	Skapare av utvärderaren	Ja
definitionen	EvaluatorDefinition	Konfiguration av basutvärderare med diskriminator	Ja
└– data_schema	object	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
└– init_parameters	object	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
└– mått	object	Förteckning över utfallsmått som tagits fram av den här utvärderaren	No
└– typ	EvaluatorDefinitionType	Definition av typ av utvärderare	Ja
display_name	string	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	No
evaluator_type	EvaluatorType	Typ av utvärderare	Ja
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
metadata	object	Metadata om utvärderaren	No
modified_at	sträng (skrivskyddad)	Datum och tid för senaste ändring av utvärderaren	Ja
name	sträng (skrivskyddad)	Namnet på resursen	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

EvaluatorVersionSkapa

Definition av utvärderare

Name	Type	Description	Obligatoriskt
categories	matris med EvaluatorCategory	Utvärderarens kategorier	Ja
definitionen	EvaluatorDefinition	Konfiguration av basutvärderare med diskriminator	Ja
└– data_schema	object	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
└– init_parameters	object	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
└– mått	object	Förteckning över utfallsmått som tagits fram av den här utvärderaren	No
└– typ	EvaluatorDefinitionType	Definition av typ av utvärderare	Ja
beskrivning	string	Texten för tillgångsbeskrivningen.	No
display_name	string	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	No
evaluator_type	EvaluatorType	Typ av utvärderare	Ja
metadata	object	Metadata om utvärderaren	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No

EvaluatorVersionUpdate

Definition av utvärderare

Name	Type	Description	Obligatoriskt
categories	matris med EvaluatorCategory	Utvärderarens kategorier	No
beskrivning	string	Texten för tillgångsbeskrivningen.	No
display_name	string	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	No
metadata	object	Metadata om utvärderaren	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No

FabricDataAgentToolParameters

Parametrarna för verktyget för infrastrukturdataagenten.

Name	Type	Description	Obligatoriskt	Standardinställning
project_connections	matris med ToolProjectConnection	De project anslutningar som är anslutna till det här verktyget. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget.	No

FileDatasetVersion

FilDatasetVersionsdefinition

Name	Type	Description	Obligatoriskt
connectionName	string	Anslutningsnamnet för Azure Storage konto. Krävs om startPendingUploadVersion inte anropades innan datauppsättningen skapades	No
dataUri	string	URI för data (exempel) Begränsningar: minLength: 1, mönster: `[a-zA-Z0-9_]`	Ja
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
isReference	booleskt värde (skrivskyddat)	Anger om datauppsättningen innehåller en referens till lagringen, eller om datauppsättningen hanterar själva lagringen. Om det är sant tas inte underliggande data bort när datamängdsversionen tas bort	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
type	enum	Datasettyp Möjliga värden: `uri_file`	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

FileDatasetVersionUpdate

FilDatasetVersionsdefinition

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	enum	Datasettyp Möjliga värden: `uri_file`	Ja

FolderDatasetVersion

FilDatasetVersionsdefinition

Name	Type	Description	Obligatoriskt
connectionName	string	Anslutningsnamnet för Azure Storage konto. Krävs om startPendingUploadVersion inte anropades innan datauppsättningen skapades	No
dataUri	string	URI för data (exempel) Begränsningar: minLength: 1, mönster: `[a-zA-Z0-9_]`	Ja
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
isReference	booleskt värde (skrivskyddat)	Anger om datauppsättningen innehåller en referens till lagringen, eller om datauppsättningen hanterar själva lagringen. Om det är sant tas inte underliggande data bort när datamängdsversionen tas bort	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
type	enum	Datasettyp Möjliga värden: `uri_folder`	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

FolderDatasetVersionUpdate

FilDatasetVersionsdefinition

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	enum	Datasettyp Möjliga värden: `uri_folder`	Ja

FunctionToolCall

Information om ett funktionsverktygsanrop.

Name	Type	Description	Obligatoriskt	Standardinställning
arguments	string	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format.	Ja
name	string	Namnet på funktionen som ska anropas.	Ja

HostedAgentDefinition

Definitionen av den värdbaserade agenten.

Name	Type	Description	Obligatoriskt
container_protocol_versions	matris med ProtocolVersionRecord	De protokoll som agenten stöder för inkommande kommunikation av containrarna.	Ja
cpu	string	CPU-konfigurationen för den värdbaserade agenten.	Ja
environment_variables	object	Miljövariabler som ska anges i den värdbaserade agentbehållaren.	No
bild	string	Avbildnings-ID:t för agenten, som gäller för avbildningsbaserade värdbaserade agenter.	No
Typ	enum	Möjliga värden: `hosted`	Ja
memory	string	Minneskonfigurationen för den värdbaserade agenten.	Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
└– rai_policy_name	string	Namnet på DEN RAI-princip som ska tillämpas.	Ja
tools	matris med OpenAI.Tool	En matris med verktyg som den värdbaserade agentens modell kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` .	No

HourlyRecurrenceSchedule

Schema för upprepning per timme.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `Hourly`	Ja

HumanEvaluationPreviewRuleAction

Utvärderingsregelåtgärd för mänsklig utvärdering.

Name	Type	Description	Obligatoriskt	Standardinställning
templateId	AssetId	Identifierare för en sparad tillgång.	Ja
type	enum	Möjliga värden: `humanEvaluationPreview`	Ja

Index

Indexresursdefinition

Diskriminerande för index

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

Typvärde	Schema
`AzureSearch`	AzureAISearchIndex
`ManagedAzureSearch`	ManagedAzureAISearchIndex
`CosmosDBNoSqlVectorStore`	CosmosDBIndex

Name	Type	Description	Obligatoriskt
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
type	IndexType		Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

IndexType

Property	Value
Type	string
Värden	`AzureSearch` `CosmosDBNoSqlVectorStore` `ManagedAzureSearch`

IndexUpdate

Indexresursdefinition

Diskriminerande för IndexUpdate

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

Typvärde	Schema
`AzureSearch`	AzureAISearchIndexUpdate
`ManagedAzureSearch`	ManagedAzureAISearchIndexUpdate
`CosmosDBNoSqlVectorStore`	CosmosDBIndexUpdate

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	IndexType		Ja

Insikt

Svarstexten för klusterinsikter.

Name	Type	Description	Obligatoriskt
displayName	string	Användarvänligt visningsnamn för insikten.	Ja
id	sträng (skrivskyddad)	Den unika identifieraren för insiktsrapporten.	Ja
metadata	InsightsMetadata (skrivskyddad)	Metadata om insikterna.	Ja
└– slutfördAt	string	Tidsstämpeln när insikterna slutfördes.	No
└– skapadAt	string	Tidsstämpeln när insikterna skapades.	Ja
request	InsightRequest	Begäran om insiktsrapporten.	Ja
└– typ	InsightType	Typ av begäran.	Ja
result	InsightResult (skrivskyddad)	Resultatet av insikterna.	No
└– typ	InsightType	Typen av insikter resultat.	Ja
state	Azure. Core.Foundations.OperationState (skrivskyddad)	Uppräkning som beskriver tillåtna åtgärdstillstånd.	Ja

InsightCluster

Ett kluster av analysprover.

Name	Type	Description	Obligatoriskt
beskrivning	string	Beskrivning av analysklustret.	Ja
id	string	ID:t för analysklustret.	Ja
etikett	string	Etikett för klustret	Ja
Prover	matris med InsightSample	Lista över exempel som tillhör det här klustret. Tom om exempel är en del av underkluster.	No
subClusters	matris med InsightCluster	Lista över underkluster i det här klustret. Tom om det inte finns några undermappar.	No
Förslag	string	Förslag för klustret	Ja
suggestionTitle	string	Rubriken på förslaget för klustret	Ja
weight	integer	Analysklustrets vikt. Detta anger antalet exempel i klustret.	Ja

InsightModelConfiguration

Konfiguration av modellen som används i insiktsgenereringen.

Name	Type	Description	Obligatoriskt	Standardinställning
modelDeploymentName	string	Modelldistributionen som ska utvärderas. Accepterar antingen distributionsnamnet ensamt eller med anslutningsnamnet som `{connectionName}/<modelDeploymentName>`.	Ja

InsightRequest

Begäran om insiktsrapporten.

Diskriminerande för InsightRequest

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

Typvärde	Schema
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightRequest
`AgentClusterInsight`	AgentClusterInsightRequest
`EvaluationComparison`	EvaluationComparisonInsightRequest

Name	Type	Description	Obligatoriskt	Standardinställning
type	InsightType	Begäran om insikter.	Ja

InsightResult

Resultatet av insikterna.

Diskriminerande för InsightResult

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

Typvärde	Schema
`EvaluationComparison`	EvaluationComparisonInsightResult
`EvaluationRunClusterInsight`	EvaluationRunClusterInsightResult
`AgentClusterInsight`	AgentClusterInsightResult

Name	Type	Description	Obligatoriskt	Standardinställning
type	InsightType	Begäran om insikter.	Ja

InsightSample

Ett smakprov från analysen.

Diskriminerande för InsightSample

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

Typvärde	Schema
`EvaluationResultSample`	EvaluationResultSample

Name	Type	Description	Obligatoriskt
correlationInfo	object	Information om korrelationen för analysexemplet.	Ja
features	object	Funktioner som hjälper till med ytterligare filtrering av data i UX.	Ja
id	string	Den unika identifieraren för analysexemplet.	Ja
type	SampleType	Vilken typ av prov som används i analysen.	Ja

InsightScheduleTask

Insiktsuppgift för schemat.

Name	Type	Description	Obligatoriskt
configuration	object	Konfiguration för uppgiften.	No
Insikt	Insikt	Svarstexten för klusterinsikter.	Ja
└– displayName	string	Användarvänligt visningsnamn för insikten.	Ja
└– id	sträng (skrivskyddad)	Den unika identifieraren för insiktsrapporten.	Ja
└– metadata	InsightsMetadata (skrivskyddad)	Metadata om insiktsrapporten.	Ja
└– begäran	InsightRequest	Begäran om insiktsanalys.	Ja
└– resultat	InsightResult (skrivskyddad)	Resultatet av insiktsrapporten.	No
└— tillstånd	Azure. Core.Foundations.OperationState (skrivskyddad)	Det aktuella tillståndet för insikterna.	Ja
type	enum	Möjliga värden: `Insight`	Ja

InsightSummary

Sammanfattning av felklusteranalysen.

Name	Type	Description	Obligatoriskt
method	string	Metod som används för klustring.	Ja
sampleCount	integer	Totalt antal prover som analyserats.	Ja
uniqueClusterCount	integer	Totalt antal unika kluster.	Ja
uniqueSubclusterCount	integer	Totalt antal unika underklusteretiketter.	Ja
usage	ClusterTokenUsage	Tokenanvändning för klusteranalys	Ja
└– inputTokenUsage	integer	användning av indatatoken	Ja
└— outputTokenUsage	integer	användning av utdatatoken	Ja
└— totalTokenUsage	integer	total tokenanvändning	Ja

InsightType

Begäran om insikter.

Property	Value
Beskrivning	Begäran om insikter.
Type	string
Värden	`EvaluationRunClusterInsight` `AgentClusterInsight` `EvaluationComparison`

InsightsMetadata

Metadata om insikterna.

Name	Type	Description	Obligatoriskt	Standardinställning
completedAt	string	Tidsstämpeln när insikterna slutfördes.	No
createdAt	string	Tidsstämpeln när insikterna skapades.	Ja

ItemGenerationParams

Representerar den uppsättning parametrar som används för att styra objektgenereringsåtgärder.

Diskriminerande för ItemGenerationParams

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

Typvärde	Schema
`red_team`	RedTeamItemGenerationParams
`red_team_seed_prompts`	RedTeamSeedPromptsItemGenerationParams
`red_team_taxonomy`	RedTeamTaxonomyItemGenerationParams
`response_retrieval`	ResponseRetrievalItemGenerationParams

Name	Type	Description	Obligatoriskt	Standardinställning
type	ItemGenerationParamsType	Typerna av parametrar för generering av röda teamobjekt.	Ja

ItemGenerationParamsType

Typerna av parametrar för generering av röda teamobjekt.

Property	Value
Beskrivning	Typerna av parametrar för generering av röda teamobjekt.
Type	string
Värden	`red_team` `response_retrieval` `red_team_seed_prompts` `red_team_taxonomy` `synthetic_data_gen_preview`

ManagedAzureAISearchIndex

Hanterad Azure AI-sökning indexdefinition

Name	Type	Description	Obligatoriskt
id	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	No
name	sträng (skrivskyddad)	Namnet på resursen	Ja
type	enum	Typ av index Möjliga värden: `ManagedAzureSearch`	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

ManagedAzureAISearchIndexUpdate

Hanterad Azure AI-sökning indexdefinition

Name	Type	Description	Obligatoriskt
beskrivning	string	Texten för tillgångsbeskrivningen.	No
tags	object	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	No
type	enum	Typ av index Möjliga värden: `ManagedAzureSearch`	Ja

MemoryItem

Ett enskilt minnesobjekt som lagras i minneslagret och som innehåller innehåll och metadata.

Diskriminerande för MemoryItem

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

Typvärde	Schema
`user_profile`	UserProfileMemoryItem
`chat_summary`	ChatSummaryMemoryItem

Name	Type	Description	Obligatoriskt
innehåll	string	Innehållet i minnet.	Ja
Typ	MemoryItemKind	Typ av minnesobjekt.	Ja
memory_id	string	Det unika ID:t för minnesobjektet.	Ja
scope	string	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja
updated_at	integer	Den senaste uppdateringstiden för minnesobjektet.	Ja

MemoryItemKind

Typ av minnesobjekt.

Property	Value
Beskrivning	Typ av minnesobjekt.
Type	string
Värden	`user_profile` `chat_summary`

MemoryOperation

Representerar en enskild minnesåtgärd (skapa, uppdatera eller ta bort) som utförs på ett minnesobjekt.

Name	Type	Description	Obligatoriskt
Typ	MemoryOperationKind	Typ av minnesoperation.	Ja
memory_item	MemoryItem	Ett enskilt minnesobjekt som lagras i minneslagret och som innehåller innehåll och metadata.	Ja
└– innehåll	string	Innehållet i minnet.	Ja
└– typ	MemoryItemKind	Typ av minnesobjekt.	Ja
└– memory_id	string	Det unika ID:t för minnesobjektet.	Ja
└– omfattning	string	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja
└– updated_at	integer	Den senaste uppdateringstiden för minnesobjektet.	Ja

MemoryOperationKind

Typ av minnesoperation.

Property	Value
Beskrivning	Typ av minnesoperation.
Type	string
Värden	`create` `update` `delete`

MemorySearchItem

Ett hämtat minnesobjekt från minnessökningen.

Name	Type	Description	Obligatoriskt
memory_item	MemoryItem	Ett enskilt minnesobjekt som lagras i minneslagret och som innehåller innehåll och metadata.	Ja
└– innehåll	string	Innehållet i minnet.	Ja
└– typ	MemoryItemKind	Typ av minnesobjekt.	Ja
└– memory_id	string	Det unika ID:t för minnesobjektet.	Ja
└– omfattning	string	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja
└– updated_at	integer	Den senaste uppdateringstiden för minnesobjektet.	Ja

MemorySearchOptions

Alternativ för minnessökning.

Name	Type	Description	Obligatoriskt	Standardinställning
max_memories	integer	Maximalt antal minnesobjekt som ska returneras.	No

MemorySearchPreviewTool

Ett verktyg för att integrera minnen i agenten.

Name	Type	Description	Obligatoriskt	Standardinställning
memory_store_name	string	Namnet på det minneslager som ska användas.	Ja
scope	string	Det namnområde som används för att gruppera och isolera minnen, till exempel ett användar-ID. Begränsar vilka minnen som kan hämtas eller uppdateras. Använd en särskild variabel `{{$userId}}` för att begränsa minnen till den aktuella inloggade användaren.	Ja
search_options	MemorySearchOptions	Alternativ för minnessökning.	No
└max_memories	integer	Maximalt antal minnesobjekt som ska returneras.	No
type	enum	Verktygets typ. Alltid `memory_search_preview`. Möjliga värden: `memory_search_preview`	Ja
update_delay	integer	Tid att vänta innan du uppdaterar minnen efter inaktivitet (sekunder). Standard 300.	No	300

MemorySearchToolCallItemParam

Name	Type	Description	Obligatoriskt	Standardinställning
results	matris med MemorySearchItem	Resultaten som returneras från minnessökningen.	No
type	enum	Möjliga värden: `memory_search_call`	Ja

MemorySearchToolCallItemResource

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
response_id	string	Svaret som objektet skapas på.	No
results	matris med MemorySearchItem	Resultaten som returneras från minnessökningen.	No
status	enum	Status för anropet till minnessökningsverktyget. En av `in_progress`, `searching`, `completed`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Möjliga värden: `memory_search_call`	Ja

MemoryStoreDefaultDefinition

Standardimplementering av minneslager.

Name	Type	Description	Obligatoriskt	Standardinställning
chat_model	string	Namnet eller identifieraren för distributionen av chattmodellen som används för minnesbearbetning.	Ja
embedding_model	string	Namnet eller identifieraren för den inbäddningsmodelldistribution som används för minnesbearbetning.	Ja
Typ	enum	Den typ av minneslagring. Möjliga värden: `default`	Ja
options	MemoryStoreDefaultOptions	Standardkonfigurationer för minneslager.	No
└– chat_summary_enabled	boolean	Om du vill aktivera extrahering av chattsammanfattningar och storage. Standardvärdet är sant.	Ja	True
└– user_profile_details	string	Specifika kategorier eller typer av användarprofilinformation som ska extraheras och lagras.	No
└– user_profile_enabled	boolean	Om du vill aktivera extrahering av användarprofiler och storage. Standardvärdet är sant.	Ja	True

MemoryStoreDefaultOptions

Standardkonfigurationer för minneslager.

Name	Type	Description	Obligatoriskt	Standardinställning
chat_summary_enabled	boolean	Om du vill aktivera extrahering av chattsammanfattningar och storage. Standardvärdet är sant.	Ja	True
user_profile_details	string	Specifika kategorier eller typer av användarprofilinformation som ska extraheras och lagras.	No
user_profile_enabled	boolean	Om du vill aktivera extrahering av användarprofiler och storage. Standardvärdet är sant.	Ja	True

MemoryStoreDefinition

Grundläggande definition för minneslagringskonfigurationer.

Diskriminerande för MemoryStoreDefinition

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

Typvärde	Schema
`default`	MemoryStoreDefaultDefinition

Name	Type	Description	Obligatoriskt	Standardinställning
Typ	MemoryStoreKind	Vilken typ av implementering av minneslager som ska användas.	Ja

MemoryStoreDeleteScopeResponse

Svar för att ta bort minnen från ett omfång.

Name	Type	Description	Obligatoriskt
borttagen	boolean	Om borttagningsåtgärden lyckades.	Ja
name	string	Namnet på minnesarkivet.	Ja
object	enum	Objekttypen. Alltid "memory_store.scope.deleted". Möjliga värden: `memory_store.scope.deleted`	Ja
scope	string	Omfånget från vilket minnen togs bort.	Ja

MemoryStoreKind

Vilken typ av implementering av minneslager som ska användas.

Property	Value
Beskrivning	Vilken typ av implementering av minneslager som ska användas.
Type	string
Värden	`default`

MemoryStoreObject

Ett minneslager som kan lagra och hämta användarminnen.

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpeln (sekunder) när minnesarkivet skapades.	Ja
definitionen	MemoryStoreDefinition	Grundläggande definition för minneslagringskonfigurationer.	Ja
└– typ	MemoryStoreKind	Den typ av minneslagring.	Ja
beskrivning	string	En beskrivning av minnesarkivet som kan läsas av människor. Begränsningar: maxLength: 512	No
id	string	Den unika identifieraren för minnesarkivet.	Ja
metadata	object	Godtyckliga nyckelvärdesmetadata som ska associeras med minnesarkivet.	No
name	string	Namnet på minnesarkivet. Begränsningar: maxLength: 256	Ja
object	enum	Objekttypen, som alltid är "memory_store". Möjliga värden: `memory_store`	Ja
updated_at	integer	Unix-tidsstämpeln (sekunder) när minnesarkivet senast uppdaterades.	Ja

MemoryStoreOperationUsage

Användningsstatistik för en minneslagringsåtgärd.

Name	Type	Description	Obligatoriskt
embedding_tokens	integer	Antalet inbäddningstoken.	Ja
input_tokens	OpenAI.integer		Ja
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Ja
└– cached_tokens	OpenAI.integer		Ja
output_tokens	OpenAI.integer		Ja
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Ja
└– reasoning_tokens	OpenAI.integer		Ja
total_tokens	OpenAI.integer		Ja

MemoryStoreSearchResponse

Svar på minnessökning.

Name	Type	Description	Obligatoriskt
Minnen	matris med MemorySearchItem	Relaterade minnesobjekt som hittades under sökåtgärden.	Ja
search_id	string	Det unika ID:t för den här sökbegäran. Använd det här värdet som previous_search_id i efterföljande begäranden för att utföra inkrementella sökningar.	Ja
usage	MemoryStoreOperationUsage	Användningsstatistik för en minneslagringsåtgärd.	Ja
└– embedding_tokens	integer	Antalet inbäddningstoken.	Ja
└– input_tokens	OpenAI.integer	Antalet indatatoken.	Ja
└─ inmatningstokensdetaljer	OpenAI.ResponseUsageInputTokensDetails	En detaljerad uppdelning av indatatoken.	Ja
└– output_tokens	OpenAI.integer	Antalet utdatatoken.	Ja
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	En detaljerad uppdelning av utdatatoken.	Ja
└– totalt_antal_tokenar	OpenAI.integer	Det totala antalet token som används.	Ja

MemoryStoreUpdateCompletedResult

Resultat av minnesuppdatering.

Name	Type	Description	Obligatoriskt
memory_operations	matris med MemoryOperation	En lista över enskilda minnesåtgärder som utfördes under uppdateringen.	Ja
usage	MemoryStoreOperationUsage	Användningsstatistik för en minneslagringsåtgärd.	Ja
└– embedding_tokens	integer	Antalet inbäddningstoken.	Ja
└– input_tokens	OpenAI.integer	Antalet indatatoken.	Ja
└─ inmatningstokensdetaljer	OpenAI.ResponseUsageInputTokensDetails	En detaljerad uppdelning av indatatoken.	Ja
└– output_tokens	OpenAI.integer	Antalet utdatatoken.	Ja
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	En detaljerad uppdelning av utdatatoken.	Ja
└– totalt_antal_tokenar	OpenAI.integer	Det totala antalet token som används.	Ja

MemoryStoreUpdateResponse

Anger status för en uppdateringsåtgärd för minneslagret.

Name	Type	Description	Obligatoriskt
fel	OpenAI.Error		No
└— additionalInfo	object		No
└– kod	sträng (nullbar)		Ja
└– felsökningsinfo	object		No
└— detaljer	matris med OpenAI.Error		No
└– meddelande	string		Ja
└– param	sträng (nullbar)		No
└– typ	string		No
result	MemoryStoreUpdateCompletedResult	Resultat av minnesuppdatering.	No
└– memory_operations	matris med MemoryOperation	En lista över enskilda minnesåtgärder som utfördes under uppdateringen.	Ja
└— användning	MemoryStoreOperationUsage	Användningsstatistik som är associerad med minnesuppdateringsåtgärden.	Ja
status	MemoryStoreUpdateStatus	Status för en uppdateringsåtgärd för minneslagret.	Ja
superseded_by	string	Den update_id åtgärden ersattes av när statusen är "ersatt".	No
update_id	string	Det unika ID:t för den här uppdateringsbegäran. Använd det här värdet som previous_update_id i efterföljande begäranden för att utföra inkrementella uppdateringar.	Ja

MemoryStoreUpdateStatus

Status för en uppdateringsåtgärd för minneslagret.

Property	Value
Type	string
Värden	`queued` `in_progress` `completed` `failed` `superseded`

MicrosoftFabricPreviewTool

Inmatningsdefinitionsinformationen för ett Microsoft Fabric-verktyg som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
fabric_dataagent_preview	FabricDataAgentToolParameters	Parametrarna för verktyget för infrastrukturdataagenten.	Ja
└– project_connections	matris med ToolProjectConnection	De project anslutningar som är anslutna till det här verktyget. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget. Begränsningar: maxItems: 1	No
type	enum	Objekttypen, som alltid är 'fabric_dataagent_preview'. Möjliga värden: `fabric_dataagent_preview`	Ja

Modellimplementering

Definition av modelldistribution

Name	Type	Description	Obligatoriskt
capabilities	objekt (skrivskyddat)	Funktioner i distribuerad modell	Ja
connectionName	sträng (skrivskyddad)	Namnet på anslutningen som distributionen kommer från	No
modelName	sträng (skrivskyddad)	Publisher-specifikt namn på den distribuerade modellen	Ja
modelPublisher	sträng (skrivskyddad)	Namnet på den distribuerade modellens utgivare	Ja
modellversion	sträng (skrivskyddad)	Publisher-specifik version av den distribuerade modellen	Ja
name	sträng (skrivskyddad)	Namn på distributionen	Ja
sku	Sku (skrivskyddad)	SKU-information	Ja
└— kapacitet	integer	SKU-kapacitet	Ja
└– familj	string	Sku-familj	Ja
└— namn	string	SKU-namn	Ja
└– storlek	string	SKU-storlek	Ja
└– nivå	string	SKU-nivå	Ja
type	enum	Typ av distribution Möjliga värden: `ModelDeployment`	Ja

ModelSamplingParams

Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.

Name	Type	Description	Obligatoriskt
max_completion_tokens	integer	Det maximala antalet token som tillåts i slutförandet.	Ja
seed	integer	Det slumpmässiga fröet för reproducerbarhet.	Ja
Temperatur	number	Temperaturparametern för sampling.	Ja
top_p	number	Parametern top-p för kärnsampling.	Ja

ModelSamplingParamsUpdate

Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.

Name	Type	Description	Obligatoriskt
max_completion_tokens	integer	Det maximala antalet token som tillåts i slutförandet.	No
seed	integer	Det slumpmässiga fröet för reproducerbarhet.	No
Temperatur	number	Temperaturparametern för sampling.	No
top_p	number	Parametern top-p för kärnsampling.	No

MonthlyRecurrenceSchedule

Månatligt upprepningsschema.

Name	Type	Description	Obligatoriskt	Standardinställning
daysOfMonth	matris med heltal	Dagar i månaden för upprepningsschemat.	Ja
type	enum	Månatlig upprepningstyp. Möjliga värden: `Monthly`	Ja

NoAuthenticationCredentials

Autentiseringsuppgifter som inte kräver autentisering

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av autentiseringsuppgifter Möjliga värden: `None`	Ja

OAuthConsentRequestOutputItem

Begäran från tjänsten om att användaren ska utföra OAuth-medgivande.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
consent_link	string	Länken som användaren kan använda för att utföra OAuth-medgivande.	Ja
id	string		Ja
response_id	string	Svaret som objektet skapas på.	No
serveretikett	string	Serveretiketten för OAuth-medgivandebegäran.	Ja
type	enum	Möjliga värden: `oauth_consent_request`	Ja

OneTimeTrigger

Utlösare en gång.

Name	Type	Description	Obligatoriskt	Standardinställning
timeZone	string	Tidszon för engångsutlösaren.	No	UTC
triggerAt	string	Datum och tid för engångsutlösaren i ISO 8601-format.	Ja
type	enum	Möjliga värden: `OneTime`	Ja

OpenAI.Annotation

En anteckning som gäller för ett intervall med utdatatext.

Diskriminator för OpenAI.Annotation

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

Typvärde	Schema
`file_citation`	OpenAI.FileCitationBody
`url_citation`	OpenAI.UrlCitationBody
`container_file_citation`	OpenAI.ContainerFileCitationBody
`file_path`	OpenAI.FilePath

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.AnnotationType		Ja

OpenAI.AnnotationType

Property	Value
Type	string
Värden	`file_citation` `url_citation` `container_file_citation` `file_path`

OpenAI.ApplyPatchCallOutputStatus

Property	Value
Type	string
Värden	`completed` `failed`

OpenAI.ApplyPatchCallOutputStatusParam

Utfallsvärden som rapporterats för apply_patch verktygsanropsutdata.

Property	Value
Type	string
Värden	`completed` `failed`

OpenAI.ApplyPatchCallStatus

Property	Value
Type	string
Värden	`in_progress` `completed`

OpenAI.ApplyPatchCallStatusParam

Statusvärden som rapporterats för apply_patch-verktygsanrop.

Property	Value
Type	string
Värden	`in_progress` `completed`

OpenAI.ApplyPatchCreateFileOperation

Instruktioner som beskriver hur du skapar en fil via apply_patch-verktyget.

Name	Type	Description	Obligatoriskt
Diff	string	Diff som ska tillämpas.	Ja
path	string	Sökväg till filen som ska skapas.	Ja
type	enum	Skapa en ny fil med det angivna diffet. Möjliga värden: `create_file`	Ja

OpenAI.ApplyPatchCreateFileOperationParam

Instruktioner för att skapa en ny fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt
Diff	string	Enhetligt diffinnehåll som ska tillämpas när filen skapas. Begränsningar: maxLength: 10485760	Ja
path	string	Sökväg till filen som ska skapas i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
type	enum	Åtgärdstypen. Alltid `create_file`. Möjliga värden: `create_file`	Ja

OpenAI.ApplyPatchDeleteFileOperation

Instruktion som beskriver hur du tar bort en fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt	Standardinställning
path	string	Sökväg till filen som ska tas bort.	Ja
type	enum	Ta bort den angivna filen. Möjliga värden: `delete_file`	Ja

OpenAI.ApplyPatchDeleteFileOperationParam

Instruktioner för att ta bort en befintlig fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt	Standardinställning
path	string	Sökväg till filen som ska tas bort i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
type	enum	Åtgärdstypen. Alltid `delete_file`. Möjliga värden: `delete_file`	Ja

OpenAI.ApplyPatchFileOperation

En av de create_file, delete_file eller update_file åtgärder som tillämpas via apply_patch.

Diskriminerande för OpenAI.ApplyPatchFileOperation

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

Typvärde	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperation
`delete_file`	OpenAI.ApplyPatchDeleteFileOperation
`update_file`	OpenAI.ApplyPatchUpdateFileOperation

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ApplyPatchFileOperationType		Ja

OpenAI.ApplyPatchFileOperationType

Property	Value
Type	string
Värden	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchOperationParam

En av de create_file, delete_file eller update_file åtgärder som tillhandahålls till apply_patch-verktyget.

Diskriminerande för OpenAI.ApplyPatchOperationParam

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

Typvärde	Schema
`create_file`	OpenAI.ApplyPatchCreateFileOperationParam
`delete_file`	OpenAI.ApplyPatchDeleteFileOperationParam
`update_file`	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ApplyPatchOperationParamType		Ja

OpenAI.ApplyPatchOperationParamType

Property	Value
Type	string
Värden	`create_file` `delete_file` `update_file`

OpenAI.ApplyPatchToolParam

Tillåter att assistenten skapar, tar bort eller uppdaterar filer med hjälp av enhetliga diffs.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Verktygets typ. Alltid `apply_patch`. Möjliga värden: `apply_patch`	Ja

OpenAI.ApplyPatchUpdateFileOperation

Instruktioner som beskriver hur du uppdaterar en fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt
Diff	string	Diff som ska tillämpas.	Ja
path	string	Sökväg till filen som ska uppdateras.	Ja
type	enum	Uppdatera en befintlig fil med det angivna diffet. Möjliga värden: `update_file`	Ja

OpenAI.ApplyPatchUpdateFileOperationParam

Instruktioner för att uppdatera en befintlig fil via verktyget apply_patch.

Name	Type	Description	Obligatoriskt
Diff	string	Enhetligt diffinnehåll som ska tillämpas på den befintliga filen. Begränsningar: maxLength: 10485760	Ja
path	string	Sökväg till filen som ska uppdateras i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
type	enum	Åtgärdstypen. Alltid `update_file`. Möjliga värden: `update_file`	Ja

OpenAI.UppskattadPlats

Name	Type	Description	Obligatoriskt
Staden	sträng (nullbar)		No
land	sträng (nullbar)		No
region	sträng (nullbar)		No
timezone	sträng (nullbar)		No
type	enum	Typ av platsnärmning. Alltid `approximate`. Möjliga värden: `approximate`	Ja

OpenAI.ChatCompletionTool

Ett funktionsverktyg som kan användas för att generera ett svar.

Name	Type	Description	Obligatoriskt	Standardinställning
function	OpenAI.FunctionObject		Ja
type	enum	Verktygets typ. För närvarande stöds endast `function`. Möjliga värden: `function`	Ja

OpenAI.ChatModel

Property Value

Type string

Värden gpt-5.2
gpt-5.2-2025-12-11
gpt-5.2-chat-latest
gpt-5.2-pro
gpt-5.2-pro-2025-12-11
gpt-5.1
gpt-5.1-2025-11-13
gpt-5.1-codex
gpt-5.1-mini
gpt-5.1-chat-latest
gpt-5
gpt-5-mini
gpt-5-nano
gpt-5-2025-08-07
gpt-5-mini-2025-08-07
gpt-5-nano-2025-08-07
gpt-5-chat-latest
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4.1-2025-04-14
gpt-4.1-mini-2025-04-14
gpt-4.1-nano-2025-04-14
o4-mini
o4-mini-2025-04-16
o3
o3-2025-04-16
o3-mini
o3-mini-2025-01-31
o1
o1-2024-12-17
o1-preview
o1-preview-2024-09-12
o1-mini
o1-mini-2024-09-12
gpt-4o
gpt-4o-2024-11-20
gpt-4o-2024-08-06
gpt-4o-2024-05-13
gpt-4o-audio-preview
gpt-4o-audio-preview-2024-10-01
gpt-4o-audio-preview-2024-12-17
gpt-4o-audio-preview-2025-06-03
gpt-4o-mini-audio-preview
gpt-4o-mini-audio-preview-2024-12-17
gpt-4o-search-preview
gpt-4o-mini-search-preview
gpt-4o-search-preview-2025-03-11
gpt-4o-mini-search-preview-2025-03-11
chatgpt-4o-latest
codex-mini-latest
gpt-4o-mini
gpt-4o-mini-2024-07-18
gpt-4-turbo
gpt-4-turbo-2024-04-09
gpt-4-0125-preview
gpt-4-turbo-preview
gpt-4-1106-preview
gpt-4-vision-preview
gpt-4
gpt-4-0314
gpt-4-0613
gpt-4-32k
gpt-4-32k-0314
gpt-4-32k-0613
gpt-3.5-turbo
gpt-3.5-turbo-16k
gpt-3.5-turbo-0301
gpt-3.5-turbo-0613
gpt-3.5-turbo-1106
gpt-3.5-turbo-0125
gpt-3.5-turbo-16k-0613

OpenAI.ClickButtonType

Property	Value
Type	string
Värden	`left` `right` `wheel` `back` `forward`

OpenAI.ClickParam

En klickåtgärd.

Name	Type	Description	Obligatoriskt
knapp	OpenAI.ClickButtonType		Ja
type	enum	Anger händelsetypen. För en klickåtgärd är den här egenskapen alltid `click`. Möjliga värden: `click`	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.CodeInterpreterContainerAuto

Konfiguration för en kodtolkarcontainer. Du kan också ange ID:t för de filer som koden ska köras på.

Name	Type	Description	Obligatoriskt
fil_identiteter	strängmatris	En valfri lista över uppladdade filer som ska vara tillgängliga för din kod.	No
minnesgräns	OpenAI.ContainerMemoryLimit (nullbar)		No
type	enum	Alltid `auto`. Möjliga värden: `auto`	Ja

OpenAI.CodeInterpreterOutputImage

Bildutdata från kodtolkaren.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av utdata. Alltid `image`. Möjliga värden: `image`	Ja
url	string	URL:en för bildens utdata från kodtolkaren.	Ja

OpenAI.CodeInterpreterOutputLogs

Loggutdata från kodtolkaren.

Name	Type	Description	Obligatoriskt	Standardinställning
logs	string	Loggutdata från kodtolkaren.	Ja
type	enum	Typ av utdata. Alltid `logs`. Möjliga värden: `logs`	Ja

OpenAI.CodeInterpreterTool

Ett verktyg som kör Python-kod för att generera ett svar på en fråga.

Name	Type	Description	Obligatoriskt	Standardinställning
container	string eller OpenAI.CodeInterpreterContainerAuto	Kodtolkarcontainern. Kan vara ett container-ID eller ett objekt som anger uppladdade fil-ID:er som ska vara tillgängliga för din kod, tillsammans med en valfri `memory_limit` inställning. Om den inte tillhandahålls förutsätter tjänsten automatisk.	No
type	enum	Typ av kodtolkarverktyg. Alltid `code_interpreter`. Möjliga värden: `code_interpreter`	Ja

OpenAI.CompactResource

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när den komprimerade konversationen skapades.	Ja
id	string	Den unika identifieraren för det komprimerade svaret.	Ja
object	enum	Objekttypen. Alltid `response.compaction`. Möjliga värden: `response.compaction`	Ja
output	matris med OpenAI.OutputItem	Den komprimerade listan över utdataobjekt. Det här är en lista över alla användarmeddelanden, följt av ett enda komprimeringsobjekt.	Ja
usage	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Ja
└– input_tokens	OpenAI.integer	Antalet indatatoken.	Ja
└─ inmatningstokensdetaljer	OpenAI.ResponseUsageInputTokensDetails	En detaljerad uppdelning av indatatoken.	Ja
└– output_tokens	OpenAI.integer	Antalet utdatatoken.	Ja
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	En detaljerad uppdelning av utdatatoken.	Ja
└– totalt_antal_tokenar	OpenAI.integer	Det totala antalet token som används.	Ja

OpenAI.CompactResponseMethodPublicBody

Name	Type	Description	Obligatoriskt
Input	sträng eller matris med OpenAI.InputItem		No
instructions	sträng (nullbar)		No
model	OpenAI.ModelIdsCompaction	Modell-ID som används för att generera svaret, till exempel `gpt-5` eller `o3`. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestandaegenskaper och prispunkter. Se modellguiden för att bläddra bland och jämföra tillgängliga modeller.	Ja
previous_response_id	sträng (nullbar)		No

OpenAI.ComparisonFilter (jämförelsefilter)

Ett filter som används för att jämföra en angiven attributnyckel med ett angivet värde med hjälp av en definierad jämförelseåtgärd.

Name	Type	Description	Obligatoriskt
key	string	Nyckeln som ska jämföras med värdet.	Ja
type	enum	Anger jämförelseoperatorn: , , , , `eqne`, , `gt`, `gte`, . `ltlteinnin` - `eq`: Motsvarar - `ne`: inte lika med - `gt`: större än - `gte`: större än eller lika med - `lt`: mindre än - `lte`: mindre än eller lika med - `in`:I - `nin`: inte i Möjliga värden: `eq`, `ne`, `gt`, `gte`, , `ltlte`	Ja
value	string eller OpenAI.numeric eller boolesk eller matris med OpenAI.ComparisonFilterValueItems	Det värde som ska jämföras med attributnyckeln. stöder sträng-, nummer- eller booleska typer.	Ja

OpenAI.ComparisonFilterValueItems

Typ: sträng eller OpenAI.numeric

OpenAI.CompoundFilter

Kombinera flera filter med and eller or.

Name	Type	Description	Obligatoriskt	Standardinställning
filters	matris med OpenAI.ComparisonFilter eller objekt	Matris med filter som ska kombineras. Objekt kan vara `ComparisonFilter` eller `CompoundFilter`.	Ja
type	enum	Typ av åtgärd: `and` eller `or`. Möjliga värden: `and`, `or`	Ja

OpenAI.ComputerAction

Diskriminerande för OpenAI.ComputerAction

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

Typvärde	Schema
`click`	OpenAI.ClickParam
`double_click`	OpenAI.DoubleClickAction
`drag`	OpenAI.Drag
`keypress`	OpenAI.KeyPressAction
`move`	OpenAI.Move
`screenshot`	OpenAI.Screenshot
`scroll`	OpenAI.Scroll
`type`	OpenAI.Type
`wait`	OpenAI.Wait

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ComputerActionType		Ja

OpenAI.ComputerActionType

Property	Value
Type	string
Värden	`click` `double_click` `drag` `keypress` `move` `screenshot` `scroll` `type` `wait`

OpenAI.ComputerCallSafetyCheckParam

En väntande säkerhetskontroll för datorsamtalet.

Name	Type	Description	Obligatoriskt
code	sträng (nullbar)		No
id	string	ID för den väntande säkerhetskontrollen.	Ja
message	sträng (nullbar)		No

OpenAI.ComputerEnvironment

Property	Value
Type	string
Värden	`windows` `mac` `linux` `ubuntu` `browser`

OpenAI.ComputerScreenshotContent

En skärmbild av en dator.

Name	Type	Description	Obligatoriskt
file_id	sträng (nullbar)		Ja
image_url	string		Ja
type	enum	Anger händelsetypen. För en datorskärm är den här egenskapen alltid inställd på `computer_screenshot`. Möjliga värden: `computer_screenshot`	Ja

OpenAI.ComputerScreenshotImage

En skärmbild av datorn som används med datoranvändningsverktyget.

Name	Type	Description	Obligatoriskt
file_id	string	Identifieraren för en uppladdad fil som innehåller skärmbilden.	No
image_url	string	URL:en för skärmbilden.	No
type	enum	Anger händelsetypen. För en datorskärm är den här egenskapen alltid inställd på `computer_screenshot`. Möjliga värden: `computer_screenshot`	Ja

OpenAI.Datoranvändningsförhandsgranskningsverktyg

Ett verktyg som styr en virtuell dator.

Name	Type	Description	Obligatoriskt
skärmhöjd	OpenAI.integer		Ja
skärmbredd	OpenAI.integer		Ja
environment	OpenAI.ComputerEnvironment		Ja
type	enum	Typ av datoranvändningsverktyg. Alltid `computer_use_preview`. Möjliga värden: `computer_use_preview`	Ja

OpenAI.ContainerFileCitationBody

En källhänvisning för en containerfil som används för att generera ett modellsvar.

Name	Type	Description	Obligatoriskt
container_id	string	ID:t för containerfilen.	Ja
end_index	OpenAI.integer		Ja
file_id	string	ID:t för filen.	Ja
filename	string	Filnamnet för containerfilen som citeras.	Ja
start_index	OpenAI.integer		Ja
type	enum	Typ av källhänvisning för containerfilen. Alltid `container_file_citation`. Möjliga värden: `container_file_citation`	Ja

OpenAI.ContainerMemoryLimit

Property	Value
Type	string
Värden	`1g` `4g` `16g` `64g`

OpenAI.ConversationItem

Ett enskilt objekt i en konversation. Uppsättningen med möjliga typer är samma som output typen av ett svarsobjekt.

Diskriminerande för OpenAI.ConversationItem

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

Typvärde	Schema
`message`	OpenAI.ConversationItemMessage
`function_call`	OpenAI.ConversationItemFunctionToolCallResource
`function_call_output`	OpenAI.ConversationItemFunctionToolCallOutputResource
`file_search_call`	OpenAI.ConversationItemFileSearchToolCall
`web_search_call`	OpenAI.ConversationItemWebSearchToolCall
`image_generation_call`	OpenAI.ConversationItemImageGenToolCall
`computer_call`	OpenAI.ConversationItemComputerToolCall
`computer_call_output`	OpenAI.ConversationItemComputerToolCallOutputResource
`reasoning`	OpenAI.ConversationItemReasoningItem
`code_interpreter_call`	OpenAI.ConversationItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ConversationItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ConversationItemLocalShellToolCallOutput
`shell_call`	OpenAI.ConversationItemFunctionShellCall
`shell_call_output`	OpenAI.ConversationItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.ConversationItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ConversationItemApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ConversationItemMcpListTools
`mcp_approval_request`	OpenAI.ConversationItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ConversationItemMcpApprovalResponseResource
`mcp_call`	OpenAI.ConversationItemMcpToolCall
`custom_tool_call`	OpenAI.ConversationItemCustomToolCall
`custom_tool_call_output`	OpenAI.ConversationItemCustomToolCallOutput

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ConversationItemType		Ja

OpenAI.ConversationItemApplyPatchToolCall

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för anropet använd korrigeringsverktyg. Fylls i när det här objektet returneras via API.	Ja
Operation	OpenAI.ApplyPatchFileOperation	En av de create_file, delete_file eller update_file åtgärder som tillämpas via apply_patch.	Ja
└– typ	OpenAI.ApplyPatchFileOperationType		Ja
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja

OpenAI.ConversationItemApplyPatchToolCallOutput

Utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktyget anropar utdata.	No
id	string	Det unika ID:t för anropsutdata för det tillämpade korrigeringsverktyget. Fylls i när det här objektet returneras via API.	Ja
output	sträng (nullbar)		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja

OpenAI.ConversationItemCodeInterpreterToolCall

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt
code	sträng (nullbar)		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja

OpenAI.ConversationItemComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Mer information finns i guiden för datoranvändning .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.ComputerAction		Ja
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja

OpenAI.ConversationItemComputerToolCallOutputResource

Name	Type	Description	Obligatoriskt
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De säkerhetskontroller som rapporterats av API:et och som har bekräftats av utvecklare.	No
call_id	string	ID:t för datorverktygets anrop som genererade utdata.	Ja
id	string	ID:t för datorverktyget anropar utdata.	No
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av utdata från datorverktygsanrop. Alltid `computer_call_output`. Möjliga värden: `computer_call_output`	Ja

OpenAI.ConversationItemCustomToolCall

Ett anrop till ett anpassat verktyg som skapats av modellen.

Name	Type	Description	Obligatoriskt
call_id	string	En identifierare som används för att mappa det här anpassade verktygsanropet till ett verktygsanropsutdata.	Ja
id	string	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	No
Input	string	Indata för det anpassade verktygsanropet som genereras av modellen.	Ja
name	string	Namnet på det anpassade verktyg som anropas.	Ja
type	enum	Typ av anpassat verktygsanrop. Alltid `custom_tool_call`. Möjliga värden: `custom_tool_call`	Ja

OpenAI.ConversationItemCustomToolCallOutput

Utdata från ett anpassat verktygsanrop från koden som skickas tillbaka till modellen.

Name	Type	Description	Obligatoriskt
call_id	string	Anrops-ID:t som används för att mappa det här anpassade verktyget anropar utdata till ett anpassat verktygsanrop.	Ja
id	string	Det unika ID:t för det anpassade verktyget anropar utdata i OpenAI-plattformen.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från det anpassade verktygsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
type	enum	Typen av anpassade verktyg anropar utdata. Alltid `custom_tool_call_output`. Möjliga värden: `custom_tool_call_output`	Ja

OpenAI.ConversationItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Mer information finns i filsökningsguiden .

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
results	matris med OpenAI.FileSearchToolCallResults		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.ConversationItemFunctionShellCall

Ett verktygsanrop som kör ett eller flera gränssnittskommandon i en hanterad miljö.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.FunctionShellAction	Kör ett gränssnittskommando.	Ja
└– kommandon	strängmatris		Ja
└– max_output_length	OpenAI.integer (nullbar)		Ja
└– timeout_ms	OpenAI.integer (nullbar)		Ja
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för gränssnittets verktygsanrop. Fylls i när det här objektet returneras via API.	Ja
status	OpenAI.LocalShellCallStatus		Ja
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja

OpenAI.ConversationItemFunctionShellCallOutput

Utdata från ett gränssnittsverktygsanrop som har genererats.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för shell-anropets utdata. Fylls i när det här objektet returneras via API.	Ja
max_output_length	OpenAI.integer (nullbar)		Ja
output	matris med OpenAI.FunctionShellCallOutputContent	En matris med gränssnittsanropets utdatainnehåll	Ja
type	enum	Typ av gränssnittsanropets utdata. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	string	Det unika ID:t för funktionsverktygets anropsresultat. Fylls i när det här objektet returneras via API.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från funktionsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av utdata från funktionsverktygets anrop. Alltid `function_call_output`. Möjliga värden: `function_call_output`	Ja

OpenAI.ConversationItemFunctionToolCallResource

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	string	Det unika ID:t för funktionsverktygets anrop.	No
name	string	Namnet på den funktion som ska köras.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.ConversationItemImageGenToolCall

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
result	sträng (nullbar)		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.ConversationItemList

En lista över konversationsobjekt.

Name	Type	Description	Obligatoriskt
data	matris med OpenAI.ConversationItem	En lista över konversationsobjekt.	Ja
first_id	string	ID för det första objektet i listan.	Ja
har_mer	boolean	Om det finns fler tillgängliga objekt.	Ja
last_id	string	ID för det sista objektet i listan.	Ja
object	enum	Den typ av objekt som returneras måste vara `list`. Möjliga värden: `list`	Ja

OpenAI.ConversationItemLocalShellToolCall

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.ConversationItemLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	string	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av anropsutdata för det lokala gränssnittet. Alltid `local_shell_call_output`. Möjliga värden: `local_shell_call_output`	Ja

OpenAI.ConversationItemMcpApprovalRequest

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.ConversationItemMcpApprovalResponseResource

Ett svar på en begäran om MCP-godkännande.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
id	string	Det unika ID:t för godkännandesvaret	Ja
reason	sträng (nullbar)		No
type	enum	Typ av objekt. Alltid `mcp_approval_response`. Möjliga värden: `mcp_approval_response`	Ja

OpenAI.ConversationItemMcpListTools

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
fel	sträng (nullbar)		No
id	string	Listans unika ID.	Ja
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.ConversationItemMcpToolCall

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
approval_request_id	sträng (nullbar)		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.ConversationItemMessage

Ett meddelande till eller från modellen.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.MessageContent	Innehållet i meddelandet	Ja
id	string	Det unika ID:t för meddelandet.	Ja
role	OpenAI.MessageRole		Ja
status	OpenAI.MessageStatus		Ja
type	enum	Typ av meddelande. Ställ alltid in på `message`. Möjliga värden: `message`	Ja

OpenAI.ConversationItemReasoningItem

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att inkludera dessa objekt i api input :et för svar för efterföljande konversationer om du hanterar kontexten manuellt.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.ReasoningTextContent	Textinnehåll i resonemang.	No
encrypted_content	sträng (nullbar)		No
id	string	Den unika identifieraren för resonemangsinnehållet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
summary	matris med OpenAI.Summary	Sammanfattningsinnehåll för resonemang.	Ja
type	enum	Typ av objekt. Alltid `reasoning`. Möjliga värden: `reasoning`	Ja

OpenAI.ConversationItemType

Property Value

Type string

Värden message
function_call
function_call_output
file_search_call
web_search_call
image_generation_call
computer_call
computer_call_output
reasoning
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call
custom_tool_call_output

OpenAI.ConversationItemWebSearchToolCall

Resultatet av ett webbsökningsverktygsanrop. Mer information finns i webbsökningsguiden .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, sök).	Ja
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.ConversationParam

Konversationen som det här svaret tillhör. Objekt från den här konversationen förbereds för input_items den här svarsbegäran. Indataobjekt och utdataobjekt från det här svaret läggs automatiskt till i den här konversationen när det här svaret har slutförts.

Typ: sträng eller OpenAI.ConversationParam-2

OpenAI.ConversationParam-2

Konversationen som det här svaret tillhör.

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	Konversationens unika ID.	Ja

OpenAI.ConversationReference

Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	Det unika ID:t för konversationen som det här svaret var associerat med.	Ja

OpenAI.ConversationResource

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Tiden då konversationen skapades, mätt i sekunder sedan Unix-epoken.	Ja
id	string	Konversationens unika ID.	Ja
metadata	OpenAI.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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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
object	enum	Objekttypen, som alltid är `conversation`. Möjliga värden: `conversation`	Ja

OpenAI.CreateChatCompletionRequestResponseFormat

Ett objekt som anger det format som modellen måste mata ut. Inställning för att { "type": "json_schema", "json_schema": {...} } aktivera strukturerade utdata som säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i guiden Strukturerade utdata. Att ställa in { "type": "json_object" } aktiverar det äldre JSON-läget, vilket säkerställer att meddelandet som modellen genererar är giltig JSON. Att använda json_schema är att föredra för modeller som stöder det.

Diskriminerande för OpenAI.CreateChatCompletionRequestResponseFormat

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

Typvärde	Schema
`text`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
`json_object`	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Ja

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSON-objektsvarsformat. En äldre metod för att generera JSON-svar. Användning json_schema rekommenderas för modeller som stöder det. Observera att modellen inte genererar JSON utan att ett system- eller användarmeddelande instruerar den att göra så.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `json_object`. Möjliga värden: `json_object`	Ja

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

Standardformat för svar. Används för att generera textsvar.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `text`. Möjliga värden: `text`	Ja

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Value
Type	string
Värden	`text` `json_schema` `json_object`

OpenAI.CreateConversationBody

Name	Type	Description	Obligatoriskt	Standardinställning
items	matris med OpenAI.InputItem		No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No

OpenAI.CreateEvalCompletionsRunDataSource

Ett CompletionsRunDataSource-objekt som beskriver en modellsamplingskonfiguration.

Name	Type	Description	Obligatoriskt
inmatningsmeddelanden	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate eller OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Används vid sampling från en modell. Avgör strukturen för de meddelanden som skickas till modellen. Kan antingen vara en referens till en fördefinierad bana (dvs. `item.input_trajectory`) eller en mall med variabelreferenser till `item` namnområdet.	No
model	string	Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini").	No
provtagning_parametrar	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource eller OpenAI.EvalStoredCompletionsSource	Avgör vad som fyller `item` namnområdet i den här körningens datakälla.	Ja
type	enum	Typen av körningsdatakälla. Alltid `completions`. Möjliga värden: `completions`	Ja

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Type	Description	Obligatoriskt	Standardinställning
item_reference	string		Ja
type	enum	Möjliga värden: `item_reference`	Ja

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Type	Description	Obligatoriskt	Standardinställning
mall	matris med OpenAI.EasyInputMessage eller OpenAI.EvalItem		Ja
type	enum	Möjliga värden: `template`	Ja

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Type	Description	Obligatoriskt	Standardinställning
max_completion_tokens	OpenAI.integer		No
resonemangsansträngning	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
svarsformat	OpenAI.ResponseFormatText eller OpenAI.ResponseFormatJsonSchema eller OpenAI.ResponseFormatJsonObject		No
seed	OpenAI.integer		No	42
Temperatur	OpenAI.numeric		No	1
tools	matris med OpenAI.ChatCompletionTool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalCustomDataSourceConfig

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 vara:

Används för att definiera dina testkriterier och
Vilka data som krävs när du skapar en körning

Name	Type	Description	Obligatoriskt
inkludera_exempelschema	boolean	Om utvärderingen ska förutsätta att du fyller exempelnamnområdet (dvs. genom att generera svar från din datakälla)	No
objektschema	object	Json-schemat för varje rad i datakällan.	Ja
type	enum	Typen av datakälla. Alltid `custom`. Möjliga värden: `custom`	Ja

OpenAI.CreateEvalJsonlRunDataSource

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

Name	Type	Description	Obligatoriskt	Standardinställning
source	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource	Avgör vad som fyller `item` namnområdet i datakällan.	Ja
type	enum	Typen av datakälla. Alltid `jsonl`. Möjliga värden: `jsonl`	Ja

OpenAI.CreateEvalLogsDataSourceConfig

En konfiguration av datakälla som anger metadataegenskapen för loggfrågan. Det här är vanligtvis metadata som usecase=chatbot eller prompt-version=v2osv.

Name	Type	Description	Obligatoriskt	Standardinställning
metadata	object	Metadatafilter för loggdatakällan.	No
type	enum	Typen av datakälla. Alltid `logs`. Möjliga värden: `logs`	Ja

OpenAI.CreateEvalResponsesRunDataSource

Ett ResponsesRunDataSource-objekt som beskriver en modellsamplingskonfiguration.

Name	Type	Description	Obligatoriskt
inmatningsmeddelanden	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate eller OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Används vid sampling från en modell. Avgör strukturen för de meddelanden som skickas till modellen. Kan antingen vara en referens till en fördefinierad bana (dvs. `item.input_trajectory`) eller en mall med variabelreferenser till `item` namnområdet.	No
model	string	Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini").	No
provtagning_parametrar	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource eller OpenAI.EvalResponsesSource	Avgör vad som fyller `item` namnområdet i den här körningens datakälla.	Ja
type	enum	Typen av körningsdatakälla. Alltid `responses`. Möjliga värden: `responses`	Ja

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Type	Description	Obligatoriskt	Standardinställning
item_reference	string		Ja
type	enum	Möjliga värden: `item_reference`	Ja

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Type	Description	Obligatoriskt	Standardinställning
mall	matris med objekt eller OpenAI.EvalItem		Ja
type	enum	Möjliga värden: `template`	Ja

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Type	Description	Obligatoriskt	Standardinställning
max_completion_tokens	OpenAI.integer		No
resonemangsansträngning	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
seed	OpenAI.integer		No	42
Temperatur	OpenAI.numeric		No	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	matris med OpenAI.Tool		No
top_p	OpenAI.numeric		No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	Type	Description	Obligatoriskt	Standardinställning
format	OpenAI.TextResponseFormatConfiguration	Ett objekt som anger det format som modellen måste mata ut. Konfigurera `{ "type": "json_schema" }` möjliggör strukturerade utdata, som säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i Standardformatet är `{ "type": "text" }` utan ytterligare alternativ. Rekommenderas inte för gpt-4o och nyare modeller:* Inställning som gör att `{ "type": "json_object" }` aktiverar det äldre JSON-läget, vilket ser till att meddelandet som modellen genererar är giltigt JSON. Att använda `json_schema` är att föredra för modeller som stöder det.	No

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Inaktuell till förmån för LogsDataSourceConfig.

Name	Type	Description	Obligatoriskt	Standardinställning
metadata	object	Metadatafiltret för datakällan med lagrade färdigställanden.	No
type	enum	Typen av datakälla. Alltid `stored_completions`. Möjliga värden: `stored_completions`	Ja

OpenAI.CreateFineTuningJobRequest

Giltiga modeller:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	Type	Description	Obligatoriskt	Standardinställning
hyperparametrar	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└– batch_size	string eller OpenAI.integer		No	bil
└– inlärningshastighetsmultiplikator	string eller OpenAI.numeric		No
└– n_epochs	string eller OpenAI.integer		No	bil
Integrationer	matris med OpenAI.CreateFineTuningJobRequestIntegrations	En lista över integreringar som ska aktiveras för ditt finjusteringsjobb.	No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
method	OpenAI.FineTuneMethod	Metoden som används för finjustering.	No
model	sträng (se giltiga modeller nedan)	Namnet på modellen som ska finjusteras. Du kan välja en av de modeller som stöds.	Ja
seed	OpenAI.integer (nullbar)		No
Suffix	sträng (nullbar)	En sträng på upp till 64 tecken som läggs till i ditt finjusterade modellnamn. Till exempel skulle en `suffix` av "custom-model-name" generera ett modellnamn som `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`. Begränsningar: minLength: 1, maxLength: 64	No
utbildningsfil	string	ID för en uppladdad fil som innehåller träningsdata. Se ladda upp en fil för att ladda upp en fil. Datamängden måste formateras som en JSONL-fil. Dessutom måste du ladda upp filen med syftet `fine-tune`. Innehållet i filen bör variera beroende på om modellen använder chattformatet, slutförandeformatet eller om finjusteringsmetoden använder inställningsformatet. Mer information finns i finjusteringsguiden .	Ja
validation_file	sträng (nullbar)	ID för en uppladdad fil som innehåller valideringsdata. Om du anger den här filen används data för att generera validering mätvärden under finjusteringen regelbundet. Dessa mått kan visas i finjusteringsresultatfilen. Samma data bör inte finnas i både tränings- och valideringsfiler. Datamängden måste formateras som en JSONL-fil. Du måste ladda upp filen med syftet `fine-tune`. Mer information finns i finjusteringsguiden .	No

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Type	Obligatoriskt
batchstorlek	string eller OpenAI.integer	No
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	No
antal epoker	string eller OpenAI.integer	No

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `wandb`	Ja
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Ja

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Type	Obligatoriskt
enhet	sträng (nullbar)	No
name	sträng (nullbar)	No
project	string	Ja
tags	strängmatris	No

OpenAI.CreateResponseStreamingResponse

OpenAI.CustomGrammarFormatParam

En grammatik som definieras av användaren.

Name	Type	Description	Obligatoriskt
definitionen	string	Grammatikdefinitionen.	Ja
Syntax	OpenAI.GrammarSyntax1		Ja
type	enum	Grammatikformat. Alltid `grammar`. Möjliga värden: `grammar`	Ja

OpenAI.CustomTextFormatParam

Obehindrat friformatstext.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Obehindrat textformat. Alltid `text`. Möjliga värden: `text`	Ja

OpenAI.CustomToolParam

Ett anpassat verktyg som bearbetar indata med ett angivet format. Läs mer om anpassade verktyg

Name	Type	Description	Obligatoriskt
beskrivning	string	Valfri beskrivning av det anpassade verktyget som används för att ge mer kontext.	No
format	OpenAI.CustomToolParamFormat	Indataformatet för det anpassade verktyget. Standardvärdet är obehindrat text.	No
└– typ	OpenAI.CustomToolParamFormatType		Ja
name	string	Namnet på det anpassade verktyget som används för att identifiera det i verktygsanrop.	Ja
type	enum	Typ av anpassat verktyg. Alltid `custom`. Möjliga värden: `custom`	Ja

OpenAI.CustomToolParamFormat

Indataformatet för det anpassade verktyget. Standardvärdet är obehindrat text.

Diskriminerande för OpenAI.CustomToolParamFormat

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

Typvärde	Schema
`text`	OpenAI.CustomTextFormatParam
`grammar`	OpenAI.CustomGrammarFormatParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.CustomToolParamFormatType		Ja

OpenAI.CustomToolParamFormatType

Property	Value
Type	string
Värden	`text` `grammar`

OpenAI.DeletedConversationResource

Name	Type	Description	Obligatoriskt
borttagen	boolean		Ja
id	string		Ja
object	enum	Möjliga värden: `conversation.deleted`	Ja

OpenAI.DetailEnum

Property	Value
Type	string
Värden	`low` `high` `auto`

OpenAI.DoubleClickAction

En dubbelklicksåtgärd.

Name	Type	Description	Obligatoriskt
type	enum	Anger händelsetypen. För en dubbelklicksåtgärd är den här egenskapen alltid inställd på `double_click`. Möjliga värden: `double_click`	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.Drag

En dragåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
path	matris med OpenAI.DragPoint	En matris med koordinater som representerar sökvägen för dragåtgärden. Koordinater visas som en matris av objekt, t.ex. `<br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>`	Ja
type	enum	Anger händelsetypen. För en dragåtgärd är den här egenskapen alltid inställd på `drag`. Möjliga värden: `drag`	Ja

OpenAI.DragPoint

Ett x/y-koordinatpar, t.ex. { x: 100, y: 200 }.

Name	Type	Description	Obligatoriskt	Standardinställning
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.EasyInputMessage

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.

Name	Type	Description	Obligatoriskt
innehåll	string eller OpenAI.InputMessageContentList	Text, bild eller ljudinmatning till modellen, som används för att generera ett svar. Kan också innehålla tidigare assistentsvar.	Ja
role	enum	Rollen för meddelandets inmatning. En av `user`, `assistant`, `system`eller `developer`. Möjliga värden: `user`, `assistant`, `system`, `developer`	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av meddelandeindata. Alltid `message`. Möjliga värden: `message`	Ja

OpenAI.Error

Name	Type	Obligatoriskt
ytterligareInformation	object	No
code	sträng (nullbar)	Ja
debugInfo	object	No
details	matris med OpenAI.Error	No
message	string	Ja
Param	sträng (nullbar)	No
type	string	No

OpenAI.EvalApiError

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

Name	Type	Description	Obligatoriskt	Standardinställning
code	string	Felkoden.	Ja
message	string	Felmeddelandet.	Ja

OpenAI.EvalGraderLabelModel

Name	Type	Description	Obligatoriskt
Input	matris med OpenAI.EvalItem		Ja
labels	strängmatris	Etiketterna som ska tilldelas till varje objekt i utvärderingen.	Ja
model	string	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	Ja
name	string	Namnet på bedömaren.	Ja
godkända_etiketter	strängmatris	Etiketterna som anger ett godkänt resultat. Måste vara en delmängd av etiketter.	Ja
type	enum	Objekttypen, som alltid är `label_model`. Möjliga värden: `label_model`	Ja

OpenAI.EvalGraderPython

Name	Type	Description	Obligatoriskt
image_tag	string	Avbildningstaggen som ska användas för Python-skriptet.	No
name	string	Namnet på bedömaren.	Ja
passera gränsvärde	OpenAI.numeric		No
source	string	Källkoden för Python-skriptet.	Ja
type	enum	Objekttypen, som alltid är `python`. Möjliga värden: `python`	Ja

OpenAI.EvalGraderScoreModel

Name	Type	Description	Obligatoriskt	Standardinställning
Input	matris med OpenAI.EvalItem	De indatameddelanden som utvärderas av väghyveln. Stöder text, utdatatext, indatabild och ljudinnehållsblock för indata, och kan innehålla mallsträngar.	Ja
model	string	Den modell som ska användas för utvärderingen.	Ja
name	string	Namnet på bedömaren.	Ja
passera gränsvärde	OpenAI.numeric		No
range	matris med OpenAI.numeric	Poängintervallet. Standardinställningen är `[0, 1]`.	No
provtagning_parametrar	OpenAI.EvalGraderScoreModelSamplingParams		No
└– max_completions_tokens	OpenAI.integer (nullbar)		No
└– reasoning_effort	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
└– frö	OpenAI.integer (nullbar)		No
└– temperatur	OpenAI.numeric (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
type	enum	Objekttypen, som alltid är `score_model`. Möjliga värden: `score_model`	Ja

OpenAI.EvalGraderScoreModelSamplingParams

Name	Type	Description	Obligatoriskt	Standardinställning
max_completions_tokens	OpenAI.integer (nullbar)		No
resonemangsansträngning	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
seed	OpenAI.integer (nullbar)		No
Temperatur	OpenAI.numeric (nullbar)		No
top_p	OpenAI.numeric (nullbar)		No	1

OpenAI.EvalGraderStringCheck

Name	Type	Description	Obligatoriskt
Input	string	Inmatningstexten. Detta kan innehålla mallsträngar.	Ja
name	string	Namnet på bedömaren.	Ja
Operation	enum	Strängkontrollprocessen som ska utföras. En av `eq`, `ne`, `like`eller `ilike`. Möjliga värden: `eq`, `ne`, `like`, `ilike`	Ja
hänvisning	string	Referenstexten. Detta kan innehålla mallsträngar.	Ja
type	enum	Objekttypen, som alltid är `string_check`. Möjliga värden: `string_check`	Ja

OpenAI.EvalGraderTextSimilarity

Name	Type	Description	Obligatoriskt
utvärderingsmetrik	enum	Det utvärderingsmått som ska användas. En av `cosine`, `fuzzy_match`, `bleu` `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, , `rouge_4`, , `rouge_5` eller `rouge_l`. Möjliga värden: `cosine`, `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, , `rouge_5`, `rouge_l`	Ja
Input	string	Texten som bedöms.	Ja
name	string	Namnet på bedömaren.	Ja
passera gränsvärde	OpenAI.numeric		Ja
hänvisning	string	Texten som betygsätts och jämförs med.	Ja
type	enum	Typ av väghyvel. Möjliga värden: `text_similarity`	Ja

OpenAI.EvalItem

Name	Type	Description	Obligatoriskt
innehåll	OpenAI.EvalItemContent	Indata till modellen – kan innehålla mallsträngar. Stöder text, utdatatext, indatabilder och indataljud, antingen som ett enskilt objekt eller en matris med objekt.	Ja
role	enum	Rollen för meddelandets inmatning. En av `user`, `assistant`, `system`eller `developer`. Möjliga värden: `user`, `assistant`, `system`, `developer`	Ja
type	enum	Typ av meddelandeindata. Alltid `message`. Möjliga värden: `message`	No

OpenAI.EvalItemContent

Indata till modellen – kan innehålla mallsträngar. Stöder text, utdatatext, indatabilder och indataljud, antingen som ett enskilt objekt eller en matris med objekt.

Typ: OpenAI.EvalItemContentItem eller OpenAI.EvalItemContentArray

Indata till modellen – kan innehålla mallsträngar. Stöder text, utdatatext, indatabilder och indataljud, antingen som ett enskilt objekt eller en matris med objekt.

OpenAI.EvalItemContentArray

En lista över indata, som var och en kan vara antingen indatatext, utdatatext, indatabild eller indataljudobjekt.

Matris för: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Ett enda innehållsobjekt: indatatext, utdatatext, indatabild eller indataljud.

Typ: OpenAI.EvalItemContentText eller OpenAI.EvalItemContentItemObject

Ett enda innehållsobjekt: indatatext, utdatatext, indatabild eller indataljud.

OpenAI.EvalItemContentItemObject

Ett enda innehållsobjekt: indatatext, utdatatext, indatabild eller indataljud.

Diskriminerande för OpenAI.EvalItemContentItemObject

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

Typvärde	Schema
`output_text`	OpenAI.EvalItemContentOutputText
`input_image`	OpenAI.EvalItemInputImage
`input_audio`	OpenAI.InputAudio
`input_text`	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.EvalItemContentItemObjectType		Ja

OpenAI.EvalItemContentItemObjectInputTextContent

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja

OpenAI.EvalItemContentItemObjectType

Property	Value
Type	string
Värden	`input_text` `output_text` `input_image` `input_audio`

OpenAI.EvalItemContentOutputText

En textutgång från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textutdata från modellen.	Ja
type	enum	Typ av utdatatext. Alltid `output_text`. Möjliga värden: `output_text`	Ja

OpenAI.EvalItemContentText

En textinmatning till modellen.

Typ: sträng

OpenAI.EvalItemInputImage

Ett block för bildindata som används i EvalItem-innehållsmatriser.

Name	Type	Description	Obligatoriskt
detail	string	Detaljnivån för bilden som ska skickas till modellen. En av `high`, `low`eller `auto`. Standardinställningen är `auto`.	No
image_url	string	URL:en för bildens indata.	Ja
type	enum	Typ av bildindata. Alltid `input_image`. Möjliga värden: `input_image`	Ja

OpenAI.EvalJsonlFileContentSource

Name	Type	Description	Obligatoriskt	Standardinställning
innehåll	matris med OpenAI.EvalJsonlFileContentSourceContent	Innehållet i jsonl-filen.	Ja
type	enum	Typen av jsonl-källa. Alltid `file_content`. Möjliga värden: `file_content`	Ja

OpenAI.EvalJsonlFileContentSourceContent

Name	Type	Description	Obligatoriskt	Standardinställning
item	object		Ja
exempel	object		No

OpenAI.EvalJsonlFileIdSource

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	Identifieraren för filen.	Ja
type	enum	Typen av jsonl-källa. Alltid `file_id`. Möjliga värden: `file_id`	Ja

OpenAI.EvalResponsesSource

Ett EvalResponsesSource-objekt som beskriver en konfiguration av datakällan som körs.

Name	Type	Description	Obligatoriskt
skapad_efter	OpenAI.integer (nullbar)		No
skapat_före	OpenAI.integer (nullbar)		No
sökinstruktioner	sträng (nullbar)		No
metadata	objekt (nullbart)		No
model	sträng (nullbar)		No
resonemangsansträngning	OpenAI.ReasoningEffort (nullbar)	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
Temperatur	OpenAI.numeric (nullbar)		No
tools	strängmatris		No
top_p	OpenAI.numeric (nullbar)		No
type	enum	Typen av körningsdatakälla. Alltid `responses`. Möjliga värden: `responses`	Ja
users	strängmatris		No

OpenAI.EvalRunOutputItemSample

Name	Type	Description	Obligatoriskt
fel	OpenAI.EvalApiError	Ett objekt som representerar ett felsvar från Eval-API:et.	Ja
avslutningsorsak	string		Ja
Input	matris med EvalRunOutputItemSampleInput		Ja
max_completion_tokens	OpenAI.integer		Ja
model	string		Ja
output	matris med EvalRunOutputItemSampleOutput		Ja
seed	OpenAI.integer		Ja
Temperatur	OpenAI.numeric		Ja
top_p	OpenAI.numeric		Ja
usage	OpenAI.EvalRunOutputItemSampleUsage		Ja

OpenAI.EvalRunOutputItemSampleUsage

Name	Type	Obligatoriskt
cached_tokens	OpenAI.integer	Ja
completion_tokens	OpenAI.integer	Ja
prompt_tokens	OpenAI.integer	Ja
total_tokens	OpenAI.integer	Ja

OpenAI.EvalRunPerModelUsage

Name	Type	Obligatoriskt
cached_tokens	OpenAI.integer	Ja
completion_tokens	OpenAI.integer	Ja
invocation_count	OpenAI.integer	Ja
model_name	string	Ja
prompt_tokens	OpenAI.integer	Ja
total_tokens	OpenAI.integer	Ja

OpenAI.EvalRunPerTestingCriteriaResults

Name	Type	Obligatoriskt
Misslyckades	OpenAI.integer	Ja
Passerade	OpenAI.integer	Ja
testkriterier	string	Ja

OpenAI.EvalRunResultCounts

Name	Type	Obligatoriskt
fel	OpenAI.integer	Ja
Misslyckades	OpenAI.integer	Ja
Passerade	OpenAI.integer	Ja
Totala	OpenAI.integer	Ja

OpenAI.EvalStoredCompletionsSource

En StoredCompletionsRunDataSource-konfiguration som beskriver en uppsättning filter

Name	Type	Description	Obligatoriskt
skapad_efter	OpenAI.integer (nullbar)		No
skapat_före	OpenAI.integer (nullbar)		No
limit	OpenAI.integer (nullbar)		No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
model	sträng (nullbar)		No
type	enum	Typ av källa. Alltid `stored_completions`. Möjliga värden: `stored_completions`	Ja

OpenAI.FileCitationBody

En källhänvisning till en fil.

Name	Type	Description	Obligatoriskt
file_id	string	ID:t för filen.	Ja
filename	string	Filnamnet för den citerade filen.	Ja
index	OpenAI.integer		Ja
type	enum	Filreferenstyp. Alltid `file_citation`. Möjliga värden: `file_citation`	Ja

OpenAI.FilePath

En sökväg till en fil.

Name	Type	Description	Obligatoriskt
file_id	string	ID:t för filen.	Ja
index	OpenAI.integer		Ja
type	enum	Typ av filsökväg. Alltid `file_path`. Möjliga värden: `file_path`	Ja

OpenAI.FileSearchTool

Ett verktyg som söker efter relevant innehåll från uppladdade filer.

Name	Type	Description	Obligatoriskt
filters	OpenAI.Filters (nullbar)		No
maximalt antal resultat	OpenAI.integer		No
rankingalternativ	OpenAI.RankingOptions		No
└– hybrid_search	OpenAI.HybridSearchOptions	Vikter som styr hur reciprocal rank fusion balanserar semantiska inbäddningsmatchningar jämfört med glesa nyckelordsmatchningar när hybridsökning är aktiverat.	No
└— ranker	OpenAI.RankerVersionType	Rangordningen som ska användas för filsökningen.	No
└– poängtröskel	OpenAI.numeric	Tröskelvärdet för poäng för filsökningen, ett tal mellan 0 och 1. Tal närmare 1 försöker returnera endast de mest relevanta resultaten, men kan returnera färre resultat.	No
type	enum	Typ av filsökningsverktyg. Alltid `file_search`. Möjliga värden: `file_search`	Ja
vector_store_ids	strängmatris	ID:t för vektorarkiven som ska sökas.	Ja

OpenAI.FileSearchToolCallResults

Name	Type	Description	Obligatoriskt
attributes	OpenAI.VectorStoreFileAttributes (nullable)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. Nycklar är strängar med en maximal längd på 64 tecken. Värden är strängar med ett maxvärde längd på 512 tecken, booleska värden eller tal.	No
file_id	string		No
filename	string		No
Poäng	number		No
text	string		No

OpenAI.Filters

Typ: OpenAI.ComparisonFilter eller OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

De hyperparametrar som används för DPO-finjusteringsjobbet.

Name	Type	Description	Obligatoriskt
batchstorlek	string eller OpenAI.integer	Antal exempel i varje batch. En större batchstorlek innebär att modellparametrar uppdateras mindre ofta, men med lägre varians.	No
beta	string eller OpenAI.numeric	Betavärdet för DPO-metoden. Ett högre betavärde ökar straffvikten mellan principen och referensmodellen.	No
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	Skalningsfaktor för inlärningsfrekvensen. En mindre inlärningshastighet kan vara användbar för att undvika överanpassning.	No
antal epoker	string eller OpenAI.integer	Antalet epoker som modellen ska tränas för. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	No

OpenAI.FineTuneDPOMethod

Konfiguration för DPO-finjusteringsmetoden.

Name	Type	Description	Obligatoriskt	Standardinställning
hyperparametrar	OpenAI.FineTuneDPOHyperparameters	De hyperparametrar som används för DPO-finjusteringsjobbet.	No

OpenAI.FineTuneMethod

Metoden som används för finjustering.

Name	Type	Description	Obligatoriskt
dataskyddsombud	OpenAI.FineTuneDPOMethod	Konfiguration för DPO-finjusteringsmetoden.	No
förstärkning	OpenAI.FineTuneReinforcementMethod	Konfiguration för finjusteringsmetoden för förstärkning.	No
Övervakas	OpenAI.FineTuneSupervisedMethod	Konfiguration för den övervakade finjusteringsmetoden.	No
type	enum	Typ av metod. Är antingen `supervised`, `dpo`eller `reinforcement`. Möjliga värden: `supervised`, `dpo`, `reinforcement`	Ja

OpenAI.FineTuneReinforcementHyperparameters

De hyperparametrar som används för finjusteringsjobbet inom förstärkning.

Name	Type	Description	Obligatoriskt
batchstorlek	string eller OpenAI.integer	Antal exempel i varje batch. En större batchstorlek innebär att modellparametrar uppdateras mindre ofta, men med lägre varians.	No
beräkningsmultiplikator	string eller OpenAI.numeric	Multiplikator på mängden beräkning som används för att utforska sökutrymme under träning.	No
utvärderingsintervall	string eller OpenAI.integer	Antalet träningssteg mellan utvärderingskörningar.	No
utvärderingsprover	string eller OpenAI.integer	Antal utvärderingsexempel som ska genereras per träningssteg.	No
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	Skalningsfaktor för inlärningsfrekvensen. En mindre inlärningshastighet kan vara användbar för att undvika överanpassning.	No
antal epoker	string eller OpenAI.integer	Antalet epoker som modellen ska tränas för. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	No
resonemangsansträngning	enum	Nivå av resonemangsarbete. Möjliga värden: `default`, `low`, `medium`, `high`	No

OpenAI.FineTuneReinforcementMethod

Konfiguration för finjusteringsmetoden för förstärkning.

Name	Type	Description	Obligatoriskt	Standardinställning
nivelleringmaskin	OpenAI.GraderStringCheck eller OpenAI.GraderTextSimilarity eller OpenAI.GraderPython eller OpenAI.GraderScoreModel eller OpenAI.GraderMulti	Den väghyvel som används för finjusteringsjobbet.	Ja
hyperparametrar	OpenAI.FineTuneReinforcementHyperparameters	De hyperparametrar som används för finjusteringsjobbet inom förstärkning.	No

OpenAI.FineTuneSupervisedHyperparameters

De hyperparametrar som används för finjusteringsjobbet.

Name	Type	Description	Obligatoriskt
batchstorlek	string eller OpenAI.integer	Antal exempel i varje batch. En större batchstorlek innebär att modellparametrar uppdateras mindre ofta, men med lägre varians.	No
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	Skalningsfaktor för inlärningsfrekvensen. En mindre inlärningshastighet kan vara användbar för att undvika överanpassning.	No
antal epoker	string eller OpenAI.integer	Antalet epoker som modellen ska tränas för. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	No

OpenAI.FineTuneSupervisedMethod

Konfiguration för den övervakade finjusteringsmetoden.

Name	Type	Description	Obligatoriskt	Standardinställning
hyperparametrar	OpenAI.FineTuneSupervisedHyperparameters	De hyperparametrar som används för finjusteringsjobbet.	No

OpenAI.FineTuningIntegration

Name	Type	Description	Obligatoriskt
type	enum	Vilken typ av integrering som aktiveras för finjusteringsjobbet Möjliga värden: `wandb`	Ja
wandb	OpenAI.FineTuningIntegrationWandb		Ja
└— entitet	sträng (nullbar)		No
└— namn	sträng (nullbar)		No
└– projekt	string		Ja
└– taggar	strängmatris		No

OpenAI.FineTuningIntegrationWandb

Name	Type	Obligatoriskt
enhet	sträng (nullbar)	No
name	sträng (nullbar)	No
project	string	Ja
tags	strängmatris	No

OpenAI.FineTuningJob

Objektet fine_tuning.job representerar ett finjusteringsjobb som har skapats via API:et.

Name	Type	Description	Obligatoriskt	Standardinställning
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet skapades.	Ja
fel	OpenAI.FineTuningJobError (nullable)		Ja
└– kod	string		Ja
└– meddelande	string		Ja
└– param	sträng (nullbar)		Ja
beräknad avslutning	integer		No
fine_tuned_model	sträng (nullbar)		Ja
avslutad_vid	integer		Ja
hyperparametrar	OpenAI.FineTuningJobHyperparameters		Ja
└– batch_size	string eller OpenAI.integer		No	bil
└– inlärningshastighetsmultiplikator	string eller OpenAI.numeric		No
└– n_epochs	string eller OpenAI.integer		No	bil
id	string	Objektidentifieraren, som kan refereras till i API-slutpunkterna.	Ja
Integrationer	matris med OpenAI.FineTuningIntegration		No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
method	OpenAI.FineTuneMethod	Metoden som används för finjustering.	No
model	string	Basmodellen som finjusteras.	Ja
object	enum	Objekttypen, som alltid är "fine_tuning.job". Möjliga värden: `fine_tuning.job`	Ja
organization_id	string	Den organisation som äger finjusteringsjobbet.	Ja
resultatfiler	strängmatris	Det kompilerade resultatfil-ID:t för finjusteringsjobbet. Du kan hämta resultatet med Api:et Files.	Ja
seed	OpenAI.integer		Ja
status	enum	Den aktuella statusen för finjusteringsjobbet, som kan vara antingen `validating_files`, `queued`, `running`, `succeeded`, `failed`eller `cancelled`. Möjliga värden: `validating_files`, `queued`, `running`, `succeeded`, , `failedcancelled`	Ja
tränade_token	OpenAI.integer (nullbar)		Ja
utbildningsfil	string	Det fil-ID:t som används för utbildning. Du kan hämta träningsdata med Files-API:et.	Ja
validation_file	sträng (nullbar)		Ja

OpenAI.FineTuningJobCheckpoint

Objektet fine_tuning.job.checkpoint representerar en modellkontrollpunkt för ett finjusteringsjobb som är redo att användas.

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när kontrollpunkten skapades.	Ja
Fintjusterad modellkontrollpunkt	string	Namnet på den finjusterade kontrollpunktsmodellen som skapas.	Ja
finjusteringsjobb_id	string	Namnet på det finjusteringsjobb från vilket denna kontrollpunkt skapades.	Ja
id	string	Kontrollpunktsidentifieraren, som kan refereras till i API-slutpunkterna.	Ja
metrics	OpenAI.FineTuningJobCheckpointMetrics		Ja
└– full_valid_loss	OpenAI.numeric		No
└– full_valid_mean_token_accuracy	OpenAI.numeric		No
└– steg	OpenAI.numeric		No
└– train_loss	OpenAI.numeric		No
└– train_mean_token_accuracy	OpenAI.numeric		No
└– valid_loss	OpenAI.numeric		No
└– giltig_medel_token_noggrannhet	OpenAI.numeric		No
object	enum	Objekttypen, som alltid är "fine_tuning.job.checkpoint". Möjliga värden: `fine_tuning.job.checkpoint`	Ja
stegnummer	OpenAI.integer		Ja

OpenAI.FineTuningJobCheckpointMetrics

Name	Type	Obligatoriskt
full_valid_loss	OpenAI.numeric	No
full_valid_mean_token_accuracy	OpenAI.numeric	No
steg	OpenAI.numeric	No
train_loss	OpenAI.numeric	No
train_mean_token_accuracy	OpenAI.numeric	No
valid_loss	OpenAI.numeric	No
valid_mean_token_accuracy	OpenAI.numeric	No

OpenAI.FineTuningJobError

Name	Type	Obligatoriskt
code	string	Ja
message	string	Ja
Param	sträng (nullbar)	Ja

OpenAI.FineTuningJobEvent

Finjustera jobbhändelseobjekt

Name	Type	Description	Obligatoriskt
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet skapades.	Ja
data	OpenAI.FineTuningJobEventData		No
id	string	Objektidentifieraren.	Ja
level	enum	Loggnivån för händelsen. Möjliga värden: `info`, `warn`, `error`	Ja
message	string	Händelsens meddelande.	Ja
object	enum	Objekttypen, som alltid är "fine_tuning.job.event". Möjliga värden: `fine_tuning.job.event`	Ja
type	enum	Typ av händelse. Möjliga värden: `message`, `metrics`	No

OpenAI.FineTuningJobEventData

Typ: objekt

OpenAI.FineTuningJobHyperparameters

Name	Type	Obligatoriskt
batchstorlek	string eller OpenAI.integer	No
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	No
antal epoker	string eller OpenAI.integer	No

OpenAI.FunctionAndCustomToolCallOutput

Diskriminerande för OpenAI.FunctionAndCustomToolCallOutput

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

Typvärde	Schema
`input_text`	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
`input_image`	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
`input_file`	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionAndCustomToolCallOutputType		Ja

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng (nullbar)		No
file_url	string	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

En bildinmatning till modellen. Läs mer om bildindata.

Name	Type	Description	Obligatoriskt
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		No
image_url	string		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja

OpenAI.FunctionAndCustomToolCallOutputType

Property	Value
Type	string
Värden	`input_text` `input_image` `input_file`

OpenAI.FunctionCallItemStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionObject

Name	Type	Description	Obligatoriskt
beskrivning	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
name	string	Namnet på den funktion som ska anropas. Måste vara a-z, A-Z, 0-9, eller innehålla understreck och bindestreck, med en maximal längd på 64.	Ja
parameters	OpenAI.FunctionParameters	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet. Om du utelämnar `parameters` definieras en funktion med en tom parameterlista.	No
Strikt	boolesk (nullbar)		No

OpenAI.FunctionParameters

Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel och JSON-schemareferensen för dokumentation om formatet. Om du utelämnar parameters definieras en funktion med en tom parameterlista.

Typ: objekt

OpenAI.FunctionShellAction

Kör ett gränssnittskommando.

Name	Type	Obligatoriskt
commands	strängmatris	Ja
max_output_length	OpenAI.integer (nullbar)	Ja
timeout_ms (timeout i millisekunder)	OpenAI.integer (nullbar)	Ja

OpenAI.FunctionShellActionParam

Kommandon och begränsningar som beskriver hur du kör gränssnittets verktygsanrop.

Name	Type	Description	Obligatoriskt
commands	strängmatris	Beställda gränssnittskommandon för körningsmiljön som ska köras.	Ja
max_output_length	OpenAI.integer (nullbar)		No
timeout_ms (timeout i millisekunder)	OpenAI.integer (nullbar)		No

OpenAI.FunctionShellCallItemStatus

Statusvärden som rapporterats för gränssnittsverktygsanrop.

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.FunctionShellCallOutputContent

Innehållet i ett gränssnittsverktyg anropar utdata som har genererats.

Name	Type	Description	Obligatoriskt
skapad av	string	Identifieraren för aktören som skapade objektet.	No
utfall	OpenAI.FunctionShellCallOutputOutcome	Representerar antingen ett slutresultat (med en slutkod) eller ett timeout-utfall för ett utdatasegment för shell-anrop.	Ja
└– typ	OpenAI.FunctionShellCallOutputOutcomeType		Ja
Stderr	string	Standardfelutdata som hämtades.	Ja
stdout	string	Standardutdata som hämtades.	Ja

OpenAI.FunctionShellCallOutputContentParam

Insamlad stdout och stderr för en del av ett gränssnittsverktyg anropar utdata.

Name	Type	Description	Obligatoriskt
utfall	OpenAI.FunctionShellCallOutputOutcomeParam	Utfallet för avslut eller timeout som är associerat med det här gränssnittsanropet.	Ja
└– typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja
Stderr	string	Insamlade stderr-utdata för shell-anropet. Begränsningar: maxLength: 10485760	Ja
stdout	string	Insamlade stdout-utdata för shell-anropet. Begränsningar: maxLength: 10485760	Ja

OpenAI.FunctionShellCallOutputExitOutcome

Anger att gränssnittskommandona har slutförts och returnerat en slutkod.

Name	Type	Description	Obligatoriskt	Standardinställning
exit_code	OpenAI.integer		Ja
type	enum	Utfallstypen. Alltid `exit`. Möjliga värden: `exit`	Ja

OpenAI.FunctionShellCallOutputExitOutcomeParam

Anger att gränssnittskommandona har slutförts och returnerat en slutkod.

Name	Type	Description	Obligatoriskt	Standardinställning
exit_code	OpenAI.integer		Ja
type	enum	Utfallstypen. Alltid `exit`. Möjliga värden: `exit`	Ja

OpenAI.FunctionShellCallOutputOutcome

Representerar antingen ett slutresultat (med en slutkod) eller ett timeout-utfall för ett utdatasegment för shell-anrop.

Diskriminerande för OpenAI.FunctionShellCallOutputOutcome

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

Typvärde	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcome
`exit`	OpenAI.FunctionShellCallOutputExitOutcome

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionShellCallOutputOutcomeType		Ja

OpenAI.FunctionShellCallOutputOutcomeParam

Utfallet för avslut eller timeout som är associerat med det här gränssnittsanropet.

Diskriminerande för OpenAI.FunctionShellCallOutputOutcomeParam

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

Typvärde	Schema
`timeout`	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
`exit`	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Value
Type	string
Värden	`timeout` `exit`

OpenAI.FunctionShellCallOutputOutcomeType

Property	Value
Type	string
Värden	`timeout` `exit`

OpenAI.FunctionShellCallOutputTimeoutOutcome

Anger att gränssnittsanropet överskred den konfigurerade tidsgränsen.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Utfallstypen. Alltid `timeout`. Möjliga värden: `timeout`	Ja

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Anger att gränssnittsanropet överskred den konfigurerade tidsgränsen.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Utfallstypen. Alltid `timeout`. Möjliga värden: `timeout`	Ja

OpenAI.FunctionShellToolParam

Ett verktyg som gör att modellen kan köra gränssnittskommandon.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av gränssnittsverktyg. Alltid `shell`. Möjliga värden: `shell`	Ja

OpenAI.FunctionTool

Definierar en funktion i din egen kod som modellen kan välja att anropa.

Name	Type	Description	Obligatoriskt
beskrivning	sträng (nullbar)		No
name	string	Namnet på funktionen som ska anropas.	Ja
parameters	objekt (nullbart)		Ja
Strikt	boolesk (nullbar)		Ja
type	enum	Typ av funktionsverktyg. Alltid `function`. Möjliga värden: `function`	Ja

OpenAI.GraderLabelModel

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

Name	Type	Description	Obligatoriskt
Input	matris med OpenAI.EvalItem		Ja
labels	strängmatris	Etiketterna som ska tilldelas till varje objekt i utvärderingen.	Ja
model	string	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	Ja
name	string	Namnet på bedömaren.	Ja
godkända_etiketter	strängmatris	Etiketterna som anger ett godkänt resultat. Måste vara en delmängd av etiketter.	Ja
type	enum	Objekttypen, som alltid är `label_model`. Möjliga värden: `label_model`	Ja

OpenAI.GraderMulti

Ett MultiGrader-objekt kombinerar utdata från flera graders för att skapa en enda poäng.

Name	Type	Description	Obligatoriskt
beräkna_utdata	string	En formel för att beräkna resultaten baserat på bedömares resultat.	Ja
Klassare	OpenAI.GraderStringCheck eller OpenAI.GraderTextSimilarity eller OpenAI.GraderPython eller OpenAI.GraderScoreModel eller OpenAI.GraderLabelModel		Ja
name	string	Namnet på bedömaren.	Ja
type	enum	Objekttypen, som alltid är `multi`. Möjliga värden: `multi`	Ja

OpenAI.GraderPython

Ett PythonGrader-objekt som kör ett Python-skript på indata.

Name	Type	Description	Obligatoriskt
image_tag	string	Avbildningstaggen som ska användas för Python-skriptet.	No
name	string	Namnet på bedömaren.	Ja
source	string	Källkoden för Python-skriptet.	Ja
type	enum	Objekttypen, som alltid är `python`. Möjliga värden: `python`	Ja

OpenAI.GraderScoreModel

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

Name	Type	Description	Obligatoriskt	Standardinställning
Input	matris med OpenAI.EvalItem	De indatameddelanden som utvärderas av väghyveln. Stöder text, utdatatext, indatabild och ljudinnehållsblock för indata, och kan innehålla mallsträngar.	Ja
model	string	Den modell som ska användas för utvärderingen.	Ja
name	string	Namnet på bedömaren.	Ja
range	matris med OpenAI.numeric	Poängintervallet. Standardinställningen är `[0, 1]`.	No
provtagning_parametrar	OpenAI.EvalGraderScoreModelSamplingParams		No
└– max_completions_tokens	OpenAI.integer (nullbar)		No
└– reasoning_effort	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
└– frö	OpenAI.integer (nullbar)		No
└– temperatur	OpenAI.numeric (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
type	enum	Objekttypen, som alltid är `score_model`. Möjliga värden: `score_model`	Ja

OpenAI.GraderStringCheck

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

Name	Type	Description	Obligatoriskt
Input	string	Inmatningstexten. Detta kan innehålla mallsträngar.	Ja
name	string	Namnet på bedömaren.	Ja
Operation	enum	Strängkontrollprocessen som ska utföras. En av `eq`, `ne`, `like`eller `ilike`. Möjliga värden: `eq`, `ne`, `like`, `ilike`	Ja
hänvisning	string	Referenstexten. Detta kan innehålla mallsträngar.	Ja
type	enum	Objekttypen, som alltid är `string_check`. Möjliga värden: `string_check`	Ja

OpenAI.GraderTextSimilarity

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

Name	Type	Description	Obligatoriskt
utvärderingsmetrik	enum	Det utvärderingsmått som ska användas. En av `cosine`, `fuzzy_match`, `bleu` `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, , `rouge_4`, , `rouge_5` eller `rouge_l`. Möjliga värden: `cosine`, `fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, , `rouge_5`, `rouge_l`	Ja
Input	string	Texten som bedöms.	Ja
name	string	Namnet på bedömaren.	Ja
hänvisning	string	Texten som betygsätts och jämförs med.	Ja
type	enum	Typ av väghyvel. Möjliga värden: `text_similarity`	Ja

OpenAI.GrammarSyntax1

Property	Value
Type	string
Värden	`lark` `regex`

OpenAI.HybridSearchOptions

Name	Type	Description	Obligatoriskt	Standardinställning
embedding_weight	OpenAI.numeric		Ja
text_weight	OpenAI.numeric		Ja

OpenAI.ImageDetail

Property	Value
Type	string
Värden	`low` `high` `auto`

OpenAI.ImageGenTool

Ett verktyg som genererar bilder med hjälp av GPT-bildmodellerna.

Giltiga modeller:

gpt-image-1
gpt-image-1-mini

Name	Type	Description	Obligatoriskt	Standardinställning
bakgrund	enum	Bakgrundstyp för den genererade bilden. En av `transparent`, `opaque`, eller `auto`. Förvald: `auto`. Möjliga värden: `transparent`, `opaque`, `auto`	No
input_fidelity	OpenAI.InputFidelity (nullbar)	Kontrollera hur mycket arbete modellen kommer att utöva för att matcha stilen och funktionerna, särskilt ansiktsdrag, för indatabilder. Den här parametern stöds endast för `gpt-image-1`. Stöds inte för `gpt-image-1-mini`. Stöder `high` och `low`. Standardinställningen är `low`.	No
inmatningsbildmask	OpenAI.ImageGenToolInputImageMask		No
└– file_id	string		No
└ image_url	string		No
model	sträng (se giltiga modeller nedan)		No
Måtta	enum	Modereringsnivå för den genererade avbildningen. Förvald: `auto`. Möjliga värden: `auto`, `low`	No
Utdata kompression	OpenAI.integer		No	100
output_format	enum	Utdataformatet för den genererade avbildningen. En av `png`, `webp` eller `jpeg`. Förvald: `png`. Möjliga värden: `png`, `webp`, `jpeg`	No
delbilder	OpenAI.integer		No
kvalitet	enum	Kvaliteten på den genererade avbildningen. En av `low`, `medium`, `high` eller `auto`. Förvald: `auto`. Möjliga värden: `low`, `medium`, `high`, `auto`	No
storlek	enum	Storleken på den genererade avbildningen. En av `1024x1024`, `1024x1536`, `1536x1024`, eller `auto`. Förvald: `auto`. Möjliga värden: `1024x1024`, `1024x1536`, `1536x1024`, `auto`	No
type	enum	Typ av bildgenereringsverktyg. Alltid `image_generation`. Möjliga värden: `image_generation`	Ja

OpenAI.ImageGenToolInputImageMask

Name	Type	Description	Obligatoriskt	Standardinställning
file_id	string		No
image_url	string		No

OpenAI.IncludeEnum

Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande stöds värden:

web_search_call.action.sources: Inkludera källorna för webbsökningsverktygets anrop.
code_interpreter_call.outputs: Innehåller utdata från python-kodkörning i kodtolkverktygets anropsobjekt.
computer_call_output.output.image_url: Inkludera bild-URL:er från datorns anropsutdata.
file_search_call.results: Inkludera sökresultaten för filsökningsverktygets anrop.
message.input_image.image_url: Inkludera bild-URL:er från indatameddelandet.
message.output_text.logprobs: Inkludera logprobs tillsammans med assistentmeddelanden.
reasoning.encrypted_content: Innehåller en krypterad version av resonemangstoken i utdata för resonemangsobjekt. Detta gör att resonemangsobjekt kan användas i konversationer med flera turer när du använder svars-API:et tillståndslöst (till exempel när parametern store är inställd på falseeller när en organisation har registrerats i programmet för datakvarhållning utan data).

Property	Value
Beskrivning	Ange ytterligare utdata som ska inkluderas i modellsvaret. För närvarande stöds värden:

web_search_call.action.sources: Inkludera källorna för webbsökningsverktygets anrop.
code_interpreter_call.outputs: Innehåller utdata från python-kodkörning i kodtolkverktygets anropsobjekt.
computer_call_output.output.image_url: Inkludera bild-URL:er från datorns anropsutdata.
file_search_call.results: Inkludera sökresultaten för filsökningsverktygets anrop.
message.input_image.image_url: Inkludera bild-URL:er från indatameddelandet.
message.output_text.logprobs: Inkludera logprobs tillsammans med assistentmeddelanden.
reasoning.encrypted_content: Innehåller en krypterad version av resonemangstoken i utdata för resonemangsobjekt. Detta gör att resonemangsobjekt kan användas i konversationer med flera turer när du använder svars-API:et tillståndslöst (till exempel när parametern store är inställd på falseeller när en organisation har registrerats i programmet för datakvarhållning utan data). | | Typ | sträng | | | Värden | file_search_call.results
web_search_call.results
web_search_call.action.sources
message.input_image.image_url
computer_call_output.output.image_url
code_interpreter_call.outputs
reasoning.encrypted_content
message.output_text.logprobs
memory_search_call.results |

OpenAI.InputAudio

En ljudinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
input_audio	OpenAI.InputAudioInputAudio		Ja
type	enum	Typ av indataobjekt. Alltid `input_audio`. Möjliga värden: `input_audio`	Ja

OpenAI.InputAudioInputAudio

Name	Type	Description	Obligatoriskt	Standardinställning
data	string		Ja
format	enum	Möjliga värden: `mp3`, `wav`	Ja

OpenAI.InputContent

Diskriminerande för OpenAI.InputContent

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

Typvärde	Schema
`input_text`	OpenAI.InputContentInputTextContent
`input_image`	OpenAI.InputContentInputImageContent
`input_file`	OpenAI.InputContentInputFileContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.InputContentType		Ja

OpenAI.InputContentInputFileContent

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng (nullbar)		No
file_url	string	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja

OpenAI.InputContentInputImageContent

En bildinmatning till modellen. Läs mer om bildindata.

Name	Type	Description	Obligatoriskt
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		No
image_url	string		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja

OpenAI.InputContentInputTextContent

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja

OpenAI.InputContentType

Property	Value
Type	string
Värden	`input_text` `input_image` `input_file`

OpenAI.InputFidelity

Kontrollera hur mycket arbete modellen kommer att utöva för att matcha stilen och funktionerna, särskilt ansiktsdrag, för indatabilder. Den här parametern stöds endast för gpt-image-1. Stöds inte för gpt-image-1-mini. Stöder high och low. Standardinställningen är low.

Property	Value
Type	string
Värden	`high` `low`

OpenAI.InputFileContent

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng (nullbar)		No
file_url	string	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja

OpenAI.InputFileContentParam

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt
file_data	sträng (nullbar)		No
file_id	sträng (nullbar)		No
file_url	string		No
filename	sträng (nullbar)		No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja

OpenAI.InputImageContent

En bildinmatning till modellen. Läs mer om bildindata.

Name	Type	Description	Obligatoriskt
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		No
image_url	string		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja

OpenAI.InputImageContentParamAutoParam

En bildinmatning till modellen. Lär dig mer om bildindata

Name	Type	Description	Obligatoriskt
detail	OpenAI.DetailEnum (nullable)		No
file_id	sträng (nullbar)		No
image_url	string		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja

OpenAI.InputItem

Ett objekt som representerar en del av kontexten för svaret som ska genereras av modellen. Kan innehålla text, bilder och ljudindata, samt tidigare assistentsvar och verktygsanropsutdata.

Diskriminerande för OpenAI.InputItem

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

Typvärde	Schema
`message`	OpenAI.EasyInputMessage
`item_reference`	OpenAI.ItemReferenceParam
`output_message`	OpenAI.InputItemOutputMessage
`file_search_call`	OpenAI.InputItemFileSearchToolCall
`computer_call`	OpenAI.InputItemComputerToolCall
`computer_call_output`	OpenAI.InputItemComputerCallOutputItemParam
`web_search_call`	OpenAI.InputItemWebSearchToolCall
`function_call`	OpenAI.InputItemFunctionToolCall
`function_call_output`	OpenAI.InputItemFunctionCallOutputItemParam
`reasoning`	OpenAI.InputItemReasoningItem
`compaction`	OpenAI.InputItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.InputItemImageGenToolCall
`code_interpreter_call`	OpenAI.InputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.InputItemLocalShellToolCall
`local_shell_call_output`	OpenAI.InputItemLocalShellToolCallOutput
`shell_call`	OpenAI.InputItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.InputItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.InputItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.InputItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.InputItemMcpListTools
`mcp_approval_request`	OpenAI.InputItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.InputItemMcpApprovalResponse
`mcp_call`	OpenAI.InputItemMcpToolCall
`custom_tool_call_output`	OpenAI.InputItemCustomToolCallOutput
`custom_tool_call`	OpenAI.InputItemCustomToolCall

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.InputItemType		Ja

OpenAI.InputItemApplyPatchToolCallItemParam

Ett verktygsanrop som representerar en begäran om att skapa, ta bort eller uppdatera filer med hjälp av diff-korrigeringar.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
Operation	OpenAI.ApplyPatchOperationParam	En av de create_file, delete_file eller update_file åtgärder som tillhandahålls till apply_patch-verktyget.	Ja
└– typ	OpenAI.ApplyPatchOperationParamType		Ja
status	OpenAI.ApplyPatchCallStatusParam	Statusvärden som rapporterats för apply_patch-verktygsanrop.	Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja

OpenAI.InputItemApplyPatchToolCallOutputItemParam

De strömmade utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
output	sträng (nullbar)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Utfallsvärden som rapporterats för apply_patch verktygsanropsutdata.	Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja

OpenAI.InputItemCodeInterpreterToolCall

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt
code	sträng (nullbar)		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja

OpenAI.InputItemCompactionSummaryItemParam

Ett komprimeringsobjekt som genereras av API:etv1/responses/compact.

Name	Type	Description	Obligatoriskt
encrypted_content	string	Det krypterade innehållet i komprimeringssammanfattningen. Begränsningar: maxLength: 10485760	Ja
id	sträng (nullbar)		No
type	enum	Typ av objekt. Alltid `compaction`. Möjliga värden: `compaction`	Ja

OpenAI.InputItemComputerCallOutputItemParam

Utdata från ett datorverktygsanrop.

Name	Type	Description	Obligatoriskt
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam		No
call_id	string	ID:t för datorverktygets anrop som genererade utdata. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		No
type	enum	Typ av utdata från datorverktygsanrop. Alltid `computer_call_output`. Möjliga värden: `computer_call_output`	Ja

OpenAI.InputItemComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Mer information finns i guiden för datoranvändning .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.ComputerAction		Ja
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja

OpenAI.InputItemCustomToolCall

Ett anrop till ett anpassat verktyg som skapats av modellen.

Name	Type	Description	Obligatoriskt
call_id	string	En identifierare som används för att mappa det här anpassade verktygsanropet till ett verktygsanropsutdata.	Ja
id	string	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	No
Input	string	Indata för det anpassade verktygsanropet som genereras av modellen.	Ja
name	string	Namnet på det anpassade verktyg som anropas.	Ja
type	enum	Typ av anpassat verktygsanrop. Alltid `custom_tool_call`. Möjliga värden: `custom_tool_call`	Ja

OpenAI.InputItemCustomToolCallOutput

Utdata från ett anpassat verktygsanrop från koden som skickas tillbaka till modellen.

Name	Type	Description	Obligatoriskt
call_id	string	Anrops-ID:t som används för att mappa det här anpassade verktyget anropar utdata till ett anpassat verktygsanrop.	Ja
id	string	Det unika ID:t för det anpassade verktyget anropar utdata i OpenAI-plattformen.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från det anpassade verktygsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
type	enum	Typen av anpassade verktyg anropar utdata. Alltid `custom_tool_call_output`. Möjliga värden: `custom_tool_call_output`	Ja

OpenAI.InputItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Mer information finns i filsökningsguiden .

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
results	matris med OpenAI.FileSearchToolCallResults		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.InputItemFunctionCallOutputItemParam

Utdata från ett funktionsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
output	sträng eller matris med OpenAI.InputTextContentParam eller OpenAI.InputImageContentParamAutoParam eller OpenAI.InputFileContentParam	Text, bild eller filutdata för funktionsverktygets anrop.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		No
type	enum	Typen av utdata från funktionsverktygets anrop. Alltid `function_call_output`. Möjliga värden: `function_call_output`	Ja

OpenAI.InputItemFunctionShellCallItemParam

Ett verktyg som representerar en begäran om att köra ett eller flera gränssnittskommandon.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.FunctionShellActionParam	Kommandon och begränsningar som beskriver hur du kör gränssnittets verktygsanrop.	Ja
└– kommandon	strängmatris	Beställda gränssnittskommandon för körningsmiljön som ska köras.	Ja
└– max_output_length	OpenAI.integer (nullbar)		No
└– timeout_ms	OpenAI.integer (nullbar)		No
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
status	OpenAI.FunctionShellCallItemStatus (nullbar)	Statusvärden som rapporterats för gränssnittsverktygsanrop.	No
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja

OpenAI.InputItemFunctionShellCallOutputItemParam

De strömmade utdataobjekten som genereras av ett gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
max_output_length	OpenAI.integer (nullbar)		No
output	matris med OpenAI.FunctionShellCallOutputContentParam	Insamlade segment av stdout- och stderr-utdata, tillsammans med deras associerade resultat.	Ja
type	enum	Typ av objekt. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja

OpenAI.InputItemFunctionToolCall

Ett verktygsanrop för att köra en funktion. Mer information finns i funktionssamtalsguiden .

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	string	Det unika ID:t för funktionsverktygets anrop.	No
name	string	Namnet på den funktion som ska köras.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.InputItemImageGenToolCall

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
result	sträng (nullbar)		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.InputItemLocalShellToolCall

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.InputItemLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	string	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av anropsutdata för det lokala gränssnittet. Alltid `local_shell_call_output`. Möjliga värden: `local_shell_call_output`	Ja

OpenAI.InputItemMcpApprovalRequest

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.InputItemMcpApprovalResponse

Ett svar på en begäran om MCP-godkännande.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
id	sträng (nullbar)		No
reason	sträng (nullbar)		No
type	enum	Typ av objekt. Alltid `mcp_approval_response`. Möjliga värden: `mcp_approval_response`	Ja

OpenAI.InputItemMcpListTools

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
fel	sträng (nullbar)		No
id	string	Listans unika ID.	Ja
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.InputItemMcpToolCall

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
approval_request_id	sträng (nullbar)		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.InputItemOutputMessage

Ett utdatameddelande från modellen.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
id	string	Utdatameddelandets unika ID.	Ja
role	enum	Utdatameddelandets roll. Alltid `assistant`. Möjliga värden: `assistant`	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av utdatameddelande. Alltid `message`. Möjliga värden: `output_message`	Ja

OpenAI.InputItemReasoningItem

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.ReasoningTextContent	Textinnehåll i resonemang.	No
encrypted_content	sträng (nullbar)		No
id	string	Den unika identifieraren för resonemangsinnehållet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
summary	matris med OpenAI.Summary	Sammanfattningsinnehåll för resonemang.	Ja
type	enum	Typ av objekt. Alltid `reasoning`. Möjliga värden: `reasoning`	Ja

OpenAI.InputItemType

Property Value

Type string

Värden message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
custom_tool_call_output
custom_tool_call
item_reference

OpenAI.InputItemWebSearchToolCall

Resultatet av ett webbsökningsverktygsanrop. Mer information finns i webbsökningsguiden .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, sök).	Ja
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.InputMessage

Name	Type	Description	Obligatoriskt
innehåll	OpenAI.InputMessageContentList	En lista över ett eller flera indataobjekt till modellen som innehåller olika innehåll types.	Ja
role	enum	Rollen för meddelandets inmatning. En av `user`, `system`eller `developer`. Möjliga värden: `user`, `system`, `developer`	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av meddelandeindata. Ställ alltid in på `message`. Möjliga värden: `message`	Ja

OpenAI.InputMessageContentList

En lista över ett eller flera indataobjekt till modellen som innehåller olika innehållstyper.

Matris för: OpenAI.InputContent

OpenAI.InputMessageResource

Name	Type	Description	Obligatoriskt
innehåll	OpenAI.InputMessageContentList	En lista över ett eller flera indataobjekt till modellen som innehåller olika innehåll types.	Ja
id	string	Det unika ID:t för meddelandeindata.	Ja
role	enum	Rollen för meddelandets inmatning. En av `user`, `system`eller `developer`. Möjliga värden: `user`, `system`, `developer`	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av meddelandeindata. Ställ alltid in på `message`. Möjliga värden: `message`	Ja

OpenAI.InputParam

Text, bild eller filindata till modellen, som används för att generera ett svar. Lära sig mer:

Typ: sträng eller matris med OpenAI.InputItem

Text, bild eller filindata till modellen, som används för att generera ett svar. Lära sig mer:

OpenAI.InputTextContent

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja

OpenAI.InputTextContentParam

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen. Begränsningar: maxLength: 10485760	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja

OpenAI.Item

Innehållsobjekt som används för att generera ett svar.

Diskriminerande för OpenAI.Item

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

Typvärde	Schema
`memory_search_call`	MemorySearchToolCallItemParam
`message`	OpenAI.InputMessage
`output_message`	OpenAI.ItemOutputMessage
`file_search_call`	OpenAI.ItemFileSearchToolCall
`computer_call`	OpenAI.ItemComputerToolCall
`computer_call_output`	OpenAI.ItemComputerCallOutputItemParam
`web_search_call`	OpenAI.ItemWebSearchToolCall
`function_call`	OpenAI.ItemFunctionToolCall
`function_call_output`	OpenAI.ItemFunctionCallOutputItemParam
`reasoning`	OpenAI.ItemReasoningItem
`compaction`	OpenAI.ItemCompactionSummaryItemParam
`image_generation_call`	OpenAI.ItemImageGenToolCall
`code_interpreter_call`	OpenAI.ItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemLocalShellToolCallOutput
`shell_call`	OpenAI.ItemFunctionShellCallItemParam
`shell_call_output`	OpenAI.ItemFunctionShellCallOutputItemParam
`apply_patch_call`	OpenAI.ItemApplyPatchToolCallItemParam
`apply_patch_call_output`	OpenAI.ItemApplyPatchToolCallOutputItemParam
`mcp_list_tools`	OpenAI.ItemMcpListTools
`mcp_approval_request`	OpenAI.ItemMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemMcpApprovalResponse
`mcp_call`	OpenAI.ItemMcpToolCall
`custom_tool_call_output`	OpenAI.ItemCustomToolCallOutput
`custom_tool_call`	OpenAI.ItemCustomToolCall

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ItemType		Ja

OpenAI.ItemApplyPatchToolCallItemParam

Ett verktygsanrop som representerar en begäran om att skapa, ta bort eller uppdatera filer med hjälp av diff-korrigeringar.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
Operation	OpenAI.ApplyPatchOperationParam	En av de create_file, delete_file eller update_file åtgärder som tillhandahålls till apply_patch-verktyget.	Ja
└– typ	OpenAI.ApplyPatchOperationParamType		Ja
status	OpenAI.ApplyPatchCallStatusParam	Statusvärden som rapporterats för apply_patch-verktygsanrop.	Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja

OpenAI.ItemApplyPatchToolCallOutputItemParam

De strömmade utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
output	sträng (nullbar)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Utfallsvärden som rapporterats för apply_patch verktygsanropsutdata.	Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja

OpenAI.ItemCodeInterpreterToolCall

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt
code	sträng (nullbar)		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja

OpenAI.ItemCompactionSummaryItemParam

Ett komprimeringsobjekt som genereras av API:etv1/responses/compact.

Name	Type	Description	Obligatoriskt
encrypted_content	string	Det krypterade innehållet i komprimeringssammanfattningen. Begränsningar: maxLength: 10485760	Ja
id	sträng (nullbar)		No
type	enum	Typ av objekt. Alltid `compaction`. Möjliga värden: `compaction`	Ja

OpenAI.ItemComputerCallOutputItemParam

Utdata från ett datorverktygsanrop.

Name	Type	Description	Obligatoriskt
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam		No
call_id	string	ID:t för datorverktygets anrop som genererade utdata. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		No
type	enum	Typ av utdata från datorverktygsanrop. Alltid `computer_call_output`. Möjliga värden: `computer_call_output`	Ja

OpenAI.ItemComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Mer information finns i guiden för datoranvändning .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.ComputerAction		Ja
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja

OpenAI.ItemCustomToolCall

Ett anrop till ett anpassat verktyg som skapats av modellen.

Name	Type	Description	Obligatoriskt
call_id	string	En identifierare som används för att mappa det här anpassade verktygsanropet till ett verktygsanropsutdata.	Ja
id	string	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	No
Input	string	Indata för det anpassade verktygsanropet som genereras av modellen.	Ja
name	string	Namnet på det anpassade verktyg som anropas.	Ja
type	enum	Typ av anpassat verktygsanrop. Alltid `custom_tool_call`. Möjliga värden: `custom_tool_call`	Ja

OpenAI.ItemCustomToolCallOutput

Utdata från ett anpassat verktygsanrop från koden som skickas tillbaka till modellen.

Name	Type	Description	Obligatoriskt
call_id	string	Anrops-ID:t som används för att mappa det här anpassade verktyget anropar utdata till ett anpassat verktygsanrop.	Ja
id	string	Det unika ID:t för det anpassade verktyget anropar utdata i OpenAI-plattformen.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från det anpassade verktygsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
type	enum	Typen av anpassade verktyg anropar utdata. Alltid `custom_tool_call_output`. Möjliga värden: `custom_tool_call_output`	Ja

OpenAI.ItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Mer information finns i filsökningsguiden .

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
results	matris med OpenAI.FileSearchToolCallResults		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.ItemFunctionCallOutputItemParam

Utdata från ett funktionsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
output	sträng eller matris med OpenAI.InputTextContentParam eller OpenAI.InputImageContentParamAutoParam eller OpenAI.InputFileContentParam	Text, bild eller filutdata för funktionsverktygets anrop.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		No
type	enum	Typen av utdata från funktionsverktygets anrop. Alltid `function_call_output`. Möjliga värden: `function_call_output`	Ja

OpenAI.ItemFunctionShellCallItemParam

Ett verktyg som representerar en begäran om att köra ett eller flera gränssnittskommandon.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.FunctionShellActionParam	Kommandon och begränsningar som beskriver hur du kör gränssnittets verktygsanrop.	Ja
└– kommandon	strängmatris	Beställda gränssnittskommandon för körningsmiljön som ska köras.	Ja
└– max_output_length	OpenAI.integer (nullbar)		No
└– timeout_ms	OpenAI.integer (nullbar)		No
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
status	OpenAI.FunctionShellCallItemStatus (nullbar)	Statusvärden som rapporterats för gränssnittsverktygsanrop.	No
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja

OpenAI.ItemFunctionShellCallOutputItemParam

De strömmade utdataobjekten som genereras av ett gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
id	sträng (nullbar)		No
max_output_length	OpenAI.integer (nullbar)		No
output	matris med OpenAI.FunctionShellCallOutputContentParam	Insamlade segment av stdout- och stderr-utdata, tillsammans med deras associerade resultat.	Ja
type	enum	Typ av objekt. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja

OpenAI.ItemFunctionToolCall

Ett verktygsanrop för att köra en funktion. Mer information finns i funktionssamtalsguiden .

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	string	Det unika ID:t för funktionsverktygets anrop.	No
name	string	Namnet på den funktion som ska köras.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.ItemImageGenToolCall

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
result	sträng (nullbar)		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.ItemLocalShellToolCall

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.ItemLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	string	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av anropsutdata för det lokala gränssnittet. Alltid `local_shell_call_output`. Möjliga värden: `local_shell_call_output`	Ja

OpenAI.ItemMcpApprovalRequest

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.ItemMcpApprovalResponse

Ett svar på en begäran om MCP-godkännande.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
id	sträng (nullbar)		No
reason	sträng (nullbar)		No
type	enum	Typ av objekt. Alltid `mcp_approval_response`. Möjliga värden: `mcp_approval_response`	Ja

OpenAI.ItemMcpListTools

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
fel	sträng (nullbar)		No
id	string	Listans unika ID.	Ja
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.ItemMcpToolCall

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
approval_request_id	sträng (nullbar)		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.ItemOutputMessage

Ett utdatameddelande från modellen.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
id	string	Utdatameddelandets unika ID.	Ja
role	enum	Utdatameddelandets roll. Alltid `assistant`. Möjliga värden: `assistant`	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av utdatameddelande. Alltid `message`. Möjliga värden: `output_message`	Ja

OpenAI.ItemReasoningItem

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.ReasoningTextContent	Textinnehåll i resonemang.	No
encrypted_content	sträng (nullbar)		No
id	string	Den unika identifieraren för resonemangsinnehållet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
summary	matris med OpenAI.Summary	Sammanfattningsinnehåll för resonemang.	Ja
type	enum	Typ av objekt. Alltid `reasoning`. Möjliga värden: `reasoning`	Ja

OpenAI.ItemReferenceParam

En intern identifierare för ett objekt att referera till.

Name	Type	Description	Obligatoriskt	Standardinställning
id	string	ID:t för det objekt som ska refereras till.	Ja
type	enum	Typ av objekt som ska refereras till. Alltid `item_reference`. Möjliga värden: `item_reference`	Ja

OpenAI.ItemResource

Innehållsobjekt som används för att generera ett svar.

Diskriminerande för OpenAI.ItemResource

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

Typvärde	Schema
`message`	OpenAI.InputMessageResource
`output_message`	OpenAI.ItemResourceOutputMessage
`file_search_call`	OpenAI.ItemResourceFileSearchToolCall
`computer_call`	OpenAI.ItemResourceComputerToolCall
`computer_call_output`	OpenAI.ItemResourceComputerToolCallOutputResource
`web_search_call`	OpenAI.ItemResourceWebSearchToolCall
`function_call`	OpenAI.ItemResourceFunctionToolCallResource
`function_call_output`	OpenAI.ItemResourceFunctionToolCallOutputResource
`image_generation_call`	OpenAI.ItemResourceImageGenToolCall
`code_interpreter_call`	OpenAI.ItemResourceCodeInterpreterToolCall
`local_shell_call`	OpenAI.ItemResourceLocalShellToolCall
`local_shell_call_output`	OpenAI.ItemResourceLocalShellToolCallOutput
`shell_call`	OpenAI.ItemResourceFunctionShellCall
`shell_call_output`	OpenAI.ItemResourceFunctionShellCallOutput
`apply_patch_call`	OpenAI.ItemResourceApplyPatchToolCall
`apply_patch_call_output`	OpenAI.ItemResourceApplyPatchToolCallOutput
`mcp_list_tools`	OpenAI.ItemResourceMcpListTools
`mcp_approval_request`	OpenAI.ItemResourceMcpApprovalRequest
`mcp_approval_response`	OpenAI.ItemResourceMcpApprovalResponseResource
`mcp_call`	OpenAI.ItemResourceMcpToolCall

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ItemResourceType		Ja

OpenAI.ItemResourceApplyPatchToolCall

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för anropet använd korrigeringsverktyg. Fylls i när det här objektet returneras via API.	Ja
Operation	OpenAI.ApplyPatchFileOperation	En av de create_file, delete_file eller update_file åtgärder som tillämpas via apply_patch.	Ja
└– typ	OpenAI.ApplyPatchFileOperationType		Ja
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja

OpenAI.ItemResourceApplyPatchToolCallOutput

Utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktyget anropar utdata.	No
id	string	Det unika ID:t för anropsutdata för det tillämpade korrigeringsverktyget. Fylls i när det här objektet returneras via API.	Ja
output	sträng (nullbar)		No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja

OpenAI.ItemResourceCodeInterpreterToolCall

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt
code	sträng (nullbar)		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja

OpenAI.ItemResourceComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Mer information finns i guiden för datoranvändning .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.ComputerAction		Ja
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Type	Description	Obligatoriskt
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De säkerhetskontroller som rapporterats av API:et och som har bekräftats av utvecklare.	No
call_id	string	ID:t för datorverktygets anrop som genererade utdata.	Ja
id	string	ID:t för datorverktyget anropar utdata.	No
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av utdata från datorverktygsanrop. Alltid `computer_call_output`. Möjliga värden: `computer_call_output`	Ja

OpenAI.ItemResourceFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Mer information finns i filsökningsguiden .

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
results	matris med OpenAI.FileSearchToolCallResults		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.ItemResourceFunctionShellCall

Ett verktygsanrop som kör ett eller flera gränssnittskommandon i en hanterad miljö.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.FunctionShellAction	Kör ett gränssnittskommando.	Ja
└– kommandon	strängmatris		Ja
└– max_output_length	OpenAI.integer (nullbar)		Ja
└– timeout_ms	OpenAI.integer (nullbar)		Ja
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för gränssnittets verktygsanrop. Fylls i när det här objektet returneras via API.	Ja
status	OpenAI.LocalShellCallStatus		Ja
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja

OpenAI.ItemResourceFunctionShellCallOutput

Utdata från ett gränssnittsverktygsanrop som har genererats.

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för shell-anropets utdata. Fylls i när det här objektet returneras via API.	Ja
max_output_length	OpenAI.integer (nullbar)		Ja
output	matris med OpenAI.FunctionShellCallOutputContent	En matris med gränssnittsanropets utdatainnehåll	Ja
type	enum	Typ av gränssnittsanropets utdata. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Type	Description	Obligatoriskt
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	string	Det unika ID:t för funktionsverktygets anropsresultat. Fylls i när det här objektet returneras via API.	No
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från funktionsanropet som genereras av koden. Kan vara en sträng eller en lista över utdatainnehåll.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av utdata från funktionsverktygets anrop. Alltid `function_call_output`. Möjliga värden: `function_call_output`	Ja

OpenAI.ItemResourceFunctionToolCallResource

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	string	Det unika ID:t för funktionsverktygets anrop.	No
name	string	Namnet på den funktion som ska köras.	Ja
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.ItemResourceImageGenToolCall

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
result	sträng (nullbar)		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.ItemResourceLocalShellToolCall

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.ItemResourceLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Name	Type	Description	Obligatoriskt
id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	string	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typen av anropsutdata för det lokala gränssnittet. Alltid `local_shell_call_output`. Möjliga värden: `local_shell_call_output`	Ja

OpenAI.ItemResourceMcpApprovalRequest

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.ItemResourceMcpApprovalResponseResource

Ett svar på en begäran om MCP-godkännande.

Name	Type	Description	Obligatoriskt
approval_request_id	string	ID:t för godkännandebegäran som besvaras.	Ja
approve	boolean	Om begäran godkändes.	Ja
id	string	Det unika ID:t för godkännandesvaret	Ja
reason	sträng (nullbar)		No
type	enum	Typ av objekt. Alltid `mcp_approval_response`. Möjliga värden: `mcp_approval_response`	Ja

OpenAI.ItemResourceMcpListTools

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
fel	sträng (nullbar)		No
id	string	Listans unika ID.	Ja
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.ItemResourceMcpToolCall

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
approval_request_id	sträng (nullbar)		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.ItemResourceOutputMessage

Ett utdatameddelande från modellen.

Name	Type	Description	Obligatoriskt
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
id	string	Utdatameddelandets unika ID.	Ja
role	enum	Utdatameddelandets roll. Alltid `assistant`. Möjliga värden: `assistant`	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av utdatameddelande. Alltid `message`. Möjliga värden: `output_message`	Ja

OpenAI.ItemResourceType

Property Value

Type string

Värden message
output_message
file_search_call
computer_call
computer_call_output
web_search_call
function_call
function_call_output
image_generation_call
code_interpreter_call
local_shell_call
local_shell_call_output
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_list_tools
mcp_approval_request
mcp_approval_response
mcp_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.ItemResourceWebSearchToolCall

Resultatet av ett webbsökningsverktygsanrop. Mer information finns i webbsökningsguiden .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, sök).	Ja
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.ItemType

Property Value

Type string

OpenAI.ItemWebSearchToolCall

Resultatet av ett webbsökningsverktygsanrop. Mer information finns i webbsökningsguiden .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, sök).	Ja
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.KeyPressAction

En samling tangenttryckningar som modellen vill utföra.

Name	Type	Description	Obligatoriskt	Standardinställning
keys	strängmatris	Kombinationen av knappar som modellen vill att man trycker på. Det här är en matris med strängar som var och en representerar en nyckel.	Ja
type	enum	Anger händelsetypen. För en keypress-åtgärd är den här egenskapen alltid inställd på `keypress`. Möjliga värden: `keypress`	Ja

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Type	Description	Obligatoriskt
data	matris med OpenAI.FineTuningJobCheckpoint		Ja
first_id	sträng (nullbar)		No
har_mer	boolean		Ja
last_id	sträng (nullbar)		No
object	enum	Möjliga värden: `list`	Ja

OpenAI.ListFineTuningJobEventsResponse

Name	Type	Description	Obligatoriskt
data	matris med OpenAI.FineTuningJobEvent		Ja
har_mer	boolean		Ja
object	enum	Möjliga värden: `list`	Ja

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Type	Description	Obligatoriskt
data	matris med OpenAI.FineTuningJob		Ja
har_mer	boolean		Ja
object	enum	Möjliga värden: `list`	Ja

OpenAI.LocalShellCallStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.LocalShellExecAction

Kör ett gränssnittskommando på servern.

Name	Type	Description	Obligatoriskt
command	strängmatris	Kommandot som ska köras.	Ja
env	object	Miljövariabler som ska anges för kommandot.	Ja
timeout_ms (timeout i millisekunder)	OpenAI.integer (nullbar)		No
type	enum	Typen av lokal shell-åtgärd. Alltid `exec`. Möjliga värden: `exec`	Ja
user	sträng (nullbar)		No
arbetskatalog	sträng (nullbar)		No

OpenAI.LocalShellToolParam

Ett verktyg som gör att modellen kan köra gränssnittskommandon i en lokal miljö.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Typ av lokalt gränssnittsverktyg. Alltid `local_shell`. Möjliga värden: `local_shell`	Ja

OpenAI.LogProb

Log sannolikhet för en token.

Name	Type	Obligatoriskt
bytes	matris med OpenAI.integer	Ja
logprob	OpenAI.numeric	Ja
token	string	Ja
top_logprobs	matris med OpenAI.TopLogProb	Ja

OpenAI.MCPListToolsTool

Ett verktyg som är tillgängligt på en MCP-server.

Name	Type	Description	Obligatoriskt
annotations	OpenAI.MCPListToolsToolAnnotations (nullbar)		No
beskrivning	sträng (nullbar)		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Ja
name	string	Namnet på verktyget.	Ja

OpenAI.MCPListToolsToolAnnotations

Typ: objekt

OpenAI.MCPListToolsToolInputSchema

Typ: objekt

OpenAI.MCPTool

Ge modellen åtkomst till ytterligare verktyg via MCP-servrar (Remote Model Context Protocol). Läs mer om MCP.

Name	Type	Description	Obligatoriskt
tillåtna_verktyg	matris med sträng eller OpenAI.MCPToolFilter		No
authorization	string	En OAuth-åtkomsttoken som kan användas med en fjärr-MCP-server, antingen med en anpassad MCP-server-URL eller en tjänstanslutning. Din ansökan måste hantera OAuth-auktoriseringsflödet och ange token här.	No
connector_id	enum	Identifierare för tjänstanslutningsprogram, som de som är tillgängliga i ChatGPT. En av `server_url` eller `connector_id` måste tillhandahållas. Läs mer om tjänsten anslutningsappar här. För närvarande stöds `connector_id` värden: -Dropbox: `connector_dropbox` -Gmail: `connector_gmail` – Google Calendar: `connector_googlecalendar` – Google Drive: `connector_googledrive` – Microsoft Teams: `connector_microsoftteams` – Outlook-kalender: `connector_outlookcalendar` – E-post i Outlook: `connector_outlookemail` -Sharepoint: `connector_sharepoint` Möjliga värden: `connector_dropbox`, `connector_gmail`, `connector_googlecalendar`, `connector_googledrive`, `connector_microsoftteams`, `connector_outlookcalendar`, , , `connector_outlookemailconnector_sharepoint`	No
headers	objekt (nullbart)		No
project_connection_id	string	Anslutnings-ID:t i project för MCP-servern. Anslutningen lagrar autentisering och annan anslutningsinformation som behövs för att ansluta till MCP-servern.	No
kräv_godkännande	objekt (se giltiga modeller nedan)		No
server_description	string	Valfri beskrivning av MCP-servern, som används för att ge mer kontext.	No
serveretikett	string	En etikett för den här MCP-servern som används för att identifiera den i verktygsanrop.	Ja
server_url	string	URL:en för MCP-servern. En av `server_url` eller `connector_id` måste vara tillhandahålls.	No
type	enum	Typ av MCP-verktyg. Alltid `mcp`. Möjliga värden: `mcp`	Ja

OpenAI.MCPToolCallStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete` `calling` `failed`

OpenAI.MCPToolFilter

Ett filterobjekt som anger vilka verktyg som tillåts.

Name	Type	Description	Obligatoriskt	Standardinställning
read_only	boolean	Anger om ett verktyg ändrar data eller är skrivskyddat. Om en MCP-servern kommenteras med `readOnlyHint`, det matchar det här filtret.	No
tool_names	strängmatris	Lista över tillåtna verktygsnamn.	No

OpenAI.MCPToolRequireApproval

Name	Type	Description	Obligatoriskt	Standardinställning
always	OpenAI.MCPToolFilter	Ett filterobjekt som anger vilka verktyg som tillåts.	No
aldrig	OpenAI.MCPToolFilter	Ett filterobjekt som anger vilka verktyg som tillåts.	No

OpenAI.MessageContent

En innehållsdel som utgör ett indata- eller utdataobjekt.

Diskriminerande för OpenAI.MessageContent

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

Typvärde	Schema
`text`	OpenAI.TextContent
`summary_text`	OpenAI.SummaryTextContent
`computer_screenshot`	OpenAI.ComputerScreenshotContent
`input_text`	OpenAI.MessageContentInputTextContent
`output_text`	OpenAI.MessageContentOutputTextContent
`reasoning_text`	OpenAI.MessageContentReasoningTextContent
`refusal`	OpenAI.MessageContentRefusalContent
`input_image`	OpenAI.MessageContentInputImageContent
`input_file`	OpenAI.MessageContentInputFileContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.MessageContentType		Ja

OpenAI.MessageContentInputFileContent

En filinmatning till modellen.

Name	Type	Description	Obligatoriskt
file_data	string	Innehållet i filen som ska skickas till modellen.	No
file_id	sträng (nullbar)		No
file_url	string	URL:en för filen som ska skickas till modellen.	No
filename	string	Namnet på filen som ska skickas till modellen.	No
type	enum	Typ av indataobjekt. Alltid `input_file`. Möjliga värden: `input_file`	Ja

OpenAI.MessageContentInputImageContent

En bildinmatning till modellen. Läs mer om bildindata.

Name	Type	Description	Obligatoriskt
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		No
image_url	string		No
type	enum	Typ av indataobjekt. Alltid `input_image`. Möjliga värden: `input_image`	Ja

OpenAI.MessageContentInputTextContent

En textinmatning till modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Textinmatningen till modellen.	Ja
type	enum	Typ av indataobjekt. Alltid `input_text`. Möjliga värden: `input_text`	Ja

OpenAI.MessageContentOutputTextContent

En textutgång från modellen.

Name	Type	Description	Obligatoriskt
annotations	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		No
text	string	Textutdata från modellen.	Ja
type	enum	Typ av utdatatext. Alltid `output_text`. Möjliga värden: `output_text`	Ja

OpenAI.MessageContentReasoningTextContent

Resonemangstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Resonemangstexten från modellen.	Ja
type	enum	Typen av resonemangstext. Alltid `reasoning_text`. Möjliga värden: `reasoning_text`	Ja

OpenAI.MessageContentRefusalContent

En vägran från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
vägran	string	Avslagsförklaringen från modellen.	Ja
type	enum	Typ av vägran. Alltid `refusal`. Möjliga värden: `refusal`	Ja

OpenAI.MessageContentType

Property	Value
Type	string
Värden	`input_text` `output_text` `text` `summary_text` `reasoning_text` `refusal` `input_image` `computer_screenshot` `input_file`

OpenAI.MessageRole

Property	Value
Type	string
Värden	`unknown` `user` `assistant` `system` `critic` `discriminator` `developer` `tool`

OpenAI.MessageStatus

Property	Value
Type	string
Värden	`in_progress` `completed` `incomplete`

OpenAI.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.

Typ: objekt

OpenAI.ModelIdsCompaction

Modell-ID som används för att generera svaret, till exempel gpt-5 eller o3. OpenAI erbjuder ett brett utbud av modeller med olika funktioner, prestandaegenskaper och prispunkter. Se modellguiden för att bläddra bland och jämföra tillgängliga modeller.

Typ: OpenAI.ModelIdsResponses eller sträng

OpenAI.ModelIdsResponses

Property	Value
Type	string
Värden	`o1-pro` `o1-pro-2025-03-19` `o3-pro` `o3-pro-2025-06-10` `o3-deep-research` `o3-deep-research-2025-06-26` `o4-mini-deep-research` `o4-mini-deep-research-2025-06-26` `computer-use-preview` `computer-use-preview-2025-03-11` `gpt-5-codex` `gpt-5-pro` `gpt-5-pro-2025-10-06` `gpt-5.1-codex-max`

OpenAI.ModelIdsShared

Typ: sträng eller OpenAI.ChatModel

OpenAI.Move

En musflyttningsåtgärd.

Name	Type	Description	Obligatoriskt
type	enum	Anger händelsetypen. För en rörelseåtgärd är den här egenskapen alltid inställd på `move`. Möjliga värden: `move`	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.OutputContent

Diskriminerande för OpenAI.OutputContent

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

Typvärde	Schema
`output_text`	OpenAI.OutputContentOutputTextContent
`refusal`	OpenAI.OutputContentRefusalContent
`reasoning_text`	OpenAI.OutputContentReasoningTextContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.OutputContentType		Ja

OpenAI.OutputContentOutputTextContent

En textutgång från modellen.

Name	Type	Description	Obligatoriskt
annotations	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		No
text	string	Textutdata från modellen.	Ja
type	enum	Typ av utdatatext. Alltid `output_text`. Möjliga värden: `output_text`	Ja

OpenAI.OutputContentReasoningTextContent

Resonemangstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Resonemangstexten från modellen.	Ja
type	enum	Typen av resonemangstext. Alltid `reasoning_text`. Möjliga värden: `reasoning_text`	Ja

OpenAI.OutputContentRefusalContent

En vägran från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
vägran	string	Avslagsförklaringen från modellen.	Ja
type	enum	Typ av vägran. Alltid `refusal`. Möjliga värden: `refusal`	Ja

OpenAI.OutputContentType

Property	Value
Type	string
Värden	`output_text` `refusal` `reasoning_text`

OpenAI.OutputItem

Diskriminerande för OpenAI.OutputItem

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

Typvärde	Schema
`structured_outputs`	StructuredOutputsOutputItem
`workflow_action`	WorkflowActionOutputItem
`oauth_consent_request`	OAuthConsentRequestOutputItem
`memory_search_call`	MemorySearchToolCallItemResource
`output_message`	OpenAI.OutputItemOutputMessage
`file_search_call`	OpenAI.OutputItemFileSearchToolCall
`function_call`	OpenAI.OutputItemFunctionToolCall
`web_search_call`	OpenAI.OutputItemWebSearchToolCall
`computer_call`	OpenAI.OutputItemComputerToolCall
`reasoning`	OpenAI.OutputItemReasoningItem
`compaction`	OpenAI.OutputItemCompactionBody
`image_generation_call`	OpenAI.OutputItemImageGenToolCall
`code_interpreter_call`	OpenAI.OutputItemCodeInterpreterToolCall
`local_shell_call`	OpenAI.OutputItemLocalShellToolCall
`shell_call`	OpenAI.OutputItemFunctionShellCall
`shell_call_output`	OpenAI.OutputItemFunctionShellCallOutput
`apply_patch_call`	OpenAI.OutputItemApplyPatchToolCall
`apply_patch_call_output`	OpenAI.OutputItemApplyPatchToolCallOutput
`mcp_call`	OpenAI.OutputItemMcpToolCall
`mcp_list_tools`	OpenAI.OutputItemMcpListTools
`mcp_approval_request`	OpenAI.OutputItemMcpApprovalRequest
`custom_tool_call`	OpenAI.OutputItemCustomToolCall

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
response_id	string	Svaret som objektet skapas på.	No
type	OpenAI.OutputItemType		Ja

OpenAI.OutputItemApplyPatchToolCall

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för anropet använd korrigeringsverktyg. Fylls i när det här objektet returneras via API.	Ja
Operation	OpenAI.ApplyPatchFileOperation	En av de create_file, delete_file eller update_file åtgärder som tillämpas via apply_patch.	Ja
└– typ	OpenAI.ApplyPatchFileOperationType		Ja
response_id	string	Svaret som objektet skapas på.	No
status	OpenAI.ApplyPatchCallStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call`. Möjliga värden: `apply_patch_call`	Ja

OpenAI.OutputItemApplyPatchToolCallOutput

Utdata som genereras av ett tillämpat korrigeringsverktygsanrop.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
call_id	string	Det unika ID:t för anropet för tillämpat korrigeringsverktyg som genererats av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktyget anropar utdata.	No
id	string	Det unika ID:t för anropsutdata för det tillämpade korrigeringsverktyget. Fylls i när det här objektet returneras via API.	Ja
output	sträng (nullbar)		No
response_id	string	Svaret som objektet skapas på.	No
status	OpenAI.ApplyPatchCallOutputStatus		Ja
type	enum	Typ av objekt. Alltid `apply_patch_call_output`. Möjliga värden: `apply_patch_call_output`	Ja

OpenAI.OutputItemCodeInterpreterToolCall

Ett verktygsanrop för att köra kod.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
code	sträng (nullbar)		Ja
container_id	string	ID:t för containern som används för att köra koden.	Ja
id	string	Det unika ID:t för kodtolkarverktygets anrop.	Ja
outputs	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
response_id	string	Svaret som objektet skapas på.	No
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är `in_progress`, `completed`, `incomplete`, `interpreting`och `failed`. Möjliga värden: `in_progress`, `completed`, `incomplete`, , `interpretingfailed`	Ja
type	enum	Typ av kodtolkarverktygsanrop. Alltid `code_interpreter_call`. Möjliga värden: `code_interpreter_call`	Ja

OpenAI.OutputItemCompactionBody

Ett komprimeringsobjekt som genereras av API:etv1/responses/compact.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
skapad av	string	Identifieraren för aktören som skapade objektet.	No
encrypted_content	string	Det krypterade innehåll som producerades av komprimering.	Ja
id	string	Det unika ID:t för komprimeringsobjektet.	Ja
response_id	string	Svaret som objektet skapas på.	No
type	enum	Typ av objekt. Alltid `compaction`. Möjliga värden: `compaction`	Ja

OpenAI.OutputItemComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Mer information finns i guiden för datoranvändning .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.ComputerAction		Ja
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
call_id	string	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
id	string	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
response_id	string	Svaret som objektet skapas på.	No
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av datoranrop. Alltid `computer_call`. Möjliga värden: `computer_call`	Ja

OpenAI.OutputItemCustomToolCall

Ett anrop till ett anpassat verktyg som skapats av modellen.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
call_id	string	En identifierare som används för att mappa det här anpassade verktygsanropet till ett verktygsanropsutdata.	Ja
id	string	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	No
Input	string	Indata för det anpassade verktygsanropet som genereras av modellen.	Ja
name	string	Namnet på det anpassade verktyg som anropas.	Ja
response_id	string	Svaret som objektet skapas på.	No
type	enum	Typ av anpassat verktygsanrop. Alltid `custom_tool_call`. Möjliga värden: `custom_tool_call`	Ja

OpenAI.OutputItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Mer information finns i filsökningsguiden .

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
id	string	Det unika ID:t för anropet av filsökningsverktyget.	Ja
queries	strängmatris	De frågor som används för att söka efter filer.	Ja
response_id	string	Svaret som objektet skapas på.	No
results	matris med OpenAI.FileSearchToolCallResults		No
status	enum	Status för filsökningsverktygets anrop. En av `in_progress`, `searching`, `incomplete` eller `failed`, Möjliga värden: `in_progress`, `searching`, `completed`, , `incompletefailed`	Ja
type	enum	Typ av filsökningsverktygsanrop. Alltid `file_search_call`. Möjliga värden: `file_search_call`	Ja

OpenAI.OutputItemFunctionShellCall

Ett verktygsanrop som kör ett eller flera gränssnittskommandon i en hanterad miljö.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.FunctionShellAction	Kör ett gränssnittskommando.	Ja
└– kommandon	strängmatris		Ja
└– max_output_length	OpenAI.integer (nullbar)		Ja
└– timeout_ms	OpenAI.integer (nullbar)		Ja
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	ID:t för entiteten som skapade det här verktygsanropet.	No
id	string	Det unika ID:t för gränssnittets verktygsanrop. Fylls i när det här objektet returneras via API.	Ja
response_id	string	Svaret som objektet skapas på.	No
status	OpenAI.LocalShellCallStatus		Ja
type	enum	Typ av objekt. Alltid `shell_call`. Möjliga värden: `shell_call`	Ja

OpenAI.OutputItemFunctionShellCallOutput

Utdata från ett gränssnittsverktygsanrop som har genererats.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
call_id	string	Det unika ID:t för gränssnittets verktygsanrop som genereras av modellen.	Ja
skapad av	string	Identifieraren för aktören som skapade objektet.	No
id	string	Det unika ID:t för shell-anropets utdata. Fylls i när det här objektet returneras via API.	Ja
max_output_length	OpenAI.integer (nullbar)		Ja
output	matris med OpenAI.FunctionShellCallOutputContent	En matris med gränssnittsanropets utdatainnehåll	Ja
response_id	string	Svaret som objektet skapas på.	No
type	enum	Typ av gränssnittsanropets utdata. Alltid `shell_call_output`. Möjliga värden: `shell_call_output`	Ja

OpenAI.OutputItemFunctionToolCall

Ett verktygsanrop för att köra en funktion. Mer information finns i funktionssamtalsguiden .

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
arguments	string	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	string	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
id	string	Det unika ID:t för funktionsverktygets anrop.	No
name	string	Namnet på den funktion som ska köras.	Ja
response_id	string	Svaret som objektet skapas på.	No
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
type	enum	Typ av funktionsverktygets anrop. Alltid `function_call`. Möjliga värden: `function_call`	Ja

OpenAI.OutputItemImageGenToolCall

En begäran om bildgenerering som gjorts av modellen.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
id	string	Det unika ID:t för bildgenereringsanropet.	Ja
response_id	string	Svaret som objektet skapas på.	No
result	sträng (nullbar)		Ja
status	enum	Status för avbildningsgenereringsanropet. Möjliga värden: `in_progress`, `completed`, `generating`, `failed`	Ja
type	enum	Typ av avbildningsgenereringsanrop. Alltid `image_generation_call`. Möjliga värden: `image_generation_call`	Ja

OpenAI.OutputItemLocalShellToolCall

Ett verktygsanrop för att köra ett kommando i det lokala gränssnittet.

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
call_id	string	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
id	string	Det unika ID:t för det lokala gränssnittsanropet.	Ja
response_id	string	Svaret som objektet skapas på.	No
status	enum	Status för det lokala gränssnittsanropet. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av lokalt gränssnittsanrop. Alltid `local_shell_call`. Möjliga värden: `local_shell_call`	Ja

OpenAI.OutputItemMcpApprovalRequest

En begäran om mänskligt godkännande av ett verktygsanrop.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
arguments	string	En JSON-sträng med argument för verktyget.	Ja
id	string	Det unika ID:t för godkännandebegäran.	Ja
name	string	Namnet på det verktyg som ska köras.	Ja
response_id	string	Svaret som objektet skapas på.	No
serveretikett	string	Etiketten på MCP-servern som skickar begäran.	Ja
type	enum	Typ av objekt. Alltid `mcp_approval_request`. Möjliga värden: `mcp_approval_request`	Ja

OpenAI.OutputItemMcpListTools

En lista över verktyg som är tillgängliga på en MCP-server.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
fel	sträng (nullbar)		No
id	string	Listans unika ID.	Ja
response_id	string	Svaret som objektet skapas på.	No
serveretikett	string	MCP-serverns etikett.	Ja
tools	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
type	enum	Typ av objekt. Alltid `mcp_list_tools`. Möjliga värden: `mcp_list_tools`	Ja

OpenAI.OutputItemMcpToolCall

Ett anrop av ett verktyg på en MCP-server.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
approval_request_id	sträng (nullbar)		No
arguments	string	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		No
id	string	Det unika ID:t för verktygsanropet.	Ja
name	string	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		No
response_id	string	Svaret som objektet skapas på.	No
serveretikett	string	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		No
type	enum	Typ av objekt. Alltid `mcp_call`. Möjliga värden: `mcp_call`	Ja

OpenAI.OutputItemOutputMessage

Ett utdatameddelande från modellen.

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
id	string	Utdatameddelandets unika ID.	Ja
response_id	string	Svaret som objektet skapas på.	No
role	enum	Utdatameddelandets roll. Alltid `assistant`. Möjliga värden: `assistant`	Ja
status	enum	Status för meddelandets indata. En av `in_progress`, `completed` eller `incomplete`. Fylls i när indataobjekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	Ja
type	enum	Typ av utdatameddelande. Alltid `message`. Möjliga värden: `output_message`	Ja

OpenAI.OutputItemReasoningItem

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
innehåll	matris med OpenAI.ReasoningTextContent	Textinnehåll i resonemang.	No
encrypted_content	sträng (nullbar)		No
id	string	Den unika identifieraren för resonemangsinnehållet.	Ja
response_id	string	Svaret som objektet skapas på.	No
status	enum	Status för objektet. En av `in_progress`, `completed` eller `incomplete`. Fylls i när objekt returneras via API. Möjliga värden: `in_progress`, `completed`, `incomplete`	No
summary	matris med OpenAI.Summary	Sammanfattningsinnehåll för resonemang.	Ja
type	enum	Typ av objekt. Alltid `reasoning`. Möjliga värden: `reasoning`	Ja

OpenAI.OutputItemType

Property Value

Type string

Värden output_message
file_search_call
function_call
web_search_call
computer_call
reasoning
compaction
image_generation_call
code_interpreter_call
local_shell_call
shell_call
shell_call_output
apply_patch_call
apply_patch_call_output
mcp_call
mcp_list_tools
mcp_approval_request
custom_tool_call
structured_outputs
oauth_consent_request
memory_search_call
workflow_action

OpenAI.OutputItemWebSearchToolCall

Resultatet av ett webbsökningsverktygsanrop. Mer information finns i webbsökningsguiden .

Name	Type	Description	Obligatoriskt
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtagits i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, sök).	Ja
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
id	string	Det unika ID:t för webbsökningsverktyget anropar.	Ja
response_id	string	Svaret som objektet skapas på.	No
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: `in_progress`, `searching`, `completed`, `failed`	Ja
type	enum	Typ av webbsökningsverktygsanrop. Alltid `web_search_call`. Möjliga värden: `web_search_call`	Ja

OpenAI.OutputMessageContent

Diskriminerande för OpenAI.OutputMessageContent

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

Typvärde	Schema
`output_text`	OpenAI.OutputMessageContentOutputTextContent
`refusal`	OpenAI.OutputMessageContentRefusalContent

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.OutputMessageContentType		Ja

OpenAI.OutputMessageContentOutputTextContent

En textutgång från modellen.

Name	Type	Description	Obligatoriskt
annotations	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		No
text	string	Textutdata från modellen.	Ja
type	enum	Typ av utdatatext. Alltid `output_text`. Möjliga värden: `output_text`	Ja

OpenAI.OutputMessageContentRefusalContent

En vägran från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
vägran	string	Avslagsförklaringen från modellen.	Ja
type	enum	Typ av vägran. Alltid `refusal`. Möjliga värden: `refusal`	Ja

OpenAI.OutputMessageContentType

Property	Value
Type	string
Värden	`output_text` `refusal`

OpenAI.Prompt

Referens till en promptmall och dess variabler. Läs mer.

Name	Type	Description	Obligatoriskt
id	string	Den unika identifieraren för den promptmall som ska användas.	Ja
variables	OpenAI.ResponsePromptVariables (nullbar)	Valfri värdekarta för att ersätta variabler i din snabb. Ersättningsvärdena kan antingen vara strängar eller andra Svarsindatatyper som bilder eller filer.	No
version	sträng (nullbar)		No

OpenAI.RankerVersionType

Property	Value
Type	string
Värden	`auto` `default-2024-11-15`

OpenAI.Rankningsalternativ

Name	Type	Description	Obligatoriskt
hybrid_search	OpenAI.HybridSearchOptions		No
└– embedding_weight	OpenAI.numeric	Vikten av inbäddningen i den ömsesidiga rankningsfusionen.	Ja
└– text_weight	OpenAI.numeric	Textens vikt i den ömsesidiga rangordningsfusionen.	Ja
rankare	OpenAI.RankerVersionType		No
poängtröskel	OpenAI.numeric		No

OpenAI.Reasoning

endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.

Name	Type	Description	Obligatoriskt
effort	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
generate_summary	enum	Möjliga värden: `auto`, `concise`, `detailed`	No
summary	enum	Möjliga värden: `auto`, `concise`, `detailed`	No

OpenAI.ReasoningEffort

Begränsar arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är none, minimal, low, medium, highoch xhigh. Att minska resonemangsinsatsen kan resultera i snabbare svar och färre token som används vid resonemang i ett svar.

gpt-5.1 standardvärdet är none, som inte utför resonemang. De resonemangsvärden som stöds för gpt-5.1 är none, low, mediumoch high. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1.
Alla modeller före gpt-5.1 standardinställningen för resonemang och har inte stöd mediumför none .
Modellen gpt-5-pro har som standard (och stöder endast) high resonemang.
xhigh stöds för alla modeller efter gpt-5.1-codex-max.

Property	Value
Type	string
Nullbar	Ja
Värden	`none` `minimal` `low` `medium` `high` `xhigh`

OpenAI.ReasoningTextContent

Resonemangstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Resonemangstexten från modellen.	Ja
type	enum	Typen av resonemangstext. Alltid `reasoning_text`. Möjliga värden: `reasoning_text`	Ja

OpenAI.Response

Name	Type	Description	Obligatoriskt	Standardinställning
agent_reference	AgentReference (nullbar)		Ja
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
bakgrund	boolesk (nullbar)		No
klarad_vid	integer		No
konversation	OpenAI.ConversationReference (nullbar)	Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.	No
└– id	string	Det unika ID:t för konversationen som det här svaret var associerat med.	Ja
skapad_tid	integer	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
fel	OpenAI.ResponseError (nullbar)	Ett felobjekt som returneras när modellen inte genererar ett svar.	Ja
└– kod	OpenAI.ResponseErrorCode	Felkoden för svaret.	Ja
└– meddelande	string	En läsbar beskrivning av felet.	Ja
id	string	Unik identifierare för det här svaret.	Ja
incomplete_details	OpenAI.ResponseIncompleteDetails (nullbar)		Ja
└— orsak	enum	Möjliga värden: `max_output_tokens`, `content_filter`	No
instructions	sträng eller matris med OpenAI.InputItem		Ja
max_output_tokens	OpenAI.integer (nullbar)		No
max_verktygs_anrop	OpenAI.integer (nullbar)		No
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
model	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
object	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
output	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
output_text	sträng (nullbar)		No
parallella verktygsanrop	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
previous_response_id	sträng (nullbar)		No
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
reasoning	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└— insats	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
└– generate_summary	enum	Möjliga värden: `auto`, `concise`, `detailed`	No
└— sammanfattning	enum	Möjliga värden: `auto`, `concise`, `detailed`	No
safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
servicenivå	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
Temperatur	OpenAI.numeric (nullbar)		No	1
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
top_logprobs	OpenAI.integer (nullbar)		No
top_p	OpenAI.numeric (nullbar)		No	1
truncation	enum	Möjliga värden: `auto`, `disabled`	No
usage	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
user	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No

OpenAI.ResponseAudioDeltaEvent

Genereras när det finns ett partiellt ljudsvar.

Name	Type	Description	Obligatoriskt
delta	string	Ett segment med Base64-kodade svarsljudbyte.	Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.audio.delta`. Möjliga värden: `response.audio.delta`	Ja

OpenAI.ResponseAudioDoneEvent

Genereras när ljudsvaret är klart.

Name	Type	Description	Obligatoriskt	Standardinställning
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.audio.done`. Möjliga värden: `response.audio.done`	Ja

OpenAI.ResponseAudioTranscriptDeltaEvent

Genereras när det finns en partiell avskrift av ljud.

Name	Type	Description	Obligatoriskt
delta	string	Den partiella avskriften av ljudsvaret.	Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.audio.transcript.delta`. Möjliga värden: `response.audio.transcript.delta`	Ja

OpenAI.ResponseAudioTranscriptDoneEvent

Genereras när den fullständiga ljudavskriften har slutförts.

Name	Type	Description	Obligatoriskt	Standardinställning
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.audio.transcript.done`. Möjliga värden: `response.audio.transcript.done`	Ja

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Genereras när ett partiellt kodfragment strömmas av kodtolkaren.

Name	Type	Description	Obligatoriskt
delta	string	Det partiella kodfragmentet som strömmas av kodtolkaren.	Ja
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call_code.delta`. Möjliga värden: `response.code_interpreter_call_code.delta`	Ja

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Genereras när kodfragmentet slutförs av kodtolkaren.

Name	Type	Description	Obligatoriskt
code	string	Det slutliga utdatat från kodtolken för kodfragmentet.	Ja
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call_code.done`. Möjliga värden: `response.code_interpreter_call_code.done`	Ja

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Genereras när kodtolkaranropet har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call.completed`. Möjliga värden: `response.code_interpreter_call.completed`	Ja

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Genereras när ett kodtolkaranrop pågår.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call.in_progress`. Möjliga värden: `response.code_interpreter_call.in_progress`	Ja

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Genereras när kodtolkaren aktivt tolkar kodfragmentet.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.code_interpreter_call.interpreting`. Möjliga värden: `response.code_interpreter_call.interpreting`	Ja

OpenAI.ResponseCompletedEvent

Genereras när modellsvaret är klart.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		No
└– completed_at	heltal (nullable)		No
└– konversation	OpenAI.ConversationReference (nullbar)	Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.	No
└– created_at	integer	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError (nullbar)	Ett felobjekt som returneras när modellen inte genererar ett svar.	Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails (nullbar)		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullbar)		No
└– max_tool_calls	OpenAI.integer (nullbar)		No
└– metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
└– modell	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng (nullbar)		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng (nullbar)		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
└– prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	OpenAI.numeric (nullbar)		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	OpenAI.integer (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
└– trunkering	enum	Möjliga värden: `auto`, `disabled`	No
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.completed`. Möjliga värden: `response.completed`	Ja

OpenAI.ResponseContentPartAddedEvent

Genereras när en ny innehållsdel läggs till.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
item_id	string	ID:t för utdataobjektet som innehållsdelen lades till i.	Ja
output_index	OpenAI.integer		Ja
del	OpenAI.OutputContent		Ja
└– typ	OpenAI.OutputContentType		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.content_part.added`. Möjliga värden: `response.content_part.added`	Ja

OpenAI.ResponseContentPartDoneEvent

Genereras när en innehållsdel är klar.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
item_id	string	ID:t för utdataobjektet som innehållsdelen lades till i.	Ja
output_index	OpenAI.integer		Ja
del	OpenAI.OutputContent		Ja
└– typ	OpenAI.OutputContentType		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.content_part.done`. Möjliga värden: `response.content_part.done`	Ja

OpenAI.ResponseCreatedEvent

En händelse som genereras när ett svar skapas.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		No
└– completed_at	heltal (nullable)		No
└– konversation	OpenAI.ConversationReference (nullbar)	Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.	No
└– created_at	integer	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError (nullbar)	Ett felobjekt som returneras när modellen inte genererar ett svar.	Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails (nullbar)		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullbar)		No
└– max_tool_calls	OpenAI.integer (nullbar)		No
└– metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
└– modell	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng (nullbar)		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng (nullbar)		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
└– prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	OpenAI.numeric (nullbar)		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	OpenAI.integer (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
└– trunkering	enum	Möjliga värden: `auto`, `disabled`	No
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.created`. Möjliga värden: `response.created`	Ja

OpenAI.ResponseCustomToolCallInputDeltaEvent

Händelse som representerar ett delta (partiell uppdatering) till indata för ett anpassat verktygsanrop.

Name	Type	Description	Obligatoriskt
delta	string	Inkrementella indata (delta) för det anpassade verktygsanropet.	Ja
item_id	string	Unik identifierare för DET API-objekt som är associerat med den här händelsen.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Händelsetypidentifieraren. Möjliga värden: `response.custom_tool_call_input.delta`	Ja

OpenAI.ResponseCustomToolCallInputDoneEvent

Händelse som anger att indata för ett anpassat verktygsanrop är slutfört.

Name	Type	Description	Obligatoriskt
Input	string	Fullständiga indata för det anpassade verktygsanropet.	Ja
item_id	string	Unik identifierare för DET API-objekt som är associerat med den här händelsen.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Händelsetypidentifieraren. Möjliga värden: `response.custom_tool_call_input.done`	Ja

OpenAI.ResponseError

Ett felobjekt som returneras när modellen inte genererar ett svar.

Name	Type	Description	Obligatoriskt	Standardinställning
code	OpenAI.ResponseErrorCode	Felkoden för svaret.	Ja
message	string	En läsbar beskrivning av felet.	Ja

OpenAI.ResponseErrorCode

Felkoden för svaret.

Property	Value
Type	string
Värden	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

Genereras när ett fel inträffar.

Name	Type	Description	Obligatoriskt
code	sträng (nullbar)		Ja
message	string	Felmeddelandet.	Ja
Param	sträng (nullbar)		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `error`. Möjliga värden: `error`	Ja

OpenAI.ResponseFailedEvent

En händelse som genereras när ett svar misslyckas.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		No
└– completed_at	heltal (nullable)		No
└– konversation	OpenAI.ConversationReference (nullbar)	Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.	No
└– created_at	integer	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError (nullbar)	Ett felobjekt som returneras när modellen inte genererar ett svar.	Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails (nullbar)		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullbar)		No
└– max_tool_calls	OpenAI.integer (nullbar)		No
└– metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
└– modell	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng (nullbar)		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng (nullbar)		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
└– prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	OpenAI.numeric (nullbar)		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	OpenAI.integer (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
└– trunkering	enum	Möjliga värden: `auto`, `disabled`	No
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.failed`. Möjliga värden: `response.failed`	Ja

OpenAI.ResponseFileSearchCallCompletedEvent

Genereras när ett filsökningsanrop har slutförts (resultat hittades).

Name	Type	Description	Obligatoriskt
item_id	string	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.file_search_call.completed`. Möjliga värden: `response.file_search_call.completed`	Ja

OpenAI.ResponseFileSearchCallInProgressEvent

Genereras när ett filsökningsanrop initieras.

Name	Type	Description	Obligatoriskt
item_id	string	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.file_search_call.in_progress`. Möjliga värden: `response.file_search_call.in_progress`	Ja

OpenAI.ResponseFileSearchCallSearchingEvent

Genereras när en filsökning för närvarande söker.

Name	Type	Description	Obligatoriskt
item_id	string	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.file_search_call.searching`. Möjliga värden: `response.file_search_call.searching`	Ja

OpenAI.ResponseFormatJsonObject

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `json_object`. Möjliga värden: `json_object`	Ja

OpenAI.ResponseFormatJsonSchema

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar. Läs mer om strukturerade utdata.

Name	Type	Description	Obligatoriskt
json-schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Ja
└— beskrivning	string		No
└— namn	string		Ja
└– schema	OpenAI.ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.	No
└– strikt	boolesk (nullbar)		No
type	enum	Vilken typ av svarsformat som definieras. Alltid `json_schema`. Möjliga värden: `json_schema`	Ja

OpenAI.ResponseFormatJsonSchemaJsonSchema

Name	Type	Description	Obligatoriskt
beskrivning	string		No
name	string		Ja
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.	No
Strikt	boolesk (nullbar)		No

OpenAI.ResponseFormatJsonSchemaSchema

Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.

Typ: objekt

OpenAI.ResponseFormatText

Standardformat för svar. Används för att generera textsvar.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `text`. Möjliga värden: `text`	Ja

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Genereras när det finns ett partiellt funktionsanropsargument delta.

Name	Type	Description	Obligatoriskt
delta	string	Funktionsanropsargumentens delta som läggs till.	Ja
item_id	string	ID:t för utdataobjektet som deltat för funktionsanropsargument läggs till i.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.function_call_arguments.delta`. Möjliga värden: `response.function_call_arguments.delta`	Ja

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Genereras när argumenten för funktionsanrop slutförs.

Name	Type	Description	Obligatoriskt
arguments	string	Argumenten för funktionsanrop.	Ja
item_id	string	Objektets ID.	Ja
name	string	Namnet på evenemanget som kallades.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Möjliga värden: `response.function_call_arguments.done`	Ja

OpenAI.ResponseImageGenCallCompletedEvent

Genereras när ett bildgenereringsverktygsanrop har slutförts och den slutliga avbildningen är tillgänglig.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.image_generation_call.completed". Möjliga värden: `response.image_generation_call.completed`	Ja

OpenAI.ResponseImageGenCallGeneratingEvent

Genereras när ett verktygsanrop för bildgenerering aktivt genererar en avbildning (mellanliggande tillstånd).

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid “response.image_generation_call.generating”. Möjliga värden: `response.image_generation_call.generating`	Ja

OpenAI.ResponseImageGenCallInProgressEvent

Genereras när ett avbildningsgenereringsverktygsanrop pågår.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.image_generation_call.in_progress". Möjliga värden: `response.image_generation_call.in_progress`	Ja

OpenAI.ResponseImageGenCallPartialImageEvent

Genereras när en partiell avbildning är tillgänglig under direktuppspelning av bildgenerering.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
partial_image_b64	string	Base64-kodade partiella bilddata, lämpliga för återgivning som en bild.	Ja
partial_image_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.image_generation_call.partial_image". Möjliga värden: `response.image_generation_call.partial_image`	Ja

OpenAI.ResponseInProgressEvent

Genereras när svaret pågår.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		No
└– completed_at	heltal (nullable)		No
└– konversation	OpenAI.ConversationReference (nullbar)	Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.	No
└– created_at	integer	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError (nullbar)	Ett felobjekt som returneras när modellen inte genererar ett svar.	Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails (nullbar)		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullbar)		No
└– max_tool_calls	OpenAI.integer (nullbar)		No
└– metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
└– modell	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng (nullbar)		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng (nullbar)		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
└– prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	OpenAI.numeric (nullbar)		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	OpenAI.integer (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
└– trunkering	enum	Möjliga värden: `auto`, `disabled`	No
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.in_progress`. Möjliga värden: `response.in_progress`	Ja

OpenAI.ResponseIncompleteDetails

Name	Type	Description	Obligatoriskt	Standardinställning
reason	enum	Möjliga värden: `max_output_tokens`, `content_filter`	No

OpenAI.ResponseIncompleteEvent

En händelse som genereras när ett svar avslutas som ofullständigt.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		No
└– completed_at	heltal (nullable)		No
└– konversation	OpenAI.ConversationReference (nullbar)	Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.	No
└– created_at	integer	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError (nullbar)	Ett felobjekt som returneras när modellen inte genererar ett svar.	Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails (nullbar)		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullbar)		No
└– max_tool_calls	OpenAI.integer (nullbar)		No
└– metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
└– modell	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng (nullbar)		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng (nullbar)		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
└– prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	OpenAI.numeric (nullbar)		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	OpenAI.integer (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
└– trunkering	enum	Möjliga värden: `auto`, `disabled`	No
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.incomplete`. Möjliga värden: `response.incomplete`	Ja

OpenAI.ResponseLogProb

En logprob är den logaritmiska sannolikhet som modellen tilldelar för att producera en viss token vid en viss position i sekvensen. Mindre negativa (högre) logprob-värden indikerar större modellförtroende för det tokenvalet.

Name	Type	Description	Obligatoriskt
logprob	OpenAI.numeric		Ja
token	string	En möjlig texttoken.	Ja
top_logprobs	matris med OpenAI.ResponseLogProbTopLogprobs	Loggens sannolikhet för de 20 mest sannolika token.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Type	Description	Obligatoriskt	Standardinställning
logprob	OpenAI.numeric		No
token	string		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Genereras när det finns ett delta (partiell uppdatering) till argumenten för ett MCP-verktygsanrop.

Name	Type	Description	Obligatoriskt
delta	string	En JSON-sträng som innehåller den partiella uppdateringen av argumenten för MCP-verktygsanropet.	Ja
item_id	string	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.mcp_call_arguments.delta". Möjliga värden: `response.mcp_call_arguments.delta`	Ja

OpenAI.ResponseMCPCallArgumentsDoneEvent

Genereras när argumenten för ett MCP-verktygsanrop slutförs.

Name	Type	Description	Obligatoriskt
arguments	string	En JSON-sträng som innehåller de slutgiltiga argumenten för MCP-verktygsanropet.	Ja
item_id	string	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.mcp_call_arguments.done". Möjliga värden: `response.mcp_call_arguments.done`	Ja

OpenAI.ResponseMCPCallCompletedEvent

Genereras när ett MCP-verktygsanrop har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktyget anropar objektet som har slutförts.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid «response.mcp_call.completed». Möjliga värden: `response.mcp_call.completed`	Ja

OpenAI.ResponseMCPCallFailedEvent

Genereras när ett MCP-verktygsanrop har misslyckats.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktygets anropsobjekt som misslyckades.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.mcp_call.failed". Möjliga värden: `response.mcp_call.failed`	Ja

OpenAI.ResponseMCPCallInProgressEvent

Genereras när ett MCP-verktygsanrop pågår.

Name	Type	Description	Obligatoriskt
item_id	string	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid ‘response.mcp_call.in_progress’. Möjliga värden: `response.mcp_call.in_progress`	Ja

OpenAI.ResponseMCPListToolsCompletedEvent

Genereras när listan över tillgängliga MCP-verktyg har hämtats.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktyget anropar objektet som genererade dessa utdata.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid ”response.mcp_list_tools.completed”. Möjliga värden: `response.mcp_list_tools.completed`	Ja

OpenAI.ResponseMCPListToolsFailedEvent

Genereras när försöket att visa tillgängliga MCP-verktyg misslyckades.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktygets anropsobjekt som misslyckades.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.mcp_list_tools.failed". Möjliga värden: `response.mcp_list_tools.failed`	Ja

OpenAI.ResponseMCPListToolsInProgressEvent

Genereras när systemet håller på att hämta listan över tillgängliga MCP-verktyg.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.mcp_list_tools.in_progress". Möjliga värden: `response.mcp_list_tools.in_progress`	Ja

OpenAI.ResponseOutputItemAddedEvent

Genereras när ett nytt utdataobjekt läggs till.

Name	Type	Description	Obligatoriskt
item	OpenAI.OutputItem		Ja
└– agent_reference	AgentReference	Agenten som skapade objektet.	No
└response_id	string	Svaret som objektet skapas på.	No
└– typ	OpenAI.OutputItemType		Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.output_item.added`. Möjliga värden: `response.output_item.added`	Ja

OpenAI.ResponseOutputItemDoneEvent

Genereras när ett utdataobjekt markeras som klart.

Name	Type	Description	Obligatoriskt
item	OpenAI.OutputItem		Ja
└– agent_reference	AgentReference	Agenten som skapade objektet.	No
└response_id	string	Svaret som objektet skapas på.	No
└– typ	OpenAI.OutputItemType		Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.output_item.done`. Möjliga värden: `response.output_item.done`	Ja

OpenAI.ResponseOutputTextAnnotationAddedEvent

Genereras när en anteckning läggs till i utdatatextinnehållet.

Name	Type	Description	Obligatoriskt
Anteckning	OpenAI.Annotation	En anteckning som gäller för ett intervall med utdatatext.	Ja
└– typ	OpenAI.AnnotationType		Ja
annotation_index	OpenAI.integer		Ja
content_index	OpenAI.integer		Ja
item_id	string	Den unika identifieraren för det objekt som anteckningen läggs till i.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.output_text.annotation.added". Möjliga värden: `response.output_text.annotation.added`	Ja

OpenAI.ResponsePromptVariables

Valfri karta av värden för att ersätta variabler i din uppmaning. Ersättningsvärdena kan antingen vara strängar eller andra typer av svarsindata som bilder eller filer.

Typ: objekt

OpenAI.ResponseQueuedEvent

Genereras när ett svar placeras i kö och väntar på att bearbetas.

Name	Type	Description	Obligatoriskt	Standardinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		No
└– completed_at	heltal (nullable)		No
└– konversation	OpenAI.ConversationReference (nullbar)	Konversationen som det här svaret tillhörde. Indataobjekt och utdataobjekt från det här svaret lades automatiskt till i den här konversationen.	No
└– created_at	integer	Unix-tidsstämpel (i sekunder) för när det här svaret skapades.	Ja
└– fel	OpenAI.ResponseError (nullbar)	Ett felobjekt som returneras när modellen inte genererar ett svar.	Ja
└– id	string	Unik identifierare för det här svaret.	Ja
└─ ofullständiga_detlajer	OpenAI.ResponseIncompleteDetails (nullbar)		Ja
└─ Instruktioner	sträng eller matris med OpenAI.InputItem (nullable)		Ja
└– max_output_tokens	OpenAI.integer (nullbar)		No
└– max_tool_calls	OpenAI.integer (nullbar)		No
└– metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
└– modell	string	Implementeringen av modellen som ska användas för att skapa det här svaret.	No
└– objekt	enum	Objekttypen för den här resursen – ange alltid till `response`. Möjliga värden: `response`	Ja
└– utdata	matris med OpenAI.OutputItem	En matris med innehållsobjekt som genereras av modellen. – Längden och ordningen på objekt i matrisen `output` är beroende på modellens svar. – I stället för att komma åt det första objektet i matrisen `output` och anta att det är ett `assistant` meddelande med innehållet som har genererats av i modellen kan du överväga att använda egenskapen `output_text` där stöds i SDK:er.	Ja
└output_text	sträng (nullbar)		No
└– parallel_tool_calls	boolean	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	True
└– föregående_svar_id	sträng (nullbar)		No
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	No
└– prompt_cache_key	string	Används av OpenAI för att cachelagra svar för liknande begäranden för att optimera dina cacheträffar. Ersätter fältet `user` . Läs mer.	No
└– prompt_cache_retention	enum	Möjliga värden: `in-memory`, `24h`	No
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└– safety_identifier	string	En stabil identifierare som används för att identifiera användare av ditt program som kan bryta mot OpenAI:s användningsprinciper. ID:na ska vara en sträng som unikt identifierar varje användare. Vi rekommenderar att du hashar användarnamnet eller e-postadressen för att undvika att skicka identifierande information till oss. Läs mer.	No
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. – Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard". – Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen. – Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå. – När den inte har angetts är standardbeteendet "auto". När parametern `service_tier` har angetts innehåller svarstexten `service_tier` värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.	No
└─ Status	enum	Status för svarsgenereringen. En av `completed`, `failed`, `in_progress`, `cancelled`, `queued` eller `incomplete`. Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`, , `queuedincomplete`	No
└– temperatur	OpenAI.numeric (nullbar)		No	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara enkel text eller strukturerade JSON-data. Lära sig mer: - Textindata och utdata - Strukturerade utdata	No
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		No
└— verktyg	OpenAI.ToolsArray	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` . Vi stöder följande kategorier av verktyg: - Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg. - MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg. - Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, gör det möjligt för modellen att anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.	No
└– top_logprobs	OpenAI.integer (nullbar)		No
└– top_p	OpenAI.numeric (nullbar)		No	1
└– trunkering	enum	Möjliga värden: `auto`, `disabled`	No
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	No
└– användare	sträng (inaktuell)	Det här fältet ersätts av `safety_identifier` och `prompt_cache_key`. Använd `prompt_cache_key` i stället för att underhålla cachelagringsoptimeringar. En stabil identifierare för dina slutanvändare. Används för att öka antalet cacheträffar genom bättre bucketning av liknande begäranden och för att hjälpa OpenAI att identifiera och förhindra missbruk. Läs mer.	No
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid "response.queued". Möjliga värden: `response.queued`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEvent

Genereras när en ny sammanfattningsdel för resonemang läggs till.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för objektet som den här sammanfattningsdelen är associerad med.	Ja
output_index	OpenAI.integer		Ja
del	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Ja
└– text	string		Ja
└– typ	enum	Möjliga värden: `summary_text`	Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_part.added`. Möjliga värden: `response.reasoning_summary_part.added`	Ja

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Type	Description	Obligatoriskt	Standardinställning
text	string		Ja
type	enum	Möjliga värden: `summary_text`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEvent

Genereras när en sammanfattningsdel av resonemanget har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för objektet som den här sammanfattningsdelen är associerad med.	Ja
output_index	OpenAI.integer		Ja
del	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Ja
└– text	string		Ja
└– typ	enum	Möjliga värden: `summary_text`	Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_part.done`. Möjliga värden: `response.reasoning_summary_part.done`	Ja

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Type	Description	Obligatoriskt	Standardinställning
text	string		Ja
type	enum	Möjliga värden: `summary_text`	Ja

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Genereras när ett delta läggs till i en sammanfattningstext för resonemang.

Name	Type	Description	Obligatoriskt
delta	string	Textdeltat som har lagts till i sammanfattningen.	Ja
item_id	string	ID:t för objektet som den här sammanfattningstextdelten är associerad med.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_text.delta`. Möjliga värden: `response.reasoning_summary_text.delta`	Ja

OpenAI.ResponseReasoningSummaryTextDoneEvent

Genereras när en sammanfattningstext för resonemanget har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	ID:t för objektet som den här sammanfattningstexten är associerad med.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		Ja
text	string	Den fullständiga texten i den slutförda motiveringssammanfattningen.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_summary_text.done`. Möjliga värden: `response.reasoning_summary_text.done`	Ja

OpenAI.ResponseReasoningTextDeltaEvent

Genereras när ett delta läggs till i en resonemangstext.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
delta	string	Textdeltat som lades till i resonemangsinnehållet.	Ja
item_id	string	ID:t för objektet som det här textdeltat är associerat med.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.reasoning_text.delta`. Möjliga värden: `response.reasoning_text.delta`	Ja

OpenAI.ResponseReasoningTextDoneEvent

Genereras när en resonemangstext har slutförts.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
item_id	string	ID:t för objektet som den här resonemangstexten är associerad med.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
text	string	Den fullständiga texten i det slutförda resonemangsinnehållet.	Ja
type	enum	Typen av händelse. Alltid `response.reasoning_text.done`. Möjliga värden: `response.reasoning_text.done`	Ja

OpenAI.ResponseRefusalDeltaEvent

Genereras när det finns en partiell avslagstext.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
delta	string	Avslagstexten som läggs till.	Ja
item_id	string	ID för det utdataobjekt som avslagstexten läggs till i.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.refusal.delta`. Möjliga värden: `response.refusal.delta`	Ja

OpenAI.ResponseRefusalDoneEvent

Genereras när avslagstexten har slutförts.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
item_id	string	ID för det utdataobjekt där avslagstexten slutförs.	Ja
output_index	OpenAI.integer		Ja
vägran	string	Avslagstexten som har slutförts.	Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.refusal.done`. Möjliga värden: `response.refusal.done`	Ja

OpenAI.ResponseStreamOptions

Alternativ för direktuppspelningssvar. Ange endast detta när du anger stream: true.

Name	Type	Description	Obligatoriskt	Standardinställning
include_obfuscation	boolean	När det är sant aktiveras fördunkling av dataströmmar. Dataströmfördunkling lägger till slumpmässiga tecken till ett `obfuscation` fält vid strömmande deltahändelser till normalisera nyttolaststorlekar som en åtgärd för vissa sidokanalattacker. Dessa fördunklingsfält ingår som standard, men lägger till en liten mängd omkostnader för dataströmmen. Du kan ställa in `include_obfuscation` på false för att optimera bandbredden om du litar på nätverkslänkarna mellan ditt program och OpenAI-API:et.	No

OpenAI.ResponseTextDeltaEvent

Genereras när det finns ytterligare ett textdelta.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
delta	string	Textdeltat som lades till.	Ja
item_id	string	ID:t för utdataobjektet som textdeltat lades till i.	Ja
logprobs	matris med OpenAI.ResponseLogProb	Loggannolikheterna för token i deltat.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.output_text.delta`. Möjliga värden: `response.output_text.delta`	Ja

OpenAI.ResponseTextDoneEvent

Genereras när textinnehållet har slutförts.

Name	Type	Description	Obligatoriskt
content_index	OpenAI.integer		Ja
item_id	string	ID för utdataobjektet där textinnehållet har slutförts.	Ja
logprobs	matris med OpenAI.ResponseLogProb	Loggannolikheterna för token i deltat.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
text	string	Textinnehållet som har slutförts.	Ja
type	enum	Typen av händelse. Alltid `response.output_text.done`. Möjliga värden: `response.output_text.done`	Ja

OpenAI.ResponseTextParam

Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer:

Name	Type	Description	Obligatoriskt	Standardinställning
format	OpenAI.TextResponseFormatConfiguration	Ett objekt som anger det format som modellen måste mata ut. Konfigurera `{ "type": "json_schema" }` möjliggör strukturerade utdata, som säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i Standardformatet är `{ "type": "text" }` utan ytterligare alternativ. Rekommenderas inte för gpt-4o och nyare modeller:* Inställning som gör att `{ "type": "json_object" }` aktiverar det äldre JSON-läget, vilket ser till att meddelandet som modellen genererar är giltigt JSON. Att använda `json_schema` är att föredra för modeller som stöder det.	No
Informationsnivån	OpenAI.Verbosity	Begränsar utförligheten i modellens svar. Lägre värden resulterar i mer koncisa svar, medan högre värden resulterar i mer utförliga svar. Värden som stöds för närvarande är `low`, `medium`och `high`.	No

OpenAI.ResponseUsage

Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.

Name	Type	Obligatoriskt
input_tokens	OpenAI.integer	Ja
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Ja
└– cached_tokens	OpenAI.integer	Ja
output_tokens	OpenAI.integer	Ja
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Ja
└– reasoning_tokens	OpenAI.integer	Ja
total_tokens	OpenAI.integer	Ja

OpenAI.ResponseUsageInputTokensDetails

Name	Type	Description	Obligatoriskt	Standardinställning
cached_tokens	OpenAI.integer		Ja

OpenAI.ResponseUsageOutputTokensDetails

Name	Type	Description	Obligatoriskt	Standardinställning
reasoning_tokens	OpenAI.integer		Ja

OpenAI.ResponseWebSearchCallCompletedEvent

Genereras när ett webbsökningsanrop har slutförts.

Name	Type	Description	Obligatoriskt
item_id	string	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.web_search_call.completed`. Möjliga värden: `response.web_search_call.completed`	Ja

OpenAI.ResponseWebSearchCallInProgressEvent

Genereras när ett webbsökningsanrop initieras.

Name	Type	Description	Obligatoriskt
item_id	string	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.web_search_call.in_progress`. Möjliga värden: `response.web_search_call.in_progress`	Ja

OpenAI.ResponseWebSearchCallSearchingEvent

Genereras när ett webbsökningsanrop körs.

Name	Type	Description	Obligatoriskt
item_id	string	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
type	enum	Typen av händelse. Alltid `response.web_search_call.searching`. Möjliga värden: `response.web_search_call.searching`	Ja

OpenAI.Screenshot

En skärmbildsåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Anger händelsetypen. För en skärmdumpåtgärd är den här egenskapen alltid inställd på `screenshot`. Möjliga värden: `screenshot`	Ja

OpenAI.Scroll

En scrollningsåtgärd.

Name	Type	Description	Obligatoriskt
scroll_x	OpenAI.integer		Ja
scroll_y	OpenAI.integer		Ja
type	enum	Anger händelsetypen. För en rullningsåtgärd är denna egenskap alltid inställd på `scroll`. Möjliga värden: `scroll`	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.SearchContextSize

Property	Value
Type	string
Värden	`low` `medium` `high`

OpenAI.ServiceTier

Anger den bearbetningstyp som används för att hantera begäran.

Om den är inställd på "auto" bearbetas begäran med den tjänstnivå som konfigurerats i inställningarna för Project. Om inget annat har konfigurerats använder Project "standard".
Om den är inställd på "standard" bearbetas begäran med standardpriser och prestanda för den valda modellen.
Om den är inställd på "flex" eller "prioritet" bearbetas begäran med motsvarande tjänstnivå.
När den inte har angetts är standardbeteendet "automatiskt". När parametern service_tier har angetts innehåller svarstexten service_tier värdet baserat på det bearbetningsläge som faktiskt används för att hantera begäran. Det här svarsvärdet kan skilja sig från värdet som anges i parametern.

Property	Value
Type	string
Nullbar	Ja
Värden	`auto` `default` `flex` `scale` `priority`

OpenAI.SpecificApplyPatchParam

Tvingar modellen att anropa verktyget apply_patch när ett verktygsanrop körs.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Verktyget som ska anropas. Alltid `apply_patch`. Möjliga värden: `apply_patch`	Ja

OpenAI.SpecificFunctionShellParam

Tvingar modellen att anropa shell-verktyget när ett verktygsanrop krävs.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Verktyget som ska anropas. Alltid `shell`. Möjliga värden: `shell`	Ja

OpenAI.Summary

En sammanfattningstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	En sammanfattning av resonemangets utdata från modellen hittills.	Ja
type	enum	Typ av objekt. Alltid `summary_text`. Möjliga värden: `summary_text`	Ja

OpenAI.SummaryTextContent

En sammanfattningstext från modellen.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	En sammanfattning av resonemangets utdata från modellen hittills.	Ja
type	enum	Typ av objekt. Alltid `summary_text`. Möjliga värden: `summary_text`	Ja

OpenAI.TextContent

Ett textinnehåll.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string		Ja
type	enum	Möjliga värden: `text`	Ja

OpenAI.TextResponseFormatConfiguration

Ett objekt som anger det format som modellen måste mata ut. Konfiguration { "type": "json_schema" } möjliggör strukturerade utdata, vilket säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i

Standardformatet är { "type": "text" } utan ytterligare alternativ. Rekommenderas inte för gpt-4o och nyare modeller:* Inställning för att aktivera det äldre JSON-läget, vilket säkerställer att { "type": "json_object" } meddelandet som modellen genererar är giltigt JSON. Att använda json_schema är att föredra för modeller som stöder det.

Diskriminerande för OpenAI.TextResponseFormatConfiguration

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

Typvärde	Schema
`json_schema`	OpenAI.TextResponseFormatJsonSchema
`text`	OpenAI.TextResponseFormatConfigurationResponseFormatText
`json_object`	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.TextResponseFormatConfigurationType		Ja

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `json_object`. Möjliga värden: `json_object`	Ja

OpenAI.TextResponseFormatConfigurationResponseFormatText

Standardformat för svar. Används för att generera textsvar.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Vilken typ av svarsformat som definieras. Alltid `text`. Möjliga värden: `text`	Ja

OpenAI.TextResponseFormatConfigurationType

Property	Value
Type	string
Värden	`text` `json_schema` `json_object`

OpenAI.TextResponseFormatJsonSchema

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar. Läs mer om strukturerade utdata.

Name	Type	Description	Obligatoriskt
beskrivning	string	En beskrivning av vad svarsformatet är till för, som används av modellen för att bestämma hur man ska svara enligt formatet.	No
name	string	Namnet på svarsformatet. Måste vara a-z, A-Z, 0-9 eller innehålla understreck och bindestreck, med en maximal längd på 64.	Ja
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.	Ja
Strikt	boolesk (nullbar)		No
type	enum	Vilken typ av svarsformat som definieras. Alltid `json_schema`. Möjliga värden: `json_schema`	Ja

OpenAI.Tool

Ett verktyg som kan användas för att generera ett svar.

Discriminator för OpenAI.Tool

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

Typvärde	Schema
`bing_grounding`	BingGroundingTool
`fabric_dataagent_preview`	MicrosoftFabricPreviewTool
`sharepoint_grounding_preview`	SharepointPreviewTool
`azure_ai_search`	AzureAISearchTool
`openapi`	OpenApiTool
`bing_custom_search_preview`	BingCustomSearchPreviewTool
`browser_automation_preview`	BrowserAutomationPreviewTool
`azure_function`	AzureFunctionTool
`capture_structured_outputs`	CaptureStructuredOutputsTool
`a2a_preview`	A2APreviewTool
`memory_search_preview`	MemorySearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search`	OpenAI.WebSearchTool
`mcp`	OpenAI.MCPTool
`image_generation`	OpenAI.ImageGenTool
`local_shell`	OpenAI.LocalShellToolParam
`shell`	OpenAI.FunctionShellToolParam
`custom`	OpenAI.CustomToolParam
`web_search_preview`	OpenAI.WebSearchPreviewTool
`apply_patch`	OpenAI.ApplyPatchToolParam

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ToolType		Ja

OpenAI.ToolChoiceAllowed

Begränsar de verktyg som är tillgängliga för modellen till en fördefinierad uppsättning.

Name	Type	Description	Obligatoriskt
mode	enum	Begränsar de verktyg som är tillgängliga för modellen till en fördefinierad uppsättning. `auto` låter modellen välja bland de tillåtna verktygen och generera en meddelande. `required` kräver att modellen anropar ett eller flera av de tillåtna verktygen. Möjliga värden: `auto`, `required`	Ja
tools	matris med objekt	En lista över verktygsdefinitioner som modellen ska tillåtas anropa. För API:et Svar kan listan med verktygsdefinitioner se ut så här: `json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>`	Ja
type	enum	Tillåten verktygskonfigurationstyp. Alltid `allowed_tools`. Möjliga värden: `allowed_tools`	Ja

OpenAI.ToolChoiceCodeInterpreter

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `code_interpreter`	Ja

OpenAI.ToolChoiceComputerUsePreview

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `computer_use_preview`	Ja

OpenAI.ToolChoiceCustom

Använd det här alternativet för att tvinga modellen att anropa ett specifikt anpassat verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
name	string	Namnet på det anpassade verktyg som ska anropas.	Ja
type	enum	För anpassade verktygsanrop är typen alltid `custom`. Möjliga värden: `custom`	Ja

OpenAI.ToolChoiceFileSearch

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `file_search`	Ja

OpenAI.ToolChoiceFunction

Använd det här alternativet för att tvinga modellen att anropa en specifik funktion.

Name	Type	Description	Obligatoriskt	Standardinställning
name	string	Namnet på funktionen som ska anropas.	Ja
type	enum	För funktionsanrop är typen alltid `function`. Möjliga värden: `function`	Ja

OpenAI.ToolChoiceImageGeneration

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `image_generation`	Ja

OpenAI.ToolChoiceMCP

Använd det här alternativet för att tvinga modellen att anropa ett specifikt verktyg på en fjärr-MCP-server.

Name	Type	Description	Obligatoriskt
name	sträng (nullbar)		No
serveretikett	string	Etiketten på DEN MCP-server som ska användas.	Ja
type	enum	För MCP-verktyg är typen alltid `mcp`. Möjliga värden: `mcp`	Ja

OpenAI.ToolChoiceOptions

Styr vilket (om något) verktyg som anropas av modellen. none innebär att modellen inte anropar något verktyg och i stället genererar ett meddelande. auto innebär att modellen kan välja mellan att generera ett meddelande eller anropa ett eller flera verktyg. required innebär att modellen måste anropa ett eller flera verktyg.

Property	Value
Type	string
Värden	`none` `auto` `required`

OpenAI.ToolChoiceParam

Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas när ett svar genereras. Se parametern tools för att se hur du anger vilka verktyg som modellen kan anropa.

Diskriminerande för OpenAI.ToolChoiceParam

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

Typvärde	Schema
`allowed_tools`	OpenAI.ToolChoiceAllowed
`function`	OpenAI.ToolChoiceFunction
`mcp`	OpenAI.ToolChoiceMCP
`custom`	OpenAI.ToolChoiceCustom
`apply_patch`	OpenAI.SpecificApplyPatchParam
`shell`	OpenAI.SpecificFunctionShellParam
`file_search`	OpenAI.ToolChoiceFileSearch
`web_search_preview`	OpenAI.ToolChoiceWebSearchPreview
`computer_use_preview`	OpenAI.ToolChoiceComputerUsePreview
`web_search_preview_2025_03_11`	OpenAI.ToolChoiceWebSearchPreview20250311
`image_generation`	OpenAI.ToolChoiceImageGeneration
`code_interpreter`	OpenAI.ToolChoiceCodeInterpreter

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenAI.ToolChoiceParamType		Ja

OpenAI.ToolChoiceParamType

Property	Value
Type	string
Värden	`allowed_tools` `function` `mcp` `custom` `apply_patch` `shell` `file_search` `web_search_preview` `computer_use_preview` `web_search_preview_2025_03_11` `image_generation` `code_interpreter`

OpenAI.ToolChoiceWebSearchPreview

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `web_search_preview`	Ja

OpenAI.ToolChoiceWebSearchPreview20250311

Anger att modellen ska använda ett inbyggt verktyg för att generera ett svar. Läs mer om inbyggda verktyg.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `web_search_preview_2025_03_11`	Ja

OpenAI.ToolType

Property Value

Type string

Värden function
file_search
computer_use_preview
web_search
mcp
code_interpreter
image_generation
local_shell
shell
custom
web_search_preview
apply_patch
a2a_preview
bing_custom_search_preview
browser_automation_preview
fabric_dataagent_preview
sharepoint_grounding_preview
memory_search_preview
azure_ai_search
azure_function
bing_grounding
capture_structured_outputs
openapi

OpenAI.ToolsArray

En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern tool_choice . Vi stöder följande kategorier av verktyg:

Inbyggda verktyg: Verktyg som tillhandahålls av OpenAI som utökar modellens funktioner, till exempel webbsökning eller filsökning. Läs mer om inbyggda verktyg.
MCP-verktyg: Integreringar med tredjepartssystem via anpassade MCP-servrar eller fördefinierade anslutningsappar som Google Drive och SharePoint. Läs mer om MCP-verktyg.
Funktionsanrop (anpassade verktyg): Funktioner som definieras av dig, vilket gör att modellen kan anropa din egen kod med starkt skrivna argument och utdata. Läs mer om funktionsanrop. Du kan också använda anpassade verktyg för att anropa din egen kod.

Matris för: OpenAI.Tool

OpenAI.TopLogProb

Den högsta logaritmiska sannolikheten för en token.

Name	Type	Obligatoriskt
bytes	matris med OpenAI.integer	Ja
logprob	OpenAI.numeric	Ja
token	string	Ja

OpenAI.Type

En åtgärd för att skriva in text.

Name	Type	Description	Obligatoriskt	Standardinställning
text	string	Texten som ska skrivas.	Ja
type	enum	Anger händelsetypen. För en åtgärdstyp är denna egenskap alltid inställd på `type`. Möjliga värden: `type`	Ja

OpenAI.UpdateConversationBody

Name	Type	Description	Obligatoriskt	Standardinställning
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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

OpenAI.UrlCitationBody

En källhänvisning för en webbresurs som används för att generera ett modellsvar.

Name	Type	Description	Obligatoriskt
end_index	OpenAI.integer		Ja
start_index	OpenAI.integer		Ja
title	string	Webbresursens rubrik.	Ja
type	enum	Typ av URL-källhänvisning. Alltid `url_citation`. Möjliga värden: `url_citation`	Ja
url	string	Url:en för webbresursen.	Ja

OpenAI.VectorStoreFileAttributes

Typ: objekt

OpenAI.Verbosity

Begränsar utförligheten i modellens svar. Lägre värden resulterar i mer koncisa svar, medan högre värden resulterar i mer utförliga svar. Värden som stöds för närvarande är low, mediumoch high.

Property	Value
Type	string
Nullbar	Ja
Värden	`low` `medium` `high`

OpenAI.Wait

En väntåtgärd.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Anger händelsetypen. Vid en väntåtgärd är denna egenskap alltid inställd på `wait`. Möjliga värden: `wait`	Ja

OpenAI.WebSearchActionFind

Åtgärdstyp "find": Söker efter ett mönster på en inläst sida.

Name	Type	Description	Obligatoriskt
pattern	string	Det mönster eller den text som ska sökas efter på sidan.	Ja
type	enum	Åtgärdstypen. Möjliga värden: `find_in_page`	Ja
url	string	Url:en för sidan sökte efter mönstret.	Ja

OpenAI.WebSearchActionOpenPage

Åtgärdstyp "open_page" – Öppnar en specifik URL från sökresultat.

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Åtgärdstypen. Möjliga värden: `open_page`	Ja
url	string	URL som öppnades av modellen.	Ja

OpenAI.WebSearchActionSearch

Åtgärdstyp "sök" – Utför en webbsökningsfråga.

Name	Type	Description	Obligatoriskt
queries	strängmatris	Sökfrågorna.	No
query	sträng (inaktuell)	[INAKTUELL] Sökfrågan.	Ja
Källor	matris med OpenAI.WebSearchActionSearchSources	Källorna som används i sökningen.	No
type	enum	Åtgärdstypen. Möjliga värden: `search`	Ja

OpenAI.WebSearchActionSearchSources

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Möjliga värden: `url`	Ja
url	string		Ja

OpenAI.WebSearchApproximateLocation

Användarens ungefärliga plats.

Name	Type	Description	Obligatoriskt
Staden	sträng (nullbar)		No
land	sträng (nullbar)		No
region	sträng (nullbar)		No
timezone	sträng (nullbar)		No
type	enum	Typ av platsnärmning. Alltid `approximate`. Möjliga värden: `approximate`	No

OpenAI.WebSearchPreviewTool

Detta verktyg söker på webben efter relevanta resultat att använda i ett svar. Läs mer om sökverktyget web.

Name	Type	Description	Obligatoriskt
sök_kontextstorlek	OpenAI.SearchContextSize		No
type	enum	Typen av webbsökningsverktyg. En av `web_search_preview` eller `web_search_preview_2025_03_11`. Möjliga värden: `web_search_preview`	Ja
användarplats	OpenAI.ApproximateLocation (nullbar)		No
└— stad	sträng (nullbar)		No
└– land	sträng (nullbar)		No
└– region	sträng (nullbar)		No
└– tidszon	sträng (nullbar)		No
└– typ	enum	Typ av platsnärmning. Alltid `approximate`. Möjliga värden: `approximate`	Ja

OpenAI.WebSearchTool

Sök på internet efter källor relaterade till prompten. Läs mer om sökverktyget web.

Name	Type	Description	Obligatoriskt
custom_search_configuration	WebSearchConfiguration	En webbsökningskonfiguration för bing anpassad sökning	No
└– instance_name	string	Namnet på den anpassade konfigurationsinstans som angetts för konfigurationen.	Ja
└– project_connection_id	string	Project anslutnings-ID för jordning med anpassad Bing-sökning	Ja
filters	OpenAI.WebSearchToolFilters (nullbar)		No
└– allowed_domains	matris med sträng (nullbar)		No
sök_kontextstorlek	enum	Vägledning på hög nivå för hur mycket utrymme i kontextfönstret som ska användas för sökningen. En av `low`, `medium`eller `high`. `medium` används som standard. Möjliga värden: `low`, `medium`, `high`	No
type	enum	Typen av webbsökningsverktyg. En av `web_search` eller `web_search_2025_08_26`. Möjliga värden: `web_search`	Ja
användarplats	OpenAI.WebSearchApproximateLocation (nullbar)	Användarens ungefärliga plats.	No
└— stad	sträng (nullbar)		No
└– land	sträng (nullbar)		No
└– region	sträng (nullbar)		No
└– tidszon	sträng (nullbar)		No
└– typ	enum	Typ av platsnärmning. Alltid `approximate`. Möjliga värden: `approximate`	No

OpenAI.WebSearchToolFilters

Name	Type	Description	Obligatoriskt	Standardinställning
allowed_domains	strängmatris		No

OpenAI.integer

Typ: heltal

Format: int64

OpenAI.numeric

Typ: tal

Format: dubbel

OpenApiAnonymousAuthDetails

Säkerhetsinformation för anonym OpenApi-autentisering

Name	Type	Description	Obligatoriskt	Standardinställning
type	enum	Objekttypen, som alltid är "anonym". Möjliga värden: `anonymous`	Ja

OpenApiAuthDetails

autentiseringsinformation för OpenApiFunctionDefinition

Diskriminerande för OpenApiAuthDetails

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

Typvärde	Schema
`anonymous`	OpenApiAnonymousAuthDetails
`project_connection`	OpenApiProjectConnectionAuthDetails
`managed_identity`	OpenApiManagedAuthDetails

Name	Type	Description	Obligatoriskt	Standardinställning
type	OpenApiAuthType	Autentiseringstyp för OpenApi-slutpunkt. Tillåtna typer är: – Anonym (ingen autentisering krävs) – Project anslutning (kräver project_connection_id till slutpunkten, som installation i AI Foundry) – Managed_Identity (kräver målgrupp för identitetsbaserad autentisering)	Ja

OpenApiAuthType

Autentiseringstyp för OpenApi-slutpunkt. Tillåtna typer är:

Anonym (ingen autentisering krävs)
Project Anslutning (kräver project_connection_id till slutpunkten, som konfigurerat i AI Foundry)
Managed_Identity (kräver målgrupp för identitetsbaserad autentisering)

Property	Value
Beskrivning	Autentiseringstyp för OpenApi-slutpunkt. Tillåtna typer är: – Anonym (ingen autentisering krävs) – Project anslutning (kräver project_connection_id till slutpunkten, som installation i AI Foundry) – Managed_Identity (kräver målgrupp för identitetsbaserad autentisering)
Type	string
Värden	`anonymous` `project_connection` `managed_identity`

OpenApiFunctionDefinition

Information om indatadefinition för en openapi-funktion.

Name	Type	Description	Obligatoriskt
auth	OpenApiAuthDetails	autentiseringsinformation för OpenApiFunctionDefinition	Ja
└– typ	OpenApiAuthType	Typen av autentisering måste vara anonym/project_connection/managed_identity	Ja
default_params	strängmatris	Lista över OpenAPI-specifikationsparametrar som använder standardvärden som tillhandahålls av användaren	No
beskrivning	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
functions	matris med objekt	Lista över funktionsdefinitioner som används av OpenApi-verktyget	No
name	string	Namnet på den funktion som ska anropas.	Ja
spec	object	Funktionsformen openapi, som beskrivs som ett JSON-schemaobjekt.	Ja

OpenApiManagedAuthDetails

Säkerhetsinformation för OpenApi managed_identity-autentisering

Name	Type	Description	Obligatoriskt
security_scheme	OpenApiManagedSecurityScheme	Säkerhetsschema för OpenApi managed_identity-autentisering	Ja
└— målgrupp	string	Autentiseringsomfång för managed_identity autentiseringstyp	Ja
type	enum	Objekttypen, som alltid är "managed_identity". Möjliga värden: `managed_identity`	Ja

OpenApiManagedSecurityScheme

Säkerhetsschema för OpenApi managed_identity-autentisering

Name	Type	Description	Obligatoriskt	Standardinställning
audience	string	Autentiseringsomfång för managed_identity autentiseringstyp	Ja

OpenApiProjectConnectionAuthDetails

Säkerhetsinformation för OpenApi-project anslutningsautentisering

Name	Type	Description	Obligatoriskt
security_scheme	OpenApiProjectConnectionSecurityScheme	Säkerhetsschema för OpenApi managed_identity-autentisering	Ja
└– project_connection_id	string	Project anslutnings-ID för Project anslutningsautentiseringstyp	Ja
type	enum	Objekttypen, som alltid är "project_connection". Möjliga värden: `project_connection`	Ja

OpenApiProjectConnectionSecurityScheme

Säkerhetsschema för OpenApi managed_identity-autentisering

Name	Type	Description	Obligatoriskt	Standardinställning
project_connection_id	string	Project anslutnings-ID för Project anslutningsautentiseringstyp	Ja

OpenApiTool

Information om indatadefinition för ett OpenAPI-verktyg som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
openapi	OpenApiFunctionDefinition	Information om indatadefinition för en openapi-funktion.	Ja
└– autentisering	OpenApiAuthDetails	Öppna API-autentiseringsinformation	Ja
└– default_params	strängmatris	Lista över OpenAPI-specifikationsparametrar som använder standardvärden som tillhandahålls av användaren	No
└— beskrivning	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
└– funktioner	matris med objekt (skrivskyddad)	Lista över funktionsdefinitioner som används av OpenApi-verktyget	No
└— beskrivning	string	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	No
└— namn	string	Namnet på den funktion som ska anropas.	Ja
└— parametrar	object	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt.	Ja
└— namn	string	Namnet på den funktion som ska anropas.	Ja
└– specifikation	object	Funktionsformen openapi, som beskrivs som ett JSON-schemaobjekt.	Ja
type	enum	Objekttypen, som alltid är "openapi". Möjliga värden: `openapi`	Ja

Sidordning

Property	Value
Type	string
Värden	`asc` `desc`

PagedConnection

Sidsidig samling med anslutningsobjekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med anslutning	Anslutningsobjekten på den här sidan	Ja

PagedDatasetVersion

Sidinsamling av DatasetVersion-objekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med DatasetVersion	DatasetVersion-objekten på den här sidan	Ja

PagedDeployment

Sidsidig samling med distributionsobjekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med distribution	Distributionsobjekten på den här sidan	Ja

PagedEvaluationRule

Sidsidig samling med EvaluationRule-objekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med EvaluationRule	EvaluationRule-objekten på den här sidan	Ja

PagedEvaluationTaxonomy

Sidsidig samling av EvaluationTaxonomy-objekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med EvaluationTaxonomy	EvaluationTaxonomy-objekten på den här sidan	Ja

PagedEvaluatorVersion

Paged-samling med EvaluatorVersion-objekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris för EvaluatorVersion	EvaluatorVersion-objekten på den här sidan	Ja

PagedIndex

Sidsidig samling indexobjekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med index	Indexobjekten på den här sidan	Ja

PagedInsight

Sidsidig samling med Insight-objekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med Insight	Insight-objekten på den här sidan	Ja

PagedRedTeam

Sidsidig samling med RedTeam-objekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med RedTeam	RedTeam-objekten på den här sidan	Ja

PagedSchedule

Sidsidig samling med schemaobjekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med schema	Schemalägg objekt på den här sidan	Ja

PagedScheduleRun

Sidsidig samling med ScheduleRun-objekt

Name	Type	Description	Obligatoriskt	Standardinställning
nextLink	string	Länken till nästa sida med objekt	No
value	matris med ScheduleRun	ScheduleRun-objekten på den här sidan	Ja

PendingUploadRequest

Representerar en begäran om en väntande uppladdning.

Name	Type	Description	Obligatoriskt
connectionName	string	Anslutningsnamn för Azure Storage-konto som ska användas för att generera tillfällig SAS-token	No
pendingUploadId	string	Om PendingUploadId inte anges används ett slumpmässigt GUID.	No
pendingUploadType	enum	BlobReference är den enda typ som stöds. Möjliga värden: `BlobReference`	Ja

PendingUploadResponse

Representerar svaret på en väntande uppladdningsbegäran

Name	Type	Description	Obligatoriskt
blobReference	BlobReference	Information om blobreferens.	Ja
└– blobUri	string	Blob-URI-sökväg för klienten för att ladda upp data. Exempel: `https://blob.windows.core.net/Container/Path`	Ja
└– autentiseringsuppgifter	SasCredential	Information om autentiseringsuppgifter för åtkomst till lagringskontot.	Ja
└– storageAccountArmId	string	ARM-ID för lagringskontot som ska användas.	Ja
pendingUploadId	string	ID för den här uppladdningsbegäran.	Ja
pendingUploadType	enum	BlobReference är den enda typ som stöds Möjliga värden: `BlobReference`	Ja
version	string	Version av resursen som ska skapas om användaren inte angav version när överföringen skapades från början	No

PromptAgentDefinition

Definitionen av promptagenten

Name	Type	Description	Obligatoriskt	Standardinställning
instructions	sträng (nullbar)	Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.	No
Typ	enum	Möjliga värden: `prompt`	Ja
model	string	Modelldistributionen som ska användas för den här agenten.	Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
└– rai_policy_name	string	Namnet på DEN RAI-princip som ska tillämpas.	Ja
reasoning	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	No
└— insats	OpenAI.ReasoningEffort	Begränsar insatsen på arbetet med resonemang för resonemangsmodeller. Värden som stöds för närvarande är `none`, `minimal`, `low`, `medium`, `high`och `xhigh`. Minska Ansträngning i resonemang kan leda till snabbare svar och färre token som används om resonemang i ett svar. - `gpt-5.1` standardvärdet är `none`, som inte utför resonemang. De resonemangsvärden som stöds för `gpt-5.1` är `none`, `low`, `medium`och `high`. Verktygsanrop stöds för alla resonemangsvärden i gpt-5.1. – Alla modeller före `gpt-5.1` standardinställningen för `medium` resonemang och stöder `none`inte . – Modellen `gpt-5-pro` har som standard (och stöder endast) `high` resonemang. - `xhigh` stöds för alla modeller efter `gpt-5.1-codex-max`.	No
└– generate_summary	enum	Möjliga värden: `auto`, `concise`, `detailed`	No
└— sammanfattning	enum	Möjliga värden: `auto`, `concise`, `detailed`	No
structured_inputs	object	En uppsättning strukturerade indata som kan delta i bindningar av promptmallsersättning eller verktygsargument.	No
Temperatur	number	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.	No	1
text	PromptAgentDefinitionTextOptions	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data.	No
└– format	OpenAI.TextResponseFormatConfiguration	Ett objekt som anger det format som modellen måste mata ut. Konfigurera `{ "type": "json_schema" }` möjliggör strukturerade utdata, som säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i Standardformatet är `{ "type": "text" }` utan ytterligare alternativ. Rekommenderas inte för gpt-4o och nyare modeller:* Inställning som gör att `{ "type": "json_object" }` aktiverar det äldre JSON-läget, vilket ser till att meddelandet som modellen genererar är giltigt JSON. Att använda `json_schema` är att föredra för modeller som stöder det.	No
tool_choice	string eller OpenAI.ToolChoiceParam	Hur modellen ska välja vilket verktyg (eller verktyg) som ska användas när ett svar genereras. Se parametern `tools` för att se hur du anger vilka verktyg som modellen kan anropa.	No
tools	matris med OpenAI.Tool	En matris med verktyg som modellen kan anropa när ett svar genereras. Du kan ange vilket verktyg som ska användas genom att ange parametern `tool_choice` .	No
top_p	number	Ett alternativ till provtagning med temperatur, som kallas kärnsampling, där modellen tar hänsyn till resultatet av token med top_p sannolikhet massa. Så 0,1 innebär endast de token som omfattar de 10 främsta i%:s sannolikhetsmassa. övervägs. Vi rekommenderar vanligtvis att du ändrar detta eller `temperature` men inte båda.	No	1

PromptAgentDefinitionTextOptions

Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data.

Name	Type	Description	Obligatoriskt	Standardinställning
format	OpenAI.TextResponseFormatConfiguration	Ett objekt som anger det format som modellen måste mata ut. Konfigurera `{ "type": "json_schema" }` möjliggör strukturerade utdata, som säkerställer att modellen matchar ditt angivna JSON-schema. Läs mer i Standardformatet är `{ "type": "text" }` utan ytterligare alternativ. Rekommenderas inte för gpt-4o och nyare modeller:* Inställning som gör att `{ "type": "json_object" }` aktiverar det äldre JSON-läget, vilket ser till att meddelandet som modellen genererar är giltigt JSON. Att använda `json_schema` är att föredra för modeller som stöder det.	No

PromptBasedEvaluatorDefinition

Promptbaserad utvärderare

Name	Type	Description	Obligatoriskt
data_schema	object	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
init_parameters	object	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	No
metrics	object	Förteckning över utfallsmått som tagits fram av den här utvärderaren	No
prompt_text	string	Prompttexten som används för utvärdering	Ja
type	enum	Möjliga värden: `prompt`	Ja

ProtocolVersionRecord

En postmappning för ett enskilt protokoll och dess version.

Name	Type	Description	Obligatoriskt	Standardinställning
protocol	AgentProtocol		Ja
version	string	Versionssträngen för protokollet, t.ex. "v0.1.1".	Ja

RaiConfig

Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).

Name	Type	Description	Obligatoriskt	Standardinställning
rai_policy_name	string	Namnet på DEN RAI-princip som ska tillämpas.	Ja

RecurrenceSchedule

Modell för upprepningsschema.

Diskriminerande för RecurrenceSchedule

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

Typvärde	Schema
`Hourly`	HourlyRecurrenceSchedule
`Daily`	DailyRecurrenceSchedule
`Weekly`	WeeklyRecurrenceSchedule
`Monthly`	MonthlyRecurrenceSchedule

Name	Type	Description	Obligatoriskt	Standardinställning
type	RecurrenceType	Typ av upprepning.	Ja

RecurrenceTrigger

Upprepningsbaserad utlösare.

Name	Type	Description	Obligatoriskt	Standardinställning
endTime	string	Sluttid för upprepningsschemat i ISO 8601-format.	No
interval	integer	Intervall för upprepningsschemat.	Ja
schedule	RecurrenceSchedule	Modell för upprepningsschema.	Ja
└– typ	RecurrenceType	Upprepningstyp för upprepningsschemat.	Ja
startTime	string	Starttid för upprepningsschemat i ISO 8601-format.	No
timeZone	string	Tidszon för upprepningsschemat.	No	UTC
type	enum	Typ av utlösare. Möjliga värden: `Recurrence`	Ja

RecurrenceType

Typ av upprepning.

Property	Value
Beskrivning	Typ av upprepning.
Type	string
Värden	`Hourly` `Daily` `Weekly` `Monthly`

RedTeam

Detaljer om det röda laget.

Name	Type	Description	Obligatoriskt	Standardinställning
applicationScenario	string	Programscenario för den röda teamåtgärden för att generera scenariospecifika attacker.	No
attackStrategies	matris med AttackStrategy	Lista över attackstrategier eller kapslade listor över attackstrategier.	No
displayName	string	Namnet på red-team-körningen.	No
id	sträng (skrivskyddad)	Identifierare för den röda teamkörningen.	Ja
numTurns	integer	Antal simuleringsrundor.	No
properties	object	Red-teamets egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	No
riskCategories	matris med RiskCategory	Lista över riskkategorier som ska generera attackmål för.	No
simulationOnly	boolean	Endast simulering eller simulering + utvärdering. Standard falskt, om sant genomsökningen utdata konversationen inte utvärderingsresultat.	No	Falsk
status	sträng (skrivskyddad)	Status för det röda teamet. Den anges efter tjänst och är skrivskyddad.	No
tags	object	Röda teamets taggar. Till skillnad från egenskaper är taggar helt föränderliga.	No
target	TargetConfig	Abstrakt klass för målkonfiguration.	Ja
└– typ	string	Typ av modellkonfiguration.	Ja

RedTeamEvalRunDataSource

Name	Type	Description	Obligatoriskt
item_generation_params	ItemGenerationParams	Representerar den uppsättning parametrar som används för att styra objektgenereringsåtgärder.	Ja
└– typ	ItemGenerationParamsType	Vilken typ av objektgenereringsparametrar som ska användas.	Ja
target	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	string	Typ av mål.	Ja
type	enum	Typen av datakälla. Alltid `azure_ai_red_team`. Möjliga värden: `azure_ai_red_team`	Ja

RedTeamItemGenerationParams

Name	Type	Description	Obligatoriskt	Standardinställning
attack_strategies	matris med AttackStrategy	Insamling av angreppsstrategier som ska användas.	Ja
num_turns	integer	Antalet svängar som tillåts i spelet.	Ja	20
type	enum	Typ av objektgenereringsparametrar. Möjliga värden: `red_team`	Ja

RedTeamSeedPromptsItemGenerationParams

Representerar parametrarna för red team seed prompts item generation.

Name	Type	Description	Obligatoriskt	Standardinställning
attack_strategies	matris med AttackStrategy	Insamling av angreppsstrategier som ska användas.	Ja
num_turns	integer	Antalet svängar som tillåts i spelet.	Ja	20
source	OpenAI.EvalJsonlFileContentSource		Ja
└– innehåll	matris med OpenAI.EvalJsonlFileContentSourceContent	Innehållet i jsonl-filen.	Ja
└– typ	enum	Typen av jsonl-källa. Alltid `file_content`. Möjliga värden: `file_content`	Ja
type	enum	Typ av objektgenereringsparametrar, alltid `red_team_seed_prompts`. Möjliga värden: `red_team_seed_prompts`	Ja

RedTeamTaxonomyItemGenerationParams

Representerar parametrarna för generering av red teamtaxonomiobjekt.

Name	Type	Description	Obligatoriskt	Standardinställning
attack_strategies	matris med AttackStrategy	Insamling av angreppsstrategier som ska användas.	Ja
num_turns	integer	Antalet svängar som tillåts i spelet.	Ja	20
source	OpenAI.EvalJsonlFileContentSource		Ja
└– innehåll	matris med OpenAI.EvalJsonlFileContentSourceContent	Innehållet i jsonl-filen.	Ja
└– typ	enum	Typen av jsonl-källa. Alltid `file_content`. Möjliga värden: `file_content`	Ja
type	enum	Typ av objektgenereringsparametrar, alltid `red_team_taxonomy`. Möjliga värden: `red_team_taxonomy`	Ja

ResponseRetrievalItemGenerationParams

Representerar parametrarna för generering av svarshämtningsobjekt.

Name	Type	Description	Obligatoriskt
data_mapping	object	Mappning från källfält till response_id fält som krävs för att hämta chatthistorik.	Ja
max_num_turns	integer	Det maximala antalet chatthistoriker som ska utvärderas.	Ja
source	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource	Källan som JSONL-innehåll läss från.	Ja
type	enum	Typ av objektgenereringsparametrar, alltid `response_retrieval`. Möjliga värden: `response_retrieval`	Ja

RiskKategori

Riskkategori för attackmålet.

Property	Value
Beskrivning	Riskkategori för attackmålet.
Type	string
Värden	`HateUnfairness` `Violence` `Sexual` `SelfHarm` `ProtectedMaterial` `CodeVulnerability` `UngroundedAttributes` `ProhibitedActions` `SensitiveDataLeakage` `TaskAdherence`

SASCredentials

Definition av autentiseringsuppgifter för signatur för delad åtkomst (SAS)

Name	Type	Description	Obligatoriskt	Standardinställning
SAS	sträng (skrivskyddad)	SAS-token	No
type	enum	Typ av autentiseringsuppgifter Möjliga värden: `SAS`	Ja

SampleType

Vilken typ av prov som används i analysen.

Property	Value
Beskrivning	Vilken typ av prov som används i analysen.
Type	string
Värden	`EvaluationResultSample`

SasCredential

Definition av SAS-autentiseringsuppgifter

Name	Type	Description	Obligatoriskt	Standardinställning
sasUri	sträng (skrivskyddad)	SAS-URI	Ja
type	enum	Typ av autentiseringsuppgifter Möjliga värden: `SAS`	Ja

Schemaläggning

Schemalägg modell.

Name	Type	Description	Obligatoriskt
beskrivning	string	Beskrivning av schemat.	No
displayName	string	Namnet på schemat.	No
enabled	boolean	Aktiverat status för schemat.	Ja
id	sträng (skrivskyddad)	Identifierare för schemat.	Ja
properties	object	Schemans egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	No
Provisioneringsstatus	ScheduleProvisioningStatus (skrivskyddad)	Status för schemaläggning av etablering.	No
systemData	objekt (skrivskyddat)	Systemmetadata för resursen.	Ja
tags	object	Schemataggar. Till skillnad från egenskaper är taggar helt föränderliga.	No
uppgift	ScheduleTask	Schemalägg uppgiftsmodell.	Ja
└– konfiguration	object	Konfiguration för uppgiften.	No
└– typ	ScheduleTaskType	Typ av uppgift.	Ja
trigger	Trigger	Basmodell för utlösare av schemat.	Ja
└– typ	TriggerType	Typ av utlösare.	Ja

ScheduleProvisioningStatus

Status för schemaläggning av etablering.

Property	Value
Beskrivning	Status för schemaläggning av etablering.
Type	string
Värden	`Creating` `Updating` `Deleting` `Succeeded` `Failed`

ScheduleRun

Schemalägg körningsmodell.

Name	Type	Description	Obligatoriskt
fel	sträng (skrivskyddad)	Felinformation för schemakörningen.	No
id	sträng (skrivskyddad)	Identifierare för schemakörningen.	Ja
properties	objekt (skrivskyddat)	Egenskaper för schemakörningen.	Ja
scheduleId	string	Identifierare för schemat.	Ja
framgång	booleskt värde (skrivskyddat)	Status för lyckad körning av schemat utlöses.	Ja
triggerTime	string	Utlösartid för schemakörningen.	No

ScheduleTask

Schemalägg uppgiftsmodell.

Diskriminerande för ScheduleTask

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

Typvärde	Schema
`Evaluation`	EvaluationScheduleTask
`Insight`	InsightScheduleTask

Name	Type	Description	Obligatoriskt	Standardinställning
configuration	object	Konfiguration för uppgiften.	No
type	ScheduleTaskType	Typ av uppgift.	Ja

ScheduleTaskType

Typ av uppgift.

Property	Value
Beskrivning	Typ av uppgift.
Type	string
Värden	`Evaluation` `Insight`

SharepointGroundingToolParameters

Parametrarna för sharepoint-jordningsverktyget.

Name	Type	Description	Obligatoriskt	Standardinställning
project_connections	matris med ToolProjectConnection	De project anslutningar som är anslutna till det här verktyget. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget.	No

SharepointPreviewTool

Information om indatadefinition för ett sharepoint-verktyg som används för att konfigurera en agent.

Name	Type	Description	Obligatoriskt
sharepoint_grounding_preview	SharepointGroundingToolParameters	Parametrarna för sharepoint-jordningsverktyget.	Ja
└– project_connections	matris med ToolProjectConnection	De project anslutningar som är anslutna till det här verktyget. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget. Begränsningar: maxItems: 1	No
type	enum	Objekttypen, som alltid är 'sharepoint_grounding_preview'. Möjliga värden: `sharepoint_grounding_preview`	Ja

Sku

SKU-information

Name	Type	Description	Obligatoriskt
capacity	integer	SKU-kapacitet	Ja
family	string	Sku-familj	Ja
name	string	SKU-namn	Ja
storlek	string	SKU-storlek	Ja
tier	string	SKU-nivå	Ja

StructuredInputDefinition

En strukturerad indata som kan delta i promptmallersättningar och verktygsargumentbindning.

Name	Type	Description	Obligatoriskt	Standardinställning
default_value		Standardvärdet för indata om inget körningsvärde anges.	No
beskrivning	string	En läsbar beskrivning av indata.	No
required	boolean	Om indataegenskapen krävs när agenten anropas.	No	Falsk
schema	object	JSON-schemat för strukturerade indata (valfritt).	No

StructuredOutputDefinition

Strukturerade utdata som kan skapas av agenten.

Name	Type	Description	Obligatoriskt
beskrivning	string	En beskrivning av de utdata som ska genereras. Används av modellen för att avgöra när utdata ska genereras.	Ja
name	string	Namnet på de strukturerade utdata.	Ja
schema	object	JSON-schemat för de strukturerade utdata.	Ja
Strikt	boolesk (nullbar)	Om du vill framtvinga strikt validering. Standard `true`.	Ja

StructuredOutputsOutputItem

Name	Type	Description	Obligatoriskt
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
output		De strukturerade utdata som samlas in under svaret.	Ja
response_id	string	Svaret som objektet skapas på.	No
type	enum	Möjliga värden: `structured_outputs`	Ja

SyntheticDataGenerationPreviewEvalRunDataSource

Representerar en datakälla för utvärderingskörningar som utvärderas baserat på genererade syntetiska data i testsyfte.

Name	Type	Description	Obligatoriskt
inmatningsmeddelanden	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		No
└– mall	matris med objekt eller OpenAI.EvalItem		Ja
└– typ	enum	Möjliga värden: `template`	Ja
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Ja
└– model_deployment_name	string	Namnet på modelldistributionen som ska användas för att generera syntetiska data.	Ja
└– output_dataset_id	sträng (skrivskyddad)	Identifieraren för utdatauppsättningen där genererade syntetiska data lagras. De genererade data är en jsonl-fil med kolumn-ID, fråga och test_description.	No
└– output_dataset_name	string	Namnet på den utdatauppsättning där genererade syntetiska data lagras. Om det inte tillhandahålls genererar tjänsten datauppsättningsnamnet automatiskt.	No
└─ uppmaning	string	Uppmaningen som används för att generera syntetiska data. Det här är ett alternativ om målet är av typen "azure_ai_agent" med instruktioner som konfigurerats i agenten.	No
└– samples_count	integer	Det maximala antalet dataexempel som ska genereras.	Ja
└— källor	matris med OpenAI.EvalJsonlFileIdSource	Valfria källfiler för seed-datainnehåll för datagenerering.	Ja
└– typ	enum	Typ av objektgenereringsparametrar. Möjliga värden: `synthetic_data_gen_preview`	Ja
target	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	string	Typ av mål.	Ja
type	enum	Typen av datakälla, alltid `azure_ai_synthetic_data_gen_preview`. Möjliga värden: `azure_ai_synthetic_data_gen_preview`	Ja

SyntheticDataGenerationPreviewItemGenerationParams

Name	Type	Description	Obligatoriskt
modellutplaceringsnamn	string	Namnet på modelldistributionen som ska användas för att generera syntetiska data.	Ja
output_dataset_id	sträng (skrivskyddad)	Identifieraren för utdatauppsättningen där genererade syntetiska data lagras. De genererade data är en jsonl-fil med kolumn-ID, fråga och test_description.	No
output_dataset_name	string	Namnet på den utdatauppsättning där genererade syntetiska data lagras. Om det inte tillhandahålls genererar tjänsten datauppsättningsnamnet automatiskt.	No
prompt	string	Uppmaningen som används för att generera syntetiska data. Det här är ett alternativ om målet är av typen "azure_ai_agent" med instruktioner som konfigurerats i agenten.	No
samples_count	integer	Det maximala antalet dataexempel som ska genereras.	Ja
Källor	matris med OpenAI.EvalJsonlFileIdSource	Valfria källfiler för seed-datainnehåll för datagenerering.	Ja
type	enum	Typ av objektgenereringsparametrar. Möjliga värden: `synthetic_data_gen_preview`	Ja

Target

Basklass för mål med stöd för diskriminator.

Diskriminerande för mål

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

Typvärde	Schema
`azure_ai_model`	AzureAIModelTarget
`azure_ai_agent`	AzureAIAgentTarget

Name	Type	Description	Obligatoriskt	Standardinställning
type	string	Typ av mål.	Ja

TargetCompletionEvalRunDataSource

Representerar en datakälla för målbaserad slutförandeutvärderingskonfiguration.

Name	Type	Description	Obligatoriskt
inmatningsmeddelanden	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		No
└– item_reference	string		Ja
└– typ	enum	Möjliga värden: `item_reference`	Ja
source	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource	Källkonfigurationen för infogade data eller fildata.	Ja
target	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	string	Typ av mål.	Ja
type	enum	Typen av datakälla, alltid `azure_ai_target_completions`. Möjliga värden: `azure_ai_target_completions`	Ja

TargetConfig

Abstrakt klass för målkonfiguration.

Diskriminerande för TargetConfig

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

Typvärde	Schema
`AzureOpenAIModel`	AzureOpenAIModelConfiguration

Name	Type	Description	Obligatoriskt	Standardinställning
type	string	Typ av modellkonfiguration.	Ja

TargetUpdate

Basklass för mål med stöd för diskriminator.

Diskriminerande för TargetUpdate

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

Typvärde	Schema
`azure_ai_model`	AzureAIModelTargetUpdate
`azure_ai_agent`	AzureAIAgentTargetUpdate

Name	Type	Description	Obligatoriskt	Standardinställning
type	string	Typ av mål.	Ja

TaxonomyCategory

Definition av taxonomikategori.

Name	Type	Description	Obligatoriskt
beskrivning	string	Beskrivning av taxonomikategorin.	No
id	string	Unik identifierare för taxonomikategorin.	Ja
name	string	Namnet på taxonomikategorin.	Ja
properties	object	Ytterligare egenskaper för taxonomikategorin.	No
riskCategory	RiskKategori	Riskkategori för attackmålet.	Ja
Underkategorier	matris med TaxonomySubCategory	Lista över taxonomiunderkategorier.	Ja

TaxonomySubCategory

Definition av underkategori taxonomi.

Name	Type	Description	Obligatoriskt
beskrivning	string	Beskrivning av underkategorin taxonomi.	No
enabled	boolean	Lista över taxonomiobjekt under den här underkategorin.	Ja
id	string	Unik identifierare för underkategorin taxonomi.	Ja
name	string	Namnet på underkategorin taxonomi.	Ja
properties	object	Ytterligare egenskaper för underkategorin taxonomi.	No

ToolDescription

Beskrivning av ett verktyg som kan användas av en agent.

Name	Type	Description	Obligatoriskt	Standardinställning
beskrivning	string	En kort beskrivning av verktygets syfte.	No
name	string	Namnet på verktyget.	No

ToolProjectConnection

En project anslutningsresurs.

Name	Type	Description	Obligatoriskt	Standardinställning
project_connection_id	string	En projektanslutning i en ToolProjectConnectionList som är kopplad till det här verktyget.	Ja

TracesPreviewEvalRunDataSource

Representerar en datakälla för utvärderingskörningar som körs via agentspårningar som lagras i Application Insights.

Name	Type	Description	Obligatoriskt	Standardinställning
agent_id	string	Agent-ID:t som används för att filtrera spårningar för utvärdering.	No
agent_name	string	Agentnamnet som används för att filtrera spårningar för utvärdering.	No
end_time	integer	Unix-tidsstämpel (i sekunder) som markerar slutet av spårningsfrågefönstret. Standardvärdet är den aktuella tiden.	No
ingestion_delay_seconds	integer	Fördröjningen för att ansöka om inmatning när du kör frågor mot spårningar.	No	300
lookback_hours	integer	Lookback-fönstret (i timmar) som används när spårningar hämtas från Application Insights. För schemalagda utvärderingar härleds detta från upprepningsintervallet.	No	168
max_traces	integer	Samplingsgräns som tillämpas på spårningar som hämtats för utvärdering.	No	1000
trace_ids	strängmatris	Insamling av agentspårningsidentifierare som ska utvärderas.	No
type	enum	Typen av datakälla, alltid `azure_ai_traces_preview`. Möjliga värden: `azure_ai_traces_preview`	Ja

TreatmentEffectType

Typ av behandlingseffekt.

Property	Value
Beskrivning	Typ av behandlingseffekt.
Type	string
Värden	`TooFewSamples` `Inconclusive` `Changed` `Improved` `Degraded`

Trigger

Basmodell för utlösare av schemat.

Diskriminerande för utlösare

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

Typvärde	Schema
`Cron`	CronTrigger (på engelska)
`Recurrence`	RecurrenceTrigger (Utlösare för upprepning)
`OneTime`	OneTimeTrigger

Name	Type	Description	Obligatoriskt	Standardinställning
type	TriggerType	Typ av utlösare.	Ja

Utlösartyp

Typ av utlösare.

Property	Value
Beskrivning	Typ av utlösare.
Type	string
Värden	`Cron` `Recurrence` `OneTime`

UpdateAgentFromManifestRequest

Name	Type	Description	Obligatoriskt
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
manifest_id	string	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
parameter_values	object	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

UpdateAgentRequest

Name	Type	Description	Obligatoriskt
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
beskrivning	string	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	No
metadata	object	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No

UpdateEvalParametersBody

Name	Type	Description	Obligatoriskt
metadata	OpenAI.Metadata (nullbar)	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 en strukturerad form format och fråga efter objekt via API eller kontrollpanelen. 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.	No
name	string		No
properties	object	Uppsättning oföränderliga 16 nyckel/värde-par som kan kopplas till ett objekt för att lagra ytterligare information. 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.	No

UserProfileMemoryItem

Ett minnesobjekt som specifikt innehåller information om användarprofiler som extraherats från konversationer, till exempel preferenser, intressen och personliga uppgifter.

Name	Type	Description	Obligatoriskt
innehåll	string	Innehållet i minnet.	Ja
Typ	enum	Typ av minnesobjekt. Möjliga värden: `user_profile`	Ja
memory_id	string	Det unika ID:t för minnesobjektet.	Ja
scope	string	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja
updated_at	integer	Den senaste uppdateringstiden för minnesobjektet.	Ja

WebSearchConfiguration

En webbsökningskonfiguration för bing anpassad sökning

Name	Type	Description	Obligatoriskt	Standardinställning
instance_name	string	Namnet på den anpassade konfigurationsinstans som angetts för konfigurationen.	Ja
project_connection_id	string	Project anslutnings-ID för jordning med anpassad Bing-sökning	Ja

WeeklyRecurrenceSchedule

Schema för upprepning varje vecka.

Name	Type	Description	Obligatoriskt	Standardinställning
dagarPåVecka	matris med DayOfWeek	Veckodagar för upprepningsschemat.	Ja
type	enum	Veckovis upprepningstyp. Möjliga värden: `Weekly`	Ja

WorkflowActionOutputItem

Name	Type	Description	Obligatoriskt
action_id	string	Unik identifierare för åtgärden.	Ja
agent_reference	AgentReference		No
└— namn	string	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: `agent_reference`	Ja
└— version	string	Agentens versionsidentifierare.	No
Typ	string	Typen av CSDL-åtgärd (t.ex. "SetVariable", "InvokeAzureAgent").	Ja
parent_action_id	string	ID för den överordnade åtgärden om det här är en kapslad åtgärd.	No
previous_action_id	string	ID för föregående åtgärd om den här åtgärden följer en annan.	No
response_id	string	Svaret som objektet skapas på.	No
status	enum	Status för åtgärden (t.ex. "in_progress", "slutförd", "misslyckades", "avbröts"). Möjliga värden: `completed`, `failed`, `in_progress`, `cancelled`	Ja
type	enum	Möjliga värden: `workflow_action`	Ja

WorkflowAgentDefinition

Definitionen av arbetsflödesagenten.

Name	Type	Description	Obligatoriskt
Typ	enum	Möjliga värden: `workflow`	Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	No
└– rai_policy_name	string	Namnet på DEN RAI-princip som ska tillämpas.	Ja
arbetsflöde	string	CSDL YAML-definitionen för arbetsflödet.	No

integer

Typ: heltal

Format: int64

Last updated on 2026-06-12