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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
metadata	objekt	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.	Nej.
name	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
typ	query	Nej.	snöre Möjliga värden: prompt, hosted, container_app, workflow	Filtrera agenter efter typ. Om det inte anges returneras alla agenter.
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	snöre	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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten som ska hämtas.
API-version	query	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten som ska hämtas.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
metadata	objekt	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.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten som ska tas bort.
API-version	query	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten som ska uppdateras.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
manifest_id	snöre	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	objekt	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.	Nej.
parameter_values	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	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	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
metadata	objekt	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.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten som du vill hämta versioner för.
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	snöre	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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten som ska hämtas.
agent_version	path	Ja	snöre	Den version av agenten som ska hämtas.
API-version	query	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten som ska tas bort.
agent_version	path	Ja	snöre	Den version av agenten som ska tas bort
API-version	query	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	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	snöre	Den API-version som ska användas för den här åtgärden.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
manifest_id	snöre	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	objekt	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.	Nej.
parameter_values	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
manifest_id	snöre	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	objekt	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.	Nej.
name	snöre	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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
operation_id	path	Ja	snöre	Åtgärds-ID:t.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
agent_version	path	Ja	snöre	Versionen av agenten.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
agent_version	path	Ja	snöre	Versionen av agenten.
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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	objekt	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 containern inte finns blir åtgärden no-op. Åtgärden är en tidskrävande åtgärd. Följer designriktlinjerna för långvariga operationer i Azure REST API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
agent_version	path	Ja	snöre	Versionen av agenten.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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	Typ	Description
Operationsplats	snöre

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ömmade från containern som textbitar. Varje chunk är en UTF-8-sträng som kan vara antingen en ren text-loggrad eller en JSON-formaterad loggpost, beroende på vilken typ av containerlogg som strömmas. Klienter bör behandla varje chunk som ogenomskinlig text och, vid behov, försöka tolka den som JSON baserat på sina loggningskrav.

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

För konsolloggar är formatet ren text som sänds ut av containerns stdout/stderr. 2025-12-15T08:43:48.72656 Anslutning till containern 'agent-container'... 2025-12-15T08:43:48.75451 Lyckats ansluta till container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replika: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:08:08:00 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
agent_version	path	Ja	snöre	Versionen av agenten.
typ	query	Nej.	snöre Möjliga värden: console, system	Konsolen returnerar container STDOUT/STDERR, systemet returnerar container app-händelseström. Standardinställning till konsol
replica_name	query	Nej.	snöre	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	Nej.	integer	Antal eftersläpande rader som returneras. Upprätthållet till 1-300. Standardvärdet är 20
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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 containern redan körs blir åtgärden no-op. Åtgärden är en tidskrävande åtgärd. Följer designriktlinjerna för långvariga operationer i Azure REST API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
agent_version	path	Ja	snöre	Versionen av agenten.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
max_replicas	integer	Det maximala antalet repliker. Standardvärdet är 1.	Nej.	1
min_replicas	integer	Det minsta antalet repliker. Standardvärdet är 1.	Nej.	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	Typ	Description
Operationsplats	snöre

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 containern inte körs, eller om den redan har stoppats, kommer åtgärden att no-op. Åtgärden är en tidskrävande åtgärd. Följer designriktlinjerna för långvariga operationer i Azure REST API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
agent_version	path	Ja	snöre	Versionen av agenten.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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	Typ	Description
Operationsplats	snöre

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 containern inte körs blir åtgärden no-op. Åtgärden är en tidskrävande åtgärd. Följer designriktlinjerna för långvariga operationer i Azure REST API:er. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
agent_name	path	Ja	snöre	Namnet på agenten.
agent_version	path	Ja	snöre	Versionen av agenten.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
max_replicas	integer	Det maximala antalet repliker.	Nej.
min_replicas	integer	Det minsta antalet repliker.	Nej.

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	Typ	Description
Operationsplats	snöre

Statuskod: standard

Beskrivning: Ett oväntat felsvar.

Innehållstyp	Type	Beskrivning
application/json	ApiErrorResponse

Connections

Anslutningar – lista

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

Lista alla anslutningar i projektet, utan att fylla i anslutningsuppgifter

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
connectionType	query	Nej.	snöre Möjliga värden: AzureOpenAI, AzureBlob, AzureStorageAccount, CognitiveSearch, CosmosDB, ApiKey, AppConfig, AppInsights, , , CustomKeysRemoteTool_Preview	Lista anslutningar av den här specifika typen
defaultConnection	query	Nej.	booleskt	Lista anslutningar som är standardanslutningar

Begärandehuvud

Namn	Krävs	Typ	Description
x-ms-client-request-id	Falsk	snöre	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	Typ	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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 autentiseringsuppgifter för anslutningen

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Det egna namnet på anslutningen, som tillhandahålls av användaren.

Begärandehuvud

Namn	Krävs	Typ	Description
x-ms-client-request-id	Falsk	snöre	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	Anslutning

Svarshuvuden:

Header	Typ	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Det egna namnet på anslutningen, som tillhandahålls av användaren.

Begärandehuvud

Namn	Krävs	Typ	Description
x-ms-client-request-id	Falsk	snöre	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	Anslutning

Svarshuvuden:

Header	Typ	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Datauppsättningar

Datauppsättningar – lista senaste

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

Visa en lista över den senaste versionen av varje DatasetVersion

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Datauppsättningar – listversioner

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

Visa en lista över alla versioner av den angivna DatasetVersion

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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 Not Found om DatasetVersion inte finns.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Det specifika versions-ID:t för den 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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 No Content om DatasetVersion har tagits bort eller om DatasetVersion inte finns.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Det specifika versions-ID:t för den DatasetVersion som ska skapas eller uppdateras.

Begärans brödtext

Innehållstyp: application/merge-patch+json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Datauppsättningar – hämta autentiseringsuppgifter

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

Få SAS-inloggningsuppgifterna för att access till storage-kontot som är kopplat till en Dataset-version.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Det specifika versions-ID:t för den 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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 specifik version.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Det specifika versions-ID:t för den DatasetVersion som ska användas.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
connectionName (på engelska)	snöre	Azure Storage Account-anslutningsnamn att använda för att generera tillfällig SAS-token	Nej.
pendingUploadId	snöre	Om PendingUploadId inte anges används ett slumpmässigt GUID.	Nej.
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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Utrullningar

Distributioner – lista

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

Lista alla distribuerade modeller i projektet

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
modelPublisher	query	Nej.	snöre	Model publisher för att filtrera modeller efter
modelName	query	Nej.	snöre	Modellnamn (publisher-specifika namn) för att filtrera modeller efter
deploymentType	query	Nej.	snöre Möjliga värden: ModelDeployment	Typ av distribution som ska filtreras efter

Begärandehuvud

Namn	Krävs	Typ	Description
x-ms-client-request-id	Falsk	snöre	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	Typ	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Distributioner – hämta

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

Hämta en distribuerad modell.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på distributionen

Begärandehuvud

Namn	Krävs	Typ	Description
x-ms-client-request-id	Falsk	snöre	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	Typ	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Utvärderingstaxonomier

Utvärderingstaxonomier – lista

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

Lista utvärderingstaxonomier

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
inputName	query	Nej.	snöre	Filtrera efter namnet på utvärderingsindata.
inputType	query	Nej.	snöre	Filtrera efter taxonomiindatatyp.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Utvärderingstaxonomier – get

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

Hämta en utvärdering som körs efter namn.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Utvärderingstaxonomier – skapa

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

Skapa en utvärderingstaxonomi.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på utvärderingstaxonomi.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
egenskaper	objekt	Ytterligare egenskaper för utvärderingstaxonomin.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	Nej.
taxonomyInput	EvaluationTaxonomyInput	Indatakonfiguration för utvärderingstaxonomin.	Ja
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomin.	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Utvärderingstaxonomier – uppdatering

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

Uppdatera en utvärderingstaxonomi.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på utvärderingstaxonomi.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
egenskaper	objekt	Ytterligare egenskaper för utvärderingstaxonomin.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	Nej.
taxonomyInput	EvaluationTaxonomyInputUpdate	Indatakonfiguration för utvärderingstaxonomin.	Nej.
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomin.	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
actionType	query	Nej.	snöre Möjliga värden: continuousEvaluation, humanEvaluationPreview	Filtrera efter typ av utvärderingsregel.
agentName (agentnamn)	query	Nej.	snöre	Filtrera efter handläggarens namn.
aktiverad	query	Nej.	booleskt	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Utvärderingsregler – hämta

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

Hämta en utvärderingsregel.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Utvärderingsregler – ta bort

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

Ta bort en utvärderingsregel.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	Unik identifierare för utvärderingsregeln.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Falsk	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
åtgärd	EvaluationRuleAction	Åtgärdsmodell för utvärdering.	Ja
└– typ	EvaluationRuleActionType	Typ av utvärderingsåtgärd.	Ja
beskrivning	snöre	Beskrivning av utvärderingsregeln.	Nej.
visningsnamn	snöre	Visningsnamn för utvärderingsregeln.	Nej.
aktiverad	booleskt	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.	Nej.
└– agentName	snöre	Filtrera efter handläggarens namn.	Ja
Id-nummer	sträng (skrivskyddad)	Unik identifierare för utvärderingsregeln.	Ja
systemData (på engelska)	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
typ	query	Nej.	snöre Möjliga värden: builtin, custom, all	Filtrera utvärderare efter typ. Möjliga värden: 'all', 'custom', 'builtin'.
limit	query	Nej.	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

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
typ	query	Nej.	snöre Möjliga värden: builtin, custom, all	Filtrera utvärderare efter typ. Möjliga värden: 'all', 'custom', 'builtin'.
limit	query	Nej.	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

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

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

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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Det specifika versions-ID för EvaluatorVersion som ska hämtas.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Den version av EvaluatorVersion som ska tas bort.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Den version av EvaluatorVersion som ska uppdateras.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
categories	matris med EvaluatorCategory	Utvärderarens kategorier	Nej.
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
display_name	snöre	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	Nej.
metadata	objekt	Metadata om utvärderaren	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.

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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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 Not Found om indexet inte finns.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Det specifika versions-ID:t 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	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	Typ	Description
x-ms-error-code	snöre	Felsträng 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Namnet på resursen
version	path	Ja	snöre	Det specifika versions-ID:t för indexet som ska skapas eller uppdateras.

Begärans brödtext

Innehållstyp: application/merge-patch+json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Insikter

Insikter – generera

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

Generera insikter

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	snöre	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	snöre	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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
visningsnamn	snöre	Användarvänligt visningsnamn för insikten.	Ja
Id-nummer	sträng (skrivskyddad)	Den unika identifieraren för insiktsrapporten.	Ja
metadata	InsightsMetadata (skrivskyddad)	Metadata om insikterna.	Ja
└– slutfördAt	snöre	Tidsstämpeln när insikterna slutfördes.	Nej.
└– skapadAt	snöre	Tidsstämpeln när insikterna skapades.	Ja
begäran	InsightRequest	Begäran om insiktsrapporten.	Ja
└– typ	InsightType	Typ av begäran.	Ja
resultat	InsightResult (skrivskyddad)	Resultatet av insikterna.	Nej.
└– typ	InsightType	Typen av insikter som resulterar.	Ja
state	Azure. Core.Foundations.OperationState (skrivskyddat)	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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Insikter – lista

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

Lista alla insikter i omvänd kronologisk ordning (nyaste först).

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
typ	query	Nej.	snöre Möjliga värden: EvaluationRunClusterInsight, AgentClusterInsight, EvaluationComparison	Filtrera efter typ av analys.
evalId	query	Nej.	snöre	Filtrera efter utvärderings-ID.
runId	query	Nej.	snöre	Filtrera efter utvärderingskörnings-ID:t.
agentName (agentnamn)	query	Nej.	snöre	Filtrera efter handläggarens namn.
includeCoordinates	query	Nej.	booleskt	Om du vill inkludera koordinater för visualisering i svaret. Standardvärdet är falskt.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Insikter – hämta

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

Få en specifik inblick med ID.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	Den unika identifieraren för insiktsrapporten.
includeCoordinates	query	Nej.	booleskt	Om du vill inkludera koordinater för visualisering i svaret. Standardvärdet är falskt.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Minneslager

Skapa minneslager

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

Skapa ett minneslager.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
definitionen	MemoryStoreDefinition	Grundläggande definition för minneslagringskonfigurationer.	Ja
└– typ	MemoryStoreKind	Den typ av minneslagring.	Ja
beskrivning	snöre	En läsbar beskrivning av minneslagret. Begränsningar: maxLength: 512	Nej.
metadata	objekt	Godtyckliga nyckel/värde-metadata som ska associeras med minneslagret.	Nej.
name	snöre	Namnet på minneslagret. 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 minneslager

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

Visa en lista över alla minneslager.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
name	path	Ja	snöre	Namnet på minnesarkivet som ska uppdateras.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En läsbar beskrivning av minneslagret. Begränsningar: maxLength: 512	Nej.
metadata	objekt	Godtyckliga nyckel/värde-metadata som ska associeras med minneslagret.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
name	path	Ja	snöre	Namnet på minnesarkivet som ska hämtas.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
name	path	Ja	snöre	Namnet på minnesarkivet som ska tas bort.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
name	path	Ja	snöre	Namnet på minneslagret.
update_id	path	Ja	snöre	ID för minnesuppdateringsåtgärden.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
name	path	Ja	snöre	Namnet på minneslagret.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
omfattning	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
name	path	Ja	snöre	Namnet på minnesarkivet som ska sökas.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
items	matris med OpenAI.InputItem	Objekt som du kan söka efter efter relevanta minnen.	Nej.
options	MemorySearchOptions	Alternativ för minnessökning.	Nej.
└max_memories	integer	Maximalt antal minnesobjekt som ska returneras.	Nej.
previous_search_id	snöre	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.	Nej.
omfattning	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
name	path	Ja	snöre	Namnet på minnesarkivet som ska uppdateras.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
items	matris med OpenAI.InputItem	Konversationsobjekt som du kan extrahera minnen från.	Nej.
previous_update_id	snöre	Det unika ID:t för den tidigare uppdateringsbegäran, vilket möjliggör inkrementella minnesuppdateringar från den plats där den senaste åtgärden slutade.	Nej.
omfattning	snöre	Det namnområde som logiskt grupperar och isolerar minnen, till exempel ett användar-ID.	Ja
update_delay	integer	Tidsgräns för bearbetning av minnesuppdateringen i sekunder. Om en ny uppdateringsbegäran tas emot under den här perioden avbryts den aktuella begäran och tidsgränsen återställs. Ställ in på 0 för att omedelbart utlösa uppdateringen utan dröjsmål. Standardvärdet är 300 (5 minuter).	Nej.	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	Typ	Description
Operationsplats	snöre	Platsen för övervakning av drifttillstå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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
items	matris med OpenAI.InputItem		Nej.
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.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	Nej.	snöre	Filtrera efter handläggarens namn. Om det tillhandahålls returneras endast objekt som är associerade med den angivna agenten.
agent_id	query	Nej.	snöre	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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
conversation_id	path	Ja	snöre	ID:t för konversationen som ska uppdateras.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinstä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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
conversation_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
conversation_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
conversation_id	path	Ja	snöre	ID för konversationen där objektet måste skapas.
include	query	Nej.	array	Ytterligare fält som ska inkluderas i svaret. Mer information finns i parametern include för att visa konversationsobjekt.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinstä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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
conversation_id	path	Ja	snöre	ID:t för konversationen där objekten måste visas.
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	Nej.	snöre 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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
conversation_id	path	Ja	snöre	ID för konversationen som innehåller objektet.
item_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
conversation_id	path	Ja	snöre	ID:t för konversationen som objektet måste tas bort från.
item_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
after	query	Nej.	snöre	Identifier för den senaste sökningen från föregående pagineringsbegäran.
limit	query	Nej.	integer	Antal körningar som ska hämtas.
order	query	Nej.	snöre Möjliga värden: asc, desc	Sorteringsordning för exekveringar efter tidsstämpel. Använd asc för stigande ordning eller desc för fallande ordning. Standardinställningen är asc.
sortera_efter	query	Nej.	snöre Möjliga värden: created_at, updated_at	Evals kan ordnas efter skapandetid eller senast uppdaterad tid. Använd created_at för att skapa tid eller updated_at för senast uppdaterad tid.

Responses

Statuskod: 200

Beskrivning: Begäran har slutförts.

Innehållstyp	Type	Beskrivning
application/json	objekt	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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
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.	Nej.
name	snöre	Namnet på utvärderingen.	Nej.
egenskaper	objekt	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.	Nej.
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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	ID:t för utvärderingen som ska uppdateras.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinstä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.	Nej.
name	snöre		Nej.
egenskaper	objekt	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.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	ID:t för utvärderingen som ska hämtas för.
after	query	Nej.	snöre	Identifier för den senaste sökningen från föregående pagineringsbegäran.
limit	query	Nej.	integer	Antal körningar som ska hämtas.
order	query	Nej.	snöre Möjliga värden: asc, desc	Sorteringsordning för exekveringar efter tidsstämpel. Använd asc för stigande ordning eller desc för fallande ordning. Standardinställningen är asc.
status	query	Nej.	snöre 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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	ID:t för utvärderingen som du vill skapa en körning för.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
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.	Nej.
name	snöre	Namnet på körningen.	Nej.
egenskaper	objekt	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.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	ID:t för utvärderingen som körningen ska tas bort från.
run_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	ID:t för utvärderingen som ska hämtas för.
run_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	ID:t för den utvärdering vars körning du vill avbryta.
run_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre
run_id	path	Ja	snöre	ID för körningen för att hämta utdataobjekt för.
after	query	Nej.	snöre	Identifier för den senaste sökningen från föregående pagineringsbegäran.
limit	query	Nej.	integer	Antal körningar som ska hämtas.
order	query	Nej.	snöre Möjliga värden: asc, desc	Sorteringsordning för exekveringar efter tidsstämpel. Använd asc för stigande ordning eller desc för fallande ordning. Standardinställningen är asc.
status	query	Nej.	snöre 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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
eval_id	path	Ja	snöre	ID:t för utvärderingen som ska hämtas för.
run_id	path	Ja	snöre	ID:t för körningen som ska hämtas.
output_item_id	path	Ja	snöre	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 namnet på de finjusterade modellerna när det är klart.

Lär dig mer om finjustering

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
hyperparametrar	OpenAI.CreateFineTuningJobRequestHyperparameters		Nej.
└– batch_size	string eller OpenAI.integer		Nej.	bil
└– learning_rate_multiplier	string eller OpenAI.numeric		Nej.
└– n_epochs	string eller OpenAI.integer		Nej.	bil
Integrationer	matris med OpenAI.CreateFineTuningJobRequestIntegrations	En lista över integreringar som ska aktiveras för ditt finjusteringsjobb.	Nej.
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.	Nej.
method	OpenAI.FineTuneMethod	Metoden som används för finjustering.	Nej.
model	sträng (se giltiga modeller nedan)	Namnet på modellen som ska finjusteras. Du kan välja en av de stödda modeller.	Ja
seed	OpenAI.integer (nullbar)		Nej.
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	Nej.
utbildningsfil	snöre	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. Se guiden finjustering för mer information.	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ått regelbundet under finjustering. 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. Se guiden finjustering för mer information.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
after	query	Nej.	snöre	Identifierare för det senaste jobbet från föregående sidnumreringsbegäran.
limit	query	Nej.	integer	Antal finjusteringsjobb som ska hämtas.
API-version	query	Ja	snöre	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är dig mer om finjustering

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
finjusteringsjobb_id	path	Ja	snöre	ID för finjusteringsjobbet.
API-version	query	Ja	snöre	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 omedelbart ett finjusterat jobb.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
finjusteringsjobb_id	path	Ja	snöre	ID:t för det finjusteringsjobb som ska avbrytas.
API-version	query	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
finjusteringsjobb_id	path	Ja	snöre	ID:t för det finjusteringsjobb som du vill hämta kontrollpunkter för.
after	query	Nej.	snöre	Identifierare för det senaste kontrollpunkts-ID:t från föregående sidnumreringsbegäran.
limit	query	Nej.	integer	Antal kontrollpunkter som ska hämtas.
API-version	query	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
finjusteringsjobb_id	path	Ja	snöre	ID:t för det finjusteringsjobb som händelser ska hämtas för.
after	query	Nej.	snöre	Identifierare för den senaste händelsen från föregående sidnumreringsbegäran.
limit	query	Nej.	integer	Antal händelser som ska hämtas.
API-version	query	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
finjusteringsjobb_id	path	Ja	snöre	ID för det finjusteringsjobb som ska pausas.
API-version	query	Ja	snöre	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 finjusterat jobb.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
finjusteringsjobb_id	path	Ja	snöre	ID:t för det finjusteringsjobb som ska återupptas.
API-version	query	Ja	snöre	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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
bakgrund	boolesk (nullbar)		Nej.
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.	Nej.
include	matris med OpenAI.IncludeEnum		Nej.
input	OpenAI.InputParam	Text, bild eller filindata till modellen, som används för att generera ett svar. Lära sig mer: - Textinmatningar och utmatningar - Bildingångar - Filinmatningar - Konversationstillstånd - Funktionsanrop	Nej.
instructions	sträng (nullbar)		Nej.
max_output_tokens	OpenAI.integer (nullbar)		Nej.
max_tool_calls	OpenAI.integer (nullbar)		Nej.
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.	Nej.
model	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
parallella verktygsanrop	boolesk (nullbar)		Nej.	Sann
previous_response_id	sträng (nullbar)		Nej.
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
prompt_cache_key	snöre	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.	Nej.
prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
reasoning	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└— insats	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
└– generate_summary	enum	Möjliga värden: auto, concise, detailed	Nej.
└— sammanfattning	enum	Möjliga värden: auto, concise, detailed	Nej.
safety_identifier	snöre	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.	Nej.
servicenivå	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
store	boolesk (nullbar)		Nej.	Sann
ström	boolesk (nullbar)		Nej.
stream_options	OpenAI.ResponseStreamOptions (nullbar)	Alternativ för direktuppspelningssvar. Ange endast detta när du anger stream: true.	Nej.
└– include_obfuscation	booleskt	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 ange include_obfuscation till false för att optimera bandbredden om du litar på nätverkslänkarna mellan ditt program och OpenAI-API:et.	Nej.
structured_inputs	objekt	Strukturerade indata till svaret som kan delta i frågemallsersättning eller verktygsargumentbindningar.	Nej.
temperatur	OpenAI.numeric (nullbar)		Nej.	1
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
top_logprobs	OpenAI.integer (nullbar)		Nej.
top_p	OpenAI.numeric (nullbar)		Nej.	1
truncation	enum	Möjliga värden: auto, disabled	Nej.
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.	Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	Nej.	snöre	Filtrera efter handläggarens namn. Om det tillhandahålls returneras endast objekt som är associerade med den angivna agenten.
agent_id	query	Nej.	snöre	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	Nej.	snöre	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	objekt	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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
input	sträng eller matris med OpenAI.InputItem		Nej.
instructions	sträng (nullbar)		Nej.
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)		Nej.

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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
response_id	path	Ja	snöre
include[]	query	Nej.	array
ström	query	Nej.	booleskt
starting_after	query	Nej.	integer

Begärandehuvud

Namn	Krävs	Typ	Description
acceptera	Falsk	snöre 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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
response_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
response_id	path	Ja	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
response_id	path	Ja	snöre
limit	query	Nej.	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	Nej.	snöre Möjliga värden: asc, desc	Sortera ordning efter created_at tidsstämpeln för objekten. asc för stigande ordning ochdesc för fallande ordning.
after	query	Nej.	snöre	En markör för användning i sidnumrering. after är ett objekt-ID som definierar din plats i listan. Om du till exempel gör en listbegäran och tar emot 100 objekt som slutar med obj_foo efterföljande anrop kan innehålla after=obj_foo för att hämta nästa sida i listan.
före	query	Nej.	snöre	En markör för användning i sidnumrering. 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	objekt	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Redteams – ta

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

Få ett redteam efter namn.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
name	path	Ja	snöre	Identifierare för det röda lagets löpning.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Redteams – skapa

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

Skapar en redteam-löpning.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
applicationScenario	snöre	Programscenario för red team-åtgärden för att generera scenariospecifika attacker.	Nej.
attackStrategies	matris med AttackStrategy	Lista över attackstrategier eller kapslade listor över attackstrategier.	Nej.
visningsnamn	snöre	Namnet på det röda lagets körning.	Nej.
Id-nummer	sträng (skrivskyddad)	Identifierare för det röda lagets löpning.	Ja
numTurns	integer	Antal simuleringsrundor.	Nej.
egenskaper	objekt	Röda lagets egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	Nej.
riskCategories	matris med RiskCategory	Lista över riskkategorier som attackmål ska genereras för.	Nej.
simulationOnly	booleskt	Endast simulering eller simulering + utvärdering. Standardvärdet false, om det är sant matar genomsökningen ut konversationen, inte utvärderingsresultatet.	Nej.	Falsk
status	sträng (skrivskyddad)	Status för det röda laget. Den ställs in av tjänsten och är skrivskyddad.	Nej.
Taggar	objekt	Röda lagets taggar. Till skillnad från egenskaper är taggar helt föränderliga.	Nej.
mål	TargetConfig	Abstrakt klass för målkonfiguration.	Ja
└– typ	snöre	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

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
typ	query	Nej.	snöre Möjliga värden: Evaluation, Insight	Filtrera efter typ av schema.
aktiverad	query	Nej.	booleskt	Filtrera efter aktiverad status.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Scheman – ta bort

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

Ta bort ett schema.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	Identifierare för schemat.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Scheman – hämta

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

Hämta ett schema efter id.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	Identifierare för schemat.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Scheman – skapa eller uppdatera

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

Skapa eller uppdatera operationsmall.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	Identifierare för schemat.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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ärans brödtext

Innehållstyp: program/json

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Beskrivning av schemat.	Nej.
visningsnamn	snöre	Namnet på schemat.	Nej.
aktiverad	booleskt	Aktiverad status för schemat.	Ja
Id-nummer	sträng (skrivskyddad)	Identifierare för schemat.	Ja
egenskaper	objekt	Schemats egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	Nej.
Provisioneringsstatus	ScheduleProvisioningStatus (skrivskyddad)	Status för schemaläggning av etablering.	Nej.
systemData (på engelska)	objekt (skrivskyddat)	Systemmetadata för resursen.	Ja
Taggar	objekt	Schemats taggar. Till skillnad från egenskaper är taggar helt föränderliga.	Nej.
uppgift	ScheduleTask	Schemalägg uppgiftsmodell.	Ja
└– konfiguration	objekt	Konfiguration för uppgiften.	Nej.
└– 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	Typ	Description
x-ms-error-code	snöre	Felsträng som anger vad som gick fel.

Scheman – listkörningar

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

Visa en lista över alla schemalagda körningar.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.
Id-nummer	path	Ja	snöre	Identifierare för schemat.
typ	query	Nej.	snöre Möjliga värden: Evaluation, Insight	Filtrera efter typ av schema.
aktiverad	query	Nej.	booleskt	Filtrera efter aktiverad status.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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	Typ	Description
x-ms-error-code	snöre	Felsträng 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 av id.

URI parametrar

Namn	I	Krävs	Typ	Description
endpoint	path	Ja	snöre	Foundry Project-slutpunkt i formen "https://{ai-services-account-name}.services.ai. azure.com/api/projects/{project-name}". Om du bara har ett 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/projekt/_project"
schedule_id	path	Ja	snöre	Den unika identifieraren för schemat.
run_id	path	Ja	snöre	Den unika identifieraren för schemakörningen.
API-version	query	Ja	snöre	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Namn	Krävs	Typ	Description
Foundry-Features	Sann	snöre 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

Komponenter

A2APreviewTool

En agent som implementerar A2A-protokollet.

Namn	Typ	Description	Krävs	Förinställning
agent_card_path	snöre	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	Nej.
base_url	snöre	Bas-URL för agenten.	Nej.
project_connection_id	snöre	Anslutnings-ID:t i projektet för A2A-servern. Anslutningen lagrar autentisering och annan anslutningsinformation som behövs för att ansluta till A2A-servern.	Nej.
typ	enum	Verktygets typ. Alltid "a2a_preview. Möjliga värden: a2a_preview	Ja

AISearchIndexResource

En resurs för AI-sökindex.

Namn	Typ	Description	Krävs	Förinställning
filter	snöre	Filtersträng för sökresurs. Lär dig mer här.	Nej.
index_asset_id	snöre	Indexera tillgångs-ID för sökresursen.	Nej.
indexnamn	snöre	Namnet på ett index i ett IndexResource som är kopplat till den här agenten.	Nej.
project_connection_id	snöre	Ett indexanslutnings-ID i en IndexResource som är kopplad till den här agenten.	Nej.
frågetyp	AzureAISearchQueryType	Tillgängliga frågetyper för Azure AI Search-verktyget.	Nej.
top_k	integer	Antal dokument som ska hämtas från sökningen och presenteras för modellen.	Nej.

AgentClusterInsightRequest

Insikter om resultaten av agentutvärderingen

Namn	Typ	Description	Krävs	Förinställning
agentName (agentnamn)	snöre	Identifierare för agenten.	Ja
modelConfiguration	InsightModelConfiguration	Konfiguration av modellen som används i insiktsgenereringen.	Nej.
└– modelDeploymentName	snöre	Modelldistributionen som ska utvärderas. Accepterar antingen distributionsnamnet ensamt eller med anslutningsnamnet som {connectionName}/<modelDeploymentName>.	Ja
typ	enum	Typ av begäran. Möjliga värden: AgentClusterInsight	Ja

AgentClusterInsightResult

Insikter från agentklusteranalysen.

Namn	Typ	Description	Krävs	Förinställning
clusterInsight	ClusterInsightResult	Insikter från klusteranalysen.	Ja
typ	enum	Typen av insikter som resulterar. Möjliga värden: AgentClusterInsight	Ja

AgentContainerObject

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

Namn	Typ	Description	Krävs	Förinställning
container	ContainerDetails (skrivskyddad)	Detaljerad information om containern.	Nej.
└– health_state	snöre	Hälsotillståndet för containern.	Ja
└– provisioning_error	snöre	Om det finns ett etableringsfel för containern.	Nej.
└– provisioning_state	snöre	Containerns etableringstillstånd.	Ja
└– repliker	matris med ContainerReplica	Listan över repliker i containern.	Ja
└— tillstånd	snöre	Behållarens tillstånd.	Ja
└– updated_on	snöre	Den senaste uppdateringstiden för containern.	Ja
skapad_tid	snöre	Skapandetiden för containern.	Ja
error_message	sträng (skrivskyddad)	Felmeddelandet om containern inte kunde fungera, om det finns några.	Nej.
Id-nummer	sträng (skrivskyddad)	Containerns identifierare.	Nej.
max_replicas	integer	Det maximala antalet repliker för containern. Standard är 1.	Nej.
min_replicas	integer	Det minsta antalet repliker för containern. Standard är 1.	Nej.
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 viss version av en agent.	Ja
updated_at	snöre	Den senaste uppdateringstiden för containern.	Ja

AgentContainerOperationError

Om det finns felinformation om containeråtgärden.

Namn	Typ	Description	Krävs	Förinställning
kod	snöre	Om det finns någon felkod för containeråtgärden.	Ja
meddelande	snöre	Felmeddelandet för containeråtgärden, om det finns något.	Ja
typ	snöre	Om det finns någon feltyp för containeråtgärden.	Ja

AgentContainerOperationObject

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

Namn	Typ	Description	Krävs	Förinställning
agent_id	snöre	Agentens ID.	Ja
agent_version_id	snöre	ID för agentversionen.	Ja
container	AgentContainerObject	Information om containern för en specifik version av en agent.	Nej.
└– container	ContainerDetails (skrivskyddad)	Den detaljerade containerinformationen.	Nej.
└– 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.	Nej.
└– id	sträng (skrivskyddad)	Containerns identifierare.	Nej.
└– max_replicas	integer	Det maximala antalet repliker för containern. Standard är 1.	Nej.
└– min_replicas	integer	Det minsta antalet repliker för containern. Standard är 1.	Nej.
└– 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.	Nej.
└– kod	snöre	Om det finns någon felkod för containeråtgärden.	Ja
└– meddelande	snöre	Felmeddelandet för containeråtgärden, om det finns något.	Ja
└– typ	snöre	Om det finns någon feltyp för containeråtgärden.	Ja
Id-nummer	snöre	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.

Fastighet	Värde
Type	snöre
Värden	NotStarted InProgress Succeeded Failed

AgentContainerStatus

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

Fastighet	Värde
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
typ	AgentKind		Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
└– rai_policy_name	snöre	Namnet på den RAI-princip som ska tillämpas.	Ja

AgentKind

Fastighet	Värde
Type	snöre
Värden	prompt hosted container_app workflow

AgentObject

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Den unika identifieraren för agenten.	Ja
name	snöre	Namnet på agenten. Begränsningar: maxLength: 63	Ja
objekt	enum	Objekttypen, som alltid är "agent". Möjliga värden: agent	Ja
versions	objekt	Den senaste versionen av agenten.	Ja
└— senaste	AgentVersionObject		Ja

AgentProtocol

Fastighet	Värde
Type	snöre
Värden	activity_protocol responses

AgentReferens

Namn	Typ	Description	Krävs	Förinställning
name	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
typ	enum	Möjliga värden: agent_reference	Ja
version	snöre	Agentens versionsidentifierare.	Nej.

AgentTaxonomyInput

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

Namn	Typ	Description	Krävs	Förinställning
riskCategories	matris med RiskCategory	Lista över riskkategorier att utvärdera mot.	Ja
mål	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	snöre	Typ av mål.	Ja
typ	enum	Indatatyp för utvärderingstaxonomin. Möjliga värden: agent	Ja

AgentTaxonomyInputUpdate

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

Namn	Typ	Description	Krävs	Förinställning
riskCategories	matris med RiskCategory	Lista över riskkategorier att utvärdera mot.	Nej.
mål	TargetUpdate	Basklass för mål med stöd för diskriminator.	Nej.
└– typ	snöre	Typ av mål.	Ja
typ	enum	Indatatyp för utvärderingstaxonomin. Möjliga värden: agent	Ja

AgentVersionObject

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (sekunder) när agenten skapades.	Ja
definitionen	AgentDefinition		Ja
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
Id-nummer	snöre	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	snöre	Namnet på agenten. Namnet kan användas för att hämta/uppdatera/ta bort agenten. Begränsningar: maxLength: 256	Ja
objekt	enum	Objekttypen, som alltid är "agent.version". Möjliga värden: agent.version	Ja
version	snöre	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

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Typ av autentiseringsuppgifter Möjliga värden: AgenticIdentityToken_Preview	Ja

ApiErrorResponse

Felsvar för API-fel.

Namn	Typ	Description	Krävs	Förinställning
fel	OpenAI.Error		Ja

ApiKeyCredentials

Definition av API-nyckelautentiseringsuppgifter

Namn	Typ	Description	Krävs	Förinställning
key	sträng (skrivskyddad)	API-nyckel	Nej.
typ	enum	Typ av autentiseringsuppgifter Möjliga värden: ApiKey	Ja

AssetCredentialResponse

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

Namn	Typ	Description	Krävs	Förinställning
blobReference	BlobReference	Information om blobreferens.	Ja
└– blobUri	snöre	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	Behörighetsinformation för att access storage kontot.	Ja
└– storageAccountArmId	snöre	ARM-ID för storage-kontot att använda.	Ja

AssetId

Identifierare för en sparad tillgång.

Typ: sträng

AttackStrategy

Strategier för attacker.

Fastighet	Värde
Beskrivning	Strategier för attacker.
Type	snöre
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.

Namn	Typ	Description	Krävs	Förinställning
kod	snöre	En av en serverdefinierad uppsättning felkoder.	Ja
details	Array av Azure. Core.Foundations.Error	En matris med information om specifika fel som ledde till det rapporterade felet.	Nej.
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.	Nej.
└– kod	snöre	En av en serverdefinierad uppsättning felkoder.	Nej.
└– innererror	Azure. Core.Foundations.InnerError	Inre fel.	Nej.
meddelande	snöre	En mänsklig läsbar representation av felet.	Ja
mål	snöre	Målet för felet.	Nej.

Azure. Core.Foundations.ErrorResponse

Ett svar som innehåller felinformation.

Namn	Typ	Description	Krävs	Förinställning
fel	Azure. Core.Foundations.Error	Felobjektet.	Ja
└– kod	snöre	En av en serverdefinierad uppsättning felkoder.	Ja
└— detaljer	Array av Azure. Core.Foundations.Error	En matris med information om specifika fel som ledde till det rapporterade felet.	Nej.
└– innererror	Azure. Core.Foundations.InnerError	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.	Nej.
└– meddelande	snöre	En mänsklig läsbar representation av felet.	Ja
└– mål	snöre	Målet för felet.	Nej.

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.

Namn	Typ	Description	Krävs	Förinställning
kod	snöre	En av en serverdefinierad uppsättning felkoder.	Nej.
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.	Nej.
└– kod	snöre	En av en serverdefinierad uppsättning felkoder.	Nej.
└– innererror	Azure. Core.Foundations.InnerError	Inre fel.	Nej.

Azure. Kärna.Grundar.OperationTillstånd

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

Fastighet	Värde
Beskrivning	Uppräkning som beskriver tillåtna åtgärdstillstånd.
Type	snöre
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.

Namn	Typ	Description	Krävs	Förinställning
name	snöre	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.	Nej.
typ	enum	Typen av mål, alltid azure_ai_agent. Möjliga värden: azure_ai_agent	Ja
version	snöre	Versionen av Azure AI-agenten.	Nej.

AzureAIAgentTargetUpdate

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

Namn	Typ	Description	Krävs	Förinställning
name	snöre	Den unika identifieraren för Azure AI-agenten.	Nej.
tool_descriptions	matris med ToolDescription	De parametrar som används för att styra agentens samplingsbeteende under textgenerering.	Nej.
typ	enum	Typen av mål, alltid azure_ai_agent. Möjliga värden: azure_ai_agent	Ja
version	snöre	Versionen av Azure AI-agenten.	Nej.

AzureAIDataSourceConfig

Namn	Typ	Description	Krävs	Förinställning
scenarie	enum	Scenario för dataschema. Möjliga värden: red_team, responses, traces_preview, synthetic_data_gen_preview	Ja
schema	objekt	JSON-schemat för det övergripande objektet för körningen av datakällans objekt.	Ja
typ	enum	Objekttypen, som alltid azure_ai_sourceär . 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.

Namn	Typ	Description	Krävs	Förinställning
model	snöre	Den unika identifieraren för Azure AI-modellen.	Nej.
provtagning_parametrar	ModelSamplingParams	Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.	Nej.
└– 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	Nummer	Temperaturparametern för sampling.	Ja
└– top_p	Nummer	Parametern top-p för kärnsampling.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
model	snöre	Den unika identifieraren för Azure AI-modellen.	Nej.
provtagning_parametrar	ModelSamplingParamsUpdate	Representerar en uppsättning parametrar som används för att styra samplingsbeteendet för en språkmodell under textgenereringen.	Nej.
└– max_completion_tokens	integer	Det maximala antalet token som tillåts i slutförandet.	Nej.
└– frö	integer	Det slumpmässiga fröet för reproducerbarhet.	Nej.
└– temperatur	Nummer	Temperaturparametern för sampling.	Nej.
└– top_p	Nummer	Parametern top-p för kärnsampling.	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
event_configuration_id	snöre	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	objekt	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
typ	enum	Typen av datakälla, alltid azure_ai_responses. Möjliga värden: azure_ai_responses	Ja

AzureAISearchIndex

Azure AI Search Index Definition

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
typ	enum	Typ av index Möjliga värden: AzureSearch	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

AzureAISearchIndexUpdate

Azure AI Search Index Definition

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	enum	Typ av index Möjliga värden: AzureSearch	Ja

AzureAISearchQueryType

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

Fastighet	Värde
Beskrivning	Tillgängliga frågetyper för Azure AI Search-verktyget.
Type	snöre
Värden	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

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

Namn	Typ	Description	Krävs	Förinställning
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
typ	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.

Namn	Typ	Description	Krävs	Förinstä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 queue-namn och URI.

Namn	Typ	Description	Krävs	Förinställning
storage_queue	AzureFunctionStorageQueue	Strukturen för att behålla storage queue-namn och URI.	Ja
└– queue_name	snöre	Namnet på en Azure-funktions-storage-kö.	Ja
└– queue_service_endpoint	snöre	URI till Azure Storage Queue-tjänsten som låter dig manipulera en kö.	Ja
typ	enum	Typen av bindning, som alltid är "storage_queue". Möjliga värden: storage_queue	Ja

AzureFunctionDefinition

Definitionen av Azure-funktionen.

Namn	Typ	Description	Krävs	Förinställning
function	objekt	Definitionen av azure funktion och dess parametrar.	Ja
└— beskrivning	snöre	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej.
└— namn	snöre	Namnet på den funktion som ska anropas.	Ja
└— parametrar	objekt	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt.	Ja
input_binding	AzureFunctionBinding	Strukturen för att behålla storage queue-namn och URI.	Ja
└– storage_queue	AzureFunctionStorageQueue	Storage queue.	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 queue-namn och URI.	Ja
└– storage_queue	AzureFunctionStorageQueue	Storage queue.	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 queue-namn och URI.

Namn	Typ	Description	Krävs	Förinställning
queue_name	snöre	Namnet på en Azure-funktions-storage-kö.	Ja
queue_service_endpoint	snöre	URI till Azure Storage Queue-tjänsten som låter dig manipulera en kö.	Ja

AzureFunctionTool

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

Namn	Typ	Description	Krävs	Förinställning
azure_function	AzureFunctionDefinition	Definitionen av Azure-funktionen.	Ja
└– funktion	objekt	Definitionen av azure funktion och dess parametrar.	Ja
└— beskrivning	snöre	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej.
└— namn	snöre	Namnet på den funktion som ska anropas.	Ja
└— parametrar	objekt	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt.	Ja
└– input_binding	AzureFunctionBinding	Inmatningskö för storage. Queue storage-triggern kör en funktion när meddelanden läggs till den.	Ja
└output_binding	AzureFunctionBinding	Utdata storage queue. Funktionen skriver utdata till den här kön när indataobjekten bearbetas.	Ja
typ	enum	Objekttypen, som alltid är "browser_automation". Möjliga värden: azure_function	Ja

AzureOpenAIModelConfiguration

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

Namn	Typ	Description	Krävs	Förinställning
modelDeploymentName	snöre	Distributionsnamn för AOAI-modellen. Exempel: gpt-4o om det är i AIServices eller anslutningsbaserat connection_name/deployment_name (t.ex. my-aoai-connection/gpt-4o).	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	CredentialType (skrivskyddad)	Typen av autentiseringsuppgifter som används av anslutningen	Ja

BingCustomSearchConfiguration

En bing anpassad sökkonfiguration.

Namn	Typ	Description	Krävs	Förinställning
count	integer	Antalet sökresultat som ska returneras i bing api-svaret	Nej.
freshness	snöre	Filtrera sökresultaten efter ett visst tidsintervall. Se accepterade värden här.	Nej.
instance_name	snöre	Namnet på den anpassade konfigurationsinstans som angetts för konfigurationen.	Ja
marknad	snöre	Marknaden där resultaten kommer ifrån.	Nej.
project_connection_id	snöre	Project anslutnings-id för jordning med bing-sökning	Ja
set_lang	snöre	Språket som används för användargränssnittssträngar när man anropar Bing API.	Nej.

BingCustomSearchPreviewTool

Indatadefinitionsinformationen för ett Bing-specialsökverktyg som används för att konfigurera en agent.

Namn	Typ	Description	Krävs	Förinställning
bing_custom_search_preview	BingCustomSearchToolParameters	Bing:s anpassade sökverktygsparametrar.	Ja
└– search_configurations	matris med BingCustomSearchConfiguration	Project-anslutningarna som är kopplade till detta verktyg. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget. Begränsningar: maxItems: 1	Ja
typ	enum	Objekttypen, som alltid är 'bing_custom_search_preview'. Möjliga värden: bing_custom_search_preview	Ja

BingCustomSearchToolParameters

Bing:s anpassade sökverktygsparametrar.

Namn	Typ	Description	Krävs	Förinställning
search_configurations	matris med BingCustomSearchConfiguration	Project-anslutningarna som är kopplade till detta verktyg. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget.	Ja

BingGroundingSearchConfiguration

Sökkonfiguration för Bing Grounding

Namn	Typ	Description	Krävs	Förinställning
count	integer	Antalet sökresultat som ska returneras i bing api-svaret	Nej.
freshness	snöre	Filtrera sökresultaten efter ett visst tidsintervall. Se accepterade värden här.	Nej.
marknad	snöre	Marknaden där resultaten kommer ifrån.	Nej.
project_connection_id	snöre	Project anslutnings-id för jordning med bing-sökning	Ja
set_lang	snöre	Språket som används för användargränssnittssträngar när man anropar Bing API.	Nej.

BingGroundingSearchToolParameters

Parametrarna för bing grounding-sökverktyget.

Namn	Typ	Description	Krävs	Förinstä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

Indatadefinitionsinformationen för ett bing-jordningssökverktyg som används för att konfigurera en agent.

Namn	Typ	Description	Krävs	Förinställning
bing_grounding	BingGroundingSearchToolParameters	Parametrarna för bing grounding-sökverktyget.	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
typ	enum	Objekttypen, som alltid är "bing_grounding". Möjliga värden: bing_grounding	Ja

BlobReference

Information om blobreferens.

Namn	Typ	Description	Krävs	Förinställning
blobUri	snöre	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	snöre	ARM-ID för storage-kontot att använda.	Ja

BrowserAutomationPreviewTool

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

Namn	Typ	Description	Krävs	Förinställning
browser_automation_preview	BrowserAutomationToolParameters	Definition av inmatningsparametrar för Browser Automation Tool.	Ja
└– anslutning	BrowserAutomationToolConnectionParameters	Projektets anslutningsparametrar kopplade till webbläsarens automatiseringsverktyg.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
project_connection_id	snöre	ID:t för projektets anslutning till din Azure Playwright-resurs.	Ja

BrowserAutomationToolParameters

Definition av inmatningsparametrar för Browser Automation Tool.

Namn	Typ	Description	Krävs	Förinställning
connection	BrowserAutomationToolConnectionParameters	Definition av indataparametrar för anslutningen som används av Browser Automation Tool.	Ja
└– project_connection_id	snöre	ID:t för projektets anslutning till din Azure Playwright-resurs.	Ja

CaptureStructuredOutputsTool

Ett verktyg för att fånga strukturerade resultat

Namn	Typ	Description	Krävs	Förinställning
Utgångar	StructuredOutputDefinition	Strukturerade utdata som kan skapas av agenten.	Ja
└— beskrivning	snöre	En beskrivning av de utdata som ska genereras. Används av modellen för att avgöra när utdata ska genereras.	Ja
└— namn	snöre	Namnet på strukturerade utdata.	Ja
└– schema	objekt	JSON-schemat för strukturerade utdata.	Ja
└– strikt	boolesk (nullbar)	Om du vill framtvinga strikt validering. Standard true.	Ja
typ	enum	Verktygets typ. Alltid capture_structured_outputs. Möjliga värden: capture_structured_outputs	Ja

ChartCoordinate

Koordinater för analysdiagrammet.

Namn	Typ	Description	Krävs	Förinställning
storlek	integer	Storleken på diagramelementet.	Ja
x	integer	X-axelns koordinat.	Ja
y	integer	Y-axeln koordineras.	Ja

ChatSummaryMemoryItem

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

Namn	Typ	Description	Krävs	Förinställning
innehåll	snöre	Innehållet i minnet.	Ja
typ	enum	Typen av minnesobjekt. Möjliga värden: chat_summary	Ja
memory_id	snöre	Det unika ID:t för minnesobjektet.	Ja
omfattning	snöre	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.

Namn	Typ	Description	Krävs	Förinställning
clusters	matris med InsightCluster	Lista över kluster som identifierats i insikterna.	Ja
Koordinater	objekt	Valfri mappning av ID:n 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.	Nej.
summary	InsightSummary	Sammanfattning av felklusteranalysen.	Ja
└— metod	snöre	Metod som används för klustring.	Ja
└– sampleCount	integer	Totalt antal analyserade prover.	Ja
└— uniqueClusterCount	integer	Totalt antal unika kluster.	Ja
└— uniqueSubclusterCount	integer	Totalt antal unika underklusteretiketter.	Ja
└— användning	ClusterTokenUsage	Tokenanvändning vid utförande av klustringsanalys	Ja

ClusterTokenUsage

Tokenanvändning för klusteranalys

Namn	Typ	Description	Krävs	Förinställning
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

Namn	Typ	Description	Krävs	Förinställning
code_text	snöre	Infogad kodtext för utvärderaren	Ja
data_schema	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
init_parameters	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
metrics	objekt	Förteckning över utfallsmått som tagits fram av den här utvärderaren	Nej.
typ	enum	Möjliga värden: code	Ja

CompletionMessageToolCallChunk

Information om knappanrop i ett meddelande.

Namn	Typ	Description	Krävs	Förinställning
function	FunctionToolCall	Information om ett funktionsverktygsanrop.	Nej.
└─ argument	snöre	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format.	Ja
└— namn	snöre	Namnet på funktionen som ska anropas.	Ja
Id-nummer	snöre	ID:t för verktygsanropet.	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
autentiseringsuppgifter	BaseCredentials (skrivskyddad)	En basklass för autentiseringsuppgifter för anslutning	Ja
└– typ	CredentialType (skrivskyddad)	Den typ av autentiseringsuppgifter som används av anslutningen	Ja
Id-nummer	sträng (skrivskyddad)	En unik identifierare för anslutningen som genereras av tjänsten	Ja
ärStandard	booleskt värde (skrivskyddat)	Om anslutningen är taggad som standardanslutningen av sin 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
mål	sträng (skrivskyddad)	Anslutnings-URL:en som ska användas för den här tjänsten	Ja
typ	ConnectionType (skrivskyddad)	Typ (eller kategori) för anslutningen	Ja

Anslutningstyp

Typ (eller kategori) för anslutningen

Fastighet	Värde
Beskrivning	Typ (eller kategori) för anslutningen
Type	snöre
Värden	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

Definitionen av containerappens agent.

Namn	Typ	Description	Krävs	Förinställning
container_app_resource_id	snöre	Resurs-ID:t för Azure Container App som hostar denna agent. Kan inte ändras mellan versioner.	Ja
container_protocol_versions	matris med ProtocolVersionRecord	De protokoll som agenten stöder för inkommande kommunikation av containrarna.	Ja
ingress_subdomain_suffix	snöre	Suffixet som ska gälla för appens underdomän när ingress skickas till agenten. Detta 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).	Nej.
└– rai_policy_name	snöre	Namnet på den RAI-princip som ska tillämpas.	Ja

ContainerDetails

Detaljerad information om containern.

Namn	Typ	Description	Krävs	Förinställning
health_state	snöre	Hälsotillståndet för containern.	Ja
provisioning_error	snöre	Om det finns ett etableringsfel för containern.	Nej.
provisioning_state	snöre	Containerns etableringstillstånd.	Ja
replicas	matris med ContainerReplica	Listan över repliker i containern.	Ja
state	snöre	Behållarens tillstånd.	Ja
updated_on	snöre	Den senaste uppdateringstiden för containern.	Ja

ContainerLogKind

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

Fastighet	Värde
Type	snöre
Värden	console system

ContainerReplica

Information om en containerreplik.

Namn	Typ	Description	Krävs	Förinställning
container_state	snöre	Containertillståndet för repliken.	Ja
name	snöre	Namnet på repliken.	Ja
state	snöre	Replikens tillstånd.	Ja

ContinuousEvaluationRuleAction

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

Namn	Typ	Description	Krävs	Förinställning
evalId	snöre	Eval-ID för att lägga till kontinuerliga utvärderingskörningar i.	Ja
maxHourlyRuns	integer	Maximalt antal utvärderingskörningar som tillåts per timme.	Nej.
typ	enum	Möjliga värden: continuousEvaluation	Ja

CosmosDBIndex

Definition av CosmosDB Vector Store-index

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	enum	Typ av index Möjliga värden: CosmosDBNoSqlVectorStore	Ja

CreateAgentFromManifestRequest

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
manifest_id	snöre	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	objekt	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.	Nej.
name	snöre	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	objekt	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

CreateAgentRequest

Namn	Typ	Description	Krävs	Förinställning
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
metadata	objekt	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.	Nej.
name	snöre	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

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
manifest_id	snöre	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	objekt	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.	Nej.
parameter_values	objekt	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

CreateAgentVersionRequest

Namn	Typ	Description	Krävs	Förinställning
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
metadata	objekt	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.	Nej.

SkapaUtvärderingsbegäran

Namn	Typ	Description	Krävs	Förinställning
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.	Nej.
name	snöre	Namnet på utvärderingen.	Nej.
egenskaper	objekt	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.	Nej.
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

Namn	Typ	Description	Krävs	Förinställning
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.	Nej.
name	snöre	Namnet på körningen.	Nej.
egenskaper	objekt	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.	Nej.

CredentialType

Typen av autentiseringsuppgifter som används av anslutningen

Fastighet	Värde
Beskrivning	Typen av autentiseringsuppgifter som används av anslutningen
Type	snöre
Värden	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Cron-baserad utlösare.

Namn	Typ	Description	Krävs	Förinställning
endTime	snöre	Sluttid för cron-schemat i ISO 8601-format.	Nej.
expression	snöre	Cron-uttryck som definierar schemafrekvensen.	Ja
startTime	snöre	Starttid för cron-schemat i ISO 8601-format.	Nej.
timeZone	snöre	Tidszon för cron-schemat.	Nej.	UTC
typ	enum	Möjliga värden: Cron	Ja

CustomCredential

Definition av anpassade autentiseringsuppgifter

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
Timmar	matris med heltal	Timmar för upprepningsschemat.	Ja
typ	enum	Typ av daglig upprepning. 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

Namn	Typ	Description	Krävs	Förinställning
schema	objekt	JSON-schemat för det övergripande objektet för körningen av datakällans objekt.	Ja
typ	snöre	Datakällans typdiskriminering.	Ja

DatasetType

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

Fastighet	Värde
Beskrivning	Räkna upp för att fastställa typen av data.
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
connectionName (på engelska)	snöre	Azure Storage Account-anslutningsnamnet. Krävs om startPendingUploadVersion inte anropades innan datauppsättningen skapades	Nej.
dataUri	snöre	URI för data (exempel) Begränsningar: minLength: 1, mönster: [a-zA-Z0-9_]	Ja
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
isReference	booleskt värde (skrivskyddat)	Indikerar om datasetet innehåller en referens till storage, eller om datasetet hanterar storage självt. Om det är sant tas inte underliggande data bort när datauppsättningsversionen tas bort	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	DatasetType	Räkna upp för att fastställa typen av data.	Ja

Veckodag

Dagar i veckan för upprepningsschema.

Fastighet	Värde
Beskrivning	Dagar i veckan för upprepningsschema.
Type	snöre
Värden	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Ett borttaget agentobjekt

Namn	Typ	Description	Krävs	Förinställning
borttagen	booleskt	Om agenten har tagits bort.	Ja
name	snöre	Namnet på agenten.	Ja
objekt	enum	Objekttypen. Alltid 'agent.deleted'. Möjliga värden: agent.deleted	Ja

DeleteAgentVersionResponse

Ett borttaget agentversionsobjekt

Namn	Typ	Description	Krävs	Förinställning
borttagen	booleskt	Om agenten har tagits bort.	Ja
name	snöre	Namnet på agenten.	Ja
objekt	enum	Objekttypen. Alltid "agent.version.deleted". Möjliga värden: agent.version.deleted	Ja
version	snöre	Agentens versionsidentifierare.	Ja

DeleteEvalResponse

Ett borttaget utvärderingsobjekt

Namn	Typ	Description	Krävs	Förinställning
borttagen	booleskt	Om evalen har tagits bort.	Ja
eval_id	snöre	id för eval.	Ja
objekt	enum	Objekttypen. Alltid "eval.deleted". Möjliga värden: eval.deleted	Ja

DeleteEvalRunResponse

Ett borttaget utvärderingskörningsobjekt.

Namn	Typ	Description	Krävs	Förinställning
borttagen	booleskt	Om evalen har tagits bort.	Nej.
objekt	enum	Objekttypen. Alltid "eval.deleted". Möjliga värden: eval.deleted	Nej.
run_id	snöre	id för eval.	Nej.

DeleteMemoryStoreResponse

Namn	Typ	Description	Krävs	Förinställning
borttagen	booleskt	Om minneslagret har tagits bort.	Ja
name	snöre	Namnet på minneslagret.	Ja
objekt	enum	Objekttypen. Alltid 'memory_store.deleted'. Möjliga värden: memory_store.deleted	Ja

DeleteResponseResult

Resultatet av en borttagningsåtgärd.

Namn	Typ	Description	Krävs	Förinställning
borttagen	enum	Returnera alltid sant Möjliga värden: True	Ja
Id-nummer	snöre	Åtgärds-ID:t.	Ja
objekt	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

Namn	Typ	Description	Krävs	Förinställning
name	sträng (skrivskyddad)	Namnet på distributionen	Ja
typ	DeploymentType		Ja

DeploymentType

Fastighet	Värde
Type	snöre
Värden	ModelDeployment

EntraIDCredentials

Definition av autentiseringsuppgifter för Entra-ID

Namn	Typ	Description	Krävs	Förinställning
typ	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

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när eval skapades.	Ja
skapad av	snöre	namnet på den person som skapade körningen.	Nej.
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-nummer	snöre	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		Nej.
name	snöre	Namnet på utvärderingen.	Ja
objekt	enum	Objekttypen. Möjliga värden: eval	Ja
egenskaper	objekt	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.	Nej.
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.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Identifieraren för den uppladdade CSV-filen.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
källa	EvalCsvFileIdSource	Representerar en referens till en uppladdad CSV-fil som används som källa för utvärderingsdata.	Ja
└– id	snöre	Identifieraren för den uppladdade CSV-filen.	Ja
└– typ	enum	Typen av källa, alltid file_id. Möjliga värden: file_id	Ja
typ	enum	Typen av datakälla, alltid csv. Möjliga värden: csv	Ja

EvalGraderAzureAIEvaluator

Namn	Typ	Description	Krävs	Förinställning
data_mapping	objekt	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	Nej.
evaluator_name	snöre	Namnet på utvärderaren.	Ja
evaluator_version	snöre	Utvärderarens version. Senaste versionen om den inte har angetts.	Nej.
initialization_parameters	objekt	Initieringsparametrarna för utvärderingen. Måste ha stöd för strukturerade utdata.	Nej.
name	snöre	Namnet på bedömaren.	Ja
typ	enum	Objekttypen, som alltid azure_ai_evaluatorär . Möjliga värden: azure_ai_evaluator	Ja

EvalResult

Resultat av utvärderingen.

Namn	Typ	Description	Krävs	Förinställning
name	snöre	Namn på kontrollen	Ja
Passerade	booleskt	Anger om kontrollen har godkänts eller misslyckats	Ja
poäng	Nummer	poäng	Ja
typ	snöre	Typ av kontroll	Ja

EvalRun

Ett schema som representerar en utvärderingskörning.

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades.	Ja
skapad av	snöre	namnet på den person som skapade körningen.	Nej.
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	snöre	Identifieraren för den associerade utvärderingen.	Ja
Id-nummer	snöre	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	snöre	Den modell som utvärderas, om tillämpligt.	Ja
modified_at	heltal		Nej.
name	snöre	Namnet på utvärderingskörningen.	Ja
objekt	enum	Typ av objekt. Alltid "eval.run". Möjliga värden: eval.run	Ja
per modellanvändning	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
egenskaper	objekt	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.	Nej.
report_url	snöre	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	snöre	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

Namn	Typ	Description	Krävs	Förinställning
typ	snöre	Datakällans typdiskriminering.	Ja

EvalRunOutputItem

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

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när utvärderingskörningen skapades.	Ja
datasource-objekt	objekt	Information om indatakällans objekt.	Ja
datakälla_objekt_id	OpenAI.integer		Ja
eval_id	snöre	Identifieraren för utvärderingsgruppen.	Ja
Id-nummer	snöre	Unik identifierare för output-objektet vid utvärderingskörningen.	Ja
objekt	enum	Typ av objekt. Alltid "eval.run.output_item". Möjliga värden: eval.run.output_item	Ja
results	matris med EvalRunOutputItemResult	En lista över graderresultat för det här utdataobjektet.	Ja
run_id	snöre	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	snöre		Ja
└– indata	matris med EvalRunOutputItemSampleInput		Ja
└– max_completion_tokens	OpenAI.integer		Ja
└– modell	snöre		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	snöre	Status för utvärderingskörningen.	Ja

EvalRunOutputItemResult

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

Namn	Typ	Description	Krävs	Förinställning
label	snöre	Etiketten som är associerad med testvillkorsmåttet (t.ex. "pass", "fail", "good", "bad").	Nej.
metric	snöre	Namnet på måttet (t.ex. "fluency", "f1_score").	Nej.
name	snöre	Namnet på bedömaren.	Ja
Passerade	booleskt	Om väghyveln ansåg att utdata var ett pass.	Ja
egenskaper	objekt	Ytterligare information om testvillkorsmåttet.	Nej.
reason	snöre	Orsaken till testvillkorsmåttet.	Nej.
exempel	objekt (nullbart)	Valfritt exempel eller mellanliggande data som genereras av väghyveln.	Nej.
poäng	OpenAI.numeric		Ja
threshold	Nummer	Tröskelvärdet som används för att fastställa pass/fail för det här testvillkoren, om det är numeriskt.	Nej.
typ	snöre	Typ av väghyvel (till exempel "string-check-grader").	Nej.

Det här objektet accepterar även ytterligare egenskaper.

EvalRunOutputItemSampleInput

Ett meddelande i utvärderingskörningen.

Namn	Typ	Description	Krävs	Förinställning
innehåll	snöre		Ja
None needed, as the translation is already accurate and fluent.	snöre		Ja
tool_calls	matris med CompletionMessageToolCallChunk	Eventuella verktygsanrop som görs i meddelandet.	Ja

EvalRunOutputItemSampleOutput

Ett meddelande i utvärderingskörningen.

Namn	Typ	Description	Krävs	Förinställning
innehåll	snöre		Nej.
None needed, as the translation is already accurate and fluent.	snöre		Nej.
tool_calls	matris med CompletionMessageToolCallChunk	Eventuella verktygsanrop som görs i meddelandet.	Ja

EvalRunResultCompareItem

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

Namn	Typ	Description	Krävs	Förinställning
deltaEstimate	Nummer	Uppskattad skillnad mellan behandling och baslinje.	Ja
pValue	Nummer	P-värde för behandlingseffekten.	Ja
treatmentEffect	TreatmentEffectType	Typ av behandlingseffekt.	Ja
treatmentRunId	snöre	Behandlingskörnings-ID.	Ja
treatmentRunSummary	EvalRunResultSummary	Sammanfattande statistik för ett mått i en utvärderingskörning.	Ja
└– genomsnitt	Nummer	Medelvärde för måttet i utvärderingskörningen.	Ja
└— runId	snöre	Utvärderingskörnings-ID:t.	Ja
└– sampleCount	integer	Antal prover i utvärderingskörningen.	Ja
└– standardAvvikelse	Nummer	Standardavvikelsen för måttet i utvärderingskörningen.	Ja

EvalRunResultComparison

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

Namn	Typ	Description	Krävs	Förinställning
baselineRunSummary	EvalRunResultSummary	Sammanfattande statistik för ett mått i en utvärderingskörning.	Ja
└– genomsnitt	Nummer	Medelvärde för måttet i utvärderingskörningen.	Ja
└— runId	snöre	Utvärderingskörnings-ID:t.	Ja
└– sampleCount	integer	Antal prover i utvärderingskörningen.	Ja
└– standardAvvikelse	Nummer	Standardavvikelsen för måttet i utvärderingskörningen.	Ja
compareItems	matris med EvalRunResultCompareItem	Lista över jämförelseresultat för varje behandlingsomgång.	Ja
Utvärderaren	snöre	Namn på utvärderaren för detta testkriterium.	Ja
metric	snöre	Mått som utvärderas.	Ja
testingCriteria	snöre	Namn på testkriterierna.	Ja

EvalRunResultSummary

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

Namn	Typ	Description	Krävs	Förinställning
genomsnitt	Nummer	Medelvärde för måttet i utvärderingskörningen.	Ja
runId	snöre	Utvärderingskörnings-ID:t.	Ja
sampleCount	integer	Antal prover i utvärderingskörningen.	Ja
standardDeviation	Nummer	Standardavvikelsen för måttet i utvärderingskörningen.	Ja

EvaluationComparisonInsightRequest

Begäran om utvärderingsjämförelse

Namn	Typ	Description	Krävs	Förinställning
baselineRunId	snöre	Baslinjekörnings-ID:t för jämförelse.	Ja
evalId	snöre	Identifierare för utvärderingen.	Ja
treatmentRunIds	strängmatris	Lista över behandlingskörnings-ID:t för jämförelse.	Ja
typ	enum	Typ av begäran. Möjliga värden: EvaluationComparison	Ja

EvaluationComparisonInsightResult

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

Namn	Typ	Description	Krävs	Förinställning
Jämförelser	matris med EvalRunResultComparison	Jämförelseresultat för varje behandling körs mot baslinjen.	Ja
method	snöre	Den statistiska metod som används för jämförelse.	Ja
typ	enum	Typen av insikter som resulterar. Möjliga värden: EvaluationComparison	Ja

EvaluationResultSample

Ett exempel från utvärderingsresultatet.

Namn	Typ	Description	Krävs	Förinställning
correlationInfo	objekt	Information om korrelationen för analysprovet.	Ja
evaluationResult	EvalResult	Resultat av utvärderingen.	Ja
└— namn	snöre	Namn på kontrollen	Ja
└– godkänd	booleskt	Anger om kontrollen har godkänts eller misslyckats	Ja
└– poäng	Nummer	poäng	Ja
└– typ	snöre	Typ av kontroll	Ja
features	objekt	Funktioner för att hjälpa till med ytterligare filtrering av data i UX.	Ja
Id-nummer	snöre	Den unika identifieraren för analysprovet.	Ja
typ	enum	Typ av utvärderingsresultat Möjliga värden: EvaluationResultSample	Ja

EvaluationRule (Utvärderingsregel)

Modell för utvärderingsregel.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	EvaluationRuleAction	Åtgärdsmodell för utvärdering.	Ja
└– typ	EvaluationRuleActionType	Typ av utvärderingsåtgärd.	Ja
beskrivning	snöre	Beskrivning av utvärderingsregeln.	Nej.
visningsnamn	snöre	Visningsnamn för utvärderingsregeln.	Nej.
aktiverad	booleskt	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.	Nej.
└– agentName	snöre	Filtrera efter handläggarens namn.	Ja
Id-nummer	sträng (skrivskyddad)	Unik identifierare för utvärderingsregeln.	Ja
systemData (på engelska)	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

Namn	Typ	Description	Krävs	Förinställning
typ	EvaluationRuleActionType	Typ av utvärderingsåtgärd.	Ja

EvaluationRuleActionType

Typ av utvärderingsåtgärd.

Fastighet	Värde
Beskrivning	Typ av utvärderingsåtgärd.
Type	snöre
Värden	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Typ av utvärderingsregelhändelse.

Fastighet	Värde
Beskrivning	Typ av utvärderingsregelhändelse.
Type	snöre
Värden	responseCompleted manual

EvaluationRuleFilter

Modell för utvärderingsfilter.

Namn	Typ	Description	Krävs	Förinställning
agentName (agentnamn)	snöre	Filtrera efter handläggarens namn.	Ja

EvaluationRunClusterInsightRequest

Insikter om uppsättningen av utvärderingsresultat

Namn	Typ	Description	Krävs	Förinställning
evalId	snöre	Utvärderings-ID för insikterna.	Ja
modelConfiguration	InsightModelConfiguration	Konfiguration av modellen som används i insiktsgenereringen.	Nej.
└– modelDeploymentName	snöre	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
typ	enum	Typ av begäran om insikter. Möjliga värden: EvaluationRunClusterInsight	Ja

EvaluationRunClusterInsightResult

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

Namn	Typ	Description	Krävs	Förinställning
clusterInsight	ClusterInsightResult	Insikter från klusteranalysen.	Ja
typ	enum	Typen av insikter som resulterar. Möjliga värden: EvaluationRunClusterInsight	Ja

EvaluationScheduleTask

Utvärderingsuppgift för schemat.

Namn	Typ	Description	Krävs	Förinställning
configuration	objekt	Konfiguration för uppgiften.	Nej.
evalId	snöre	Identifierare för utvärderingsgruppen.	Ja
evalRun	objekt	Nyttolasten för utvärderingskörningen.	Ja
typ	enum	Möjliga värden: Evaluation	Ja

EvaluationTaxonomy

Definition av taxonomi för utvärdering

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
egenskaper	objekt	Ytterligare egenskaper för utvärderingstaxonomin.	Nej.
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	Nej.
taxonomyInput	EvaluationTaxonomyInput	Indatakonfiguration för utvärderingstaxonomin.	Ja
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomin.	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

EvaluationTaxonomyCreateOrUpdate

Definition av taxonomi för utvärdering

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
egenskaper	objekt	Ytterligare egenskaper för utvärderingstaxonomin.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	Nej.
taxonomyInput	EvaluationTaxonomyInput	Indatakonfiguration för utvärderingstaxonomin.	Ja
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomin.	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

Namn	Typ	Description	Krävs	Förinställning
typ	EvaluationTaxonomyInputType	Typ av indata från utvärderingstaxonomin.	Ja

EvaluationTaxonomyInputType

Typ av indata från utvärderingstaxonomin.

Fastighet	Värde
Beskrivning	Typ av indata från utvärderingstaxonomin.
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
typ	EvaluationTaxonomyInputType	Typ av indata från utvärderingstaxonomin.	Ja

EvaluationTaxonomyUpdate

Definition av taxonomi för utvärdering

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
egenskaper	objekt	Ytterligare egenskaper för utvärderingstaxonomin.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
taxonomyCategories	matris med TaxonomyCategory	Lista över taxonomikategorier.	Nej.
taxonomyInput	EvaluationTaxonomyInputUpdate	Indatakonfiguration för utvärderingstaxonomin.	Nej.
└– typ	EvaluationTaxonomyInputType	Indatatyp för utvärderingstaxonomin.	Ja

EvaluatorCategory

Utvärderarens kategori

Fastighet	Värde
Beskrivning	Utvärderarens kategori
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
data_schema	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
init_parameters	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
metrics	objekt	Förteckning över utfallsmått som tagits fram av den här utvärderaren	Nej.
typ	EvaluatorDefinitionType	Definition av typ av utvärderare	Ja

EvaluatorDefinitionType

Definition av typ av utvärderare

Fastighet	Värde
Beskrivning	Definition av typ av utvärderare
Type	snöre
Värden	prompt code prompt_and_code service openai_graders

EvaluatorMetric

Utvärderare Metriska mått

Namn	Typ	Description	Krävs	Förinställning
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	Nej.
is_primary	booleskt	Anger om det här måttet är primärt när det finns flera mätvärden.	Nej.
max_value	Nummer	Maximalt värde för måttet. Om inget anges antas den vara obunden.	Nej.
min_value	Nummer	Minsta värde för måttet	Nej.
typ	EvaluatorMetricType	Typ av utvärderare	Nej.

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

Fastighet	Värde
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	snöre
Värden	increase decrease neutral

EvaluatorMetricType

Typ av utvärderare

Fastighet	Värde
Beskrivning	Typ av utvärderare
Type	snöre
Värden	ordinal continuous boolean

EvaluatorType

Typ av utvärderare

Fastighet	Värde
Beskrivning	Typ av utvärderare
Type	snöre
Värden	builtin custom

EvaluatorVersion

Definition av utvärderare

Namn	Typ	Description	Krävs	Förinställning
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	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
└– init_parameters	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
└– mått	objekt	Förteckning över utfallsmått som tagits fram av den här utvärderaren	Nej.
└– typ	EvaluatorDefinitionType	Definition av typ av utvärderare	Ja
display_name	snöre	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	Nej.
evaluator_type	EvaluatorType	Typ av utvärderare	Ja
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
metadata	objekt	Metadata om utvärderaren	Nej.
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

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

EvaluatorVersionUpdate

Definition av utvärderare

Namn	Typ	Description	Krävs	Förinställning
categories	matris med EvaluatorCategory	Utvärderarens kategorier	Nej.
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
display_name	snöre	Visningsnamn för utvärderaren. Det hjälper att enkelt hitta utvärderaren i AI Foundry. Det behöver inte vara unikt.	Nej.
metadata	objekt	Metadata om utvärderaren	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.

FabricDataAgentToolParameters

Parametrarna för verktyget för infrastrukturdataagenten.

Namn	Typ	Description	Krävs	Förinställning
project_connections	matris med ToolProjectConnection	Project-anslutningarna som är kopplade till detta verktyg. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget.	Nej.

FileDatasetVersion

FilDatasetVersionsdefinition

Namn	Typ	Description	Krävs	Förinställning
connectionName (på engelska)	snöre	Azure Storage Account-anslutningsnamnet. Krävs om startPendingUploadVersion inte anropades innan datauppsättningen skapades	Nej.
dataUri	snöre	URI för data (exempel) Begränsningar: minLength: 1, mönster: [a-zA-Z0-9_]	Ja
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
isReference	booleskt värde (skrivskyddat)	Indikerar om datasetet innehåller en referens till storage, eller om datasetet hanterar storage självt. Om det är sant tas inte underliggande data bort när datauppsättningsversionen tas bort	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
typ	enum	Datasettyp Möjliga värden: uri_file	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

FileDatasetVersionUpdate

FilDatasetVersionsdefinition

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	enum	Datasettyp Möjliga värden: uri_file	Ja

FolderDatasetVersion

FilDatasetVersionsdefinition

Namn	Typ	Description	Krävs	Förinställning
connectionName (på engelska)	snöre	Azure Storage Account-anslutningsnamnet. Krävs om startPendingUploadVersion inte anropades innan datauppsättningen skapades	Nej.
dataUri	snöre	URI för data (exempel) Begränsningar: minLength: 1, mönster: [a-zA-Z0-9_]	Ja
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
isReference	booleskt värde (skrivskyddat)	Indikerar om datasetet innehåller en referens till storage, eller om datasetet hanterar storage självt. Om det är sant tas inte underliggande data bort när datauppsättningsversionen tas bort	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
typ	enum	Datasettyp Möjliga värden: uri_folder	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

FolderDatasetVersionUpdate

FilDatasetVersionsdefinition

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	enum	Datasettyp Möjliga värden: uri_folder	Ja

FunctionToolCall

Information om ett funktionsverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	Argumenten för att anropa funktionen med, som genereras av modellen i JSON-format.	Ja
name	snöre	Namnet på funktionen som ska anropas.	Ja

HostedAgentDefinition

Definitionen av den värdbaserade agenten.

Namn	Typ	Description	Krävs	Förinställning
container_protocol_versions	matris med ProtocolVersionRecord	De protokoll som agenten stöder för inkommande kommunikation av containrarna.	Ja
cpu	snöre	CPU-konfigurationen för den värdbaserade agenten.	Ja
environment_variables	objekt	Miljövariabler som ska anges i den värdbaserade agentbehållaren.	Nej.
bild	snöre	Avbildnings-ID:t för agenten, som gäller för avbildningsbaserade värdbaserade agenter.	Nej.
typ	enum	Möjliga värden: hosted	Ja
memory	snöre	Minneskonfigurationen för den värdbaserade agenten.	Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
└– rai_policy_name	snöre	Namnet på den RAI-princip som ska tillämpas.	Ja
verktyg	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 .	Nej.

HourlyRecurrenceSchedule

Schema för upprepning per timme.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Möjliga värden: Hourly	Ja

HumanEvaluationPreviewRuleAction

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

Namn	Typ	Description	Krävs	Förinställning
templateId	AssetId	Identifierare för en sparad tillgång.	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
typ	IndexType		Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

IndexType

Fastighet	Värde
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	IndexType		Ja

Insikt

Svarstexten för klusterinsikter.

Namn	Typ	Description	Krävs	Förinställning
visningsnamn	snöre	Användarvänligt visningsnamn för insikten.	Ja
Id-nummer	sträng (skrivskyddad)	Den unika identifieraren för insiktsrapporten.	Ja
metadata	InsightsMetadata (skrivskyddad)	Metadata om insikterna.	Ja
└– slutfördAt	snöre	Tidsstämpeln när insikterna slutfördes.	Nej.
└– skapadAt	snöre	Tidsstämpeln när insikterna skapades.	Ja
begäran	InsightRequest	Begäran om insiktsrapporten.	Ja
└– typ	InsightType	Typ av begäran.	Ja
resultat	InsightResult (skrivskyddad)	Resultatet av insikterna.	Nej.
└– typ	InsightType	Typen av insikter som resulterar.	Ja
state	Azure. Core.Foundations.OperationState (skrivskyddat)	Uppräkning som beskriver tillåtna åtgärdstillstånd.	Ja

InsightCluster

Ett kluster av analysprover.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Beskrivning av analysklustret.	Ja
Id-nummer	snöre	ID:t för analysklustret.	Ja
label	snöre	Etikett för klustret	Ja
Prover	matris med InsightSample	Lista över exempel som tillhör det här klustret. Tom om exemplen är en del av underkluster.	Nej.
subClusters	matris med InsightCluster	Lista över underkluster i det här klustret. Töm om det inte finns några underkluster.	Nej.
förslag	snöre	Förslag för klustret	Ja
suggestionTitle	snöre	Titeln på förslaget för klustret	Ja
weight	integer	Vikten på analysklustret. Detta anger antalet exempel i klustret.	Ja

InsightModelConfiguration

Konfiguration av modellen som används i insiktsgenereringen.

Namn	Typ	Description	Krävs	Förinställning
modelDeploymentName	snöre	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

Namn	Typ	Description	Krävs	Förinställning
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	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

Namn	Typ	Description	Krävs	Förinställning
correlationInfo	objekt	Information om korrelationen för analysprovet.	Ja
features	objekt	Funktioner för att hjälpa till med ytterligare filtrering av data i UX.	Ja
Id-nummer	snöre	Den unika identifieraren för analysprovet.	Ja
typ	SampleType	Vilken typ av prov som används i analysen.	Ja

InsightScheduleTask

Insiktsuppgift för schemat.

Namn	Typ	Description	Krävs	Förinställning
configuration	objekt	Konfiguration för uppgiften.	Nej.
insikt	Insikt	Svarstexten för klusterinsikter.	Ja
└– displayName	snöre	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.	Nej.
└— tillstånd	Azure. Core.Foundations.OperationState (skrivskyddat)	Det aktuella tillståndet för insikterna.	Ja
typ	enum	Möjliga värden: Insight	Ja

InsightSummary

Sammanfattning av felklusteranalysen.

Namn	Typ	Description	Krävs	Förinställning
method	snöre	Metod som används för klustring.	Ja
sampleCount	integer	Totalt antal analyserade prover.	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.

Fastighet	Värde
Beskrivning	Begäran om insikter.
Type	snöre
Värden	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadata om insikterna.

Namn	Typ	Description	Krävs	Förinställning
completedAt	snöre	Tidsstämpeln när insikterna slutfördes.	Nej.
createdAt	snöre	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

Namn	Typ	Description	Krävs	Förinställning
typ	ItemGenerationParamsType	Typerna av parametrar för generering av röda teamobjekt.	Ja

ItemGenerationParamsType

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

Fastighet	Värde
Beskrivning	Typerna av parametrar för generering av röda teamobjekt.
Type	snöre
Värden	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Managed Azure AI Search Index Definition

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	sträng (skrivskyddad)	Tillgångs-ID, en unik identifierare för tillgången	Nej.
name	sträng (skrivskyddad)	Namnet på resursen	Ja
typ	enum	Typ av index Möjliga värden: ManagedAzureSearch	Ja
version	sträng (skrivskyddad)	Versionen av resursen	Ja

ManagedAzureAISearchIndexUpdate

Managed Azure AI Search Index Definition

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Texten för tillgångsbeskrivningen.	Nej.
Taggar	objekt	Taggordlista. Taggar kan läggas till, tas bort och uppdateras.	Nej.
typ	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

Namn	Typ	Description	Krävs	Förinställning
innehåll	snöre	Innehållet i minnet.	Ja
typ	MemoryItemKind	Typ av minnesobjekt.	Ja
memory_id	snöre	Det unika ID:t för minnesobjektet.	Ja
omfattning	snöre	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.

Fastighet	Värde
Beskrivning	Typ av minnesobjekt.
Type	snöre
Värden	user_profile chat_summary

MemoryOperation

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

Namn	Typ	Description	Krävs	Förinställning
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	snöre	Innehållet i minnet.	Ja
└– typ	MemoryItemKind	Typen av minnesobjekt.	Ja
└– memory_id	snöre	Det unika ID:t för minnesobjektet.	Ja
└– omfattning	snöre	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.

Fastighet	Värde
Beskrivning	Typ av minnesoperation.
Type	snöre
Värden	create update delete

MemorySearchItem

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

Namn	Typ	Description	Krävs	Förinställning
memory_item	MemoryItem	Ett enskilt minnesobjekt som lagras i minneslagret och som innehåller innehåll och metadata.	Ja
└– innehåll	snöre	Innehållet i minnet.	Ja
└– typ	MemoryItemKind	Typen av minnesobjekt.	Ja
└– memory_id	snöre	Det unika ID:t för minnesobjektet.	Ja
└– omfattning	snöre	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.

Namn	Typ	Description	Krävs	Förinställning
max_memories	integer	Maximalt antal minnesobjekt som ska returneras.	Nej.

MemorySearchPreviewTool

Ett verktyg för att integrera minnen i agenten.

Namn	Typ	Description	Krävs	Förinställning
memory_store_name	snöre	Namnet på det minneslager som ska användas.	Ja
omfattning	snöre	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.	Nej.
└max_memories	integer	Maximalt antal minnesobjekt som ska returneras.	Nej.
typ	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.	Nej.	300

MemorySearchToolCallItemParam

Namn	Typ	Description	Krävs	Förinställning
results	matris med MemorySearchItem	Resultaten som returneras från minnessökningen.	Nej.
typ	enum	Möjliga värden: memory_search_call	Ja

MemorySearchToolCallItemResource

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
response_id	snöre	Svaret som objektet skapas på.	Nej.
results	matris med MemorySearchItem	Resultaten som returneras från minnessökningen.	Nej.
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
typ	enum	Möjliga värden: memory_search_call	Ja

MemoryStoreDefaultDefinition

Standardimplementering av minneslager.

Namn	Typ	Description	Krävs	Förinställning
chat_model	snöre	Namnet eller identifieraren för distributionen av chattkompletteringsmodellen som används för minnesbearbetning.	Ja
embedding_model	snöre	Namnet eller identifieraren för inbäddningsmodelldistributionen 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.	Nej.
└– chat_summary_enabled	booleskt	Om man ska aktivera chatsammanfattning, extraktion och storage. Standardvärdet är sant.	Ja	Sann
└– user_profile_details	snöre	Specifika kategorier eller typer av användarprofilinformation som ska extraheras och lagras.	Nej.
└– user_profile_enabled	booleskt	Om man ska aktivera användarprofilutvinning och storage. Standardvärdet är sant.	Ja	Sann

MemoryStoreDefaultOptions

Standardkonfigurationer för minneslager.

Namn	Typ	Description	Krävs	Förinställning
chat_summary_enabled	booleskt	Om man ska aktivera chatsammanfattning, extraktion och storage. Standardvärdet är sant.	Ja	Sann
user_profile_details	snöre	Specifika kategorier eller typer av användarprofilinformation som ska extraheras och lagras.	Nej.
user_profile_enabled	booleskt	Om man ska aktivera användarprofilutvinning och storage. Standardvärdet är sant.	Ja	Sann

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

Namn	Typ	Description	Krävs	Förinstä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.

Namn	Typ	Description	Krävs	Förinställning
borttagen	booleskt	Om borttagningen lyckades.	Ja
name	snöre	Namnet på minneslagret.	Ja
objekt	enum	Objekttypen. Alltid "memory_store.scope.deleted". Möjliga värden: memory_store.scope.deleted	Ja
omfattning	snöre	Omfånget från vilket minnen raderades.	Ja

MemoryStoreKind

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

Fastighet	Värde
Beskrivning	Vilken typ av implementering av minneslager som ska användas.
Type	snöre
Värden	default

MemoryStoreObject

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

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (sekunder) när minneslagret skapades.	Ja
definitionen	MemoryStoreDefinition	Grundläggande definition för minneslagringskonfigurationer.	Ja
└– typ	MemoryStoreKind	Den typ av minneslagring.	Ja
beskrivning	snöre	En läsbar beskrivning av minneslagret. Begränsningar: maxLength: 512	Nej.
Id-nummer	snöre	Den unika identifieraren för minneslagret.	Ja
metadata	objekt	Godtyckliga nyckel/värde-metadata som ska associeras med minneslagret.	Nej.
name	snöre	Namnet på minneslagret. Begränsningar: maxLength: 256	Ja
objekt	enum	Objekttypen, som alltid är "memory_store". Möjliga värden: memory_store	Ja
updated_at	integer	Unix-tidsstämpeln (sekunder) när minneslagret senast uppdaterades.	Ja

MemoryStoreOperationUsage

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

Namn	Typ	Description	Krävs	Förinställning
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.

Namn	Typ	Description	Krävs	Förinställning
Minnen	matris med MemorySearchItem	Relaterade minnesobjekt som hittades under sökningen.	Ja
search_id	snöre	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.

Namn	Typ	Description	Krävs	Förinställning
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.

Namn	Typ	Description	Krävs	Förinställning
fel	OpenAI.Error		Nej.
└— additionalInfo	objekt		Nej.
└– kod	sträng (nullbar)		Ja
└– felsökningsinfo	objekt		Nej.
└— detaljer	matris med OpenAI.Error		Nej.
└– meddelande	snöre		Ja
└– param	sträng (nullbar)		Nej.
└– typ	snöre		Nej.
resultat	MemoryStoreUpdateCompletedResult	Resultat av minnesuppdatering.	Nej.
└– 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	snöre	Den update_id som åtgärden ersattes av när statusen är "ersatt".	Nej.
update_id	snöre	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.

Fastighet	Värde
Type	snöre
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.

Namn	Typ	Description	Krävs	Förinställning
fabric_dataagent_preview	FabricDataAgentToolParameters	Parametrarna för verktyget för infrastrukturdataagenten.	Ja
└– project_connections	matris med ToolProjectConnection	Project-anslutningarna som är kopplade till detta verktyg. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget. Begränsningar: maxItems: 1	Nej.
typ	enum	Objekttypen, som alltid är 'fabric_dataagent_preview'. Möjliga värden: fabric_dataagent_preview	Ja

ModelDeployment

Definition av modelldistribution

Namn	Typ	Description	Krävs	Förinställning
capabilities	objekt (skrivskyddat)	Funktioner för distribuerad modell	Ja
connectionName (på engelska)	sträng (skrivskyddad)	Namnet på den anslutning som distributionen kommer från	Nej.
modelName	sträng (skrivskyddad)	Publisher-specifikt namn på den implementerade modellen	Ja
modelPublisher	sträng (skrivskyddad)	Namnet på den implementerade modellens publisher	Ja
modellversion	sträng (skrivskyddad)	Publisher-specifik version av den implementerade modellen	Ja
name	sträng (skrivskyddad)	Namnet på distributionen	Ja
sku	Sku (skrivskyddad)	SKU-information	Ja
└— kapacitet	integer	SKU-kapacitet	Ja
└– familj	snöre	SKU-familj	Ja
└— namn	snöre	SKU-namn	Ja
└– storlek	snöre	SKU-storlek	Ja
└– nivå	snöre	SKU-nivå	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
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	Nummer	Temperaturparametern för sampling.	Ja
top_p	Nummer	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.

Namn	Typ	Description	Krävs	Förinställning
max_completion_tokens	integer	Det maximala antalet token som tillåts i slutförandet.	Nej.
seed	integer	Det slumpmässiga fröet för reproducerbarhet.	Nej.
temperatur	Nummer	Temperaturparametern för sampling.	Nej.
top_p	Nummer	Parametern top-p för kärnsampling.	Nej.

MonthlyRecurrenceSchedule

Månatligt upprepningsschema.

Namn	Typ	Description	Krävs	Förinställning
daysOfMonth	matris med heltal	Dagar i månaden för upprepningsschemat.	Ja
typ	enum	Typ av månatlig upprepning. Möjliga värden: Monthly	Ja

NoAuthenticationCredentials

Autentiseringsuppgifter som inte kräver autentisering

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
consent_link	snöre	Länken som användaren kan använda för att utföra OAuth-medgivande.	Ja
Id-nummer	snöre		Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
serveretikett	snöre	Serveretiketten för OAuth-medgivandebegäran.	Ja
typ	enum	Möjliga värden: oauth_consent_request	Ja

OneTimeTrigger

Utlösare en gång.

Namn	Typ	Description	Krävs	Förinställning
timeZone	snöre	Tidszon för engångsutlösaren.	Nej.	UTC
triggerAt	snöre	Datum och tid för engångsutlösaren i ISO 8601-format.	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.AnnotationType		Ja

OpenAI.AnnotationType

Fastighet	Värde
Type	snöre
Värden	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

Fastighet	Värde
Type	snöre
Värden	completed failed

OpenAI.ApplyPatchCallOutputStatusParam

Utfallsvärden rapporteras för apply_patch verktygssamtalsutdata.

Fastighet	Värde
Type	snöre
Värden	completed failed

OpenAI.ApplyPatchCallStatus

Fastighet	Värde
Type	snöre
Värden	in_progress completed

OpenAI.ApplyPatchCallStatusParam

Statusvärden rapporteras för apply_patch verktygsanrop.

Fastighet	Värde
Type	snöre
Värden	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

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

Namn	Typ	Description	Krävs	Förinställning
Diff	snöre	Diff som ska tillämpas.	Ja
path	snöre	Sökväg till filen som ska skapas.	Ja
typ	enum	Skapa en ny fil med det angivna diffet. Möjliga värden: create_file	Ja

OpenAI.ApplyPatchCreateFileOperationParam

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

Namn	Typ	Description	Krävs	Förinställning
Diff	snöre	Enhetligt diff-innehåll att tillämpa vid filskapande. Begränsningar: maxLength: 10485760	Ja
path	snöre	Sökväg för filen att skapa i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
path	snöre	Sökväg till filen som ska tas bort.	Ja
typ	enum	Ta bort den angivna filen. Möjliga värden: delete_file	Ja

OpenAI.ApplyPatchDeleteFileOperationParam

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

Namn	Typ	Description	Krävs	Förinställning
path	snöre	Sökväg för filen att ta bort i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ApplyPatchFileOperationType		Ja

OpenAI.ApplyPatchFileOperationType

Fastighet	Värde
Type	snöre
Värden	create_file delete_file update_file

OpenAI.ApplyPatchOperationParam

En av de create_file, delete_file eller update_file operationerna som tillförs 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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ApplyPatchOperationParamType		Ja

OpenAI.ApplyPatchOperationParamType

Fastighet	Värde
Type	snöre
Värden	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

Tillåter assistenten att skapa, radera eller uppdatera filer med enhetliga diffar.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
Diff	snöre	Diff som ska tillämpas.	Ja
path	snöre	Sökväg till filen som ska uppdateras.	Ja
typ	enum	Uppdatera en befintlig fil med det angivna diffet. Möjliga värden: update_file	Ja

OpenAI.ApplyPatchUpdateFileOperationParam

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

Namn	Typ	Description	Krävs	Förinställning
Diff	snöre	Enhetligt diff-innehåll att applicera på den befintliga filen. Begränsningar: maxLength: 10485760	Ja
path	snöre	Vägen för filen att uppdatera i förhållande till arbetsytans rot. Begränsningar: minLength: 1	Ja
typ	enum	Åtgärdstypen. Alltid update_file. Möjliga värden: update_file	Ja

OpenAI.UppskattadPlats

Namn	Typ	Description	Krävs	Förinställning
city	sträng (nullbar)		Nej.
country	sträng (nullbar)		Nej.
region	sträng (nullbar)		Nej.
timezone	sträng (nullbar)		Nej.
typ	enum	Typ av platsapproximation. Alltid approximate. Möjliga värden: approximate	Ja

OpenAI.ChatCompletionTool

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

Namn	Typ	Description	Krävs	Förinställning
function	OpenAI.FunctionObject		Ja
typ	enum	Verktygets typ. För närvarande stöds endast function. Möjliga värden: function	Ja

OpenAI.ChatModel

Fastighet	Värde
Type	snöre
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

Fastighet	Värde
Type	snöre
Värden	left right wheel back forward

OpenAI.ClickParam

En klickåtgärd.

Namn	Typ	Description	Krävs	Förinställning
knapp	OpenAI.ClickButtonType		Ja
typ	enum	Anger händelsetypen. För en klickåtgärd är denna egenskap 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å.

Namn	Typ	Description	Krävs	Förinställning
fil_identiteter	strängmatris	En valfri lista över uppladdade filer som ska vara tillgängliga för din kod.	Nej.
minnesgräns	OpenAI.ContainerMemoryLimit (nullbar)		Nej.
typ	enum	Alltid auto. Möjliga värden: auto	Ja

OpenAI.CodeInterpreterOutputImage

Bilden utdata från kodtolkaren.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Typ av utdata. Alltid image. Möjliga värden: image	Ja
URL	snöre	URL:en för bildens utdata från kodtolkaren.	Ja

OpenAI.CodeInterpreterOutputLogs

Loggarna utdata från kodtolkaren.

Namn	Typ	Description	Krävs	Förinställning
logs	snöre	Loggarna utdata från kodtolkaren.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
container	string eller OpenAI.CodeInterpreterContainerAuto	Behållaren för kodtolken. 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.	Nej.
typ	enum	Typ av kodtolkarverktyg. Alltid code_interpreter. Möjliga värden: code_interpreter	Ja

OpenAI.CompactResource

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpel (i sekunder) när den komprimerade konversationen skapades.	Ja
Id-nummer	snöre	Den unika identifieraren för det komprimerade svaret.	Ja
objekt	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

Namn	Typ	Description	Krävs	Förinställning
input	sträng eller matris med OpenAI.InputItem		Nej.
instructions	sträng (nullbar)		Nej.
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)		Nej.

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.

Namn	Typ	Description	Krävs	Förinställning
key	snöre	Nyckeln som ska jämföras med värdet.	Ja
typ	enum	Specificerar jämförelseoperatorn: eq, , ne, gtgte, lt, ltein, nin. - 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
värde	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.

Namn	Typ	Description	Krävs	Förinställning
filters	matris med OpenAI.ComparisonFilter eller objekt	Matris med filter som ska kombineras. Objekt kan vara ComparisonFilter eller CompoundFilter.	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ComputerActionType		Ja

OpenAI.ComputerActionType

Fastighet	Värde
Type	snöre
Värden	click double_click drag keypress move screenshot scroll type wait

OpenAI.ComputerCallSafetyCheckParam

En väntande säkerhetskontroll för datorsamtalet.

Namn	Typ	Description	Krävs	Förinställning
kod	sträng (nullbar)		Nej.
Id-nummer	snöre	ID för den väntande säkerhetskontrollen.	Ja
meddelande	sträng (nullbar)		Nej.

OpenAI.ComputerEnvironment

Fastighet	Värde
Type	snöre
Värden	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

En skärmbild av en dator.

Namn	Typ	Description	Krävs	Förinställning
file_id	sträng (nullbar)		Ja
image_url	snöre		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
file_id	snöre	Identifieraren för en uppladdad fil som innehåller skärmbilden.	Nej.
image_url	snöre	URL:en för skärmbilden.	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
skärmhöjd	OpenAI.integer		Ja
skärmbredd	OpenAI.integer		Ja
environment	OpenAI.ComputerEnvironment		Ja
typ	enum	Typ av datoranvändningsverktyg. Alltid computer_use_preview. Möjliga värden: computer_use_preview	Ja

OpenAI.ContainerFileCitationBody

En referens till en containerfil som används för att generera ett modellsvar.

Namn	Typ	Description	Krävs	Förinställning
container_id	snöre	ID:t för containerfilen.	Ja
end_index	OpenAI.integer		Ja
file_id	snöre	ID:t för filen.	Ja
filename	snöre	Filnamnet på containerfilen som angavs.	Ja
start_index	OpenAI.integer		Ja
typ	enum	Typen av containerarkivcitat. Alltid container_file_citation. Möjliga värden: container_file_citation	Ja

OpenAI.ContainerMemoryLimit

Fastighet	Värde
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ConversationItemType		Ja

OpenAI.ConversationItemApplyPatchToolCall

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktygsanropet.	Nej.
Id-nummer	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktyget anropar utdata.	Nej.
Id-nummer	snöre	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)		Nej.
status	OpenAI.ApplyPatchCallOutputStatus		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
kod	sträng (nullbar)		Ja
container_id	snöre	ID:t för containern som används för att köra koden.	Ja
Id-nummer	snöre	Det unika ID:t för kodtolkarverktygets anrop.	Ja
Utgångar	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är in_progress, completed, incomplete, interpretingoch failed. Möjliga värden: in_progress, completed, incomplete, , interpretingfailed	Ja
typ	enum	Typ av kodtolkarverktygsanrop. Alltid code_interpreter_call. Möjliga värden: code_interpreter_call	Ja

OpenAI.ConversationItemComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Se datorguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.ComputerAction		Ja
call_id	snöre	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
Id-nummer	snöre	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
typ	enum	Typ av datoranrop. Alltid computer_call. Möjliga värden: computer_call	Ja

OpenAI.ConversationItemComputerToolCallOutputResource

Namn	Typ	Description	Krävs	Förinställning
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De säkerhetskontroller som rapporterats av API:et och som har bekräftats av utvecklare.	Nej.
call_id	snöre	ID:t för datorverktygets anrop som genererade utdata.	Ja
Id-nummer	snöre	ID:t för datorverktyget anropar utdata.	Nej.
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	Nej.
typ	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 skapat av modellen.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	En identifierare som används för att mappa detta anpassade verktygsanrop till ett verktygsanropsutdata.	Ja
Id-nummer	snöre	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	Nej.
input	snöre	Indata för det anpassade verktygsanropet genereras av modellen.	Ja
name	snöre	Namnet på det anpassade verktyg som anropas.	Ja
typ	enum	Typen av det anpassade verktygsanropet. Alltid custom_tool_call. Möjliga värden: custom_tool_call	Ja

OpenAI.ConversationItemCustomToolCallOutput

Resultatet av ett anpassat verktygsanrop från din kod, som skickas tillbaka till modellen.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Anrops-ID:t, som används för att mappa detta anpassade verktygsanropsutdata till ett eget verktygsanrop.	Ja
Id-nummer	snöre	Det unika ID:t för det anpassade verktygsanropet ger utdata i OpenAI-plattformen.	Nej.
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Resultatet från det anpassade verktygsanropet som genereras av din kod. Det kan vara en sträng eller en lista med utdatainnehåll.	Ja
typ	enum	Typen av det anpassade verktyget anropar utdata. Alltid custom_tool_call_output. Möjliga värden: custom_tool_call_output	Ja

OpenAI.ConversationItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Se sökguiden fil för mer information.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	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		Nej.
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
typ	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ö.

Namn	Typ	Description	Krävs	Förinställning
å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	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktygsanropet.	Nej.
Id-nummer	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen.	Ja
skapad av	snöre	Identifieraren för aktören som skapade objektet.	Nej.
Id-nummer	snöre	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
typ	enum	Typ av gränssnittsanropets utdata. Alltid shell_call_output. Möjliga värden: shell_call_output	Ja

OpenAI.ConversationItemFunctionToolCallOutputResource

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för funktionsverktygets anropsresultat. Fylls i när det här objektet returneras via API.	Nej.
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från funktionsanropet som genereras av koden. Det kan vara en sträng eller en lista med 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	Nej.
typ	enum	Typen av utdata från funktionsverktygets anrop. Alltid function_call_output. Möjliga värden: function_call_output	Ja

OpenAI.ConversationItemFunctionToolCallResource

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för funktionsverktygets anrop.	Nej.
name	snöre	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	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för bildgenereringsanropet.	Ja
resultat	sträng (nullbar)		Ja
status	enum	Status för bildgenereringssamtalet. Möjliga värden: in_progress, completed, generating, failed	Ja
typ	enum	Typen av bildgenereringsanrop. Alltid image_generation_call. Möjliga värden: image_generation_call	Ja

OpenAI.ConversationItemList

En lista över konversationsobjekt.

Namn	Typ	Description	Krävs	Förinställning
data	matris med OpenAI.ConversationItem	En lista över konversationsobjekt.	Ja
first_id	snöre	ID för det första objektet i listan.	Ja
har_mer	booleskt	Om det finns fler tillgängliga objekt.	Ja
last_id	snöre	ID för det sista objektet i listan.	Ja
objekt	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.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för det lokala skalsamtalet.	Ja
status	enum	Status för det lokala skalsamtalet. Möjliga värden: in_progress, completed, incomplete	Ja
typ	enum	Typen av lokal skal-call. Alltid local_shell_call. Möjliga värden: local_shell_call	Ja

OpenAI.ConversationItemLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	snöre	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: in_progress, completed, incomplete	Nej.
typ	enum	Typen av lokal skalverktygsanropsutgång. 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.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argument för verktyget.	Ja
Id-nummer	snöre	Den unika identifieringen för godkännandebegäran.	Ja
name	snöre	Namnet på det verktyg som ska köras.	Ja
serveretikett	snöre	Etiketten på MCP-servern som skickar begäran.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	snöre	ID:t för godkännandebegäran som besvaras.	Ja
approve	booleskt	Om begäran godkändes.	Ja
Id-nummer	snöre	Det unika ID:t för godkännandesvaret	Ja
reason	sträng (nullbar)		Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Den unika ID:n på listan.	Ja
serveretikett	snöre	MCP-serverns etikett.	Ja
verktyg	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	sträng (nullbar)		Nej.
arguments	snöre	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Det unika ID:t för verktygsanropet.	Ja
name	snöre	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		Nej.
serveretikett	snöre	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		Nej.
typ	enum	Typ av objekt. Alltid mcp_call. Möjliga värden: mcp_call	Ja

OpenAI.ConversationItemMessage

Ett meddelande till eller från modellen.

Namn	Typ	Description	Krävs	Förinställning
innehåll	matris med OpenAI.MessageContent	Innehållet i meddelandet	Ja
Id-nummer	snöre	Det unika ID:t för meddelandet.	Ja
None needed, as the translation is already accurate and fluent.	OpenAI.MessageRole		Ja
status	OpenAI.MessageStatus		Ja
typ	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 din input till Responses API för kommande rundor i en konversation om du manuellt hanterar kontext.

Namn	Typ	Description	Krävs	Förinställning
innehåll	matris med OpenAI.ReasoningTextContent	Resonemang textinnehåll.	Nej.
encrypted_content	sträng (nullbar)		Nej.
Id-nummer	snöre	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	Nej.
summary	matris med OpenAI.Summary	Resonemang sammanfattningsinnehåll.	Ja
typ	enum	Typ av objekt. Alltid reasoning. Möjliga värden: reasoning	Ja

OpenAI.ConversationItemType

Fastighet	Värde
Type	snöre
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ökningsverktyg som anropas. Se webbsökningsguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtas i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, hitta).	Ja
Id-nummer	snöre	Det unika ID:t för webbsökverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: in_progress, searching, completed, failed	Ja
typ	enum	Typen av webbsökverktyget kallas. 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

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.

OpenAI.ConversationParam-2

Konversationen som det här svaret tillhör.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	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.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för konversationen som det här svaret var associerat med.	Ja

OpenAI.ConversationResource

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Tiden då konversationen skapades, mätt i sekunder sedan Unix-epoken.	Ja
Id-nummer	snöre	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
objekt	enum	Objekttypen, som alltid conversationär . 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 Structured Outputs. 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

Namn	Typ	Description	Krävs	Förinställning
typ	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 kommer att generera JSON utan ett system- eller användarmeddelande som instruerar den to do det.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Vilken typ av svarsformat som definieras. Alltid text. Möjliga värden: text	Ja

OpenAI.CreateChatCompletionRequestResponseFormatType

Fastighet	Värde
Type	snöre
Värden	text json_schema json_object

OpenAI.CreateConversationBody

Namn	Typ	Description	Krävs	Förinställning
items	matris med OpenAI.InputItem		Nej.
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.	Nej.

OpenAI.CreateEvalCompletionsRunDataSource

Ett CompletionsRunDataSource-objekt som beskriver en modellsamplingskonfiguration.

Namn	Typ	Description	Krävs	Förinställning
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.	Nej.
model	snöre	Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini").	Nej.
provtagning_parametrar	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		Nej.
källa	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
typ	enum	Typen av körningsdatakälla. Alltid completions. Möjliga värden: completions	Ja

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Namn	Typ	Description	Krävs	Förinställning
item_reference	snöre		Ja
typ	enum	Möjliga värden: item_reference	Ja

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Namn	Typ	Description	Krävs	Förinställning
mall	matris med OpenAI.EasyInputMessage eller OpenAI.EvalItem		Ja
typ	enum	Möjliga värden: template	Ja

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Namn	Typ	Description	Krävs	Förinställning
max_completion_tokens	OpenAI.integer		Nej.
resonemangsansträngning	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
svarsformat	OpenAI.ResponseFormatText eller OpenAI.ResponseFormatJsonSchema eller OpenAI.ResponseFormatJsonObject		Nej.
seed	OpenAI.integer		Nej.	42
temperatur	OpenAI.numeric		Nej.	1
verktyg	matris med OpenAI.ChatCompletionTool		Nej.
top_p	OpenAI.numeric		Nej.	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

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

OpenAI.CreateEvalJsonlRunDataSource

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

Namn	Typ	Description	Krävs	Förinställning
källa	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource	Avgör vad som fyller item namnområdet i datakällan.	Ja
typ	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.

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

OpenAI.CreateEvalResponsesRunDataSource

Ett ResponsesRunDataSource-objekt som beskriver en modellsamplingskonfiguration.

Namn	Typ	Description	Krävs	Förinställning
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.	Nej.
model	snöre	Namnet på den modell som ska användas för att generera slutföranden (t.ex. "o3-mini").	Nej.
provtagning_parametrar	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		Nej.
källa	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
typ	enum	Typen av körningsdatakälla. Alltid responses. Möjliga värden: responses	Ja

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Namn	Typ	Description	Krävs	Förinställning
item_reference	snöre		Ja
typ	enum	Möjliga värden: item_reference	Ja

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Namn	Typ	Description	Krävs	Förinställning
mall	matris med objekt eller OpenAI.EvalItem		Ja
typ	enum	Möjliga värden: template	Ja

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Namn	Typ	Description	Krävs	Förinställning
max_completion_tokens	OpenAI.integer		Nej.
resonemangsansträngning	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
seed	OpenAI.integer		Nej.	42
temperatur	OpenAI.numeric		Nej.	1
text	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		Nej.
verktyg	matris med OpenAI.Tool		Nej.
top_p	OpenAI.numeric		Nej.	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Namn	Typ	Description	Krävs	Förinstä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.	Nej.

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Inaktuell till förmån för LogsDataSourceConfig.

Namn	Typ	Description	Krävs	Förinställning
metadata	objekt	Metadatafilter för datakällan för lagrade slutföranden.	Nej.
typ	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

Namn	Typ	Description	Krävs	Förinställning
hyperparametrar	OpenAI.CreateFineTuningJobRequestHyperparameters		Nej.
└– batch_size	string eller OpenAI.integer		Nej.	bil
└– learning_rate_multiplier	string eller OpenAI.numeric		Nej.
└– n_epochs	string eller OpenAI.integer		Nej.	bil
Integrationer	matris med OpenAI.CreateFineTuningJobRequestIntegrations	En lista över integreringar som ska aktiveras för ditt finjusteringsjobb.	Nej.
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.	Nej.
method	OpenAI.FineTuneMethod	Metoden som används för finjustering.	Nej.
model	sträng (se giltiga modeller nedan)	Namnet på modellen som ska finjusteras. Du kan välja en av de stödda modeller.	Ja
seed	OpenAI.integer (nullbar)		Nej.
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	Nej.
utbildningsfil	snöre	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. Se guiden finjustering för mer information.	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ått regelbundet under finjustering. 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. Se guiden finjustering för mer information.	Nej.

OpenAI.CreateFineTuningJobRequestHyperparameters

Namn	Typ	Description	Krävs	Förinställning
batchstorlek	string eller OpenAI.integer		Nej.
inlärningshastighetsmultiplikator	string eller OpenAI.numeric		Nej.
antal epoker	string eller OpenAI.integer		Nej.

OpenAI.CreateFineTuningJobRequestIntegrations

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Möjliga värden: wandb	Ja
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Ja

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Namn	Typ	Description	Krävs	Förinställning
entitet	sträng (nullbar)		Nej.
name	sträng (nullbar)		Nej.
project	snöre		Ja
Taggar	strängmatris		Nej.

OpenAI.CreateResponseStreamingResponse

Typ: OpenAI.ResponseAudioDeltaEvent eller OpenAI.ResponseAudioTranscriptDeltaEvent eller OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent eller OpenAI.ResponseCodeInterpreterCallInProgressEvent eller OpenAI.ResponseCodeInterpreterCallInterpretingEvent eller OpenAI.ResponseContentPartAddedEvent eller OpenAI.ResponseCreatedEvent eller OpenAI.ResponseErrorEvent eller OpenAI.ResponseFileSearchCallInProgressEvent eller OpenAI.ResponseFileSearchCallSearchingEvent eller OpenAI.ResponseFunctionCallArgumentsDeltaEvent eller OpenAI.ResponseInProgressEvent eller OpenAI.ResponseFailedEvent eller OpenAI.ResponseIncompleteEvent eller OpenAI.ResponseOutputItemAddedEvent eller OpenAI.ResponseReasoningSummaryPartAddedEvent eller OpenAI.ResponseReasoningSummaryTextDeltaEvent eller OpenAI.ResponseReasoningTextDeltaEvent eller OpenAI.ResponseRefusalDeltaEvent eller OpenAI.ResponseTextDeltaEvent eller OpenAI.ResponseWebSearchCallInProgressEvent eller OpenAI.ResponseWebSearchCallSearchingEvent eller OpenAI.ResponseImageGenCallGeneratingEvent eller OpenAI.ResponseImageGenCallInProgressEvent eller OpenAI.ResponseImageGenCallPartialImageEvent eller OpenAI.ResponseMCPCallArgumentsDeltaEvent eller OpenAI.ResponseMCPCallFailedEvent eller OpenAI.ResponseMCPCallInProgressEvent eller OpenAI.ResponseMCPListToolsFailedEvent eller OpenAI.ResponseMCPListToolsInProgressEvent eller OpenAI.ResponseOutputTextAnnotationAddedEvent eller OpenAI.ResponseQueuedEvent eller OpenAI.ResponseCustomToolCallInputDeltaEvent eller OpenAI.ResponseAudioDoneEvent eller OpenAI.ResponseAudioTranscriptDoneEvent eller OpenAI.ResponseCodeInterpreterCallCodeDoneEvent eller OpenAI.ResponseCodeInterpreterCallCompletedEvent eller OpenAI.ResponseCompletedEvent eller OpenAI.ResponseContentPartDoneEvent eller OpenAI.ResponseFileSearchCallCompletedEvent eller OpenAI.ResponseFunctionCallArgumentsDoneEvent eller OpenAI.ResponseOutputItemDoneEvent eller OpenAI.ResponseReasoningSummaryPartDoneEvent eller OpenAI.ResponseReasoningSummaryTextDoneEvent eller OpenAI.ResponseReasoningTextDoneEvent eller OpenAI.ResponseRefusalDoneEvent eller OpenAI..ResponseTextDoneEvent eller OpenAI.ResponseWebSearchCallCompletedEvent eller OpenAI.ResponseImageGenCallCompletedEvent eller OpenAI.ResponseMCPCallArgumentsDoneEvent eller OpenAI.ResponseMCPCallCompletedEvent eller OpenAI.ResponseMCPListToolsCompletedEvent eller OpenAI.ResponseCustomToolCallInputDoneEvent

OpenAI.CustomGrammarFormatParam

En grammatik definierad av användaren.

Namn	Typ	Description	Krävs	Förinställning
definitionen	snöre	Grammatikdefinitionen.	Ja
syntax	OpenAI.GrammarSyntax1		Ja
typ	enum	Grammatikformat. Alltid grammar. Möjliga värden: grammar	Ja

OpenAI.CustomTextFormatParam

Obegränsad fri text.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Obegränsat textformat. Alltid text. Möjliga värden: text	Ja

OpenAI.CustomToolParam

Ett anpassat verktyg som bearbetar indata med ett specificerat format. Läs mer om anpassade verktyg

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Valfri beskrivning av det anpassade verktyget, som används för att ge mer kontext.	Nej.
format	OpenAI.CustomToolParamFormat	Inmatningsformatet för det anpassade verktyget. Standard är obegränsad text.	Nej.
└– typ	OpenAI.CustomToolParamFormatType		Ja
name	snöre	Namnet på det anpassade verktyget, som används för att identifiera det i verktygsanrop.	Ja
typ	enum	Typen av det anpassade verktyget. Alltid custom. Möjliga värden: custom	Ja

OpenAI.CustomToolParamFormat

Inmatningsformatet för det anpassade verktyget. Standard är obegränsad 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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.CustomToolParamFormatType		Ja

OpenAI.CustomToolParamFormatType

Fastighet	Värde
Type	snöre
Värden	text grammar

OpenAI.DeletedConversationResource

Namn	Typ	Description	Krävs	Förinställning
borttagen	booleskt		Ja
Id-nummer	snöre		Ja
objekt	enum	Möjliga värden: conversation.deleted	Ja

OpenAI.DetailEnum

Fastighet	Värde
Type	snöre
Värden	low high auto

OpenAI.DoubleClickAction

En dubbelklicksåtgärd.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinstä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
typ	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 }.

Namn	Typ	Description	Krävs	Förinstä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.

Namn	Typ	Description	Krävs	Förinställning
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
None needed, as the translation is already accurate and fluent.	enum	Rollen för meddelandets inmatning. En av user, assistant, systemeller developer. Möjliga värden: user, assistant, system, developer	Ja
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	Nej.
typ	enum	Typ av meddelandeindata. Alltid message. Möjliga värden: message	Ja

OpenAI.Error

Namn	Typ	Description	Krävs	Förinställning
ytterligareInformation	objekt		Nej.
kod	sträng (nullbar)		Ja
debugInfo	objekt		Nej.
details	matris med OpenAI.Error		Nej.
meddelande	snöre		Ja
Param	sträng (nullbar)		Nej.
typ	snöre		Nej.

OpenAI.EvalApiError

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

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

OpenAI.EvalGraderLabelModel

Namn	Typ	Description	Krävs	Förinställning
input	matris med OpenAI.EvalItem		Ja
labels	strängmatris	Etiketterna som ska tilldelas till varje objekt i utvärderingen.	Ja
model	snöre	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	Ja
name	snöre	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
typ	enum	Objekttypen, som alltid label_modelär . Möjliga värden: label_model	Ja

OpenAI.EvalGraderPython

Namn	Typ	Description	Krävs	Förinställning
image_tag	snöre	Avbildningstaggen som ska användas för Python-skriptet.	Nej.
name	snöre	Namnet på bedömaren.	Ja
passera gränsvärde	OpenAI.numeric		Nej.
källa	snöre	Källkoden för Python-skriptet.	Ja
typ	enum	Objekttypen, som alltid pythonär . Möjliga värden: python	Ja

OpenAI.EvalGraderScoreModel

Namn	Typ	Description	Krävs	Förinstä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	snöre	Den modell som ska användas för utvärderingen.	Ja
name	snöre	Namnet på bedömaren.	Ja
passera gränsvärde	OpenAI.numeric		Nej.
range	matris med OpenAI.numeric	Poängintervallet. Standardinställningen är [0, 1].	Nej.
provtagning_parametrar	OpenAI.EvalGraderScoreModelSamplingParams		Nej.
└– max_completions_tokens	OpenAI.integer (nullbar)		Nej.
└– reasoning_effort	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
└– frö	OpenAI.integer (nullbar)		Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
typ	enum	Objekttypen, som alltid score_modelär . Möjliga värden: score_model	Ja

OpenAI.EvalGraderScoreModelSamplingParams

Namn	Typ	Description	Krävs	Förinställning
max_completions_tokens	OpenAI.integer (nullbar)		Nej.
resonemangsansträngning	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
seed	OpenAI.integer (nullbar)		Nej.
temperatur	OpenAI.numeric (nullbar)		Nej.
top_p	OpenAI.numeric (nullbar)		Nej.	1

OpenAI.EvalGraderStringCheck

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

OpenAI.EvalGraderTextSimilarity

Namn	Typ	Description	Krävs	Förinställning
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	snöre	Texten som bedöms.	Ja
name	snöre	Namnet på bedömaren.	Ja
passera gränsvärde	OpenAI.numeric		Ja
hänvisning	snöre	Texten som betygsätts och jämförs med.	Ja
typ	enum	Typ av väghyvel. Möjliga värden: text_similarity	Ja

OpenAI.EvalItem

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

Namn	Typ	Description	Krävs	Förinställning
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
None needed, as the translation is already accurate and fluent.	enum	Rollen för meddelandets inmatning. En av user, assistant, systemeller developer. Möjliga värden: user, assistant, system, developer	Ja
typ	enum	Typ av meddelandeindata. Alltid message. Möjliga värden: message	Nej.

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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.EvalItemContentItemObjectType		Ja

OpenAI.EvalItemContentItemObjectInputTextContent

En textinmatning till modellen.

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

OpenAI.EvalItemContentItemObjectType

Fastighet	Värde
Type	snöre
Värden	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

En textutgång från modellen.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	Textutdata från modellen.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
detail	snöre	Detaljnivån för bilden som ska skickas till modellen. En av high, loweller auto. Standardinställningen är auto.	Nej.
image_url	snöre	URL:en för bildens indata.	Ja
typ	enum	Typ av bildindata. Alltid input_image. Möjliga värden: input_image	Ja

OpenAI.EvalJsonlFileContentSource

Namn	Typ	Description	Krävs	Förinställning
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

OpenAI.EvalJsonlFileContentSourceContent

Namn	Typ	Description	Krävs	Förinställning
item	objekt		Ja
exempel	objekt		Nej.

OpenAI.EvalJsonlFileIdSource

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

OpenAI.EvalResponsesSource

Ett EvalResponsesSource-objekt som beskriver en konfiguration av datakällan som körs.

Namn	Typ	Description	Krävs	Förinställning
skapad_efter	OpenAI.integer (nullbar)		Nej.
skapat_före	OpenAI.integer (nullbar)		Nej.
instructions_search	sträng (nullbar)		Nej.
metadata	objekt (nullbart)		Nej.
model	sträng (nullbar)		Nej.
resonemangsansträngning	OpenAI.ReasoningEffort (nullbar)	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
temperatur	OpenAI.numeric (nullbar)		Nej.
verktyg	strängmatris		Nej.
top_p	OpenAI.numeric (nullbar)		Nej.
typ	enum	Typen av körningsdatakälla. Alltid responses. Möjliga värden: responses	Ja
users	strängmatris		Nej.

OpenAI.EvalRunOutputItemSample

Namn	Typ	Description	Krävs	Förinställning
fel	OpenAI.EvalApiError	Ett objekt som representerar ett felsvar från Eval-API:et.	Ja
avslutningsorsak	snöre		Ja
input	matris med EvalRunOutputItemSampleInput		Ja
max_completion_tokens	OpenAI.integer		Ja
model	snöre		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

Namn	Typ	Description	Krävs	Förinställning
cached_tokens	OpenAI.integer		Ja
completion_tokens	OpenAI.integer		Ja
prompt_tokens	OpenAI.integer		Ja
total_tokens	OpenAI.integer		Ja

OpenAI.EvalRunPerModelUsage

Namn	Typ	Description	Krävs	Förinställning
cached_tokens	OpenAI.integer		Ja
completion_tokens	OpenAI.integer		Ja
invocation_count	OpenAI.integer		Ja
model_name	snöre		Ja
prompt_tokens	OpenAI.integer		Ja
total_tokens	OpenAI.integer		Ja

OpenAI.EvalRunPerTestingCriteriaResults

Namn	Typ	Description	Krävs	Förinställning
Misslyckades	OpenAI.integer		Ja
Passerade	OpenAI.integer		Ja
testkriterier	snöre		Ja

OpenAI.EvalRunResultCounts

Namn	Typ	Description	Krävs	Förinställning
fel	OpenAI.integer		Ja
Misslyckades	OpenAI.integer		Ja
Passerade	OpenAI.integer		Ja
summa	OpenAI.integer		Ja

OpenAI.EvalStoredCompletionsSource

En StoredCompletionsRunDataSource-konfiguration som beskriver en uppsättning filter

Namn	Typ	Description	Krävs	Förinställning
skapad_efter	OpenAI.integer (nullbar)		Nej.
skapat_före	OpenAI.integer (nullbar)		Nej.
limit	OpenAI.integer (nullbar)		Nej.
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.	Nej.
model	sträng (nullbar)		Nej.
typ	enum	Typ av källa. Alltid stored_completions. Möjliga värden: stored_completions	Ja

OpenAI.FileCitationBody

En källhänvisning till en fil.

Namn	Typ	Description	Krävs	Förinställning
file_id	snöre	ID:t för filen.	Ja
filename	snöre	Filnamnet för den citerade filen.	Ja
index	OpenAI.integer		Ja
typ	enum	Filreferenstyp. Alltid file_citation. Möjliga värden: file_citation	Ja

OpenAI.FilePath

En sökväg till en fil.

Namn	Typ	Description	Krävs	Förinställning
file_id	snöre	ID:t för filen.	Ja
index	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
filters	OpenAI.Filters (nullbar)		Nej.
maximalt antal resultat	OpenAI.integer		Nej.
rankingalternativ	OpenAI.RankingOptions		Nej.
└– hybrid_search	OpenAI.HybridSearchOptions	Vikter som styr hur reciprok rankfusion balanserar semantiska inbäddningsmatchningar jämfört med glesa nyckelordsmatchningar när hybridsökning är aktiverad.	Nej.
└— ranker	OpenAI.RankerVersionType	Rangordningen som ska användas för filsökningen.	Nej.
└– 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.	Nej.
typ	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

Namn	Typ	Description	Krävs	Förinställning
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.	Nej.
file_id	snöre		Nej.
filename	snöre		Nej.
poäng	Nummer		Nej.
text	snöre		Nej.

OpenAI.Filters

Typ: OpenAI.ComparisonFilter eller OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

De hyperparametrar som används för DPO-finjusteringsjobbet.

Namn	Typ	Description	Krävs	Förinställning
batchstorlek	string eller OpenAI.integer	Antal exempel i varje batch. En större batchstorlek innebär att modellparametrar uppdateras mer sällan, men med lägre varians.	Nej.
beta	string eller OpenAI.numeric	Betavärdet för DPO-metoden. Ett högre betavärde ökar straffvikten mellan principen och referensmodellen.	Nej.
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	Skalningsfaktor för inlärningsfrekvensen. En mindre inlärningshastighet kan vara användbar för att undvika överanpassning.	Nej.
antal epoker	string eller OpenAI.integer	Antalet epoker som modellen ska tränas i. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	Nej.

OpenAI.FineTuneDPOMethod

Konfiguration för DPO-finjusteringsmetoden.

Namn	Typ	Description	Krävs	Förinställning
hyperparametrar	OpenAI.FineTuneDPOHyperparameters	De hyperparametrar som används för DPO-finjusteringsjobbet.	Nej.

OpenAI.FineTuneMethod

Metoden som används för finjustering.

Namn	Typ	Description	Krävs	Förinställning
dpo	OpenAI.FineTuneDPOMethod	Konfiguration för DPO-finjusteringsmetoden.	Nej.
förstärkning	OpenAI.FineTuneReinforcementMethod	Konfiguration för finjusteringsmetoden för förstärkning.	Nej.
Övervakas	OpenAI.FineTuneSupervisedMethod	Konfiguration för den övervakade finjusteringsmetoden.	Nej.
typ	enum	Typ av metod. Är antingen supervised, dpoeller reinforcement. Möjliga värden: supervised, dpo, reinforcement	Ja

OpenAI.FineTuneReinforcementHyperparameters

De hyperparametrar som används för finjusteringsjobbet för förstärkning.

Namn	Typ	Description	Krävs	Förinställning
batchstorlek	string eller OpenAI.integer	Antal exempel i varje batch. En större batchstorlek innebär att modellparametrar uppdateras mer sällan, men med lägre varians.	Nej.
compute_multiplier	string eller OpenAI.numeric	Multiplikator på mängden beräkning som används för att utforska sökutrymme under träning.	Nej.
eval_interval	string eller OpenAI.integer	Antalet träningssteg mellan utvärderingskörningar.	Nej.
eval_samples	string eller OpenAI.integer	Antal utvärderingsexempel som ska genereras per träningssteg.	Nej.
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	Skalningsfaktor för inlärningsfrekvensen. En mindre inlärningshastighet kan vara användbar för att undvika överanpassning.	Nej.
antal epoker	string eller OpenAI.integer	Antalet epoker som modellen ska tränas i. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	Nej.
resonemangsansträngning	enum	Nivå av resonemangsarbete. Möjliga värden: default, low, medium, high	Nej.

OpenAI.FineTuneReinforcementMethod

Konfiguration för finjusteringsmetoden för förstärkning.

Namn	Typ	Description	Krävs	Förinställning
väghyvel	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 för förstärkning.	Nej.

OpenAI.FineTuneSupervisedHyperparameters

De hyperparametrar som används för finjusteringsjobbet.

Namn	Typ	Description	Krävs	Förinställning
batchstorlek	string eller OpenAI.integer	Antal exempel i varje batch. En större batchstorlek innebär att modellparametrar uppdateras mer sällan, men med lägre varians.	Nej.
inlärningshastighetsmultiplikator	string eller OpenAI.numeric	Skalningsfaktor för inlärningsfrekvensen. En mindre inlärningshastighet kan vara användbar för att undvika överanpassning.	Nej.
antal epoker	string eller OpenAI.integer	Antalet epoker som modellen ska tränas i. En epok refererar till en fullständig cykel genom träningsdatauppsättningen.	Nej.

OpenAI.FineTuneSupervisedMethod

Konfiguration för den övervakade finjusteringsmetoden.

Namn	Typ	Description	Krävs	Förinställning
hyperparametrar	OpenAI.FineTuneSupervisedHyperparameters	De hyperparametrar som används för finjusteringsjobbet.	Nej.

OpenAI.FineTuningIntegration

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Vilken typ av integrering som aktiveras för finjusteringsjobbet Möjliga värden: wandb	Ja
wandb	OpenAI.FineTuningIntegrationWandb		Ja
└— entitet	sträng (nullbar)		Nej.
└— namn	sträng (nullbar)		Nej.
└─ Project	snöre		Ja
└– taggar	strängmatris		Nej.

OpenAI.FineTuningIntegrationWandb

Namn	Typ	Description	Krävs	Förinställning
entitet	sträng (nullbar)		Nej.
name	sträng (nullbar)		Nej.
project	snöre		Ja
Taggar	strängmatris		Nej.

OpenAI.FineTuningJob

Objektet fine_tuning.job representerar ett finjusteringsjobb som har skapats via API:et.

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet skapades.	Ja
fel	OpenAI.FineTuningJobError (nullable)		Ja
└– kod	snöre		Ja
└– meddelande	snöre		Ja
└– param	sträng (nullbar)		Ja
beräknad avslutning	integer		Nej.
fine_tuned_model	sträng (nullbar)		Ja
avslutad_vid	integer		Ja
hyperparametrar	OpenAI.FineTuningJobHyperparameters		Ja
└– batch_size	string eller OpenAI.integer		Nej.	bil
└– learning_rate_multiplier	string eller OpenAI.numeric		Nej.
└– n_epochs	string eller OpenAI.integer		Nej.	bil
Id-nummer	snöre	Objektidentifieraren, som kan refereras till i API-slutpunkterna.	Ja
Integrationer	matris med OpenAI.FineTuningIntegration		Nej.
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.	Nej.
method	OpenAI.FineTuneMethod	Metoden som används för finjustering.	Nej.
model	snöre	Basmodellen som finjusteras.	Ja
objekt	enum	Objekttypen, som alltid är "fine_tuning.job". Möjliga värden: fine_tuning.job	Ja
organization_id	snöre	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, failedeller cancelled. Möjliga värden: validating_files, queued, running, succeeded, , failedcancelled	Ja
tränade_token	OpenAI.integer (nullbar)		Ja
utbildningsfil	snöre	Det fil-ID som används för träning. 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.

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när kontrollpunkten skapades.	Ja
Fintjusterad modellkontrollpunkt	snöre	Namnet på den finjusterade kontrollpunktsmodellen som skapas.	Ja
finjusteringsjobb_id	snöre	Namnet på det finjusteringsjobb från vilket denna kontrollpunkt skapades.	Ja
Id-nummer	snöre	Kontrollpunktsidentifieraren, som kan refereras till i API-slutpunkterna.	Ja
metrics	OpenAI.FineTuningJobCheckpointMetrics		Ja
└– full_valid_loss	OpenAI.numeric		Nej.
└– full_valid_mean_token_accuracy	OpenAI.numeric		Nej.
└– steg	OpenAI.numeric		Nej.
└– train_loss	OpenAI.numeric		Nej.
└– train_mean_token_accuracy	OpenAI.numeric		Nej.
└– valid_loss	OpenAI.numeric		Nej.
└– valid_mean_token_accuracy	OpenAI.numeric		Nej.
objekt	enum	Objekttypen, som alltid är "fine_tuning.job.checkpoint". Möjliga värden: fine_tuning.job.checkpoint	Ja
stegnummer	OpenAI.integer		Ja

OpenAI.FineTuningJobCheckpointMetrics

Namn	Typ	Description	Krävs	Förinställning
full_valid_loss	OpenAI.numeric		Nej.
full_valid_mean_token_accuracy	OpenAI.numeric		Nej.
steg	OpenAI.numeric		Nej.
train_loss	OpenAI.numeric		Nej.
train_mean_token_accuracy	OpenAI.numeric		Nej.
valid_loss	OpenAI.numeric		Nej.
valid_mean_token_accuracy	OpenAI.numeric		Nej.

OpenAI.FineTuningJobError

Namn	Typ	Description	Krävs	Förinställning
kod	snöre		Ja
meddelande	snöre		Ja
Param	sträng (nullbar)		Ja

OpenAI.FineTuningJobEvent

Finjustera jobbhändelseobjekt

Namn	Typ	Description	Krävs	Förinställning
skapad_tid	integer	Unix-tidsstämpeln (i sekunder) för när finjusteringsjobbet skapades.	Ja
data	OpenAI.FineTuningJobEventData		Nej.
Id-nummer	snöre	Objektidentifieraren.	Ja
nivå	enum	Loggnivån för händelsen. Möjliga värden: info, warn, error	Ja
meddelande	snöre	Meddelandet om händelsen.	Ja
objekt	enum	Objekttypen, som alltid är "fine_tuning.job.event". Möjliga värden: fine_tuning.job.event	Ja
typ	enum	Typ av händelse. Möjliga värden: message, metrics	Nej.

OpenAI.FineTuningJobEventData

Typ: objekt

OpenAI.FineTuningJobHyperparameters

Namn	Typ	Description	Krävs	Förinställning
batchstorlek	string eller OpenAI.integer		Nej.
inlärningshastighetsmultiplikator	string eller OpenAI.numeric		Nej.
antal epoker	string eller OpenAI.integer		Nej.

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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.FunctionAndCustomToolCallOutputType		Ja

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

En filinmatning till modellen.

Namn	Typ	Description	Krävs	Förinställning
file_data	snöre	Innehållet i filen som ska skickas till modellen.	Nej.
file_id	sträng (nullbar)		Nej.
file_url	snöre	URL:en till filen som ska skickas till modellen.	Nej.
filename	snöre	Namnet på filen som ska skickas till modellen.	Nej.
typ	enum	Typ av indataobjekt. Alltid input_file. Möjliga värden: input_file	Ja

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

En bildinmatning till modellen. Lär dig om bildingångar.

Namn	Typ	Description	Krävs	Förinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		Nej.
image_url	snöre		Nej.
typ	enum	Typ av indataobjekt. Alltid input_image. Möjliga värden: input_image	Ja

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

En textinmatning till modellen.

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

OpenAI.FunctionAndCustomToolCallOutputType

Fastighet	Värde
Type	snöre
Värden	input_text input_image input_file

OpenAI.FunctionCallItemStatus

Fastighet	Värde
Type	snöre
Värden	in_progress completed incomplete

OpenAI.FunctionObject

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej.
name	snöre	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
parametrar	OpenAI.FunctionParameters	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel, och JSON Schema reference för dokumentation om formatet. Om du utelämnar parameters definieras en funktion med en tom parameterlista.	Nej.
strict	boolesk (nullbar)		Nej.

OpenAI.FunctionParameters

Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt. Se guiden för exempel, och JSON Schema reference 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.

Namn	Typ	Description	Krävs	Förinställning
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 man kör shell-verktygsanropet.

Namn	Typ	Description	Krävs	Förinställning
commands	strängmatris	Beställde shell-kommandon för att exekveringsmiljön ska köras.	Ja
max_output_length	OpenAI.integer (nullbar)		Nej.
timeout_ms (timeout i millisekunder)	OpenAI.integer (nullbar)		Nej.

OpenAI.FunctionShellCallItemStatus

Statusvärden rapporteras för skalverktygsanrop.

Fastighet	Värde
Type	snöre
Värden	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

Innehållet i ett gränssnittsverktyg anropar utdata som har genererats.

Namn	Typ	Description	Krävs	Förinställning
skapad av	snöre	Identifieraren för aktören som skapade objektet.	Nej.
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	snöre	Standardfelutdata som hämtades.	Ja
stdout	snöre	Standardutdata som hämtades.	Ja

OpenAI.FunctionShellCallOutputContentParam

Fångade stdout och stderr för en del av ett skalverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
utfall	OpenAI.FunctionShellCallOutputOutcomeParam	Utgången eller timeout-resultatet av detta shell-call.	Ja
└– typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja
Stderr	snöre	Fångade Stderr-utgången för granatanropet. Begränsningar: maxLength: 10485760	Ja
stdout	snöre	Fångade stdout-utgången för granatsamtalet. Begränsningar: maxLength: 10485760	Ja

OpenAI.FunctionShellCallOutputExitOutcome

Indikerar att skalkommandona avslutades och returnerade en avslutningskod.

Namn	Typ	Description	Krävs	Förinställning
exit_code	OpenAI.integer		Ja
typ	enum	Resultattypen. Alltid exit. Möjliga värden: exit	Ja

OpenAI.FunctionShellCallOutputExitOutcomeParam

Indikerar att skalkommandona avslutades och returnerade en avslutningskod.

Namn	Typ	Description	Krävs	Förinställning
exit_code	OpenAI.integer		Ja
typ	enum	Resultattypen. 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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.FunctionShellCallOutputOutcomeType		Ja

OpenAI.FunctionShellCallOutputOutcomeParam

Utgången eller timeout-resultatet av detta shell-call.

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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.FunctionShellCallOutputOutcomeParamType		Ja

OpenAI.FunctionShellCallOutputOutcomeParamType

Fastighet	Värde
Type	snöre
Värden	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

Fastighet	Värde
Type	snöre
Värden	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Indikerar att skalanropet överskred sin konfigurerade tidsgräns.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Resultattypen. Alltid timeout. Möjliga värden: timeout	Ja

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Indikerar att skalanropet överskred sin konfigurerade tidsgräns.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Resultattypen. Alltid timeout. Möjliga värden: timeout	Ja

OpenAI.FunctionShellToolParam

Ett verktyg som låter modellen utföra skalkommandon.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Typen av skalverktyg. Alltid shell. Möjliga värden: shell	Ja

OpenAI.FunctionTool

Definierar en funktion i din egen kod som modellen kan välja att anropa.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	sträng (nullbar)		Nej.
name	snöre	Namnet på funktionen som ska anropas.	Ja
parametrar	objekt (nullbart)		Ja
strict	boolesk (nullbar)		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
input	matris med OpenAI.EvalItem		Ja
labels	strängmatris	Etiketterna som ska tilldelas till varje objekt i utvärderingen.	Ja
model	snöre	Den modell som ska användas för utvärderingen. Måste ha stöd för strukturerade utdata.	Ja
name	snöre	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
typ	enum	Objekttypen, som alltid label_modelär . 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.

Namn	Typ	Description	Krävs	Förinställning
calculate_output	snöre	En formel för att beräkna utdata baserat på graderresultat.	Ja
Klassare	OpenAI.GraderStringCheck eller OpenAI.GraderTextSimilarity eller OpenAI.GraderPython eller OpenAI.GraderScoreModel eller OpenAI.GraderLabelModel		Ja
name	snöre	Namnet på bedömaren.	Ja
typ	enum	Objekttypen, som alltid multiär . Möjliga värden: multi	Ja

OpenAI.GraderPython

Ett PythonGrader-objekt som kör ett Python-skript på indata.

Namn	Typ	Description	Krävs	Förinställning
image_tag	snöre	Avbildningstaggen som ska användas för Python-skriptet.	Nej.
name	snöre	Namnet på bedömaren.	Ja
källa	snöre	Källkoden för Python-skriptet.	Ja
typ	enum	Objekttypen, som alltid pythonär . 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.

Namn	Typ	Description	Krävs	Förinstä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	snöre	Den modell som ska användas för utvärderingen.	Ja
name	snöre	Namnet på bedömaren.	Ja
range	matris med OpenAI.numeric	Poängintervallet. Standardinställningen är [0, 1].	Nej.
provtagning_parametrar	OpenAI.EvalGraderScoreModelSamplingParams		Nej.
└– max_completions_tokens	OpenAI.integer (nullbar)		Nej.
└– reasoning_effort	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
└– frö	OpenAI.integer (nullbar)		Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
typ	enum	Objekttypen, som alltid score_modelär . 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.

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

OpenAI.GraderTextSimilarity

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

Namn	Typ	Description	Krävs	Förinställning
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	snöre	Texten som bedöms.	Ja
name	snöre	Namnet på bedömaren.	Ja
hänvisning	snöre	Texten som betygsätts och jämförs med.	Ja
typ	enum	Typ av väghyvel. Möjliga värden: text_similarity	Ja

OpenAI.GrammarSyntax1

Fastighet	Värde
Type	snöre
Värden	lark regex

OpenAI.HybridSearchOptions

Namn	Typ	Description	Krävs	Förinställning
embedding_weight	OpenAI.numeric		Ja
text_weight	OpenAI.numeric		Ja

OpenAI.ImageDetail

Fastighet	Värde
Type	snöre
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

Namn	Typ	Description	Krävs	Förinstä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	Nej.
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.	Nej.
inmatningsbildmask	OpenAI.ImageGenToolInputImageMask		Nej.
└– file_id	snöre		Nej.
└ image_url	snöre		Nej.
model	sträng (se giltiga modeller nedan)		Nej.
moderation	enum	Modereringsnivå för den genererade avbildningen. Förvald: auto. Möjliga värden: auto, low	Nej.
Utdata kompression	OpenAI.integer		Nej.	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	Nej.
delbilder	OpenAI.integer		Nej.
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	Nej.
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	Nej.
typ	enum	Typ av bildgenereringsverktyg. Alltid image_generation. Möjliga värden: image_generation	Ja

OpenAI.ImageGenToolInputImageMask

Namn	Typ	Description	Krävs	Förinställning
file_id	snöre		Nej.
image_url	snöre		Nej.

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 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).

Fastighet	Värde
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 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.

Namn	Typ	Description	Krävs	Förinställning
input_audio	OpenAI.InputAudioInputAudio		Ja
typ	enum	Typ av indataobjekt. Alltid input_audio. Möjliga värden: input_audio	Ja

OpenAI.InputAudioInputAudio

Namn	Typ	Description	Krävs	Förinställning
data	snöre		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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.InputContentType		Ja

OpenAI.InputContentInputFileContent

En filinmatning till modellen.

Namn	Typ	Description	Krävs	Förinställning
file_data	snöre	Innehållet i filen som ska skickas till modellen.	Nej.
file_id	sträng (nullbar)		Nej.
file_url	snöre	URL:en till filen som ska skickas till modellen.	Nej.
filename	snöre	Namnet på filen som ska skickas till modellen.	Nej.
typ	enum	Typ av indataobjekt. Alltid input_file. Möjliga värden: input_file	Ja

OpenAI.InputContentInputImageContent

En bildinmatning till modellen. Lär dig om bildingångar.

Namn	Typ	Description	Krävs	Förinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		Nej.
image_url	snöre		Nej.
typ	enum	Typ av indataobjekt. Alltid input_image. Möjliga värden: input_image	Ja

OpenAI.InputContentInputTextContent

En textinmatning till modellen.

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

OpenAI.InputContentType

Fastighet	Värde
Type	snöre
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.

Fastighet	Värde
Type	snöre
Värden	high low

OpenAI.InputFileContent

En filinmatning till modellen.

Namn	Typ	Description	Krävs	Förinställning
file_data	snöre	Innehållet i filen som ska skickas till modellen.	Nej.
file_id	sträng (nullbar)		Nej.
file_url	snöre	URL:en till filen som ska skickas till modellen.	Nej.
filename	snöre	Namnet på filen som ska skickas till modellen.	Nej.
typ	enum	Typ av indataobjekt. Alltid input_file. Möjliga värden: input_file	Ja

OpenAI.InputFileContentParam

En filinmatning till modellen.

Namn	Typ	Description	Krävs	Förinställning
file_data	sträng (nullbar)		Nej.
file_id	sträng (nullbar)		Nej.
file_url	snöre		Nej.
filename	sträng (nullbar)		Nej.
typ	enum	Typ av indataobjekt. Alltid input_file. Möjliga värden: input_file	Ja

OpenAI.InputImageContent

En bildinmatning till modellen. Lär dig om bildingångar.

Namn	Typ	Description	Krävs	Förinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		Nej.
image_url	snöre		Nej.
typ	enum	Typ av indataobjekt. Alltid input_image. Möjliga värden: input_image	Ja

OpenAI.InputImageContentParamAutoParam

En bildinmatning till modellen. Lär dig om bildingångar

Namn	Typ	Description	Krävs	Förinställning
detail	OpenAI.DetailEnum (nullable)		Nej.
file_id	sträng (nullbar)		Nej.
image_url	snöre		Nej.
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.InputItemType		Ja

OpenAI.InputItemApplyPatchToolCallItemParam

Ett verktygsanrop som representerar en förfrågan om att skapa, ta bort eller uppdatera filer med hjälp av olika patchar.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
Operation	OpenAI.ApplyPatchOperationParam	En av de create_file, delete_file eller update_file operationerna som tillförs apply_patch verktyget.	Ja
└– typ	OpenAI.ApplyPatchOperationParamType		Ja
status	OpenAI.ApplyPatchCallStatusParam	Statusvärden rapporteras för apply_patch verktygsanrop.	Ja
typ	enum	Typ av objekt. Alltid apply_patch_call. Möjliga värden: apply_patch_call	Ja

OpenAI.InputItemApplyPatchToolCallOutputItemParam

Den strömmade utdata som sänds ut av ett apply patch-verktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
output	sträng (nullbar)		Nej.
status	OpenAI.ApplyPatchCallOutputStatusParam	Utfallsvärden rapporteras för apply_patch verktygssamtalsutdata.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
kod	sträng (nullbar)		Ja
container_id	snöre	ID:t för containern som används för att köra koden.	Ja
Id-nummer	snöre	Det unika ID:t för kodtolkarverktygets anrop.	Ja
Utgångar	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är in_progress, completed, incomplete, interpretingoch failed. Möjliga värden: in_progress, completed, incomplete, , interpretingfailed	Ja
typ	enum	Typ av kodtolkarverktygsanrop. Alltid code_interpreter_call. Möjliga värden: code_interpreter_call	Ja

OpenAI.InputItemCompactionSummaryItemParam

Ett kompaktionsobjekt genererat av API:etv1/responses/compact.

Namn	Typ	Description	Krävs	Förinställning
encrypted_content	snöre	Det krypterade innehållet i komprimeringssammanfattningen. Begränsningar: maxLength: 10485760	Ja
Id-nummer	sträng (nullbar)		Nej.
typ	enum	Typ av objekt. Alltid compaction. Möjliga värden: compaction	Ja

OpenAI.InputItemComputerCallOutputItemParam

Utdata från ett datorverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam		Nej.
call_id	snöre	ID:t för datorverktygets anrop som genererade utdata. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		Nej.
typ	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. Se datorguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.ComputerAction		Ja
call_id	snöre	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
Id-nummer	snöre	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
typ	enum	Typ av datoranrop. Alltid computer_call. Möjliga värden: computer_call	Ja

OpenAI.InputItemCustomToolCall

Ett anrop till ett anpassat verktyg skapat av modellen.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	En identifierare som används för att mappa detta anpassade verktygsanrop till ett verktygsanropsutdata.	Ja
Id-nummer	snöre	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	Nej.
input	snöre	Indata för det anpassade verktygsanropet genereras av modellen.	Ja
name	snöre	Namnet på det anpassade verktyg som anropas.	Ja
typ	enum	Typen av det anpassade verktygsanropet. Alltid custom_tool_call. Möjliga värden: custom_tool_call	Ja

OpenAI.InputItemCustomToolCallOutput

Resultatet av ett anpassat verktygsanrop från din kod, som skickas tillbaka till modellen.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Anrops-ID:t, som används för att mappa detta anpassade verktygsanropsutdata till ett eget verktygsanrop.	Ja
Id-nummer	snöre	Det unika ID:t för det anpassade verktygsanropet ger utdata i OpenAI-plattformen.	Nej.
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Resultatet från det anpassade verktygsanropet som genereras av din kod. Det kan vara en sträng eller en lista med utdatainnehåll.	Ja
typ	enum	Typen av det anpassade verktyget anropar utdata. Alltid custom_tool_call_output. Möjliga värden: custom_tool_call_output	Ja

OpenAI.InputItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Se sökguiden fil för mer information.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	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		Nej.
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
typ	enum	Typ av filsökningsverktygsanrop. Alltid file_search_call. Möjliga värden: file_search_call	Ja

OpenAI.InputItemFunctionCallOutputItemParam

Utdata från ett funktionsverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
output	sträng eller matris med OpenAI.InputTextContentParam eller OpenAI.InputImageContentParamAutoParam eller OpenAI.InputFileContentParam	Text, bild eller filutdata från funktionsverktygsanropet.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		Nej.
typ	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 förfrågan om att utföra ett eller flera skalkommandon.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.FunctionShellActionParam	Kommandon och begränsningar som beskriver hur man kör shell-verktygsanropet.	Ja
└– kommandon	strängmatris	Beställde shell-kommandon för att exekveringsmiljön ska köras.	Ja
└– max_output_length	OpenAI.integer (nullbar)		Nej.
└– timeout_ms	OpenAI.integer (nullbar)		Nej.
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
status	OpenAI.FunctionShellCallItemStatus (nullbar)	Statusvärden rapporteras för skalverktygsanrop.	Nej.
typ	enum	Typ av objekt. Alltid shell_call. Möjliga värden: shell_call	Ja

OpenAI.InputItemFunctionShellCallOutputItemParam

De strömmade utdataobjekten som sänds ut av ett skalverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
max_output_length	OpenAI.integer (nullbar)		Nej.
output	matris med OpenAI.FunctionShellCallOutputContentParam	Fångade delar av stdout- och stderr-produktionen, tillsammans med deras tillhörande utfall.	Ja
typ	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. Se guiden för anrop funktionen för mer information.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för funktionsverktygets anrop.	Nej.
name	snöre	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	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för bildgenereringsanropet.	Ja
resultat	sträng (nullbar)		Ja
status	enum	Status för bildgenereringssamtalet. Möjliga värden: in_progress, completed, generating, failed	Ja
typ	enum	Typen av bildgenereringsanrop. 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.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för det lokala skalsamtalet.	Ja
status	enum	Status för det lokala skalsamtalet. Möjliga värden: in_progress, completed, incomplete	Ja
typ	enum	Typen av lokal skal-call. Alltid local_shell_call. Möjliga värden: local_shell_call	Ja

OpenAI.InputItemLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	snöre	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: in_progress, completed, incomplete	Nej.
typ	enum	Typen av lokal skalverktygsanropsutgång. 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.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argument för verktyget.	Ja
Id-nummer	snöre	Den unika identifieringen för godkännandebegäran.	Ja
name	snöre	Namnet på det verktyg som ska köras.	Ja
serveretikett	snöre	Etiketten på MCP-servern som skickar begäran.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	snöre	ID:t för godkännandebegäran som besvaras.	Ja
approve	booleskt	Om begäran godkändes.	Ja
Id-nummer	sträng (nullbar)		Nej.
reason	sträng (nullbar)		Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Den unika ID:n på listan.	Ja
serveretikett	snöre	MCP-serverns etikett.	Ja
verktyg	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	sträng (nullbar)		Nej.
arguments	snöre	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Det unika ID:t för verktygsanropet.	Ja
name	snöre	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		Nej.
serveretikett	snöre	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		Nej.
typ	enum	Typ av objekt. Alltid mcp_call. Möjliga värden: mcp_call	Ja

OpenAI.InputItemOutputMessage

Ett utdatameddelande från modellen.

Namn	Typ	Description	Krävs	Förinställning
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
Id-nummer	snöre	Utdatameddelandets unika ID.	Ja
None needed, as the translation is already accurate and fluent.	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
typ	enum	Typ av utdatameddelande. Alltid message. Möjliga värden: output_message	Ja

OpenAI.InputItemReasoningItem

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att inkludera dessa objekt i din input till Responses API för kommande rundor i en konversation om du manuellt hanterar kontext.

Namn	Typ	Description	Krävs	Förinställning
innehåll	matris med OpenAI.ReasoningTextContent	Resonemang textinnehåll.	Nej.
encrypted_content	sträng (nullbar)		Nej.
Id-nummer	snöre	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	Nej.
summary	matris med OpenAI.Summary	Resonemang sammanfattningsinnehåll.	Ja
typ	enum	Typ av objekt. Alltid reasoning. Möjliga värden: reasoning	Ja

OpenAI.InputItemType

Fastighet	Värde
Type	snöre
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ökningsverktyg som anropas. Se webbsökningsguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtas i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, hitta).	Ja
Id-nummer	snöre	Det unika ID:t för webbsökverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: in_progress, searching, completed, failed	Ja
typ	enum	Typen av webbsökverktyget kallas. Alltid web_search_call. Möjliga värden: web_search_call	Ja

OpenAI.InputMessage

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.

Namn	Typ	Description	Krävs	Förinställning
innehåll	OpenAI.InputMessageContentList	En lista över ett eller flera indataobjekt till modellen som innehåller olika innehåll types.	Ja
None needed, as the translation is already accurate and fluent.	enum	Rollen för meddelandets inmatning. En av user, systemeller 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	Nej.
typ	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

Namn	Typ	Description	Krävs	Förinställning
innehåll	OpenAI.InputMessageContentList	En lista över ett eller flera indataobjekt till modellen som innehåller olika innehåll types.	Ja
Id-nummer	snöre	Det unika ID:t för meddelandeindata.	Ja
None needed, as the translation is already accurate and fluent.	enum	Rollen för meddelandets inmatning. En av user, systemeller 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	Nej.
typ	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:

• Textinmatningar och -utdata
• Bildingångar
• Filinmatningar
• Konversationstillstånd
• Funktionsanrop

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:

• Textinmatningar och -utdata
• Bildingångar
• Filinmatningar
• Konversationstillstånd
• Funktionsanrop

OpenAI.InputTextContent

En textinmatning till modellen.

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

OpenAI.InputTextContentParam

En textinmatning till modellen.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	Textinmatningen till modellen. Begränsningar: maxLength: 10485760	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ItemType		Ja

OpenAI.ItemApplyPatchToolCallItemParam

Ett verktygsanrop som representerar en förfrågan om att skapa, ta bort eller uppdatera filer med hjälp av olika patchar.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
Operation	OpenAI.ApplyPatchOperationParam	En av de create_file, delete_file eller update_file operationerna som tillförs apply_patch verktyget.	Ja
└– typ	OpenAI.ApplyPatchOperationParamType		Ja
status	OpenAI.ApplyPatchCallStatusParam	Statusvärden rapporteras för apply_patch verktygsanrop.	Ja
typ	enum	Typ av objekt. Alltid apply_patch_call. Möjliga värden: apply_patch_call	Ja

OpenAI.ItemApplyPatchToolCallOutputItemParam

Den strömmade utdata som sänds ut av ett apply patch-verktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
output	sträng (nullbar)		Nej.
status	OpenAI.ApplyPatchCallOutputStatusParam	Utfallsvärden rapporteras för apply_patch verktygssamtalsutdata.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
kod	sträng (nullbar)		Ja
container_id	snöre	ID:t för containern som används för att köra koden.	Ja
Id-nummer	snöre	Det unika ID:t för kodtolkarverktygets anrop.	Ja
Utgångar	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är in_progress, completed, incomplete, interpretingoch failed. Möjliga värden: in_progress, completed, incomplete, , interpretingfailed	Ja
typ	enum	Typ av kodtolkarverktygsanrop. Alltid code_interpreter_call. Möjliga värden: code_interpreter_call	Ja

OpenAI.ItemCompactionSummaryItemParam

Ett kompaktionsobjekt genererat av API:etv1/responses/compact.

Namn	Typ	Description	Krävs	Förinställning
encrypted_content	snöre	Det krypterade innehållet i komprimeringssammanfattningen. Begränsningar: maxLength: 10485760	Ja
Id-nummer	sträng (nullbar)		Nej.
typ	enum	Typ av objekt. Alltid compaction. Möjliga värden: compaction	Ja

OpenAI.ItemComputerCallOutputItemParam

Utdata från ett datorverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam		Nej.
call_id	snöre	ID:t för datorverktygets anrop som genererade utdata. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
output	OpenAI.ComputerScreenshotImage	En skärmbild av datorn som används med datoranvändningsverktyget.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		Nej.
typ	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. Se datorguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.ComputerAction		Ja
call_id	snöre	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
Id-nummer	snöre	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
typ	enum	Typ av datoranrop. Alltid computer_call. Möjliga värden: computer_call	Ja

OpenAI.ItemCustomToolCall

Ett anrop till ett anpassat verktyg skapat av modellen.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	En identifierare som används för att mappa detta anpassade verktygsanrop till ett verktygsanropsutdata.	Ja
Id-nummer	snöre	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	Nej.
input	snöre	Indata för det anpassade verktygsanropet genereras av modellen.	Ja
name	snöre	Namnet på det anpassade verktyg som anropas.	Ja
typ	enum	Typen av det anpassade verktygsanropet. Alltid custom_tool_call. Möjliga värden: custom_tool_call	Ja

OpenAI.ItemCustomToolCallOutput

Resultatet av ett anpassat verktygsanrop från din kod, som skickas tillbaka till modellen.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Anrops-ID:t, som används för att mappa detta anpassade verktygsanropsutdata till ett eget verktygsanrop.	Ja
Id-nummer	snöre	Det unika ID:t för det anpassade verktygsanropet ger utdata i OpenAI-plattformen.	Nej.
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Resultatet från det anpassade verktygsanropet som genereras av din kod. Det kan vara en sträng eller en lista med utdatainnehåll.	Ja
typ	enum	Typen av det anpassade verktyget anropar utdata. Alltid custom_tool_call_output. Möjliga värden: custom_tool_call_output	Ja

OpenAI.ItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Se sökguiden fil för mer information.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	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		Nej.
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
typ	enum	Typ av filsökningsverktygsanrop. Alltid file_search_call. Möjliga värden: file_search_call	Ja

OpenAI.ItemFunctionCallOutputItemParam

Utdata från ett funktionsverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
output	sträng eller matris med OpenAI.InputTextContentParam eller OpenAI.InputImageContentParamAutoParam eller OpenAI.InputFileContentParam	Text, bild eller filutdata från funktionsverktygsanropet.	Ja
status	OpenAI.FunctionCallItemStatus (nullable)		Nej.
typ	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 förfrågan om att utföra ett eller flera skalkommandon.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.FunctionShellActionParam	Kommandon och begränsningar som beskriver hur man kör shell-verktygsanropet.	Ja
└– kommandon	strängmatris	Beställde shell-kommandon för att exekveringsmiljön ska köras.	Ja
└– max_output_length	OpenAI.integer (nullbar)		Nej.
└– timeout_ms	OpenAI.integer (nullbar)		Nej.
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
status	OpenAI.FunctionShellCallItemStatus (nullbar)	Statusvärden rapporteras för skalverktygsanrop.	Nej.
typ	enum	Typ av objekt. Alltid shell_call. Möjliga värden: shell_call	Ja

OpenAI.ItemFunctionShellCallOutputItemParam

De strömmade utdataobjekten som sänds ut av ett skalverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen. Begränsningar: minLength: 1, maxLength: 64	Ja
Id-nummer	sträng (nullbar)		Nej.
max_output_length	OpenAI.integer (nullbar)		Nej.
output	matris med OpenAI.FunctionShellCallOutputContentParam	Fångade delar av stdout- och stderr-produktionen, tillsammans med deras tillhörande utfall.	Ja
typ	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. Se guiden för anrop funktionen för mer information.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för funktionsverktygets anrop.	Nej.
name	snöre	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	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för bildgenereringsanropet.	Ja
resultat	sträng (nullbar)		Ja
status	enum	Status för bildgenereringssamtalet. Möjliga värden: in_progress, completed, generating, failed	Ja
typ	enum	Typen av bildgenereringsanrop. 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.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för det lokala skalsamtalet.	Ja
status	enum	Status för det lokala skalsamtalet. Möjliga värden: in_progress, completed, incomplete	Ja
typ	enum	Typen av lokal skal-call. Alltid local_shell_call. Möjliga värden: local_shell_call	Ja

OpenAI.ItemLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	snöre	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: in_progress, completed, incomplete	Nej.
typ	enum	Typen av lokal skalverktygsanropsutgång. 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.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argument för verktyget.	Ja
Id-nummer	snöre	Den unika identifieringen för godkännandebegäran.	Ja
name	snöre	Namnet på det verktyg som ska köras.	Ja
serveretikett	snöre	Etiketten på MCP-servern som skickar begäran.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	snöre	ID:t för godkännandebegäran som besvaras.	Ja
approve	booleskt	Om begäran godkändes.	Ja
Id-nummer	sträng (nullbar)		Nej.
reason	sträng (nullbar)		Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Den unika ID:n på listan.	Ja
serveretikett	snöre	MCP-serverns etikett.	Ja
verktyg	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	sträng (nullbar)		Nej.
arguments	snöre	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Det unika ID:t för verktygsanropet.	Ja
name	snöre	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		Nej.
serveretikett	snöre	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		Nej.
typ	enum	Typ av objekt. Alltid mcp_call. Möjliga värden: mcp_call	Ja

OpenAI.ItemOutputMessage

Ett utdatameddelande från modellen.

Namn	Typ	Description	Krävs	Förinställning
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
Id-nummer	snöre	Utdatameddelandets unika ID.	Ja
None needed, as the translation is already accurate and fluent.	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
typ	enum	Typ av utdatameddelande. Alltid message. Möjliga värden: output_message	Ja

OpenAI.ItemReasoningItem

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att inkludera dessa objekt i din input till Responses API för kommande rundor i en konversation om du manuellt hanterar kontext.

Namn	Typ	Description	Krävs	Förinställning
innehåll	matris med OpenAI.ReasoningTextContent	Resonemang textinnehåll.	Nej.
encrypted_content	sträng (nullbar)		Nej.
Id-nummer	snöre	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	Nej.
summary	matris med OpenAI.Summary	Resonemang sammanfattningsinnehåll.	Ja
typ	enum	Typ av objekt. Alltid reasoning. Möjliga värden: reasoning	Ja

OpenAI.ItemReferenceParam

En intern identifierare för ett objekt att referera till.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	ID:t för det objekt som ska refereras till.	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ItemResourceType		Ja

OpenAI.ItemResourceApplyPatchToolCall

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktygsanropet.	Nej.
Id-nummer	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktyget anropar utdata.	Nej.
Id-nummer	snöre	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)		Nej.
status	OpenAI.ApplyPatchCallOutputStatus		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
kod	sträng (nullbar)		Ja
container_id	snöre	ID:t för containern som används för att köra koden.	Ja
Id-nummer	snöre	Det unika ID:t för kodtolkarverktygets anrop.	Ja
Utgångar	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är in_progress, completed, incomplete, interpretingoch failed. Möjliga värden: in_progress, completed, incomplete, , interpretingfailed	Ja
typ	enum	Typ av kodtolkarverktygsanrop. Alltid code_interpreter_call. Möjliga värden: code_interpreter_call	Ja

OpenAI.ItemResourceComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Se datorguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.ComputerAction		Ja
call_id	snöre	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
Id-nummer	snöre	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
typ	enum	Typ av datoranrop. Alltid computer_call. Möjliga värden: computer_call	Ja

OpenAI.ItemResourceComputerToolCallOutputResource

Namn	Typ	Description	Krävs	Förinställning
acknowledged_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De säkerhetskontroller som rapporterats av API:et och som har bekräftats av utvecklare.	Nej.
call_id	snöre	ID:t för datorverktygets anrop som genererade utdata.	Ja
Id-nummer	snöre	ID:t för datorverktyget anropar utdata.	Nej.
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	Nej.
typ	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. Se sökguiden fil för mer information.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	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		Nej.
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
typ	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ö.

Namn	Typ	Description	Krävs	Förinställning
å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	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktygsanropet.	Nej.
Id-nummer	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen.	Ja
skapad av	snöre	Identifieraren för aktören som skapade objektet.	Nej.
Id-nummer	snöre	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
typ	enum	Typ av gränssnittsanropets utdata. Alltid shell_call_output. Möjliga värden: shell_call_output	Ja

OpenAI.ItemResourceFunctionToolCallOutputResource

Namn	Typ	Description	Krävs	Förinställning
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för funktionsverktygets anropsresultat. Fylls i när det här objektet returneras via API.	Nej.
output	sträng eller matris med OpenAI.FunctionAndCustomToolCallOutput	Utdata från funktionsanropet som genereras av koden. Det kan vara en sträng eller en lista med 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	Nej.
typ	enum	Typen av utdata från funktionsverktygets anrop. Alltid function_call_output. Möjliga värden: function_call_output	Ja

OpenAI.ItemResourceFunctionToolCallResource

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för funktionsverktygets anrop.	Nej.
name	snöre	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	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för bildgenereringsanropet.	Ja
resultat	sträng (nullbar)		Ja
status	enum	Status för bildgenereringssamtalet. Möjliga värden: in_progress, completed, generating, failed	Ja
typ	enum	Typen av bildgenereringsanrop. 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.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
call_id	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för det lokala skalsamtalet.	Ja
status	enum	Status för det lokala skalsamtalet. Möjliga värden: in_progress, completed, incomplete	Ja
typ	enum	Typen av lokal skal-call. Alltid local_shell_call. Möjliga värden: local_shell_call	Ja

OpenAI.ItemResourceLocalShellToolCallOutput

Utdata från ett lokalt gränssnittsverktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
output	snöre	En JSON-sträng med utdata från det lokala gränssnittets verktygsanrop.	Ja
status	enum	Möjliga värden: in_progress, completed, incomplete	Nej.
typ	enum	Typen av lokal skalverktygsanropsutgång. 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.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng med argument för verktyget.	Ja
Id-nummer	snöre	Den unika identifieringen för godkännandebegäran.	Ja
name	snöre	Namnet på det verktyg som ska köras.	Ja
serveretikett	snöre	Etiketten på MCP-servern som skickar begäran.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	snöre	ID:t för godkännandebegäran som besvaras.	Ja
approve	booleskt	Om begäran godkändes.	Ja
Id-nummer	snöre	Det unika ID:t för godkännandesvaret	Ja
reason	sträng (nullbar)		Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Den unika ID:n på listan.	Ja
serveretikett	snöre	MCP-serverns etikett.	Ja
verktyg	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
approval_request_id	sträng (nullbar)		Nej.
arguments	snöre	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Det unika ID:t för verktygsanropet.	Ja
name	snöre	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		Nej.
serveretikett	snöre	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		Nej.
typ	enum	Typ av objekt. Alltid mcp_call. Möjliga värden: mcp_call	Ja

OpenAI.ItemResourceOutputMessage

Ett utdatameddelande från modellen.

Namn	Typ	Description	Krävs	Förinställning
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
Id-nummer	snöre	Utdatameddelandets unika ID.	Ja
None needed, as the translation is already accurate and fluent.	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
typ	enum	Typ av utdatameddelande. Alltid message. Möjliga värden: output_message	Ja

OpenAI.ItemResourceType

Fastighet	Värde
Type	snöre
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ökningsverktyg som anropas. Se webbsökningsguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtas i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, hitta).	Ja
Id-nummer	snöre	Det unika ID:t för webbsökverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: in_progress, searching, completed, failed	Ja
typ	enum	Typen av webbsökverktyget kallas. Alltid web_search_call. Möjliga värden: web_search_call	Ja

OpenAI.ItemType

Fastighet	Värde
Type	snöre
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 structured_outputs oauth_consent_request memory_search_call workflow_action

OpenAI.ItemWebSearchToolCall

Resultatet av ett webbsökningsverktyg som anropas. Se webbsökningsguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtas i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, hitta).	Ja
Id-nummer	snöre	Det unika ID:t för webbsökverktyget anropar.	Ja
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: in_progress, searching, completed, failed	Ja
typ	enum	Typen av webbsökverktyget kallas. Alltid web_search_call. Möjliga värden: web_search_call	Ja

OpenAI.KeyPressAction

En samling tangenttryckningar som modellen vill utföra.

Namn	Typ	Description	Krävs	Förinställning
Nycklar	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
typ	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

Namn	Typ	Description	Krävs	Förinställning
data	matris med OpenAI.FineTuningJobCheckpoint		Ja
first_id	sträng (nullbar)		Nej.
har_mer	booleskt		Ja
last_id	sträng (nullbar)		Nej.
objekt	enum	Möjliga värden: list	Ja

OpenAI.ListFineTuningJobEventsResponse

Namn	Typ	Description	Krävs	Förinställning
data	matris med OpenAI.FineTuningJobEvent		Ja
har_mer	booleskt		Ja
objekt	enum	Möjliga värden: list	Ja

OpenAI.ListPaginatedFineTuningJobsResponse

Namn	Typ	Description	Krävs	Förinställning
data	matris med OpenAI.FineTuningJob		Ja
har_mer	booleskt		Ja
objekt	enum	Möjliga värden: list	Ja

OpenAI.LocalShellCallStatus

Fastighet	Värde
Type	snöre
Värden	in_progress completed incomplete

OpenAI.LocalShellExecAction

Kör ett gränssnittskommando på servern.

Namn	Typ	Description	Krävs	Förinställning
kommando	strängmatris	Kommandot som ska köras.	Ja
env	objekt	Miljövariabler som ska anges för kommandot.	Ja
timeout_ms (timeout i millisekunder)	OpenAI.integer (nullbar)		Nej.
typ	enum	Typen av lokal gränssnittsåtgärd. Alltid exec. Möjliga värden: exec	Ja
user	sträng (nullbar)		Nej.
working_directory	sträng (nullbar)		Nej.

OpenAI.LocalShellToolParam

Ett verktyg som gör att modellen kan köra gränssnittskommandon i en lokal miljö.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Typ av lokalt gränssnittsverktyg. Alltid local_shell. Möjliga värden: local_shell	Ja

OpenAI.LogProb

Loggens sannolikhet för en token.

Namn	Typ	Description	Krävs	Förinställning
bytes	matris med OpenAI.integer		Ja
logprob	OpenAI.numeric		Ja
token	snöre		Ja
top_logprobs	matris med OpenAI.TopLogProb		Ja

OpenAI.MCPListToolsTool

Ett verktyg som är tillgängligt på en MCP-server.

Namn	Typ	Description	Krävs	Förinställning
Anteckningar	OpenAI.MCPListToolsToolAnnotations (nullbar)		Nej.
beskrivning	sträng (nullbar)		Nej.
input_schema	OpenAI.MCPListToolsToolInputSchema		Ja
name	snöre	Namnet på verktyget.	Ja

OpenAI.MCPListToolsToolAnnotations

Typ: objekt

OpenAI.MCPListToolsToolInputSchema

Typ: objekt

OpenAI.MCPTool

Ge modellen access till ytterligare verktyg via fjärrservrar för Model Context Protocol (MCP). Lär dig mer om MCP.

Namn	Typ	Description	Krävs	Förinställning
tillåtna_verktyg	matris med sträng eller OpenAI.MCPToolFilter		Nej.
auktorisering	snöre	En OAuth access-token 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.	Nej.
connector_id	enum	Identifierare för tjänstekopplingar, som de som finns i ChatGPT. En av server_url eller connector_id måste tillhandahållas. Läs mer om tjänsten Kontakter här. För närvarande stödda connector_id värden är: -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	Nej.
headers	objekt (nullbart)		Nej.
project_connection_id	snöre	Anslutnings-ID:t i projektet för MCP-servern. Anslutningen lagrar autentisering och annan anslutningsinformation som behövs för att ansluta till MCP-servern.	Nej.
kräv_godkännande	objekt (se giltiga modeller nedan)		Nej.
server_description	snöre	Valfri beskrivning av MCP-servern, använd för att ge mer kontext.	Nej.
serveretikett	snöre	En etikett för den här MCP-servern som används för att identifiera den i verktygsanrop.	Ja
server_url	snöre	URL:en för MCP-servern. En av server_url eller connector_id måste vara tillhandahålls.	Nej.
typ	enum	Typ av MCP-verktyg. Alltid mcp. Möjliga värden: mcp	Ja

OpenAI.MCPToolCallStatus

Fastighet	Värde
Type	snöre
Värden	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

Ett filterobjekt för att specificera vilka verktyg som är tillåtna.

Namn	Typ	Description	Krävs	Förinställning
read_only	booleskt	Anger om ett verktyg ändrar data eller är skrivskyddat. Om en MCP-servern kommenteras med readOnlyHint, det matchar det här filtret.	Nej.
tool_names	strängmatris	Lista över tillåtna verktygsnamn.	Nej.

OpenAI.MCPToolRequireApproval

Namn	Typ	Description	Krävs	Förinställning
always	OpenAI.MCPToolFilter	Ett filterobjekt för att specificera vilka verktyg som är tillåtna.	Nej.
aldrig	OpenAI.MCPToolFilter	Ett filterobjekt för att specificera vilka verktyg som är tillåtna.	Nej.

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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.MessageContentType		Ja

OpenAI.MessageContentInputFileContent

En filinmatning till modellen.

Namn	Typ	Description	Krävs	Förinställning
file_data	snöre	Innehållet i filen som ska skickas till modellen.	Nej.
file_id	sträng (nullbar)		Nej.
file_url	snöre	URL:en till filen som ska skickas till modellen.	Nej.
filename	snöre	Namnet på filen som ska skickas till modellen.	Nej.
typ	enum	Typ av indataobjekt. Alltid input_file. Möjliga värden: input_file	Ja

OpenAI.MessageContentInputImageContent

En bildinmatning till modellen. Lär dig om bildingångar.

Namn	Typ	Description	Krävs	Förinställning
detail	OpenAI.ImageDetail		Ja
file_id	sträng (nullbar)		Nej.
image_url	snöre		Nej.
typ	enum	Typ av indataobjekt. Alltid input_image. Möjliga värden: input_image	Ja

OpenAI.MessageContentInputTextContent

En textinmatning till modellen.

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

OpenAI.MessageContentOutputTextContent

En textutgång från modellen.

Namn	Typ	Description	Krävs	Förinställning
Anteckningar	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		Nej.
text	snöre	Textutdata från modellen.	Ja
typ	enum	Typ av utdatatext. Alltid output_text. Möjliga värden: output_text	Ja

OpenAI.MessageContentReasoningTextContent

Resonerande text från modellen.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	Resonemangstexten från modellen.	Ja
typ	enum	Typen av resonemangstext. Alltid reasoning_text. Möjliga värden: reasoning_text	Ja

OpenAI.MessageContentRefusalContent

En vägran från modellen.

Namn	Typ	Description	Krävs	Förinställning
vägran	snöre	Avslagsförklaringen från modellen.	Ja
typ	enum	Typ av vägran. Alltid refusal. Möjliga värden: refusal	Ja

OpenAI.MessageContentType

Fastighet	Värde
Type	snöre
Värden	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

Fastighet	Värde
Type	snöre
Värden	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Fastighet	Värde
Type	snöre
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

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.

OpenAI.ModelIdsResponses

Fastighet	Värde
Type	snöre
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.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Anger händelsetypen. För en flyttå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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.OutputContentType		Ja

OpenAI.OutputContentOutputTextContent

En textutgång från modellen.

Namn	Typ	Description	Krävs	Förinställning
Anteckningar	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		Nej.
text	snöre	Textutdata från modellen.	Ja
typ	enum	Typ av utdatatext. Alltid output_text. Möjliga värden: output_text	Ja

OpenAI.OutputContentReasoningTextContent

Resonerande text från modellen.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	Resonemangstexten från modellen.	Ja
typ	enum	Typen av resonemangstext. Alltid reasoning_text. Möjliga värden: reasoning_text	Ja

OpenAI.OutputContentRefusalContent

En vägran från modellen.

Namn	Typ	Description	Krävs	Förinställning
vägran	snöre	Avslagsförklaringen från modellen.	Ja
typ	enum	Typ av vägran. Alltid refusal. Möjliga värden: refusal	Ja

OpenAI.OutputContentType

Fastighet	Värde
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
response_id	snöre	Svaret som objektet skapas på.	Nej.
typ	OpenAI.OutputItemType		Ja

OpenAI.OutputItemApplyPatchToolCall

Ett verktygsanrop som tillämpar fildiff genom att skapa, ta bort eller uppdatera filer.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktygsanropet.	Nej.
Id-nummer	snöre	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	snöre	Svaret som objektet skapas på.	Nej.
status	OpenAI.ApplyPatchCallStatus		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
call_id	snöre	Det unika ID:t för apply patch-verktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktyget anropar utdata.	Nej.
Id-nummer	snöre	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)		Nej.
response_id	snöre	Svaret som objektet skapas på.	Nej.
status	OpenAI.ApplyPatchCallOutputStatus		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
kod	sträng (nullbar)		Ja
container_id	snöre	ID:t för containern som används för att köra koden.	Ja
Id-nummer	snöre	Det unika ID:t för kodtolkarverktygets anrop.	Ja
Utgångar	matris med OpenAI.CodeInterpreterOutputLogs eller OpenAI.CodeInterpreterOutputImage		Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
status	enum	Status för kodtolkarverktygets anrop. Giltiga värden är in_progress, completed, incomplete, interpretingoch failed. Möjliga värden: in_progress, completed, incomplete, , interpretingfailed	Ja
typ	enum	Typ av kodtolkarverktygsanrop. Alltid code_interpreter_call. Möjliga värden: code_interpreter_call	Ja

OpenAI.OutputItemCompactionBody

Ett kompaktionsobjekt genererat av API:etv1/responses/compact.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
skapad av	snöre	Identifieraren för aktören som skapade objektet.	Nej.
encrypted_content	snöre	Det krypterade innehåll som producerades av komprimering.	Ja
Id-nummer	snöre	Det unika ID:t för kompakteringsobjektet.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
typ	enum	Typ av objekt. Alltid compaction. Möjliga värden: compaction	Ja

OpenAI.OutputItemComputerToolCall

Ett verktygsanrop till ett datoranvändningsverktyg. Se datorguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.ComputerAction		Ja
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
call_id	snöre	En identifierare som används när du svarar på verktygsanropet med utdata.	Ja
Id-nummer	snöre	Datoranropets unika ID.	Ja
pending_safety_checks	matris med OpenAI.ComputerCallSafetyCheckParam	De väntande säkerhetskontrollerna för datorsamtalet.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
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
typ	enum	Typ av datoranrop. Alltid computer_call. Möjliga värden: computer_call	Ja

OpenAI.OutputItemCustomToolCall

Ett anrop till ett anpassat verktyg skapat av modellen.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
call_id	snöre	En identifierare som används för att mappa detta anpassade verktygsanrop till ett verktygsanropsutdata.	Ja
Id-nummer	snöre	Det unika ID:t för det anpassade verktygsanropet i OpenAI-plattformen.	Nej.
input	snöre	Indata för det anpassade verktygsanropet genereras av modellen.	Ja
name	snöre	Namnet på det anpassade verktyg som anropas.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
typ	enum	Typen av det anpassade verktygsanropet. Alltid custom_tool_call. Möjliga värden: custom_tool_call	Ja

OpenAI.OutputItemFileSearchToolCall

Resultatet av ett filsökningsverktygsanrop. Se sökguiden fil för mer information.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
Id-nummer	snöre	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	snöre	Svaret som objektet skapas på.	Nej.
results	matris med OpenAI.FileSearchToolCallResults		Nej.
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
typ	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ö.

Namn	Typ	Description	Krävs	Förinställning
å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		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen.	Ja
skapad av	snöre	ID:t för entiteten som skapade det här verktygsanropet.	Nej.
Id-nummer	snöre	Det unika ID:t för gränssnittets verktygsanrop. Fylls i när det här objektet returneras via API.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
status	OpenAI.LocalShellCallStatus		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
call_id	snöre	Det unika ID:t för skalverktygsanropet som genereras av modellen.	Ja
skapad av	snöre	Identifieraren för aktören som skapade objektet.	Nej.
Id-nummer	snöre	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	snöre	Svaret som objektet skapas på.	Nej.
typ	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. Se guiden för anrop funktionen för mer information.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
arguments	snöre	En JSON-sträng med argumenten som ska skickas till funktionen.	Ja
call_id	snöre	Det unika ID:t för funktionsverktygets anrop som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för funktionsverktygets anrop.	Nej.
name	snöre	Namnet på den funktion som ska köras.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
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	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
Id-nummer	snöre	Det unika ID:t för bildgenereringsanropet.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
resultat	sträng (nullbar)		Ja
status	enum	Status för bildgenereringssamtalet. Möjliga värden: in_progress, completed, generating, failed	Ja
typ	enum	Typen av bildgenereringsanrop. 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.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.LocalShellExecAction	Kör ett gränssnittskommando på servern.	Ja
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
call_id	snöre	Det unika ID:t för det lokala gränssnittsverktygsanropet som genereras av modellen.	Ja
Id-nummer	snöre	Det unika ID:t för det lokala skalsamtalet.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
status	enum	Status för det lokala skalsamtalet. Möjliga värden: in_progress, completed, incomplete	Ja
typ	enum	Typen av lokal skal-call. 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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
arguments	snöre	En JSON-sträng med argument för verktyget.	Ja
Id-nummer	snöre	Den unika identifieringen för godkännandebegäran.	Ja
name	snöre	Namnet på det verktyg som ska köras.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
serveretikett	snöre	Etiketten på MCP-servern som skickar begäran.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Den unika ID:n på listan.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
serveretikett	snöre	MCP-serverns etikett.	Ja
verktyg	matris med OpenAI.MCPListToolsTool	Verktygen som är tillgängliga på servern.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
approval_request_id	sträng (nullbar)		Nej.
arguments	snöre	En JSON-sträng med argumenten som skickas till verktyget.	Ja
fel	sträng (nullbar)		Nej.
Id-nummer	snöre	Det unika ID:t för verktygsanropet.	Ja
name	snöre	Namnet på verktyget som kördes.	Ja
output	sträng (nullbar)		Nej.
response_id	snöre	Svaret som objektet skapas på.	Nej.
serveretikett	snöre	Etiketten på MCP-servern som kör verktyget.	Ja
status	OpenAI.MCPToolCallStatus		Nej.
typ	enum	Typ av objekt. Alltid mcp_call. Möjliga värden: mcp_call	Ja

OpenAI.OutputItemOutputMessage

Ett utdatameddelande från modellen.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
innehåll	matris med OpenAI.OutputMessageContent	Innehållet i utdatameddelandet.	Ja
Id-nummer	snöre	Utdatameddelandets unika ID.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
None needed, as the translation is already accurate and fluent.	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
typ	enum	Typ av utdatameddelande. Alltid message. Möjliga värden: output_message	Ja

OpenAI.OutputItemReasoningItem

En beskrivning av den tankekedja som används av en resonemangsmodell när ett svar genereras. Se till att inkludera dessa objekt i din input till Responses API för kommande rundor i en konversation om du manuellt hanterar kontext.

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
innehåll	matris med OpenAI.ReasoningTextContent	Resonemang textinnehåll.	Nej.
encrypted_content	sträng (nullbar)		Nej.
Id-nummer	snöre	Den unika identifieraren för resonemangsinnehållet.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
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	Nej.
summary	matris med OpenAI.Summary	Resonemang sammanfattningsinnehåll.	Ja
typ	enum	Typ av objekt. Alltid reasoning. Möjliga värden: reasoning	Ja

OpenAI.OutputItemType

Fastighet	Värde
Type	snöre
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ökningsverktyg som anropas. Se webbsökningsguiden för mer information.

Namn	Typ	Description	Krävs	Förinställning
åtgärd	OpenAI.WebSearchActionSearch eller OpenAI.WebSearchActionOpenPage eller OpenAI.WebSearchActionFind	Ett objekt som beskriver den specifika åtgärd som vidtas i det här webbsökningsanropet. Innehåller information om hur modellen använde webben (sök, open_page, hitta).	Ja
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
Id-nummer	snöre	Det unika ID:t för webbsökverktyget anropar.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
status	enum	Status för webbsökningsverktygets anrop. Möjliga värden: in_progress, searching, completed, failed	Ja
typ	enum	Typen av webbsökverktyget kallas. 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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.OutputMessageContentType		Ja

OpenAI.OutputMessageContentOutputTextContent

En textutgång från modellen.

Namn	Typ	Description	Krävs	Förinställning
Anteckningar	matris med OpenAI.Annotation	Anteckningarna i textutdata.	Ja
logprobs	matris med OpenAI.LogProb		Nej.
text	snöre	Textutdata från modellen.	Ja
typ	enum	Typ av utdatatext. Alltid output_text. Möjliga värden: output_text	Ja

OpenAI.OutputMessageContentRefusalContent

En vägran från modellen.

Namn	Typ	Description	Krävs	Förinställning
vägran	snöre	Avslagsförklaringen från modellen.	Ja
typ	enum	Typ av vägran. Alltid refusal. Möjliga värden: refusal	Ja

OpenAI.OutputMessageContentType

Fastighet	Värde
Type	snöre
Värden	output_text refusal

OpenAI.Prompt

Referens till en promptmall och dess variabler. Läs mer.

Namn	Typ	Description	Krävs	Förinställning
Id-nummer	snöre	Den unika identifieraren för den promptmall som ska användas.	Ja
variabler	OpenAI.ResponsePromptVariables (nullbar)	Valfri mappning av värden att ersätta med variabler i din snabb. Ersättningsvärdena kan antingen vara strängar eller andra Svarsindatatyper som bilder eller filer.	Nej.
version	sträng (nullbar)		Nej.

OpenAI.RankerVersionType

Fastighet	Värde
Type	snöre
Värden	auto default-2024-11-15

OpenAI.Rankningsalternativ

Namn	Typ	Description	Krävs	Förinställning
hybrid_search	OpenAI.HybridSearchOptions		Nej.
└– embedding_weight	OpenAI.numeric	Vikten av inbäddningen i den reciproka rankningsfusionen.	Ja
└– text_weight	OpenAI.numeric	Textens tyngd i den ömsesidiga rangordningsfusionen.	Ja
rankare	OpenAI.RankerVersionType		Nej.
poängtröskel	OpenAI.numeric		Nej.

OpenAI.Reasoning

Endast GPT-5 och O-serie modeller Konfigurationsalternativ för resonemangsmodeller.

Namn	Typ	Description	Krävs	Förinställning
effort	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
generate_summary	enum	Möjliga värden: auto, concise, detailed	Nej.
summary	enum	Möjliga värden: auto, concise, detailed	Nej.

OpenAI.ReasoningEffort

Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden ä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 går som standard till none, vilket inte utför resonemang. De stödda resonemangsvärdena 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 används som gpt-5.1 standard resonerande medium och stödjer noneinte.
• Modellen gpt-5-pro använder som standard (och stödjer bara) high resonemangsarbete.
• xhigh stöds för alla modeller efter gpt-5.1-codex-max.

Fastighet	Värde
Type	snöre
Nullbar	Ja
Värden	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

Resonerande text från modellen.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	Resonemangstexten från modellen.	Ja
typ	enum	Typen av resonemangstext. Alltid reasoning_text. Möjliga värden: reasoning_text	Ja

OpenAI.Response

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference (nullbar)		Ja
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
bakgrund	boolesk (nullbar)		Nej.
klarad_vid	integer		Nej.
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.	Nej.
└– id	snöre	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	snöre	En läsbar beskrivning av felet.	Ja
Id-nummer	snöre	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	Nej.
instructions	sträng eller matris med OpenAI.InputItem		Ja
max_output_tokens	OpenAI.integer (nullbar)		Nej.
max_tool_calls	OpenAI.integer (nullbar)		Nej.
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.	Nej.
model	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
objekt	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)		Nej.
parallella verktygsanrop	booleskt	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	Sann
previous_response_id	sträng (nullbar)		Nej.
prompt	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
prompt_cache_key	snöre	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.	Nej.
prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
reasoning	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└— insats	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
└– generate_summary	enum	Möjliga värden: auto, concise, detailed	Nej.
└— sammanfattning	enum	Möjliga värden: auto, concise, detailed	Nej.
safety_identifier	snöre	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.	Nej.
servicenivå	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
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	Nej.
temperatur	OpenAI.numeric (nullbar)		Nej.	1
text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
tool_choice	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
top_logprobs	OpenAI.integer (nullbar)		Nej.
top_p	OpenAI.numeric (nullbar)		Nej.	1
truncation	enum	Möjliga värden: auto, disabled	Nej.
usage	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Nej.
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.	Nej.

OpenAI.ResponseAudioDeltaEvent

Genereras när det finns ett partiellt ljudsvar.

Namn	Typ	Description	Krävs	Förinställning
delta	snöre	Ett segment med Base64-kodade svarsljudbyte.	Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
delta	snöre	Den partiella avskriften av ljudsvaret.	Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
delta	snöre	Det partiella kodfragmentet som strömmas av kodtolkaren.	Ja
item_id	snöre	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
kod	snöre	Det slutliga utdatat från kodtolken för kodfragmentet.	Ja
item_id	snöre	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för kodtolkarverktygets anropsobjekt.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		Nej.
└– completed_at	heltal (nullable)		Nej.
└– 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.	Nej.
└– 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	snöre	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)		Nej.
└– max_tool_calls	OpenAI.integer (nullbar)		Nej.
└– 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.	Nej.
└– modell	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
└– 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)		Nej.
└– parallel_tool_calls	booleskt	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	Sann
└– föregående_svar_id	sträng (nullbar)		Nej.
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
└– prompt_cache_key	snöre	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.	Nej.
└– prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└– safety_identifier	snöre	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.	Nej.
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
└— 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	Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
└— 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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
└– top_logprobs	OpenAI.integer (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
└– trunkering	enum	Möjliga värden: auto, disabled	Nej.
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Nej.
└– 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.	Nej.
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
item_id	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
item_id	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		Nej.
└– completed_at	heltal (nullable)		Nej.
└– 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.	Nej.
└– 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	snöre	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)		Nej.
└– max_tool_calls	OpenAI.integer (nullbar)		Nej.
└– 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.	Nej.
└– modell	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
└– 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)		Nej.
└– parallel_tool_calls	booleskt	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	Sann
└– föregående_svar_id	sträng (nullbar)		Nej.
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
└– prompt_cache_key	snöre	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.	Nej.
└– prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└– safety_identifier	snöre	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.	Nej.
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
└— 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	Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
└— 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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
└– top_logprobs	OpenAI.integer (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
└– trunkering	enum	Möjliga värden: auto, disabled	Nej.
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Nej.
└– 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.	Nej.
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
delta	snöre	Inkrementella indata (delta) för det anpassade verktygsanropet.	Ja
item_id	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
input	snöre	Fullständiga indata för det anpassade verktygsanropet.	Ja
item_id	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
kod	OpenAI.ResponseErrorCode	Felkoden för svaret.	Ja
meddelande	snöre	En läsbar beskrivning av felet.	Ja

OpenAI.ResponseErrorCode

Felkoden för svaret.

Fastighet	Värde
Type	snöre
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.

Namn	Typ	Description	Krävs	Förinställning
kod	sträng (nullbar)		Ja
meddelande	snöre	Felmeddelandet.	Ja
Param	sträng (nullbar)		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		Nej.
└– completed_at	heltal (nullable)		Nej.
└– 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.	Nej.
└– 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	snöre	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)		Nej.
└– max_tool_calls	OpenAI.integer (nullbar)		Nej.
└– 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.	Nej.
└– modell	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
└– 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)		Nej.
└– parallel_tool_calls	booleskt	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	Sann
└– föregående_svar_id	sträng (nullbar)		Nej.
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
└– prompt_cache_key	snöre	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.	Nej.
└– prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└– safety_identifier	snöre	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.	Nej.
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
└— 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	Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
└— 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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
└– top_logprobs	OpenAI.integer (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
└– trunkering	enum	Möjliga värden: auto, disabled	Nej.
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Nej.
└– 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.	Nej.
sequence_number	OpenAI.integer		Ja
typ	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).

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID för utdataobjektet när filsökningsanropet initieras.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	enum	Typen av händelse. Alltid response.file_search_call.searching. Möjliga värden: response.file_search_call.searching	Ja

OpenAI.ResponseFormatJsonObject

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 kommer att generera JSON utan ett system- eller användarmeddelande som instruerar den to do det.

Namn	Typ	Description	Krävs	Förinställning
typ	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är dig mer om Structured Outputs.

Namn	Typ	Description	Krävs	Förinställning
json-schema	OpenAI.ResponseFormatJsonSchemaJsonSchema		Ja
└— beskrivning	snöre		Nej.
└— namn	snöre		Ja
└– schema	OpenAI.ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.	Nej.
└– strikt	boolesk (nullbar)		Nej.
typ	enum	Vilken typ av svarsformat som definieras. Alltid json_schema. Möjliga värden: json_schema	Ja

OpenAI.ResponseFormatJsonSchemaJsonSchema

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre		Nej.
name	snöre		Ja
schema	OpenAI.ResponseFormatJsonSchemaSchema	Schemat för svarsformatet, som beskrivs som ett JSON-schemaobjekt. Lär dig hur du skapar JSON-scheman här.	Nej.
strict	boolesk (nullbar)		Nej.

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.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
delta	snöre	Funktionsanropsargumentens delta som läggs till.	Ja
item_id	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	Argumenten för funktionsanrop.	Ja
item_id	snöre	Objektets ID.	Ja
name	snöre	Namnet på funktionen som anropades.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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).

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för det bildgenereringsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
partial_image_b64	snöre	Base64-kodade partiella bilddata, lämpliga för återgivning som en bild.	Ja
partial_image_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		Nej.
└– completed_at	heltal (nullable)		Nej.
└– 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.	Nej.
└– 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	snöre	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)		Nej.
└– max_tool_calls	OpenAI.integer (nullbar)		Nej.
└– 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.	Nej.
└– modell	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
└– 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)		Nej.
└– parallel_tool_calls	booleskt	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	Sann
└– föregående_svar_id	sträng (nullbar)		Nej.
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
└– prompt_cache_key	snöre	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.	Nej.
└– prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└– safety_identifier	snöre	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.	Nej.
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
└— 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	Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
└— 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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
└– top_logprobs	OpenAI.integer (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
└– trunkering	enum	Möjliga värden: auto, disabled	Nej.
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Nej.
└– 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.	Nej.
sequence_number	OpenAI.integer		Ja
typ	enum	Typen av händelse. Alltid response.in_progress. Möjliga värden: response.in_progress	Ja

OpenAI.ResponseIncompleteDetails

Namn	Typ	Description	Krävs	Förinställning
reason	enum	Möjliga värden: max_output_tokens, content_filter	Nej.

OpenAI.ResponseIncompleteEvent

En händelse som genereras när ett svar avslutas som ofullständigt.

Namn	Typ	Description	Krävs	Förinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		Nej.
└– completed_at	heltal (nullable)		Nej.
└– 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.	Nej.
└– 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	snöre	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)		Nej.
└– max_tool_calls	OpenAI.integer (nullbar)		Nej.
└– 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.	Nej.
└– modell	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
└– 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)		Nej.
└– parallel_tool_calls	booleskt	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	Sann
└– föregående_svar_id	sträng (nullbar)		Nej.
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
└– prompt_cache_key	snöre	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.	Nej.
└– prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└– safety_identifier	snöre	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.	Nej.
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
└— 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	Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
└— 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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
└– top_logprobs	OpenAI.integer (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
└– trunkering	enum	Möjliga värden: auto, disabled	Nej.
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Nej.
└– 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.	Nej.
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
logprob	OpenAI.numeric		Ja
token	snöre	En möjlig texttoken.	Ja
top_logprobs	matris med OpenAI.ResponseLogProbTopLogprobs	Loggens sannolikhet för de 20 mest sannolika token.	Nej.

OpenAI.ResponseLogProbTopLogprobs

Namn	Typ	Description	Krävs	Förinställning
logprob	OpenAI.numeric		Nej.
token	snöre		Nej.

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Genereras när det finns ett delta (partiell uppdatering) till argumenten för ett MCP-verktygsanrop.

Namn	Typ	Description	Krävs	Förinställning
delta	snöre	En JSON-sträng som innehåller den partiella uppdateringen av argumenten för MCP-verktygsanropet.	Ja
item_id	snöre	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
arguments	snöre	En JSON-sträng som innehåller de slutgiltiga argumenten för MCP-verktygsanropet.	Ja
item_id	snöre	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID:t för MCP-verktyget anropar objektet som har slutförts.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID:t för MCP-verktygets anropsobjekt som misslyckades.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Den unika identifieraren för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID:t för MCP-verktyget anropar objektet som genererade dessa utdata.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID:t för MCP-verktygets anropsobjekt som misslyckades.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID:t för MCP-verktygets anropsobjekt som bearbetas.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item	OpenAI.OutputItem		Ja
└– agent_reference	AgentReference	Agenten som skapade objektet.	Nej.
└response_id	snöre	Svaret som objektet skapas på.	Nej.
└– typ	OpenAI.OutputItemType		Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item	OpenAI.OutputItem		Ja
└– agent_reference	AgentReference	Agenten som skapade objektet.	Nej.
└response_id	snöre	Svaret som objektet skapas på.	Nej.
└– typ	OpenAI.OutputItemType		Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
annotation	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	snöre	Den unika identifieraren för det objekt som anteckningen läggs till i.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	enum	Typen av händelse. Alltid "response.output_text.annotation.added". Möjliga värden: response.output_text.annotation.added	Ja

OpenAI.ResponsePromptVariables

Valfri mappning av värden att ersätta med variabler i din fråga. 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.

Namn	Typ	Description	Krävs	Förinställning
response	OpenAI.Response		Ja
└– agent_reference	AgentReference (nullbar)	Agenten som används för det här svaret	Ja
└– bakgrund	boolesk (nullbar)		Nej.
└– completed_at	heltal (nullable)		Nej.
└– 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.	Nej.
└– 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	snöre	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)		Nej.
└– max_tool_calls	OpenAI.integer (nullbar)		Nej.
└– 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.	Nej.
└– modell	snöre	Implementeringen av modellen som ska användas för att skapa det här svaret.	Nej.
└– 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)		Nej.
└– parallel_tool_calls	booleskt	Om modellen ska kunna köra verktygsanrop parallellt.	Ja	Sann
└– föregående_svar_id	sträng (nullbar)		Nej.
└─ uppmaning	OpenAI.Prompt	Referens till en promptmall och dess variabler. Läs mer.	Nej.
└– prompt_cache_key	snöre	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.	Nej.
└– prompt_cache_retention	enum	Möjliga värden: in-memory, 24h	Nej.
└– resonemang	OpenAI.Reasoning (nullbar)	endast gpt-5- och o-seriens modeller Konfigurationsalternativ för resonemangsmodeller.	Nej.
└– safety_identifier	snöre	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.	Nej.
└– service_tier	OpenAI.ServiceTier	Anger den bearbetningstyp som används för att hantera begäran. - Om den är inställd på 'auto' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'. – 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå. – 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.	Nej.
└— 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	Nej.
└– temperatur	OpenAI.numeric (nullbar)		Nej.	1
└– text	OpenAI.ResponseTextParam	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data. Lära sig mer: - Textinmatningar och utmatningar - Strukturerade Utdata	Nej.
└– verktygsval	OpenAI.ToolChoiceOptions eller OpenAI.ToolChoiceParam		Nej.
└— 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, som 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 Tools. - 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 funktion anropar. Du kan också använda anpassade verktyg för att anropa din egen kod.	Nej.
└– top_logprobs	OpenAI.integer (nullbar)		Nej.
└– top_p	OpenAI.numeric (nullbar)		Nej.	1
└– trunkering	enum	Möjliga värden: auto, disabled	Nej.
└— användning	OpenAI.ResponseUsage	Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.	Nej.
└– 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.	Nej.
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID:t för objektet som den här sammanfattningsdelen är associerad med.	Ja
output_index	OpenAI.integer		Ja
del	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Ja
└– text	snöre		Ja
└– typ	enum	Möjliga värden: summary_text	Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		Ja
typ	enum	Typen av händelse. Alltid response.reasoning_summary_part.added. Möjliga värden: response.reasoning_summary_part.added	Ja

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Namn	Typ	Description	Krävs	Förinställning
text	snöre		Ja
typ	enum	Möjliga värden: summary_text	Ja

OpenAI.ResponseReasoningSummaryPartDoneEvent

Genereras när en sammanfattningsdel av resonemanget har slutförts.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	ID:t för objektet som den här sammanfattningsdelen är associerad med.	Ja
output_index	OpenAI.integer		Ja
del	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Ja
└– text	snöre		Ja
└– typ	enum	Möjliga värden: summary_text	Ja
sequence_number	OpenAI.integer		Ja
summary_index	OpenAI.integer		Ja
typ	enum	Typen av händelse. Alltid response.reasoning_summary_part.done. Möjliga värden: response.reasoning_summary_part.done	Ja

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Namn	Typ	Description	Krävs	Förinställning
text	snöre		Ja
typ	enum	Möjliga värden: summary_text	Ja

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Genereras när ett delta läggs till i en sammanfattningstext för resonemang.

Namn	Typ	Description	Krävs	Förinställning
delta	snöre	Textdeltat som har lagts till i sammanfattningen.	Ja
item_id	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	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	snöre	Den fullständiga texten i den slutförda motiveringssammanfattningen.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
delta	snöre	Textdeltat som lades till i resonemangsinnehållet.	Ja
item_id	snöre	ID:t för objektet som det här textdeltat är associerat med.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
item_id	snöre	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	snöre	Den fullständiga texten i det slutförda resonemangsinnehållet.	Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
delta	snöre	Avslagstexten som läggs till.	Ja
item_id	snöre	ID för det utdataobjekt som avslagstexten läggs till i.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
item_id	snöre	ID för det utdataobjekt där avslagstexten slutförs.	Ja
output_index	OpenAI.integer		Ja
vägran	snöre	Avslagstexten som har slutförts.	Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
include_obfuscation	booleskt	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 ange include_obfuscation till false för att optimera bandbredden om du litar på nätverkslänkarna mellan ditt program och OpenAI-API:et.	Nej.

OpenAI.ResponseTextDeltaEvent

Genereras när det finns ytterligare ett textdelta.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
delta	snöre	Textdeltat som lades till.	Ja
item_id	snöre	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
content_index	OpenAI.integer		Ja
item_id	snöre	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	snöre	Textinnehållet som har slutförts.	Ja
typ	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:

• Textinmatningar och -utdata
• Strukturerade utdata

Namn	Typ	Description	Krävs	Förinstä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.	Nej.
Informationsnivån	OpenAI.Verbosity	Begränsar hur ordrik modellens svar är. 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.	Nej.

OpenAI.ResponseUsage

Representerar information om tokenanvändning, inklusive indatatoken, utdatatoken, en uppdelning av utdatatoken och de totala token som används.

Namn	Typ	Description	Krävs	Förinställning
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

Namn	Typ	Description	Krävs	Förinställning
cached_tokens	OpenAI.integer		Ja

OpenAI.ResponseUsageOutputTokensDetails

Namn	Typ	Description	Krävs	Förinställning
reasoning_tokens	OpenAI.integer		Ja

OpenAI.ResponseWebSearchCallCompletedEvent

Genereras när ett webbsökningsanrop har slutförts.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
item_id	snöre	Unikt ID för utdataobjektet som är associerat med webbsökningsanropet.	Ja
output_index	OpenAI.integer		Ja
sequence_number	OpenAI.integer		Ja
typ	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.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Anger händelsetypen. För en skärmbildåtgärd är den här egenskapen alltid inställd på screenshot. Möjliga värden: screenshot	Ja

OpenAI.Scroll

En scrollningsåtgärd.

Namn	Typ	Description	Krävs	Förinställning
scroll_x	OpenAI.integer		Ja
scroll_y	OpenAI.integer		Ja
typ	enum	Anger händelsetypen. För en rullningsåtgärd är den här egenskapen alltid inställd på scroll. Möjliga värden: scroll	Ja
x	OpenAI.integer		Ja
y	OpenAI.integer		Ja

OpenAI.SearchContextSize

Fastighet	Värde
Type	snöre
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' kommer förfrågan att behandlas med servicenivån konfigurerad i Project-inställningarna. Om inget annat är konfigurerat, kommer Project att använda 'default'.
• 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 'priority', kommer förfrågan att behandlas med motsvarande tjänstenivå.
• 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.

Fastighet	Värde
Type	snöre
Nullbar	Ja
Värden	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

Tvingar modellen att anropa verktyget apply_patch när ett verktygsanrop körs.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Verktyget som ska anropas. Alltid shell. Möjliga värden: shell	Ja

OpenAI.Summary

En sammanfattningstext från modellen.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	En sammanfattning av resonemangsresultatet från modellen hittills.	Ja
typ	enum	Typ av objekt. Alltid summary_text. Möjliga värden: summary_text	Ja

OpenAI.SummaryTextContent

En sammanfattningstext från modellen.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	En sammanfattning av resonemangsresultatet från modellen hittills.	Ja
typ	enum	Typ av objekt. Alltid summary_text. Möjliga värden: summary_text	Ja

OpenAI.TextContent

Ett textinnehåll.

Namn	Typ	Description	Krävs	Förinställning
text	snöre		Ja
typ	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 { "type": "json_object" } aktivera det äldre JSON-läget, vilket säkerställer att meddelandet 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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.TextResponseFormatConfigurationType		Ja

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

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 kommer att generera JSON utan ett system- eller användarmeddelande som instruerar den to do det.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Vilken typ av svarsformat som definieras. Alltid text. Möjliga värden: text	Ja

OpenAI.TextResponseFormatConfigurationType

Fastighet	Värde
Type	snöre
Värden	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

JSON-schema svarsformat. Används för att generera strukturerade JSON-svar. Lär dig mer om Structured Outputs.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	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.	Nej.
name	snöre	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
strict	boolesk (nullbar)		Nej.
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ToolType		Ja

OpenAI.ToolChoiceAllowed

Begränsar de verktyg som är tillgängliga för modellen till en fördefinierad uppsättning.

Namn	Typ	Description	Krävs	Förinställning
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
verktyg	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
typ	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är dig mer om inbyggda verktyg.

Namn	Typ	Description	Krävs	Förinställning
typ	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är dig mer om inbyggda verktyg.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
name	snöre	Namnet på det anpassade verktyg som ska anropas.	Ja
typ	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är dig mer om inbyggda verktyg.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
name	snöre	Namnet på funktionen som ska anropas.	Ja
typ	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är dig mer om inbyggda verktyg.

Namn	Typ	Description	Krävs	Förinställning
typ	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.

Namn	Typ	Description	Krävs	Förinställning
name	sträng (nullbar)		Nej.
serveretikett	snöre	Etiketten på DEN MCP-server som ska användas.	Ja
typ	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.

Fastighet	Värde
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
typ	OpenAI.ToolChoiceParamType		Ja

OpenAI.ToolChoiceParamType

Fastighet	Värde
Type	snöre
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är dig mer om inbyggda verktyg.

Namn	Typ	Description	Krävs	Förinställning
typ	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är dig mer om inbyggda verktyg.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Möjliga värden: web_search_preview_2025_03_11	Ja

OpenAI.ToolType

Fastighet	Värde
Type	snöre
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 och som utökar modellens kapaciteter, som 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 Tools.
• 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är dig mer om function calling. Du kan också använda anpassade verktyg för att anropa din egen kod.

Matris för: OpenAI.Tool

OpenAI.TopLogProb

Den högsta loggens sannolikhet för en token.

Namn	Typ	Description	Krävs	Förinställning
bytes	matris med OpenAI.integer		Ja
logprob	OpenAI.numeric		Ja
token	snöre		Ja

OpenAI.Type

En åtgärd för att skriva in text.

Namn	Typ	Description	Krävs	Förinställning
text	snöre	Texten som ska skrivas.	Ja
typ	enum	Anger händelsetypen. För en typåtgärd är den här egenskapen alltid inställd på type. Möjliga värden: type	Ja

OpenAI.UpdateConversationBody

Namn	Typ	Description	Krävs	Förinstä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.

Namn	Typ	Description	Krävs	Förinställning
end_index	OpenAI.integer		Ja
start_index	OpenAI.integer		Ja
title	snöre	Webbresursens rubrik.	Ja
typ	enum	Typ av URL-källhänvisning. Alltid url_citation. Möjliga värden: url_citation	Ja
URL	snöre	Url:en för webbresursen.	Ja

OpenAI.VectorStoreFileAttributes

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, booleska värden eller tal.

Typ: objekt

OpenAI.Verbosity

Begränsar hur ordrik modellens svar är. Lägre värden ger mer koncisa svar, medan högre värden ger mer utförliga svar. Värden som stöds för närvarande är low, mediumoch high.

Fastighet	Värde
Type	snöre
Nullbar	Ja
Värden	low medium high

OpenAI.Wait

En väntåtgärd.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Anger händelsetypen. För en vänta-åtgärd är den här egenskapen 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.

Namn	Typ	Description	Krävs	Förinställning
pattern	snöre	Det mönster eller den text som ska sökas efter på sidan.	Ja
typ	enum	Åtgärdstypen. Möjliga värden: find_in_page	Ja
URL	snöre	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.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Åtgärdstypen. Möjliga värden: open_page	Ja
URL	snöre	Url:en som öppnats av modellen.	Ja

OpenAI.WebSearchActionSearch

Åtgärdstyp "sök" – Utför en webbsökningsfråga.

Namn	Typ	Description	Krävs	Förinställning
queries	strängmatris	Sökfrågorna.	Nej.
query	sträng (inaktuell)	[INAKTUELL] Sökfrågan.	Ja
Källor	matris med OpenAI.WebSearchActionSearchSources	De källor som använts i sökningen.	Nej.
typ	enum	Åtgärdstypen. Möjliga värden: search	Ja

OpenAI.WebSearchActionSearchSources

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Möjliga värden: url	Ja
URL	snöre		Ja

OpenAI.WebSearchApproximateLocation

Användarens ungefärliga plats.

Namn	Typ	Description	Krävs	Förinställning
city	sträng (nullbar)		Nej.
country	sträng (nullbar)		Nej.
region	sträng (nullbar)		Nej.
timezone	sträng (nullbar)		Nej.
typ	enum	Typ av platsapproximation. Alltid approximate. Möjliga värden: approximate	Nej.

OpenAI.WebSearchPreviewTool

Detta verktyg söker på webben efter relevanta resultat att använda i ett svar. Läs mer om webbsökverktyget.

Namn	Typ	Description	Krävs	Förinställning
sök_kontextstorlek	OpenAI.SearchContextSize		Nej.
typ	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)		Nej.
└— stad	sträng (nullbar)		Nej.
└– land	sträng (nullbar)		Nej.
└– region	sträng (nullbar)		Nej.
└– tidszon	sträng (nullbar)		Nej.
└– typ	enum	Typ av platsapproximation. Alltid approximate. Möjliga värden: approximate	Ja

OpenAI.WebSearchTool

Sök på internet efter källor relaterade till prompten. Läs mer om webbsökverktyget.

Namn	Typ	Description	Krävs	Förinställning
custom_search_configuration	WebSearchConfiguration	En webbsökningskonfiguration för bing anpassad sökning	Nej.
└– instance_name	snöre	Namnet på den anpassade konfigurationsinstans som angetts för konfigurationen.	Ja
└– project_connection_id	snöre	Project anslutnings-id för jordning med bing anpassad sökning	Ja
filters	OpenAI.WebSearchToolFilters (nullbar)		Nej.
└– allowed_domains	matris med sträng (nullbar)		Nej.
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, mediumeller high. medium används som standard. Möjliga värden: low, medium, high	Nej.
typ	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.	Nej.
└— stad	sträng (nullbar)		Nej.
└– land	sträng (nullbar)		Nej.
└– region	sträng (nullbar)		Nej.
└– tidszon	sträng (nullbar)		Nej.
└– typ	enum	Typ av platsapproximation. Alltid approximate. Möjliga värden: approximate	Nej.

OpenAI.WebSearchToolFilters

Namn	Typ	Description	Krävs	Förinställning
allowed_domains	strängmatris		Nej.

OpenAI.integer

Typ: heltal

Format: int64

OpenAI.numeric

Typ: tal

Format: dubbel

OpenApiAnonymousAuthDetails

Säkerhetsinformation för anonym OpenApi-autentisering

Namn	Typ	Description	Krävs	Förinställning
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	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)	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)

Fastighet	Värde
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 konfigurerat i AI Foundry) – Managed_Identity (kräver målgrupp för identitetsbaserad autentisering)
Type	snöre
Värden	anonymous project_connection managed_identity

OpenApiFunctionDefinition

Information om indatadefinition för en openapi-funktion.

Namn	Typ	Description	Krävs	Förinställning
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	Nej.
beskrivning	snöre	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej.
functions	matris med objekt	Lista över funktionsdefinitioner som används av OpenApi-verktyget	Nej.
name	snöre	Namnet på den funktion som ska anropas.	Ja
specifikation	objekt	Funktionsformen openapi, som beskrivs som ett JSON-schemaobjekt.	Ja

OpenApiManagedAuthDetails

Säkerhetsinformation för OpenApi managed_identity-autentisering

Namn	Typ	Description	Krävs	Förinställning
security_scheme	OpenApiManagedSecurityScheme	Säkerhetsschema för OpenApi managed_identity-autentisering	Ja
└— målgrupp	snöre	Autentiseringsomfång för managed_identity autentiseringstyp	Ja
typ	enum	Objekttypen, som alltid är "managed_identity". Möjliga värden: managed_identity	Ja

OpenApiManagedSecurityScheme

Säkerhetsschema för OpenApi managed_identity-autentisering

Namn	Typ	Description	Krävs	Förinställning
audience	snöre	Autentiseringsomfång för managed_identity autentiseringstyp	Ja

OpenApiProjectConnectionAuthDetails

Säkerhetsdetaljer för autentisering av OpenApi-projekt-anslutningar

Namn	Typ	Description	Krävs	Förinställning
security_scheme	OpenApiProjectConnectionSecurityScheme	Säkerhetsschema för OpenApi managed_identity-autentisering	Ja
└– project_connection_id	snöre	Project connection id för Project Connection-autentiseringstyp	Ja
typ	enum	Objekttypen, som alltid är "project_connection". Möjliga värden: project_connection	Ja

OpenApiProjectConnectionSecurityScheme

Säkerhetsschema för OpenApi managed_identity-autentisering

Namn	Typ	Description	Krävs	Förinställning
project_connection_id	snöre	Project connection id för Project Connection-autentiseringstyp	Ja

OpenApiTool

Information om indatadefinition för ett OpenAPI-verktyg som används för att konfigurera en agent.

Namn	Typ	Description	Krävs	Förinställning
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	Nej.
└— beskrivning	snöre	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej.
└– funktioner	matris med objekt (skrivskyddad)	Lista över funktionsdefinitioner som används av OpenApi-verktyget	Nej.
└— beskrivning	snöre	En beskrivning av vad funktionen gör, som används av modellen för att välja när och hur funktionen ska anropas.	Nej.
└— namn	snöre	Namnet på den funktion som ska anropas.	Ja
└— parametrar	objekt	Parametrarna som funktionerna accepterar, som beskrivs som ett JSON-schemaobjekt.	Ja
└— namn	snöre	Namnet på den funktion som ska anropas.	Ja
└– specifikation	objekt	Funktionsformen openapi, som beskrivs som ett JSON-schemaobjekt.	Ja
typ	enum	Objekttypen, som alltid är "openapi". Möjliga värden: openapi	Ja

Sidordning

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

PagedConnection

En sidindelad samling av anslutningsobjekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med anslutning	Anslutningsobjekten på den här sidan	Ja

PagedDatasetVersion

Sidad samling av DatasetVersion-objekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med DatasetVersion	Objekten DatasetVersion på den här sidan	Ja

PagedDeployment

En sidig samling distributionsobjekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med distribution	Distributionsobjekten på den här sidan	Ja

PagedEvaluationRule

Sidsidig samling med EvaluationRule-objekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med EvaluationRule	EvaluationRule-objekten på den här sidan	Ja

PagedEvaluationTaxonomy

Sidsidig samling av EvaluationTaxonomy-objekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med EvaluationTaxonomy	EvaluationTaxonomy-objekten på den här sidan	Ja

PagedEvaluatorVersion

Paged-samling med EvaluatorVersion-objekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris för EvaluatorVersion	EvaluatorVersion-objekten på den här sidan	Ja

PagedIndex

En sida med indexobjekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med index	Indexobjekten på den här sidan	Ja

PagedInsight

Sidsidig samling med Insight-objekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med Insight	Insight-objekten på den här sidan	Ja

PagedRedTeam

Sida samling av RedTeam-föremål

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med RedTeam	RedTeam-objekten på den här sidan	Ja

PagedSchedule

Sidad samling av schemaobjekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med schema	Schemalägg objekt på den här sidan	Ja

PagedScheduleRun

Sidad samling av ScheduleRun-objekt

Namn	Typ	Description	Krävs	Förinställning
nextLink	snöre	Länken till nästa sida med objekt	Nej.
värde	matris med ScheduleRun	ScheduleRun-objekten på den här sidan	Ja

PendingUploadRequest

Representerar en begäran om en väntande uppladdning.

Namn	Typ	Description	Krävs	Förinställning
connectionName (på engelska)	snöre	Azure Storage Account-anslutningsnamn att använda för att generera tillfällig SAS-token	Nej.
pendingUploadId	snöre	Om PendingUploadId inte anges används ett slumpmässigt GUID.	Nej.
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

Namn	Typ	Description	Krävs	Förinställning
blobReference	BlobReference	Information om blobreferens.	Ja
└– blobUri	snöre	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	Behörighetsinformation för att access storage kontot.	Ja
└– storageAccountArmId	snöre	ARM-ID för storage-kontot att använda.	Ja
pendingUploadId	snöre	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	snöre	Version av resursen som ska skapas om användaren inte angav version när överföringen skapades från början	Nej.

PromptAgentDefinition

Definitionen av promptagenten

Namn	Typ	Description	Krävs	Förinställning
instructions	sträng (nullbar)	Ett systemmeddelande (eller utvecklarmeddelande) som infogats i modellens kontext.	Nej.
typ	enum	Möjliga värden: prompt	Ja
model	snöre	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).	Nej.
└– rai_policy_name	snöre	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.	Nej.
└— insats	OpenAI.ReasoningEffort	Begränsar arbetet med resonemang för resonemangsmodeller. För närvarande stödda värden är none, minimal, , low, medium, highoch 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 stödda resonemangsvärdena 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 noneinte . – 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.	Nej.
└– generate_summary	enum	Möjliga värden: auto, concise, detailed	Nej.
└— sammanfattning	enum	Möjliga värden: auto, concise, detailed	Nej.
structured_inputs	objekt	En uppsättning strukturerade indata som kan delta i bindningar av promptmallsersättning eller verktygsargument.	Nej.
temperatur	Nummer	Vilken samplingstemperatur som ska användas, mellan 0 och 2. Högre värden som 0,8 gör utdata mer slumpmässiga, medan lägre värden som 0,2 gör det mer fokuserat och deterministiskt. Vi rekommenderar vanligtvis att du ändrar detta eller top_p men inte båda.	Nej.	1
text	PromptAgentDefinitionTextOptions	Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data.	Nej.
└– 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.	Nej.
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.	Nej.
verktyg	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 .	Nej.
top_p	Nummer	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.	Nej.	1

PromptAgentDefinitionTextOptions

Konfigurationsalternativ för ett textsvar från modellen. Kan vara oformaterad text eller strukturerade JSON-data.

Namn	Typ	Description	Krävs	Förinstä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.	Nej.

PromptBasedEvaluatorDefinition

Promptbaserad utvärderare

Namn	Typ	Description	Krävs	Förinställning
data_schema	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indata. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
init_parameters	objekt	JSON-schemat (utkast 2020-12) för utvärderarens indataparametrar. Detta inkluderar parametrar som typ, egenskaper, obligatoriskt.	Nej.
metrics	objekt	Förteckning över utfallsmått som tagits fram av den här utvärderaren	Nej.
prompt_text	snöre	Prompttexten som används för utvärdering	Ja
typ	enum	Möjliga värden: prompt	Ja

ProtocolVersionRecord

En postmappning för ett enskilt protokoll och dess version.

Namn	Typ	Description	Krävs	Förinställning
protocol	AgentProtocol		Ja
version	snöre	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).

Namn	Typ	Description	Krävs	Förinställning
rai_policy_name	snöre	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

Namn	Typ	Description	Krävs	Förinställning
typ	RecurrenceType	Typ av upprepning.	Ja

RecurrenceTrigger

Upprepningsbaserad utlösare.

Namn	Typ	Description	Krävs	Förinställning
endTime	snöre	Sluttid för upprepningsschemat i ISO 8601-format.	Nej.
interval	integer	Intervall för upprepningsschemat.	Ja
schedule	RecurrenceSchedule	Modell för upprepningsschema.	Ja
└– typ	RecurrenceType	Upprepningstyp för upprepningsschemat.	Ja
startTime	snöre	Starttid för upprepningsschemat i ISO 8601-format.	Nej.
timeZone	snöre	Tidszon för upprepningsschemat.	Nej.	UTC
typ	enum	Typ av utlösare. Möjliga värden: Recurrence	Ja

RecurrenceType

Typ av upprepning.

Fastighet	Värde
Beskrivning	Typ av upprepning.
Type	snöre
Värden	Hourly Daily Weekly Monthly

RedTeam

Detaljer om det röda laget.

Namn	Typ	Description	Krävs	Förinställning
applicationScenario	snöre	Programscenario för red team-åtgärden för att generera scenariospecifika attacker.	Nej.
attackStrategies	matris med AttackStrategy	Lista över attackstrategier eller kapslade listor över attackstrategier.	Nej.
visningsnamn	snöre	Namnet på det röda lagets körning.	Nej.
Id-nummer	sträng (skrivskyddad)	Identifierare för det röda lagets löpning.	Ja
numTurns	integer	Antal simuleringsrundor.	Nej.
egenskaper	objekt	Röda lagets egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	Nej.
riskCategories	matris med RiskCategory	Lista över riskkategorier som attackmål ska genereras för.	Nej.
simulationOnly	booleskt	Endast simulering eller simulering + utvärdering. Standardvärdet false, om det är sant matar genomsökningen ut konversationen, inte utvärderingsresultatet.	Nej.	Falsk
status	sträng (skrivskyddad)	Status för det röda laget. Den ställs in av tjänsten och är skrivskyddad.	Nej.
Taggar	objekt	Röda lagets taggar. Till skillnad från egenskaper är taggar helt föränderliga.	Nej.
mål	TargetConfig	Abstrakt klass för målkonfiguration.	Ja
└– typ	snöre	Typ av modellkonfiguration.	Ja

RedTeamEvalRunDataSource

Namn	Typ	Description	Krävs	Förinställning
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
mål	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	snöre	Typ av mål.	Ja
typ	enum	Typen av datakälla. Alltid azure_ai_red_team. Möjliga värden: azure_ai_red_team	Ja

RedTeamItemGenerationParams

Namn	Typ	Description	Krävs	Förinstä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
typ	enum	Typ av objektgenereringsparametrar. Möjliga värden: red_team	Ja

RedTeamSeedPromptsItemGenerationParams

Representerar parametrarna för red team seed prompts item generation.

Namn	Typ	Description	Krävs	Förinstä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
källa	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
typ	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.

Namn	Typ	Description	Krävs	Förinstä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
källa	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
typ	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.

Namn	Typ	Description	Krävs	Förinställning
data_mapping	objekt	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

RiskKategori

Riskkategori för attackmålet.

Fastighet	Värde
Beskrivning	Riskkategori för attackmålet.
Type	snöre
Värden	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Definition av Shared Access Signature (SAS) legitimation

Namn	Typ	Description	Krävs	Förinställning
SAS	sträng (skrivskyddad)	SAS-token	Nej.
typ	enum	Typ av autentiseringsuppgifter Möjliga värden: SAS	Ja

SampleType

Vilken typ av prov som används i analysen.

Fastighet	Värde
Beskrivning	Vilken typ av prov som används i analysen.
Type	snöre
Värden	EvaluationResultSample

SasCredential

Definition av SAS-autentiseringsuppgifter

Namn	Typ	Description	Krävs	Förinställning
sasUri	sträng (skrivskyddad)	SAS-uri	Ja
typ	enum	Typ av autentiseringsuppgifter Möjliga värden: SAS	Ja

Schema

Schemalägg modell.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Beskrivning av schemat.	Nej.
visningsnamn	snöre	Namnet på schemat.	Nej.
aktiverad	booleskt	Aktiverad status för schemat.	Ja
Id-nummer	sträng (skrivskyddad)	Identifierare för schemat.	Ja
egenskaper	objekt	Schemats egenskaper. Till skillnad från taggar är egenskaper endast tillägg. När en egenskap har lagts till kan den inte tas bort.	Nej.
Provisioneringsstatus	ScheduleProvisioningStatus (skrivskyddad)	Status för schemaläggning av etablering.	Nej.
systemData (på engelska)	objekt (skrivskyddat)	Systemmetadata för resursen.	Ja
Taggar	objekt	Schemats taggar. Till skillnad från egenskaper är taggar helt föränderliga.	Nej.
uppgift	ScheduleTask	Schemalägg uppgiftsmodell.	Ja
└– konfiguration	objekt	Konfiguration för uppgiften.	Nej.
└– 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.

Fastighet	Värde
Beskrivning	Status för schemaläggning av etablering.
Type	snöre
Värden	Creating Updating Deleting Succeeded Failed

ScheduleRun

Schemalägg körningsmodell.

Namn	Typ	Description	Krävs	Förinställning
fel	sträng (skrivskyddad)	Felinformation för schemakörningen.	Nej.
Id-nummer	sträng (skrivskyddad)	Identifierare för schemakörningen.	Ja
egenskaper	objekt (skrivskyddat)	Egenskaper för schemakörningen.	Ja
scheduleId	snöre	Identifierare för schemat.	Ja
framgång	booleskt värde (skrivskyddat)	Utlös status för lyckad schemakörning.	Ja
triggerTime	snöre	Utlösningstid för schemakörningen.	Nej.

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

Namn	Typ	Description	Krävs	Förinställning
configuration	objekt	Konfiguration för uppgiften.	Nej.
typ	ScheduleTaskType	Typ av uppgift.	Ja

ScheduleTaskType

Typ av uppgift.

Fastighet	Värde
Beskrivning	Typ av uppgift.
Type	snöre
Värden	Evaluation Insight

SharepointGroundingToolParameters

Parametrarna för sharepoint-jordningsverktyget.

Namn	Typ	Description	Krävs	Förinställning
project_connections	matris med ToolProjectConnection	Project-anslutningarna som är kopplade till detta verktyg. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget.	Nej.

SharepointPreviewTool

Information om indatadefinition för ett sharepoint-verktyg som används för att konfigurera en agent.

Namn	Typ	Description	Krävs	Förinställning
sharepoint_grounding_preview	SharepointGroundingToolParameters	Parametrarna för sharepoint-jordningsverktyget.	Ja
└– project_connections	matris med ToolProjectConnection	Project-anslutningarna som är kopplade till detta verktyg. Det kan finnas högst 1 anslutning resurs som är kopplad till verktyget. Begränsningar: maxItems: 1	Nej.
typ	enum	Objekttypen, som alltid är 'sharepoint_grounding_preview'. Möjliga värden: sharepoint_grounding_preview	Ja

Sku

SKU-information

Namn	Typ	Description	Krävs	Förinställning
capacity	integer	SKU-kapacitet	Ja
family	snöre	SKU-familj	Ja
name	snöre	SKU-namn	Ja
storlek	snöre	SKU-storlek	Ja
nivå	snöre	SKU-nivå	Ja

StructuredInputDefinition

En strukturerad indata som kan delta i promptmallersättningar och verktygsargumentbindning.

Namn	Typ	Description	Krävs	Förinställning
default_value		Standardvärdet för indata om inget körningsvärde anges.	Nej.
beskrivning	snöre	En läsbar beskrivning av indata.	Nej.
required	booleskt	Om indataegenskapen krävs när agenten anropas.	Nej.	Falsk
schema	objekt	JSON-schemat för strukturerade indata (valfritt).	Nej.

StructuredOutputDefinition

Strukturerade utdata som kan skapas av agenten.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En beskrivning av de utdata som ska genereras. Används av modellen för att avgöra när utdata ska genereras.	Ja
name	snöre	Namnet på strukturerade utdata.	Ja
schema	objekt	JSON-schemat för strukturerade utdata.	Ja
strict	boolesk (nullbar)	Om du vill framtvinga strikt validering. Standard true.	Ja

StructuredOutputsOutputItem

Namn	Typ	Description	Krävs	Förinställning
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
output		De strukturerade utdata som samlas in under svaret.	Ja
response_id	snöre	Svaret som objektet skapas på.	Nej.
typ	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.

Namn	Typ	Description	Krävs	Förinställning
inmatningsmeddelanden	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		Nej.
└– mall	matris med objekt eller OpenAI.EvalItem		Ja
└– typ	enum	Möjliga värden: template	Ja
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Ja
└– model_deployment_name	snöre	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.	Nej.
└– output_dataset_name	snöre	Namnet på den utdatauppsättning där genererade syntetiska data lagras. Om det inte tillhandahålls genererar tjänsten datauppsättningsnamnet automatiskt.	Nej.
└─ uppmaning	snöre	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.	Nej.
└– 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
mål	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	snöre	Typ av mål.	Ja
typ	enum	Typen av datakälla, alltid azure_ai_synthetic_data_gen_preview. Möjliga värden: azure_ai_synthetic_data_gen_preview	Ja

SyntheticDataGenerationPreviewItemGenerationParams

Namn	Typ	Description	Krävs	Förinställning
model_deployment_name	snöre	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.	Nej.
output_dataset_name	snöre	Namnet på den utdatauppsättning där genererade syntetiska data lagras. Om det inte tillhandahålls genererar tjänsten datauppsättningsnamnet automatiskt.	Nej.
prompt	snöre	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.	Nej.
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

Mål

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

Namn	Typ	Description	Krävs	Förinställning
typ	snöre	Typ av mål.	Ja

TargetCompletionEvalRunDataSource

Representerar en datakälla för målbaserad slutförandeutvärderingskonfiguration.

Namn	Typ	Description	Krävs	Förinställning
inmatningsmeddelanden	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		Nej.
└– item_reference	snöre		Ja
└– typ	enum	Möjliga värden: item_reference	Ja
källa	OpenAI.EvalJsonlFileContentSource eller OpenAI.EvalJsonlFileIdSource	Källkonfigurationen för infogade data eller fildata.	Ja
mål	Mål	Basklass för mål med stöd för diskriminator.	Ja
└– typ	snöre	Typ av mål.	Ja
typ	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

Namn	Typ	Description	Krävs	Förinställning
typ	snöre	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

Namn	Typ	Description	Krävs	Förinställning
typ	snöre	Typ av mål.	Ja

TaxonomyCategory

Definition av taxonomikategori.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Beskrivning av taxonomikategorin.	Nej.
Id-nummer	snöre	Unik identifierare för taxonomikategorin.	Ja
name	snöre	Namnet på taxonomikategorin.	Ja
egenskaper	objekt	Ytterligare egenskaper för taxonomikategorin.	Nej.
riskCategory	RiskKategori	Riskkategori för attackmålet.	Ja
underkategorier	matris med TaxonomySubCategory	Lista över underkategorier inom taxonomi.	Ja

TaxonomySubCategory

Definition av underkategori taxonomi.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	Beskrivning av underkategorin taxonomi.	Nej.
aktiverad	booleskt	Förteckning över taxonomiartiklar i denna underkategori.	Ja
Id-nummer	snöre	Unik identitetsbeteckning för underkategorin i taxonomin.	Ja
name	snöre	Namn på underkategorin taxonomi.	Ja
egenskaper	objekt	Ytterligare egenskaper för underkategorin taxonomi.	Nej.

ToolDescription

Beskrivning av ett verktyg som kan användas av en agent.

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En kort beskrivning av verktygets syfte.	Nej.
name	snöre	Namnet på verktyget.	Nej.

ToolProjectConnection

En resurs för projekt-anslutning.

Namn	Typ	Description	Krävs	Förinställning
project_connection_id	snöre	En project-anslutning i en ToolProjectConnectionList kopplad till detta verktyg.	Ja

TracesPreviewEvalRunDataSource

Representerar en datakälla för utvärderingskörningar som körs via agentspårningar som lagras i Application Insights.

Namn	Typ	Description	Krävs	Förinställning
agent_id	snöre	Agent-ID:t som används för att filtrera spårningar för utvärdering.	Nej.
agent_name	snöre	Agentnamnet som används för att filtrera spårningar för utvärdering.	Nej.
end_time	integer	Unix-tidsstämpel (i sekunder) som markerar slutet av spårningsfrågefönstret. Standardvärdet är den aktuella tiden.	Nej.
ingestion_delay_seconds	integer	Fördröjningen för att ansöka om inmatning när du kör frågor mot spårningar.	Nej.	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.	Nej.	168
max_traces	integer	Samplingsgräns som tillämpas på spårningar som hämtats för utvärdering.	Nej.	1 000
trace_ids	strängmatris	Insamling av agentspårningsidentifierare som ska utvärderas.	Nej.
typ	enum	Typen av datakälla, alltid azure_ai_traces_preview. Möjliga värden: azure_ai_traces_preview	Ja

TreatmentEffectType

Typ av behandlingseffekt.

Fastighet	Värde
Beskrivning	Typ av behandlingseffekt.
Type	snöre
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

Namn	Typ	Description	Krävs	Förinställning
typ	TriggerType	Typ av utlösare.	Ja

TriggerType

Typ av utlösare.

Fastighet	Värde
Beskrivning	Typ av utlösare.
Type	snöre
Värden	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Namn	Typ	Description	Krävs	Förinställning
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
manifest_id	snöre	Manifest-ID:t som agentversionen ska importeras från.	Ja
metadata	objekt	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.	Nej.
parameter_values	objekt	Indata till manifestet som resulterar i en helt materialiserad agent.	Ja

UpdateAgentRequest

Namn	Typ	Description	Krävs	Förinställning
definitionen	AgentDefinition		Ja
└– typ	AgentKind		Ja
└– rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
beskrivning	snöre	En läsbar beskrivning av agenten. Begränsningar: maxLength: 512	Nej.
metadata	objekt	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.	Nej.

UpdateEvalParametersBody

Namn	Typ	Description	Krävs	Förinstä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.	Nej.
name	snöre		Nej.
egenskaper	objekt	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.	Nej.

UserProfileMemoryItem

Ett minnesobjekt som specifikt innehåller information om användarprofiler som extraherats från konversationer, till exempel preferenser, intressen och personliga uppgifter.

Namn	Typ	Description	Krävs	Förinställning
innehåll	snöre	Innehållet i minnet.	Ja
typ	enum	Typen av minnesobjekt. Möjliga värden: user_profile	Ja
memory_id	snöre	Det unika ID:t för minnesobjektet.	Ja
omfattning	snöre	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

Namn	Typ	Description	Krävs	Förinställning
instance_name	snöre	Namnet på den anpassade konfigurationsinstans som angetts för konfigurationen.	Ja
project_connection_id	snöre	Project anslutnings-id för jordning med bing anpassad sökning	Ja

WeeklyRecurrenceSchedule

Schema för upprepning varje vecka.

Namn	Typ	Description	Krävs	Förinställning
daysOfWeek	matris med DayOfWeek	Dagar i veckan för upprepningsschemat.	Ja
typ	enum	Typ av veckovis upprepning. Möjliga värden: Weekly	Ja

WorkflowActionOutputItem

Namn	Typ	Description	Krävs	Förinställning
action_id	snöre	Unik identifierare för åtgärden.	Ja
agent_reference	AgentReference		Nej.
└— namn	snöre	Namnet på agenten. Begränsningar: maxLength: 256	Ja
└– typ	enum	Möjliga värden: agent_reference	Ja
└— version	snöre	Agentens versionsidentifierare.	Nej.
typ	snöre	Typen av CSDL-åtgärd (t.ex. "SetVariable", "InvokeAzureAgent").	Ja
parent_action_id	snöre	ID för den överordnade åtgärden om det här är en kapslad åtgärd.	Nej.
previous_action_id	snöre	ID för föregående åtgärd om den här åtgärden följer en annan.	Nej.
response_id	snöre	Svaret som objektet skapas på.	Nej.
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
typ	enum	Möjliga värden: workflow_action	Ja

WorkflowAgentDefinition

Definitionen av arbetsflödesagenten.

Namn	Typ	Description	Krävs	Förinställning
typ	enum	Möjliga värden: workflow	Ja
rai_config	RaiConfig	Konfiguration för innehållsfiltrering och säkerhetsfunktioner för ansvarsfull AI (RAI).	Nej.
└– rai_policy_name	snöre	Namnet på den RAI-princip som ska tillämpas.	Ja
arbetsflöde	snöre	CSDL YAML-definitionen av arbetsflödet.	Nej.

integer

Typ: heltal

Format: int64