Microsoft Foundry

API-versie: v1

Authentication

Flow: impliciet

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

Scopes:

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

Agents

Agents - agent maken

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

Hiermee maakt u de agent.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview, HostedAgents=V1PreviewWorkflowAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De unieke naam waarmee de agent wordt geïdentificeerd. De naam kan worden gebruikt om de agent op te halen/bij te werken/te verwijderen. - Moet beginnen en eindigen met alfanumerieke tekens, - Kan afbreekstreepjes in het midden bevatten - Mag niet langer zijn dan 63 tekens. Beperkingen: maxLength: 63	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agents weergeven

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

Geeft de lijst met alle agenten terug.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
vriendelijk	zoekopdracht	No	tekenreeks Mogelijke waarden: prompt, hosted, , container_appworkflow	Filter agents op soort. Indien niet opgegeven, worden alle agents geretourneerd.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agent ophalen

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

Haalt de agent op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent die moet worden opgehaald.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agent bijwerken

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

Werkt de agent bij door een nieuwe versie toe te voegen als er wijzigingen zijn in de agentdefinitie. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent die moet worden opgehaald.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview, HostedAgents=V1PreviewWorkflowAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agent verwijderen

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

Hiermee verwijdert u een agent.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent die u wilt verwijderen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DeleteAgentResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agent bijwerken vanuit manifest

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

Hiermee werkt u de agent bij vanuit een manifest door een nieuwe versie toe te voegen als er wijzigingen in de agentdefinitie zijn. Als er geen wijzigingen zijn, wordt de bestaande agentversie geretourneerd.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent die moet worden bijgewerkt.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	tekenreeks	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
parameter_values	object	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agentversie maken

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

Maak een nieuwe agentversie.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De unieke naam waarmee de agent wordt geïdentificeerd. De naam kan worden gebruikt om de agent op te halen/bij te werken/te verwijderen. - Moet beginnen en eindigen met alfanumerieke tekens, - Kan afbreekstreepjes in het midden bevatten - Mag niet langer zijn dan 63 tekens.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview, HostedAgents=V1PreviewWorkflowAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentVersionObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agentversies vermelden

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

Retourneert de lijst met versies van een agent.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent voor het ophalen van versies.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agentversie ophalen

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

Haalt een specifieke versie van een agent op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent die moet worden opgehaald.
agent_version	path	Yes	tekenreeks	De versie van de agent die moet worden opgehaald.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentVersionObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agentversie verwijderen

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

Hiermee verwijdert u een specifieke versie van een agent.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent die u wilt verwijderen.
agent_version	path	Yes	tekenreeks	De versie van de agent die u wilt verwijderen
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DeleteAgentVersionResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents : agentversie maken vanuit manifest

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

Maak een nieuwe agentversie op basis van een manifest.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De unieke naam waarmee de agent wordt geïdentificeerd. De naam kan worden gebruikt om de agent op te halen/bij te werken/te verwijderen. - Moet beginnen en eindigen met alfanumerieke tekens, - Kan afbreekstreepjes in het midden bevatten - Mag niet langer zijn dan 63 tekens.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	tekenreeks	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
parameter_values	object	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentVersionObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agents - agent maken vanuit manifest

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

Maakt een agent van een manifest.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	tekenreeks	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De unieke naam waarmee de agent wordt geïdentificeerd. De naam kan worden gebruikt om de agent op te halen/bij te werken/te verwijderen. - Moet beginnen en eindigen met alfanumerieke tekens, - Kan afbreekstreepjes in het midden bevatten - Mag niet langer zijn dan 63 tekens. Beperkingen: maxLength: 63	Yes
parameter_values	object	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers

Agentcontainers - agentcontainerbewerkingen weergeven

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

Lijst met containerbewerkingen voor een agent.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - agentcontainerbewerking ophalen

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

De status van een containerbewerking voor een agent ophalen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
operation_id	path	Yes	tekenreeks	De bewerkings-id.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentContainerOperationObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - agentcontainer ophalen

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

Haal een container op voor een specifieke versie van een agent.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
agent_version	path	Yes	tekenreeks	De versie van de agent.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AgentContainerObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - containerbewerkingen van agentversie weergeven

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

Geef containerbewerkingen weer voor een specifieke versie van een agent.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
agent_version	path	Yes	tekenreeks	De versie van de agent.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - agentcontainer verwijderen

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

Een container verwijderen voor een specifieke versie van een agent. Als de container niet bestaat, wordt de bewerking no-op. De bewerking is een langdurige bewerking. Volg de ontwerprichtlijnen voor langdurige bewerkingen in Azure REST API's. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
agent_version	path	Yes	tekenreeks	De versie van de agent.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 202

Beschrijving: De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Inhoudstype	Type	Description
application/json	AgentContainerOperationObject

Antwoordheaders:

Koptekst	Typ	Description
Operatie-Locatie	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - containerlogboeken van agent streamen

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

Containerlogboekvermelding die vanuit de container wordt gestreamd als tekstsegmenten. Elk segment is een UTF-8-tekenreeks die een logboekregel zonder opmaak of een logboekvermelding met JSON-indeling kan zijn, afhankelijk van het type containerlogboek dat wordt gestreamd. Clients moeten elk segment behandelen als ondoorzichtige tekst en, indien nodig, proberen het te parseren als JSON op basis van hun logboekvereisten.

Voor systeemlogboeken, de indeling is JSON met de volgende structuur: {"TimeStamp":"2025-12-15T16:51:33Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Connecting to the events collector...","Reason":"StartingGettingEvents","EventSource":"ContainerAppController","Count":1} {"TimeStamp":"2025-12-15T16:51:34Z","Type":"Normal","ContainerAppName":null,"RevisionName":null,"ReplicaName":null,"Msg":"Successfully connected to events server","Reason":"ConnectedToEventsServer","EventSource":"ContainerAppController","Count":1}

Voor consolelogboeken is de indeling tekst zonder opmaak, zoals verzonden door de stdout/stderr van de container. 2025-12-15T08:43:48.72656 Verbinding maken met de container 'agent-container'... 2025-12-15T08:43:48.75451 Successfully Connected to container: 'agent-container' [Revision: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b', Replica: 'je90fe655aa742ef9a188b9fd14d6764--7tca06b-6898b9c89f-mpkjc'] 2025-12-15T08:33:59.0671054Z stdout F INFO: 127.0.0.1:42588 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:29.0649033Z stdout F INFO: 127.0.0.1:60246 - "GET /readiness HTTP/1.1" 200 OK 2025-12-15T08:34:59.0644467Z stdout F INFO: 127.0.0.1:43994 - "GET /readiness HTTP/1.1" 200 OK

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
agent_version	path	Yes	tekenreeks	De versie van de agent.
vriendelijk	zoekopdracht	No	tekenreeks Mogelijke waarden: console, system	console retourneert container stdout/stderr, systeem retourneert gebeurtenisstroom van container-app. standaardinstellingen voor console
replica_name	zoekopdracht	No	tekenreeks	Wanneer u dit weglaat, kiest de server de eerste replica voor consolelogboeken. Vereist om een specifieke replica te targeten.
staart	zoekopdracht	No	integer	Het aantal volglijnen dat wordt geretourneerd. Afgedwongen tot 1-300. Standaard ingesteld op 20
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - agentcontainer starten

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

Start een container voor een specifieke versie van een agent. Als de container al wordt uitgevoerd, wordt de bewerking no-op. De bewerking is een langdurige bewerking. Volg de ontwerprichtlijnen voor langdurige bewerkingen in Azure REST API's. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
agent_version	path	Yes	tekenreeks	De versie van de agent.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
max_replicas	integer	Het maximum aantal replica's. Wordt standaard ingesteld op 1.	No	1
min_replicas	integer	Het minimum aantal replica's. Wordt standaard ingesteld op 1.	No	1

Responses

Statuscode: 202

Beschrijving: De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Inhoudstype	Type	Description
application/json	AgentContainerOperationObject

Antwoordheaders:

Koptekst	Typ	Description
Operatie-Locatie	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - agentcontainer stoppen

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

Stop een container voor een specifieke versie van een agent. Als de container niet wordt uitgevoerd of al is gestopt, wordt de bewerking no-op. De bewerking is een langdurige bewerking. Volg de ontwerprichtlijnen voor langdurige bewerkingen in Azure REST API's. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
agent_version	path	Yes	tekenreeks	De versie van de agent.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 202

Beschrijving: De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Inhoudstype	Type	Description
application/json	AgentContainerOperationObject

Antwoordheaders:

Koptekst	Typ	Description
Operatie-Locatie	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Agentcontainers - agentcontainer bijwerken

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

Een container bijwerken voor een specifieke versie van een agent. Als de container niet wordt uitgevoerd, wordt de bewerking no-op. De bewerking is een langdurige bewerking. Volg de ontwerprichtlijnen voor langdurige bewerkingen in Azure REST API's. https://github.com/microsoft/api-guidelines/blob/vNext/azure/ConsiderationsForServiceDesign.md#action-operations

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
agent_name	path	Yes	tekenreeks	De naam van de agent.
agent_version	path	Yes	tekenreeks	De versie van de agent.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: ContainerAgents=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
max_replicas	integer	Het maximum aantal replica's.	No
min_replicas	integer	Het minimum aantal replica's.	No

Responses

Statuscode: 202

Beschrijving: De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Inhoudstype	Type	Description
application/json	AgentContainerOperationObject

Antwoordheaders:

Koptekst	Typ	Description
Operatie-Locatie	tekenreeks

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Verbindingen

Verbindingen - lijst

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

Alle verbindingen in het project weergeven zonder verbindingsreferenties in te vullen

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
connectionType	zoekopdracht	No	tekenreeks Mogelijke waarden: AzureOpenAI, AzureBlob, , AzureStorageAccount, CognitiveSearch, CosmosDB, ApiKey, AppConfigAppInsightsCustomKeysRemoteTool_Preview	Verbindingen van dit specifieke type weergeven
defaultConnection	zoekopdracht	No	boolean	Verbindingen weergeven die standaardverbindingen zijn

Koptekst van aanvraag

Name	Required	Typ	Description
x-ms-client-request-id	Onwaar	tekenreeks	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedConnection

Antwoordheaders:

Koptekst	Typ	Description
x-ms-client-request-id		Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Verbindingen - ophalen

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

Een verbinding ophalen op naam, zonder verbindingsreferenties in te vullen

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De beschrijvende naam van de verbinding, geleverd door de gebruiker.

Koptekst van aanvraag

Name	Required	Typ	Description
x-ms-client-request-id	Onwaar	tekenreeks	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Connection

Antwoordheaders:

Koptekst	Typ	Description
x-ms-client-request-id		Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Verbindingen - ophalen met referenties

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

Een verbinding ophalen op naam, met de bijbehorende verbindingsreferenties

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De beschrijvende naam van de verbinding, geleverd door de gebruiker.

Koptekst van aanvraag

Name	Required	Typ	Description
x-ms-client-request-id	Onwaar	tekenreeks	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Connection

Antwoordheaders:

Koptekst	Typ	Description
x-ms-client-request-id		Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Datasets

Gegevenssets - lijst met nieuwste gegevenssets

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

De nieuwste versie van elke DatasetVersion weergeven

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedDatasetVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Gegevenssets - lijstversies

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

Alle versies van de opgegeven DatasetVersion weergeven

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedDatasetVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Gegevenssets - versie ophalen

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

Haal de specifieke versie van de DatasetVersion op. De service retourneert de fout 404 Niet gevonden als de DatasetVersion niet bestaat.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De specifieke versie-id van de DatasetVersion die moet worden opgehaald.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DatasetVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Gegevenssets - versie verwijderen

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

Verwijder de specifieke versie van de DatasetVersion. De service retourneert 204 Geen inhoud als de DatasetVersion is verwijderd of als de DatasetVersion niet bestaat.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De versie van de DatasetVersion die moet worden verwijderd.

Responses

Statuscode: 204

Beschrijving: Er is geen inhoud die voor deze aanvraag moet worden verzonden, maar de headers kunnen nuttig zijn.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Gegevenssets - versie maken of bijwerken

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

Maak een nieuwe of werk een bestaande DatasetVersion bij met de opgegeven versie-id

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De specifieke versie-id van de DatasetVersion die moet worden gemaakt of bijgewerkt.

Aanvraaglichaam

Inhoudstype: toepassing/merge-patch+json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	DatasetType	Opsomming om het type gegevens te bepalen.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DatasetVersion

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	DatasetVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Gegevenssets - referenties ophalen

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

Haal de SAS-referentie op voor toegang tot het opslagaccount dat is gekoppeld aan een gegevenssetversie.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De specifieke versie-id van de DatasetVersion waarop moet worden uitgevoerd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	AssetCredentialResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Gegevenssets : beginnen met uploadversie in behandeling

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

Start een nieuwe of haal een bestaande upload van een gegevensset op voor een specifieke versie.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De specifieke versie-id van de DatasetVersion waarop moet worden uitgevoerd.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
connectionName	tekenreeks	Naam van de Azure Storage-accountverbinding die moet worden gebruikt voor het genereren van een tijdelijk SAS-token	No
pendingUploadId	tekenreeks	Als PendingUploadId niet is opgegeven, wordt een willekeurige GUID gebruikt.	No
pendingUploadType	enum	BlobReference is het enige ondersteunde type. Mogelijke waarden: BlobReference	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PendingUploadResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Implementaties

Implementaties - lijst

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

Alle geïmplementeerde modellen in het project weergeven

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
modelPublisher	zoekopdracht	No	tekenreeks	Modeluitgever om modellen te filteren op
modelName	zoekopdracht	No	tekenreeks	Modelnaam (de specifieke naam van de uitgever) om modellen te filteren op
deploymentType	zoekopdracht	No	tekenreeks Mogelijke waarden: ModelDeployment	Type implementatie om de lijst te filteren op

Koptekst van aanvraag

Name	Required	Typ	Description
x-ms-client-request-id	Onwaar	tekenreeks	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedDeployment

Antwoordheaders:

Koptekst	Typ	Description
x-ms-client-request-id		Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Implementaties - ophalen

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

Haal een geïmplementeerd model op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	Naam van de implementatie

Koptekst van aanvraag

Name	Required	Typ	Description
x-ms-client-request-id	Onwaar	tekenreeks	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Deployment

Antwoordheaders:

Koptekst	Typ	Description
x-ms-client-request-id		Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatietaxonomie

Evaluatietaxonomie - lijst

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

Evaluatietaxonomie weergeven

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
inputName	zoekopdracht	No	tekenreeks	Filter op de naam van de evaluatie-invoer.
inputType	zoekopdracht	No	tekenreeks	Filteren op invoertype taxonomie.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedEvaluationTaxonomy

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatietaxonomie - get

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

Een evaluatieuitvoering op naam ophalen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvaluationTaxonomy

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatietaxonomie - verwijderen

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

Verwijder een evaluatietaxonomie op naam.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 204

Beschrijving: Er is geen inhoud die voor deze aanvraag moet worden verzonden, maar de headers kunnen nuttig zijn.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatietaxonomie - maken

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

Maak een evaluatietaxonomie.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de evaluatietaxonomie.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
properties	object	Aanvullende eigenschappen voor de evaluatietaxonomie.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
taxonomiecategorieën	matrix van TaxonomieCategory	Lijst met taxonomiecategorieën.	No
taxonomieInput	EvaluationTaxonomyInput	Invoerconfiguratie voor de evaluatietaxonomie.	Yes
└type.	EvaluationTaxonomyInputType	Invoertype van de evaluatietaxonomie.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvaluationTaxonomy

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	EvaluationTaxonomy

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatietaxonomie - update

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

Een evaluatietaxonomie bijwerken.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de evaluatietaxonomie.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
properties	object	Aanvullende eigenschappen voor de evaluatietaxonomie.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
taxonomiecategorieën	matrix van TaxonomieCategory	Lijst met taxonomiecategorieën.	No
taxonomieInput	EvaluationTaxonomyInputUpdate	Invoerconfiguratie voor de evaluatietaxonomie.	No
└type.	EvaluationTaxonomyInputType	Invoertype van de evaluatietaxonomie.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvaluationTaxonomy

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatieregels

Evaluatieregels - lijst

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

Alle evaluatieregels weergeven.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
actionType	zoekopdracht	No	tekenreeks Mogelijke waarden: continuousEvaluation, humanEvaluationPreview	Filter op het type evaluatieregel.
agentName	zoekopdracht	No	tekenreeks	Filter op de naam van de agent.
enabled	zoekopdracht	No	boolean	Filter op de status ingeschakeld.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedEvaluationRule

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatieregels - get

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

Haal een evaluatieregel op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	Unieke id voor de evaluatieregel.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvaluationRule

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatieregels - verwijderen

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

Een evaluatieregel verwijderen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	Unieke id voor de evaluatieregel.

Responses

Statuscode: 204

Beschrijving: Er is geen inhoud die voor deze aanvraag moet worden verzonden, maar de headers kunnen nuttig zijn.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluatieregels - maken of bijwerken

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

Een evaluatieregel maken of bijwerken.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	Unieke id voor de evaluatieregel.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	Onwaar	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
action	EvaluationRuleAction	Evaluatie actiemodel.	Yes
└type.	EvaluationRuleActionType	Aard van de evaluatieactie.	Yes
beschrijving	tekenreeks	Beschrijving voor de evaluatieregel.	No
displayName	tekenreeks	Weergavenaam voor de evaluatieregel.	No
enabled	boolean	Geeft aan of de evaluatieregel is ingeschakeld. De standaardwaarde is waar.	Yes
eventType	EvaluationRuleEventType	Type van de gebeurtenis van de evaluatieregel.	Yes
filter	EvaluationRuleFilter	Evaluatie filtermodel.	No
└} agentName	tekenreeks	Filter op agentnaam.	Yes
id	tekenreeks (alleen-lezen)	Unieke id voor de evaluatieregel.	Yes
systeemgegevens	object (alleen-lezen)	Systeemmetagegevens voor de evaluatieregel.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvaluationRule

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	EvaluationRule

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Beoordelaars

Evaluators - lijst met nieuwste versies

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

Maak een lijst van de nieuwste versie van elke beoordelaar

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
type	zoekopdracht	No	tekenreeks Mogelijke waarden: builtin, customall	Filter evaluators op type. Mogelijke waarden: 'all', 'custom', 'builtin'.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedEvaluatorVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluators - lijstversies

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

Maak een lijst van alle versies van de gegeven evaluator

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
type	zoekopdracht	No	tekenreeks Mogelijke waarden: builtin, customall	Filter evaluators op type. Mogelijke waarden: 'all', 'custom', 'builtin'.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de standaardwaarde is 20.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedEvaluatorVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluators - versie maken

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

Maak een nieuwe EvaluatorVersion met automatisch verhoogde versie-id

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
categories	matrix van EvaluatorCategory	De categorieën van de evaluator	Yes
definitie	EvaluatorDefinition	Configuratie van basisbeoordelaar met discriminator	Yes
└data_schema	object	Het JSON-schema (Draft 2020-12) voor de invoergegevens van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
└init_parameters	object	Het JSON-schema (concept 2020-12) voor de invoerparameters van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
Metrische gegevens └*	object	Lijst met outputstatistieken geproduceerd door deze beoordelaar	No
└type.	EvaluatorDefinitionType	De definitie van het type beoordelaar	Yes
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
display_name	tekenreeks	Weergavenaam voor evaluator. Het helpt om de evaluator gemakkelijk te vinden in AI Foundry. Het hoeft niet uniek te zijn.	No
evaluator_type	EvaluatorType	Het type van de evaluator	Yes
metadata	object	Metadata over de evaluator	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No

Responses

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	EvaluatorVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluators - versie ophalen

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

Haal de specifieke versie van de EvaluatorVersion op. De service retourneert de fout 404 Not Found als de EvaluatorVersion niet bestaat.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De specifieke versie-id van de EvaluatorVersion die moet worden opgehaald.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvaluatorVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluators - versie verwijderen

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

Verwijder de specifieke versie van de EvaluatorVersion. De service retourneert 204 Geen inhoud als de EvaluatorVersion met succes is verwijderd of als de EvaluatorVersion niet bestaat.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De versie van de EvaluatorVersion die moet worden verwijderd.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 204

Beschrijving: Er is geen inhoud die voor deze aanvraag moet worden verzonden, maar de headers kunnen nuttig zijn.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Evaluators - updateversie

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

Werk een bestaande EvaluatorVersion bij met de opgegeven versie-id

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De versie van de EvaluatorVersion die moet worden bijgewerkt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Evaluations=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
categories	matrix van EvaluatorCategory	De categorieën van de evaluator	No
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
display_name	tekenreeks	Weergavenaam voor evaluator. Het helpt om de evaluator gemakkelijk te vinden in AI Foundry. Het hoeft niet uniek te zijn.	No
metadata	object	Metadata over de evaluator	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvaluatorVersion

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Indexes

Indexen - lijst met meest recente

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

De nieuwste versie van elke index weergeven

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedIndex

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Indexen - lijstversies

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

Alle versies van de opgegeven index weergeven

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedIndex

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Indexen - versie ophalen

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

Haal de specifieke versie van de index op. De service retourneert de fout 404 Niet gevonden als de index niet bestaat.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De specifieke versie-id van de index die moet worden opgehaald.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Index

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Indexen - versie verwijderen

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

Verwijder de specifieke versie van de index. De service retourneert 204 Geen inhoud als de index is verwijderd of als de index niet bestaat.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De versie van de index die u wilt verwijderen.

Responses

Statuscode: 204

Beschrijving: Er is geen inhoud die voor deze aanvraag moet worden verzonden, maar de headers kunnen nuttig zijn.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Indexen - versie maken of bijwerken

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

Een nieuwe index maken of een bestaande index bijwerken met de opgegeven versie-id

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	De naam van de resource
version	path	Yes	tekenreeks	De specifieke versie-id van de index die moet worden gemaakt of bijgewerkt.

Aanvraaglichaam

Inhoudstype: toepassing/merge-patch+json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	IndexType		Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Index

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	Index

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Insights

Inzichten - genereren

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

Inzichten genereren

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Insights=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.
Herhaalbaarheid-Request-ID	Onwaar	tekenreeks	Unieke, door de client gegenereerde ID om de idempotentie van aanvragen te garanderen. Gebruik dezelfde ID voor nieuwe pogingen om dubbele evaluaties te voorkomen.
Herhaalbaarheid-First-Sent	Onwaar	tekenreeks	Tijdstempel die aangeeft wanneer dit verzoek voor het eerst is gestart. Gebruikt in combinatie met repeatability-request-id voor idempotentiecontrole.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
displayName	tekenreeks	Gebruiksvriendelijke weergavenaam voor het inzicht.	Yes
id	tekenreeks (alleen-lezen)	De unieke id voor het inzichtenrapport.	Yes
metadata	InsightsMetadata (alleen-lezen)	Metadata over de inzichten.	Yes
└} completedAt	tekenreeks	De tijdstempel waarop de inzichten zijn voltooid.	No
└* createdAt	tekenreeks	De tijdstempel waarop de inzichten zijn gemaakt.	Yes
request	InsightRequest	De aanvraag van het inzichtenrapport.	Yes
└type.	InsightType	Het type aanvraag.	Yes
result	InsightResult (alleen-lezen)	Het resultaat van de inzichten.	No
└type.	InsightType	Het type inzichtenresultaat.	Yes
state	Azure. Core.Foundations.OperationState (alleen-lezen)	Enum beschrijft de toegestane bewerkingstoestanden.	Yes

Responses

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	Inzichten

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Inzichten - lijst

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

Geef alle inzichten weer in omgekeerde chronologische volgorde (nieuwste eerst).

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
type	zoekopdracht	No	tekenreeks Mogelijke waarden: EvaluationRunClusterInsight, AgentClusterInsightEvaluationComparison	Filter op het type analyse.
evalId	zoekopdracht	No	tekenreeks	Filter op de evaluatie-ID.
runId	zoekopdracht	No	tekenreeks	Filter op de ID van de evaluatie-uitvoering.
agentName	zoekopdracht	No	tekenreeks	Filter op de naam van de agent.
includeCoördinaten	zoekopdracht	No	boolean	Of coördinaten voor visualisatie in het antwoord moeten worden opgenomen. Standaard ingesteld op onwaar.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Insights=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedInsight

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Inzichten - ophalen

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

Krijg een specifiek inzicht op id.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	De unieke id voor het inzichtenrapport.
includeCoördinaten	zoekopdracht	No	boolean	Of coördinaten voor visualisatie in het antwoord moeten worden opgenomen. Standaard ingesteld op onwaar.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Insights=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Inzichten

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Geheugenarchieven

Geheugenopslag maken

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

Maak een geheugenopslag.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
definitie	MemoryStoreDefinition	Basisdefinitie voor configuraties van geheugenopslag.	Yes
└.	MemoryStoreKind	Het soort geheugenopslag.	Yes
beschrijving	tekenreeks	Een door mensen leesbare beschrijving van het geheugenarchief. Beperkingen: maxLength: 512	No
metadata	object	Willekeurige sleutelwaardemetagegevens die moeten worden gekoppeld aan het geheugenarchief.	No
naam	tekenreeks	De naam van het geheugenarchief. Beperkingen: maxLength: 256	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	MemoryStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Geheugenarchieven weergeven

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

Maak een lijst van alle geheugenarchieven.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Geheugenopslag bijwerken

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

Werk een geheugenarchief bij.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
naam	path	Yes	tekenreeks	De naam van het geheugenarchief dat moet worden bijgewerkt.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een door mensen leesbare beschrijving van het geheugenarchief. Beperkingen: maxLength: 512	No
metadata	object	Willekeurige sleutelwaardemetagegevens die moeten worden gekoppeld aan het geheugenarchief.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	MemoryStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Geheugenopslag ophalen

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

Haal een geheugenarchief op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
naam	path	Yes	tekenreeks	De naam van het geheugenarchief dat moet worden opgehaald.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	MemoryStoreObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Geheugenarchief verwijderen

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

Verwijder een geheugenarchief.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
naam	path	Yes	tekenreeks	De naam van het geheugenarchief dat moet worden verwijderd.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DeleteMemoryStoreResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Updateresultaat ophalen

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

Resultaat van de update van de geheugenopslag ophalen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
naam	path	Yes	tekenreeks	De naam van het geheugenarchief.
update_id	path	Yes	tekenreeks	De id van de geheugenupdatebewerking.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	MemoryStoreUpdateResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Bereikgeheugens verwijderen

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

Verwijder alle terugblikken die aan een specifiek bereik zijn gekoppeld uit een geheugenarchief.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
naam	path	Yes	tekenreeks	De naam van het geheugenarchief.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
scope	tekenreeks	De naamruimte die logisch groepeert en geheugens isoleren die moeten worden verwijderd, zoals een gebruikers-id.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	MemoryStoreDeleteScopeResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Zoekgeheugens

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

Zoek naar relevante herinneringen in een geheugenarchief op basis van de gesprekscontext.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
naam	path	Yes	tekenreeks	De naam van het geheugenarchief dat moet worden gezocht.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
Onderdelen	matrix van OpenAI.InputItem	Items waarvoor moet worden gezocht naar relevante herinneringen.	No
options	MemorySearchOptions	Zoekopties voor geheugen.	No
└max_memories	integer	Maximum aantal geheugenitems dat moet worden geretourneerd.	No
previous_search_id	tekenreeks	De unieke id van de vorige zoekaanvraag, waardoor incrementele geheugenzoekopdrachten mogelijk zijn van waaruit de laatste bewerking was gebleven.	No
scope	tekenreeks	De naamruimte die herinneringen logisch groepeert en isoleert, zoals een gebruikers-ID.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	MemoryStoreSearchResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Herinneringen bijwerken

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

Werk het geheugenarchief bij met gespreksgeheugens.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
naam	path	Yes	tekenreeks	De naam van het geheugenarchief dat moet worden bijgewerkt.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: MemoryStores=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
Onderdelen	matrix van OpenAI.InputItem	Gespreksitems waaruit herinneringen kunnen worden geëxtraheerd.	No
previous_update_id	tekenreeks	De unieke id van de vorige updateaanvraag, waardoor incrementele geheugenupdates worden ingeschakeld vanaf waar de laatste bewerking was gebleven.	No
scope	tekenreeks	De naamruimte die herinneringen logisch groepeert en isoleert, zoals een gebruikers-ID.	Yes
update_delay	integer	Time-outperiode voordat de geheugenupdate in seconden wordt verwerkt. Als er tijdens deze periode een nieuwe updateaanvraag wordt ontvangen, wordt de huidige aanvraag geannuleerd en wordt de time-out opnieuw ingesteld. Ingesteld op 0 om de update onmiddellijk te activeren. De standaardwaarde is 300 (5 minuten).	No	300

Responses

Statuscode: 202

Beschrijving: De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Inhoudstype	Type	Description
application/json	MemoryStoreUpdateResponse

Antwoordheaders:

Koptekst	Typ	Description
Operatie-Locatie	tekenreeks	De locatie voor het bewaken van de bewerkingsstatus.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gesprekken

Gesprek maken

POST {endpoint}/openai/v1/conversations

Maak een gesprek.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
Onderdelen	matrix van OpenAI.InputItem		No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ConversationResource

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gesprekken weergeven

GET {endpoint}/openai/v1/conversations

Retourneert de lijst met alle gesprekken.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
agent_name	zoekopdracht	No	tekenreeks	Filter op agentnaam. Indien opgegeven, worden alleen items geretourneerd die zijn gekoppeld aan de opgegeven agent.
agent_id	zoekopdracht	No	tekenreeks	Filter op agent-id in de indeling name:version. Indien opgegeven, worden alleen items geretourneerd die zijn gekoppeld aan de opgegeven agent-id.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gesprek bijwerken

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

Een gesprek bijwerken.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	tekenreeks	De id van het gesprek dat moet worden bijgewerkt.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ConversationResource

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gesprek ophalen

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

Hiermee haalt u een gesprek op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	tekenreeks	De id van het gesprek dat moet worden opgehaald.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ConversationResource

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gesprek verwijderen

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

Hiermee verwijdert u een gesprek.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	tekenreeks	De id van het gesprek dat moet worden verwijderd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.DeletedConversationResource

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gespreksitems maken

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

Items maken in een gesprek met de opgegeven id.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	tekenreeks	De id van het gesprek waarop het item moet worden gemaakt.
include	zoekopdracht	No	gegevensreeks	Aanvullende velden die moeten worden opgenomen in het antwoord. Zie de parameter voor het include weergeven van gespreksitems voor meer informatie.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
Onderdelen	matrix van OpenAI.Item	De items die moeten worden toegevoegd aan het gesprek. U kunt maximaal 20 items tegelijk toevoegen.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ConversationItemList

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gespreksitems vermelden

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

Alle items voor een gesprek met de opgegeven id weergeven.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	tekenreeks	De id van het gesprek waarop de items moeten worden weergegeven.
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
item_type	zoekopdracht	No	tekenreeks Mogelijke waarden: message, output_message, , file_search_callcomputer_call, , , computer_call_outputweb_search_callfunction_callfunction_call_outputreasoningcompactionimage_generation_callcode_interpreter_calllocal_shell_calllocal_shell_call_outputshell_callshell_call_outputapply_patch_callapply_patch_call_outputmcp_list_toolsmcp_approval_requestmcp_approval_responsemcp_callcustom_tool_call_outputcustom_tool_callstructured_outputsoauth_consent_requestmemory_search_callworkflow_action	Filteren op itemtype. Indien opgegeven, worden alleen items van het opgegeven type geretourneerd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gespreksitem ophalen

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

Eén item ophalen uit een gesprek met de opgegeven id's.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	tekenreeks	De id van het gesprek dat het item bevat.
item_id	path	Yes	tekenreeks	De id van het gespreksitem dat moet worden opgehaald.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.OutputItem

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gespreksitem verwijderen

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

Een item verwijderen uit een gesprek met de opgegeven id's.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
conversation_id	path	Yes	tekenreeks	De id van het gesprek waaruit het item moet worden verwijderd.
item_id	path	Yes	tekenreeks	De id van het gespreksitem dat moet worden verwijderd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ConversationResource

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals

Evals - lijst evals

GET {endpoint}/openai/v1/evals

Een lijst weergeven van alle evaluaties: lijst met evaluaties voor een project.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
after	zoekopdracht	No	tekenreeks	Identificatie voor de laatste uitvoering van de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal runs dat moet worden opgehaald.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteervolgorde voor uitvoeringen op tijdstempel. Gebruiken asc voor oplopende volgorde of desc voor aflopende volgorde. Wordt standaard ingesteld op asc.
sorteren_op	zoekopdracht	No	tekenreeks Mogelijke waarden: created_at, updated_at	Evals kunnen worden gesorteerd op aanmaakdatum of laatst bijgewerkt. Gebruik created_at voor aanmaaktijdstip of updated_at voor het laatst bijgewerkte tijdstip.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - eval maken

POST {endpoint}/openai/v1/evals

Evaluatie maken Maak de structuur van een evaluatie die kan worden gebruikt om de prestaties van een model te testen. Een evaluatie is een set testcriteria en de configuratie voor een gegevensbron, die het schema bepaalt van de gegevens die in de evaluatie worden gebruikt. Nadat u een evaluatie hebt gemaakt, kunt u deze uitvoeren op verschillende modellen en modelparameters. We ondersteunen verschillende typen graders en gegevensbronnen. Zie voor meer informatie de

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
gegevensbron_configuratie	OpenAI.CreateEvalCustomDataSourceConfig of OpenAI.CreateEvalLogsDataSourceConfig of OpenAI.CreateEvalStoredCompletionsDataSourceConfig of AzureAIDataSourceConfig	De configuratie voor de gegevensbron die wordt gebruikt voor de evaluatieuitvoering. Bepaalt het schema van de gegevens die in de evaluatie worden gebruikt.	Yes
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van de evaluatie.	No
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
testing_criteria	matrix van OpenAI.EvalGraderLabelModel of OpenAI.EvalGraderStringCheck of OpenAI.EvalGraderTextSimilarity of OpenAI.EvalGraderPython of OpenAI.EvalGraderScoreModel of EvalGraderAzureAIEvaluator	Een lijst met beoordelaars voor alle evaluatieruns in deze groep. Graders kunnen verwijzen naar variabelen in de gegevensbron met dubbele accolades, zoals {{item.variable_name}}. Als u naar de uitvoer van het model wilt verwijzen, gebruikt u de sample naamruimte (ie, {{sample.output_text}}).	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - eval verwijderen

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

Een evaluatie verwijderen Een evaluatie verwijderen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De id van de evaluatie die moet worden verwijderd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DeleteEvalResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - eval ophalen

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

Haal een evaluatie Op basis van id een evaluatie op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De ID van de evaluatie die moet worden opgehaald.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - evaluatie bijwerken

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

Een evaluatie bijwerken Bepaalde eigenschappen van een evaluatie bijwerken.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De id van de evaluatie die moet worden bijgewerkt.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks		No
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Eval

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - lijstuitvoeringen

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

Haal een lijst met uitvoeringen op voor een evaluatie Een lijst met uitvoeringen ophalen voor een evaluatie.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De id van de evaluatie waarvoor uitvoeringen moeten worden opgehaald.
after	zoekopdracht	No	tekenreeks	Identificatie voor de laatste uitvoering van de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal runs dat moet worden opgehaald.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteervolgorde voor uitvoeringen op tijdstempel. Gebruiken asc voor oplopende volgorde of desc voor aflopende volgorde. Wordt standaard ingesteld op asc.
status	zoekopdracht	No	tekenreeks Mogelijke waarden: queued, in_progress, completed, , canceled, . failed Filter wordt uitgevoerd op status. Een van queued, in_progress, failed, , , completed, . canceled

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - eval-uitvoering maken

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

Evaluatieuitvoering maken

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De ID van de evaluatie waarvoor een run moet worden gemaakt.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
gegevensbron	OpenAI.CreateEvalJsonlRunDataSource of OpenAI.CreateEvalCompletionsRunDataSource of OpenAI.CreateEvalResponsesRunDataSource of EvalRunDataSource	Details over de gegevensbron van de uitvoering.	Yes
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van de run.	No
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - eval-uitvoering verwijderen

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

Evaluatieuitvoering Verwijderen Een evaluatieuitvoering verwijderen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De ID van de evaluatie waarvan de uitvoering verwijderd moet worden.
run_id	path	Yes	tekenreeks	De id van de uitvoering die moet worden verwijderd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DeleteEvalRunResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - eval run ophalen

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

Een evaluatieuitvoering ophalen Een evaluatie uitvoeren op basis van id.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De id van de evaluatie waarvoor uitvoeringen moeten worden opgehaald.
run_id	path	Yes	tekenreeks	De ID van de run die moet worden opgehaald.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - eval-uitvoering annuleren

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

Evaluatieuitvoering Annuleren: een doorlopende evaluatieuitvoering annuleren.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De id van de evaluatie waarvan u de uitvoering wilt annuleren.
run_id	path	Yes	tekenreeks	De ID van de run die moet worden geannuleerd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvalRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - uitvoeritems voor evaluatieuitvoering ophalen

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

Uitvoeritems voor evaluatieuitvoering ophalen Een lijst met uitvoeritems voor een evaluatieuitvoering ophalen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks
run_id	path	Yes	tekenreeks	De ID van de uitvoering waarvoor de uitvoeritems moeten worden opgehaald.
after	zoekopdracht	No	tekenreeks	Identificatie voor de laatste uitvoering van de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal runs dat moet worden opgehaald.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteervolgorde voor uitvoeringen op tijdstempel. Gebruiken asc voor oplopende volgorde of desc voor aflopende volgorde. Wordt standaard ingesteld op asc.
status	zoekopdracht	No	tekenreeks Mogelijke waarden: fail, pass	Uitvoeritems filteren op status. Gebruiken failed om te filteren op mislukte uitvoer items of pass om te filteren op doorgegeven uitvoeritems.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Evals - uitvoeritem voor evaluatiebewerking ophalen

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

Haal een uitvoeritem op van een evaluatieuitvoering Haal een uitvoeritem op basis van id op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
eval_id	path	Yes	tekenreeks	De id van de evaluatie waarvoor uitvoeringen moeten worden opgehaald.
run_id	path	Yes	tekenreeks	De ID van de run die moet worden opgehaald.
uitvoer_item_id	path	Yes	tekenreeks	De id van het uitvoeritem dat moet worden opgehaald.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	EvalRunOutputItem

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Fine-Tuning

Taak voor het afstemmen maken

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

Hiermee maakt u een taak voor fijn afstemmen aan, dat het proces start voor het maken van een nieuw model op basis van een bepaalde gegevensset.

Antwoord bevat details van de in de wachtrij geplaatste taak, inclusief taakstatus en de naam van de fijn afgestelde modellen zodra deze zijn voltooid.

Meer informatie over het afstemmen

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└ batch_size	tekenreeks of OpenAI.integer		No	Auto
└learning_rate_multiplier	tekenreeks of OpenAI.numeriek		No
└n_epochs	tekenreeks of OpenAI.integer		No	Auto
integraties	matrix van OpenAI.CreateFineTuningJobRequestIntegrations	Een lijst met integraties waarmee u uw taak kunt verfijnen.	No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
method	OpenAI.FineTuneMethod	De methode die wordt gebruikt voor het afstemmen.	No
model	tekenreeks (zie geldige modellen hieronder)	De naam van het model om te fine-tunen. U kunt een van de volgende opties selecteren ondersteunde modellen.	Yes
seed	OpenAI.integer (nullbaar)		No
achtervoegsel	tekenreeks (nullable)	Een tekenreeks van maximaal 64 tekens die wordt toegevoegd aan de aangepaste modelnaam. Bijvoorbeeld, een suffix van 'custom-model-name' zou een modelnaam zoals ft:gpt-4o-mini:openai:custom-model-name:7p4lURel opleveren. Beperkingen: minLength: 1, maxLength: 64	No
training_file	tekenreeks	De id van een geüpload bestand dat trainingsgegevens bevat. Zie het uploadbestand voor het uploaden van een bestand. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. Daarnaast moet u uw bestand uploaden met het doel fine-tune. De inhoud van het bestand moet verschillen, afhankelijk van of het model gebruikmaakt van de chat, voltooiingsindeling of als de methode voor het afstemmen gebruikmaakt van de voorkeursindeling . Zie de handleiding voor het afstemmen voor meer informatie.	Yes
validatiebestand	tekenreeks (nullable)	De id van een geüpload bestand dat validatiegegevens bevat. Als u dit bestand opgeeft, worden de gegevens gebruikt om validatie te genereren metrische gegevens worden periodiek tijdens het afstemmen verfijnd. Deze metrische gegevens kunnen worden weergegeven in het bestand met resultaten afstemmen. Dezelfde gegevens mogen niet aanwezig zijn in zowel trein- als validatiebestanden. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. Je moet je bestand met het doel fine-tune uploaden. Zie de handleiding voor het afstemmen voor meer informatie.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Gepagineerde taken weergeven

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

Lijst de fine-tuning taken van uw organisatie

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
after	zoekopdracht	No	tekenreeks	Id voor de laatste taak uit de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal fijnstemmingsopdrachten dat moet worden opgehaald.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Taak voor het afstemmen ophalen

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

Krijg informatie over een fijn-afsteltaak.

Meer informatie over het afstemmen

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Yes	tekenreeks	De ID van de taak voor het fijnstemmen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Taak voor het afstemmen annuleren

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

Onmiddellijk een fine-tuning taak annuleren.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Yes	tekenreeks	De id van de taak voor het afstemmen om te annuleren.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Controlepunten voor taakafstemming weergeven

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

Controlepunten weergeven voor een taak voor het afstemmen van taken.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Yes	tekenreeks	De ID van de finetuning-taak om controlepunten voor te verkrijgen.
after	zoekopdracht	No	tekenreeks	Identificator voor de laatste controlepunt-ID van het vorige pagineringsverzoek.
limit	zoekopdracht	No	integer	Aantal controlepunten om op te halen.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Taakafstemmingsevenementen weergeven

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

Ontvang gedetailleerde statusupdates voor een taak voor het afstemmen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Yes	tekenreeks	De ID van de fijnregelingsopdracht om gebeurtenissen voor te verkrijgen.
after	zoekopdracht	No	tekenreeks	Id voor de laatste gebeurtenis uit de vorige pagineringsaanvraag.
limit	zoekopdracht	No	integer	Aantal gebeurtenissen dat moet worden opgehaald.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Taak voor het afstemmen onderbreken

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

Pauzeer een taak die wordt uitgevoerd.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Yes	tekenreeks	De ID van de fine-tuning taak om te onderbreken.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Taak voor afstemmen hervatten

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

Een gepauzeerde fine-tune klus hervatten.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
fine_tuning_job_id	path	Yes	tekenreeks	Het ID van de fine-tuning taak om te hervatten.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.FineTuningJob

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Responses

Antwoord maken - antwoordstroom maken

POST {endpoint}/openai/v1/responses

Hiermee maakt u een modelantwoord. Hiermee maakt u een modelantwoord (streaming-antwoord).

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
achtergrond	Booleaanse waarde (nullable)		No
gesprek	OpenAI.ConversationParam (nulleerbaar)	Het gesprek waartoe dit antwoord behoort. Items uit dit gesprek worden voorafgegaan aan input_items deze antwoordaanvraag. Invoeritems en uitvoeritems uit dit antwoord worden automatisch toegevoegd aan dit gesprek nadat dit antwoord is voltooid.	No
include	matrix van OpenAI.IncludeEnum		No
input	OpenAI.InputParam	Tekst, afbeelding of bestandsinvoer voor het model, dat wordt gebruikt om een antwoord te genereren. Meer informatie: - tekstinvoer en -uitvoer - Afbeeldingsingangen - Bestandsinvoer - Gesprekstoestand - Functie aanroepen	No
aanwijzingen	tekenreeks (nullable)		No
max_output_tokens	OpenAI.integer (nullbaar)		No
max_gereedschap_aanroepen	OpenAI.integer (nullbaar)		No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
parallel_gereedschapsoproepen	Booleaanse waarde (nullable)		No	True
previous_response_id	tekenreeks (nullable)		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
reasoning	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└* inspanning	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
└─generate_summary	enum	Mogelijke waarden: auto, concisedetailed	No
Samenvatting └─	enum	Mogelijke waarden: auto, concisedetailed	No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
serviceniveau	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
store	Booleaanse waarde (nullable)		No	True
stream	Booleaanse waarde (nullable)		No
stream_options	OpenAI.ResponseStreamOptions (nullbaar)	Opties voor streamingreacties. Stel dit alleen in wanneer u instelt stream: true.	No
└include_obfuscation	boolean	Wanneer waar, wordt de verdoezeling van stromen ingeschakeld. Stream-verdoofing voegt toe willekeurige tekens naar een obfuscation veld bij streaming-deltagebeurtenissen naar normaliseer nettoladinggrootten als een beperking voor bepaalde side-channel-aanvallen. Deze verborgen velden zijn standaard opgenomen, maar voeg een kleine hoeveelheid toe overhead naar de gegevensstroom. U kunt instellen include_obfuscation op false om te optimaliseren voor bandbreedte als u de netwerkkoppelingen tussen uw toepassing en de OpenAI-API.	No
structured_inputs	object	De gestructureerde invoer voor het antwoord dat kan deelnemen aan promptsjabloonvervanging of bindingen voor hulpprogrammaargumenten.	No
Temperatuur	OpenAI.numeriek (nullable)		No	1
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
top_logprobs	OpenAI.integer (nullbaar)		No
top_p	OpenAI.numeriek (nullable)		No	1
truncation	enum	Mogelijke waarden: auto, disabled	No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Antwoorden weergeven

GET {endpoint}/openai/v1/responses

Retourneert de lijst met alle antwoorden.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.
agent_name	zoekopdracht	No	tekenreeks	Filter op agentnaam. Indien opgegeven, worden alleen items geretourneerd die zijn gekoppeld aan de opgegeven agent.
agent_id	zoekopdracht	No	tekenreeks	Filter op agent-id in de indeling name:version. Indien opgegeven, worden alleen items geretourneerd die zijn gekoppeld aan de opgegeven agent-id.
conversation_id	zoekopdracht	No	tekenreeks	Filteren op gespreks-id. Indien opgegeven, worden alleen antwoorden geretourneerd die zijn gekoppeld aan het opgegeven gesprek.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Compact antwoordgesprek

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

Produceert een compressie van een antwoordgesprek.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
input	tekenreeks of matrix van OpenAI.InputItem		No
aanwijzingen	tekenreeks (nullable)		No
model	OpenAI.ModelIdsCompaction	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals gpt-5 of o3. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestatiekenmerken en prijspunten. Raadpleeg de modelhandleiding om door beschikbare modellen te bladeren en te vergelijken.	Yes
previous_response_id	tekenreeks (nullable)		No

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.CompactResource

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Antwoord ophalen - antwoordstroom ophalen

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

Haalt een modelantwoord op met de opgegeven id. Hiermee haalt u een modelantwoord op met de opgegeven id (streaming-antwoord).

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	tekenreeks
include[]	zoekopdracht	No	gegevensreeks
stream	zoekopdracht	No	boolean
starting_after	zoekopdracht	No	integer

Koptekst van aanvraag

Name	Required	Typ	Description
accepteren	Onwaar	tekenreeks Mogelijke waarden: text/event-stream

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.Response
text/event-stream	OpenAI.CreateResponseStreamingResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Antwoord verwijderen

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

Hiermee verwijdert u een modelantwoord.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	tekenreeks	De id van het antwoord dat moet worden verwijderd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	DeleteResponseResult

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Antwoord annuleren

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

Hiermee annuleert u een modelantwoord.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	tekenreeks	De id van het antwoord dat moet worden geannuleerd.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	OpenAI.Response

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Invoeritems weergeven

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

Retourneert een lijst met invoeritems voor een bepaald antwoord.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
response_id	path	Yes	tekenreeks
limit	zoekopdracht	No	integer	Een limiet voor het aantal objecten dat moet worden geretourneerd. De limiet kan variëren tussen 1 en 100 en de de standaardwaarde is 20.
order	zoekopdracht	No	tekenreeks Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde.
after	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. after is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende oproep kan "after=obj_foo" bevatten om de volgende pagina van de lijst op te halen.
voordat	zoekopdracht	No	tekenreeks	Een cursor voor gebruik in paginering. before is een object-id die uw plaats in de lijst definieert. Als u bijvoorbeeld een verzoek om een lijst indient en 100 objecten ontvangt, eindigend met obj_foo, dan... Een volgende aanroep kan voor=obj_foo bevatten om de vorige pagina van de lijst op te halen.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	object	De antwoordgegevens voor een aangevraagde lijst met items.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Redteams

Redteams - lijst

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

Geef een redteam op naam weer.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: RedTeams=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedRedTeam

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Redteams - krijg

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

Haal een redteam op naam op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
naam	path	Yes	tekenreeks	Id van de rode teamuitvoering.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: RedTeams=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	RedTeam

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Redteams - maken

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

Hiermee maakt u een redteam-uitvoering.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: RedTeams=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
applicationScenario	tekenreeks	Toepassingsscenario voor de rode teambewerking om scenariospecifieke aanvallen te genereren.	No
attackStrategies	matrix van AttackStrategy	Lijst met aanvalsstrategieën of geneste lijsten met aanvalsstrategieën.	No
displayName	tekenreeks	Naam van de rode teamuitvoering.	No
id	tekenreeks (alleen-lezen)	Id van de rode teamuitvoering.	Yes
numTurns	integer	Aantal simulatierondes.	No
properties	object	De eigenschappen van het rode team. In tegenstelling tot tags zijn eigenschappen alleen-toevoegen. Zodra deze is toegevoegd, kan een eigenschap niet worden verwijderd.	No
riskCategories	matrix van RiskCategory	Lijst met risicocategorieën voor het genereren van aanvalsdoelen.	No
simulatieOnly	boolean	Alleen simulatie of Simulatie en evaluatie. Standaard onwaar, als waar de scan het gesprek niet evalueert.	No	Onwaar
status	tekenreeks (alleen-lezen)	Status van het rode team. Deze is ingesteld door de service en heeft het kenmerk Alleen-lezen.	No
tags	object	De tags van het rode team. In tegenstelling tot eigenschappen zijn tags volledig veranderlijk.	No
target	TargetConfig	Abstracte klasse voor doelconfiguratie.	Yes
└type.	tekenreeks	Type van de modelconfiguratie.	Yes

Responses

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	RedTeam

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Planningen

Planningen - lijst

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

Geef alle planningen weer.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
type	zoekopdracht	No	tekenreeks Mogelijke waarden: Evaluation, Insight	Filter op het type planning.
enabled	zoekopdracht	No	boolean	Filter op de status ingeschakeld.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Schedules=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedSchedule

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Planningen - verwijderen

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

Een schema verwijderen.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	Id van de planning.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Schedules=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 204

Beschrijving: Er is geen inhoud die voor deze aanvraag moet worden verzonden, maar de headers kunnen nuttig zijn.

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Schema's - ophalen

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

Haal een planning op basis van de id op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	Id van de planning.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Schedules=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Schedule

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Planningen - maken of bijwerken

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

Een bewerkingssjabloon maken of bijwerken.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	Id van de planning.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Schedules=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Beschrijving van de planning.	No
displayName	tekenreeks	Naam van de planning.	No
enabled	boolean	Status van de planning ingeschakeld.	Yes
id	tekenreeks (alleen-lezen)	Id van de planning.	Yes
properties	object	De eigenschappen van de planning. In tegenstelling tot tags zijn eigenschappen alleen-toevoegen. Zodra deze is toegevoegd, kan een eigenschap niet worden verwijderd.	No
provisioneringsstatus	ScheduleProvisioningStatus (alleen-lezen)	Planningsstatus inplannen.	No
systeemgegevens	object (alleen-lezen)	Systeemmetagegevens voor de resource.	Yes
tags	object	De tags van de planning. In tegenstelling tot eigenschappen zijn tags volledig veranderlijk.	No
taak	ScheduleTask	Taakmodel plannen.	Yes
└configuratie.	object	Configuratie voor de taak.	No
└type.	ScheduleTaskType	Type taak.	Yes
trigger	Trigger	Basismodel voor Trigger van het rooster.	Yes
└type.	TriggerType	Type van de trekker.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	Schedule

Statuscode: 201

Beschrijving: De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Inhoudstype	Type	Description
application/json	Schedule

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Schema's - lijstuitvoeringen

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

Geef alle planningsuitvoeringen weer.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.
id	path	Yes	tekenreeks	Id van de planning.
type	zoekopdracht	No	tekenreeks Mogelijke waarden: Evaluation, Insight	Filter op het type planning.
enabled	zoekopdracht	No	boolean	Filter op de status ingeschakeld.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Schedules=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	PagedScheduleRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	Azure. Core.Foundations.ErrorResponse

Antwoordheaders:

Koptekst	Typ	Description
x-ms-error-code	tekenreeks	Tekenreeksfoutcode die aangeeft wat er mis is gegaan.

Schema's - uitvoering ophalen

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

Haal een planning op basis van de id op.

URI-parameters

Name	In	Required	Typ	Description
endpoint	path	Yes	tekenreeks	Foundry Project-eindpunt in het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}". Als u slechts één Project in uw Foundry Hub hebt of als u de standaard-Project in uw hub gebruikt u het formulier "https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project"
schedule_id	path	Yes	tekenreeks	De unieke id van de planning.
run_id	path	Yes	tekenreeks	De unieke id van de planningsuitvoering.
api-versie	zoekopdracht	Yes	tekenreeks	De API-versie die voor deze bewerking moet worden gebruikt.

Koptekst van aanvraag

Name	Required	Typ	Description
Foundry-Features	True	tekenreeks Mogelijke waarden: Schedules=V1Preview	Een functievlag die is vereist bij het gebruik van preview-bewerkingen of het wijzigen van persistente preview-resources.

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Type	Description
application/json	ScheduleRun

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Type	Description
application/json	ApiErrorResponse

Components

A2APreviewTool

Een agent die het A2A-protocol implementeert.

Name	Typ	Description	Required	Verstek
agent_card_path	tekenreeks	Het pad naar de agentkaart ten opzichte van de base_url. Indien niet opgegeven, wordt standaard ingesteld op /.well-known/agent-card.json	No
base_url	tekenreeks	Basis-URL van de agent.	No
project_connection_id	tekenreeks	De verbindings-id in de project voor de A2A-server. De verbinding slaat authenticatie en andere verbindingsgegevens op die nodig zijn om verbinding te maken met de A2A-server.	No
type	enum	Het type hulpprogramma. Altijd "a2a_preview. Mogelijke waarden: a2a_preview	Yes

AISearchIndexResource

Een AI-zoekindexbron.

Name	Typ	Description	Required	Verstek
filter	tekenreeks	filtertekenreeks voor zoekresource. Klik hier voor meer informatie.	No
index_asset_id	tekenreeks	Indexasset-id voor zoekresource.	No
indexnaam	tekenreeks	De naam van een index in een IndexResource die is gekoppeld aan deze agent.	No
project_connection_id	tekenreeks	Een indexverbindings-id in een IndexResource die is gekoppeld aan deze agent.	No
vraagtype	AzureAISearchQueryType	Beschikbare querytypen voor de Azure AI Zoeken-tool.	No
top_k	integer	Het aantal documenten dat moet worden opgehaald uit het zoek- en presentatiemodel.	No

AgentClusterInsightRequest

Inzichten in de set resultaten van agentevaluatie

Name	Typ	Description	Required	Verstek
agentName	tekenreeks	Id voor de agent.	Yes
modelConfiguratie	InsightModelConfiguration	Configuratie van het model dat wordt gebruikt bij het genereren van inzichten.	No
└* modelDeploymentName	tekenreeks	De te evalueren modelimplementatie. Accepteert alleen de implementatienaam of met de verbindingsnaam als {connectionName}/<modelDeploymentName>.	Yes
type	enum	Het type aanvraag. Mogelijke waarden: AgentClusterInsight	Yes

AgentClusterInsightResult

Inzichten uit de analyse van de agentcluster.

Name	Typ	Description	Required	Verstek
clusterInsight	ClusterInsightResult	Inzichten uit de clusteranalyse.	Yes
type	enum	Het type inzichtenresultaat. Mogelijke waarden: AgentClusterInsight	Yes

AgentContainerObject

De details van de container van een specifieke versie van een agent.

Name	Typ	Description	Required	Verstek
container	ContainerDetails (alleen-lezen)	Gedetailleerde informatie over de container.	No
└health_state	tekenreeks	De status van de container.	Yes
└provisioning_error	tekenreeks	De inrichtingsfout van de container, indien van toepassing.	No
└provisioning_state	tekenreeks	De inrichtingsstatus van de container.	Yes
└* replica's	matrix van ContainerReplica	De lijst met replica's in de container.	Yes
└state.	tekenreeks	De status van de container.	Yes
└updated_on	tekenreeks	De laatste updatetijd van de container.	Yes
aangemaakt_op	tekenreeks	De aanmaaktijd van de container.	Yes
error_message	tekenreeks (alleen-lezen)	Het foutbericht als de container niet kan worden uitgevoerd, indien van toepassing.	No
id	tekenreeks (alleen-lezen)	De id van de container.	No
max_replicas	integer	Het maximum aantal replica's voor de container. De standaardwaarde is 1.	No
min_replicas	integer	Het minimale aantal replica's voor de container. De standaardwaarde is 1.	No
object	enum	Het objecttype, dat altijd 'agent.container' is. Mogelijke waarden: agent.container	Yes
status	AgentContainerStatus (alleen-lezen)	Status van de container van een specifieke versie van een agent.	Yes
updated_at	tekenreeks	De laatste updatetijd van de container.	Yes

AgentContainerOperationError

De foutdetails van de containerbewerking, indien van toepassing.

Name	Typ	Description	Required	Verstek
code	tekenreeks	De foutcode van de containerbewerking, indien van toepassing.	Yes
message	tekenreeks	Het foutbericht van de containerbewerking, indien van toepassing.	Yes
type	tekenreeks	Het fouttype van de containerbewerking, indien van toepassing.	Yes

AgentContainerOperationObject

De containerbewerking voor een specifieke versie van een agent.

Name	Typ	Description	Required	Verstek
agent_id	tekenreeks	De id van de agent.	Yes
agent_version_id	tekenreeks	De id van de agentversie.	Yes
container	AgentContainerObject	De details van de container van een specifieke versie van een agent.	No
└* container	ContainerDetails (alleen-lezen)	De gedetailleerde containergegevens.	No
└ created_at	tekenreeks (alleen-lezen)	De aanmaaktijd van de container.	Yes
└error_message	tekenreeks (alleen-lezen)	Het foutbericht als de container niet kan worden uitgevoerd, indien van toepassing.	No
└─ id	tekenreeks (alleen-lezen)	De id van de container.	No
└max_replicas	integer	Het maximum aantal replica's voor de container. De standaardwaarde is 1.	No
└min_replicas	integer	Het minimale aantal replica's voor de container. De standaardwaarde is 1.	No
└─ object	enum	Het objecttype, dat altijd 'agent.container' is. Mogelijke waarden: agent.container	Yes
└─ Status	AgentContainerStatus (alleen-lezen)	De status van de container van een specifieke versie van een agent.	Yes
└updated_at	tekenreeks (alleen-lezen)	De laatste updatetijd van de container.	Yes
fout	AgentContainerOperationError	De foutdetails van de containerbewerking, indien van toepassing.	No
└─ code	tekenreeks	De foutcode van de containerbewerking, indien van toepassing.	Yes
└• bericht	tekenreeks	Het foutbericht van de containerbewerking, indien van toepassing.	Yes
└type.	tekenreeks	Het fouttype van de containerbewerking, indien van toepassing.	Yes
id	tekenreeks	De id van de containerbewerking. Deze id is een unieke id in het systeem.	Yes
status	AgentContainerOperationStatus	Status van de containerbewerking voor een specifieke versie van een agent.	Yes

AgentContainerOperationStatus

Status van de containerbewerking voor een specifieke versie van een agent.

Property	Value
Type	tekenreeks
waarden	NotStarted InProgress Succeeded Failed

AgentContainerStatus

Status van de container van een specifieke versie van een agent.

Property	Value
Type	tekenreeks
waarden	Starting Running Stopping Stopped Failed Deleting Deleted Updating

AgentDefinition

Discriminator voor AgentDefinition

Dit onderdeel maakt gebruik van de eigenschap kind om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
prompt	PromptAgentDefinition
workflow	WorkflowAgentDefinition
hosted	HostedAgentDefinition
container_app	ContainerAppAgentDefinition

Name	Typ	Description	Required	Verstek
vriendelijk	AgentKind		Yes
rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
└rai_policy_name	tekenreeks	De naam van het RAI-beleid dat moet worden toegepast.	Yes

AgentKind

Property	Value
Type	tekenreeks
waarden	prompt hosted container_app workflow

AgentObject

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke id van de agent.	Yes
naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 63	Yes
object	enum	Het objecttype, dat altijd 'agent' is. Mogelijke waarden: agent	Yes
versions	object	De nieuwste versie van de agent.	Yes
└latest	AgentVersionObject		Yes

AgentProtocol

Property	Value
Type	tekenreeks
waarden	activity_protocol responses

AgentReference

Name	Typ	Description	Required	Verstek
naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
type	enum	Mogelijke waarden: agent_reference	Yes
version	tekenreeks	De versie-id van de agent.	No

AgentTaxonomyInput

Invoerconfiguratie voor de evaluatietaxonomie wanneer het invoertype agent is.

Name	Typ	Description	Required	Verstek
riskCategories	matrix van RiskCategory	Lijst met risicocategorieën die moeten worden geëvalueerd.	Yes
target	Doel	Basisklasse voor doelen met discriminatorondersteuning.	Yes
└type.	tekenreeks	Het type doel.	Yes
type	enum	Invoertype van de evaluatietaxonomie. Mogelijke waarden: agent	Yes

AgentTaxonomyInputUpdate

Invoerconfiguratie voor de evaluatietaxonomie wanneer het invoertype agent is.

Name	Typ	Description	Required	Verstek
riskCategories	matrix van RiskCategory	Lijst met risicocategorieën die moeten worden geëvalueerd.	No
target	TargetUpdate	Basisklasse voor doelen met discriminatorondersteuning.	No
└type.	tekenreeks	Het type doel.	Yes
type	enum	Invoertype van de evaluatietaxonomie. Mogelijke waarden: agent	Yes

AgentVersionObject

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	De Unix-tijdstempel (seconden) waarin de agent is gemaakt.	Yes
definitie	AgentDefinition		Yes
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
id	tekenreeks	De unieke id van de agentversie.	Yes
metadata	object (nul)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Yes
naam	tekenreeks	De naam van de agent. De naam kan worden gebruikt om de agent op te halen/bij te werken/te verwijderen. Beperkingen: maxLength: 256	Yes
object	enum	Het objecttype, dat altijd 'agent.version' is. Mogelijke waarden: agent.version	Yes
version	tekenreeks	De versie-id van de agent. Agents zijn onveranderlijk en elke update creëert een nieuwe versie terwijl de naam hetzelfde blijft.	Yes

AgenticIdentityPreviewCredentials

Definitie van agentische identiteitsreferenties

Name	Typ	Description	Required	Verstek
type	enum	Het type aanmeldingsgegevens Mogelijke waarden: AgenticIdentityToken_Preview	Yes

ApiErrorResponse

Foutreactie voor API-fouten.

Name	Typ	Description	Required	Verstek
fout	OpenAI.Error		Yes

ApiKeyCredentials

Definitie van API-sleutel

Name	Typ	Description	Required	Verstek
sleutel	tekenreeks (alleen-lezen)	API-sleutel	No
type	enum	Het type aanmeldingsgegevens Mogelijke waarden: ApiKey	Yes

AssetCredentialResponse

Vertegenwoordigt een verwijzing naar een blob voor consumptie

Name	Typ	Description	Required	Verstek
blobReference	BlobReference	Details van de blobreferentie.	Yes
└* blobUri	tekenreeks	Blob-URI-pad voor client om gegevens te uploaden. Voorbeeld:https://blob.windows.core.net/Container/Path	Yes
Referentie └*	SasCredential	Referentiegegevens voor toegang tot het opslagaccount.	Yes
└* storageAccountArmId	tekenreeks	ARM-id van het opslagaccount dat moet worden gebruikt.	Yes

Assetnummer

Id van een opgeslagen asset.

Type: tekenreeks

AttackStrategy

Strategieën voor aanvallen.

Property	Value
Description	Strategieën voor aanvallen.
Type	tekenreeks
waarden	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

Het foutobject.

Name	Typ	Description	Required	Verstek
code	tekenreeks	Een van een door de server gedefinieerde set foutcodes.	Yes
details	matrix van Azure. Core.Foundations.Error	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.	No
innererror	Azure. Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ code	tekenreeks	Een van een door de server gedefinieerde set foutcodes.	No
└* innererror	Azure. Core.Foundations.InnerError	Interne fout.	No
message	tekenreeks	Een leesbare weergave van de fout.	Yes
target	tekenreeks	Het doel van de fout.	No

Azure. Core.Foundations.ErrorResponse

Een antwoord met foutdetails.

Name	Typ	Description	Required	Verstek
fout	Azure. Core.Foundations.Error	Het foutobject.	Yes
└─ code	tekenreeks	Een van een door de server gedefinieerde set foutcodes.	Yes
└─ details weergeven	matrix van Azure. Core.Foundations.Error	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.	No
└* innererror	Azure. Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.	No
└• bericht	tekenreeks	Een leesbare weergave van de fout.	Yes
└target	tekenreeks	Het doel van de fout.	No

Azure. Core.Foundations.InnerError

Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description	Required	Verstek
code	tekenreeks	Een van een door de server gedefinieerde set foutcodes.	No
innererror	Azure. Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.	No
└─ code	tekenreeks	Een van een door de server gedefinieerde set foutcodes.	No
└* innererror	Azure. Core.Foundations.InnerError	Interne fout.	No

Azure. Core.Foundations.OperationState

Enum beschrijft de toegestane bewerkingstoestanden.

Property	Value
Description	Enum beschrijft de toegestane bewerkingstoestanden.
Type	tekenreeks
waarden	NotStarted Running Succeeded Failed Canceled

Azure. Core.uuid

Universeel Unieke Identificatie

Type: tekenreeks

Indeling: uuid

AzureAIAgentTarget

Vertegenwoordigt een doel dat een Azure AI-agent specificeert.

Name	Typ	Description	Required	Verstek
naam	tekenreeks	De unieke id van de Azure AI-agent.	Yes
tool_descriptions	matrix van ToolDescription	De parameters die worden gebruikt om het steekproefgedrag van de agent tijdens het genereren van tekst te controleren.	No
type	enum	Het type doelwit, altijd azure_ai_agent. Mogelijke waarden: azure_ai_agent	Yes
version	tekenreeks	De versie van de Azure AI-agent.	No

AzureAIAgentTargetUpdate

Vertegenwoordigt een doel dat een Azure AI-agent specificeert.

Name	Typ	Description	Required	Verstek
naam	tekenreeks	De unieke id van de Azure AI-agent.	No
tool_descriptions	matrix van ToolDescription	De parameters die worden gebruikt om het steekproefgedrag van de agent tijdens het genereren van tekst te controleren.	No
type	enum	Het type doelwit, altijd azure_ai_agent. Mogelijke waarden: azure_ai_agent	Yes
version	tekenreeks	De versie van de Azure AI-agent.	No

AzureAIDataSourceConfig

Name	Typ	Description	Required	Verstek
situatie	enum	Scenario van gegevensschema. Mogelijke waarden: red_team, responses, , traces_previewsynthetic_data_gen_preview	Yes
schema	object	Het algemene JSON-schema voor het uitvoeren van gegevensbronitems.	Yes
type	enum	Het objecttype, dat altijd azure_ai_sourceis. Mogelijke waarden: azure_ai_source	Yes

AzureAIModelTarget

Vertegenwoordigt een doel dat een Azure AI-model specificeert voor bewerkingen die modelselectie vereisen.

Name	Typ	Description	Required	Verstek
model	tekenreeks	De unieke id van het Azure AI-model.	No
sampling_params	ModelSamplingParams	Vertegenwoordigt een set parameters die worden gebruikt voor het bepalen van het steekproefgedrag van een taalmodel tijdens het genereren van tekst.	No
└max_completion_tokens	integer	Het maximum aantal tokens dat is toegestaan in de voltooiing.	Yes
└─ zaad	integer	Het willekeurige zaad voor reproduceerbaarheid.	Yes
└─ temperatuur	number	De temperatuurparameter voor steekproeven.	Yes
└─ top_p	number	De top-p-parameter voor kernsampling.	Yes
type	enum	Het type doelwit, altijd azure_ai_model. Mogelijke waarden: azure_ai_model	Yes

AzureAIModelTargetUpdate

Vertegenwoordigt een doel dat een Azure AI-model specificeert voor bewerkingen die modelselectie vereisen.

Name	Typ	Description	Required	Verstek
model	tekenreeks	De unieke id van het Azure AI-model.	No
sampling_params	ModelSamplingParamsUpdate	Vertegenwoordigt een set parameters die worden gebruikt voor het bepalen van het steekproefgedrag van een taalmodel tijdens het genereren van tekst.	No
└max_completion_tokens	integer	Het maximum aantal tokens dat is toegestaan in de voltooiing.	No
└─ zaad	integer	Het willekeurige zaad voor reproduceerbaarheid.	No
└─ temperatuur	number	De temperatuurparameter voor steekproeven.	No
└─ top_p	number	De top-p-parameter voor kernsampling.	No
type	enum	Het type doelwit, altijd azure_ai_model. Mogelijke waarden: azure_ai_model	Yes

AzureAIResponsesEvalRunDataSource

Vertegenwoordigt een gegevensbron voor evaluatieuitvoeringen die specifiek zijn voor doorlopende evaluatiescenario's.

Name	Typ	Description	Required	Verstek
event_configuration_id	tekenreeks	De naam van de gebeurtenisconfiguratie die is gekoppeld aan deze evaluatieuitvoering.	Yes
item_generation_params	ResponseRetrievalItemGenerationParams	Vertegenwoordigt de parameters voor het genereren van het antwoorditem.	Yes
└data_mapping	object	Toewijzing van bronvelden aan response_id veld, vereist voor het ophalen van de chatgeschiedenis.	Yes
└max_num_turns	integer	Het maximum aantal beurten van chatgeschiedenis dat moet worden geëvalueerd.	Yes
└* bron	OpenAI.EvalJsonlFileContentSource of OpenAI.EvalJsonlFileIdSource	De bron waaruit JSONL-inhoud wordt gelezen.	Yes
└type.	enum	Het type parameters voor het genereren van items, altijd response_retrieval. Mogelijke waarden: response_retrieval	Yes
max_runs_hourly	integer	Maximum aantal evaluatieuitvoeringen dat per uur is toegestaan.	Yes
type	enum	Het type gegevensbron, altijd azure_ai_responses. Mogelijke waarden: azure_ai_responses	Yes

Azure AI Zoeken Index

Azure AI Zoeken indexdefinitie

Name	Typ	Description	Required	Verstek
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
type	enum	Type index Mogelijke waarden: AzureSearch	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

AzureAISearchIndexUpdate

Azure AI Zoeken indexdefinitie

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	enum	Type index Mogelijke waarden: AzureSearch	Yes

AzureAISearchQueryType

Beschikbare querytypen voor de Azure AI Zoeken-tool.

Property	Value
Description	Beschikbare querytypen voor de Azure AI Zoeken-tool.
Type	tekenreeks
waarden	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

De inputdefinitie-informatie voor een Azure AI-zoektool zoals gebruikt om een agent te configureren.

Name	Typ	Description	Required	Verstek
azure_ai_search	AzureAISearchToolResource	Een set indexbronnen die worden gebruikt door het hulpprogramma azure_ai_search.	Yes
Indexen └*	matrix van AISearchIndexResource	De indexen die aan deze agent zijn gekoppeld. Er mag maximaal 1 index zijn resource die is gekoppeld aan de agent. Beperkingen: maxItems: 1	Yes
type	enum	Het objecttype, dat altijd 'azure_ai_search' is. Mogelijke waarden: azure_ai_search	Yes

AzureAISearchToolResource

Een set indexbronnen die worden gebruikt door het hulpprogramma azure_ai_search.

Name	Typ	Description	Required	Verstek
Indexen	matrix van AISearchIndexResource	De indexen die aan deze agent zijn gekoppeld. Er mag maximaal 1 index zijn resource die is gekoppeld aan de agent.	Yes

AzureFunctionBinding

De structuur voor het behouden van storage wachtrijnaam en URI.

Name	Typ	Description	Required	Verstek
storage_queue	AzureFunctionStorageQueue	De structuur voor het behouden van storage wachtrijnaam en URI.	Yes
└queue_name	tekenreeks	De naam van een Azure functieopslagwachtrij.	Yes
└queue_service_endpoint	tekenreeks	URI naar de Azure Storage Queue-service waarmee u een wachtrij kunt bewerken.	Yes
type	enum	Het type binding, dat altijd 'storage_queue' is. Mogelijke waarden: storage_queue	Yes

AzureFunctionDefinition

De definitie van de Azure-functie.

Name	Typ	Description	Required	Verstek
function	object	De definitie van de Azure-functie en de bijbehorende parameters.	Yes
└─ Beschrijving	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
└- parameters	object	De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject.	Yes
input_binding	AzureFunctionBinding	De structuur voor het behouden van storage wachtrijnaam en URI.	Yes
└storage_queue	AzureFunctionStorageQueue	Opslagwachtrij.	Yes
└type.	enum	Het type binding, dat altijd 'storage_queue' is. Mogelijke waarden: storage_queue	Yes
output_binding	AzureFunctionBinding	De structuur voor het behouden van storage wachtrijnaam en URI.	Yes
└storage_queue	AzureFunctionStorageQueue	Opslagwachtrij.	Yes
└type.	enum	Het type binding, dat altijd 'storage_queue' is. Mogelijke waarden: storage_queue	Yes

AzureFunctionStorageQueue

De structuur voor het behouden van storage wachtrijnaam en URI.

Name	Typ	Description	Required	Verstek
queue_name	tekenreeks	De naam van een Azure functieopslagwachtrij.	Yes
queue_service_endpoint	tekenreeks	URI naar de Azure Storage Queue-service waarmee u een wachtrij kunt bewerken.	Yes

AzureFunctionTool

De inputdefinitie-informatie voor een Azure Function Tool, zoals gebruikt om een Agent te configureren.

Name	Typ	Description	Required	Verstek
azure_function	AzureFunctionDefinition	De definitie van de Azure-functie.	Yes
└, functie	object	De definitie van de Azure-functie en de bijbehorende parameters.	Yes
└─ Beschrijving	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
└- parameters	object	De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject.	Yes
└input_binding	AzureFunctionBinding	Invoeropslagwachtrij. De wachtrijopslagtrigger voert een functie uit wanneer er berichten aan worden toegevoegd.	Yes
└output_binding	AzureFunctionBinding	Uitvoeropslagwachtrij. De functie schrijft uitvoer naar deze wachtrij wanneer de invoeritems worden verwerkt.	Yes
type	enum	Het objecttype, dat altijd 'browser_automation' is. Mogelijke waarden: azure_function	Yes

AzureOpenAIModelConfiguration

Azure OpenAI-modelconfiguratie. De API-versie wordt door de service geselecteerd voor het opvragen van het model.

Name	Typ	Description	Required	Verstek
modelDeploymentName	tekenreeks	Implementatienaam voor AOAI-model. Voorbeeld: gpt-4o als in AIServices of op basis van connection_name/deployment_name een verbinding (bijvoorbeeld my-aoai-connection/gpt-4o).	Yes
type	enum	Mogelijke waarden: AzureOpenAIModel	Yes

BaseCredentials

Een basisklasse voor verbindingsreferenties

Discriminator voor BaseCredentials

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
ApiKey	ApiKeyCredentials
AAD	EntraIDCredentials
CustomKeys	CustomCredential
SAS	SASCredentials
None	NoAuthenticationCredentials
AgenticIdentityToken_Preview	AgenticIdentityPreviewCredentials

Name	Typ	Description	Required	Verstek
type	CredentialType (alleen-lezen)	Het referentietype dat door de verbinding wordt gebruikt	Yes

BingCustomSearchConfiguration

Een bing aangepaste zoekconfiguratie.

Name	Typ	Description	Required	Verstek
count	integer	Het aantal zoekresultaten dat moet worden geretourneerd in het antwoord van de Bing API	No
freshness	tekenreeks	Zoekresultaten filteren op een specifiek tijdsbereik. Bekijk hier geaccepteerde waarden.	No
instance_name	tekenreeks	Naam van het aangepaste configuratie-exemplaar dat is opgegeven voor de configuratie.	Yes
Markt	tekenreeks	De markt waar de resultaten vandaan komen.	No
project_connection_id	tekenreeks	Project verbindings-id voor grounding met Bing Search	Yes
set_lang	tekenreeks	De taal die moet worden gebruikt voor tekenreeksen van de gebruikersinterface bij het aanroepen van Bing API.	No

BingCustomSearchPreviewTool

De informatie over de invoerdefinitie voor een Bing aangepaste zoekfunctie, zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Description	Required	Verstek
bing_custom_search_preview	BingCustomSearchToolParameters	De bing aangepaste zoekprogrammaparameters.	Yes
└search_configurations	matrix van BingCustomSearchConfiguration	De project verbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma. Beperkingen: maxItems: 1	Yes
type	enum	Het objecttype, dat altijd 'bing_custom_search_preview' is. Mogelijke waarden: bing_custom_search_preview	Yes

BingCustomSearchToolParameters

De bing aangepaste zoekprogrammaparameters.

Name	Typ	Description	Required	Verstek
search_configurations	matrix van BingCustomSearchConfiguration	De project verbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma.	Yes

BingGroundingSearchConfiguration

Zoekconfiguratie voor Bing Grounding

Name	Typ	Description	Required	Verstek
count	integer	Het aantal zoekresultaten dat moet worden geretourneerd in het antwoord van de Bing API	No
freshness	tekenreeks	Zoekresultaten filteren op een specifiek tijdsbereik. Bekijk hier geaccepteerde waarden.	No
Markt	tekenreeks	De markt waar de resultaten vandaan komen.	No
project_connection_id	tekenreeks	Project verbindings-id voor grounding met Bing Search	Yes
set_lang	tekenreeks	De taal die moet worden gebruikt voor tekenreeksen van de gebruikersinterface bij het aanroepen van Bing API.	No

BingGroundingSearchToolParameters

De bing parameters voor zoekhulpprogramma's.

Name	Typ	Description	Required	Verstek
search_configurations	matrix van BingGroundingSearchConfiguration	De zoekconfiguraties die aan dit hulpprogramma zijn gekoppeld. Er mag maximaal 1 zijn zoekconfiguratieresource die is gekoppeld aan het hulpprogramma.	Yes

BingGroundingTool

De informatie over de invoerdefinitie voor een bing grounding search tool zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Description	Required	Verstek
bing_grounding	BingGroundingSearchToolParameters	De bing parameters voor zoekhulpprogramma's.	Yes
└search_configurations	matrix van BingGroundingSearchConfiguration	De zoekconfiguraties die aan dit hulpprogramma zijn gekoppeld. Er mag maximaal 1 zijn zoekconfiguratieresource die is gekoppeld aan het hulpprogramma. Beperkingen: maxItems: 1	Yes
type	enum	Het objecttype, dat altijd 'bing_grounding' is. Mogelijke waarden: bing_grounding	Yes

BlobReference

Details van de blobreferentie.

Name	Typ	Description	Required	Verstek
blobUri	tekenreeks	Blob-URI-pad voor client om gegevens te uploaden. Voorbeeld:https://blob.windows.core.net/Container/Path	Yes
credential	SasCredential	Definitie van SAS-referenties	Yes
└* sasUri	tekenreeks (alleen-lezen)	SAS-URI	Yes
└type.	enum	Type referentie Mogelijke waarden: SAS	Yes
storageAccountArmId	tekenreeks	ARM-id van het opslagaccount dat moet worden gebruikt.	Yes

BrowserAutomationPreviewTool

De invoerdefinitie-informatie voor een Browser Automation Tool, zoals gebruikt om een Agent te configureren.

Name	Typ	Description	Required	Verstek
browser_automation_preview	BrowserAutomationToolParameters	Definitie van invoerparameters voor de Browser Automation Tool.	Yes
└* verbinding	BrowserAutomationToolConnectionParameters	De projectverbindingsparameters die zijn gekoppeld aan het hulpprogramma BrowserAutomatisering.	Yes
type	enum	Het objecttype, dat altijd 'browser_automation_preview' is. Mogelijke waarden: browser_automation_preview	Yes

BrowserAutomationToolConnectionParameters

Definitie van invoerparameters voor de verbinding die wordt gebruikt door de Browser Automation Tool.

Name	Typ	Description	Required	Verstek
project_connection_id	tekenreeks	De id van de projectverbinding met uw Azure Playwright-resource.	Yes

BrowserAutomationToolParameters

Definitie van invoerparameters voor de Browser Automation Tool.

Name	Typ	Description	Required	Verstek
verbinding	BrowserAutomationToolConnectionParameters	Definitie van invoerparameters voor de verbinding die wordt gebruikt door de Browser Automation Tool.	Yes
└project_connection_id	tekenreeks	De id van de projectverbinding met uw Azure Playwright-resource.	Yes

CaptureStructuredOutputsTool

Een tool voor het vastleggen van gestructureerde outputs

Name	Typ	Description	Required	Verstek
outputs	StructuredOutputDefinition	Een gestructureerde uitvoer die door de agent kan worden geproduceerd.	Yes
└─ Beschrijving	tekenreeks	Een beschrijving van de uitvoer die moet worden verzonden. Wordt gebruikt door het model om te bepalen wanneer de uitvoer moet worden verzonden.	Yes
└─naam	tekenreeks	De naam van de gestructureerde uitvoer.	Yes
└─ schema	object	Het JSON-schema voor de gestructureerde uitvoer.	Yes
└─ strikt	Booleaanse waarde (nullable)	Of strikte validatie moet worden afgedwongen. Standaard true.	Yes
type	enum	Het type hulpprogramma. Altijd capture_structured_outputs. Mogelijke waarden: capture_structured_outputs	Yes

ChartCoördinaat

Coördinaten voor de analysegrafiek.

Name	Typ	Description	Required	Verstek
size	integer	De grootte van het grafiekelement.	Yes
x	integer	Coördinaat van X-as.	Yes
y	integer	Y-ascoördinaat.	Yes

ChatSummaryMemoryItem

Een geheugenitem met een samenvatting uit gesprekken.

Name	Typ	Description	Required	Verstek
inhoud	tekenreeks	De inhoud van het geheugen.	Yes
vriendelijk	enum	Het type geheugenitem. Mogelijke waarden: chat_summary	Yes
memory_id	tekenreeks	De unieke ID van het geheugenitem.	Yes
scope	tekenreeks	De naamruimte die herinneringen logisch groepeert en isoleert, zoals een gebruikers-ID.	Yes
updated_at	integer	De laatste updatetijd van het geheugenitem.	Yes

ClusterInsightResult

Inzichten uit de clusteranalyse.

Name	Typ	Description	Required	Verstek
clusters	matrix van InsightCluster	Lijst met clusters die zijn geïdentificeerd in de inzichten.	Yes
Coördinaten	object	Optionele toewijzing van id's aan 2D-coördinaten die worden gebruikt door de UX voor visualisatie. De kaartsleutels zijn tekenreeks-id's (bijvoorbeeld een cluster-id of een voorbeeld-id) en de waarden zijn de coördinaten en de visuele grootte voor rendering in een 2D-grafiek. Deze eigenschap wordt weggelaten, tenzij de client coördinaten aanvraagt (bijvoorbeeld door door te geven includeCoordinates=true als een queryparameter). Voorbeeld: <br> {<br> "cluster-1": { "x": 12, "y": 34, "size": 8 },<br> "sample-123": { "x": 18, "y": 22, "size": 4 }<br> }<br> Coördinaten zijn alleen bedoeld voor visualisatie aan de clientzijde en niet wijzig de canonieke inzichtenresultaten.	No
samenvatting	InsightSummary	Samenvatting van de analyse van het foutencluster.	Yes
Methode └*	tekenreeks	Methode die wordt gebruikt voor clustering.	Yes
└* sampleCount	integer	Totaal aantal geanalyseerde steekproeven.	Yes
└* uniqueClusterCount	integer	Totaal aantal unieke clusters.	Yes
└* uniqueSubclusterCount	integer	Totaal aantal unieke subclusterlabels.	Yes
└─ gebruik	ClusterTokenUsage	Tokengebruik tijdens het uitvoeren van clusteranalyse	Yes

ClusterTokenUsage

Tokengebruik voor clusteranalyse

Name	Typ	Description	Required	Verstek
inputTokenUsage	integer	invoertokengebruik	Yes
outputTokenUsage	integer	gebruik van uitvoertoken	Yes
totalTokenUsage	integer	totaal tokengebruik	Yes

CodeBasedEvaluatorDefinition

Definitie van een beoordelaar op basis van code met behulp van python-code

Name	Typ	Description	Required	Verstek
code_text	tekenreeks	Inlinecodetekst voor de evaluator	Yes
data_schema	object	Het JSON-schema (Draft 2020-12) voor de invoergegevens van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
init_parameters	object	Het JSON-schema (concept 2020-12) voor de invoerparameters van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
metrics	object	Lijst met outputstatistieken geproduceerd door deze beoordelaar	No
type	enum	Mogelijke waarden: code	Yes

CompletionMessageToolCallChunk

Details van hulpprogramma-aanroep binnen een bericht.

Name	Typ	Description	Required	Verstek
function	FunctionToolCall	Details van een aanroep van een functiehulpmiddel.	No
└; argumenten	tekenreeks	De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling.	Yes
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
id	tekenreeks	De id voor de aanroep van het hulpprogramma.	Yes
type	enum	Het type aanroep van het hulpprogramma, dat altijd 'functie' is. Mogelijke waarden: function	Yes

Verbinding

Reactie uit de lijst en verbindingen ophalen bewerkingen

Name	Typ	Description	Required	Verstek
credentials	BaseCredentials (alleen-lezen)	Een basisklasse voor verbindingsreferenties	Yes
└type.	CredentialType (alleen-lezen)	Het type referentie dat wordt gebruikt door de verbinding	Yes
id	tekenreeks (alleen-lezen)	Een unieke id voor de verbinding, gegenereerd door de service	Yes
isDefault	Booleaanse waarde (alleen-lezen)	Of de verbinding is gelabeld als de standaardverbinding van het type	Yes
metadata	object (alleen-lezen)	Metagegevens van de verbinding	Yes
naam	tekenreeks (alleen-lezen)	De beschrijvende naam van de verbinding, geleverd door de gebruiker.	Yes
target	tekenreeks (alleen-lezen)	De verbindings-URL die moet worden gebruikt voor deze service	Yes
type	ConnectionType (alleen-lezen)	Het type (of categorie) van de verbinding	Yes

ConnectionType

Het type (of categorie) van de verbinding

Property	Value
Description	Het type (of categorie) van de verbinding
Type	tekenreeks
waarden	AzureOpenAI AzureBlob AzureStorageAccount CognitiveSearch CosmosDB ApiKey AppConfig AppInsights CustomKeys RemoteTool_Preview

ContainerAppAgentDefinition

De definitie van de container-app-agent.

Name	Typ	Description	Required	Verstek
container_app_resource_id	tekenreeks	De resource-id van de Azure Container App die als host fungeert voor deze agent. Niet veranderlijk in verschillende versies.	Yes
container_protocol_versions	matrix van ProtocolVersionRecord	De protocollen die de agent ondersteunt voor inkomend verkeer van de containers.	Yes
ingress_subdomain_suffix	tekenreeks	Het achtervoegsel dat moet worden toegepast op het subdomein van de app bij het verzenden van inkomend verkeer naar de agent. Dit kan een label zijn (bijvoorbeeld '---current'), een specifieke revisie (bijvoorbeeld '--0000001') of leeg om het standaardeindpunt voor de container-app te gebruiken.	Yes
vriendelijk	enum	Mogelijke waarden: container_app	Yes
rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
└rai_policy_name	tekenreeks	De naam van het RAI-beleid dat moet worden toegepast.	Yes

ContainerDetails

Gedetailleerde informatie over de container.

Name	Typ	Description	Required	Verstek
health_state	tekenreeks	De status van de container.	Yes
provisioning_error	tekenreeks	De inrichtingsfout van de container, indien van toepassing.	No
provisioning_state	tekenreeks	De inrichtingsstatus van de container.	Yes
replicas	matrix van ContainerReplica	De lijst met replica's in de container.	Yes
state	tekenreeks	De status van de container.	Yes
updated_on	tekenreeks	De laatste updatetijd van de container.	Yes

ContainerLogKind

Het type logboek dat vanuit een container moet worden gestreamd.

Property	Value
Type	tekenreeks
waarden	console system

ContainerReplica

Informatie over een containerreplica.

Name	Typ	Description	Required	Verstek
container_state	tekenreeks	De containerstatus van de replica.	Yes
naam	tekenreeks	De naam van de replica.	Yes
state	tekenreeks	De status van de replica.	Yes

ContinuousEvaluationRuleAction

Evaluatieregelactie voor continue evaluatie.

Name	Typ	Description	Required	Verstek
evalId	tekenreeks	Evaluatie-id waaraan continue evaluatieuitvoeringen moeten worden toegevoegd.	Yes
maxHourlyRuns	integer	Maximum aantal evaluatieuitvoeringen dat per uur is toegestaan.	No
type	enum	Mogelijke waarden: continuousEvaluation	Yes

CosmosDBIndex

Definitie van CosmosDB Vector Store-index

Name	Typ	Description	Required	Verstek
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
type	enum	Type index Mogelijke waarden: CosmosDBNoSqlVectorStore	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

CosmosDBIndexUpdate

Definitie van CosmosDB Vector Store-index

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	enum	Type index Mogelijke waarden: CosmosDBNoSqlVectorStore	Yes

CreateAgentFromManifestRequest

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	tekenreeks	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De unieke naam waarmee de agent wordt geïdentificeerd. De naam kan worden gebruikt om de agent op te halen/bij te werken/te verwijderen. - Moet beginnen en eindigen met alfanumerieke tekens, - Kan afbreekstreepjes in het midden bevatten - Mag niet langer zijn dan 63 tekens. Beperkingen: maxLength: 63	Yes
parameter_values	object	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

CreateAgentRequest

Name	Typ	Description	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De unieke naam waarmee de agent wordt geïdentificeerd. De naam kan worden gebruikt om de agent op te halen/bij te werken/te verwijderen. - Moet beginnen en eindigen met alfanumerieke tekens, - Kan afbreekstreepjes in het midden bevatten - Mag niet langer zijn dan 63 tekens. Beperkingen: maxLength: 63	Yes

CreateAgentVersionFromManifestRequest

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	tekenreeks	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
parameter_values	object	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

CreateAgentVersionRequest

Name	Typ	Description	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

CreateEvalRequest

Name	Typ	Description	Required	Verstek
gegevensbron_configuratie	OpenAI.CreateEvalCustomDataSourceConfig of OpenAI.CreateEvalLogsDataSourceConfig of OpenAI.CreateEvalStoredCompletionsDataSourceConfig of AzureAIDataSourceConfig	De configuratie voor de gegevensbron die wordt gebruikt voor de evaluatieuitvoering. Bepaalt het schema van de gegevens die in de evaluatie worden gebruikt.	Yes
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van de evaluatie.	No
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
testing_criteria	matrix van OpenAI.EvalGraderLabelModel of OpenAI.EvalGraderStringCheck of OpenAI.EvalGraderTextSimilarity of OpenAI.EvalGraderPython of OpenAI.EvalGraderScoreModel of EvalGraderAzureAIEvaluator	Een lijst met beoordelaars voor alle evaluatieruns in deze groep. Graders kunnen verwijzen naar variabelen in de gegevensbron met dubbele accolades, zoals {{item.variable_name}}. Als u naar de uitvoer van het model wilt verwijzen, gebruikt u de sample naamruimte (ie, {{sample.output_text}}).	Yes

Aanvraag voor EvaluatieRun Creëeren

Name	Typ	Description	Required	Verstek
gegevensbron	OpenAI.CreateEvalJsonlRunDataSource of OpenAI.CreateEvalCompletionsRunDataSource of OpenAI.CreateEvalResponsesRunDataSource of EvalRunDataSource	Details over de gegevensbron van de uitvoering.	Yes
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks	De naam van de run.	No
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

CredentialType

Het referentietype dat door de verbinding wordt gebruikt

Property	Value
Description	Het referentietype dat door de verbinding wordt gebruikt
Type	tekenreeks
waarden	ApiKey AAD SAS CustomKeys None AgenticIdentityToken_Preview

CronTrigger

Cron gebaseerde trigger.

Name	Typ	Description	Required	Verstek
endTime	tekenreeks	Eindtijd voor het cron-schema in ISO 8601-formaat.	No
expression	tekenreeks	Cron-expressie die de planningsfrequentie definieert.	Yes
startTime	tekenreeks	Starttijd voor het cron-schema in ISO 8601-formaat.	No
timeZone	tekenreeks	Tijdzone voor het cron-schema.	No	UTC
type	enum	Mogelijke waarden: Cron	Yes

CustomCredential

Definitie van aangepaste referenties

Name	Typ	Description	Required	Verstek
type	enum	Het type aanmeldingsgegevens Mogelijke waarden: CustomKeys	Yes

Dit object accepteert ook aanvullende eigenschappen van het type: tekenreeks

DailyRecurrenceSchedule

Dagelijks herhalingsschema.

Name	Typ	Description	Required	Verstek
hours	matrix van geheel getal	Uren voor het terugkeerschema.	Yes
type	enum	Dagelijks terugkeertype. Mogelijke waarden: Daily	Yes

DataSourceConfig

Basisklasse voor het uitvoeren van gegevensbronnen met discriminator-ondersteuning.

Discriminator voor DataSourceConfig

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema

Name	Typ	Description	Required	Verstek
schema	object	Het algemene JSON-schema voor het uitvoeren van gegevensbronitems.	Yes
type	tekenreeks	De discriminatie van het gegevensbrontype.	Yes

DatasetType

Opsomming om het type gegevens te bepalen.

Property	Value
Description	Opsomming om het type gegevens te bepalen.
Type	tekenreeks
waarden	uri_file uri_folder

DatasetVersion

Definitie van datasetversie

Discriminator voor DatasetVersion

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
uri_file	FileDatasetVersion
uri_folder	FolderDatasetVersion

Name	Typ	Description	Required	Verstek
connectionName	tekenreeks	De naam van de Azure Storage accountverbinding. Vereist als startPendingUploadVersion niet is aangeroepen voordat de gegevensset werd gemaakt	No
dataUri	tekenreeks	URI van de gegevens (voorbeeld) Beperkingen: minLength: 1, patroon: [a-zA-Z0-9_]	Yes
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
isReference	Booleaanse waarde (alleen-lezen)	Geeft aan of de gegevensset een verwijzing naar de opslag bevat of dat de gegevensset de opslag zelf beheert. Indien waar, worden de onderliggende gegevens niet verwijderd wanneer de versie van de gegevensset wordt verwijderd	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
type	DatasetType	Opsomming om het type gegevens te bepalen.	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

DatasetVersionUpdate

Definitie van datasetversie

Discriminator voor DatasetVersionUpdate

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
uri_file	FileDatasetVersionUpdate
uri_folder	FolderDatasetVersionUpdate

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	DatasetType	Opsomming om het type gegevens te bepalen.	Yes

Dag van de Week

Dagen van de week voor het herhalingsschema.

Property	Value
Description	Dagen van de week voor het herhalingsschema.
Type	tekenreeks
waarden	Sunday Monday Tuesday Wednesday Thursday Friday Saturday

DeleteAgentResponse

Een verwijderd agentobject

Name	Typ	Description	Required	Verstek
verwijderd	boolean	Of de agent is verwijderd.	Yes
naam	tekenreeks	De naam van de agent.	Yes
object	enum	Het objecttype. Altijd 'agent.deleted'. Mogelijke waarden: agent.deleted	Yes

DeleteAgentVersionResponse

Een verwijderde agentversie Object

Name	Typ	Description	Required	Verstek
verwijderd	boolean	Of de agent is verwijderd.	Yes
naam	tekenreeks	De naam van de agent.	Yes
object	enum	Het objecttype. Altijd 'agent.version.deleted'. Mogelijke waarden: agent.version.deleted	Yes
version	tekenreeks	De versie-id van de agent.	Yes

DeleteEvalResponse

Een verwijderd evaluatieobject

Name	Typ	Description	Required	Verstek
verwijderd	boolean	Of de evaluatie is verwijderd.	Yes
eval_id	tekenreeks	id van de evaluatie.	Yes
object	enum	Het objecttype. Altijd 'eval.deleted'. Mogelijke waarden: eval.deleted	Yes

DeleteEvalRunResponse

Een verwijderd evaluatieuitvoeringsobject.

Name	Typ	Description	Required	Verstek
verwijderd	boolean	Of de evaluatie is verwijderd.	No
object	enum	Het objecttype. Altijd 'eval.deleted'. Mogelijke waarden: eval.deleted	No
run_id	tekenreeks	id van de evaluatie.	No

DeleteMemoryStoreResponse

Name	Typ	Description	Required	Verstek
verwijderd	boolean	Of het geheugenarchief is verwijderd.	Yes
naam	tekenreeks	De naam van het geheugenarchief.	Yes
object	enum	Het objecttype. Altijd 'memory_store.deleted'. Mogelijke waarden: memory_store.deleted	Yes

DeleteResponseResult

Het resultaat van een verwijderreactiebewerking.

Name	Typ	Description	Required	Verstek
verwijderd	enum	Altijd waar retourneren Mogelijke waarden: True	Yes
id	tekenreeks	De bewerkings-id.	Yes
object	enum	Retourneer altijd 'antwoord'. Mogelijke waarden: response	Yes

Deployment

Definitie van modelimplementatie

Onderscheid maken voor implementatie

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
ModelDeployment	ModelDeployment

Name	Typ	Description	Required	Verstek
naam	tekenreeks (alleen-lezen)	Naam van de implementatie	Yes
type	DeploymentType		Yes

DeploymentType

Property	Value
Type	tekenreeks
waarden	ModelDeployment

EntraIDCredentials

Entra ID credential definitie

Name	Typ	Description	Required	Verstek
type	enum	Het type aanmeldingsgegevens Mogelijke waarden: AAD	Yes

Eval

Een Eval-object met een configuratie- en testcriteria voor een gegevensbron. Een Eval vertegenwoordigt een taak die moet worden uitgevoerd voor uw LLM-integratie. Vind ik leuk:

• De kwaliteit van mijn chatbot verbeteren
• Bekijk hoe goed mijn chatbot de klantondersteuning afhandelt
• Controleer of o4-mini beter is in mijn usecase dan gpt-4o

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer de eval is aangemaakt.	Yes
gemaakt door	tekenreeks	de naam van de persoon die de uitvoering heeft gemaakt.	No
gegevensbron_configuratie	OpenAI.CreateEvalCustomDataSourceConfig of OpenAI.CreateEvalLogsDataSourceConfig of OpenAI.CreateEvalStoredCompletionsDataSourceConfig of AzureAIDataSourceConfig	Configuratie van gegevensbronnen die worden gebruikt in uitvoeringen van de evaluatie.	Yes
id	tekenreeks	Unieke id voor de evaluatie.	Yes
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Yes
modified_at	geheel getal		No
naam	tekenreeks	De naam van de evaluatie.	Yes
object	enum	Het objecttype. Mogelijke waarden: eval	Yes
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
testing_criteria	matrix van OpenAI.EvalGraderLabelModel of OpenAI.EvalGraderStringCheck of OpenAI.EvalGraderTextSimilarity of OpenAI.EvalGraderPython of OpenAI.EvalGraderScoreModel of EvalGraderAzureAIEvaluator	Een lijst met testcriteria.	Yes

EvalCsvFileIdSource

Vertegenwoordigt een verwijzing naar een geüpload CSV-bestand dat wordt gebruikt als bron voor evaluatiegegevens.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De id van het geüploade CSV-bestand.	Yes
type	enum	Het type bron, altijd file_id. Mogelijke waarden: file_id	Yes

EvalCsvRunDataSource

Vertegenwoordigt een CSV-gegevensbron voor evaluatieuitvoeringen.

Name	Typ	Description	Required	Verstek
source	EvalCsvFileIdSource	Vertegenwoordigt een verwijzing naar een geüpload CSV-bestand dat wordt gebruikt als bron voor evaluatiegegevens.	Yes
└─ id	tekenreeks	De id van het geüploade CSV-bestand.	Yes
└type.	enum	Het type bron, altijd file_id. Mogelijke waarden: file_id	Yes
type	enum	Het type gegevensbron, altijd csv. Mogelijke waarden: csv	Yes

EvalGraderAzureAIEvaluator

Name	Typ	Description	Required	Verstek
gegevenskoppeling	object	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	No
evaluator_name	tekenreeks	De naam van de evaluator.	Yes
evaluator_version	tekenreeks	De versie van de evaluator. Nieuwste versie als deze niet is opgegeven.	No
initialization_parameters	object	De initialisatieparameters voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	No
naam	tekenreeks	De naam van de beoordelaar.	Yes
type	enum	Het objecttype, dat altijd azure_ai_evaluatoris. Mogelijke waarden: azure_ai_evaluator	Yes

EvalResult

Resultaat van de evaluatie.

Name	Typ	Description	Required	Verstek
naam	tekenreeks	naam van de controle	Yes
Doorgegeven	boolean	geeft aan of de controle is geslaagd of mislukt	Yes
Score	number	Score	Yes
type	tekenreeks	type controle	Yes

EvalRun

Een schema dat een evaluatieuitvoering vertegenwoordigt.

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	Unix-tijdstempel (in seconden) wanneer de evaluatieuitvoering is gemaakt.	Yes
gemaakt door	tekenreeks	de naam van de persoon die de uitvoering heeft gemaakt.	No
gegevensbron	OpenAI.CreateEvalJsonlRunDataSource of OpenAI.CreateEvalCompletionsRunDataSource of OpenAI.CreateEvalResponsesRunDataSource of EvalRunDataSource	Informatie over de gegevensbron van de uitvoering.	Yes
fout	OpenAI.EvalApiError	Een object dat een foutbericht weergeeft van de Eval-API.	Yes
eval_id	tekenreeks	De identificator van de bijbehorende evaluatie.	Yes
id	tekenreeks	Unieke identificator voor de evaluatierun.	Yes
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Yes
model	tekenreeks	Het model dat wordt geëvalueerd, indien van toepassing.	Yes
modified_at	geheel getal		No
naam	tekenreeks	De naam van de evaluatieronde.	Yes
object	enum	Het type van het object. Altijd 'eval.run'. Mogelijke waarden: eval.run	Yes
gebruik per model	matrix van OpenAI.EvalRunPerModelUsage	Gebruiksstatistieken voor elk model tijdens de evaluatieuitvoering.	Yes
per_testcriteria_resultaten	matrix van OpenAI.EvalRunPerTestingCriteriaResults	Resultaten per testcriteria die zijn toegepast tijdens de evaluatieuitvoering.	Yes
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
report_url	tekenreeks	De URL naar het weergegeven evaluatierapport op het UI-dashboard.	Yes
aantal_resultaten	OpenAI.EvalRunResultCounts		Yes
└* fout opgetreden	OpenAI.integer		Yes
└* mislukt	OpenAI.integer		Yes
└* geslaagd	OpenAI.integer		Yes
└totaal.	OpenAI.integer		Yes
status	tekenreeks	De status van de evaluatiesessie.	Yes

EvalRunDataSource

Basisklasse voor het uitvoeren van gegevensbronnen met discriminator-ondersteuning.

Discriminator voor EvalRunDataSource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
azure_ai_traces_preview	TracesPreviewEvalRunDataSource
azure_ai_synthetic_data_gen_preview	SyntheticDataGenerationPreviewEvalRunDataSource
azure_ai_responses	AzureAIResponsesEvalRunDataSource
azure_ai_target_completions	TargetCompletionEvalRunDataSource
csv	EvalCsvRunDataSource
azure_ai_red_team	RedTeamEvalRunDataSource

Name	Typ	Description	Required	Verstek
type	tekenreeks	De discriminatie van het gegevensbrontype.	Yes

EvalRunOutputItem

Een schema dat een uitvoeritem voor de evaluatieuitvoering vertegenwoordigt.

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	Unix-tijdstempel (in seconden) wanneer de evaluatieuitvoering is gemaakt.	Yes
gegevensbron_item	object	Details van het invoergegevensbronitem.	Yes
gegevensbron_item_id	OpenAI.integer		Yes
eval_id	tekenreeks	De id van de evaluatiegroep.	Yes
id	tekenreeks	Unieke id voor het uitvoeritem van de evaluatieuitvoering.	Yes
object	enum	Het type van het object. Altijd 'eval.run.output_item'. Mogelijke waarden: eval.run.output_item	Yes
results	matrix van EvalRunOutputItemResult	Een lijst met cijferresultaten voor dit uitvoeritem.	Yes
run_id	tekenreeks	De id van de evaluatieuitvoering die is gekoppeld aan dit uitvoeritem.	Yes
voorbeeld	OpenAI.EvalRunOutputItemSample		Yes
└─ fout	OpenAI.EvalApiError	Een object dat een foutbericht weergeeft van de Eval-API.	Yes
└finish_reason	tekenreeks		Yes
└input.	matrix van EvalRunOutputItemSampleInput		Yes
└max_completion_tokens	OpenAI.integer		Yes
└model.	tekenreeks		Yes
└─ uitvoer	matrix van EvalRunOutputItemSampleOutput		Yes
└─ zaad	OpenAI.integer		Yes
└─ temperatuur	OpenAI.numeriek		Yes
└─ top_p	OpenAI.numeriek		Yes
└─ gebruik	OpenAI.EvalRunOutputItemSampleUsage		Yes
status	tekenreeks	De status van de evaluatiesessie.	Yes

EvalRunOutputItemResult

Eén cijferresultaat voor een uitvoeritem voor evaluatieuitvoering.

Name	Typ	Description	Required	Verstek
label	tekenreeks	Het label dat is gekoppeld aan de metrische testcriteria (bijvoorbeeld 'pass', 'fail', 'good', 'bad').	No
metric	tekenreeks	De naam van de metrische waarde (bijvoorbeeld 'vloeiendheid', 'f1_score').	No
naam	tekenreeks	De naam van de beoordelaar.	Yes
Doorgegeven	boolean	Of de grader de uitvoer als een pas beschouwd heeft.	Yes
properties	object	Aanvullende informatie over de metrische testcriteria.	No
reden	tekenreeks	De reden voor de metrische testcriteria.	No
voorbeeld	object (nul)	Optionele voorbeeld- of tussenliggende gegevens die door de grader worden geproduceerd.	No
Score	OpenAI.numeriek		Yes
threshold	number	De drempelwaarde die wordt gebruikt voor het bepalen van de pass/fail voor deze testcriteria, als deze numeriek is.	No
type	tekenreeks	Het cijfertype (bijvoorbeeld 'string-check-grader').	No

Dit object accepteert ook aanvullende eigenschappen.

EvalRunOutputItemSampleInput

Een bericht in de evaluatieuitvoering.

Name	Typ	Description	Required	Verstek
inhoud	tekenreeks		Yes
role	tekenreeks		Yes
tool_calls	matrix van CompletionMessageToolCallChunk	Hulpprogramma-aanroepen binnen het bericht, indien van toepassing.	Yes

EvalRunOutputItemSampleOutput

Een bericht in de evaluatieuitvoering.

Name	Typ	Description	Required	Verstek
inhoud	tekenreeks		No
role	tekenreeks		No
tool_calls	matrix van CompletionMessageToolCallChunk	Hulpprogramma-aanroepen binnen het bericht, indien van toepassing.	Yes

EvalRunResultCompareItem

Metrische vergelijking voor een behandeling ten opzichte van de baseline.

Name	Typ	Description	Required	Verstek
deltaEstimate	number	Geschatte verschil tussen behandeling en basislijn.	Yes
pValue	number	P-waarde voor het behandelingseffect.	Yes
treatmentEffect	TreatmentEffectType	Type behandelingseffect.	Yes
treatmentRunId	tekenreeks	De behandelingsuitvoerings-id.	Yes
behandelingRunSummary	EvalRunResultSummary	Samenvattende statistieken van een metrische waarde in een evaluatierun.	Yes
└} gemiddelde	number	De gemiddelde waarde van de metrische waarde in de evaluatieuitvoering.	Yes
└} runId	tekenreeks	De uitvoerings-id van de evaluatie.	Yes
└* sampleCount	integer	Aantal voorbeelden in de evaluatieuitvoering.	Yes
└* standardDeviation	number	Standaarddeviatie van de metrische waarde in de evaluatieuitvoering.	Yes

EvalRunResultComparison

Vergelijkingsresultaten voor behandeling lopen tegen de uitgangswaarde.

Name	Typ	Description	Required	Verstek
baselineRunSummary	EvalRunResultSummary	Samenvattende statistieken van een metrische waarde in een evaluatierun.	Yes
└} gemiddelde	number	De gemiddelde waarde van de metrische waarde in de evaluatieuitvoering.	Yes
└} runId	tekenreeks	De uitvoerings-id van de evaluatie.	Yes
└* sampleCount	integer	Aantal voorbeelden in de evaluatieuitvoering.	Yes
└* standardDeviation	number	Standaarddeviatie van de metrische waarde in de evaluatieuitvoering.	Yes
compareItems	matrix van EvalRunResultCompareItem	Lijst met vergelijkingsresultaten voor elke behandelingsuitvoering.	Yes
Evaluatiebureau	tekenreeks	Naam van de evaluator voor deze testcriteria.	Yes
metric	tekenreeks	Metrische gegevens die worden geëvalueerd.	Yes
testingCriteria	tekenreeks	Naam van de testcriteria.	Yes

EvalRunResultSummary

Samenvattende statistieken van een metrische waarde in een evaluatierun.

Name	Typ	Description	Required	Verstek
gemiddeld	number	De gemiddelde waarde van de metrische waarde in de evaluatieuitvoering.	Yes
runId	tekenreeks	De uitvoerings-id van de evaluatie.	Yes
sampleCount	integer	Aantal voorbeelden in de evaluatieuitvoering.	Yes
standardDeviation	number	Standaarddeviatie van de metrische waarde in de evaluatieuitvoering.	Yes

EvaluationComparisonInsightRequest

Evaluatie Vergelijking Aanvraag

Name	Typ	Description	Required	Verstek
baselineRunId	tekenreeks	De basislijnuitvoerings-id voor vergelijking.	Yes
evalId	tekenreeks	Id voor de evaluatie.	Yes
treatmentRunIds	array van tekenreeksen	Lijst met behandelingsrun-id's voor vergelijking.	Yes
type	enum	Het type aanvraag. Mogelijke waarden: EvaluationComparison	Yes

EvaluationComparisonInsightResult

Inzichten uit de evaluatievergelijking.

Name	Typ	Description	Required	Verstek
Vergelijkingen	matrix van EvalRunResultComparison	Vergelijkingsresultaten voor elke behandeling die op basis van de basislijn wordt uitgevoerd.	Yes
method	tekenreeks	De statistische methode die wordt gebruikt voor vergelijking.	Yes
type	enum	Het type inzichtenresultaat. Mogelijke waarden: EvaluationComparison	Yes

EvaluationResultSample

Een greep uit het evaluatieresultaat.

Name	Typ	Description	Required	Verstek
correlationInfo	object	Informatie over de correlatie voor het analysevoorbeeld.	Yes
evaluationResult	EvalResult	Resultaat van de evaluatie.	Yes
└─naam	tekenreeks	naam van de controle	Yes
└* geslaagd	boolean	geeft aan of de controle is geslaagd of mislukt	Yes
└} score	number	Score	Yes
└type.	tekenreeks	type controle	Yes
features	object	Functies die u helpen bij het extra filteren van gegevens in UX.	Yes
id	tekenreeks	De unieke id voor het analysevoorbeeld.	Yes
type	enum	Voorbeeldtype evaluatieresultaat Mogelijke waarden: EvaluationResultSample	Yes

Evaluatie Regel

Model voor evaluatieregels.

Name	Typ	Description	Required	Verstek
action	EvaluationRuleAction	Evaluatie actiemodel.	Yes
└type.	EvaluationRuleActionType	Aard van de evaluatieactie.	Yes
beschrijving	tekenreeks	Beschrijving voor de evaluatieregel.	No
displayName	tekenreeks	Weergavenaam voor de evaluatieregel.	No
enabled	boolean	Geeft aan of de evaluatieregel is ingeschakeld. De standaardwaarde is waar.	Yes
eventType	EvaluationRuleEventType	Type van de gebeurtenis van de evaluatieregel.	Yes
filter	EvaluationRuleFilter	Evaluatie filtermodel.	No
└} agentName	tekenreeks	Filter op agentnaam.	Yes
id	tekenreeks (alleen-lezen)	Unieke id voor de evaluatieregel.	Yes
systeemgegevens	object (alleen-lezen)	Systeemmetagegevens voor de evaluatieregel.	Yes

EvaluationRuleAction

Evaluatie actiemodel.

Discriminator voor EvaluationRuleAction

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
continuousEvaluation	ContinuousEvaluationRuleAction
humanEvaluationPreview	HumanEvaluationPreviewRuleAction

Name	Typ	Description	Required	Verstek
type	EvaluationRuleActionType	Aard van de evaluatieactie.	Yes

EvaluationRuleActionType

Aard van de evaluatieactie.

Property	Value
Description	Aard van de evaluatieactie.
Type	tekenreeks
waarden	continuousEvaluation humanEvaluationPreview

EvaluationRuleEventType

Type van de gebeurtenis van de evaluatieregel.

Property	Value
Description	Type van de gebeurtenis van de evaluatieregel.
Type	tekenreeks
waarden	responseCompleted manual

EvaluationRuleFilter

Evaluatie filtermodel.

Name	Typ	Description	Required	Verstek
agentName	tekenreeks	Filter op agentnaam.	Yes

EvaluationRunClusterInsightRequest

Inzichten in de set evaluatieresultaten

Name	Typ	Description	Required	Verstek
evalId	tekenreeks	Evaluatie-id voor de inzichten.	Yes
modelConfiguratie	InsightModelConfiguration	Configuratie van het model dat wordt gebruikt bij het genereren van inzichten.	No
└* modelDeploymentName	tekenreeks	De te evalueren modelimplementatie. Accepteert alleen de implementatienaam of met de verbindingsnaam als {connectionName}/<modelDeploymentName>.	Yes
runIds	array van tekenreeksen	Lijst met evaluatie-uitvoerings-id's voor de inzichten.	Yes
type	enum	Het type inzichtenaanvraag. Mogelijke waarden: EvaluationRunClusterInsight	Yes

EvaluationRunClusterInsightResult

Inzichten uit de evaluatie voeren clusteranalyse uit.

Name	Typ	Description	Required	Verstek
clusterInsight	ClusterInsightResult	Inzichten uit de clusteranalyse.	Yes
type	enum	Het type inzichtenresultaat. Mogelijke waarden: EvaluationRunClusterInsight	Yes

EvaluationScheduleTask

Evaluatietaak voor het rooster.

Name	Typ	Description	Required	Verstek
configuration	object	Configuratie voor de taak.	No
evalId	tekenreeks	Id van de evaluatiegroep.	Yes
evalRun	object	De nettolading van de evaluatieuitvoering.	Yes
type	enum	Mogelijke waarden: Evaluation	Yes

EvaluationTaxonomy

Evaluatie taxonomie definitie

Name	Typ	Description	Required	Verstek
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
properties	object	Aanvullende eigenschappen voor de evaluatietaxonomie.	No
taxonomiecategorieën	matrix van TaxonomieCategory	Lijst met taxonomiecategorieën.	No
taxonomieInput	EvaluationTaxonomyInput	Invoerconfiguratie voor de evaluatietaxonomie.	Yes
└type.	EvaluationTaxonomyInputType	Invoertype van de evaluatietaxonomie.	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

EvaluationTaxonomyCreateOrUpdate

Evaluatie taxonomie definitie

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
properties	object	Aanvullende eigenschappen voor de evaluatietaxonomie.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
taxonomiecategorieën	matrix van TaxonomieCategory	Lijst met taxonomiecategorieën.	No
taxonomieInput	EvaluationTaxonomyInput	Invoerconfiguratie voor de evaluatietaxonomie.	Yes
└type.	EvaluationTaxonomyInputType	Invoertype van de evaluatietaxonomie.	Yes

EvaluationTaxonomyInput

Invoerconfiguratie voor de evaluatietaxonomie.

Discriminator voor EvaluationTaxonomyInput

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
agent	AgentTaxonomyInput

Name	Typ	Description	Required	Verstek
type	EvaluationTaxonomyInputType	Type van de taxonomie-invoer van de evaluatie.	Yes

EvaluationTaxonomyInputType

Type van de taxonomie-invoer van de evaluatie.

Property	Value
Description	Type van de taxonomie-invoer van de evaluatie.
Type	tekenreeks
waarden	agent policy

EvaluationTaxonomyInputUpdate

Invoerconfiguratie voor de evaluatietaxonomie.

Discriminator voor EvaluationTaxonomyInputUpdate

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
agent	AgentTaxonomyInputUpdate

Name	Typ	Description	Required	Verstek
type	EvaluationTaxonomyInputType	Type van de taxonomie-invoer van de evaluatie.	Yes

EvaluationTaxonomyUpdate

Evaluatie taxonomie definitie

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
properties	object	Aanvullende eigenschappen voor de evaluatietaxonomie.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
taxonomiecategorieën	matrix van TaxonomieCategory	Lijst met taxonomiecategorieën.	No
taxonomieInput	EvaluationTaxonomyInputUpdate	Invoerconfiguratie voor de evaluatietaxonomie.	No
└type.	EvaluationTaxonomyInputType	Invoertype van de evaluatietaxonomie.	Yes

EvaluatorCategory

De categorie van de evaluator

Property	Value
Description	De categorie van de evaluator
Type	tekenreeks
waarden	quality safety agents

EvaluatorDefinition

Configuratie van basisbeoordelaar met discriminator

Discriminator voor EvaluatorDefinition

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
code	CodeBasedEvaluatorDefinition
prompt	PromptBasedEvaluatorDefinition

Name	Typ	Description	Required	Verstek
data_schema	object	Het JSON-schema (Draft 2020-12) voor de invoergegevens van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
init_parameters	object	Het JSON-schema (concept 2020-12) voor de invoerparameters van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
metrics	object	Lijst met outputstatistieken geproduceerd door deze beoordelaar	No
type	EvaluatorDefinitionType	De definitie van het type beoordelaar	Yes

EvaluatorDefinitionType

De definitie van het type beoordelaar

Property	Value
Description	De definitie van het type beoordelaar
Type	tekenreeks
waarden	prompt code prompt_and_code service openai_graders

EvaluatorMetric

Evaluator metriek

Name	Typ	Description	Required	Verstek
desirable_direction	EvaluatorMetricDirection	De richting van de metriek die aangeeft of een hogere waarde beter, een lagere waarde beter of neutraal is	No
is_primary	boolean	Geeft aan of deze metrische waarde primair is wanneer er meerdere metrische gegevens zijn.	No
max_value	number	Maximumwaarde voor de metrische waarde. Als dit niet is opgegeven, wordt ervan uitgegaan dat deze niet-afhankelijk is.	No
min_value	number	Minimumwaarde voor de metrische waarde	No
type	EvaluatorMetricType	Het type van de evaluator	No

EvaluatorMetricDirection

De richting van de metriek die aangeeft of een hogere waarde beter, een lagere waarde beter of neutraal is

Property	Value
Description	De richting van de metriek die aangeeft of een hogere waarde beter, een lagere waarde beter of neutraal is
Type	tekenreeks
waarden	increase decrease neutral

EvaluatorMetricType

Het type van de evaluator

Property	Value
Description	Het type van de evaluator
Type	tekenreeks
waarden	ordinal continuous boolean

EvaluatorType

Het type van de evaluator

Property	Value
Description	Het type van de evaluator
Type	tekenreeks
waarden	builtin custom

EvaluatorVersion

Definitie van evaluator

Name	Typ	Description	Required	Verstek
categories	matrix van EvaluatorCategory	De categorieën van de evaluator	Yes
aangemaakt_op	tekenreeks (alleen-lezen)	Aanmaakdatum/-tijd van de evaluator	Yes
gemaakt door	tekenreeks (alleen-lezen)	Maker van de evaluator	Yes
definitie	EvaluatorDefinition	Configuratie van basisbeoordelaar met discriminator	Yes
└data_schema	object	Het JSON-schema (Draft 2020-12) voor de invoergegevens van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
└init_parameters	object	Het JSON-schema (concept 2020-12) voor de invoerparameters van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
Metrische gegevens └*	object	Lijst met outputstatistieken geproduceerd door deze beoordelaar	No
└type.	EvaluatorDefinitionType	De definitie van het type beoordelaar	Yes
display_name	tekenreeks	Weergavenaam voor evaluator. Het helpt om de evaluator gemakkelijk te vinden in AI Foundry. Het hoeft niet uniek te zijn.	No
evaluator_type	EvaluatorType	Het type van de evaluator	Yes
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
metadata	object	Metadata over de evaluator	No
modified_at	tekenreeks (alleen-lezen)	Laatst gewijzigde datum/tijd van de evaluator	Yes
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

EvaluatorVersionCreate

Definitie van evaluator

Name	Typ	Description	Required	Verstek
categories	matrix van EvaluatorCategory	De categorieën van de evaluator	Yes
definitie	EvaluatorDefinition	Configuratie van basisbeoordelaar met discriminator	Yes
└data_schema	object	Het JSON-schema (Draft 2020-12) voor de invoergegevens van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
└init_parameters	object	Het JSON-schema (concept 2020-12) voor de invoerparameters van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
Metrische gegevens └*	object	Lijst met outputstatistieken geproduceerd door deze beoordelaar	No
└type.	EvaluatorDefinitionType	De definitie van het type beoordelaar	Yes
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
display_name	tekenreeks	Weergavenaam voor evaluator. Het helpt om de evaluator gemakkelijk te vinden in AI Foundry. Het hoeft niet uniek te zijn.	No
evaluator_type	EvaluatorType	Het type van de evaluator	Yes
metadata	object	Metadata over de evaluator	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No

EvaluatorVersionUpdate

Definitie van evaluator

Name	Typ	Description	Required	Verstek
categories	matrix van EvaluatorCategory	De categorieën van de evaluator	No
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
display_name	tekenreeks	Weergavenaam voor evaluator. Het helpt om de evaluator gemakkelijk te vinden in AI Foundry. Het hoeft niet uniek te zijn.	No
metadata	object	Metadata over de evaluator	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No

FabricDataAgentToolParameters

De parameters van de fabric data agent.

Name	Typ	Description	Required	Verstek
project_connections	matrix van ToolProjectConnection	De project verbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma.	No

FileDatasetVersion

Definitie van FileDatasetVersion

Name	Typ	Description	Required	Verstek
connectionName	tekenreeks	De naam van de Azure Storage accountverbinding. Vereist als startPendingUploadVersion niet is aangeroepen voordat de gegevensset werd gemaakt	No
dataUri	tekenreeks	URI van de gegevens (voorbeeld) Beperkingen: minLength: 1, patroon: [a-zA-Z0-9_]	Yes
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
isReference	Booleaanse waarde (alleen-lezen)	Geeft aan of de gegevensset een verwijzing naar de opslag bevat of dat de gegevensset de opslag zelf beheert. Indien waar, worden de onderliggende gegevens niet verwijderd wanneer de versie van de gegevensset wordt verwijderd	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
type	enum	Gegevenssettype Mogelijke waarden: uri_file	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

FileDatasetVersionUpdate

Definitie van FileDatasetVersion

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	enum	Gegevenssettype Mogelijke waarden: uri_file	Yes

FolderDatasetVersion

Definitie van FileDatasetVersion

Name	Typ	Description	Required	Verstek
connectionName	tekenreeks	De naam van de Azure Storage accountverbinding. Vereist als startPendingUploadVersion niet is aangeroepen voordat de gegevensset werd gemaakt	No
dataUri	tekenreeks	URI van de gegevens (voorbeeld) Beperkingen: minLength: 1, patroon: [a-zA-Z0-9_]	Yes
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
isReference	Booleaanse waarde (alleen-lezen)	Geeft aan of de gegevensset een verwijzing naar de opslag bevat of dat de gegevensset de opslag zelf beheert. Indien waar, worden de onderliggende gegevens niet verwijderd wanneer de versie van de gegevensset wordt verwijderd	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
type	enum	Gegevenssettype Mogelijke waarden: uri_folder	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

FolderDatasetVersionUpdate

Definitie van FileDatasetVersion

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	enum	Gegevenssettype Mogelijke waarden: uri_folder	Yes

FunctionToolCall

Details van een aanroep van een functiehulpmiddel.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	De argumenten waarmee de functie moet worden aangeroepen, zoals gegenereerd door het model in JSON-indeling.	Yes
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes

HostedAgentDefinition

De definitie van de gehoste agent.

Name	Typ	Description	Required	Verstek
container_protocol_versions	matrix van ProtocolVersionRecord	De protocollen die de agent ondersteunt voor inkomend verkeer van de containers.	Yes
cpu	tekenreeks	De CPU-configuratie voor de gehoste agent.	Yes
environment_variables	object	Omgevingsvariabelen die moeten worden ingesteld in de gehoste agentcontainer.	No
image	tekenreeks	De installatiekopie-id voor de agent, die van toepassing is op gehoste agents op basis van installatiekopieën.	No
vriendelijk	enum	Mogelijke waarden: hosted	Yes
memory	tekenreeks	De geheugenconfiguratie voor de gehoste agent.	Yes
rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
└rai_policy_name	tekenreeks	De naam van het RAI-beleid dat moet worden toegepast.	Yes
tools	matrix van OpenAI.Tool	Een reeks hulpprogramma's die het model van de gehoste agent kan aanroepen tijdens het genereren van een reactie. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen.	No

HourlyRecurrenceSchedule

Herhalingsschema per uur.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: Hourly	Yes

HumanEvaluationPreviewRuleAction

Evaluatieregelactie voor menselijke evaluatie.

Name	Typ	Description	Required	Verstek
templateId	AssetId	Id van een opgeslagen asset.	Yes
type	enum	Mogelijke waarden: humanEvaluationPreview	Yes

Index

Definitie van indexresource

Discriminator voor index

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
AzureSearch	AzureAISearchIndex
ManagedAzureSearch	ManagedAzureAISearchIndex
CosmosDBNoSqlVectorStore	CosmosDBIndex

Name	Typ	Description	Required	Verstek
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
type	IndexType		Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

IndexType

Property	Value
Type	tekenreeks
waarden	AzureSearch CosmosDBNoSqlVectorStore ManagedAzureSearch

IndexUpdate

Definitie van indexresource

Discriminator voor IndexUpdate

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
AzureSearch	AzureAISearchIndexUpdate
ManagedAzureSearch	ManagedAzureAISearchIndexUpdate
CosmosDBNoSqlVectorStore	CosmosDBIndexUpdate

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	IndexType		Yes

Inzicht

De antwoordbody voor clusterinzichten.

Name	Typ	Description	Required	Verstek
displayName	tekenreeks	Gebruiksvriendelijke weergavenaam voor het inzicht.	Yes
id	tekenreeks (alleen-lezen)	De unieke id voor het inzichtenrapport.	Yes
metadata	InsightsMetadata (alleen-lezen)	Metadata over de inzichten.	Yes
└} completedAt	tekenreeks	De tijdstempel waarop de inzichten zijn voltooid.	No
└* createdAt	tekenreeks	De tijdstempel waarop de inzichten zijn gemaakt.	Yes
request	InsightRequest	De aanvraag van het inzichtenrapport.	Yes
└type.	InsightType	Het type aanvraag.	Yes
result	InsightResult (alleen-lezen)	Het resultaat van de inzichten.	No
└type.	InsightType	Het type inzichtenresultaat.	Yes
state	Azure. Core.Foundations.OperationState (alleen-lezen)	Enum beschrijft de toegestane bewerkingstoestanden.	Yes

InsightCluster

Een cluster van analysemonsters.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Beschrijving van het analysecluster.	Yes
id	tekenreeks	De id van het analysecluster.	Yes
label	tekenreeks	Label voor het cluster	Yes
Monsters	matrix van InsightSample	Lijst met voorbeelden die deel uitmaken van dit cluster. Leeg als voorbeelden deel uitmaken van subclusters.	No
subclusters	matrix van InsightCluster	Lijst met subclusters binnen dit cluster. Leeg als er geen subclusters bestaan.	No
Suggestie	tekenreeks	Suggestie voor het cluster	Yes
suggestionTitle	tekenreeks	De titel van de suggestie voor het cluster	Yes
weight	integer	Het gewicht van het analysecluster. Dit geeft het aantal steekproeven in het cluster aan.	Yes

InsightModelConfiguration

Configuratie van het model dat wordt gebruikt bij het genereren van inzichten.

Name	Typ	Description	Required	Verstek
modelDeploymentName	tekenreeks	De te evalueren modelimplementatie. Accepteert alleen de implementatienaam of met de verbindingsnaam als {connectionName}/<modelDeploymentName>.	Yes

InsightRequest

De aanvraag van het inzichtenrapport.

Discriminator voor InsightRequest

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
EvaluationRunClusterInsight	EvaluationRunClusterInsightRequest
AgentClusterInsight	AgentClusterInsightRequest
EvaluationComparison	EvaluationComparisonInsightRequest

Name	Typ	Description	Required	Verstek
type	InsightType	Het verzoek van de inzichten.	Yes

InsightResult

Het resultaat van de inzichten.

Discriminator voor InsightResult

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
EvaluationComparison	EvaluationComparisonInsightResult
EvaluationRunClusterInsight	EvaluationRunClusterInsightResult
AgentClusterInsight	AgentClusterInsightResult

Name	Typ	Description	Required	Verstek
type	InsightType	Het verzoek van de inzichten.	Yes

InsightSample

Een voorbeeld uit de analyse.

Discriminator voor InsightSample

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
EvaluationResultSample	EvaluationResultSample

Name	Typ	Description	Required	Verstek
correlationInfo	object	Informatie over de correlatie voor het analysevoorbeeld.	Yes
features	object	Functies die u helpen bij het extra filteren van gegevens in UX.	Yes
id	tekenreeks	De unieke id voor het analysevoorbeeld.	Yes
type	SampleType	Het type monster dat in de analyse wordt gebruikt.	Yes

InsightScheduleTask

Inzichttaak voor het rooster.

Name	Typ	Description	Required	Verstek
configuration	object	Configuratie voor de taak.	No
Inzicht	Inzichten	De antwoordbody voor clusterinzichten.	Yes
└} displayName	tekenreeks	Gebruiksvriendelijke weergavenaam voor het inzicht.	Yes
└─ id	tekenreeks (alleen-lezen)	De unieke id voor het inzichtenrapport.	Yes
└* metagegevens	InsightsMetadata (alleen-lezen)	Metagegevens over het inzichtenrapport.	Yes
└* aanvraag	InsightRequest	Aanvraag voor de analyse van inzichten.	Yes
└* resultaat	InsightResult (alleen-lezen)	Het resultaat van het inzichtenrapport.	No
└state.	Azure. Core.Foundations.OperationState (alleen-lezen)	De huidige status van de inzichten.	Yes
type	enum	Mogelijke waarden: Insight	Yes

InsightSummary

Samenvatting van de analyse van het foutencluster.

Name	Typ	Description	Required	Verstek
method	tekenreeks	Methode die wordt gebruikt voor clustering.	Yes
sampleCount	integer	Totaal aantal geanalyseerde steekproeven.	Yes
uniqueClusterCount	integer	Totaal aantal unieke clusters.	Yes
uniqueSubclusterCount	integer	Totaal aantal unieke subclusterlabels.	Yes
usage	ClusterTokenUsage	Tokengebruik voor clusteranalyse	Yes
└* inputTokenUsage	integer	invoertokengebruik	Yes
└* outputTokenUsage	integer	gebruik van uitvoertoken	Yes
└* totalTokenUsage	integer	totaal tokengebruik	Yes

InsightType

Het verzoek van de inzichten.

Property	Value
Description	Het verzoek van de inzichten.
Type	tekenreeks
waarden	EvaluationRunClusterInsight AgentClusterInsight EvaluationComparison

InsightsMetadata

Metadata over de inzichten.

Name	Typ	Description	Required	Verstek
completedAt	tekenreeks	De tijdstempel waarop de inzichten zijn voltooid.	No
gemaaktOp	tekenreeks	De tijdstempel waarop de inzichten zijn gemaakt.	Yes

ItemGenerationParams

Vertegenwoordigt de set parameters die worden gebruikt voor het beheren van bewerkingen voor het genereren van items.

Discriminator voor ItemGenerationParams

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
red_team	RedTeamItemGenerationParams
red_team_seed_prompts	RedTeamSeedPromptsItemGenerationParams
red_team_taxonomy	RedTeamTaxonomyItemGenerationParams
response_retrieval	ResponseRetrievalItemGenerationParams

Name	Typ	Description	Required	Verstek
type	ItemGenerationParamsType	De typen parameters voor het genereren van rode teamitems.	Yes

ItemGenerationParamsType

De typen parameters voor het genereren van rode teamitems.

Property	Value
Description	De typen parameters voor het genereren van rode teamitems.
Type	tekenreeks
waarden	red_team response_retrieval red_team_seed_prompts red_team_taxonomy synthetic_data_gen_preview

ManagedAzureAISearchIndex

Definitie van beheerde Azure AI Zoeken-index

Name	Typ	Description	Required	Verstek
id	tekenreeks (alleen-lezen)	Item-ID, een unieke ID voor het item	No
naam	tekenreeks (alleen-lezen)	De naam van de resource	Yes
type	enum	Type index Mogelijke waarden: ManagedAzureSearch	Yes
version	tekenreeks (alleen-lezen)	De versie van de bron	Yes

ManagedAzureAISearchIndexUpdate

Definitie van beheerde Azure AI Zoeken-index

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	De tekst van de assetbeschrijving.	No
tags	object	Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.	No
type	enum	Type index Mogelijke waarden: ManagedAzureSearch	Yes

MemoryItem

Een enkel geheugenitem dat is opgeslagen in het geheugenarchief en dat inhoud en metadata bevat.

Discriminator voor MemoryItem

Dit onderdeel maakt gebruik van de eigenschap kind om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
user_profile	UserProfileMemoryItem
chat_summary	ChatSummaryMemoryItem

Name	Typ	Description	Required	Verstek
inhoud	tekenreeks	De inhoud van het geheugen.	Yes
vriendelijk	MemoryItemKind	Soort geheugenitem.	Yes
memory_id	tekenreeks	De unieke ID van het geheugenitem.	Yes
scope	tekenreeks	De naamruimte die herinneringen logisch groepeert en isoleert, zoals een gebruikers-ID.	Yes
updated_at	integer	De laatste updatetijd van het geheugenitem.	Yes

MemoryItemKind

Soort geheugenitem.

Property	Value
Description	Soort geheugenitem.
Type	tekenreeks
waarden	user_profile chat_summary

MemoryOperation

Vertegenwoordigt een enkele geheugenbewerking (maken, bijwerken of verwijderen) die wordt uitgevoerd op een geheugenitem.

Name	Typ	Description	Required	Verstek
vriendelijk	MemoryOperationKind	Soort geheugenwerking.	Yes
memory_item	MemoryItem	Een enkel geheugenitem dat is opgeslagen in het geheugenarchief en dat inhoud en metadata bevat.	Yes
└* inhoud	tekenreeks	De inhoud van het geheugen.	Yes
└.	MemoryItemKind	Het type geheugenitem.	Yes
└memory_id	tekenreeks	De unieke ID van het geheugenitem.	Yes
└* bereik	tekenreeks	De naamruimte die herinneringen logisch groepeert en isoleert, zoals een gebruikers-ID.	Yes
└updated_at	integer	De laatste updatetijd van het geheugenitem.	Yes

MemoryOperationKind

Soort geheugenwerking.

Property	Value
Description	Soort geheugenwerking.
Type	tekenreeks
waarden	create update delete

MemorySearchItem

Een opgehaald geheugenitem uit het geheugen zoeken.

Name	Typ	Description	Required	Verstek
memory_item	MemoryItem	Een enkel geheugenitem dat is opgeslagen in het geheugenarchief en dat inhoud en metadata bevat.	Yes
└* inhoud	tekenreeks	De inhoud van het geheugen.	Yes
└.	MemoryItemKind	Het type geheugenitem.	Yes
└memory_id	tekenreeks	De unieke ID van het geheugenitem.	Yes
└* bereik	tekenreeks	De naamruimte die herinneringen logisch groepeert en isoleert, zoals een gebruikers-ID.	Yes
└updated_at	integer	De laatste updatetijd van het geheugenitem.	Yes

MemorySearchOptions

Zoekopties voor geheugen.

Name	Typ	Description	Required	Verstek
max_memories	integer	Maximum aantal geheugenitems dat moet worden geretourneerd.	No

MemorySearchPreviewTool

Een hulpmiddel om herinneringen in de agent te integreren.

Name	Typ	Description	Required	Verstek
memory_store_name	tekenreeks	De naam van de geheugenopslag die u wilt gebruiken.	Yes
scope	tekenreeks	De naamruimte die wordt gebruikt om geheugens te groeperen en te isoleren, zoals een gebruikers-id. Beperkt welke herinneringen kunnen worden opgehaald of bijgewerkt. Gebruik een speciale variabele {{$userId}} om het bereik van geheugens te bepalen voor de huidige aangemelde gebruiker.	Yes
search_options	MemorySearchOptions	Zoekopties voor geheugen.	No
└max_memories	integer	Maximum aantal geheugenitems dat moet worden geretourneerd.	No
type	enum	Het type hulpprogramma. Altijd memory_search_preview. Mogelijke waarden: memory_search_preview	Yes
update_delay	integer	Tijd om te wachten met het bijwerken van herinneringen na inactiviteit (seconden). Standaard 300.	No	300

MemorySearchToolCallItemParam

Name	Typ	Description	Required	Verstek
results	matrix van MemorySearchItem	De resultaten die zijn geretourneerd door de geheugenzoekopdracht.	No
type	enum	Mogelijke waarden: memory_search_call	Yes

MemorySearchToolCallItemResource

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
results	matrix van MemorySearchItem	De resultaten die zijn geretourneerd door de geheugenzoekopdracht.	No
status	enum	De status van de aanroep van het hulpprogramma voor geheugenzoekopdrachten. Eén van in_progress, searching, of completedincompletefailed, Mogelijke waarden: in_progress, searching, completed, , incompletefailed	Yes
type	enum	Mogelijke waarden: memory_search_call	Yes

MemoryStoreDefaultDefinition

Implementatie van standaardgeheugenopslag.

Name	Typ	Description	Required	Verstek
chat_model	tekenreeks	De naam of id van de implementatie van het chatvoltooiingsmodel die wordt gebruikt voor geheugenverwerking.	Yes
embedding_model	tekenreeks	De naam of id van de insluitmodelimplementatie die wordt gebruikt voor geheugenverwerking.	Yes
vriendelijk	enum	Het soort geheugenopslag. Mogelijke waarden: default	Yes
options	MemoryStoreDefaultOptions	Standaard configuraties voor geheugenopslag.	No
└chat_summary_enabled	boolean	Of chatsamenvatting en storage moeten worden ingeschakeld. De standaardwaarde is waar.	Yes	True
└user_profile_details	tekenreeks	Specifieke categorieën of soorten gebruikersprofielinformatie om te extraheren en op te slaan.	No
└user_profile_enabled	boolean	Of u gebruikersprofielextractie en storage wilt inschakelen. De standaardwaarde is waar.	Yes	True

MemoryStoreDefaultOptions

Standaard configuraties voor geheugenopslag.

Name	Typ	Description	Required	Verstek
chat_summary_enabled	boolean	Of chatsamenvatting en storage moeten worden ingeschakeld. De standaardwaarde is waar.	Yes	True
user_profile_details	tekenreeks	Specifieke categorieën of soorten gebruikersprofielinformatie om te extraheren en op te slaan.	No
user_profile_enabled	boolean	Of u gebruikersprofielextractie en storage wilt inschakelen. De standaardwaarde is waar.	Yes	True

MemoryStoreDefinition

Basisdefinitie voor configuraties van geheugenopslag.

Discriminator voor MemoryStoreDefinition

Dit onderdeel maakt gebruik van de eigenschap kind om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
default	MemoryStoreDefaultDefinition

Name	Typ	Description	Required	Verstek
vriendelijk	MemoryStoreKind	Het type implementatie van de geheugenopslag dat moet worden gebruikt.	Yes

MemoryStoreDeleteScopeResponse

Antwoord voor het verwijderen van herinneringen uit een scope.

Name	Typ	Description	Required	Verstek
verwijderd	boolean	Of de verwijderingsbewerking is geslaagd.	Yes
naam	tekenreeks	De naam van het geheugenarchief.	Yes
object	enum	Het objecttype. Altijd 'memory_store.scope.deleted'. Mogelijke waarden: memory_store.scope.deleted	Yes
scope	tekenreeks	Het bereik waaruit geheugens zijn verwijderd.	Yes

MemoryStoreKind

Het type implementatie van de geheugenopslag dat moet worden gebruikt.

Property	Value
Description	Het type implementatie van de geheugenopslag dat moet worden gebruikt.
Type	tekenreeks
waarden	default

MemoryStoreObject

Een geheugenarchief dat gebruikersgeheugens kan opslaan en ophalen.

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	De Unix-tijdstempel (seconden) toen het geheugenarchief werd gemaakt.	Yes
definitie	MemoryStoreDefinition	Basisdefinitie voor configuraties van geheugenopslag.	Yes
└.	MemoryStoreKind	Het soort geheugenopslag.	Yes
beschrijving	tekenreeks	Een door mensen leesbare beschrijving van het geheugenarchief. Beperkingen: maxLength: 512	No
id	tekenreeks	De unieke id van het geheugenarchief.	Yes
metadata	object	Willekeurige sleutelwaardemetagegevens die moeten worden gekoppeld aan het geheugenarchief.	No
naam	tekenreeks	De naam van het geheugenarchief. Beperkingen: maxLength: 256	Yes
object	enum	Het objecttype, dat altijd 'memory_store' is. Mogelijke waarden: memory_store	Yes
updated_at	integer	De Unix-tijdstempel (seconden) toen het geheugenarchief voor het laatst is bijgewerkt.	Yes

MemoryStoreOperationUsage

Gebruiksstatistieken van een geheugenopslagbewerking.

Name	Typ	Description	Required	Verstek
embedding_tokens	integer	Het aantal insluittokens.	Yes
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└ cached_tokens	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ redeneertokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

MemoryStoreSearchResponse

Antwoord op geheugenzoekopdrachten.

Name	Typ	Description	Required	Verstek
Herinneringen	matrix van MemorySearchItem	Gerelateerde geheugenitems gevonden tijdens de zoekbewerking.	Yes
search_id	tekenreeks	De unieke id van deze zoekaanvraag. Gebruik deze waarde als previous_search_id in volgende aanvragen om incrementele zoekopdrachten uit te voeren.	Yes
usage	MemoryStoreOperationUsage	Gebruiksstatistieken van een geheugenopslagbewerking.	Yes
└embedding_tokens	integer	Het aantal insluittokens.	Yes
└input_tokens	OpenAI.integer	Het aantal invoertokens.	Yes
└─input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Een gedetailleerde uitsplitsing van de invoertokens.	Yes
└output_tokens	OpenAI.integer	Het aantal uitvoertokens.	Yes
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Een gedetailleerde uitsplitsing van de uitvoertokens.	Yes
└ totaal tokens	OpenAI.integer	Het totale aantal gebruikte tokens.	Yes

MemoryStoreUpdateCompletedResult

Resultaat geheugenupdate.

Name	Typ	Description	Required	Verstek
memory_operations	matrix van MemoryOperation	Een lijst met afzonderlijke geheugenbewerkingen die zijn uitgevoerd tijdens de update.	Yes
usage	MemoryStoreOperationUsage	Gebruiksstatistieken van een geheugenopslagbewerking.	Yes
└embedding_tokens	integer	Het aantal insluittokens.	Yes
└input_tokens	OpenAI.integer	Het aantal invoertokens.	Yes
└─input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Een gedetailleerde uitsplitsing van de invoertokens.	Yes
└output_tokens	OpenAI.integer	Het aantal uitvoertokens.	Yes
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Een gedetailleerde uitsplitsing van de uitvoertokens.	Yes
└ totaal tokens	OpenAI.integer	Het totale aantal gebruikte tokens.	Yes

MemoryStoreUpdateResponse

Geeft de status weer van een updatebewerking voor het geheugenarchief.

Name	Typ	Description	Required	Verstek
fout	OpenAI.Error		No
└* additionalInfo	object		No
└─ code	tekenreeks (nullable)		Yes
└* foutopsporingInfo	object		No
└─ details weergeven	matrix van OpenAI.Error		No
└• bericht	tekenreeks		Yes
└─ Param	tekenreeks (nullable)		No
└type.	tekenreeks		No
result	MemoryStoreUpdateCompletedResult	Resultaat geheugenupdate.	No
└memory_operations	matrix van MemoryOperation	Een lijst met afzonderlijke geheugenbewerkingen die zijn uitgevoerd tijdens de update.	Yes
└─ gebruik	MemoryStoreOperationUsage	Gebruiksstatistieken die zijn gekoppeld aan de geheugenupdatebewerking.	Yes
status	MemoryStoreUpdateStatus	Status van een updatebewerking van het geheugen.	Yes
superseded_by	tekenreeks	De update_id de bewerking is vervangen door wanneer de status 'vervangen' is.	No
update_id	tekenreeks	De unieke id van deze updateaanvraag. Gebruik deze waarde als previous_update_id in volgende aanvragen om incrementele updates uit te voeren.	Yes

MemoryStoreUpdateStatus

Status van een updatebewerking van het geheugen.

Property	Value
Type	tekenreeks
waarden	queued in_progress completed failed superseded

MicrosoftFabricPreviewTool

De inputdefinitie-informatie voor een Microsoft Fabric-tool zoals gebruikt om een agent te configureren.

Name	Typ	Description	Required	Verstek
fabric_dataagent_preview	FabricDataAgentToolParameters	De parameters van de fabric data agent.	Yes
└project_connections	matrix van ToolProjectConnection	De project verbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma. Beperkingen: maxItems: 1	No
type	enum	Het objecttype, dat altijd 'fabric_dataagent_preview' is. Mogelijke waarden: fabric_dataagent_preview	Yes

ModelDeployment

Definitie van modelimplementatie

Name	Typ	Description	Required	Verstek
capabilities	object (alleen-lezen)	Mogelijkheden van geïmplementeerd model	Yes
connectionName	tekenreeks (alleen-lezen)	Naam van de verbinding waarvan de implementatie afkomstig is	No
modelName	tekenreeks (alleen-lezen)	Publisher-specifieke naam van het geïmplementeerde model	Yes
modelPublisher	tekenreeks (alleen-lezen)	Naam van de uitgever van het geïmplementeerde model	Yes
modelversie	tekenreeks (alleen-lezen)	Publisher specifieke versie van het geïmplementeerde model	Yes
naam	tekenreeks (alleen-lezen)	Naam van de implementatie	Yes
sku	SKU (alleen-lezen)	SKU-informatie	Yes
└capaciteit.	integer	SKU-capaciteit	Yes
└* familie	tekenreeks	SKU-familie	Yes
└─naam	tekenreeks	SKU-naam	Yes
└* grootte	tekenreeks	SKU-grootte	Yes
└tier.	tekenreeks	SKU-laag	Yes
type	enum	Het type implementatie Mogelijke waarden: ModelDeployment	Yes

ModelSamplingParams

Vertegenwoordigt een set parameters die worden gebruikt voor het bepalen van het steekproefgedrag van een taalmodel tijdens het genereren van tekst.

Name	Typ	Description	Required	Verstek
max_completion_tokens	integer	Het maximum aantal tokens dat is toegestaan in de voltooiing.	Yes
seed	integer	Het willekeurige zaad voor reproduceerbaarheid.	Yes
Temperatuur	number	De temperatuurparameter voor steekproeven.	Yes
top_p	number	De top-p-parameter voor kernsampling.	Yes

ModelSamplingParamsUpdate

Vertegenwoordigt een set parameters die worden gebruikt voor het bepalen van het steekproefgedrag van een taalmodel tijdens het genereren van tekst.

Name	Typ	Description	Required	Verstek
max_completion_tokens	integer	Het maximum aantal tokens dat is toegestaan in de voltooiing.	No
seed	integer	Het willekeurige zaad voor reproduceerbaarheid.	No
Temperatuur	number	De temperatuurparameter voor steekproeven.	No
top_p	number	De top-p-parameter voor kernsampling.	No

MonthlyRecurrenceSchedule

Maandelijks herhalingsschema.

Name	Typ	Description	Required	Verstek
daysOfMonth	matrix van geheel getal	Dagen van de maand voor het terugkeerschema.	Yes
type	enum	Maandelijks terugkeerpatroon. Mogelijke waarden: Monthly	Yes

NoAuthenticationCredentials

Referenties waarvoor geen verificatie is vereist

Name	Typ	Description	Required	Verstek
type	enum	Het referentietype Mogelijke waarden: None	Yes

OAuthConsentRequestOutputItem

Verzoek van de service voor de gebruiker om OAuth-toestemming uit te voeren.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
consent_link	tekenreeks	De koppeling die de gebruiker kan gebruiken om OAuth-toestemming uit te voeren.	Yes
id	tekenreeks		Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
server_label	tekenreeks	Het serverlabel voor de OAuth-toestemmingsaanvraag.	Yes
type	enum	Mogelijke waarden: oauth_consent_request	Yes

OneTimeTrigger

Eenmalige trigger.

Name	Typ	Description	Required	Verstek
timeZone	tekenreeks	Tijdzone voor de eenmalige trigger.	No	UTC
triggerAt	tekenreeks	Datum en tijd voor de eenmalige trigger in ISO 8601-indeling.	Yes
type	enum	Mogelijke waarden: OneTime	Yes

OpenAI.Annotation

Een aantekening die van toepassing is op een reeks uitvoerteksten.

Discriminateur voor OpenAI.Annotatie

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
file_citation	OpenAI.FileCitationBody
url_citation	OpenAI.UrlCitationBody
container_file_citation	OpenAI.ContainerFileCitationBody
file_path	OpenAI.FilePath

Name	Typ	Description	Required	Verstek
type	OpenAI.AnnotationType		Yes

OpenAI.AnnotationType

Property	Value
Type	tekenreeks
waarden	file_citation url_citation container_file_citation file_path

OpenAI.ApplyPatchCallOutputStatus

Property	Value
Type	tekenreeks
waarden	completed failed

OpenAI.ApplyPatchCallOutputStatusParam

Resultaatwaarden gerapporteerd voor uitvoer van apply_patch hulpprogramma-aanroep.

Property	Value
Type	tekenreeks
waarden	completed failed

OpenAI.ApplyPatchCallStatus

Property	Value
Type	tekenreeks
waarden	in_progress completed

OpenAI.ApplyPatchCallStatusParam

Statuswaarden gerapporteerd voor apply_patch hulpprogramma-aanroepen.

Property	Value
Type	tekenreeks
waarden	in_progress completed

OpenAI.ApplyPatchCreateFileOperation

Instructies voor het maken van een bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Diff om toe te passen.	Yes
path	tekenreeks	Pad van het te maken bestand.	Yes
type	enum	Maak een nieuw bestand met de opgegeven diff. Mogelijke waarden: create_file	Yes

OpenAI.ApplyPatchCreateFileOperationParam

Instructies voor het maken van een nieuw bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Uniforme diff-inhoud die moet worden toegepast bij het maken van het bestand. Beperkingen: maxLength: 10485760	Yes
path	tekenreeks	Pad van het bestand dat moet worden gemaakt ten opzichte van de hoofdmap van de werkruimte. Beperkingen: minLength: 1	Yes
type	enum	Het bewerkingstype. Altijd create_file. Mogelijke waarden: create_file	Yes

OpenAI.ApplyPatchDeleteFileOperation

Instructies voor het verwijderen van een bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
path	tekenreeks	Pad van het bestand dat u wilt verwijderen.	Yes
type	enum	Verwijder het opgegeven bestand. Mogelijke waarden: delete_file	Yes

OpenAI.ApplyPatchDeleteFileOperationParam

Instructie voor het verwijderen van een bestaand bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
path	tekenreeks	Pad van het bestand dat moet worden verwijderd ten opzichte van de hoofdmap van de werkruimte. Beperkingen: minLength: 1	Yes
type	enum	Het bewerkingstype. Altijd delete_file. Mogelijke waarden: delete_file	Yes

OpenAI.ApplyPatchFileOperation

Een van de create_file-, delete_file- of update_file bewerkingen die worden toegepast via apply_patch.

Discriminator voor OpenAI.ApplyPatchFileOperation

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
create_file	OpenAI.ApplyPatchCreateFileOperation
delete_file	OpenAI.ApplyPatchDeleteFileOperation
update_file	OpenAI.ApplyPatchUpdateFileOperation

Name	Typ	Description	Required	Verstek
type	OpenAI.ApplyPatchFileOperationType		Yes

OpenAI.ApplyPatchFileOperationType

Property	Value
Type	tekenreeks
waarden	create_file delete_file update_file

OpenAI.ApplyPatchOperationParam

Een van de create_file-, delete_file- of update_file bewerkingen die aan het hulpprogramma apply_patch worden geleverd.

Discriminator voor OpenAI.ApplyPatchOperationParam

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
create_file	OpenAI.ApplyPatchCreateFileOperationParam
delete_file	OpenAI.ApplyPatchDeleteFileOperationParam
update_file	OpenAI.ApplyPatchUpdateFileOperationParam

Name	Typ	Description	Required	Verstek
type	OpenAI.ApplyPatchOperationParamType		Yes

OpenAI.ApplyPatchOperationParamType

Property	Value
Type	tekenreeks
waarden	create_file delete_file update_file

OpenAI.ApplyPatchToolParam

Stelt de assistent in staat om bestanden aan te maken, verwijderen of bijwerken met behulp van unified diffs.

Name	Typ	Description	Required	Verstek
type	enum	Het type hulpprogramma. Altijd apply_patch. Mogelijke waarden: apply_patch	Yes

OpenAI.ApplyPatchUpdateFileOperation

Instructies voor het bijwerken van een bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Diff om toe te passen.	Yes
path	tekenreeks	Pad van het bestand dat moet worden bijgewerkt.	Yes
type	enum	Werk een bestaand bestand bij met de opgegeven diff. Mogelijke waarden: update_file	Yes

OpenAI.ApplyPatchUpdateFileOperationParam

Instructies voor het bijwerken van een bestaand bestand via het hulpprogramma apply_patch.

Name	Typ	Description	Required	Verstek
Diff	tekenreeks	Geïntegreerde diff-inhoud die moet worden toegepast op het bestaande bestand. Beperkingen: maxLength: 10485760	Yes
path	tekenreeks	Pad van het bestand dat moet worden bijgewerkt ten opzichte van de hoofdmap van de werkruimte. Beperkingen: minLength: 1	Yes
type	enum	Het bewerkingstype. Altijd update_file. Mogelijke waarden: update_file	Yes

OpenAI.ApproximateLocation

Name	Typ	Description	Required	Verstek
city	tekenreeks (nullable)		No
country	tekenreeks (nullable)		No
region	tekenreeks (nullable)		No
timezone	tekenreeks (nullable)		No
type	enum	Het type locatie-benadering. Altijd approximate. Mogelijke waarden: approximate	Yes

OpenAI.ChatCompletionTool

Een functiehulpprogramma dat kan worden gebruikt om een antwoord te genereren.

Name	Typ	Description	Required	Verstek
function	OpenAI.FunctionObject		Yes
type	enum	Het type hulpprogramma. Op dit moment wordt alleen function ondersteund. Mogelijke waarden: function	Yes

OpenAI.ChatModel

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

OpenAI.ClickButtonType

Property	Value
Type	tekenreeks
waarden	left right wheel back forward

OpenAI.ClickParam

Een klikactie.

Name	Typ	Description	Required	Verstek
knop	OpenAI.ClickButtonType		Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een klikactie is deze eigenschap altijd click. Mogelijke waarden: click	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.CodeInterpreterContainerAuto

Configuratie voor een code-interpretercontainer. Geef desgewenst de id's van de bestanden op waarop de code moet worden uitgevoerd.

Name	Typ	Description	Required	Verstek
file_ids	array van tekenreeksen	Een optionele lijst met geüploade bestanden om beschikbaar te maken voor uw code.	No
geheugenlimiet	OpenAI.ContainerMemoryLimit (nul)		No
type	enum	Altijd auto. Mogelijke waarden: auto	Yes

OpenAI.CodeInterpreterOutputImage

De beelduitvoer van de code-interpreter.

Name	Typ	Description	Required	Verstek
type	enum	Het type uitvoer. Altijd image. Mogelijke waarden: image	Yes
URL	tekenreeks	De URL van de beelduitvoer van de code-interpreter.	Yes

OpenAI.CodeInterpreterOutputLogs

De logboekuitvoer van de code-interpreter.

Name	Typ	Description	Required	Verstek
logs	tekenreeks	De logboekuitvoer van de code-interpreter.	Yes
type	enum	Het type uitvoer. Altijd logs. Mogelijke waarden: logs	Yes

OpenAI.CodeInterpreterTool

Een hulpprogramma waarmee Python-code wordt uitgevoerd om een reactie op een prompt te genereren.

Name	Typ	Description	Required	Verstek
container	tekenreeks of OpenAI.CodeInterpreterContainerAuto	De container voor code-interpreters. Kan een container-id of een object zijn dat geeft geüploade bestands-id's op die beschikbaar moeten worden gesteld aan uw code, samen met een optionele memory_limit instelling. Als deze niet is opgegeven, gaat de service ervan uit dat deze automatisch wordt gebruikt.	No
type	enum	Het type code interpreter-programma. Altijd code_interpreter. Mogelijke waarden: code_interpreter	Yes

OpenAI.CompactResource

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	Unix-tijdstempel (in seconden) toen het gecomprimeerde gesprek werd gemaakt.	Yes
id	tekenreeks	De unieke id voor het gecomprimeerde antwoord.	Yes
object	enum	Het objecttype. Altijd response.compaction. Mogelijke waarden: response.compaction	Yes
output	matrix van OpenAI.OutputItem	De gecomprimeerde lijst met uitvoeritems. Dit is een lijst met alle gebruikersberichten, gevolgd door één compressie-item.	Yes
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	Yes
└input_tokens	OpenAI.integer	Het aantal invoertokens.	Yes
└─input_tokens_details	OpenAI.ResponseUsageInputTokensDetails	Een gedetailleerde uitsplitsing van de invoertokens.	Yes
└output_tokens	OpenAI.integer	Het aantal uitvoertokens.	Yes
└output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails	Een gedetailleerde uitsplitsing van de uitvoertokens.	Yes
└ totaal tokens	OpenAI.integer	Het totale aantal gebruikte tokens.	Yes

OpenAI.CompactResponseMethodPublicBody

Name	Typ	Description	Required	Verstek
input	tekenreeks of matrix van OpenAI.InputItem		No
aanwijzingen	tekenreeks (nullable)		No
model	OpenAI.ModelIdsCompaction	Model-id die wordt gebruikt voor het genereren van het antwoord, zoals gpt-5 of o3. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestatiekenmerken en prijspunten. Raadpleeg de modelhandleiding om door beschikbare modellen te bladeren en te vergelijken.	Yes
previous_response_id	tekenreeks (nullable)		No

OpenAI.ComparisonFilter

Een filter dat wordt gebruikt om een opgegeven kenmerksleutel te vergelijken met een bepaalde waarde met behulp van een gedefinieerde vergelijkingsbewerking.

Name	Typ	Description	Required	Verstek
sleutel	tekenreeks	De sleutel die moet worden vergeleken met de waarde.	Yes
type	enum	Specificeert de vergelijkingsoperator: eq, , , ne, gt, gte, ltlte, , innin. - eq: is gelijk aan - ne: niet gelijk aan - gt: groter dan - gte: groter dan of gelijk aan - lt: kleiner dan - lte: kleiner dan of gelijk aan - in:Inch - nin: niet in Mogelijke waarden: eq, ne, gt, gte, , ltlte	Yes
value	tekenreeks of OpenAI.numeriek of booleaanse waarde of matrix van OpenAI.ComparisonFilterValueItems	De waarde die moet worden vergeleken met de kenmerksleutel; ondersteunt tekenreeks-, getal- of booleaanse typen.	Yes

OpenAI.ComparisonFilterValueItems

Type: tekenreeks of OpenAI.numeriek

OpenAI.CompoundFilter

Meerdere filters combineren met and of or.

Name	Typ	Description	Required	Verstek
filters	matrix van OpenAI.ComparisonFilter of object	Matrix van filters die moeten worden gecombineerd. Items kunnen ComparisonFilter of CompoundFilter.	Yes
type	enum	Type van bewerking: and of or. Mogelijke waarden: and, or	Yes

OpenAI.ComputerAction

Discriminator voor OpenAI.ComputerAction

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
click	OpenAI.ClickParam
double_click	OpenAI.DoubleClickAction
drag	OpenAI.Drag
keypress	OpenAI.KeyPressAction
move	OpenAI.Move
screenshot	OpenAI.Screenshot
scroll	OpenAI.Scroll
type	OpenAI.Type
wait	OpenAI.Wait

Name	Typ	Description	Required	Verstek
type	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionType

Property	Value
Type	tekenreeks
waarden	click double_click drag keypress move screenshot scroll type wait

OpenAI.ComputerCallSafetyCheckParam

Een veiligheidscontrole in behandeling voor de computeroproep.

Name	Typ	Description	Required	Verstek
code	tekenreeks (nullable)		No
id	tekenreeks	De ID van de lopende veiligheidscontrole.	Yes
message	tekenreeks (nullable)		No

OpenAI.ComputerEnvironment

Property	Value
Type	tekenreeks
waarden	windows mac linux ubuntu browser

OpenAI.ComputerScreenshotContent

Een schermopname van een computer.

Name	Typ	Description	Required	Verstek
file_id	tekenreeks (nullable)		Yes
image_url	tekenreeks		Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een schermafbeelding van een computer is deze eigenschap altijd ingesteld op computer_screenshot. Mogelijke waarden: computer_screenshot	Yes

OpenAI.ComputerScreenshotImage

Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.

Name	Typ	Description	Required	Verstek
file_id	tekenreeks	De id van een geüpload bestand dat de schermopname bevat.	No
image_url	tekenreeks	De URL van de schermopname.	No
type	enum	Hiermee geeft u het gebeurtenistype. Voor een schermafbeelding van een computer is deze eigenschap altijd ingesteld op computer_screenshot. Mogelijke waarden: computer_screenshot	Yes

OpenAI.ComputerUsePreviewTool

Een hulpprogramma waarmee een virtuele computer wordt bestuurd.

Name	Typ	Description	Required	Verstek
schermhoogte	OpenAI.integer		Yes
weergavebreedte	OpenAI.integer		Yes
environment	OpenAI.ComputerEnvironment		Yes
type	enum	Het type hulpprogramma voor computergebruik. Altijd computer_use_preview. Mogelijke waarden: computer_use_preview	Yes

OpenAI.ContainerFileCitationBody

Een citatie voor een containerbestand dat wordt gebruikt om een modelantwoord te genereren.

Name	Typ	Description	Required	Verstek
container_id	tekenreeks	De ID van het containerbestand.	Yes
end_index	OpenAI.integer		Yes
file_id	tekenreeks	De id van het bestand.	Yes
filename	tekenreeks	De bestandsnaam van het genoemde containerbestand.	Yes
start_index	OpenAI.integer		Yes
type	enum	Het type containerbestand, citaat. Altijd container_file_citation. Mogelijke waarden: container_file_citation	Yes

OpenAI.ContainerMemoryLimit

Property	Value
Type	tekenreeks
waarden	1g 4g 16g 64g

OpenAI.ConversationItem

Eén item in een gesprek. De set mogelijke typen is hetzelfde als het output type antwoordobject.

Discriminator voor OpenAI.ConversationItem

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
message	OpenAI.ConversationItemMessage
function_call	OpenAI.ConversationItemFunctionToolCallResource
function_call_output	OpenAI.ConversationItemFunctionToolCallOutputResource
file_search_call	OpenAI.ConversationItemFileSearchToolCall
web_search_call	OpenAI.ConversationItemWebSearchToolCall
image_generation_call	OpenAI.ConversationItemImageGenToolCall
computer_call	OpenAI.ConversationItemComputerToolCall
computer_call_output	OpenAI.ConversationItemComputerToolCallOutputResource
reasoning	OpenAI.ConversationItemReasoningItem
code_interpreter_call	OpenAI.ConversationItemCodeInterpreterToolCall
local_shell_call	OpenAI.ConversationItemLocalShellToolCall
local_shell_call_output	OpenAI.ConversationItemLocalShellToolCallOutput
shell_call	OpenAI.ConversationItemFunctionShellCall
shell_call_output	OpenAI.ConversationItemFunctionShellCallOutput
apply_patch_call	OpenAI.ConversationItemApplyPatchToolCall
apply_patch_call_output	OpenAI.ConversationItemApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ConversationItemMcpListTools
mcp_approval_request	OpenAI.ConversationItemMcpApprovalRequest
mcp_approval_response	OpenAI.ConversationItemMcpApprovalResponseResource
mcp_call	OpenAI.ConversationItemMcpToolCall
custom_tool_call	OpenAI.ConversationItemCustomToolCall
custom_tool_call_output	OpenAI.ConversationItemCustomToolCallOutput

Name	Typ	Description	Required	Verstek
type	OpenAI.ConversationItemType		Yes

OpenAI.ConversationItemApplyPatchToolCall

Een aanroep van een hulpprogramma waarmee bestandsverschil wordt toegepast door bestanden te maken, te verwijderen of bij te werken.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep patchtool toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
operatie	OpenAI.ApplyPatchFileOperation	Een van de create_file-, delete_file- of update_file bewerkingen die worden toegepast via apply_patch.	Yes
└type.	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Het type item. Altijd apply_patch_call. Mogelijke waarden: apply_patch_call	Yes

OpenAI.ConversationItemApplyPatchToolCallOutput

De uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die dit hulpprogramma heeft gemaakt, roept uitvoer aan.	No
id	tekenreeks	De unieke id van de uitvoer van de patchtool-aanroep toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
output	tekenreeks (nullable)		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Het type item. Altijd apply_patch_call_output. Mogelijke waarden: apply_patch_call_output	Yes

OpenAI.ConversationItemCodeInterpreterToolCall

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
code	tekenreeks (nullable)		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage		Yes
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijnin_progress, , , completeden incompleteinterpretingfailed. Mogelijke waarden: in_progress, completed, incomplete, , interpretingfailed	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd code_interpreter_call. Mogelijke waarden: code_interpreter_call	Yes

OpenAI.ConversationItemComputerToolCall

Een oproep aan een computergebruikshulpmiddel. Zie de computergids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		Yes
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren veiligheidscontroles voor de computeroproep.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type computeroproep. Altijd computer_call. Mogelijke waarden: computer_call	Yes

OpenAI.ConversationItemComputerToolCallOutputResource

Name	Typ	Description	Required	Verstek
acknowledged_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Yes
id	tekenreeks	De id van de uitvoer van de computertooloproep.	No
output	OpenAI.ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Yes
status	enum	De status van de berichtinvoer. Een van in_progress, completedof incomplete. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type aanroepuitvoer van het computerhulpprogramma. Altijd computer_call_output. Mogelijke waarden: computer_call_output	Yes

OpenAI.ConversationItemCustomToolCall

Een aanroep naar een aangepaste tool die door het model is gemaakt.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	Een identifier die wordt gebruikt om deze aangepaste tooloproep te koppelen aan een toolcall-uitvoer.	Yes
id	tekenreeks	De unieke ID van de custom tool-aanroep in het OpenAI-platform.	No
input	tekenreeks	De invoer voor de custom tool-aanroep die door het model wordt gegenereerd.	Yes
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat wordt aangeroepen.	Yes
type	enum	Het type custom tool-oproep. Altijd custom_tool_call. Mogelijke waarden: custom_tool_call	Yes

OpenAI.ConversationItemCustomToolCallOutput

De output van een aangepaste tool-aanroep vanuit je code, die wordt teruggestuurd naar het model.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De call ID, gebruikt om deze custom tool-call output te koppelen aan een custom tool call.	Yes
id	tekenreeks	De unieke ID van de aangepaste toolcall levert uit in het OpenAI-platform.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De output van de custom tool-aanroep die door je code wordt gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
type	enum	Het type output van de custom tool-oproep. Altijd custom_tool_call_output. Mogelijke waarden: custom_tool_call_output	Yes

OpenAI.ConversationItemFileSearchToolCall

De resultaten van een aanroep van een zoekprogramma voor bestanden. Zie de zoekgids bestand voor meer informatie.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	matrix van OpenAI.FileSearchToolCallResults		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van in_progress, searching, incomplete of failed Mogelijke waarden: in_progress, searching, completed, , incompletefailed	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd file_search_call. Mogelijke waarden: file_search_call	Yes

OpenAI.ConversationItemFunctionShellCall

Een hulpprogramma-aanroep waarmee een of meer shell-opdrachten in een beheerde omgeving worden uitgevoerd.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellAction	Voer een shell-opdracht uit.	Yes
└opdrachten.	array van tekenreeksen		Yes
└max_output_length	OpenAI.integer (nullbaar)		Yes
└timeout_ms	OpenAI.integer (nullbaar)		Yes
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep van het shell-hulpprogramma. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
type	enum	Het type item. Altijd shell_call. Mogelijke waarden: shell_call	Yes

OpenAI.ConversationItemFunctionShellCallOutput

De uitvoer van een shell-hulpprogramma-aanroep die is verzonden.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke id van de uitvoer van de shell-aanroep. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
max_output_length	OpenAI.integer (nullbaar)		Yes
output	matrix van OpenAI.FunctionShellCallOutputContent	Een matrix met uitvoerinhoud van shell-aanroep	Yes
type	enum	Het type uitvoer van de shell-aanroep. Altijd shell_call_output. Mogelijke waarden: shell_call_output	Yes

OpenAI.ConversationItemFunctionToolCallOutputResource

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de uitvoer van het functiehulpmiddel. Ingevuld wanneer dit item wordt geretourneerd via API.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De uitvoer van de functie-aanroep die door uw code is gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type uitvoer van het functiehulpmiddel. Altijd function_call_output. Mogelijke waarden: function_call_output	Yes

OpenAI.ConversationItemFunctionToolCallResource

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks	De unieke id van de aanroep van het functiehulpmiddel.	No
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd function_call. Mogelijke waarden: function_call	Yes

OpenAI.ConversationItemImageGenToolCall

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
result	tekenreeks (nullable)		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: in_progress, completed, , generatingfailed	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd image_generation_call. Mogelijke waarden: image_generation_call	Yes

OpenAI.ConversationItemList

Een lijst met gespreksitems.

Name	Typ	Description	Required	Verstek
data	matrix van OpenAI.ConversationItem	Een lijst met gespreksitems.	Yes
first_id	tekenreeks	De ID van het eerste item in de lijst.	Yes
heeft_meer	boolean	Of er meer items beschikbaar zijn.	Yes
last_id	tekenreeks	De id van het laatste item in de lijst.	Yes
object	enum	Het type object dat wordt geretourneerd, moet zijn list. Mogelijke waarden: list	Yes

OpenAI.ConversationItemLocalShellToolCall

Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.

Name	Typ	Description	Required	Verstek
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
status	enum	De status van de lokale shellcall. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type lokale schelproep. Altijd local_shell_call. Mogelijke waarden: local_shell_call	Yes

OpenAI.ConversationItemLocalShellToolCallOutput

De uitvoer van een lokale shell tool aanroep.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
output	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Yes
status	enum	Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type van de lokale shell-tool call output. Altijd local_shell_call_output. Mogelijke waarden: local_shell_call_output	Yes

OpenAI.ConversationItemMcpApprovalRequest

Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd mcp_approval_request. Mogelijke waarden: mcp_approval_request	Yes

OpenAI.ConversationItemMcpApprovalResponseResource

Een reactie op een MCP-goedkeuringsaanvraag.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
id	tekenreeks	De unieke id van het goedkeuringsantwoord	Yes
reden	tekenreeks (nullable)		No
type	enum	Het type item. Altijd mcp_approval_response. Mogelijke waarden: mcp_approval_response	Yes

OpenAI.ConversationItemMcpListTools

Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.

Name	Typ	Description	Required	Verstek
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de lijst.	Yes
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd mcp_list_tools. Mogelijke waarden: mcp_list_tools	Yes

OpenAI.ConversationItemMcpToolCall

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks (nullable)		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks (nullable)		No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd mcp_call. Mogelijke waarden: mcp_call	Yes

OpenAI.ConversationItemMessage

Een bericht naar of van het model.

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.MessageContent	De inhoud van het bericht	Yes
id	tekenreeks	De unieke id van het bericht.	Yes
role	OpenAI.MessageRole		Yes
status	OpenAI.MessageStatus		Yes
type	enum	Het type bericht. Altijd ingesteld op message. Mogelijke waarden: message	Yes

OpenAI.ConversationItemReasoningItem

Een beschrijving van de gedachtenketen die wordt gebruikt door een redeneringsmodel tijdens het genereren van een antwoord. Zorg ervoor dat je deze items in je in de Responses API opneemt voor volgende beurten van een gesprek als je handmatig context< managing context/c1> doet.

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.ReasoningTextContent	Redeneren over tekstinhoud.	No
encrypted_content	tekenreeks (nullable)		No
id	tekenreeks	De unieke identificator van de inhoud van de redenering.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
samenvatting	matrix van OpenAI.Summary	Samenvatting van redenering.	Yes
type	enum	Het type van het object. Altijd reasoning. Mogelijke waarden: reasoning	Yes

OpenAI.ConversationItemType

Property	Value
Type	tekenreeks
waarden	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

De resultaten van een aanroep van een webzoektool. Zie de webzoekgids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web heeft gebruikt (zoeken, open_page, zoeken).	Yes
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: in_progress, searching, , completedfailed	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd web_search_call. Mogelijke waarden: web_search_call	Yes

OpenAI.ConversationParam

Het gesprek waartoe dit antwoord behoort. Items uit dit gesprek worden voorafgegaan aan input_items deze antwoordaanvraag. Invoeritems en uitvoeritems uit dit antwoord worden automatisch toegevoegd aan dit gesprek nadat dit antwoord is voltooid.

Type: tekenreeks of OpenAI.ConversationParam-2

Het gesprek waartoe dit antwoord behoort. Items uit dit gesprek worden voorafgegaan aan input_items deze antwoordaanvraag. Invoeritems en uitvoeritems uit dit antwoord worden automatisch toegevoegd aan dit gesprek nadat dit antwoord is voltooid.

OpenAI.ConversationParam-2

Het gesprek waartoe dit antwoord behoort.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke id van het gesprek.	Yes

OpenAI.ConversationReference

Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke id van het gesprek waaraan dit antwoord is gekoppeld.	Yes

OpenAI.ConversationResource

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	Het tijdstip waarop het gesprek is gemaakt, gemeten in seconden sinds de Unix-epoch.	Yes
id	tekenreeks	De unieke id van het gesprek.	Yes
metadata	OpenAI.Metadata	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Yes
object	enum	Het objecttype, dat altijd conversationis. Mogelijke waarden: conversation	Yes

OpenAI.CreateChatCompletionRequestResponseFormat

Een object dat de indeling aangeeft die het model moet uitvoeren. Instelling voor { "type": "json_schema", "json_schema": {...} } het inschakelen van gestructureerde uitvoer die ervoor zorgt dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie vindt u in de handleiding Structured Outputs. { "type": "json_object" } Als u de oudere JSON-modus wilt inschakelen, zorgt u ervoor dat het bericht dat het model genereert geldige JSON is. Het is aanbevolen om json_schema te gebruiken voor modellen die dit ondersteunen.

Discriminator voor OpenAI.CreateChatCompletionRequestResponseFormat

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
text	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText
json_object	OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

Name	Typ	Description	Required	Verstek
type	OpenAI.CreateChatCompletionRequestResponseFormatType		Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatJsonObject

JSON-objectantwoordindeling. Een oudere methode voor het genereren van JSON-antwoorden. Het gebruik json_schema wordt aanbevolen voor modellen die dit ondersteunen. Houd er rekening mee dat het model geen JSON genereert zonder een systeem- of gebruikersbericht waarin het wordt geïnstrueerd om dit te doen.

Name	Typ	Description	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd json_object. Mogelijke waarden: json_object	Yes

OpenAI.CreateChatCompletionRequestResponseFormatResponseFormatText

De standaard antwoordindeling. Wordt gebruikt om tekstreacties te genereren.

Name	Typ	Description	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd text. Mogelijke waarden: text	Yes

OpenAI.CreateChatCompletionRequestResponseFormatType

Property	Value
Type	tekenreeks
waarden	text json_schema json_object

OpenAI.CreateConversationBody

Name	Typ	Description	Required	Verstek
Onderdelen	matrix van OpenAI.InputItem		No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

OpenAI.CreateEvalCompletionsRunDataSource

Een CompletionsRunDataSource-object met een beschrijving van een modelsamplingconfiguratie.

Name	Typ	Description	Required	Verstek
invoer_berichten	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate of OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference	Wordt gebruikt bij het nemen van steekproeven van een model. Bepaalt de structuur van de berichten die in het model zijn doorgegeven. Dit kan een verwijzing zijn naar een vooraf gedefinieerd traject (ie, item.input_trajectory) of een sjabloon met variabele verwijzingen naar de item naamruimte.	No
model	tekenreeks	De naam van het model dat moet worden gebruikt voor het genereren van voltooiingen (bijvoorbeeld 'o3-mini').	No
sampling_params	OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource of OpenAI.EvalJsonlFileIdSource of OpenAI.EvalStoredCompletionsSource	Bepaalt wat de naamruimte in de item gegevensbron van deze uitvoering vult.	Yes
type	enum	Het type rungegevensbron. Altijd completions. Mogelijke waarden: completions	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference

Name	Typ	Description	Required	Verstek
item_reference	tekenreeks		Yes
type	enum	Mogelijke waarden: item_reference	Yes

OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesTemplate

Name	Typ	Description	Required	Verstek
sjabloon	matrix van OpenAI.EasyInputMessage of OpenAI.EvalItem		Yes
type	enum	Mogelijke waarden: template	Yes

OpenAI.CreateEvalCompletionsRunDataSourceSamplingParams

Name	Typ	Description	Required	Verstek
max_completion_tokens	OpenAI.integer		No
inspanning bij redeneren	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
responsformaat	OpenAI.ResponseFormatText of OpenAI.ResponseFormatJsonSchema of OpenAI.ResponseFormatJsonObject		No
seed	OpenAI.integer		No	42
Temperatuur	OpenAI.numeriek		No	1
tools	matrix van OpenAI.ChatCompletionTool		No
top_p	OpenAI.numeriek		No	1

OpenAI.CreateEvalCustomDataSourceConfig

Een CustomDataSourceConfig-object dat het schema definieert voor de gegevensbron die wordt gebruikt voor de evaluatieuitvoeringen. Dit schema wordt gebruikt om de vorm van de gegevens te definiëren die:

• Wordt gebruikt om uw testcriteria te definiëren en
• Welke gegevens zijn vereist voor het maken van een run

Name	Typ	Description	Required	Verstek
include_voorbeeldschema	boolean	Of de evaluatie verwacht dat u de voorbeeldnaamruimte invult (bijvoorbeeld door het genereren van antwoorden uit uw gegevensbron)	No
item-schema	object	Het json-schema voor elke rij in de gegevensbron.	Yes
type	enum	Het type gegevensbron. Altijd custom. Mogelijke waarden: custom	Yes

OpenAI.CreateEvalJsonlRunDataSource

Een JsonlRunDataSource-object dat een JSONL-bestand opgeeft dat overeenkomt met de eval

Name	Typ	Description	Required	Verstek
source	OpenAI.EvalJsonlFileContentSource of OpenAI.EvalJsonlFileIdSource	Bepaalt wat de naamruimte in de item gegevensbron vult.	Yes
type	enum	Het type gegevensbron. Altijd jsonl. Mogelijke waarden: jsonl	Yes

OpenAI.CreateEvalLogsDataSourceConfig

Een gegevensbronconfiguratie waarmee de metagegevenseigenschap van uw logboekquery wordt opgegeven. Dit zijn meestal metagegevens zoals usecase=chatbot of prompt-version=v2, enzovoort.

Name	Typ	Description	Required	Verstek
metadata	object	Metagegevensfilters voor de logboekgegevensbron.	No
type	enum	Het type gegevensbron. Altijd logs. Mogelijke waarden: logs	Yes

OpenAI.CreateEvalResponsesRunDataSource

Een ResponsesRunDataSource-object waarin een modelsamplingconfiguratie wordt beschreven.

Name	Typ	Description	Required	Verstek
invoer_berichten	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate of OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference	Wordt gebruikt bij het nemen van steekproeven van een model. Bepaalt de structuur van de berichten die in het model zijn doorgegeven. Dit kan een verwijzing zijn naar een vooraf gedefinieerd traject (ie, item.input_trajectory) of een sjabloon met variabele verwijzingen naar de item naamruimte.	No
model	tekenreeks	De naam van het model dat moet worden gebruikt voor het genereren van voltooiingen (bijvoorbeeld 'o3-mini').	No
sampling_params	OpenAI.CreateEvalResponsesRunDataSourceSamplingParams		No
source	OpenAI.EvalJsonlFileContentSource of OpenAI.EvalJsonlFileIdSource of OpenAI.EvalResponsesSource	Bepaalt wat de naamruimte in de item gegevensbron van deze uitvoering vult.	Yes
type	enum	Het type rungegevensbron. Altijd responses. Mogelijke waarden: responses	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesItemReference

Name	Typ	Description	Required	Verstek
item_reference	tekenreeks		Yes
type	enum	Mogelijke waarden: item_reference	Yes

OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate

Name	Typ	Description	Required	Verstek
sjabloon	matrix van object of OpenAI.EvalItem		Yes
type	enum	Mogelijke waarden: template	Yes

OpenAI.CreateEvalResponsesRunDataSourceSamplingParams

Name	Typ	Description	Required	Verstek
max_completion_tokens	OpenAI.integer		No
inspanning bij redeneren	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
seed	OpenAI.integer		No	42
Temperatuur	OpenAI.numeriek		No	1
tekst	OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText		No
tools	matrix van OpenAI.Tool		No
top_p	OpenAI.numeriek		No	1

OpenAI.CreateEvalResponsesRunDataSourceSamplingParamsText

Name	Typ	Description	Required	Verstek
format	OpenAI.TextResponseFormatConfiguration	Een object dat de indeling aangeeft die het model moet uitvoeren. { "type": "json_schema" } Configureren maakt gestructureerde uitvoer mogelijk, dit zorgt ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie in de De standaardindeling is { "type": "text" } zonder extra opties. *Niet aanbevolen voor gpt-4o en nieuwere modellen:** Instellen van { "type": "json_object" } schakelt de oudere JSON-modus in, die zorgt ervoor dat het bericht dat het model genereert geldige JSON is. Het gebruiken van json_schema heeft de voorkeur voor modellen die dit ondersteunen.	No

OpenAI.CreateEvalStoredCompletionsDataSourceConfig

Verouderd verklaard ten gunste van LogsDataSourceConfig.

Name	Typ	Description	Required	Verstek
metadata	object	Metagegevensfilters voor de opgeslagen voltooiingsgegevensbron.	No
type	enum	Het type gegevensbron. Altijd stored_completions. Mogelijke waarden: stored_completions	Yes

OpenAI.CreateFineTuningJobRequest

Geldige modellen:

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	Typ	Description	Required	Verstek
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.CreateFineTuningJobRequestHyperparameters		No
└ batch_size	tekenreeks of OpenAI.integer		No	Auto
└learning_rate_multiplier	tekenreeks of OpenAI.numeriek		No
└n_epochs	tekenreeks of OpenAI.integer		No	Auto
integraties	matrix van OpenAI.CreateFineTuningJobRequestIntegrations	Een lijst met integraties waarmee u uw taak kunt verfijnen.	No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
method	OpenAI.FineTuneMethod	De methode die wordt gebruikt voor het afstemmen.	No
model	tekenreeks (zie geldige modellen hieronder)	De naam van het model om te fine-tunen. U kunt een van de volgende opties selecteren ondersteunde modellen.	Yes
seed	OpenAI.integer (nullbaar)		No
achtervoegsel	tekenreeks (nullable)	Een tekenreeks van maximaal 64 tekens die wordt toegevoegd aan de aangepaste modelnaam. Bijvoorbeeld, een suffix van 'custom-model-name' zou een modelnaam zoals ft:gpt-4o-mini:openai:custom-model-name:7p4lURel opleveren. Beperkingen: minLength: 1, maxLength: 64	No
training_file	tekenreeks	De id van een geüpload bestand dat trainingsgegevens bevat. Zie het uploadbestand voor het uploaden van een bestand. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. Daarnaast moet u uw bestand uploaden met het doel fine-tune. De inhoud van het bestand moet verschillen, afhankelijk van of het model gebruikmaakt van de chat, voltooiingsindeling of als de methode voor het afstemmen gebruikmaakt van de voorkeursindeling . Zie de handleiding voor het afstemmen voor meer informatie.	Yes
validatiebestand	tekenreeks (nullable)	De id van een geüpload bestand dat validatiegegevens bevat. Als u dit bestand opgeeft, worden de gegevens gebruikt om validatie te genereren metrische gegevens worden periodiek tijdens het afstemmen verfijnd. Deze metrische gegevens kunnen worden weergegeven in het bestand met resultaten afstemmen. Dezelfde gegevens mogen niet aanwezig zijn in zowel trein- als validatiebestanden. Uw gegevensset moet zijn opgemaakt als een JSONL-bestand. Je moet je bestand met het doel fine-tune uploaden. Zie de handleiding voor het afstemmen voor meer informatie.	No

OpenAI.CreateFineTuningJobRequestHyperparameters

Name	Typ	Description	Required	Verstek
batchgrootte	tekenreeks of OpenAI.integer		No
leerverhouding-vermenigvuldiger	tekenreeks of OpenAI.numeriek		No
aantal tijdperken	tekenreeks of OpenAI.integer		No

OpenAI.CreateFineTuningJobRequestIntegrations

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: wandb	Yes
wandb	OpenAI.CreateFineTuningJobRequestIntegrationsWandb		Yes

OpenAI.CreateFineTuningJobRequestIntegrationsWandb

Name	Typ	Description	Required	Verstek
entiteit	tekenreeks (nullable)		No
naam	tekenreeks (nullable)		No
project	tekenreeks		Yes
tags	array van tekenreeksen		No

OpenAI.CreateResponseStreamingResponse

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

OpenAI.CustomGrammarFormatParam

Een grammatica gedefinieerd door de gebruiker.

Name	Typ	Description	Required	Verstek
definitie	tekenreeks	De grammaticale definitie.	Yes
syntaxis	OpenAI.GrammarSyntax1		Yes
type	enum	Grammaticale formaat. Altijd grammar. Mogelijke waarden: grammar	Yes

OpenAI.CustomTextFormatParam

Onbeperkte vrije vorm tekst.

Name	Typ	Description	Required	Verstek
type	enum	Onbeperkt tekstformaat. Altijd text. Mogelijke waarden: text	Yes

OpenAI.CustomToolParam

Een aangepaste tool die input verwerkt met een gespecificeerd formaat. Lees meer over custom tools

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Optionele beschrijving van de aangepaste tool, gebruikt om meer context te bieden.	No
format	OpenAI.CustomToolParamFormat	Het invoerformaat voor de aangepaste tool. Standaard is onbeperkte tekst.	No
└type.	OpenAI.CustomToolParamFormatType		Yes
naam	tekenreeks	De naam van de aangepaste tool, gebruikt om deze te identificeren in tool-aanroepen.	Yes
type	enum	Het type aangepaste tool. Altijd custom. Mogelijke waarden: custom	Yes

OpenAI.CustomToolParamFormat

Het invoerformaat voor de aangepaste tool. Standaard is onbeperkte tekst.

Discriminator voor OpenAI.CustomToolParamFormat

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
text	OpenAI.CustomTextFormatParam
grammar	OpenAI.CustomGrammarFormatParam

Name	Typ	Description	Required	Verstek
type	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Property	Value
Type	tekenreeks
waarden	text grammar

OpenAI.DeletedConversationResource

Name	Typ	Description	Required	Verstek
verwijderd	boolean		Yes
id	tekenreeks		Yes
object	enum	Mogelijke waarden: conversation.deleted	Yes

OpenAI.DetailEnum

Property	Value
Type	tekenreeks
waarden	low high auto

OpenAI.DoubleClickAction

Een actie met dubbelklikken.

Name	Typ	Description	Required	Verstek
type	enum	Hiermee geeft u het gebeurtenistype. Voor een actie met dubbelklikken is deze eigenschap altijd ingesteld op double_click. Mogelijke waarden: double_click	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.Drag

Een sleepactie.

Name	Typ	Description	Required	Verstek
path	matrix van OpenAI.DragPoint	Een matrix met coördinaten die het pad van de sleepactie vertegenwoordigen. Coördinaten worden weergegeven als een matrix van objecten, bijvoorbeeld <br> [<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br> ]<br>	Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een sleepactie is deze eigenschap altijd ingesteld op drag. Mogelijke waarden: drag	Yes

OpenAI.DragPoint

Een x/y-coördinaatpaar, bijvoorbeeld { x: 100, y: 200 }.

Name	Typ	Description	Required	Verstek
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.EasyInputMessage

Een berichtinvoer voor het model met een rol die de instructies in de volgende hiërarchie aangeeft. Instructies met de developer of system rol hebben voorrang op instructies die met de user rol worden gegeven. Berichten met de assistant rol worden verondersteld te zijn gegenereerd door het model in eerdere interacties.

Name	Typ	Description	Required	Verstek
inhoud	tekenreeks of OpenAI.InputMessageContentList	Tekst, afbeelding of audio-invoer voor het model, dat wordt gebruikt om een antwoord te genereren. Kan ook eerdere antwoorden van assistenten bevatten.	Yes
role	enum	De rol van de berichtinvoer. Een vanuser, assistant, of system developer. Mogelijke waarden: user, assistant, , systemdeveloper	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type berichtinvoer. Altijd message. Mogelijke waarden: message	Yes

OpenAI.Error

Name	Typ	Description	Required	Verstek
aanvullende informatie	object		No
code	tekenreeks (nullable)		Yes
foutopsporingInfo	object		No
details	matrix van OpenAI.Error		No
message	tekenreeks		Yes
param	tekenreeks (nullable)		No
type	tekenreeks		No

OpenAI.EvalApiError

Een object dat een foutbericht weergeeft van de Eval-API.

Name	Typ	Description	Required	Verstek
code	tekenreeks	De foutcode.	Yes
message	tekenreeks	Het foutbericht.	Yes

OpenAI.EvalGraderLabelModel

Name	Typ	Description	Required	Verstek
input	matrix van OpenAI.EvalItem		Yes
labels	array van tekenreeksen	De labels die aan elk item in de evaluatie moeten worden toegewezen.	Yes
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
doorgeven_labels	array van tekenreeksen	De labels die een geslaagd resultaat aangeven. Moet een subset van labels zijn.	Yes
type	enum	Het objecttype, dat altijd label_modelis. Mogelijke waarden: label_model	Yes

OpenAI.EvalGraderPython

Name	Typ	Description	Required	Verstek
image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
naam	tekenreeks	De naam van de beoordelaar.	Yes
drempelwaarde overschrijden	OpenAI.numeriek		No
source	tekenreeks	De broncode van het Python-script.	Yes
type	enum	Het objecttype, dat altijd pythonis. Mogelijke waarden: python	Yes

OpenAI.EvalGraderScoreModel

Name	Typ	Description	Required	Verstek
input	matrix van OpenAI.EvalItem	De invoerberichten die door de cijferaar worden geëvalueerd. Ondersteunt tekst-, uitvoertekst-, invoerafbeeldings- en invoerinhoudsblokken en kan sjabloontekenreeksen bevatten.	Yes
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
drempelwaarde overschrijden	OpenAI.numeriek		No
range	matrix van OpenAI.numeriek	Het bereik van de score. Wordt standaard ingesteld op [0, 1].	No
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		No
└max_completions_tokens	OpenAI.integer (nullbaar)		No
└─ redeneerinspanning	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
└─ zaad	OpenAI.integer (nullbaar)		No
└─ temperatuur	OpenAI.numeriek (nullable)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
type	enum	Het objecttype, dat altijd score_modelis. Mogelijke waarden: score_model	Yes

OpenAI.EvalGraderScoreModelSamplingParams

Name	Typ	Description	Required	Verstek
max_completions_tokens	OpenAI.integer (nullbaar)		No
inspanning bij redeneren	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
seed	OpenAI.integer (nullbaar)		No
Temperatuur	OpenAI.numeriek (nullable)		No
top_p	OpenAI.numeriek (nullable)		No	1

OpenAI.EvalGraderStringCheck

Name	Typ	Description	Required	Verstek
input	tekenreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
operatie	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een vaneq, ne, of likeilike. Mogelijke waarden: eq, ne, , likeilike	Yes
referentie	tekenreeks	De verwijzingstekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
type	enum	Het objecttype, dat altijd string_checkis. Mogelijke waarden: string_check	Yes

OpenAI.EvalGraderTextSimilarity

Name	Typ	Description	Required	Verstek
evaluatiemaatstaf	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van cosine, fuzzy_match, bleu gleu, , meteorrouge_1, rouge_2, , rouge_3, , rouge_4rouge_5 of rouge_l. Mogelijke waarden: cosine, , fuzzy_match, bleu, gleu, meteor, , rouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Yes
input	tekenreeks	De tekst die wordt beoordeeld.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
drempelwaarde overschrijden	OpenAI.numeriek		Yes
referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	Yes
type	enum	Het type cijfer. Mogelijke waarden: text_similarity	Yes

OpenAI.EvalItem

Een berichtinvoer voor het model met een rol die de instructies in de volgende hiërarchie aangeeft. Instructies met de developer of system rol hebben voorrang op instructies die met de user rol worden gegeven. Berichten met de assistant rol worden verondersteld te zijn gegenereerd door het model in eerdere interacties.

Name	Typ	Description	Required	Verstek
inhoud	OpenAI.EvalItemContent	Invoer voor het model- kan sjabloontekenreeksen bevatten. Ondersteunt tekst, uitvoertekst, invoerafbeeldingen en invoeraudio, hetzij als één item of een matrix met items.	Yes
role	enum	De rol van de berichtinvoer. Een vanuser, assistant, of system developer. Mogelijke waarden: user, assistant, , systemdeveloper	Yes
type	enum	Het type berichtinvoer. Altijd message. Mogelijke waarden: message	No

OpenAI.EvalItemContent

Invoer voor het model- kan sjabloontekenreeksen bevatten. Ondersteunt tekst, uitvoertekst, invoerafbeeldingen en invoeraudio, hetzij als één item of een matrix met items.

Type: OpenAI.EvalItemContentItem of OpenAI.EvalItemContentArray

Invoer voor het model- kan sjabloontekenreeksen bevatten. Ondersteunt tekst, uitvoertekst, invoerafbeeldingen en invoeraudio, hetzij als één item of een matrix met items.

OpenAI.EvalItemContentArray

Een lijst met invoergegevens, die elk een invoertekst, uitvoertekst, invoerafbeelding of invoeraudioobject kunnen zijn.

Matrix van: OpenAI.EvalItemContentItem

OpenAI.EvalItemContentItem

Eén inhoudsitem: invoertekst, uitvoertekst, invoerafbeelding of invoeraudio.

Type: OpenAI.EvalItemContentText of OpenAI.EvalItemContentItemObject

Eén inhoudsitem: invoertekst, uitvoertekst, invoerafbeelding of invoeraudio.

OpenAI.EvalItemContentItemObject

Eén inhoudsitem: invoertekst, uitvoertekst, invoerafbeelding of invoeraudio.

Discriminator voor OpenAI.EvalItemContentItemObject

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
output_text	OpenAI.EvalItemContentOutputText
input_image	OpenAI.EvalItemInputImage
input_audio	OpenAI.InputAudio
input_text	OpenAI.EvalItemContentItemObjectInputTextContent

Name	Typ	Description	Required	Verstek
type	OpenAI.EvalItemContentItemObjectType		Yes

OpenAI.EvalItemContentItemObjectInputTextContent

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd input_text. Mogelijke waarden: input_text	Yes

OpenAI.EvalItemContentItemObjectType

Property	Value
Type	tekenreeks
waarden	input_text output_text input_image input_audio

OpenAI.EvalItemContentOutputText

Een tekstuitvoer van het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd output_text. Mogelijke waarden: output_text	Yes

OpenAI.EvalItemContentText

Een tekstinvoer voor het model.

Type: tekenreeks

OpenAI.EvalItemInputImage

Een invoerblok voor afbeeldingen dat wordt gebruikt in EvalItem-inhoudsmatrixen.

Name	Typ	Description	Required	Verstek
detail	tekenreeks	Het detailniveau van de afbeelding die naar het model moet worden verzonden. Een van high, lowof auto. Wordt standaard ingesteld op auto.	No
image_url	tekenreeks	De URL van de afbeeldingsinvoer.	Yes
type	enum	Het type afbeeldingsinvoer. Altijd input_image. Mogelijke waarden: input_image	Yes

OpenAI.EvalJsonlFileContentSource

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.EvalJsonlFileContentSourceContent	De inhoud van het jsonl-bestand.	Yes
type	enum	Het type jsonl-bron. Altijd file_content. Mogelijke waarden: file_content	Yes

OpenAI.EvalJsonlFileContentSourceContent

Name	Typ	Description	Required	Verstek
item	object		Yes
voorbeeld	object		No

OpenAI.EvalJsonlFileIdSource

Name	Typ	Description	Required	Verstek
id	tekenreeks	De identificatie van het bestand.	Yes
type	enum	Het type jsonl-bron. Altijd file_id. Mogelijke waarden: file_id	Yes

OpenAI.EvalResponsesSource

Een EvalResponsesSource-object met een beschrijving van de configuratie van een uitvoeringsgegevensbron.

Name	Typ	Description	Required	Verstek
aangemaakt_na	OpenAI.integer (nullbaar)		No
gemaakt_voor	OpenAI.integer (nullbaar)		No
instructies_zoeken	tekenreeks (nullable)		No
metadata	object (nul)		No
model	tekenreeks (nullable)		No
inspanning bij redeneren	OpenAI.ReasoningEffort (nul)	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
Temperatuur	OpenAI.numeriek (nullable)		No
tools	array van tekenreeksen		No
top_p	OpenAI.numeriek (nullable)		No
type	enum	Het type rungegevensbron. Altijd responses. Mogelijke waarden: responses	Yes
users	array van tekenreeksen		No

OpenAI.EvalRunOutputItemSample

Name	Typ	Description	Required	Verstek
fout	OpenAI.EvalApiError	Een object dat een foutbericht weergeeft van de Eval-API.	Yes
afsluitreden	tekenreeks		Yes
input	matrix van EvalRunOutputItemSampleInput		Yes
max_completion_tokens	OpenAI.integer		Yes
model	tekenreeks		Yes
output	matrix van EvalRunOutputItemSampleOutput		Yes
seed	OpenAI.integer		Yes
Temperatuur	OpenAI.numeriek		Yes
top_p	OpenAI.numeriek		Yes
usage	OpenAI.EvalRunOutputItemSampleUsage		Yes

OpenAI.EvalRunOutputItemSampleUsage

Name	Typ	Description	Required	Verstek
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerModelUsage

Name	Typ	Description	Required	Verstek
cached_tokens	OpenAI.integer		Yes
completion_tokens	OpenAI.integer		Yes
invocation_count	OpenAI.integer		Yes
model_name	tekenreeks		Yes
prompt_tokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.EvalRunPerTestingCriteriaResults

Name	Typ	Description	Required	Verstek
mislukt	OpenAI.integer		Yes
Doorgegeven	OpenAI.integer		Yes
testing_criteria	tekenreeks		Yes

OpenAI.EvalRunResultCounts

Name	Typ	Description	Required	Verstek
fout opgetreden	OpenAI.integer		Yes
mislukt	OpenAI.integer		Yes
Doorgegeven	OpenAI.integer		Yes
totaal	OpenAI.integer		Yes

OpenAI.EvalStoredCompletionsSource

Een StoredCompletionsRunDataSource-configuratie die een set filters beschrijft

Name	Typ	Description	Required	Verstek
aangemaakt_na	OpenAI.integer (nullbaar)		No
gemaakt_voor	OpenAI.integer (nullbaar)		No
limit	OpenAI.integer (nullbaar)		No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
model	tekenreeks (nullable)		No
type	enum	Het type bron. Altijd stored_completions. Mogelijke waarden: stored_completions	Yes

OpenAI.FileCitationBody

Een bronvermelding naar een bestand.

Name	Typ	Description	Required	Verstek
file_id	tekenreeks	De id van het bestand.	Yes
filename	tekenreeks	De bestandsnaam van het geciteerde bestand.	Yes
index	OpenAI.integer		Yes
type	enum	Het type bronvermelding van het bestand. Altijd file_citation. Mogelijke waarden: file_citation	Yes

OpenAI.FilePath

Een pad naar een bestand.

Name	Typ	Description	Required	Verstek
file_id	tekenreeks	De id van het bestand.	Yes
index	OpenAI.integer		Yes
type	enum	Het type van het bestandspad. Altijd file_path. Mogelijke waarden: file_path	Yes

OpenAI.FileSearchTool

Een hulpprogramma waarmee wordt gezocht naar relevante inhoud uit geüploade bestanden.

Name	Typ	Description	Required	Verstek
filters	OpenAI.Filters (nullable)		No
max_aantal_resultaten	OpenAI.integer		No
rangschikkingsopties	OpenAI.RankingOptions		No
└hybrid_search	OpenAI.HybridSearchOptions	Gewichten die bepalen hoe reciprocal rank fusion semantische embeddingmatches in balans brengt versus spaarzame trefwoordmatches wanneer hybride zoeken is ingeschakeld.	No
Rangschikker	OpenAI.RankerVersionType	De ranker die moet worden gebruikt voor het zoeken naar bestanden.	No
└score_threshold	OpenAI.numeriek	De scoredrempel voor het zoeken naar bestanden, een getal tussen 0 en 1. Getallen dichter bij 1 proberen alleen de meest relevante resultaten te retourneren, maar kunnen minder resultaten opleveren.	No
type	enum	Het type zoekprogramma voor bestanden. Altijd file_search. Mogelijke waarden: file_search	Yes
vector_store_ids	array van tekenreeksen	De id's van de vectorarchieven om te zoeken.	Yes

OpenAI.FileSearchToolCallResults

Name	Typ	Description	Required	Verstek
attributes	OpenAI.VectorStoreFileAttributes (nullbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximum lengte van 512 tekens, booleaanse waarden of getallen.	No
file_id	tekenreeks		No
filename	tekenreeks		No
Score	number		No
tekst	tekenreeks		No

OpenAI.Filters

Type: OpenAI.ComparisonFilter of OpenAI.CompoundFilter

OpenAI.FineTuneDPOHyperparameters

De hyperparameters die worden gebruikt voor de DPO-fijnafstemmingstaak.

Name	Typ	Description	Required	Verstek
batchgrootte	tekenreeks of OpenAI.integer	Aantal voorbeelden in elke batch. Een grotere batchgrootte betekent dat modelparameters minder vaak worden bijgewerkt, maar met een lagere variantie.	No
bèta	tekenreeks of OpenAI.numeriek	De bètawaarde voor de DPO-methode. Een hogere bètawaarde verhoogt het gewicht van de boete tussen het beleid en het referentiemodel.	No
leerverhouding-vermenigvuldiger	tekenreeks of OpenAI.numeriek	Schaalfactor voor de leersnelheid. Een kleiner leerpercentage kan nuttig zijn om overfitting te voorkomen.	No
aantal tijdperken	tekenreeks of OpenAI.integer	Het aantal tijdvakken waarvoor het model moet worden getraind. Een tijdsperiode verwijst naar één volledige cyclus door de trainingsgegevensset.	No

OpenAI.FineTuneDPOMethod

Configuratie voor de methode voor het afstemmen van de DPO.

Name	Typ	Description	Required	Verstek
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.FineTuneDPOHyperparameters	De hyperparameters die worden gebruikt voor de DPO-fijnafstemmingstaak.	No

OpenAI.FineTuneMethod

De methode die wordt gebruikt voor het afstemmen.

Name	Typ	Description	Required	Verstek
dpo	OpenAI.FineTuneDPOMethod	Configuratie voor de methode voor het afstemmen van de DPO.	No
versterking	OpenAI.FineTuneReinforcementMethod	Configuratie voor de verfijningsmethode voor versterking.	No
Gemonitord	OpenAI.FineTuneSupervisedMethod	Configuratie voor de begeleide fijnafstemmingsmethode.	No
type	enum	Het type methode. Ofwel supervised, dpo of reinforcement. Mogelijke waarden: supervised, dporeinforcement	Yes

OpenAI.FineTuneReinforcementHyperparameters

De hyperparameters die worden gebruikt voor de versterkingsafstemmingstaak.

Name	Typ	Description	Required	Verstek
batchgrootte	tekenreeks of OpenAI.integer	Aantal voorbeelden in elke batch. Een grotere batchgrootte betekent dat modelparameters minder vaak worden bijgewerkt, maar met een lagere variantie.	No
compute_multiplier	tekenreeks of OpenAI.numeriek	Vermenigvuldiger op de hoeveelheid rekenkracht die wordt gebruikt voor het verkennen van de zoekruimte tijdens de training.	No
eval_interval	tekenreeks of OpenAI.integer	Het aantal trainingsstappen tussen evaluatieuitvoeringen.	No
evaluatievoorbeelden	tekenreeks of OpenAI.integer	Aantal evaluatievoorbeelden dat per trainingsstap moet worden gegenereerd.	No
leerverhouding-vermenigvuldiger	tekenreeks of OpenAI.numeriek	Schaalfactor voor de leersnelheid. Een kleiner leerpercentage kan nuttig zijn om overfitting te voorkomen.	No
aantal tijdperken	tekenreeks of OpenAI.integer	Het aantal tijdvakken waarvoor het model moet worden getraind. Een tijdsperiode verwijst naar één volledige cyclus door de trainingsgegevensset.	No
inspanning bij redeneren	enum	Niveau van redeneringsinspanning. Mogelijke waarden: default, low, , mediumhigh	No

OpenAI.FineTuneReinforcementMethod

Configuratie voor de verfijningsmethode voor versterking.

Name	Typ	Description	Required	Verstek
Grader	OpenAI.GraderStringCheck of OpenAI.GraderTextSimilarity of OpenAI.GraderPython of OpenAI.GraderScoreModel of OpenAI.GraderMulti	De grader die wordt gebruikt voor de afstemmingstaak.	Yes
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.FineTuneReinforcementHyperparameters	De hyperparameters die worden gebruikt voor de versterkingsafstemmingstaak.	No

OpenAI.FineTuneSupervisedHyperparameters

De hyperparameters die worden gebruikt voor de afstemmingstaak.

Name	Typ	Description	Required	Verstek
batchgrootte	tekenreeks of OpenAI.integer	Aantal voorbeelden in elke batch. Een grotere batchgrootte betekent dat modelparameters minder vaak worden bijgewerkt, maar met een lagere variantie.	No
leerverhouding-vermenigvuldiger	tekenreeks of OpenAI.numeriek	Schaalfactor voor de leersnelheid. Een kleiner leerpercentage kan nuttig zijn om overfitting te voorkomen.	No
aantal tijdperken	tekenreeks of OpenAI.integer	Het aantal tijdvakken waarvoor het model moet worden getraind. Een tijdsperiode verwijst naar één volledige cyclus door de trainingsgegevensset.	No

OpenAI.FineTuneSupervisedMethod

Configuratie voor de begeleide fijnafstemmingsmethode.

Name	Typ	Description	Required	Verstek
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.FineTuneSupervisedHyperparameters	De hyperparameters die worden gebruikt voor de afstemmingstaak.	No

OpenAI.FineTuningIntegration

Name	Typ	Description	Required	Verstek
type	enum	Het type integratie dat wordt ingeschakeld voor de taak van fijn-afstemming Mogelijke waarden: wandb	Yes
wandb	OpenAI.FineTuningIntegrationWandb		Yes
└─ Entiteit	tekenreeks (nullable)		No
└─naam	tekenreeks (nullable)		No
└─project	tekenreeks		Yes
└─ tags	array van tekenreeksen		No

OpenAI.FineTuningIntegrationWandb

Name	Typ	Description	Required	Verstek
entiteit	tekenreeks (nullable)		No
naam	tekenreeks (nullable)		No
project	tekenreeks		Yes
tags	array van tekenreeksen		No

OpenAI.FineTuningJob

Het fine_tuning.job object vertegenwoordigt een verfijningstaak die is gemaakt via de API.

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer de taak voor het afstemmen is gemaakt.	Yes
fout	OpenAI.FineTuningJobError (nullable)		Yes
└─ code	tekenreeks		Yes
└• bericht	tekenreeks		Yes
└─ Param	tekenreeks (nullable)		Yes
geschatte voltooiing	integer		No
fine_tuned_model	tekenreeks (nullable)		Yes
afgerond_op	integer		Yes
hyperparameters (instellingen die een model beïnvloeden)	OpenAI.FineTuningJobHyperparameters		Yes
└ batch_size	tekenreeks of OpenAI.integer		No	Auto
└learning_rate_multiplier	tekenreeks of OpenAI.numeriek		No
└n_epochs	tekenreeks of OpenAI.integer		No	Auto
id	tekenreeks	De object-id waarnaar kan worden verwezen in de API-eindpunten.	Yes
integraties	matrix van OpenAI.FineTuningIntegration		No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
method	OpenAI.FineTuneMethod	De methode die wordt gebruikt voor het afstemmen.	No
model	tekenreeks	Het basismodel dat wordt geoptimaliseerd.	Yes
object	enum	Het objecttype, dat altijd fine_tuning.job is. Mogelijke waarden: fine_tuning.job	Yes
organisatie_id	tekenreeks	De organisatie die de eigenaar is van het fine-tuning project.	Yes
resultaat_bestanden	array van tekenreeksen	De gecompileerde resultaatbestands-ID's voor de fijnstemmingsopdracht. U kunt de resultaten ophalen met de Files-API.	Yes
seed	OpenAI.integer		Yes
status	enum	De huidige status van de taak voor het afstemmen kan validating_files, queued, running, succeeded, failed, of cancelled zijn. Mogelijke waarden: validating_files, queued, running, succeeded, , failedcancelled	Yes
trained_tokens	OpenAI.integer (nullbaar)		Yes
training_file	tekenreeks	De bestands-id die wordt gebruikt voor de training. U kunt de trainingsgegevens ophalen met de Files-API.	Yes
validatiebestand	tekenreeks (nullable)		Yes

OpenAI.FineTuningJobCheckpoint

Het fine_tuning.job.checkpoint object vertegenwoordigt een modelcontrolepunt voor een fijnregelingsproces dat gereed is voor gebruik.

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer het controlepunt is gemaakt.	Yes
fine_tuned_model_checkpoint (fijn-afgestelde modelcontrolenpunt)	tekenreeks	De naam van het nauwkeurig afgestemde controlepuntmodel dat wordt gemaakt.	Yes
fine_tuning_job_id	tekenreeks	De naam van de taak voor het afstemmen waarvan dit controlepunt is gemaakt.	Yes
id	tekenreeks	De controlepunt-id waarnaar kan worden verwezen in de API-eindpunten.	Yes
metrics	OpenAI.FineTuningJobCheckpointMetrics		Yes
└full_valid_loss	OpenAI.numeriek		No
└full_valid_mean_token_accuracy	OpenAI.numeriek		No
└stap.	OpenAI.numeriek		No
└─ train_loss	OpenAI.numeriek		No
└train_mean_token_accuracy	OpenAI.numeriek		No
└valid_loss	OpenAI.numeriek		No
└─ geldige_gemiddelde_token_nauwkeurigheid	OpenAI.numeriek		No
object	enum	Het objecttype, dat altijd 'fine_tuning.job.checkpoint' is. Mogelijke waarden: fine_tuning.job.checkpoint	Yes
stap_nummer	OpenAI.integer		Yes

OpenAI.FineTuningJobCheckpointMetrics

Name	Typ	Description	Required	Verstek
full_valid_loss	OpenAI.numeriek		No
full_valid_mean_token_accuracy	OpenAI.numeriek		No
stap	OpenAI.numeriek		No
train_loss	OpenAI.numeriek		No
train_mean_token_accuracy	OpenAI.numeriek		No
valid_loss	OpenAI.numeriek		No
valid_mean_token_accuracy	OpenAI.numeriek		No

OpenAI.FineTuningJobError

Name	Typ	Description	Required	Verstek
code	tekenreeks		Yes
message	tekenreeks		Yes
param	tekenreeks (nullable)		Yes

OpenAI.FineTuningJobEvent

Taakgebeurtenisobject verfijnen

Name	Typ	Description	Required	Verstek
aangemaakt_op	integer	De Unix-tijdstempel (in seconden) voor wanneer de taak voor het afstemmen is gemaakt.	Yes
data	OpenAI.FineTuningJobEventData		No
id	tekenreeks	De object-id.	Yes
level	enum	Het logboekniveau van de gebeurtenis. Mogelijke waarden: info, warnerror	Yes
message	tekenreeks	Het bericht van de gebeurtenis.	Yes
object	enum	Het objecttype, dat altijd fine_tuning.job.event is. Mogelijke waarden: fine_tuning.job.event	Yes
type	enum	Het type gebeurtenis. Mogelijke waarden: message, metrics	No

OpenAI.FineTuningJobEventData

Type: objecten

OpenAI.FineTuningJobHyperparameters

Name	Typ	Description	Required	Verstek
batchgrootte	tekenreeks of OpenAI.integer		No
leerverhouding-vermenigvuldiger	tekenreeks of OpenAI.numeriek		No
aantal tijdperken	tekenreeks of OpenAI.integer		No

OpenAI.FunctionAndCustomToolCallOutput

Discriminator voor OpenAI.FunctionAndCustomToolCallOutput

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
input_text	OpenAI.FunctionAndCustomToolCallOutputInputTextContent
input_image	OpenAI.FunctionAndCustomToolCallOutputInputImageContent
input_file	OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionAndCustomToolCallOutputType		Yes

OpenAI.FunctionAndCustomToolCallOutputInputFileContent

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks (nullable)		No
file_url	tekenreeks	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd input_file. Mogelijke waarden: input_file	Yes

OpenAI.FunctionAndCustomToolCallOutputInputImageContent

Een afbeeldingsinvoer voor het model. Leer over image inputs.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks (nullable)		No
image_url	tekenreeks		No
type	enum	Het type invoeritem. Altijd input_image. Mogelijke waarden: input_image	Yes

OpenAI.FunctionAndCustomToolCallOutputInputTextContent

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd input_text. Mogelijke waarden: input_text	Yes

OpenAI.FunctionAndCustomToolCallOutputType

Property	Value
Type	tekenreeks
waarden	input_text input_image input_file

OpenAI.FunctionCallItemStatus

Property	Value
Type	tekenreeks
waarden	in_progress completed incomplete

OpenAI.FunctionObject

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
naam	tekenreeks	De naam van de functie die moet worden aangeroepen. Moet a-z, A-Z, 0-9, onderstrepingstekens of streepjes bevatten, met een maximale lengte van maximaal 64 tekens.	Yes
parameters	OpenAI.FunctionParameters	De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject. Zie de handleiding voor voorbeelden en de naslaginformatie over het JSON-schema voor documentatie over de indeling. Als u parameters weglaat, wordt een functie met een lege parameterlijst gedefinieerd.	No
streng	Booleaanse waarde (nullable)		No

OpenAI.FunctionParameters

De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject. Zie de handleiding voor voorbeelden en de naslaginformatie over het JSON-schema voor documentatie over de indeling. Als u parameters weglaat, wordt een functie met een lege parameterlijst gedefinieerd.

Type: objecten

OpenAI.FunctionShellAction

Voer een shell-opdracht uit.

Name	Typ	Description	Required	Verstek
Opdrachten	array van tekenreeksen		Yes
max_output_length	OpenAI.integer (nullbaar)		Yes
timeout_ms (milliseconden)	OpenAI.integer (nullbaar)		Yes

OpenAI.FunctionShellActionParam

Opdrachten en limieten voor het uitvoeren van de aanroep van het shell-hulpprogramma.

Name	Typ	Description	Required	Verstek
Opdrachten	array van tekenreeksen	Geordende shell-opdrachten voor de uitvoeringsomgeving die moet worden uitgevoerd.	Yes
max_output_length	OpenAI.integer (nullbaar)		No
timeout_ms (milliseconden)	OpenAI.integer (nullbaar)		No

OpenAI.FunctionShellCallItemStatus

Statuswaarden gerapporteerd voor shell-hulpprogramma-aanroepen.

Property	Value
Type	tekenreeks
waarden	in_progress completed incomplete

OpenAI.FunctionShellCallOutputContent

De inhoud van een shell-hulpprogramma roept uitvoer aan die is verzonden.

Name	Typ	Description	Required	Verstek
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
resultaat	OpenAI.FunctionShellCallOutputOutcome	Vertegenwoordigt een afsluitresultaat (met een afsluitcode) of een time-outresultaat voor een shell-aanroepuitvoersegment.	Yes
└type.	OpenAI.FunctionShellCallOutputOutcomeType		Yes
Stderr	tekenreeks	De standaardfoutuitvoer die is vastgelegd.	Yes
stdout	tekenreeks	De standaarduitvoer die is vastgelegd.	Yes

OpenAI.FunctionShellCallOutputContentParam

Vastgelegde stdout en stderr voor een deel van de uitvoer van een shell-hulpprogramma.

Name	Typ	Description	Required	Verstek
resultaat	OpenAI.FunctionShellCallOutputOutcomeParam	Het afsluit- of time-outresultaat dat is gekoppeld aan deze shell-aanroep.	Yes
└type.	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes
Stderr	tekenreeks	Vastgelegde stderr-uitvoer voor de shell-aanroep. Beperkingen: maxLength: 10485760	Yes
stdout	tekenreeks	Vastgelegde stdout-uitvoer voor de shell-aanroep. Beperkingen: maxLength: 10485760	Yes

OpenAI.FunctionShellCallOutputExitOutcome

Geeft aan dat de shell-commando's zijn voltooid en een exitcode hebben teruggegeven.

Name	Typ	Description	Required	Verstek
exit_code	OpenAI.integer		Yes
type	enum	Het type resultaat. Altijd exit. Mogelijke waarden: exit	Yes

OpenAI.FunctionShellCallOutputExitOutcomeParam

Geeft aan dat de shell-commando's zijn voltooid en een exitcode hebben teruggegeven.

Name	Typ	Description	Required	Verstek
exit_code	OpenAI.integer		Yes
type	enum	Het type resultaat. Altijd exit. Mogelijke waarden: exit	Yes

OpenAI.FunctionShellCallOutputOutcome

Vertegenwoordigt een afsluitresultaat (met een afsluitcode) of een time-outresultaat voor een shell-aanroepuitvoersegment.

Discriminator voor OpenAI.FunctionShellCallOutputOutcome

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcome
exit	OpenAI.FunctionShellCallOutputExitOutcome

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionShellCallOutputOutcomeType		Yes

OpenAI.FunctionShellCallOutputOutcomeParam

Het afsluit- of time-outresultaat dat is gekoppeld aan deze shell-aanroep.

Discriminator voor OpenAI.FunctionShellCallOutputOutcomeParam

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
timeout	OpenAI.FunctionShellCallOutputTimeoutOutcomeParam
exit	OpenAI.FunctionShellCallOutputExitOutcomeParam

Name	Typ	Description	Required	Verstek
type	OpenAI.FunctionShellCallOutputOutcomeParamType		Yes

OpenAI.FunctionShellCallOutputOutcomeParamType

Property	Value
Type	tekenreeks
waarden	timeout exit

OpenAI.FunctionShellCallOutputOutcomeType

Property	Value
Type	tekenreeks
waarden	timeout exit

OpenAI.FunctionShellCallOutputTimeoutOutcome

Geeft aan dat de shell-oproep de geconfigureerde tijdslimiet heeft overschreden.

Name	Typ	Description	Required	Verstek
type	enum	Het type resultaat. Altijd timeout. Mogelijke waarden: timeout	Yes

OpenAI.FunctionShellCallOutputTimeoutOutcomeParam

Geeft aan dat de shell-oproep de geconfigureerde tijdslimiet heeft overschreden.

Name	Typ	Description	Required	Verstek
type	enum	Het type resultaat. Altijd timeout. Mogelijke waarden: timeout	Yes

OpenAI.FunctionShellToolParam

Een tool waarmee het model shell-commando's kan uitvoeren.

Name	Typ	Description	Required	Verstek
type	enum	Het type schelpgereedschap. Altijd shell. Mogelijke waarden: shell	Yes

OpenAI.FunctionTool

Definieert een functie in uw eigen code die het model kan aanroepen.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks (nullable)		No
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
parameters	object (nul)		Yes
streng	Booleaanse waarde (nullable)		Yes
type	enum	Het type functiehulpmiddel. Altijd function. Mogelijke waarden: function	Yes

OpenAI.GraderLabelModel

Een LabelModelGrader-object dat gebruikmaakt van een model om labels toe te wijzen aan elk item in de evaluatie.

Name	Typ	Description	Required	Verstek
input	matrix van OpenAI.EvalItem		Yes
labels	array van tekenreeksen	De labels die aan elk item in de evaluatie moeten worden toegewezen.	Yes
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie. Moet gestructureerde uitvoer ondersteunen.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
doorgeven_labels	array van tekenreeksen	De labels die een geslaagd resultaat aangeven. Moet een subset van labels zijn.	Yes
type	enum	Het objecttype, dat altijd label_modelis. Mogelijke waarden: label_model	Yes

OpenAI.GraderMulti

Een MultiGrader-object combineert de uitvoer van meerdere graders om één score te produceren.

Name	Typ	Description	Required	Verstek
bereken_uitvoer	tekenreeks	Een formule om de uitvoer te berekenen op basis van beoordelingsresultaten.	Yes
Klassers	OpenAI.GraderStringCheck of OpenAI.GraderTextSimilarity of OpenAI.GraderPython of OpenAI.GraderScoreModel of OpenAI.GraderLabelModel		Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
type	enum	Het objecttype, dat altijd multiis. Mogelijke waarden: multi	Yes

OpenAI.GraderPython

Een PythonGrader-object dat een Python-script uitvoert op de invoer.

Name	Typ	Description	Required	Verstek
image_tag	tekenreeks	De afbeeldingstag die moet worden gebruikt voor het Python-script.	No
naam	tekenreeks	De naam van de beoordelaar.	Yes
source	tekenreeks	De broncode van het Python-script.	Yes
type	enum	Het objecttype, dat altijd pythonis. Mogelijke waarden: python	Yes

OpenAI.GraderScoreModel

Een ScoreModelGrader-object dat gebruikmaakt van een model om een score toe te wijzen aan de invoer.

Name	Typ	Description	Required	Verstek
input	matrix van OpenAI.EvalItem	De invoerberichten die door de cijferaar worden geëvalueerd. Ondersteunt tekst-, uitvoertekst-, invoerafbeeldings- en invoerinhoudsblokken en kan sjabloontekenreeksen bevatten.	Yes
model	tekenreeks	Het model dat moet worden gebruikt voor de evaluatie.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
range	matrix van OpenAI.numeriek	Het bereik van de score. Wordt standaard ingesteld op [0, 1].	No
sampling_params	OpenAI.EvalGraderScoreModelSamplingParams		No
└max_completions_tokens	OpenAI.integer (nullbaar)		No
└─ redeneerinspanning	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
└─ zaad	OpenAI.integer (nullbaar)		No
└─ temperatuur	OpenAI.numeriek (nullable)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
type	enum	Het objecttype, dat altijd score_modelis. Mogelijke waarden: score_model	Yes

OpenAI.GraderStringCheck

Een StringCheckGrader-object dat een tekenreeksvergelijking tussen invoer en verwijzing uitvoert met behulp van een opgegeven bewerking.

Name	Typ	Description	Required	Verstek
input	tekenreeks	De invoertekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
operatie	enum	De tekenreekscontrolebewerking die moet worden uitgevoerd. Een vaneq, ne, of likeilike. Mogelijke waarden: eq, ne, , likeilike	Yes
referentie	tekenreeks	De verwijzingstekst. Dit kunnen sjabloontekenreeksen zijn.	Yes
type	enum	Het objecttype, dat altijd string_checkis. Mogelijke waarden: string_check	Yes

OpenAI.GraderTextSimilarity

Een TextSimilarityGrader-object waarmee tekst wordt beoordeeld op basis van metrische overeenkomsten.

Name	Typ	Description	Required	Verstek
evaluatiemaatstaf	enum	De metrische evaluatiegegevens die moeten worden gebruikt. Een van cosine, fuzzy_match, bleu gleu, , meteorrouge_1, rouge_2, , rouge_3, , rouge_4rouge_5 of rouge_l. Mogelijke waarden: cosine, , fuzzy_match, bleu, gleu, meteor, , rouge_1rouge_2rouge_3rouge_4rouge_5rouge_l	Yes
input	tekenreeks	De tekst die wordt beoordeeld.	Yes
naam	tekenreeks	De naam van de beoordelaar.	Yes
referentie	tekenreeks	De tekst wordt beoordeeld op basis van.	Yes
type	enum	Het type cijfer. Mogelijke waarden: text_similarity	Yes

OpenAI.GrammarSyntax1

Property	Value
Type	tekenreeks
waarden	lark regex

OpenAI.HybridSearchOptions

Name	Typ	Description	Required	Verstek
embedding_weight	OpenAI.numeriek		Yes
text_weight	OpenAI.numeriek		Yes

OpenAI.ImageDetail

Property	Value
Type	tekenreeks
waarden	low high auto

OpenAI.ImageGenTool

Een tool die afbeeldingen genereert met behulp van de GPT-beeldmodellen.

Geldige modellen:

gpt-image-1
gpt-image-1-mini

Name	Typ	Description	Required	Verstek
achtergrond	enum	Achtergrondtype voor de gegenereerde afbeelding. Eén van transparent, opaque, of auto. Standaard: auto. Mogelijke waarden: transparent, opaqueauto	No
invoergetrouwheid	OpenAI.InputFidelity (nullable)	Bepaal hoeveel inspanning het model zal uitoefenen om overeen te komen met de stijl en kenmerken, met name gezichtskenmerken, van invoerafbeeldingen. Deze parameter wordt alleen ondersteund voor gpt-image-1. Niet ondersteund voor gpt-image-1-mini. Ondersteunt high en low. Wordt standaard ingesteld op low.	No
invoer_afbeelding_masker	OpenAI.ImageGenToolInputImageMask		No
└─file_id	tekenreeks		No
└─image_url	tekenreeks		No
model	tekenreeks (zie geldige modellen hieronder)		No
moderation	enum	Beheerniveau voor de gegenereerde afbeelding. Standaard: auto. Mogelijke waarden: auto, low	No
uitvoercompressie	OpenAI.integer		No	100
uitvoerformaat	enum	De uitvoerindeling van de gegenereerde afbeelding. Een van png, webpof jpeg. Standaard: png. Mogelijke waarden: png, webpjpeg	No
gedeeltelijke_afbeeldingen	OpenAI.integer		No
kwaliteit	enum	De kwaliteit van de gegenereerde afbeelding. Een van low, medium, high of auto. Standaard: auto. Mogelijke waarden: low, medium, , highauto	No
size	enum	De grootte van de gegenereerde afbeelding. Een van 1024x1024, 1024x1536 1536x1024, of auto. Standaard: auto. Mogelijke waarden: 1024x1024, 1024x1536, , 1536x1024auto	No
type	enum	Het type tool voor het genereren van beelden. Altijd image_generation. Mogelijke waarden: image_generation	Yes

OpenAI.ImageGenToolInputImageMask

Name	Typ	Description	Required	Verstek
file_id	tekenreeks		No
image_url	tekenreeks		No

OpenAI.IncludeEnum

Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn:

• web_search_call.action.sources: Neem de bronnen van de aanroep van het webzoekprogramma op.
• code_interpreter_call.outputs: Bevat de output van de uitvoering van Python-code in aanroepitems van het code-interpreterprogramma.
• computer_call_output.output.image_url: Neem afbeeldings-URL's op uit de uitkomst van de computeroproep.
• file_search_call.results: Neem de zoekresultaten van de aanroep van het zoekprogramma voor bestanden op.
• message.input_image.image_url: Neem afbeeldings-URL's op uit het invoerbericht.
• message.output_text.logprobs: Neem logprobs op in assistentberichten.
• reasoning.encrypted_content: Bevat een versleutelde versie van redeneringstokens in de uitvoer van redeneringsitems. Hierdoor kunnen redeneringscomponenten worden gebruikt in gesprekken met meerdere beurten wanneer de antwoorden-API staatloos gebruikt kan worden (zoals wanneer de store parameter is ingesteld op false, of wanneer een organisatie is ingeschreven in het programma voor gegevens zonder retentie).

Property	Value
Description	Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn:

• web_search_call.action.sources: Neem de bronnen van de aanroep van het webzoekprogramma op.
• code_interpreter_call.outputs: Bevat de output van de uitvoering van Python-code in aanroepitems van het code-interpreterprogramma.
• computer_call_output.output.image_url: Neem afbeeldings-URL's op uit de uitkomst van de computeroproep.
• file_search_call.results: Neem de zoekresultaten van de aanroep van het zoekprogramma voor bestanden op.
• message.input_image.image_url: Neem afbeeldings-URL's op uit het invoerbericht.
• message.output_text.logprobs: Neem logprobs op in assistentberichten.
• reasoning.encrypted_content: Bevat een versleutelde versie van redeneringstokens in de uitvoer van redeneringsitems. Hierdoor kunnen redeneringscomponenten worden gebruikt in gesprekken met meerdere beurten wanneer de antwoorden-API staatloos gebruikt kan worden (zoals wanneer de store parameter is ingesteld op false, of wanneer een organisatie is ingeschreven in het programma voor gegevens zonder retentie). | | Type | tekenreeks | | Waarden | 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

Een audio-invoer voor het model.

Name	Typ	Description	Required	Verstek
input_audio	OpenAI.InputAudioInputAudio		Yes
type	enum	Het type invoeritem. Altijd input_audio. Mogelijke waarden: input_audio	Yes

OpenAI.InputAudioInputAudio

Name	Typ	Description	Required	Verstek
data	tekenreeks		Yes
format	enum	Mogelijke waarden: mp3, wav	Yes

OpenAI.InputContent

Discriminator voor OpenAI.InputContent

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
input_text	OpenAI.InputContentInputTextContent
input_image	OpenAI.InputContentInputImageContent
input_file	OpenAI.InputContentInputFileContent

Name	Typ	Description	Required	Verstek
type	OpenAI.InputContentType		Yes

OpenAI.InputContentInputFileContent

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks (nullable)		No
file_url	tekenreeks	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd input_file. Mogelijke waarden: input_file	Yes

OpenAI.InputContentInputImageContent

Een afbeeldingsinvoer voor het model. Leer over image inputs.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks (nullable)		No
image_url	tekenreeks		No
type	enum	Het type invoeritem. Altijd input_image. Mogelijke waarden: input_image	Yes

OpenAI.InputContentInputTextContent

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd input_text. Mogelijke waarden: input_text	Yes

OpenAI.InputContentType

Property	Value
Type	tekenreeks
waarden	input_text input_image input_file

OpenAI.InputFidelity

Bepaal hoeveel inspanning het model zal uitoefenen om overeen te komen met de stijl en kenmerken, met name gezichtskenmerken, van invoerafbeeldingen. Deze parameter wordt alleen ondersteund voor gpt-image-1. Niet ondersteund voor gpt-image-1-mini. Ondersteunt high en low. Wordt standaard ingesteld op low.

Property	Value
Type	tekenreeks
waarden	high low

OpenAI.InputFileContent

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks (nullable)		No
file_url	tekenreeks	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd input_file. Mogelijke waarden: input_file	Yes

OpenAI.InputFileContentParam

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
file_data	tekenreeks (nullable)		No
file_id	tekenreeks (nullable)		No
file_url	tekenreeks		No
filename	tekenreeks (nullable)		No
type	enum	Het type invoeritem. Altijd input_file. Mogelijke waarden: input_file	Yes

OpenAI.InputImageContent

Een afbeeldingsinvoer voor het model. Leer over image inputs.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks (nullable)		No
image_url	tekenreeks		No
type	enum	Het type invoeritem. Altijd input_image. Mogelijke waarden: input_image	Yes

OpenAI.InputImageContentParamAutoParam

Een afbeeldingsinvoer voor het model. Meer informatie over afbeeldingsinvoer

Name	Typ	Description	Required	Verstek
detail	OpenAI.DetailEnum (nullbaar)		No
file_id	tekenreeks (nullable)		No
image_url	tekenreeks		No
type	enum	Het type invoeritem. Altijd input_image. Mogelijke waarden: input_image	Yes

OpenAI.InputItem

Een item dat een deel van de context vertegenwoordigt voor het antwoord dat door het model wordt gegenereerd. Kan tekst, afbeeldingen en audio-invoer bevatten, evenals eerdere antwoorden van assistenten en uitvoer van hulpprogramma-oproepen.

Discriminator voor OpenAI.InputItem

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
message	OpenAI.EasyInputMessage
item_reference	OpenAI.ItemReferenceParam
output_message	OpenAI.InputItemOutputMessage
file_search_call	OpenAI.InputItemFileSearchToolCall
computer_call	OpenAI.InputItemComputerToolCall
computer_call_output	OpenAI.InputItemComputerCallOutputItemParam
web_search_call	OpenAI.InputItemWebSearchToolCall
function_call	OpenAI.InputItemFunctionToolCall
function_call_output	OpenAI.InputItemFunctionCallOutputItemParam
reasoning	OpenAI.InputItemReasoningItem
compaction	OpenAI.InputItemCompactionSummaryItemParam
image_generation_call	OpenAI.InputItemImageGenToolCall
code_interpreter_call	OpenAI.InputItemCodeInterpreterToolCall
local_shell_call	OpenAI.InputItemLocalShellToolCall
local_shell_call_output	OpenAI.InputItemLocalShellToolCallOutput
shell_call	OpenAI.InputItemFunctionShellCallItemParam
shell_call_output	OpenAI.InputItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.InputItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.InputItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.InputItemMcpListTools
mcp_approval_request	OpenAI.InputItemMcpApprovalRequest
mcp_approval_response	OpenAI.InputItemMcpApprovalResponse
mcp_call	OpenAI.InputItemMcpToolCall
custom_tool_call_output	OpenAI.InputItemCustomToolCallOutput
custom_tool_call	OpenAI.InputItemCustomToolCall

Name	Typ	Description	Required	Verstek
type	OpenAI.InputItemType		Yes

OpenAI.InputItemApplyPatchToolCallItemParam

Een hulpprogramma-aanroep die een aanvraag vertegenwoordigt voor het maken, verwijderen of bijwerken van bestanden met behulp van diff-patches.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
operatie	OpenAI.ApplyPatchOperationParam	Een van de create_file-, delete_file- of update_file bewerkingen die aan het hulpprogramma apply_patch worden geleverd.	Yes
└type.	OpenAI.ApplyPatchOperationParamType		Yes
status	OpenAI.ApplyPatchCallStatusParam	Statuswaarden gerapporteerd voor apply_patch hulpprogramma-aanroepen.	Yes
type	enum	Het type item. Altijd apply_patch_call. Mogelijke waarden: apply_patch_call	Yes

OpenAI.InputItemApplyPatchToolCallOutputItemParam

De gestreamde uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
output	tekenreeks (nullable)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Resultaatwaarden gerapporteerd voor uitvoer van apply_patch hulpprogramma-aanroep.	Yes
type	enum	Het type item. Altijd apply_patch_call_output. Mogelijke waarden: apply_patch_call_output	Yes

OpenAI.InputItemCodeInterpreterToolCall

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
code	tekenreeks (nullable)		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage		Yes
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijnin_progress, , , completeden incompleteinterpretingfailed. Mogelijke waarden: in_progress, completed, incomplete, , interpretingfailed	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd code_interpreter_call. Mogelijke waarden: code_interpreter_call	Yes

OpenAI.InputItemCompactionSummaryItemParam

Een compactie-item dat door de v1/responses/compact API wordt gegenereerd.

Name	Typ	Description	Required	Verstek
encrypted_content	tekenreeks	De versleutelde inhoud van de compressiesamenvatting. Beperkingen: maxLength: 10485760	Yes
id	tekenreeks (nullable)		No
type	enum	Het type item. Altijd compaction. Mogelijke waarden: compaction	Yes

OpenAI.InputItemComputerCallOutputItemParam

De uitvoer van een aanroep van een computerhulpprogramma.

Name	Typ	Description	Required	Verstek
acknowledged_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam		No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
output	OpenAI.ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Yes
status	OpenAI.FunctionCallItemStatus (nullierbar)		No
type	enum	Het type aanroepuitvoer van het computerhulpprogramma. Altijd computer_call_output. Mogelijke waarden: computer_call_output	Yes

OpenAI.InputItemComputerToolCall

Een oproep aan een computergebruikshulpmiddel. Zie de computergids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		Yes
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren veiligheidscontroles voor de computeroproep.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type computeroproep. Altijd computer_call. Mogelijke waarden: computer_call	Yes

OpenAI.InputItemCustomToolCall

Een aanroep naar een aangepaste tool die door het model is gemaakt.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	Een identifier die wordt gebruikt om deze aangepaste tooloproep te koppelen aan een toolcall-uitvoer.	Yes
id	tekenreeks	De unieke ID van de custom tool-aanroep in het OpenAI-platform.	No
input	tekenreeks	De invoer voor de custom tool-aanroep die door het model wordt gegenereerd.	Yes
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat wordt aangeroepen.	Yes
type	enum	Het type custom tool-oproep. Altijd custom_tool_call. Mogelijke waarden: custom_tool_call	Yes

OpenAI.InputItemCustomToolCallOutput

De output van een aangepaste tool-aanroep vanuit je code, die wordt teruggestuurd naar het model.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De call ID, gebruikt om deze custom tool-call output te koppelen aan een custom tool call.	Yes
id	tekenreeks	De unieke ID van de aangepaste toolcall levert uit in het OpenAI-platform.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De output van de custom tool-aanroep die door je code wordt gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
type	enum	Het type output van de custom tool-oproep. Altijd custom_tool_call_output. Mogelijke waarden: custom_tool_call_output	Yes

OpenAI.InputItemFileSearchToolCall

De resultaten van een aanroep van een zoekprogramma voor bestanden. Zie de zoekgids bestand voor meer informatie.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	matrix van OpenAI.FileSearchToolCallResults		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van in_progress, searching, incomplete of failed Mogelijke waarden: in_progress, searching, completed, , incompletefailed	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd file_search_call. Mogelijke waarden: file_search_call	Yes

OpenAI.InputItemFunctionCallOutputItemParam

De uitvoer van een functiehulpmiddeloproep.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
output	tekenreeks of matrix van OpenAI.InputTextContentParam of OpenAI.InputImageContentParamAutoParam of OpenAI.InputFileContentParam	Tekst, afbeelding of bestandsuitvoer van de aanroep van het functiehulpmiddel.	Yes
status	OpenAI.FunctionCallItemStatus (nullierbar)		No
type	enum	Het type uitvoer van het functiehulpmiddel. Altijd function_call_output. Mogelijke waarden: function_call_output	Yes

OpenAI.InputItemFunctionShellCallItemParam

Een hulpprogramma dat een aanvraag vertegenwoordigt voor het uitvoeren van een of meer shell-opdrachten.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellActionParam	Opdrachten en limieten voor het uitvoeren van de aanroep van het shell-hulpprogramma.	Yes
└opdrachten.	array van tekenreeksen	Geordende shell-opdrachten voor de uitvoeringsomgeving die moet worden uitgevoerd.	Yes
└max_output_length	OpenAI.integer (nullbaar)		No
└timeout_ms	OpenAI.integer (nullbaar)		No
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
status	OpenAI.FunctionShellCallItemStatus (nullbaar)	Statuswaarden gerapporteerd voor shell-hulpprogramma-aanroepen.	No
type	enum	Het type item. Altijd shell_call. Mogelijke waarden: shell_call	Yes

OpenAI.InputItemFunctionShellCallOutputItemParam

De gestreamde uitvoeritems die worden verzonden door een shell-hulpprogramma-aanroep.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
max_output_length	OpenAI.integer (nullbaar)		No
output	matrix van OpenAI.FunctionShellCallOutputContentParam	Vastgelegde segmenten van stdout- en stderr-uitvoer, samen met de bijbehorende resultaten.	Yes
type	enum	Het type item. Altijd shell_call_output. Mogelijke waarden: shell_call_output	Yes

OpenAI.InputItemFunctionToolCall

Een aanroep van een hulpprogramma om een functie uit te voeren. Zie de handleiding voor het aanroepen van functies voor meer informatie.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks	De unieke id van de aanroep van het functiehulpmiddel.	No
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd function_call. Mogelijke waarden: function_call	Yes

OpenAI.InputItemImageGenToolCall

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
result	tekenreeks (nullable)		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: in_progress, completed, , generatingfailed	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd image_generation_call. Mogelijke waarden: image_generation_call	Yes

OpenAI.InputItemLocalShellToolCall

Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.

Name	Typ	Description	Required	Verstek
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
status	enum	De status van de lokale shellcall. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type lokale schelproep. Altijd local_shell_call. Mogelijke waarden: local_shell_call	Yes

OpenAI.InputItemLocalShellToolCallOutput

De uitvoer van een lokale shell tool aanroep.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
output	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Yes
status	enum	Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type van de lokale shell-tool call output. Altijd local_shell_call_output. Mogelijke waarden: local_shell_call_output	Yes

OpenAI.InputItemMcpApprovalRequest

Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd mcp_approval_request. Mogelijke waarden: mcp_approval_request	Yes

OpenAI.InputItemMcpApprovalResponse

Een reactie op een MCP-goedkeuringsaanvraag.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
id	tekenreeks (nullable)		No
reden	tekenreeks (nullable)		No
type	enum	Het type item. Altijd mcp_approval_response. Mogelijke waarden: mcp_approval_response	Yes

OpenAI.InputItemMcpListTools

Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.

Name	Typ	Description	Required	Verstek
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de lijst.	Yes
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd mcp_list_tools. Mogelijke waarden: mcp_list_tools	Yes

OpenAI.InputItemMcpToolCall

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks (nullable)		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks (nullable)		No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd mcp_call. Mogelijke waarden: mcp_call	Yes

OpenAI.InputItemOutputMessage

Een uitvoerbericht van het model.

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.OutputMessageContent	De inhoud van het uitvoerbericht.	Yes
id	tekenreeks	De unieke id van het uitvoerbericht.	Yes
role	enum	De rol van het uitvoerbericht. Altijd assistant. Mogelijke waarden: assistant	Yes
status	enum	De status van de berichtinvoer. Een van in_progress, completedof incomplete. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type van het uitvoerbericht. Altijd message. Mogelijke waarden: output_message	Yes

OpenAI.InputItemReasoningItem

Een beschrijving van de gedachtenketen die wordt gebruikt door een redeneringsmodel tijdens het genereren van een antwoord. Zorg ervoor dat je deze items in je in de Responses API opneemt voor volgende beurten van een gesprek als je handmatig context< managing context/c1> doet.

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.ReasoningTextContent	Redeneren over tekstinhoud.	No
encrypted_content	tekenreeks (nullable)		No
id	tekenreeks	De unieke identificator van de inhoud van de redenering.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
samenvatting	matrix van OpenAI.Summary	Samenvatting van redenering.	Yes
type	enum	Het type van het object. Altijd reasoning. Mogelijke waarden: reasoning	Yes

OpenAI.InputItemType

Property	Value
Type	tekenreeks
waarden	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

De resultaten van een aanroep van een webzoektool. Zie de webzoekgids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web heeft gebruikt (zoeken, open_page, zoeken).	Yes
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: in_progress, searching, , completedfailed	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd web_search_call. Mogelijke waarden: web_search_call	Yes

OpenAI.InputMessage

Een berichtinvoer voor het model met een rol die de instructies in de volgende hiërarchie aangeeft. Instructies met de developer of system rol hebben voorrang op instructies die met de user rol worden gegeven.

Name	Typ	Description	Required	Verstek
inhoud	OpenAI.InputMessageContentList	Een lijst met een of veel invoeritems voor het model, met verschillende inhoud types.	Yes
role	enum	De rol van de berichtinvoer. Een van user, systemof developer. Mogelijke waarden: user, systemdeveloper	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type berichtinvoer. Altijd ingesteld op message. Mogelijke waarden: message	Yes

OpenAI.InputMessageContentList

Een lijst met een of veel invoeritems voor het model, met verschillende inhoudstypen.

Matrix van: OpenAI.InputContent

OpenAI.InputMessageResource

Name	Typ	Description	Required	Verstek
inhoud	OpenAI.InputMessageContentList	Een lijst met een of veel invoeritems voor het model, met verschillende inhoud types.	Yes
id	tekenreeks	De unieke id van de berichtinvoer.	Yes
role	enum	De rol van de berichtinvoer. Een van user, systemof developer. Mogelijke waarden: user, systemdeveloper	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type berichtinvoer. Altijd ingesteld op message. Mogelijke waarden: message	Yes

OpenAI.InputParam

Tekst, afbeelding of bestandsinvoer voor het model, dat wordt gebruikt om een antwoord te genereren. Meer informatie:

• Tekstinvoer en -uitvoer
• Afbeeldingsingangen
• Bestandsinvoer
• Gespreksstatus
• Functie aanroepen

Type: tekenreeks of matrix van OpenAI.InputItem

Tekst, afbeelding of bestandsinvoer voor het model, dat wordt gebruikt om een antwoord te genereren. Meer informatie:

• Tekstinvoer en -uitvoer
• Afbeeldingsingangen
• Bestandsinvoer
• Gespreksstatus
• Functie aanroepen

OpenAI.InputTextContent

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd input_text. Mogelijke waarden: input_text	Yes

OpenAI.InputTextContentParam

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model. Beperkingen: maxLength: 10485760	Yes
type	enum	Het type invoeritem. Altijd input_text. Mogelijke waarden: input_text	Yes

OpenAI.Item

Inhoudsitem dat wordt gebruikt om een antwoord te genereren.

Discriminator voor OpenAI.Item

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
memory_search_call	MemorySearchToolCallItemParam
message	OpenAI.InputMessage
output_message	OpenAI.ItemOutputMessage
file_search_call	OpenAI.ItemFileSearchToolCall
computer_call	OpenAI.ItemComputerToolCall
computer_call_output	OpenAI.ItemComputerCallOutputItemParam
web_search_call	OpenAI.ItemWebSearchToolCall
function_call	OpenAI.ItemFunctionToolCall
function_call_output	OpenAI.ItemFunctionCallOutputItemParam
reasoning	OpenAI.ItemReasoningItem
compaction	OpenAI.ItemCompactionSummaryItemParam
image_generation_call	OpenAI.ItemImageGenToolCall
code_interpreter_call	OpenAI.ItemCodeInterpreterToolCall
local_shell_call	OpenAI.ItemLocalShellToolCall
local_shell_call_output	OpenAI.ItemLocalShellToolCallOutput
shell_call	OpenAI.ItemFunctionShellCallItemParam
shell_call_output	OpenAI.ItemFunctionShellCallOutputItemParam
apply_patch_call	OpenAI.ItemApplyPatchToolCallItemParam
apply_patch_call_output	OpenAI.ItemApplyPatchToolCallOutputItemParam
mcp_list_tools	OpenAI.ItemMcpListTools
mcp_approval_request	OpenAI.ItemMcpApprovalRequest
mcp_approval_response	OpenAI.ItemMcpApprovalResponse
mcp_call	OpenAI.ItemMcpToolCall
custom_tool_call_output	OpenAI.ItemCustomToolCallOutput
custom_tool_call	OpenAI.ItemCustomToolCall

Name	Typ	Description	Required	Verstek
type	OpenAI.ItemType		Yes

OpenAI.ItemApplyPatchToolCallItemParam

Een hulpprogramma-aanroep die een aanvraag vertegenwoordigt voor het maken, verwijderen of bijwerken van bestanden met behulp van diff-patches.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
operatie	OpenAI.ApplyPatchOperationParam	Een van de create_file-, delete_file- of update_file bewerkingen die aan het hulpprogramma apply_patch worden geleverd.	Yes
└type.	OpenAI.ApplyPatchOperationParamType		Yes
status	OpenAI.ApplyPatchCallStatusParam	Statuswaarden gerapporteerd voor apply_patch hulpprogramma-aanroepen.	Yes
type	enum	Het type item. Altijd apply_patch_call. Mogelijke waarden: apply_patch_call	Yes

OpenAI.ItemApplyPatchToolCallOutputItemParam

De gestreamde uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
output	tekenreeks (nullable)		No
status	OpenAI.ApplyPatchCallOutputStatusParam	Resultaatwaarden gerapporteerd voor uitvoer van apply_patch hulpprogramma-aanroep.	Yes
type	enum	Het type item. Altijd apply_patch_call_output. Mogelijke waarden: apply_patch_call_output	Yes

OpenAI.ItemCodeInterpreterToolCall

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
code	tekenreeks (nullable)		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage		Yes
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijnin_progress, , , completeden incompleteinterpretingfailed. Mogelijke waarden: in_progress, completed, incomplete, , interpretingfailed	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd code_interpreter_call. Mogelijke waarden: code_interpreter_call	Yes

OpenAI.ItemCompactionSummaryItemParam

Een compactie-item dat door de v1/responses/compact API wordt gegenereerd.

Name	Typ	Description	Required	Verstek
encrypted_content	tekenreeks	De versleutelde inhoud van de compressiesamenvatting. Beperkingen: maxLength: 10485760	Yes
id	tekenreeks (nullable)		No
type	enum	Het type item. Altijd compaction. Mogelijke waarden: compaction	Yes

OpenAI.ItemComputerCallOutputItemParam

De uitvoer van een aanroep van een computerhulpprogramma.

Name	Typ	Description	Required	Verstek
acknowledged_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam		No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
output	OpenAI.ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Yes
status	OpenAI.FunctionCallItemStatus (nullierbar)		No
type	enum	Het type aanroepuitvoer van het computerhulpprogramma. Altijd computer_call_output. Mogelijke waarden: computer_call_output	Yes

OpenAI.ItemComputerToolCall

Een oproep aan een computergebruikshulpmiddel. Zie de computergids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		Yes
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren veiligheidscontroles voor de computeroproep.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type computeroproep. Altijd computer_call. Mogelijke waarden: computer_call	Yes

OpenAI.ItemCustomToolCall

Een aanroep naar een aangepaste tool die door het model is gemaakt.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	Een identifier die wordt gebruikt om deze aangepaste tooloproep te koppelen aan een toolcall-uitvoer.	Yes
id	tekenreeks	De unieke ID van de custom tool-aanroep in het OpenAI-platform.	No
input	tekenreeks	De invoer voor de custom tool-aanroep die door het model wordt gegenereerd.	Yes
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat wordt aangeroepen.	Yes
type	enum	Het type custom tool-oproep. Altijd custom_tool_call. Mogelijke waarden: custom_tool_call	Yes

OpenAI.ItemCustomToolCallOutput

De output van een aangepaste tool-aanroep vanuit je code, die wordt teruggestuurd naar het model.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De call ID, gebruikt om deze custom tool-call output te koppelen aan een custom tool call.	Yes
id	tekenreeks	De unieke ID van de aangepaste toolcall levert uit in het OpenAI-platform.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De output van de custom tool-aanroep die door je code wordt gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
type	enum	Het type output van de custom tool-oproep. Altijd custom_tool_call_output. Mogelijke waarden: custom_tool_call_output	Yes

OpenAI.ItemFileSearchToolCall

De resultaten van een aanroep van een zoekprogramma voor bestanden. Zie de zoekgids bestand voor meer informatie.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	matrix van OpenAI.FileSearchToolCallResults		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van in_progress, searching, incomplete of failed Mogelijke waarden: in_progress, searching, completed, , incompletefailed	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd file_search_call. Mogelijke waarden: file_search_call	Yes

OpenAI.ItemFunctionCallOutputItemParam

De uitvoer van een functiehulpmiddeloproep.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
output	tekenreeks of matrix van OpenAI.InputTextContentParam of OpenAI.InputImageContentParamAutoParam of OpenAI.InputFileContentParam	Tekst, afbeelding of bestandsuitvoer van de aanroep van het functiehulpmiddel.	Yes
status	OpenAI.FunctionCallItemStatus (nullierbar)		No
type	enum	Het type uitvoer van het functiehulpmiddel. Altijd function_call_output. Mogelijke waarden: function_call_output	Yes

OpenAI.ItemFunctionShellCallItemParam

Een hulpprogramma dat een aanvraag vertegenwoordigt voor het uitvoeren van een of meer shell-opdrachten.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellActionParam	Opdrachten en limieten voor het uitvoeren van de aanroep van het shell-hulpprogramma.	Yes
└opdrachten.	array van tekenreeksen	Geordende shell-opdrachten voor de uitvoeringsomgeving die moet worden uitgevoerd.	Yes
└max_output_length	OpenAI.integer (nullbaar)		No
└timeout_ms	OpenAI.integer (nullbaar)		No
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
status	OpenAI.FunctionShellCallItemStatus (nullbaar)	Statuswaarden gerapporteerd voor shell-hulpprogramma-aanroepen.	No
type	enum	Het type item. Altijd shell_call. Mogelijke waarden: shell_call	Yes

OpenAI.ItemFunctionShellCallOutputItemParam

De gestreamde uitvoeritems die worden verzonden door een shell-hulpprogramma-aanroep.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd. Beperkingen: minLength: 1, maxLength: 64	Yes
id	tekenreeks (nullable)		No
max_output_length	OpenAI.integer (nullbaar)		No
output	matrix van OpenAI.FunctionShellCallOutputContentParam	Vastgelegde segmenten van stdout- en stderr-uitvoer, samen met de bijbehorende resultaten.	Yes
type	enum	Het type item. Altijd shell_call_output. Mogelijke waarden: shell_call_output	Yes

OpenAI.ItemFunctionToolCall

Een aanroep van een hulpprogramma om een functie uit te voeren. Zie de handleiding voor het aanroepen van functies voor meer informatie.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks	De unieke id van de aanroep van het functiehulpmiddel.	No
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd function_call. Mogelijke waarden: function_call	Yes

OpenAI.ItemImageGenToolCall

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
result	tekenreeks (nullable)		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: in_progress, completed, , generatingfailed	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd image_generation_call. Mogelijke waarden: image_generation_call	Yes

OpenAI.ItemLocalShellToolCall

Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.

Name	Typ	Description	Required	Verstek
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
status	enum	De status van de lokale shellcall. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type lokale schelproep. Altijd local_shell_call. Mogelijke waarden: local_shell_call	Yes

OpenAI.ItemLocalShellToolCallOutput

De uitvoer van een lokale shell tool aanroep.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
output	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Yes
status	enum	Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type van de lokale shell-tool call output. Altijd local_shell_call_output. Mogelijke waarden: local_shell_call_output	Yes

OpenAI.ItemMcpApprovalRequest

Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd mcp_approval_request. Mogelijke waarden: mcp_approval_request	Yes

OpenAI.ItemMcpApprovalResponse

Een reactie op een MCP-goedkeuringsaanvraag.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
id	tekenreeks (nullable)		No
reden	tekenreeks (nullable)		No
type	enum	Het type item. Altijd mcp_approval_response. Mogelijke waarden: mcp_approval_response	Yes

OpenAI.ItemMcpListTools

Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.

Name	Typ	Description	Required	Verstek
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de lijst.	Yes
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd mcp_list_tools. Mogelijke waarden: mcp_list_tools	Yes

OpenAI.ItemMcpToolCall

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks (nullable)		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks (nullable)		No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd mcp_call. Mogelijke waarden: mcp_call	Yes

OpenAI.ItemOutputMessage

Een uitvoerbericht van het model.

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.OutputMessageContent	De inhoud van het uitvoerbericht.	Yes
id	tekenreeks	De unieke id van het uitvoerbericht.	Yes
role	enum	De rol van het uitvoerbericht. Altijd assistant. Mogelijke waarden: assistant	Yes
status	enum	De status van de berichtinvoer. Een van in_progress, completedof incomplete. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type van het uitvoerbericht. Altijd message. Mogelijke waarden: output_message	Yes

OpenAI.ItemReasoningItem

Een beschrijving van de gedachtenketen die wordt gebruikt door een redeneringsmodel tijdens het genereren van een antwoord. Zorg ervoor dat je deze items in je in de Responses API opneemt voor volgende beurten van een gesprek als je handmatig context< managing context/c1> doet.

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.ReasoningTextContent	Redeneren over tekstinhoud.	No
encrypted_content	tekenreeks (nullable)		No
id	tekenreeks	De unieke identificator van de inhoud van de redenering.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
samenvatting	matrix van OpenAI.Summary	Samenvatting van redenering.	Yes
type	enum	Het type van het object. Altijd reasoning. Mogelijke waarden: reasoning	Yes

OpenAI.ItemReferenceParam

Een interne id voor een item waarnaar moet worden verwezen.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De id van het item waarnaar moet worden verwezen.	Yes
type	enum	Het type item waarnaar moet worden verwezen. Altijd item_reference. Mogelijke waarden: item_reference	Yes

OpenAI.ItemResource

Inhoudsitem dat wordt gebruikt om een antwoord te genereren.

Discriminator voor OpenAI.ItemResource

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
message	OpenAI.InputMessageResource
output_message	OpenAI.ItemResourceOutputMessage
file_search_call	OpenAI.ItemResourceFileSearchToolCall
computer_call	OpenAI.ItemResourceComputerToolCall
computer_call_output	OpenAI.ItemResourceComputerToolCallOutputResource
web_search_call	OpenAI.ItemResourceWebSearchToolCall
function_call	OpenAI.ItemResourceFunctionToolCallResource
function_call_output	OpenAI.ItemResourceFunctionToolCallOutputResource
image_generation_call	OpenAI.ItemResourceImageGenToolCall
code_interpreter_call	OpenAI.ItemResourceCodeInterpreterToolCall
local_shell_call	OpenAI.ItemResourceLocalShellToolCall
local_shell_call_output	OpenAI.ItemResourceLocalShellToolCallOutput
shell_call	OpenAI.ItemResourceFunctionShellCall
shell_call_output	OpenAI.ItemResourceFunctionShellCallOutput
apply_patch_call	OpenAI.ItemResourceApplyPatchToolCall
apply_patch_call_output	OpenAI.ItemResourceApplyPatchToolCallOutput
mcp_list_tools	OpenAI.ItemResourceMcpListTools
mcp_approval_request	OpenAI.ItemResourceMcpApprovalRequest
mcp_approval_response	OpenAI.ItemResourceMcpApprovalResponseResource
mcp_call	OpenAI.ItemResourceMcpToolCall

Name	Typ	Description	Required	Verstek
type	OpenAI.ItemResourceType		Yes

OpenAI.ItemResourceApplyPatchToolCall

Een aanroep van een hulpprogramma waarmee bestandsverschil wordt toegepast door bestanden te maken, te verwijderen of bij te werken.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep patchtool toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
operatie	OpenAI.ApplyPatchFileOperation	Een van de create_file-, delete_file- of update_file bewerkingen die worden toegepast via apply_patch.	Yes
└type.	OpenAI.ApplyPatchFileOperationType		Yes
status	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Het type item. Altijd apply_patch_call. Mogelijke waarden: apply_patch_call	Yes

OpenAI.ItemResourceApplyPatchToolCallOutput

De uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die dit hulpprogramma heeft gemaakt, roept uitvoer aan.	No
id	tekenreeks	De unieke id van de uitvoer van de patchtool-aanroep toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
output	tekenreeks (nullable)		No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Het type item. Altijd apply_patch_call_output. Mogelijke waarden: apply_patch_call_output	Yes

OpenAI.ItemResourceCodeInterpreterToolCall

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
code	tekenreeks (nullable)		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage		Yes
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijnin_progress, , , completeden incompleteinterpretingfailed. Mogelijke waarden: in_progress, completed, incomplete, , interpretingfailed	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd code_interpreter_call. Mogelijke waarden: code_interpreter_call	Yes

OpenAI.ItemResourceComputerToolCall

Een oproep aan een computergebruikshulpmiddel. Zie de computergids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		Yes
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren veiligheidscontroles voor de computeroproep.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type computeroproep. Altijd computer_call. Mogelijke waarden: computer_call	Yes

OpenAI.ItemResourceComputerToolCallOutputResource

Name	Typ	Description	Required	Verstek
acknowledged_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De veiligheidscontroles die zijn gerapporteerd door de API die zijn bevestigd door de ontwikkelaar.	No
call_id	tekenreeks	De id van de computertool-aanroep die de uitvoer heeft geproduceerd.	Yes
id	tekenreeks	De id van de uitvoer van de computertooloproep.	No
output	OpenAI.ComputerScreenshotImage	Een schermopnameafbeelding van een computer die wordt gebruikt met het hulpprogramma voor computergebruik.	Yes
status	enum	De status van de berichtinvoer. Een van in_progress, completedof incomplete. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type aanroepuitvoer van het computerhulpprogramma. Altijd computer_call_output. Mogelijke waarden: computer_call_output	Yes

OpenAI.ItemResourceFileSearchToolCall

De resultaten van een aanroep van een zoekprogramma voor bestanden. Zie de zoekgids bestand voor meer informatie.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
results	matrix van OpenAI.FileSearchToolCallResults		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van in_progress, searching, incomplete of failed Mogelijke waarden: in_progress, searching, completed, , incompletefailed	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd file_search_call. Mogelijke waarden: file_search_call	Yes

OpenAI.ItemResourceFunctionShellCall

Een hulpprogramma-aanroep waarmee een of meer shell-opdrachten in een beheerde omgeving worden uitgevoerd.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellAction	Voer een shell-opdracht uit.	Yes
└opdrachten.	array van tekenreeksen		Yes
└max_output_length	OpenAI.integer (nullbaar)		Yes
└timeout_ms	OpenAI.integer (nullbaar)		Yes
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep van het shell-hulpprogramma. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
status	OpenAI.LocalShellCallStatus		Yes
type	enum	Het type item. Altijd shell_call. Mogelijke waarden: shell_call	Yes

OpenAI.ItemResourceFunctionShellCallOutput

De uitvoer van een shell-hulpprogramma-aanroep die is verzonden.

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke id van de uitvoer van de shell-aanroep. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
max_output_length	OpenAI.integer (nullbaar)		Yes
output	matrix van OpenAI.FunctionShellCallOutputContent	Een matrix met uitvoerinhoud van shell-aanroep	Yes
type	enum	Het type uitvoer van de shell-aanroep. Altijd shell_call_output. Mogelijke waarden: shell_call_output	Yes

OpenAI.ItemResourceFunctionToolCallOutputResource

Name	Typ	Description	Required	Verstek
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de uitvoer van het functiehulpmiddel. Ingevuld wanneer dit item wordt geretourneerd via API.	No
output	tekenreeks of matrix van OpenAI.FunctionAndCustomToolCallOutput	De uitvoer van de functie-aanroep die door uw code is gegenereerd. Dit kan een tekenreeks of een lijst met uitvoerinhoud zijn.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type uitvoer van het functiehulpmiddel. Altijd function_call_output. Mogelijke waarden: function_call_output	Yes

OpenAI.ItemResourceFunctionToolCallResource

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks	De unieke id van de aanroep van het functiehulpmiddel.	No
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd function_call. Mogelijke waarden: function_call	Yes

OpenAI.ItemResourceImageGenToolCall

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
result	tekenreeks (nullable)		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: in_progress, completed, , generatingfailed	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd image_generation_call. Mogelijke waarden: image_generation_call	Yes

OpenAI.ItemResourceLocalShellToolCall

Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.

Name	Typ	Description	Required	Verstek
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
status	enum	De status van de lokale shellcall. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type lokale schelproep. Altijd local_shell_call. Mogelijke waarden: local_shell_call	Yes

OpenAI.ItemResourceLocalShellToolCallOutput

De uitvoer van een lokale shell tool aanroep.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
output	tekenreeks	Een JSON-tekenreeks van de uitvoer van de aanroep van het lokale shell-hulpprogramma.	Yes
status	enum	Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type van de lokale shell-tool call output. Altijd local_shell_call_output. Mogelijke waarden: local_shell_call_output	Yes

OpenAI.ItemResourceMcpApprovalRequest

Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd mcp_approval_request. Mogelijke waarden: mcp_approval_request	Yes

OpenAI.ItemResourceMcpApprovalResponseResource

Een reactie op een MCP-goedkeuringsaanvraag.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks	De ID van de goedkeuringsaanvraag waarop wordt geantwoord.	Yes
approve	boolean	Of de aanvraag is goedgekeurd.	Yes
id	tekenreeks	De unieke id van het goedkeuringsantwoord	Yes
reden	tekenreeks (nullable)		No
type	enum	Het type item. Altijd mcp_approval_response. Mogelijke waarden: mcp_approval_response	Yes

OpenAI.ItemResourceMcpListTools

Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.

Name	Typ	Description	Required	Verstek
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de lijst.	Yes
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd mcp_list_tools. Mogelijke waarden: mcp_list_tools	Yes

OpenAI.ItemResourceMcpToolCall

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required	Verstek
approval_request_id	tekenreeks (nullable)		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks (nullable)		No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd mcp_call. Mogelijke waarden: mcp_call	Yes

OpenAI.ItemResourceOutputMessage

Een uitvoerbericht van het model.

Name	Typ	Description	Required	Verstek
inhoud	matrix van OpenAI.OutputMessageContent	De inhoud van het uitvoerbericht.	Yes
id	tekenreeks	De unieke id van het uitvoerbericht.	Yes
role	enum	De rol van het uitvoerbericht. Altijd assistant. Mogelijke waarden: assistant	Yes
status	enum	De status van de berichtinvoer. Een van in_progress, completedof incomplete. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type van het uitvoerbericht. Altijd message. Mogelijke waarden: output_message	Yes

OpenAI.ItemResourceType

Property	Value
Type	tekenreeks
waarden	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

De resultaten van een aanroep van een webzoektool. Zie de webzoekgids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web heeft gebruikt (zoeken, open_page, zoeken).	Yes
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: in_progress, searching, , completedfailed	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd web_search_call. Mogelijke waarden: web_search_call	Yes

OpenAI.ItemType

Property	Value
Type	tekenreeks
waarden	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

De resultaten van een aanroep van een webzoektool. Zie de webzoekgids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web heeft gebruikt (zoeken, open_page, zoeken).	Yes
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: in_progress, searching, , completedfailed	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd web_search_call. Mogelijke waarden: web_search_call	Yes

OpenAI.KeyPressAction

Een verzameling toetsaanslagen die het model graag zou willen uitvoeren.

Name	Typ	Description	Required	Verstek
keys	array van tekenreeksen	De toetsencombinatie die het model aanraadt om in te drukken. Dit is een matrix met tekenreeksen die elk een sleutel vertegenwoordigen.	Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een toetsdrukactie is deze eigenschap altijd ingesteld op keypress. Mogelijke waarden: keypress	Yes

OpenAI.ListFineTuningJobCheckpointsResponse

Name	Typ	Description	Required	Verstek
data	matrix van OpenAI.FineTuningJobCheckpoint		Yes
first_id	tekenreeks (nullable)		No
heeft_meer	boolean		Yes
last_id	tekenreeks (nullable)		No
object	enum	Mogelijke waarden: list	Yes

OpenAI.ListFineTuningJobEventsResponse

Name	Typ	Description	Required	Verstek
data	matrix van OpenAI.FineTuningJobEvent		Yes
heeft_meer	boolean		Yes
object	enum	Mogelijke waarden: list	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name	Typ	Description	Required	Verstek
data	matrix van OpenAI.FineTuningJob		Yes
heeft_meer	boolean		Yes
object	enum	Mogelijke waarden: list	Yes

OpenAI.LocalShellCallStatus

Property	Value
Type	tekenreeks
waarden	in_progress completed incomplete

OpenAI.LocalShellExecAction

Voer een shell-opdracht uit op de server.

Name	Typ	Description	Required	Verstek
command	array van tekenreeksen	De opdracht die moet worden uitgevoerd.	Yes
Env	object	Omgevingsvariabelen die moeten worden ingesteld voor de opdracht.	Yes
timeout_ms (milliseconden)	OpenAI.integer (nullbaar)		No
type	enum	Het type lokale shell-actie. Altijd exec. Mogelijke waarden: exec	Yes
user	tekenreeks (nullable)		No
working_directory	tekenreeks (nullable)		No

OpenAI.LocalShellToolParam

Een hulpprogramma waarmee het model shell-opdrachten kan uitvoeren in een lokale omgeving.

Name	Typ	Description	Required	Verstek
type	enum	Het type van het lokale shell-hulpprogramma. Altijd local_shell. Mogelijke waarden: local_shell	Yes

OpenAI.LogProb

De logaritmische waarschijnlijkheid van een token.

Name	Typ	Description	Required	Verstek
bytes	matrix van OpenAI.integer		Yes
logprob	OpenAI.numeriek		Yes
token	tekenreeks		Yes
top_logprobs	matrix van OpenAI.TopLogProb		Yes

OpenAI.MCPListToolsTool

Een hulpprogramma dat beschikbaar is op een MCP-server.

Name	Typ	Description	Required	Verstek
annotations	OpenAI.MCPListToolsToolAnnotaties (nul)		No
beschrijving	tekenreeks (nullable)		No
input_schema	OpenAI.MCPListToolsToolInputSchema		Yes
naam	tekenreeks	De naam van het hulpprogramma.	Yes

OpenAI.MCPListToolsToolAnnotations

Type: objecten

OpenAI.MCPListToolsToolInputSchema

Type: objecten

OpenAI.MCPTool

Geef het model toegang tot aanvullende tools via externe MCP-servers (Model Context Protocol). Leer meer over MCP.

Name	Typ	Description	Required	Verstek
toegestane_hulpmiddelen	matrix van tekenreeks of OpenAI.MCPToolFilter		No
authorization	tekenreeks	Een OAuth access token die gebruikt kan worden met een externe MCP-server, ofwel met een aangepaste MCP-server-URL of een serviceconnector. Uw toepassing moet de OAuth-autorisatiestroom verwerken en hier het token opgeven.	No
connector_id	enum	Identifier voor serviceconnectors, zoals die beschikbaar zijn in ChatGPT. Een van server_url of connector_id moet worden verstrekt. Meer informatie over service Connectoren Hier. Momenteel ondersteunde connector_id waarden zijn: -Dropbox: connector_dropbox -Gmail: connector_gmail - Google Agenda: connector_googlecalendar - Google Drive: connector_googledrive - Microsoft Teams:connector_microsoftteams - Outlook Agenda: connector_outlookcalendar - E-mail van Outlook: connector_outlookemail -Sharepoint: connector_sharepoint Mogelijke waarden: connector_dropbox, connector_gmail, connector_googlecalendar, connector_googledrive, connector_microsoftteams, , connector_outlookcalendarconnector_outlookemailconnector_sharepoint	No
headers	object (nul)		No
project_connection_id	tekenreeks	De verbindings-id in de project voor de MCP-server. De verbinding slaat verificatie en andere verbindingsgegevens op die nodig zijn om verbinding te maken met de MCP-server.	No
goedkeuring vereist	object (zie geldige modellen hieronder)		No
server_description	tekenreeks	Optionele beschrijving van de MCP-server, gebruikt om meer context te bieden.	No
server_label	tekenreeks	Een label voor deze MCP-server, dat wordt gebruikt om het te identificeren in hulpprogramma-aanroepen.	Yes
server_url	tekenreeks	De URL voor de MCP-server. Een van of server_url moet een van connector_id de verstrekt.	No
type	enum	Het type van de MCP-tool. Altijd mcp. Mogelijke waarden: mcp	Yes

OpenAI.MCPToolCallStatus

Property	Value
Type	tekenreeks
waarden	in_progress completed incomplete calling failed

OpenAI.MCPToolFilter

Een filterobject om aan te geven welke tools zijn toegestaan.

Name	Typ	Description	Required	Verstek
read_only	boolean	Geeft aan of een tool data wijzigt of alleen-lezen is. Als een MCP-server wordt geannoteerd met readOnlyHint, deze komt overeen met dit filter.	No
tool_names	array van tekenreeksen	Lijst met toegestane namen van hulpprogramma's.	No

OpenAI.MCPToolRequireApproval

Name	Typ	Description	Required	Verstek
always	OpenAI.MCPToolFilter	Een filterobject om aan te geven welke tools zijn toegestaan.	No
nooit	OpenAI.MCPToolFilter	Een filterobject om aan te geven welke tools zijn toegestaan.	No

OpenAI.MessageContent

Een inhoudsonderdeel dat een invoer- of uitvoeritem vormt.

Discriminator voor OpenAI.MessageContent

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
text	OpenAI.TextContent
summary_text	OpenAI.SummaryTextContent
computer_screenshot	OpenAI.ComputerScreenshotContent
input_text	OpenAI.MessageContentInputTextContent
output_text	OpenAI.MessageContentOutputTextContent
reasoning_text	OpenAI.MessageContentReasoningTextContent
refusal	OpenAI.MessageContentRefusalContent
input_image	OpenAI.MessageContentInputImageContent
input_file	OpenAI.MessageContentInputFileContent

Name	Typ	Description	Required	Verstek
type	OpenAI.MessageContentType		Yes

OpenAI.MessageContentInputFileContent

Een bestandsinvoer voor het model.

Name	Typ	Description	Required	Verstek
file_data	tekenreeks	De inhoud van het bestand dat naar het model moet worden verzonden.	No
file_id	tekenreeks (nullable)		No
file_url	tekenreeks	De URL van het bestand dat naar het model gestuurd moet worden.	No
filename	tekenreeks	De naam van het bestand dat naar het model moet worden verzonden.	No
type	enum	Het type invoeritem. Altijd input_file. Mogelijke waarden: input_file	Yes

OpenAI.MessageContentInputImageContent

Een afbeeldingsinvoer voor het model. Leer over image inputs.

Name	Typ	Description	Required	Verstek
detail	OpenAI.ImageDetail		Yes
file_id	tekenreeks (nullable)		No
image_url	tekenreeks		No
type	enum	Het type invoeritem. Altijd input_image. Mogelijke waarden: input_image	Yes

OpenAI.MessageContentInputTextContent

Een tekstinvoer voor het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekstinvoer voor het model.	Yes
type	enum	Het type invoeritem. Altijd input_text. Mogelijke waarden: input_text	Yes

OpenAI.MessageContentOutputTextContent

Een tekstuitvoer van het model.

Name	Typ	Description	Required	Verstek
annotations	matrix van OpenAI.Annotation	De annotaties van de tekstuitvoer.	Yes
logprobs	matrix van OpenAI.LogProb		No
tekst	tekenreeks	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd output_text. Mogelijke waarden: output_text	Yes

OpenAI.MessageContentReasoningTextContent

Redenerende tekst uit het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De redeneringstekst van het model.	Yes
type	enum	Het type redeneringstekst. Altijd reasoning_text. Mogelijke waarden: reasoning_text	Yes

OpenAI.MessageContentRefusalContent

Een weigering van het model.

Name	Typ	Description	Required	Verstek
weigering	tekenreeks	De weigeringsverklaring van het model.	Yes
type	enum	Het type weigering. Altijd refusal. Mogelijke waarden: refusal	Yes

OpenAI.MessageContentType

Property	Value
Type	tekenreeks
waarden	input_text output_text text summary_text reasoning_text refusal input_image computer_screenshot input_file

OpenAI.MessageRole

Property	Value
Type	tekenreeks
waarden	unknown user assistant system critic discriminator developer tool

OpenAI.MessageStatus

Property	Value
Type	tekenreeks
waarden	in_progress completed incomplete

OpenAI.Metadata

Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.

Type: objecten

OpenAI.ModelIdsCompaction

Model-id die wordt gebruikt voor het genereren van het antwoord, zoals gpt-5 of o3. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestatiekenmerken en prijspunten. Raadpleeg de modelhandleiding om door beschikbare modellen te bladeren en te vergelijken.

Type: OpenAI.ModelIdsResponses of tekenreeks

Model-id die wordt gebruikt voor het genereren van het antwoord, zoals gpt-5 of o3. OpenAI biedt een breed scala aan modellen met verschillende mogelijkheden, prestatiekenmerken en prijspunten. Raadpleeg de modelhandleiding om door beschikbare modellen te bladeren en te vergelijken.

OpenAI.ModelIdsResponses

Property	Value
Type	tekenreeks
waarden	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

Type: tekenreeks of OpenAI.ChatModel

OpenAI.Move

Een actie voor het verplaatsen van de muis.

Name	Typ	Description	Required	Verstek
type	enum	Hiermee geeft u het gebeurtenistype. Voor een beweging is deze eigenschap altijd ingesteld op move. Mogelijke waarden: move	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.OutputContent

Discriminator voor OpenAI.OutputContent

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
output_text	OpenAI.OutputContentOutputTextContent
refusal	OpenAI.OutputContentRefusalContent
reasoning_text	OpenAI.OutputContentReasoningTextContent

Name	Typ	Description	Required	Verstek
type	OpenAI.OutputContentType		Yes

OpenAI.OutputContentOutputTextContent

Een tekstuitvoer van het model.

Name	Typ	Description	Required	Verstek
annotations	matrix van OpenAI.Annotation	De annotaties van de tekstuitvoer.	Yes
logprobs	matrix van OpenAI.LogProb		No
tekst	tekenreeks	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd output_text. Mogelijke waarden: output_text	Yes

OpenAI.OutputContentReasoningTextContent

Redenerende tekst uit het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De redeneringstekst van het model.	Yes
type	enum	Het type redeneringstekst. Altijd reasoning_text. Mogelijke waarden: reasoning_text	Yes

OpenAI.OutputContentRefusalContent

Een weigering van het model.

Name	Typ	Description	Required	Verstek
weigering	tekenreeks	De weigeringsverklaring van het model.	Yes
type	enum	Het type weigering. Altijd refusal. Mogelijke waarden: refusal	Yes

OpenAI.OutputContentType

Property	Value
Type	tekenreeks
waarden	output_text refusal reasoning_text

OpenAI.OutputItem

Discriminator voor OpenAI.OutputItem

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	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.OutputItemMMcpApprovalRequest
custom_tool_call	OpenAI.OutputItemCustomToolCall

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
type	OpenAI.OutputItemType		Yes

OpenAI.OutputItemApplyPatchToolCall

Een aanroep van een hulpprogramma waarmee bestandsverschil wordt toegepast door bestanden te maken, te verwijderen of bij te werken.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep patchtool toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
operatie	OpenAI.ApplyPatchFileOperation	Een van de create_file-, delete_file- of update_file bewerkingen die worden toegepast via apply_patch.	Yes
└type.	OpenAI.ApplyPatchFileOperationType		Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	OpenAI.ApplyPatchCallStatus		Yes
type	enum	Het type item. Altijd apply_patch_call. Mogelijke waarden: apply_patch_call	Yes

OpenAI.OutputItemApplyPatchToolCallOutput

De uitvoer die wordt verzonden door een patchtoolaanroep toepassen.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
call_id	tekenreeks	De unieke ID van de apply patch tool-aanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die dit hulpprogramma heeft gemaakt, roept uitvoer aan.	No
id	tekenreeks	De unieke id van de uitvoer van de patchtool-aanroep toepassen. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
output	tekenreeks (nullable)		No
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	OpenAI.ApplyPatchCallOutputStatus		Yes
type	enum	Het type item. Altijd apply_patch_call_output. Mogelijke waarden: apply_patch_call_output	Yes

OpenAI.OutputItemCodeInterpreterToolCall

Een aanroep van een hulpprogramma om code uit te voeren.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
code	tekenreeks (nullable)		Yes
container_id	tekenreeks	De id van de container die wordt gebruikt om de code uit te voeren.	Yes
id	tekenreeks	De unieke ID van de aanroep van het code-interpreterhulpprogramma.	Yes
outputs	matrix van OpenAI.CodeInterpreterOutputLogs of OpenAI.CodeInterpreterOutputImage		Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	enum	De status van de aanroep van het hulpprogramma code-interpreter. Geldige waarden zijnin_progress, , , completeden incompleteinterpretingfailed. Mogelijke waarden: in_progress, completed, incomplete, , interpretingfailed	Yes
type	enum	Het type oproep van het code-interpreter-hulpprogramma. Altijd code_interpreter_call. Mogelijke waarden: code_interpreter_call	Yes

OpenAI.OutputItemCompactionBody

Een compactie-item dat door de v1/responses/compact API wordt gegenereerd.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
encrypted_content	tekenreeks	De versleutelde inhoud die is geproduceerd door compressie.	Yes
id	tekenreeks	De unieke ID van het compactie-item.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
type	enum	Het type item. Altijd compaction. Mogelijke waarden: compaction	Yes

OpenAI.OutputItemComputerToolCall

Een oproep aan een computergebruikshulpmiddel. Zie de computergids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.ComputerAction		Yes
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
call_id	tekenreeks	Een identificator die wordt gebruikt om te reageren op de oproep van het hulpprogramma met uitvoer.	Yes
id	tekenreeks	De unieke ID van het computergesprek.	Yes
pending_safety_checks	matrix van OpenAI.ComputerCallSafetyCheckParam	De nog uit te voeren veiligheidscontroles voor de computeroproep.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type computeroproep. Altijd computer_call. Mogelijke waarden: computer_call	Yes

OpenAI.OutputItemCustomToolCall

Een aanroep naar een aangepaste tool die door het model is gemaakt.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
call_id	tekenreeks	Een identifier die wordt gebruikt om deze aangepaste tooloproep te koppelen aan een toolcall-uitvoer.	Yes
id	tekenreeks	De unieke ID van de custom tool-aanroep in het OpenAI-platform.	No
input	tekenreeks	De invoer voor de custom tool-aanroep die door het model wordt gegenereerd.	Yes
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat wordt aangeroepen.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
type	enum	Het type custom tool-oproep. Altijd custom_tool_call. Mogelijke waarden: custom_tool_call	Yes

OpenAI.OutputItemFileSearchToolCall

De resultaten van een aanroep van een zoekprogramma voor bestanden. Zie de zoekgids bestand voor meer informatie.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
id	tekenreeks	De unieke ID van de aanroep van het zoekprogramma voor bestanden.	Yes
queries	array van tekenreeksen	De query's die worden gebruikt om te zoeken naar bestanden.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
results	matrix van OpenAI.FileSearchToolCallResults		No
status	enum	De status van de aanroep van de bestandzoektool. Eén van in_progress, searching, incomplete of failed Mogelijke waarden: in_progress, searching, completed, , incompletefailed	Yes
type	enum	Het type van de aanroep van het zoekprogramma voor bestanden. Altijd file_search_call. Mogelijke waarden: file_search_call	Yes

OpenAI.OutputItemFunctionShellCall

Een hulpprogramma-aanroep waarmee een of meer shell-opdrachten in een beheerde omgeving worden uitgevoerd.

Name	Typ	Description	Required	Verstek
action	OpenAI.FunctionShellAction	Voer een shell-opdracht uit.	Yes
└opdrachten.	array van tekenreeksen		Yes
└max_output_length	OpenAI.integer (nullbaar)		Yes
└timeout_ms	OpenAI.integer (nullbaar)		Yes
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de entiteit die deze aanroep voor dit hulpprogramma heeft gemaakt.	No
id	tekenreeks	De unieke id van de aanroep van het shell-hulpprogramma. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	OpenAI.LocalShellCallStatus		Yes
type	enum	Het type item. Altijd shell_call. Mogelijke waarden: shell_call	Yes

OpenAI.OutputItemFunctionShellCallOutput

De uitvoer van een shell-hulpprogramma-aanroep die is verzonden.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
call_id	tekenreeks	De unieke ID van de shell-toolaanroep die door het model wordt gegenereerd.	Yes
gemaakt door	tekenreeks	De id van de actor die het item heeft gemaakt.	No
id	tekenreeks	De unieke id van de uitvoer van de shell-aanroep. Ingevuld wanneer dit item wordt geretourneerd via API.	Yes
max_output_length	OpenAI.integer (nullbaar)		Yes
output	matrix van OpenAI.FunctionShellCallOutputContent	Een matrix met uitvoerinhoud van shell-aanroep	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
type	enum	Het type uitvoer van de shell-aanroep. Altijd shell_call_output. Mogelijke waarden: shell_call_output	Yes

OpenAI.OutputItemFunctionToolCall

Een aanroep van een hulpprogramma om een functie uit te voeren. Zie de handleiding voor het aanroepen van functies voor meer informatie.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die moeten worden doorgegeven aan de functie.	Yes
call_id	tekenreeks	De unieke id van de functieaanroep die door het model is gegenereerd.	Yes
id	tekenreeks	De unieke id van de aanroep van het functiehulpmiddel.	No
naam	tekenreeks	De naam van de functie die moet worden uitgevoerd.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
type	enum	Het type aanroep van het functiehulpmiddel. Altijd function_call. Mogelijke waarden: function_call	Yes

OpenAI.OutputItemImageGenToolCall

Een aanvraag voor het genereren van afbeeldingen door het model.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
id	tekenreeks	De unieke ID van de beeldgeneratie-aanroep.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
result	tekenreeks (nullable)		Yes
status	enum	De status van de beeldgeneratieoproep. Mogelijke waarden: in_progress, completed, , generatingfailed	Yes
type	enum	Het type van de beeldgeneratie-oproep. Altijd image_generation_call. Mogelijke waarden: image_generation_call	Yes

OpenAI.OutputItemLocalShellToolCall

Een aanroep van een hulpprogramma om een opdracht uit te voeren in de lokale shell.

Name	Typ	Description	Required	Verstek
action	OpenAI.LocalShellExecAction	Voer een shell-opdracht uit op de server.	Yes
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
call_id	tekenreeks	De unieke ID van de aanroep van het lokale shell-hulpprogramma dat door het model is gegenereerd.	Yes
id	tekenreeks	De unieke ID van de lokale shell-oproep.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	enum	De status van de lokale shellcall. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type lokale schelproep. Altijd local_shell_call. Mogelijke waarden: local_shell_call	Yes

OpenAI.OutputItemMMcpApprovalRequest

Een verzoek om menselijke goedkeuring van een aanroep van een hulpmiddel.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
arguments	tekenreeks	Een JSON-tekenreeks met argumenten voor het hulpprogramma.	Yes
id	tekenreeks	De unieke ID van het goedkeuringsverzoek.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat moet worden uitgevoerd.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
server_label	tekenreeks	Het label van de MCP-server die de aanvraag indient.	Yes
type	enum	Het type item. Altijd mcp_approval_request. Mogelijke waarden: mcp_approval_request	Yes

OpenAI.OutputItemMcpListTools

Een lijst met hulpprogramma's die beschikbaar zijn op een MCP-server.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de lijst.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
server_label	tekenreeks	Het label van de MCP-server.	Yes
tools	matrix van OpenAI.MCPListToolsTool	De hulpprogramma's die beschikbaar zijn op de server.	Yes
type	enum	Het type item. Altijd mcp_list_tools. Mogelijke waarden: mcp_list_tools	Yes

OpenAI.OutputItemMcpToolCall

Een aanroep van een hulpprogramma op een MCP-server.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
approval_request_id	tekenreeks (nullable)		No
arguments	tekenreeks	Een JSON-tekenreeks van de argumenten die aan het hulpprogramma zijn doorgegeven.	Yes
fout	tekenreeks (nullable)		No
id	tekenreeks	De unieke ID van de toolcall.	Yes
naam	tekenreeks	De naam van het hulpprogramma dat is uitgevoerd.	Yes
output	tekenreeks (nullable)		No
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
server_label	tekenreeks	Het label van de MCP-server waarop het hulpprogramma wordt uitgevoerd.	Yes
status	OpenAI.MCPToolCallStatus		No
type	enum	Het type item. Altijd mcp_call. Mogelijke waarden: mcp_call	Yes

OpenAI.OutputItemOutputMessage

Een uitvoerbericht van het model.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
inhoud	matrix van OpenAI.OutputMessageContent	De inhoud van het uitvoerbericht.	Yes
id	tekenreeks	De unieke id van het uitvoerbericht.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
role	enum	De rol van het uitvoerbericht. Altijd assistant. Mogelijke waarden: assistant	Yes
status	enum	De status van de berichtinvoer. Een van in_progress, completedof incomplete. Ingevuld wanneer invoeritems worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	Yes
type	enum	Het type van het uitvoerbericht. Altijd message. Mogelijke waarden: output_message	Yes

OpenAI.OutputItemReasoningItem

Een beschrijving van de gedachtenketen die wordt gebruikt door een redeneringsmodel tijdens het genereren van een antwoord. Zorg ervoor dat je deze items in je in de Responses API opneemt voor volgende beurten van een gesprek als je handmatig context< managing context/c1> doet.

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
inhoud	matrix van OpenAI.ReasoningTextContent	Redeneren over tekstinhoud.	No
encrypted_content	tekenreeks (nullable)		No
id	tekenreeks	De unieke identificator van de inhoud van de redenering.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	enum	De status van het item. Een van in_progress, completedof incomplete. Ingevuld wanneer items worden geretourneerd via API. Mogelijke waarden: in_progress, completedincomplete	No
samenvatting	matrix van OpenAI.Summary	Samenvatting van redenering.	Yes
type	enum	Het type van het object. Altijd reasoning. Mogelijke waarden: reasoning	Yes

OpenAI.OutputItemType

Property	Value
Type	tekenreeks
waarden	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

De resultaten van een aanroep van een webzoektool. Zie de webzoekgids voor meer informatie.

Name	Typ	Description	Required	Verstek
action	OpenAI.WebSearchActionSearch of OpenAI.WebSearchActionOpenPage of OpenAI.WebSearchActionFind	Een object dat de specifieke actie beschrijft die in deze zoekopdracht is uitgevoerd. Bevat details over hoe het model het web heeft gebruikt (zoeken, open_page, zoeken).	Yes
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
id	tekenreeks	De unieke ID van de webzoektool wordt genoemd.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	enum	De status van de oproep van de webzoektool. Mogelijke waarden: in_progress, searching, , completedfailed	Yes
type	enum	Het type zoekhulpmiddel wordt genoemd. Altijd web_search_call. Mogelijke waarden: web_search_call	Yes

OpenAI.OutputMessageContent

Discriminator voor OpenAI.OutputMessageContent

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
output_text	OpenAI.OutputMessageContentOutputTextContent
refusal	OpenAI.OutputMessageContentRefusalContent

Name	Typ	Description	Required	Verstek
type	OpenAI.OutputMessageContentType		Yes

OpenAI.OutputMessageContentOutputTextContent

Een tekstuitvoer van het model.

Name	Typ	Description	Required	Verstek
annotations	matrix van OpenAI.Annotation	De annotaties van de tekstuitvoer.	Yes
logprobs	matrix van OpenAI.LogProb		No
tekst	tekenreeks	De tekstuitvoer van het model.	Yes
type	enum	Het type uitvoertekst. Altijd output_text. Mogelijke waarden: output_text	Yes

OpenAI.OutputMessageContentRefusalContent

Een weigering van het model.

Name	Typ	Description	Required	Verstek
weigering	tekenreeks	De weigeringsverklaring van het model.	Yes
type	enum	Het type weigering. Altijd refusal. Mogelijke waarden: refusal	Yes

OpenAI.OutputMessageContentType

Property	Value
Type	tekenreeks
waarden	output_text refusal

OpenAI.Prompt

Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.

Name	Typ	Description	Required	Verstek
id	tekenreeks	De unieke identificatie van de promptsjabloon die moet worden gebruikt.	Yes
variables	OpenAI.ResponsePromptVariables (nullable)	Optionele map met waarden om variabelen in uw te vervangen. prompt De vervangingswaarden kunnen tekenreeksen of andere waarden zijn Antwoordinvoertypen, zoals afbeeldingen of bestanden.	No
version	tekenreeks (nullable)		No

OpenAI.RankerVersionType

Property	Value
Type	tekenreeks
waarden	auto default-2024-11-15

OpenAI.RankingOptions

Name	Typ	Description	Required	Verstek
hybrid_search	OpenAI.HybridSearchOptions		No
└embedding_weight	OpenAI.numeriek	Het gewicht van de inbedding in de reciproke rangfusie.	Yes
└text_weight	OpenAI.numeriek	Het gewicht van de tekst in de wederzijdse rangordeningsfusie.	Yes
rangschikker	OpenAI.RankerVersionType		No
score-drempelwaarde	OpenAI.numeriek		No

OpenAI.Reasoning

Alleen GPT-5 en O-serie modellen Configuratieopties voor redeneermodellen.

Name	Typ	Description	Required	Verstek
effort	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
generate_summary	enum	Mogelijke waarden: auto, concisedetailed	No
samenvatting	enum	Mogelijke waarden: auto, concisedetailed	No

OpenAI.ReasoningEffort

Beperkt de inspanning voor redenering bij redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Het verminderen van redeneringsinspanningen kan leiden tot snellere antwoorden en minder tokens die worden gebruikt voor redenering in een antwoord.

• gpt-5.1 standaard op none, wat geen redeneren uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1.
• Alle modellen vóór gpt-5.1 de standaard gebruiken medium redeneerinspanning, en ondersteunen nonegeen .
• Het gpt-5-pro model gebruikt standaard (en ondersteunt alleen) high redeneerinspanning.
• xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.

Property	Value
Type	tekenreeks
Nullable	Yes
waarden	none minimal low medium high xhigh

OpenAI.ReasoningTextContent

Redenerende tekst uit het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De redeneringstekst van het model.	Yes
type	enum	Het type redeneringstekst. Altijd reasoning_text. Mogelijke waarden: reasoning_text	Yes

OpenAI.Response

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference (nul)		Yes
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
achtergrond	Booleaanse waarde (nullable)		No
voltooid_op	integer		No
gesprek	OpenAI.ConversationReference (nul-baar)	Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.	No
└─ id	tekenreeks	De unieke id van het gesprek waaraan dit antwoord is gekoppeld.	Yes
aangemaakt_op	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
fout	OpenAI.ResponseError (nullable)	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	Yes
└• bericht	tekenreeks	Een door mensen leesbare beschrijving van de fout.	Yes
id	tekenreeks	Unieke id voor dit antwoord.	Yes
incomplete_details	OpenAI.ResponseIncompleteDetails (nullbaar)		Yes
└─ reden	enum	Mogelijke waarden: max_output_tokens, content_filter	No
aanwijzingen	tekenreeks of matrix van OpenAI.InputItem		Yes
max_output_tokens	OpenAI.integer (nullbaar)		No
max_gereedschap_aanroepen	OpenAI.integer (nullbaar)		No
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
model	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
object	enum	Het objecttype van deze resource - altijd ingesteld op response. Mogelijke waarden: response	Yes
output	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de output matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de output matrix en ervan uitgaande dat het een assistant bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de output_text eigenschap te gebruiken waar ondersteund in SDK's.	Yes
output_text	tekenreeks (nullable)		No
parallel_gereedschapsoproepen	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
previous_response_id	tekenreeks (nullable)		No
prompt	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
reasoning	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└* inspanning	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
└─generate_summary	enum	Mogelijke waarden: auto, concisedetailed	No
Samenvatting └─	enum	Mogelijke waarden: auto, concisedetailed	No
safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
serviceniveau	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
status	enum	De status van de reactiegeneratie. Een van completed, failed in_progress, cancelled, queued of incomplete. Mogelijke waarden: completed, failed, in_progress, cancelled, , queuedincomplete	No
Temperatuur	OpenAI.numeriek (nullable)		No	1
tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
tool_choice	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
tools	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
top_logprobs	OpenAI.integer (nullbaar)		No
top_p	OpenAI.numeriek (nullable)		No	1
truncation	enum	Mogelijke waarden: auto, disabled	No
usage	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
user	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No

OpenAI.ResponseAudioDeltaEvent

Verzonden wanneer er sprake is van een gedeeltelijk audio-antwoord.

Name	Typ	Description	Required	Verstek
delta	tekenreeks	Een segment van met Base64 gecodeerde audiobytes voor antwoorden.	Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.audio.delta. Mogelijke waarden: response.audio.delta	Yes

OpenAI.ResponseAudioDoneEvent

Verzonden wanneer het audio-antwoord is voltooid.

Name	Typ	Description	Required	Verstek
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.audio.done. Mogelijke waarden: response.audio.done	Yes

OpenAI.ResponseAudioTranscriptDeltaEvent

Verzonden wanneer er een gedeeltelijke transcriptie van audio is.

Name	Typ	Description	Required	Verstek
delta	tekenreeks	Het gedeeltelijke transcript van het audioantwoord.	Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.audio.transcript.delta. Mogelijke waarden: response.audio.transcript.delta	Yes

OpenAI.ResponseAudioTranscriptDoneEvent

Uitgezonden wanneer het volledige audiotranscript is voltooid.

Name	Typ	Description	Required	Verstek
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.audio.transcript.done. Mogelijke waarden: response.audio.transcript.done	Yes

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

Verzonden wanneer een gedeeltelijk codefragment wordt gestreamd door de code-interpreter.

Name	Typ	Description	Required	Verstek
delta	tekenreeks	Het gedeeltelijke codefragment dat wordt gestreamd door de code-interpreter.	Yes
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.code_interpreter_call_code.delta. Mogelijke waarden: response.code_interpreter_call_code.delta	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

Verzonden wanneer het codefragment is voltooid door de code-interpreter.

Name	Typ	Description	Required	Verstek
code	tekenreeks	De uiteindelijke uitvoer van het codefragment door de code-interpreter.	Yes
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.code_interpreter_call_code.done. Mogelijke waarden: response.code_interpreter_call_code.done	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

Verzonden wanneer de aanroep van de code-interpreter is voltooid.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.code_interpreter_call.completed. Mogelijke waarden: response.code_interpreter_call.completed	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

Verzonden wanneer een aanroep van een code-interpreter wordt uitgevoerd.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.code_interpreter_call.in_progress. Mogelijke waarden: response.code_interpreter_call.in_progress	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

Verzonden wanneer de code-interpreter het codefragment actief interpreteert.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke identificatie van het aanroepitem van het code-interpreter-hulpprogramma.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.code_interpreter_call.interpreting. Mogelijke waarden: response.code_interpreter_call.interpreting	Yes

OpenAI.ResponseCompletedEvent

Verzonden wanneer het modelantwoord is voltooid.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└agent_reference	AgentReference (nul)	De agent die voor dit antwoord wordt gebruikt	Yes
└* achtergrond	Booleaanse waarde (nullable)		No
└completed_at	geheel getal (nullable)		No
└gesprek.	OpenAI.ConversationReference (nul-baar)	Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.	No
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError (nullable)	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails (nullbaar)		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem (nullable)		Yes
└─max_output_tokens	OpenAI.integer (nullbaar)		No
└─ max_tool_calls	OpenAI.integer (nullbaar)		No
└* metagegevens	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op response. Mogelijke waarden: response	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de output matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de output matrix en ervan uitgaande dat het een assistant bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de output_text eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks (nullable)		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks (nullable)		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
└prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
└* redenering	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
└service_tier	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
└─ Status	enum	De status van de reactiegeneratie. Een van completed, failed in_progress, cancelled, queued of incomplete. Mogelijke waarden: completed, failed, in_progress, cancelled, , queuedincomplete	No
└─ temperatuur	OpenAI.numeriek (nullable)		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	OpenAI.integer (nullbaar)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
└─ afkapping	enum	Mogelijke waarden: auto, disabled	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.completed. Mogelijke waarden: response.completed	Yes

OpenAI.ResponseContentPartAddedEvent

Verzonden wanneer een nieuw inhoudsonderdeel wordt toegevoegd.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
item_id	tekenreeks	De id van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Yes
output_index	OpenAI.integer		Yes
deel	OpenAI.OutputContent		Yes
└type.	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.content_part.added. Mogelijke waarden: response.content_part.added	Yes

OpenAI.ResponseContentPartDoneEvent

Verzonden wanneer een inhoudsonderdeel is voltooid.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
item_id	tekenreeks	De id van het uitvoeritem waaraan het inhoudsonderdeel is toegevoegd.	Yes
output_index	OpenAI.integer		Yes
deel	OpenAI.OutputContent		Yes
└type.	OpenAI.OutputContentType		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.content_part.done. Mogelijke waarden: response.content_part.done	Yes

OpenAI.ResponseCreatedEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord wordt gecreëerd.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└agent_reference	AgentReference (nul)	De agent die voor dit antwoord wordt gebruikt	Yes
└* achtergrond	Booleaanse waarde (nullable)		No
└completed_at	geheel getal (nullable)		No
└gesprek.	OpenAI.ConversationReference (nul-baar)	Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.	No
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError (nullable)	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails (nullbaar)		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem (nullable)		Yes
└─max_output_tokens	OpenAI.integer (nullbaar)		No
└─ max_tool_calls	OpenAI.integer (nullbaar)		No
└* metagegevens	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op response. Mogelijke waarden: response	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de output matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de output matrix en ervan uitgaande dat het een assistant bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de output_text eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks (nullable)		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks (nullable)		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
└prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
└* redenering	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
└service_tier	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
└─ Status	enum	De status van de reactiegeneratie. Een van completed, failed in_progress, cancelled, queued of incomplete. Mogelijke waarden: completed, failed, in_progress, cancelled, , queuedincomplete	No
└─ temperatuur	OpenAI.numeriek (nullable)		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	OpenAI.integer (nullbaar)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
└─ afkapping	enum	Mogelijke waarden: auto, disabled	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.created. Mogelijke waarden: response.created	Yes

OpenAI.ResponseCustomToolCallInputDeltaEvent

Gebeurtenis die een delta vertegenwoordigt (gedeeltelijke update) voor de invoer van een aangepaste tool-aanroep.

Name	Typ	Description	Required	Verstek
delta	tekenreeks	De incrementele invoergegevens (delta) voor de aanroep van het aangepaste hulpprogramma.	Yes
item_id	tekenreeks	Unieke id voor het API-item dat aan deze gebeurtenis is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	De id van het gebeurtenistype. Mogelijke waarden: response.custom_tool_call_input.delta	Yes

OpenAI.ResponseCustomToolCallInputDoneEvent

Gebeurtenis die aangeeft dat de invoer voor een aangepaste tool-aanroep is voltooid.

Name	Typ	Description	Required	Verstek
input	tekenreeks	De volledige invoergegevens voor de aanroep van het aangepaste hulpprogramma.	Yes
item_id	tekenreeks	Unieke id voor het API-item dat aan deze gebeurtenis is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	De id van het gebeurtenistype. Mogelijke waarden: response.custom_tool_call_input.done	Yes

OpenAI.ResponseError

Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.

Name	Typ	Description	Required	Verstek
code	OpenAI.ResponseErrorCode	De foutcode voor het antwoord.	Yes
message	tekenreeks	Een door mensen leesbare beschrijving van de fout.	Yes

OpenAI.ResponseErrorCode

De foutcode voor het antwoord.

Property	Value
Type	tekenreeks
waarden	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

Verzonden wanneer er een fout optreedt.

Name	Typ	Description	Required	Verstek
code	tekenreeks (nullable)		Yes
message	tekenreeks	Het foutbericht.	Yes
param	tekenreeks (nullable)		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd error. Mogelijke waarden: error	Yes

OpenAI.ResponseFailedEvent

Een gebeurtenis die wordt verzonden wanneer een antwoord mislukt.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└agent_reference	AgentReference (nul)	De agent die voor dit antwoord wordt gebruikt	Yes
└* achtergrond	Booleaanse waarde (nullable)		No
└completed_at	geheel getal (nullable)		No
└gesprek.	OpenAI.ConversationReference (nul-baar)	Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.	No
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError (nullable)	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails (nullbaar)		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem (nullable)		Yes
└─max_output_tokens	OpenAI.integer (nullbaar)		No
└─ max_tool_calls	OpenAI.integer (nullbaar)		No
└* metagegevens	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op response. Mogelijke waarden: response	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de output matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de output matrix en ervan uitgaande dat het een assistant bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de output_text eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks (nullable)		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks (nullable)		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
└prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
└* redenering	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
└service_tier	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
└─ Status	enum	De status van de reactiegeneratie. Een van completed, failed in_progress, cancelled, queued of incomplete. Mogelijke waarden: completed, failed, in_progress, cancelled, , queuedincomplete	No
└─ temperatuur	OpenAI.numeriek (nullable)		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	OpenAI.integer (nullbaar)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
└─ afkapping	enum	Mogelijke waarden: auto, disabled	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.failed. Mogelijke waarden: response.failed	Yes

OpenAI.ResponseFileSearchCallCompletedEvent

Verzonden wanneer een aanroep voor het zoeken van bestanden is voltooid (resultaten gevonden).

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De ID van het uitvoeritem waarmee de aanroep voor het zoeken van bestanden wordt gestart.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.file_search_call.completed. Mogelijke waarden: response.file_search_call.completed	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

Verzonden wanneer een aanroep voor het zoeken van bestanden wordt gestart.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De ID van het uitvoeritem waarmee de aanroep voor het zoeken van bestanden wordt gestart.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.file_search_call.in_progress. Mogelijke waarden: response.file_search_call.in_progress	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

Verzonden wanneer er momenteel wordt gezocht in een bestand.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De ID van het uitvoeritem waarmee de aanroep voor het zoeken van bestanden wordt gestart.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.file_search_call.searching. Mogelijke waarden: response.file_search_call.searching	Yes

OpenAI.ResponseFormatJsonObject

JSON-objectantwoordindeling. Een oudere methode voor het genereren van JSON-antwoorden. Het gebruik json_schema wordt aanbevolen voor modellen die dit ondersteunen. Houd er rekening mee dat het model geen JSON genereert zonder een systeem- of gebruikersbericht waarin het wordt geïnstrueerd om dit te doen.

Name	Typ	Description	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd json_object. Mogelijke waarden: json_object	Yes

OpenAI.ResponseFormatJsonSchema

JSON Schema-antwoordindeling. Wordt gebruikt om gestructureerde JSON-antwoorden te genereren. Meer informatie over gestructureerde uitvoer.

Name	Typ	Description	Required	Verstek
JSON-schema	OpenAI.ResponseFormatJsonSchemaJsonSchemaJsonSchema		Yes
└─ Beschrijving	tekenreeks		No
└─naam	tekenreeks		Yes
└─ schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	No
└─ strikt	Booleaanse waarde (nullable)		No
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd json_schema. Mogelijke waarden: json_schema	Yes

OpenAI.ResponseFormatJsonSchemaJsonSchemaJsonSchema

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks		No
naam	tekenreeks		Yes
schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	No
streng	Booleaanse waarde (nullable)		No

OpenAI.ResponseFormatJsonSchemaSchema

Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.

Type: objecten

OpenAI.ResponseFormatText

De standaard antwoordindeling. Wordt gebruikt om tekstreacties te genereren.

Name	Typ	Description	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd text. Mogelijke waarden: text	Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

Verzonden wanneer er sprake is van een delta voor gedeeltelijke functie-aanroepargumenten.

Name	Typ	Description	Required	Verstek
delta	tekenreeks	De toegevoegde delta voor de argumenten van de functieaanroep.	Yes
item_id	tekenreeks	De id van het uitvoeritem waaraan de delta voor functie-aanroepargumenten wordt toegevoegd.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.function_call_arguments.delta. Mogelijke waarden: response.function_call_arguments.delta	Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

Verzonden wanneer argumenten voor functieoproep zijn voltooid.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	De functieoproep-argumenten.	Yes
item_id	tekenreeks	De id van het item.	Yes
naam	tekenreeks	De naam van de bijeenkomst die werd genoemd.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Mogelijke waarden: response.function_call_arguments.done	Yes

OpenAI.ResponseImageGenCallCompletedEvent

Uitgevoerd wanneer de aanroep van het hulpprogramma voor het genereren van afbeeldingen is voltooid en de uiteindelijke afbeelding beschikbaar is.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke identificatie van het item voor het genereren van afbeeldingen dat verwerkt wordt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.completed'. Mogelijke waarden: response.image_generation_call.completed	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

Wordt gegenereerd wanneer een afbeeldingsgeneratiehulpprogramma actief een afbeelding genereert (tussenstatus).

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke identificatie van het item voor het genereren van afbeeldingen dat verwerkt wordt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.generating'. Mogelijke waarden: response.image_generation_call.generating	Yes

OpenAI.ResponseImageGenCallInProgressEvent

Verzonden wanneer er een aanroep van het hulpprogramma voor het genereren van afbeeldingen wordt uitgevoerd.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke identificatie van het item voor het genereren van afbeeldingen dat verwerkt wordt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.in_progress'. Mogelijke waarden: response.image_generation_call.in_progress	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

Verzonden wanneer een gedeeltelijke afbeelding beschikbaar is tijdens beeldgeneratie streaming.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke identificatie van het item voor het genereren van afbeeldingen dat verwerkt wordt.	Yes
output_index	OpenAI.integer		Yes
partial_image_b64	tekenreeks	Met Base64 gecodeerde gedeeltelijke afbeeldingsgegevens, geschikt voor rendering als afbeelding.	Yes
partial_image_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.image_generation_call.partial_image'. Mogelijke waarden: response.image_generation_call.partial_image	Yes

OpenAI.ResponseInProgressEvent

Uitgezonden wanneer het antwoord in uitvoering is.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└agent_reference	AgentReference (nul)	De agent die voor dit antwoord wordt gebruikt	Yes
└* achtergrond	Booleaanse waarde (nullable)		No
└completed_at	geheel getal (nullable)		No
└gesprek.	OpenAI.ConversationReference (nul-baar)	Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.	No
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError (nullable)	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails (nullbaar)		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem (nullable)		Yes
└─max_output_tokens	OpenAI.integer (nullbaar)		No
└─ max_tool_calls	OpenAI.integer (nullbaar)		No
└* metagegevens	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op response. Mogelijke waarden: response	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de output matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de output matrix en ervan uitgaande dat het een assistant bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de output_text eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks (nullable)		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks (nullable)		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
└prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
└* redenering	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
└service_tier	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
└─ Status	enum	De status van de reactiegeneratie. Een van completed, failed in_progress, cancelled, queued of incomplete. Mogelijke waarden: completed, failed, in_progress, cancelled, , queuedincomplete	No
└─ temperatuur	OpenAI.numeriek (nullable)		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	OpenAI.integer (nullbaar)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
└─ afkapping	enum	Mogelijke waarden: auto, disabled	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.in_progress. Mogelijke waarden: response.in_progress	Yes

OpenAI.ResponseIncompleteDetails

Name	Typ	Description	Required	Verstek
reden	enum	Mogelijke waarden: max_output_tokens, content_filter	No

OpenAI.ResponseIncompleteEvent

Een gebeurtenis die wordt gegenereerd wanneer een reactie eindigt als onvolledig.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└agent_reference	AgentReference (nul)	De agent die voor dit antwoord wordt gebruikt	Yes
└* achtergrond	Booleaanse waarde (nullable)		No
└completed_at	geheel getal (nullable)		No
└gesprek.	OpenAI.ConversationReference (nul-baar)	Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.	No
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError (nullable)	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails (nullbaar)		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem (nullable)		Yes
└─max_output_tokens	OpenAI.integer (nullbaar)		No
└─ max_tool_calls	OpenAI.integer (nullbaar)		No
└* metagegevens	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op response. Mogelijke waarden: response	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de output matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de output matrix en ervan uitgaande dat het een assistant bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de output_text eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks (nullable)		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks (nullable)		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
└prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
└* redenering	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
└service_tier	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
└─ Status	enum	De status van de reactiegeneratie. Een van completed, failed in_progress, cancelled, queued of incomplete. Mogelijke waarden: completed, failed, in_progress, cancelled, , queuedincomplete	No
└─ temperatuur	OpenAI.numeriek (nullable)		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	OpenAI.integer (nullbaar)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
└─ afkapping	enum	Mogelijke waarden: auto, disabled	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.incomplete. Mogelijke waarden: response.incomplete	Yes

OpenAI.ResponseLogProb

Een logprob is de logaritmische kans die het model toewijst aan het produceren van een bepaald token op een bepaalde positie in de reeks. Minder negatieve (hogere) logprobwaarden geven een groter modelvertrouwen in die tokenkeuze aan.

Name	Typ	Description	Required	Verstek
logprob	OpenAI.numeriek		Yes
token	tekenreeks	Een mogelijk teksttoken.	Yes
top_logprobs	matrix van OpenAI.ResponseLogProbTopLogprobs	De logboekkans van de 20 meest waarschijnlijke tokens.	No

OpenAI.ResponseLogProbTopLogprobs

Name	Typ	Description	Required	Verstek
logprob	OpenAI.numeriek		No
token	tekenreeks		No

OpenAI.ResponseMCPCallArgumentsDeltaEvent

Verzonden wanneer er een delta (gedeeltelijke update) is voor de argumenten van een MCP-hulpprogrammaaanroep.

Name	Typ	Description	Required	Verstek
delta	tekenreeks	Een JSON-tekenreeks met de gedeeltelijke update van de argumenten voor de aanroep van het MCP-hulpprogramma.	Yes
item_id	tekenreeks	De unieke id van het oproepitem van het MCP-hulpprogramma dat wordt verwerkt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call_arguments.delta'. Mogelijke waarden: response.mcp_call_arguments.delta	Yes

OpenAI.ResponseMCPCallArgumentsDoneEvent

Verzonden wanneer de argumenten voor een MCP-hulpprogrammaaanroep zijn voltooid.

Name	Typ	Description	Required	Verstek
arguments	tekenreeks	Een JSON-tekenreeks met de voltooide argumenten voor de MCP-hulpprogramma-aanroep.	Yes
item_id	tekenreeks	De unieke id van het oproepitem van het MCP-hulpprogramma dat wordt verwerkt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call_arguments.done'. Mogelijke waarden: response.mcp_call_arguments.done	Yes

OpenAI.ResponseMCPCallCompletedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is voltooid.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het MCP-hulpprogramma oproepitem dat is voltooid.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.completed'. Mogelijke waarden: response.mcp_call.completed	Yes

OpenAI.ResponseMCPCallFailedEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep is mislukt.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat is mislukt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.failed'. Mogelijke waarden: response.mcp_call.failed	Yes

OpenAI.ResponseMCPCallInProgressEvent

Verzonden wanneer een MCP-hulpprogrammaaanroep wordt uitgevoerd.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De unieke id van het oproepitem van het MCP-hulpprogramma dat wordt verwerkt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_call.in_progress'. Mogelijke waarden: response.mcp_call.in_progress	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

Uitgezonden wanneer de lijst met beschikbare MCP-hulpprogramma's succesvol is opgehaald.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat deze uitvoer heeft geproduceerd.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.completed'. Mogelijke waarden: response.mcp_list_tools.completed	Yes

OpenAI.ResponseMCPListToolsFailedEvent

Verzonden wanneer de poging om beschikbare MCP-hulpprogramma's weer te geven is mislukt.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat is mislukt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.failed'. Mogelijke waarden: response.mcp_list_tools.failed	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

Verzonden wanneer het systeem bezig is met het ophalen van de lijst met beschikbare MCP-hulpprogramma's.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het MCP-hulpprogramma-aanroepitem dat wordt verwerkt.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.mcp_list_tools.in_progress'. Mogelijke waarden: response.mcp_list_tools.in_progress	Yes

OpenAI.ResponseOutputItemAddedEvent

Verzonden wanneer een nieuw uitvoeritem wordt toegevoegd.

Name	Typ	Description	Required	Verstek
item	OpenAI.OutputItem		Yes
└agent_reference	AgentReference	De agent die het item heeft gemaakt.	No
└response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
└type.	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.output_item.added. Mogelijke waarden: response.output_item.added	Yes

OpenAI.ResponseOutputItemDoneEvent

Verzonden wanneer een uitvoeritem is gemarkeerd als voltooid.

Name	Typ	Description	Required	Verstek
item	OpenAI.OutputItem		Yes
└agent_reference	AgentReference	De agent die het item heeft gemaakt.	No
└response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
└type.	OpenAI.OutputItemType		Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.output_item.done. Mogelijke waarden: response.output_item.done	Yes

OpenAI.ResponseOutputTextAnnotationAddedEvent

Verzonden wanneer een aantekening wordt toegevoegd aan de inhoud van de uitvoertekst.

Name	Typ	Description	Required	Verstek
annotation	OpenAI.Annotatie	Een aantekening die van toepassing is op een reeks uitvoerteksten.	Yes
└type.	OpenAI.AnnotationType		Yes
annotation_index	OpenAI.integer		Yes
content_index	OpenAI.integer		Yes
item_id	tekenreeks	De unieke id van het item waaraan de aantekening wordt toegevoegd.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.output_text.annotation.added'. Mogelijke waarden: response.output_text.annotation.added	Yes

OpenAI.ResponsePromptVariables

Optionele lijst van waardes om variabelen in uw prompt te vervangen. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.

Type: objecten

OpenAI.ResponseQueuedEvent

Wordt uitgezonden wanneer een antwoord in de wachtrij staat en op verwerking wacht.

Name	Typ	Description	Required	Verstek
antwoord	OpenAI.Response		Yes
└agent_reference	AgentReference (nul)	De agent die voor dit antwoord wordt gebruikt	Yes
└* achtergrond	Booleaanse waarde (nullable)		No
└completed_at	geheel getal (nullable)		No
└gesprek.	OpenAI.ConversationReference (nul-baar)	Het gesprek waartoe dit antwoord behoort. Invoeritems en uitvoeritems uit dit antwoord zijn automatisch toegevoegd aan dit gesprek.	No
└ created_at	integer	Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt.	Yes
└─ fout	OpenAI.ResponseError (nullable)	Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.	Yes
└─ id	tekenreeks	Unieke id voor dit antwoord.	Yes
└onvolledige_details	OpenAI.ResponseIncompleteDetails (nullbaar)		Yes
└─ instructies	tekenreeks of matrix van OpenAI.InputItem (nullable)		Yes
└─max_output_tokens	OpenAI.integer (nullbaar)		No
└─ max_tool_calls	OpenAI.integer (nullbaar)		No
└* metagegevens	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
└model.	tekenreeks	De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord.	No
└─ object	enum	Het objecttype van deze resource - altijd ingesteld op response. Mogelijke waarden: response	Yes
└─ uitvoer	matrix van OpenAI.OutputItem	Een reeks met inhoudsitems die door het model worden gegenereerd. - De lengte en volgorde van items in de output matrix is afhankelijk bij het antwoord van het model. - In plaats van toegang te krijgen tot het eerste item in de output matrix en ervan uitgaande dat het een assistant bericht is met de inhoud die is gegenereerd door het model kunt u overwegen om de output_text eigenschap te gebruiken waar ondersteund in SDK's.	Yes
└output_text	tekenreeks (nullable)		No
└parallel_tool_calls	boolean	Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren.	Yes	True
└vorig_antwoord_id	tekenreeks (nullable)		No
└prompt.	OpenAI.Prompt	Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.	No
└prompt_cache_key	tekenreeks	Wordt door OpenAI gebruikt om reacties op vergelijkbare aanvragen in de cache op te slaan om de slagsnelheid van uw cache te optimaliseren. Vervangt het user veld. Meer informatie.	No
└prompt_cache_retention	enum	Mogelijke waarden: in-memory, 24h	No
└* redenering	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└safety_identifier	tekenreeks	Een stabiele id die wordt gebruikt om gebruikers van uw toepassing te detecteren die het gebruiksbeleid van OpenAI kunnen schenden. De id's moeten een tekenreeks zijn die elke gebruiker uniek identificeert. We raden u aan hun gebruikersnaam of e-mailadres te hashen om te voorkomen dat u ons identificeert. Meer informatie.	No
└service_tier	OpenAI.ServiceTier	Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag. - Als deze optie is ingesteld op 'automatisch', wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'. - Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en prestaties voor het geselecteerde model. - Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. - Als dit niet is ingesteld, is het standaardgedrag automatisch. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.	No
└─ Status	enum	De status van de reactiegeneratie. Een van completed, failed in_progress, cancelled, queued of incomplete. Mogelijke waarden: completed, failed, in_progress, cancelled, , queuedincomplete	No
└─ temperatuur	OpenAI.numeriek (nullable)		No	1
└─ tekst	OpenAI.ResponseTextParam	Configuratieopties voor een tekstantwoord van het model. Kan duidelijk zijn tekst of gestructureerde JSON-gegevens. Meer informatie: - tekstinvoer en -uitvoer - Gestructureerde Outputs	No
└─ gereedschapskeuze	OpenAI.ToolChoiceOptions of OpenAI.ToolChoiceParam		No
└─ hulpmiddelen	OpenAI.ToolsArray	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's: - Ingebouwde hulpprogramma's: Hulpprogramma's die door OpenAI worden geleverd en de functionaliteit uitbreiden. De mogelijkheden van het model, zoals webzoeken of bestandszoek. Meer informatie over ingebouwde tools. - MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors, zoals Google Drive en SharePoint. Meer informatie over MCP-tools. - Functie-aanroepen (aangepaste hulpprogramma's): Functies die door u zijn gedefinieerd, het model in staat stellen om uw eigen code aan te roepen met sterk getypte argumenten en uitvoer. Meer informatie over functie aanroepen. U kunt ook aangepaste hulpprogramma's om uw eigen code aan te roepen.	No
└ top_logprobs	OpenAI.integer (nullbaar)		No
└─ top_p	OpenAI.numeriek (nullable)		No	1
└─ afkapping	enum	Mogelijke waarden: auto, disabled	No
└─ gebruik	OpenAI.ResponseUsage	Vertegenwoordigt tokengebruiksgegevens, inclusief invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.	No
└─ gebruiker	tekenreeks (afgeschaft)	Dit veld wordt vervangen door safety_identifier en prompt_cache_key. Gebruik prompt_cache_key in plaats daarvan om cachingoptimalisaties te onderhouden. Een stabiele id voor uw eindgebruikers. Wordt gebruikt om het aantal cachetreffers te verhogen door vergelijkbare aanvragen beter te bucketen en om OpenAI te helpen misbruik te detecteren en te voorkomen. Meer informatie.	No
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd 'response.queued'. Mogelijke waarden: response.queued	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

Verzonden wanneer een nieuw redeneringssamenvattingsonderdeel wordt toegevoegd.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het item waarmee dit overzichtsonderdeel is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
deel	OpenAI.ResponseReasoningSummaryPartAddedEventPart		Yes
└─ tekst	tekenreeks		Yes
└type.	enum	Mogelijke waarden: summary_text	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.reasoning_summary_part.added. Mogelijke waarden: response.reasoning_summary_part.added	Yes

OpenAI.ResponseReasoningSummaryPartAddedEventPart

Name	Typ	Description	Required	Verstek
tekst	tekenreeks		Yes
type	enum	Mogelijke waarden: summary_text	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

Verzonden wanneer een samenvattingsonderdeel met redenering is voltooid.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het item waarmee dit overzichtsonderdeel is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
deel	OpenAI.ResponseReasoningSummaryPartDoneEventPart		Yes
└─ tekst	tekenreeks		Yes
└type.	enum	Mogelijke waarden: summary_text	Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.reasoning_summary_part.done. Mogelijke waarden: response.reasoning_summary_part.done	Yes

OpenAI.ResponseReasoningSummaryPartDoneEventPart

Name	Typ	Description	Required	Verstek
tekst	tekenreeks		Yes
type	enum	Mogelijke waarden: summary_text	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

Verzonden wanneer een delta wordt toegevoegd aan een redeneringssamenvattingstekst.

Name	Typ	Description	Required	Verstek
delta	tekenreeks	De tekst delta die is toegevoegd aan de samenvatting.	Yes
item_id	tekenreeks	De ID van het item waarmee deze delta van de samenvattingstekst is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.reasoning_summary_text.delta. Mogelijke waarden: response.reasoning_summary_text.delta	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

Verzonden wanneer een samenvattingstekst met redenering is voltooid.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	De id van het item waarmee deze samenvattingstekst is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
summary_index	OpenAI.integer		Yes
tekst	tekenreeks	De volledige tekst van de voltooide redeneringssamenvatting.	Yes
type	enum	Het type gebeurtenis. Altijd response.reasoning_summary_text.done. Mogelijke waarden: response.reasoning_summary_text.done	Yes

OpenAI.ResponseReasoningTextDeltaEvent

Verzonden wanneer een delta wordt toegevoegd aan een redeneringstekst.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
delta	tekenreeks	De tekst delta die is toegevoegd aan de redeneringsinhoud.	Yes
item_id	tekenreeks	De id van het item waarmee deze redeneringstekst delta is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.reasoning_text.delta. Mogelijke waarden: response.reasoning_text.delta	Yes

OpenAI.ResponseReasoningTextDoneEvent

Verzonden wanneer een redeneringstekst is voltooid.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
item_id	tekenreeks	De id van het item waarmee deze redeneringstekst is gekoppeld.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tekst	tekenreeks	De volledige tekst van de voltooide redeneringsinhoud.	Yes
type	enum	Het type gebeurtenis. Altijd response.reasoning_text.done. Mogelijke waarden: response.reasoning_text.done	Yes

OpenAI.ResponseRefusalDeltaEvent

Verzonden wanneer er sprake is van een gedeeltelijke weigeringstekst.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
delta	tekenreeks	De weigeringstekst die wordt toegevoegd.	Yes
item_id	tekenreeks	De id van het uitvoeritem waaraan de weigeringstekst wordt toegevoegd.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.refusal.delta. Mogelijke waarden: response.refusal.delta	Yes

OpenAI.ResponseRefusalDoneEvent

Verzonden wanneer de weigeringstekst is voltooid.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
item_id	tekenreeks	De id van het uitvoeritem waarvan de weigeringstekst is voltooid.	Yes
output_index	OpenAI.integer		Yes
weigering	tekenreeks	De afgeronde weigeringstekst	Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.refusal.done. Mogelijke waarden: response.refusal.done	Yes

OpenAI.ResponseStreamOptions

Opties voor streamingreacties. Stel dit alleen in wanneer u instelt stream: true.

Name	Typ	Description	Required	Verstek
include_obfuscation	boolean	Wanneer waar, wordt de verdoezeling van stromen ingeschakeld. Stream-verdoofing voegt toe willekeurige tekens naar een obfuscation veld bij streaming-deltagebeurtenissen naar normaliseer nettoladinggrootten als een beperking voor bepaalde side-channel-aanvallen. Deze verborgen velden zijn standaard opgenomen, maar voeg een kleine hoeveelheid toe overhead naar de gegevensstroom. U kunt instellen include_obfuscation op false om te optimaliseren voor bandbreedte als u de netwerkkoppelingen tussen uw toepassing en de OpenAI-API.	No

OpenAI.ResponseTextDeltaEvent

Verzonden wanneer er een extra tekstdelta is.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
delta	tekenreeks	De tekstdelta die is toegevoegd.	Yes
item_id	tekenreeks	De ID van het uitvoerelement waaraan de tekstdelta is toegevoegd.	Yes
logprobs	matrix van OpenAI.ResponseLogProb	De logboekkans van de tokens in de delta.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.output_text.delta. Mogelijke waarden: response.output_text.delta	Yes

OpenAI.ResponseTextDoneEvent

Verzonden wanneer tekstinhoud is voltooid.

Name	Typ	Description	Required	Verstek
content_index	OpenAI.integer		Yes
item_id	tekenreeks	De id van het uitvoeritem waarvan de tekstinhoud is voltooid.	Yes
logprobs	matrix van OpenAI.ResponseLogProb	De logboekkans van de tokens in de delta.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
tekst	tekenreeks	De inhoud van de tekst die is voltooid.	Yes
type	enum	Het type gebeurtenis. Altijd response.output_text.done. Mogelijke waarden: response.output_text.done	Yes

OpenAI.ResponseTextParam

Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn. Meer informatie:

• Tekstinvoer en -uitvoer
• Gestructureerde Uitvoeren

Name	Typ	Description	Required	Verstek
format	OpenAI.TextResponseFormatConfiguration	Een object dat de indeling aangeeft die het model moet uitvoeren. { "type": "json_schema" } Configureren maakt gestructureerde uitvoer mogelijk, dit zorgt ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie in de De standaardindeling is { "type": "text" } zonder extra opties. *Niet aanbevolen voor gpt-4o en nieuwere modellen:** Instellen van { "type": "json_object" } schakelt de oudere JSON-modus in, die zorgt ervoor dat het bericht dat het model genereert geldige JSON is. Het gebruiken van json_schema heeft de voorkeur voor modellen die dit ondersteunen.	No
langdradigheid	OpenAI.Verbosity	Beperkt de omvangrijkheid van het antwoord van het model. Lagere waarden resulteren in beknoptere antwoorden, terwijl hogere waarden leiden tot uitgebreidere antwoorden. Momenteel ondersteunde waarden zijn low, mediumen high.	No

OpenAI.ResponseUsage

Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.

Name	Typ	Description	Required	Verstek
input_tokens	OpenAI.integer		Yes
input_tokens_details	OpenAI.ResponseUsageInputTokensDetails		Yes
└ cached_tokens	OpenAI.integer		Yes
output_tokens	OpenAI.integer		Yes
output_tokens_details	OpenAI.ResponseUsageOutputTokensDetails		Yes
└─ redeneertokens	OpenAI.integer		Yes
total_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageInputTokensDetails

Name	Typ	Description	Required	Verstek
cached_tokens	OpenAI.integer		Yes

OpenAI.ResponseUsageOutputTokensDetails

Name	Typ	Description	Required	Verstek
redeneringssymbolen	OpenAI.integer		Yes

OpenAI.ResponseWebSearchCallCompletedEvent

Verzonden wanneer een webzoekopdracht is voltooid.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.web_search_call.completed. Mogelijke waarden: response.web_search_call.completed	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

Verzonden wanneer een webzoekopdracht wordt gestart.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.web_search_call.in_progress. Mogelijke waarden: response.web_search_call.in_progress	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

Verzonden wanneer een webzoekopdracht wordt uitgevoerd.

Name	Typ	Description	Required	Verstek
item_id	tekenreeks	Unieke id voor het uitvoeritem dat is gekoppeld aan de webzoekopdracht.	Yes
output_index	OpenAI.integer		Yes
sequence_number	OpenAI.integer		Yes
type	enum	Het type gebeurtenis. Altijd response.web_search_call.searching. Mogelijke waarden: response.web_search_call.searching	Yes

OpenAI.Screenshot

Een schermopnameactie.

Name	Typ	Description	Required	Verstek
type	enum	Hiermee geeft u het gebeurtenistype. Voor een actie om een schermafbeelding te maken, is deze eigenschap belangrijk. altijd ingesteld op screenshot. Mogelijke waarden: screenshot	Yes

OpenAI.Scroll

Een scrollactie.

Name	Typ	Description	Required	Verstek
scroll_x	OpenAI.integer		Yes
scroll_y	OpenAI.integer		Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een schuifactie is deze eigenschap altijd ingesteld op scroll. Mogelijke waarden: scroll	Yes
x	OpenAI.integer		Yes
y	OpenAI.integer		Yes

OpenAI.SearchContextSize

Property	Value
Type	tekenreeks
waarden	low medium high

OpenAI.ServiceTier

Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag.

• Als deze optie is ingesteld op Automatisch, wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt de Project 'standaard'.
• Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en -prestaties voor het geselecteerde model.
• Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag.
• Als dit niet is ingesteld, is het standaardgedrag 'automatisch'. Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.

Property	Value
Type	tekenreeks
Nullable	Yes
waarden	auto default flex scale priority

OpenAI.SpecificApplyPatchParam

Hiermee dwingt u het model om het apply_patch hulpprogramma aan te roepen bij het uitvoeren van een hulpprogramma-aanroep.

Name	Typ	Description	Required	Verstek
type	enum	Het hulpprogramma dat moet worden aangeroepen. Altijd apply_patch. Mogelijke waarden: apply_patch	Yes

OpenAI.SpecificFunctionShellParam

Dwingt het model om het shell-hulpprogramma aan te roepen wanneer een hulpprogramma-aanroep is vereist.

Name	Typ	Description	Required	Verstek
type	enum	Het hulpprogramma dat moet worden aangeroepen. Altijd shell. Mogelijke waarden: shell	Yes

OpenAI.Summary

Een samenvattende tekst van het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	Een samenvatting van de redeneerresultaten van het model tot nu toe.	Yes
type	enum	Het type van het object. Altijd summary_text. Mogelijke waarden: summary_text	Yes

OpenAI.SummaryTextContent

Een samenvattende tekst van het model.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	Een samenvatting van de redeneerresultaten van het model tot nu toe.	Yes
type	enum	Het type van het object. Altijd summary_text. Mogelijke waarden: summary_text	Yes

OpenAI.TextContent

Een tekstinhoud.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks		Yes
type	enum	Mogelijke waarden: text	Yes

OpenAI.TextResponseFormatConfiguration

Een object dat de indeling aangeeft die het model moet uitvoeren. { "type": "json_schema" } Als u gestructureerde uitvoer configureert, zorgt u ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie in de

De standaardindeling is { "type": "text" } zonder extra opties. Niet aanbevolen voor GPT-4o en nieuwere modellen:* Instelling om de oudere JSON-modus in { "type": "json_object" } te schakelen, die ervoor zorgt dat het bericht dat het model genereert geldig JSON is. Het is aanbevolen om json_schema te gebruiken voor modellen die dit ondersteunen.

Discriminator voor OpenAI.TextResponseFormatConfiguration

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
json_schema	OpenAI.TextResponseFormatJsonSchema
text	OpenAI.TextResponseFormatConfigurationResponseFormatText
json_object	OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

Name	Typ	Description	Required	Verstek
type	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON-objectantwoordindeling. Een oudere methode voor het genereren van JSON-antwoorden. Het gebruik json_schema wordt aanbevolen voor modellen die dit ondersteunen. Houd er rekening mee dat het model geen JSON genereert zonder een systeem- of gebruikersbericht waarin het wordt geïnstrueerd om dit te doen.

Name	Typ	Description	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd json_object. Mogelijke waarden: json_object	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

De standaard antwoordindeling. Wordt gebruikt om tekstreacties te genereren.

Name	Typ	Description	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd text. Mogelijke waarden: text	Yes

OpenAI.TextResponseFormatConfigurationType

Property	Value
Type	tekenreeks
waarden	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

JSON Schema-antwoordindeling. Wordt gebruikt om gestructureerde JSON-antwoorden te genereren. Meer informatie over gestructureerde uitvoer.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om bepalen hoe moet worden gereageerd volgens de voorgeschreven manier.	No
naam	tekenreeks	De naam van de antwoordindeling. Moet a-z, A-Z, 0-9 zijn, of bevatten onderstrepingstekens en streepjes, met een maximale lengte van 64 tekens.	Yes
schema	OpenAI.ResponseFormatJsonSchemaSchema	Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.	Yes
streng	Booleaanse waarde (nullable)		No
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd json_schema. Mogelijke waarden: json_schema	Yes

OpenAI.Tool

Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.

Discriminator voor OpenAI.Tool

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
bing_grounding	BingGroundingTool
fabric_dataagent_preview	MicrosoftFabricPreviewTool
sharepoint_grounding_preview	SharepointPreviewTool
azure_ai_search	AzureAISearchTool
openapi	OpenApiTool
bing_custom_search_preview	BingCustomSearchPreviewTool
browser_automation_preview	BrowserAutomationPreviewTool
azure_function	AzureFunctionTool
capture_structured_outputs	CaptureStructuredOutputsTool
a2a_preview	A2APreviewTool
memory_search_preview	MemorySearchPreviewTool
code_interpreter	OpenAI.CodeInterpreterTool
function	OpenAI.FunctionTool
file_search	OpenAI.FileSearchTool
computer_use_preview	OpenAI.ComputerUsePreviewTool
web_search	OpenAI.WebSearchTool
mcp	OpenAI.MCPTool
image_generation	OpenAI.ImageGenTool
local_shell	OpenAI.LocalShellToolParam
shell	OpenAI.FunctionShellToolParam
custom	OpenAI.CustomToolParam
web_search_preview	OpenAI.WebSearchPreviewTool
apply_patch	OpenAI.ApplyPatchToolParam

Name	Typ	Description	Required	Verstek
type	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Hiermee beperkt u de hulpprogramma's die beschikbaar zijn voor het model tot een vooraf gedefinieerde set.

Name	Typ	Description	Required	Verstek
modus	enum	Hiermee beperkt u de hulpprogramma's die beschikbaar zijn voor het model tot een vooraf gedefinieerde set. auto hiermee kan het model kiezen uit de toegestane hulpprogramma's en een bericht. required vereist dat het model een of meer van de toegestane hulpprogramma's aanroept. Mogelijke waarden: auto, required	Yes
tools	matrix van object	Een lijst met hulpprogrammadefinities die het model mag aanroepen. Voor de Antwoorden-API kan de lijst met hulpprogrammadefinities er als volgt uitzien: json<br> [<br> { "type": "function", "name": "get_weather" },<br> { "type": "mcp", "server_label": "deepwiki" },<br> { "type": "image_generation" }<br> ]<br>	Yes
type	enum	Toegestaan configuratietype voor hulpprogramma's. Altijd allowed_tools. Mogelijke waarden: allowed_tools	Yes

OpenAI.ToolChoiceCodeInterpreter

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: code_interpreter	Yes

OpenAI.ToolChoiceComputerUsePreview

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: computer_use_preview	Yes

OpenAI.ToolChoiceCustom

Gebruik deze optie om af te dwingen dat het model een specifiek aangepast hulpprogramma aanroept.

Name	Typ	Description	Required	Verstek
naam	tekenreeks	De naam van het aangepaste hulpprogramma dat moet worden aangeroepen.	Yes
type	enum	Voor het aanroepen van aangepaste hulpprogramma's is het type altijd custom. Mogelijke waarden: custom	Yes

OpenAI.ToolChoiceFileSearch

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: file_search	Yes

OpenAI.ToolChoiceFunction

Gebruik deze optie om af te dwingen dat het model een specifieke functie aanroept.

Name	Typ	Description	Required	Verstek
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
type	enum	Voor functie-aanroepen is het type altijd function. Mogelijke waarden: function	Yes

OpenAI.ToolChoiceImageGeneration

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: image_generation	Yes

OpenAI.ToolChoiceMCP

Gebruik deze optie om af te dwingen dat het model een specifiek hulpprogramma aanroept op een externe MCP-server.

Name	Typ	Description	Required	Verstek
naam	tekenreeks (nullable)		No
server_label	tekenreeks	Het label van de MCP-server die moet worden gebruikt.	Yes
type	enum	Voor MCP-hulpprogramma's is het type altijd mcp. Mogelijke waarden: mcp	Yes

OpenAI.ToolChoiceOptions

Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. none betekent dat het model geen hulpprogramma aanroept en in plaats daarvan een bericht genereert. auto betekent dat het model kan kiezen tussen het genereren van een bericht of het aanroepen van een of meer hulpprogramma's. required betekent dat het model een of meer hulpprogramma's moet aanroepen.

Property	Value
Type	tekenreeks
waarden	none auto required

OpenAI.ToolChoiceParam

Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de tools parameter om te zien welke hulpprogramma's het model kan aanroepen.

Discriminator voor OpenAI.ToolChoiceParam

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
allowed_tools	OpenAI.ToolChoiceAllowed
function	OpenAI.ToolChoiceFunction
mcp	OpenAI.ToolChoiceMCP
custom	OpenAI.ToolChoiceCustom
apply_patch	OpenAI.SpecificApplyPatchParam
shell	OpenAI.SpecificFunctionShellParam
file_search	OpenAI.ToolChoiceFileSearch
web_search_preview	OpenAI.ToolChoiceWebSearchPreview
computer_use_preview	OpenAI.ToolChoiceComputerUsePreview
web_search_preview_2025_03_11	OpenAI.ToolChoiceWebSearchPreview20250311
image_generation	OpenAI.ToolChoiceImageGeneration
code_interpreter	OpenAI.ToolChoiceCodeInterpreter

Name	Typ	Description	Required	Verstek
type	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Property	Value
Type	tekenreeks
waarden	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

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: web_search_preview	Yes

OpenAI.ToolChoiceWebSearchPreview20250311

Geeft aan dat het model een ingebouwd hulpprogramma moet gebruiken om een antwoord te genereren. Leer meer over ingebouwde tools.

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: web_search_preview_2025_03_11	Yes

OpenAI.ToolType

Property	Value
Type	tekenreeks
waarden	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

Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de tool_choice parameter in te stellen. We ondersteunen de volgende categorieën hulpprogramma's:

• Ingebouwde tools: Tools die door OpenAI worden aangeboden en de mogelijkheden van het model uitbreiden, zoals web search of file search. Lees meer over ingebouwde tools.
• MCP Tools: Integraties met systemen van derden via aangepaste MCP-servers of vooraf gedefinieerde connectors zoals Google Drive en SharePoint. Lees meer over MCP Tools.
• Functie-aanroepen (aangepaste hulpprogramma's): functies die door u worden gedefinieerd, zodat het model uw eigen code kan aanroepen met sterk getypte argumenten en uitvoer. Meer informatie over het aanroepen van functies. U kunt ook aangepaste hulpprogramma's gebruiken om uw eigen code aan te roepen.

Matrix van: OpenAI.Tool

OpenAI.TopLogProb

De hoogste logaritmische waarschijnlijkheid van een token.

Name	Typ	Description	Required	Verstek
bytes	matrix van OpenAI.integer		Yes
logprob	OpenAI.numeriek		Yes
token	tekenreeks		Yes

OpenAI.Type

Een actie om tekst te typen.

Name	Typ	Description	Required	Verstek
tekst	tekenreeks	De tekst die moet worden getypt.	Yes
type	enum	Hiermee geeft u het gebeurtenistype. Voor een typeactie is deze eigenschap altijd ingesteld op type. Mogelijke waarden: type	Yes

OpenAI.UpdateConversationBody

Name	Typ	Description	Required	Verstek
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	Yes

OpenAI.UrlCitationBody

Een bronvermelding voor een webresource die wordt gebruikt om een modelantwoord te genereren.

Name	Typ	Description	Required	Verstek
end_index	OpenAI.integer		Yes
start_index	OpenAI.integer		Yes
title	tekenreeks	De titel van de webresource.	Yes
type	enum	Het type URL-bronvermelding. Altijd url_citation. Mogelijke waarden: url_citation	Yes
URL	tekenreeks	De URL van de webresource.	Yes

OpenAI.VectorStoreFileAttributes

Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens, booleaanse waarden of getallen.

Type: objecten

OpenAI.Verbosity

Beperkt de omvangrijkheid van het antwoord van het model. Lagere waarden zorgen voor beknoptere antwoorden, terwijl hogere waarden meer uitgebreide antwoorden opleveren. Momenteel ondersteunde waarden zijn low, mediumen high.

Property	Value
Type	tekenreeks
Nullable	Yes
waarden	low medium high

OpenAI.Wait

Een wachtactie.

Name	Typ	Description	Required	Verstek
type	enum	Hiermee geeft u het gebeurtenistype. Voor een wachtactie is deze eigenschap altijd ingesteld op wait. Mogelijke waarden: wait	Yes

OpenAI.WebSearchActionFind

Actietype 'zoeken': zoekt naar een patroon binnen een geladen pagina.

Name	Typ	Description	Required	Verstek
pattern	tekenreeks	Het patroon of de tekst die u op de pagina wilt zoeken.	Yes
type	enum	Het actietype. Mogelijke waarden: find_in_page	Yes
URL	tekenreeks	De URL van de pagina waarnaar het patroon is gezocht.	Yes

OpenAI.WebSearchActionOpenPage

Actietype 'open_page': hiermee opent u een specifieke URL uit zoekresultaten.

Name	Typ	Description	Required	Verstek
type	enum	Het actietype. Mogelijke waarden: open_page	Yes
URL	tekenreeks	De URL die door het model is geopend.	Yes

OpenAI.WebSearchActionSearch

Actietype 'zoeken': voert een webzoekquery uit.

Name	Typ	Description	Required	Verstek
queries	array van tekenreeksen	De zoekquery's.	No
zoekopdracht	tekenreeks (afgeschaft)	[AFGESCHAFT] De zoekquery.	Yes
Bronnen	matrix van OpenAI.WebSearchActionSearchSources	De bronnen die bij het zoeken zijn gebruikt.	No
type	enum	Het actietype. Mogelijke waarden: search	Yes

OpenAI.WebSearchActionSearchSources

Name	Typ	Description	Required	Verstek
type	enum	Mogelijke waarden: url	Yes
URL	tekenreeks		Yes

OpenAI.WebSearchApproximateLocation

De ongeveer locatie van de gebruiker.

Name	Typ	Description	Required	Verstek
city	tekenreeks (nullable)		No
country	tekenreeks (nullable)		No
region	tekenreeks (nullable)		No
timezone	tekenreeks (nullable)		No
type	enum	Het type locatie-benadering. Altijd approximate. Mogelijke waarden: approximate	No

OpenAI.WebSearchPreviewTool

Deze tool zoekt op het web naar relevante resultaten om in een reactie te gebruiken. Meer informatie over het webzoekprogramma.

Name	Typ	Description	Required	Verstek
zoek_context_grootte	OpenAI.SearchContextSize		No
type	enum	Het type webzoekprogramma. Een van web_search_preview of web_search_preview_2025_03_11. Mogelijke waarden: web_search_preview	Yes
gebruikerslocatie	OpenAI.ApproximateLocation (nulleerbaar)		No
└city	tekenreeks (nullable)		No
└land	tekenreeks (nullable)		No
└* regio	tekenreeks (nullable)		No
└* tijdzone	tekenreeks (nullable)		No
└type.	enum	Het type locatie-benadering. Altijd approximate. Mogelijke waarden: approximate	Yes

OpenAI.WebSearchTool

Zoek op internet naar bronnen die met de prompt te maken hebben. Meer informatie over het webzoekprogramma.

Name	Typ	Description	Required	Verstek
custom_search_configuration	WebSearchConfiguration	Een webzoekconfiguratie voor bing aangepaste zoekopdrachten	No
└instance_name	tekenreeks	Naam van het aangepaste configuratie-exemplaar dat is opgegeven voor de configuratie.	Yes
└project_connection_id	tekenreeks	Project verbindings-id voor grounding met Bing Custom Search	Yes
filters	OpenAI.WebSearchToolFilters (nullbaar)		No
└allowed_domains	matrix van tekenreeks (nullable)		No
zoek_context_grootte	enum	Richtlijnen op hoog niveau voor de hoeveelheid contextvensterruimte die moet worden gebruikt voor de zoekopdracht. Een van low, mediumof high. medium is de standaardwaarde. Mogelijke waarden: low, mediumhigh	No
type	enum	Het type webzoekprogramma. Een van web_search of web_search_2025_08_26. Mogelijke waarden: web_search	Yes
gebruikerslocatie	OpenAI.WebSearchApproximateLocation (nulleerbaar)	De ongeveer locatie van de gebruiker.	No
└city	tekenreeks (nullable)		No
└land	tekenreeks (nullable)		No
└* regio	tekenreeks (nullable)		No
└* tijdzone	tekenreeks (nullable)		No
└type.	enum	Het type locatie-benadering. Altijd approximate. Mogelijke waarden: approximate	No

OpenAI.WebSearchToolFilters

Name	Typ	Description	Required	Verstek
allowed_domains	array van tekenreeksen		No

OpenAI.integer

Type: geheel getal

Indeling: int64

OpenAI.numeriek

Type: getal

Opmaak: dubbel

OpenApiAnonymousAuthDetails

Beveiligingsdetails voor anonieme OpenApi-verificatie

Name	Typ	Description	Required	Verstek
type	enum	Het objecttype, dat altijd 'anoniem' is. Mogelijke waarden: anonymous	Yes

OpenApiAuthDetails

verificatiedetails voor OpenApiFunctionDefinition

Discriminator voor OpenApiAuthDetails

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
anonymous	OpenApiAnonymousAuthDetails
project_connection	OpenApiProjectConnectionAuthDetails
managed_identity	OpenApiManagedAuthDetails

Name	Typ	Description	Required	Verstek
type	OpenApiAuthType	Verificatietype voor OpenApi-eindpunt. Toegestane soorten zijn: - Anoniem (geen verificatie vereist) - Project verbinding (vereist project_connection_id naar eindpunt, als installatie in AI Foundry) - Managed_Identity (vereist doelgroep voor verificatie op basis van identiteit)	Yes

OpenApiAuthType

Verificatietype voor OpenApi-eindpunt. Toegestane soorten zijn:

• Anoniem (geen authenticatie vereist)
• Project Verbinding (vereist project_connection_id naar het eindpunt, zoals ingesteld in AI Foundry)
• Managed_Identity (vereist publiek voor verificatie op basis van identiteit)

Property	Value
Description	Verificatietype voor OpenApi-eindpunt. Toegestane soorten zijn: - Anoniem (geen verificatie vereist) - Project verbinding (vereist project_connection_id naar eindpunt, als installatie in AI Foundry) - Managed_Identity (vereist doelgroep voor verificatie op basis van identiteit)
Type	tekenreeks
waarden	anonymous project_connection managed_identity

OpenApiFunctionDefinition

De informatie over de invoerdefinitie voor een openapi-functie.

Name	Typ	Description	Required	Verstek
auth	OpenApiAuthDetails	verificatiedetails voor OpenApiFunctionDefinition	Yes
└type.	OpenApiAuthType	Het type verificatie moet anoniem/project_connection/managed_identity	Yes
default_params	array van tekenreeksen	Lijst met parameters voor OpenAPI-specificaties die gebruikmaken van door de gebruiker opgegeven standaardinstellingen	No
beschrijving	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
functions	matrix van object	Lijst met functiedefinities die worden gebruikt door het OpenApi-hulpprogramma	No
naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
spec	object	De openapi-functieshape, beschreven als een JSON-schemaobject.	Yes

OpenApiManagedAuthDetails

Beveiligingsdetails voor OpenApi managed_identity-verificatie

Name	Typ	Description	Required	Verstek
security_scheme	OpenApiManagedSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie	Yes
└publiek	tekenreeks	Verificatiebereik voor managed_identity verificatietype	Yes
type	enum	Het objecttype, dat altijd 'managed_identity' is. Mogelijke waarden: managed_identity	Yes

OpenApiManagedSecurityScheme

Beveiligingsschema voor OpenApi managed_identity-verificatie

Name	Typ	Description	Required	Verstek
audience	tekenreeks	Verificatiebereik voor managed_identity verificatietype	Yes

OpenApiProjectConnectionAuthDetails

Beveiligingsdetails voor OpenApi project-verbindingsverificatie

Name	Typ	Description	Required	Verstek
security_scheme	OpenApiProjectConnectionSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie	Yes
└project_connection_id	tekenreeks	Project verbindings-id voor Project verbindingsverificatietype	Yes
type	enum	Het objecttype, dat altijd 'project_connection' is. Mogelijke waarden: project_connection	Yes

OpenApiProjectConnectionSecurityScheme

Beveiligingsschema voor OpenApi managed_identity-verificatie

Name	Typ	Description	Required	Verstek
project_connection_id	tekenreeks	Project verbindings-id voor Project verbindingsverificatietype	Yes

OpenApiTool

De informatie over de invoerdefinitie voor een OpenAPI-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Description	Required	Verstek
openapi	OpenApiFunctionDefinition	De informatie over de invoerdefinitie voor een openapi-functie.	Yes
└} verificatie	OpenApiAuthDetails	Details van API-verificatie openen	Yes
└default_params	array van tekenreeksen	Lijst met parameters voor OpenAPI-specificaties die gebruikmaken van door de gebruiker opgegeven standaardinstellingen	No
└─ Beschrijving	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
└functies.	matrix van object (alleen-lezen)	Lijst met functiedefinities die worden gebruikt door het OpenApi-hulpprogramma	No
└─ Beschrijving	tekenreeks	Een beschrijving van wat de functie doet, die door het model wordt gebruikt om te kiezen wanneer en hoe de functie moet worden aangeroepen.	No
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
└- parameters	object	De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject.	Yes
└─naam	tekenreeks	De naam van de functie die moet worden aangeroepen.	Yes
└spec.	object	De openapi-functieshape, beschreven als een JSON-schemaobject.	Yes
type	enum	Het objecttype, dat altijd 'openapi' is. Mogelijke waarden: openapi	Yes

PageOrder

Property	Value
Type	tekenreeks
waarden	asc desc

PagedConnection

Gepaginade verzameling verbindingsitems

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van verbinding	De verbindingsitems op deze pagina	Yes

PagedDatasetVersion

Gepaginade verzameling GegevenssetVersion-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van DatasetVersion	De DatasetVersion-items op deze pagina	Yes

PagedDeployment

Gepaginade verzameling implementatie-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van implementatie	De implementatie-items op deze pagina	Yes

PagedEvaluationRule

Gepaginade verzameling EvaluationRule-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van EvaluationRule	De EvaluationRule-items op deze pagina	Yes

PagedEvaluationTaxonomy

Gepaginade verzameling EvaluationTaxonomy-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van EvaluationTaxonomy	De EvaluationTaxonomy-items op deze pagina	Yes

PagedEvaluatorVersion

Gepaginade verzameling evaluatorVersion-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van EvaluatorVersion	De EvaluatorVersion-items op deze pagina	Yes

PagedIndex

Gepaginade verzameling indexitems

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van index	De indexitems op deze pagina	Yes

PagedInsight

Gepaginade verzameling Insight-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van Inzicht	De Insight-items op deze pagina	Yes

PagedRedTeam

Gepaginade verzameling RedTeam-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van RedTeam	De RedTeam-items op deze pagina	Yes

PagedSchedule

Gepaginade verzameling planningsitems

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van Planning	De planningsitems op deze pagina	Yes

PagedScheduleRun

Gepaginade verzameling ScheduleRun-items

Name	Typ	Description	Required	Verstek
nextLink	tekenreeks	De koppeling naar de volgende pagina met items	No
value	matrix van ScheduleRun	De ScheduleRun-items op deze pagina	Yes

PendingUploadRequest

Vertegenwoordigt een aanvraag voor een upload die in afwachting is.

Name	Typ	Description	Required	Verstek
connectionName	tekenreeks	Naam van de Azure Storage-accountverbinding die moet worden gebruikt voor het genereren van een tijdelijk SAS-token	No
pendingUploadId	tekenreeks	Als PendingUploadId niet is opgegeven, wordt een willekeurige GUID gebruikt.	No
pendingUploadType	enum	BlobReference is het enige ondersteunde type. Mogelijke waarden: BlobReference	Yes

PendingUploadResponse

Vertegenwoordigt het antwoord op een in behandeling zijnde uploadaanvraag

Name	Typ	Description	Required	Verstek
blobReference	BlobReference	Details van de blobreferentie.	Yes
└* blobUri	tekenreeks	Blob-URI-pad voor client om gegevens te uploaden. Voorbeeld:https://blob.windows.core.net/Container/Path	Yes
Referentie └*	SasCredential	Referentiegegevens voor toegang tot het opslagaccount.	Yes
└* storageAccountArmId	tekenreeks	ARM-id van het opslagaccount dat moet worden gebruikt.	Yes
pendingUploadId	tekenreeks	ID voor dit uploadverzoek.	Yes
pendingUploadType	enum	BlobReference is het enige ondersteunde type Mogelijke waarden: BlobReference	Yes
version	tekenreeks	Versie van het item dat moet worden gemaakt als de gebruiker de versie niet heeft opgegeven bij het maken van een upload	No

PromptAgentDefinition

De definitie van de promptagent

Name	Typ	Description	Required	Verstek
aanwijzingen	tekenreeks (nullable)	Een systeembericht (of ontwikkelaarsbericht) dat is ingevoegd binnen de context van het model.	No
vriendelijk	enum	Mogelijke waarden: prompt	Yes
model	tekenreeks	De modelimplementatie die voor deze agent moet worden gebruikt.	Yes
rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
└rai_policy_name	tekenreeks	De naam van het RAI-beleid dat moet worden toegepast.	Yes
reasoning	OpenAI.Reasoning (nul)	alleen gpt-5- en o-seriemodellen Configuratieopties voor redeneringsmodellen.	No
└* inspanning	OpenAI.ReasoningEffort	Beperkt inspanning voor redenering redeneringsmodellen. Momenteel ondersteunde waarden zijn none, , , minimal, lowmedium, en highxhigh. Verminderen redenering kan leiden tot snellere antwoorden en minder gebruikte tokens over redenering bij een antwoord. - gpt-5.1 wordt standaard ingesteld noneop , wat geen redenering uitvoert. De ondersteunde redeneerwaarden voor gpt-5.1 zijn none, low, , mediumen high. Hulpprogramma-aanroepen worden ondersteund voor alle redeneringswaarden in gpt-5.1. - Alle modellen vóór gpt-5.1 de standaardinstelling voor medium redenering en bieden geen ondersteuning nonevoor . - Het gpt-5-pro model is standaard ingesteld op (en ondersteunt alleen) high redeneringsinspanningen. - xhigh wordt ondersteund voor alle modellen na gpt-5.1-codex-max.	No
└─generate_summary	enum	Mogelijke waarden: auto, concisedetailed	No
Samenvatting └─	enum	Mogelijke waarden: auto, concisedetailed	No
structured_inputs	object	Set gestructureerde invoer die kan deelnemen aan prompt sjabloonvervanging of toolargumentbindingen.	No
Temperatuur	number	Welke steekproeftemperatuur moet worden gebruikt, tussen 0 en 2. Hogere waarden zoals 0,8 zorgen ervoor dat de uitvoer willekeuriger wordt, terwijl lagere waarden zoals 0,2 ervoor zorgen dat de uitvoer meer gericht en deterministisch wordt. Over het algemeen raden we aan om dit of top_p te wijzigen, maar niet beide.	No	1
tekst	PromptAgentDefinitionTextOptions	Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.	No
└─ formaat	OpenAI.TextResponseFormatConfiguration	Een object dat de indeling aangeeft die het model moet uitvoeren. { "type": "json_schema" } Configureren maakt gestructureerde uitvoer mogelijk, dit zorgt ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie in de De standaardindeling is { "type": "text" } zonder extra opties. *Niet aanbevolen voor gpt-4o en nieuwere modellen:** Instellen van { "type": "json_object" } schakelt de oudere JSON-modus in, die zorgt ervoor dat het bericht dat het model genereert geldige JSON is. Het gebruiken van json_schema heeft de voorkeur voor modellen die dit ondersteunen.	No
tool_choice	tekenreeks of OpenAI.ToolChoiceParam	Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de tools parameter om te zien welke hulpprogramma's het model kan aanroepen.	No
tools	matrix van OpenAI.Tool	Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kan opgeven welk hulpprogramma moet worden gebruikt door de tool_choice parameter in te stellen.	No
top_p	number	Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model de resultaten van de tokens met top_p waarschijnlijkheid beschouwt massa. 0,1 betekent dus alleen de tokens die de top 10% kansmassa omvatten worden overwogen. Over het algemeen raden we aan om dit of temperature te wijzigen, maar niet beide.	No	1

PromptAgentDefinitionTextOptions

Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.

Name	Typ	Description	Required	Verstek
format	OpenAI.TextResponseFormatConfiguration	Een object dat de indeling aangeeft die het model moet uitvoeren. { "type": "json_schema" } Configureren maakt gestructureerde uitvoer mogelijk, dit zorgt ervoor dat het model overeenkomt met het opgegeven JSON-schema. Meer informatie in de De standaardindeling is { "type": "text" } zonder extra opties. *Niet aanbevolen voor gpt-4o en nieuwere modellen:** Instellen van { "type": "json_object" } schakelt de oudere JSON-modus in, die zorgt ervoor dat het bericht dat het model genereert geldige JSON is. Het gebruiken van json_schema heeft de voorkeur voor modellen die dit ondersteunen.	No

PromptBasedEvaluatorDefinition

Prompt-gebaseerde evaluator

Name	Typ	Description	Required	Verstek
data_schema	object	Het JSON-schema (Draft 2020-12) voor de invoergegevens van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
init_parameters	object	Het JSON-schema (concept 2020-12) voor de invoerparameters van de beoordelaar. Dit omvat parameters zoals type, eigenschappen, vereist.	No
metrics	object	Lijst met outputstatistieken geproduceerd door deze beoordelaar	No
prompt_text	tekenreeks	De prompttekst die wordt gebruikt voor evaluatie	Yes
type	enum	Mogelijke waarden: prompt	Yes

ProtocolVersionRecord

Een recordtoewijzing voor een enkel protocol en de versie ervan.

Name	Typ	Description	Required	Verstek
protocol	AgentProtocol		Yes
version	tekenreeks	De versietekenreeks voor het protocol, bijvoorbeeld v0.1.1.	Yes

RaiConfig

Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.

Name	Typ	Description	Required	Verstek
rai_policy_name	tekenreeks	De naam van het RAI-beleid dat moet worden toegepast.	Yes

RecurrenceSchedule

Model voor herhalingsschema.

Discriminator voor RecurrenceSchedule

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
Hourly	HourlyRecurrenceSchedule
Daily	DailyRecurrenceSchedule
Weekly	WeeklyRecurrenceSchedule
Monthly	MonthlyRecurrenceSchedule

Name	Typ	Description	Required	Verstek
type	Recurrencetype	Type herhaling.	Yes

RecurrenceTrigger

Trigger op basis van herhaling.

Name	Typ	Description	Required	Verstek
endTime	tekenreeks	Eindtijd voor het herhalingsschema in ISO 8601-indeling.	No
interval	integer	Interval voor het herhalingsschema.	Yes
schedule	RecurrenceSchedule	Model voor herhalingsschema.	Yes
└type.	Recurrencetype	Terugkeerpatroontype voor het terugkeerschema.	Yes
startTime	tekenreeks	Starttijd voor het herhalingsschema in ISO 8601-indeling.	No
timeZone	tekenreeks	Tijdzone voor het herhalingsschema.	No	UTC
type	enum	Type van de trekker. Mogelijke waarden: Recurrence	Yes

Recurrencetype

Type herhaling.

Property	Value
Description	Type herhaling.
Type	tekenreeks
waarden	Hourly Daily Weekly Monthly

RedTeam

Rode teamdetails.

Name	Typ	Description	Required	Verstek
applicationScenario	tekenreeks	Toepassingsscenario voor de rode teambewerking om scenariospecifieke aanvallen te genereren.	No
attackStrategies	matrix van AttackStrategy	Lijst met aanvalsstrategieën of geneste lijsten met aanvalsstrategieën.	No
displayName	tekenreeks	Naam van de rode teamuitvoering.	No
id	tekenreeks (alleen-lezen)	Id van de rode teamuitvoering.	Yes
numTurns	integer	Aantal simulatierondes.	No
properties	object	De eigenschappen van het rode team. In tegenstelling tot tags zijn eigenschappen alleen-toevoegen. Zodra deze is toegevoegd, kan een eigenschap niet worden verwijderd.	No
riskCategories	matrix van RiskCategory	Lijst met risicocategorieën voor het genereren van aanvalsdoelen.	No
simulatieOnly	boolean	Alleen simulatie of Simulatie en evaluatie. Standaard onwaar, als waar de scan het gesprek niet evalueert.	No	Onwaar
status	tekenreeks (alleen-lezen)	Status van het rode team. Deze is ingesteld door de service en heeft het kenmerk Alleen-lezen.	No
tags	object	De tags van het rode team. In tegenstelling tot eigenschappen zijn tags volledig veranderlijk.	No
target	TargetConfig	Abstracte klasse voor doelconfiguratie.	Yes
└type.	tekenreeks	Type van de modelconfiguratie.	Yes

RedTeamEvalRunDataSource

Name	Typ	Description	Required	Verstek
item_generation_params	ItemGenerationParams	Vertegenwoordigt de set parameters die worden gebruikt voor het beheren van bewerkingen voor het genereren van items.	Yes
└type.	ItemGenerationParamsType	Het type parameters voor het genereren van items dat moet worden gebruikt.	Yes
target	Doel	Basisklasse voor doelen met discriminatorondersteuning.	Yes
└type.	tekenreeks	Het type doel.	Yes
type	enum	Het type gegevensbron. Altijd azure_ai_red_team. Mogelijke waarden: azure_ai_red_team	Yes

RedTeamItemGenerationParams

Name	Typ	Description	Required	Verstek
attack_strategies	matrix van AttackStrategy	De verzameling aanvalsstrategieën die moeten worden gebruikt.	Yes
num_turns	integer	Het aantal beurten dat is toegestaan in het spel.	Yes	20
type	enum	Het type parameters voor het genereren van items. Mogelijke waarden: red_team	Yes

RedTeamSeedPromptsItemGenerationParams

Vertegenwoordigt de parameters voor het genereren van items in rode team seeds.

Name	Typ	Description	Required	Verstek
attack_strategies	matrix van AttackStrategy	De verzameling aanvalsstrategieën die moeten worden gebruikt.	Yes
num_turns	integer	Het aantal beurten dat is toegestaan in het spel.	Yes	20
source	OpenAI.EvalJsonlFileContentSource		Yes
└* inhoud	matrix van OpenAI.EvalJsonlFileContentSourceContent	De inhoud van het jsonl-bestand.	Yes
└type.	enum	Het type jsonl-bron. Altijd file_content. Mogelijke waarden: file_content	Yes
type	enum	Het type parameters voor het genereren van items, altijd red_team_seed_prompts. Mogelijke waarden: red_team_seed_prompts	Yes

RedTeamTaxonomyItemGenerationParams

Vertegenwoordigt de parameters voor het genereren van items in de rode teamtaxonomie.

Name	Typ	Description	Required	Verstek
attack_strategies	matrix van AttackStrategy	De verzameling aanvalsstrategieën die moeten worden gebruikt.	Yes
num_turns	integer	Het aantal beurten dat is toegestaan in het spel.	Yes	20
source	OpenAI.EvalJsonlFileContentSource		Yes
└* inhoud	matrix van OpenAI.EvalJsonlFileContentSourceContent	De inhoud van het jsonl-bestand.	Yes
└type.	enum	Het type jsonl-bron. Altijd file_content. Mogelijke waarden: file_content	Yes
type	enum	Het type parameters voor het genereren van items, altijd red_team_taxonomy. Mogelijke waarden: red_team_taxonomy	Yes

ResponseRetrievalItemGenerationParams

Vertegenwoordigt de parameters voor het genereren van het antwoorditem.

Name	Typ	Description	Required	Verstek
gegevenskoppeling	object	Toewijzing van bronvelden aan response_id veld, vereist voor het ophalen van de chatgeschiedenis.	Yes
max_num_turns	integer	Het maximum aantal beurten van chatgeschiedenis dat moet worden geëvalueerd.	Yes
source	OpenAI.EvalJsonlFileContentSource of OpenAI.EvalJsonlFileIdSource	De bron waaruit JSONL-inhoud wordt gelezen.	Yes
type	enum	Het type parameters voor het genereren van items, altijd response_retrieval. Mogelijke waarden: response_retrieval	Yes

RiskCategory

Risicocategorie voor het aanvalsdoel.

Property	Value
Description	Risicocategorie voor het aanvalsdoel.
Type	tekenreeks
waarden	HateUnfairness Violence Sexual SelfHarm ProtectedMaterial CodeVulnerability UngroundedAttributes ProhibitedActions SensitiveDataLeakage TaskAdherence

SASCredentials

Definitie van SAS-referenties (Shared Access Signature)

Name	Typ	Description	Required	Verstek
SAS	tekenreeks (alleen-lezen)	SAS-token	No
type	enum	Het type aanmeldingsgegevens Mogelijke waarden: SAS	Yes

SampleType

Het type monster dat in de analyse wordt gebruikt.

Property	Value
Description	Het type monster dat in de analyse wordt gebruikt.
Type	tekenreeks
waarden	EvaluationResultSample

SasCredential

Definitie van SAS-referenties

Name	Typ	Description	Required	Verstek
sasUri	tekenreeks (alleen-lezen)	SAS-URI	Yes
type	enum	Type referentie Mogelijke waarden: SAS	Yes

Schedule

Schema model.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Beschrijving van de planning.	No
displayName	tekenreeks	Naam van de planning.	No
enabled	boolean	Status van de planning ingeschakeld.	Yes
id	tekenreeks (alleen-lezen)	Id van de planning.	Yes
properties	object	De eigenschappen van de planning. In tegenstelling tot tags zijn eigenschappen alleen-toevoegen. Zodra deze is toegevoegd, kan een eigenschap niet worden verwijderd.	No
provisioneringsstatus	ScheduleProvisioningStatus (alleen-lezen)	Planningsstatus inplannen.	No
systeemgegevens	object (alleen-lezen)	Systeemmetagegevens voor de resource.	Yes
tags	object	De tags van de planning. In tegenstelling tot eigenschappen zijn tags volledig veranderlijk.	No
taak	ScheduleTask	Taakmodel plannen.	Yes
└configuratie.	object	Configuratie voor de taak.	No
└type.	ScheduleTaskType	Type taak.	Yes
trigger	Trigger	Basismodel voor Trigger van het rooster.	Yes
└type.	TriggerType	Type van de trekker.	Yes

ScheduleProvisioningStatus

Planningsstatus inplannen.

Property	Value
Description	Planningsstatus inplannen.
Type	tekenreeks
waarden	Creating Updating Deleting Succeeded Failed

ScheduleRun

Model voor planning.

Name	Typ	Description	Required	Verstek
fout	tekenreeks (alleen-lezen)	Foutinformatie voor de planningsuitvoering.	No
id	tekenreeks (alleen-lezen)	Id van de planningsuitvoering.	Yes
properties	object (alleen-lezen)	Eigenschappen van de planningsuitvoering.	Yes
scheduleId	tekenreeks	Id van de planning.	Yes
success	Booleaanse waarde (alleen-lezen)	Activeren van de geslaagde status van de planningsuitvoering.	Yes
triggerTime	tekenreeks	Triggertijd van de planningsuitvoering.	No

ScheduleTask

Taakmodel plannen.

Discriminator voor ScheduleTask

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
Evaluation	EvaluationScheduleTask
Insight	InsightScheduleTask

Name	Typ	Description	Required	Verstek
configuration	object	Configuratie voor de taak.	No
type	ScheduleTaskType	Type taak.	Yes

ScheduleTaskType

Type taak.

Property	Value
Description	Type taak.
Type	tekenreeks
waarden	Evaluation Insight

SharepointGroundingToolParameters

De parameters van de sharepoint-aardingstool.

Name	Typ	Description	Required	Verstek
project_connections	matrix van ToolProjectConnection	De project verbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma.	No

SharepointPreviewTool

De informatie over de invoerdefinitie voor een SharePoint-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Description	Required	Verstek
sharepoint_grounding_preview	SharepointGroundingToolParameters	De parameters van de sharepoint-aardingstool.	Yes
└project_connections	matrix van ToolProjectConnection	De project verbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma. Beperkingen: maxItems: 1	No
type	enum	Het objecttype, dat altijd 'sharepoint_grounding_preview' is. Mogelijke waarden: sharepoint_grounding_preview	Yes

Sku

SKU-informatie

Name	Typ	Description	Required	Verstek
capacity	integer	SKU-capaciteit	Yes
family	tekenreeks	SKU-familie	Yes
naam	tekenreeks	SKU-naam	Yes
size	tekenreeks	SKU-grootte	Yes
tier	tekenreeks	SKU-laag	Yes

StructuredInputDefinition

Een gestructureerde invoer die kan deelnemen aan snelle sjabloonvervangingen en het binden van gereedschapsargumenten.

Name	Typ	Description	Required	Verstek
default_value		De standaardwaarde voor de invoer als er geen runtime-waarde is opgegeven.	No
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de invoer.	No
required	boolean	Of de invoereigenschap vereist is wanneer de agent wordt aangeroepen.	No	Onwaar
schema	object	Het JSON-schema voor de gestructureerde invoer (optioneel).	No

StructuredOutputDefinition

Een gestructureerde uitvoer die door de agent kan worden geproduceerd.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een beschrijving van de uitvoer die moet worden verzonden. Wordt gebruikt door het model om te bepalen wanneer de uitvoer moet worden verzonden.	Yes
naam	tekenreeks	De naam van de gestructureerde uitvoer.	Yes
schema	object	Het JSON-schema voor de gestructureerde uitvoer.	Yes
streng	Booleaanse waarde (nullable)	Of strikte validatie moet worden afgedwongen. Standaard true.	Yes

StructuredOutputsOutputItem

Name	Typ	Description	Required	Verstek
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
output		De gestructureerde uitvoer die tijdens het antwoord is vastgelegd.	Yes
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
type	enum	Mogelijke waarden: structured_outputs	Yes

SyntheticDataGenerationPreviewEvalRunDataSource

Vertegenwoordigt een gegevensbron voor evaluatieuitvoeringen die worden geëvalueerd op basis van gegenereerde synthetische gegevens voor testdoeleinden.

Name	Typ	Description	Required	Verstek
invoer_berichten	OpenAI.CreateEvalResponsesRunDataSourceInputMessagesTemplate		No
└─ sjabloon	matrix van object of OpenAI.EvalItem		Yes
└type.	enum	Mogelijke waarden: template	Yes
item_generation_params	SyntheticDataGenerationPreviewItemGenerationParams		Yes
└model_deployment_name	tekenreeks	De naam van de modelimplementatie die moet worden gebruikt voor het genereren van synthetische gegevens.	Yes
└output_dataset_id	tekenreeks (alleen-lezen)	De id van de uitvoergegevensset waar gegenereerde synthetische gegevens worden opgeslagen. De gegenereerde gegevens zijn een jsonl-bestand met kolommen-id, query en test_description.	No
└output_dataset_name	tekenreeks	De naam van de uitvoergegevensset waar gegenereerde synthetische gegevens worden opgeslagen. Als deze niet is opgegeven, genereert de service automatisch de naam van de gegevensset.	No
└prompt.	tekenreeks	De prompt die wordt gebruikt voor het genereren van synthetische gegevens. Dit is een optie als het doel van het type 'azure_ai_agent' is met instructies die zijn geconfigureerd in de agent.	No
└samples_count	integer	Het maximum aantal gegevensvoorbeelden dat moet worden gegenereerd.	Yes
└bronnen.	matrix van OpenAI.EvalJsonlFileIdSource	De optionele seed-gegevensinhoudsbronbestanden voor het genereren van gegevens.	Yes
└type.	enum	Het type parameters voor het genereren van items. Mogelijke waarden: synthetic_data_gen_preview	Yes
target	Doel	Basisklasse voor doelen met discriminatorondersteuning.	Yes
└type.	tekenreeks	Het type doel.	Yes
type	enum	Het type gegevensbron, altijd azure_ai_synthetic_data_gen_preview. Mogelijke waarden: azure_ai_synthetic_data_gen_preview	Yes

SyntheticDataGenerationPreviewItemGenerationParams

Name	Typ	Description	Required	Verstek
model_deployment_name	tekenreeks	De naam van de modelimplementatie die moet worden gebruikt voor het genereren van synthetische gegevens.	Yes
output_dataset_id	tekenreeks (alleen-lezen)	De id van de uitvoergegevensset waar gegenereerde synthetische gegevens worden opgeslagen. De gegenereerde gegevens zijn een jsonl-bestand met kolommen-id, query en test_description.	No
output_dataset_name	tekenreeks	De naam van de uitvoergegevensset waar gegenereerde synthetische gegevens worden opgeslagen. Als deze niet is opgegeven, genereert de service automatisch de naam van de gegevensset.	No
prompt	tekenreeks	De prompt die wordt gebruikt voor het genereren van synthetische gegevens. Dit is een optie als het doel van het type 'azure_ai_agent' is met instructies die zijn geconfigureerd in de agent.	No
samples_count	integer	Het maximum aantal gegevensvoorbeelden dat moet worden gegenereerd.	Yes
Bronnen	matrix van OpenAI.EvalJsonlFileIdSource	De optionele seed-gegevensinhoudsbronbestanden voor het genereren van gegevens.	Yes
type	enum	Het type parameters voor het genereren van items. Mogelijke waarden: synthetic_data_gen_preview	Yes

Doel

Basisklasse voor doelen met discriminatorondersteuning.

Onderscheid maken voor doel

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
azure_ai_model	AzureAIModelTarget
azure_ai_agent	AzureAIAgentTarget

Name	Typ	Description	Required	Verstek
type	tekenreeks	Het type doel.	Yes

TargetCompletionEvalRunDataSource

Vertegenwoordigt een gegevensbron voor op doel gebaseerde voltooiingsevaluatieconfiguratie.

Name	Typ	Description	Required	Verstek
invoer_berichten	OpenAI.CreateEvalCompletionsRunDataSourceInputMessagesItemReference		No
└ item_reference	tekenreeks		Yes
└type.	enum	Mogelijke waarden: item_reference	Yes
source	OpenAI.EvalJsonlFileContentSource of OpenAI.EvalJsonlFileIdSource	De bronconfiguratie voor inline- of bestandsgegevens.	Yes
target	Doel	Basisklasse voor doelen met discriminatorondersteuning.	Yes
└type.	tekenreeks	Het type doel.	Yes
type	enum	Het type gegevensbron, altijd azure_ai_target_completions. Mogelijke waarden: azure_ai_target_completions	Yes

TargetConfig

Abstracte klasse voor doelconfiguratie.

Discriminator voor TargetConfig

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
AzureOpenAIModel	AzureOpenAIModelConfiguration

Name	Typ	Description	Required	Verstek
type	tekenreeks	Type van de modelconfiguratie.	Yes

TargetUpdate

Basisklasse voor doelen met discriminatorondersteuning.

Discriminator voor TargetUpdate

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
azure_ai_model	AzureAIModelTargetUpdate
azure_ai_agent	AzureAIAgentTargetUpdate

Name	Typ	Description	Required	Verstek
type	tekenreeks	Het type doel.	Yes

TaxonomieCategory

Definitie van taxonomiecategorie.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Beschrijving van de taxonomiecategorie.	No
id	tekenreeks	Unieke id van de taxonomiecategorie.	Yes
naam	tekenreeks	Naam van de taxonomiecategorie.	Yes
properties	object	Aanvullende eigenschappen voor de taxonomiecategorie.	No
riskCategory	RiskCategory	Risicocategorie voor het aanvalsdoel.	Yes
Subcategorieën	matrix van TaxonomieSubCategory	Lijst met subcategorieën voor taxonomie.	Yes

TaxonomieSubCategory

Definitie van subcategorie taxonomie.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Beschrijving van de subcategorie taxonomie.	No
enabled	boolean	Lijst met taxonomie-items onder deze subcategorie.	Yes
id	tekenreeks	Unieke id van de subcategorie taxonomie.	Yes
naam	tekenreeks	Naam van de subcategorie taxonomie.	Yes
properties	object	Aanvullende eigenschappen voor de subcategorie taxonomie.	No

ToolDescription

Beschrijving van een tool die door een agent kan worden gebruikt.

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een korte beschrijving van het doel van het hulpmiddel.	No
naam	tekenreeks	De naam van het hulpprogramma.	No

ToolProjectConnection

Een project verbindingsresource.

Name	Typ	Description	Required	Verstek
project_connection_id	tekenreeks	Een projectverbinding in een ToolProjectConnectionList die aan dit hulpprogramma is gekoppeld.	Yes

TracesPreviewEvalRunDataSource

Vertegenwoordigt een gegevensbron voor evaluatieuitvoeringen die worden uitgevoerd via agenttraceringen die zijn opgeslagen in Application Insights.

Name	Typ	Description	Required	Verstek
agent_id	tekenreeks	De agent-id die wordt gebruikt voor het filteren van traceringen voor evaluatie.	No
agent_name	tekenreeks	De agentnaam die wordt gebruikt voor het filteren van traceringen voor evaluatie.	No
eindtijd	integer	Unix-tijdstempel (in seconden) die het einde van het traceringsqueryvenster markeert. De standaardinstelling is de huidige tijd.	No
ingestion_delay_seconds	integer	De vertraging die moet worden toegepast op opname bij het uitvoeren van query's op traceringen.	No	300
lookback_hours	integer	Lookback-venster (in uren) toegepast bij het ophalen van traceringen uit Application Insights. Voor geplande evaluaties wordt dit afgeleid van het terugkeerinterval.	No	168
max_traces	integer	De steekproeflimiet die is toegepast op traceringen die zijn opgehaald voor evaluatie.	No	1000
trace_ids	array van tekenreeksen	Verzameling agenttracerings-id's die moeten worden geëvalueerd.	No
type	enum	Het type gegevensbron, altijd azure_ai_traces_preview. Mogelijke waarden: azure_ai_traces_preview	Yes

TreatmentEffectType

Type behandelingseffect.

Property	Value
Description	Type behandelingseffect.
Type	tekenreeks
waarden	TooFewSamples Inconclusive Changed Improved Degraded

Trigger

Basismodel voor Trigger van het rooster.

Discriminator voor trigger

Dit onderdeel maakt gebruik van de eigenschap type om onderscheid te maken tussen verschillende typen:

Typewaarde	Schema
Cron	CronTrigger-
Recurrence	RecurrenceTrigger-
OneTime	OneTimeTrigger

Name	Typ	Description	Required	Verstek
type	TriggerType	Type van de trekker.	Yes

TriggerType

Type van de trekker.

Property	Value
Description	Type van de trekker.
Type	tekenreeks
waarden	Cron Recurrence OneTime

UpdateAgentFromManifestRequest

Name	Typ	Description	Required	Verstek
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	tekenreeks	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
parameter_values	object	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

UpdateAgentRequest

Name	Typ	Description	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
beschrijving	tekenreeks	Een voor mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	object	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

UpdateEvalParametersBody

Name	Typ	Description	Required	Verstek
metadata	OpenAI.Metadata (nulbaar)	Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan zijn handig voor het opslaan van aanvullende informatie over het object in een gestructureerde opmaken en queries uitvoeren voor objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No
naam	tekenreeks		No
properties	object	Set onveranderbare 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld voor het opslaan van aanvullende informatie. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens.	No

UserProfileMemoryItem

Een geheugenitem dat specifiek gebruikersprofielinformatie bevat die is geëxtraheerd uit gesprekken, zoals voorkeuren, interesses en persoonlijke gegevens.

Name	Typ	Description	Required	Verstek
inhoud	tekenreeks	De inhoud van het geheugen.	Yes
vriendelijk	enum	Het type geheugenitem. Mogelijke waarden: user_profile	Yes
memory_id	tekenreeks	De unieke ID van het geheugenitem.	Yes
scope	tekenreeks	De naamruimte die herinneringen logisch groepeert en isoleert, zoals een gebruikers-ID.	Yes
updated_at	integer	De laatste updatetijd van het geheugenitem.	Yes

WebSearchConfiguration

Een webzoekconfiguratie voor bing aangepaste zoekopdrachten

Name	Typ	Description	Required	Verstek
instance_name	tekenreeks	Naam van het aangepaste configuratie-exemplaar dat is opgegeven voor de configuratie.	Yes
project_connection_id	tekenreeks	Project verbindings-id voor grounding met Bing Custom Search	Yes

WeeklyRecurrenceSchedule

Wekelijks herhalingsschema.

Name	Typ	Description	Required	Verstek
dagenVanWeek	matrix van DayOfWeek	Dagen van de week voor het terugkeerschema.	Yes
type	enum	Wekelijks terugkeerpatroon. Mogelijke waarden: Weekly	Yes

WorkflowActionOutputItem

Name	Typ	Description	Required	Verstek
action_id	tekenreeks	Unieke id voor de actie.	Yes
agent_reference	AgentReference		No
└─naam	tekenreeks	De naam van de agent. Beperkingen: maxLength: 256	Yes
└type.	enum	Mogelijke waarden: agent_reference	Yes
└─ versie	tekenreeks	De versie-id van de agent.	No
vriendelijk	tekenreeks	Het type CSDL-actie (bijvoorbeeld 'SetVariable', 'InvokeAzureAgent').	Yes
parent_action_id	tekenreeks	Id van de bovenliggende actie als dit een geneste actie is.	No
previous_action_id	tekenreeks	Id van de vorige actie als deze actie een andere actie volgt.	No
response_id	tekenreeks	Het antwoord waarop het item is gemaakt.	No
status	enum	Status van de actie (bijvoorbeeld 'in_progress', 'voltooid', 'mislukt', 'geannuleerd'). Mogelijke waarden: completed, failed, , in_progresscancelled	Yes
type	enum	Mogelijke waarden: workflow_action	Yes

WorkflowAgentDefinition

De definitie van de workflowagent.

Name	Typ	Description	Required	Verstek
vriendelijk	enum	Mogelijke waarden: workflow	Yes
rai_config	RaiConfig	Configuratie voor Responsible AI (RAI) contentfiltering en veiligheidsfuncties.	No
└rai_policy_name	tekenreeks	De naam van het RAI-beleid dat moet worden toegepast.	Yes
werkstroom	tekenreeks	De CSDL YAML-definitie van de werkstroom.	No

integer

Type: geheel getal

Indeling: int64