Microsoft Foundry - agenten

API-versie: v1

Server:{endpoint} — Microsoft Foundry

Servervariabelen:

Variabele	Verstek	Beschrijving
endpoint		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"

Authenticatie

OAuth2Auth (OAuth 2.0)

Flow: impliciet

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

Scopes:

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

Beveiligingsvereisten

Alle eindpunten vereisen OAuth2Auth (scopes: https://ai.azure.com/.default).

Agents - agent maken

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

Hiermee maakt u de agent.

URI-parameters

Name	In	Required	Typ	Beschrijving
endpoint	server	Yes	string	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	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Koptekst van aanvraag

Name	Required	Typ	Beschrijving
Foundry-Features	No	string Mogelijke waarden: HostedAgents=V1Preview, WorkflowAgents=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	Beschrijving	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	Voorwerp	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
name	string	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	Typ	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	ApiErrorResponse

Agents - agents weergeven

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

Retourneert de lijst met alle agents.

URI-parameters

Name	In	Required	Typ	Beschrijving
endpoint	server	Yes	string	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"
kind	zoekopdracht	No	string Mogelijke waarden: prompt, hostedworkflow	Filter agents op soort. Indien niet opgegeven, worden alle agents geretourneerd. Serialisatie: explode: false
limit	zoekopdracht	No	geheel getal (int32)	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. Serialisatie: explode: false
order	zoekopdracht	No	string Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde. Serialisatie: explode: false
after	zoekopdracht	No	string	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. Serialisatie: explode: false
voordat	zoekopdracht	No	string	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. Serialisatie: explode: false
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	Voorwerp	De antwoordgegevens voor een aangevraagde lijst met items.

Name	Typ	Beschrijving	Required	Verstek
data	array van AgentObject	De gevraagde lijst met items.	Yes
first_id	string	De eerste ID die in deze lijst wordt weergegeven.	No
heeft_meer	boolean	Een waarde die aangeeft of er extra waarden beschikbaar zijn die niet in deze lijst zijn opgenomen.	Yes
last_id	string	De laatste ID die in deze lijst wordt weergegeven.	No

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	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	Beschrijving
endpoint	server	Yes	string	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	string	De naam van de agent die moet worden opgehaald.
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	ApiErrorResponse

Agents - agent bijwerken

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

Hiermee wordt de agent bijgewerkt door een nieuwe versie toe te voegen als er wijzigingen in de agentdefinitie zijn. Als er geen wijzigingen worden aangebracht, wordt de bestaande agentversie geretourneerd.

URI-parameters

Name	In	Required	Typ	Beschrijving
endpoint	server	Yes	string	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	string	De naam van de agent die moet worden opgehaald.
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Koptekst van aanvraag

Name	Required	Typ	Beschrijving
Foundry-Features	No	string Mogelijke waarden: HostedAgents=V1Preview, WorkflowAgents=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	Beschrijving	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	Voorwerp	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	Typ	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	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	Beschrijving
endpoint	server	Yes	string	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	string	De naam van de agent die u wilt verwijderen.
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	DeleteAgentResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	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 worden aangebracht, wordt de bestaande agentversie geretourneerd.

URI-parameters

Name	In	Required	Typ	Beschrijving
endpoint	server	Yes	string	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	string	De naam van de agent die moet worden bijgewerkt.
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	string	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	Voorwerp	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	Voorwerp	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	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	Beschrijving
endpoint	server	Yes	string	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	string	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	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Koptekst van aanvraag

Name	Required	Typ	Beschrijving
Foundry-Features	No	string Mogelijke waarden: HostedAgents=V1Preview, WorkflowAgents=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	Beschrijving	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	Voorwerp	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	Typ	Description
application/json	AgentVersionObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	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	Beschrijving
endpoint	server	Yes	string	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	string	De naam van de agent voor het ophalen van versies.
limit	zoekopdracht	No	geheel getal (int32)	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. Serialisatie: explode: false
order	zoekopdracht	No	string Mogelijke waarden: asc, desc	Sorteer de volgorde op de created_at tijdstempel van de objecten. asc voor oplopende volgorde endesc voor aflopende volgorde. Serialisatie: explode: false
after	zoekopdracht	No	string	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. Serialisatie: explode: false
voordat	zoekopdracht	No	string	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. Serialisatie: explode: false
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	Voorwerp	De antwoordgegevens voor een aangevraagde lijst met items.

Name	Typ	Beschrijving	Required	Verstek
data	array van AgentVersionObject	De gevraagde lijst met items.	Yes
first_id	string	De eerste ID die in deze lijst wordt weergegeven.	No
heeft_meer	boolean	Een waarde die aangeeft of er extra waarden beschikbaar zijn die niet in deze lijst zijn opgenomen.	Yes
last_id	string	De laatste ID die in deze lijst wordt weergegeven.	No

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	ApiErrorResponse

Agents - agentversie ophalen

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

Hiermee haalt u een specifieke versie van een agent op.

URI-parameters

Name	In	Required	Typ	Beschrijving
endpoint	server	Yes	string	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	string	De naam van de agent die moet worden opgehaald.
agent_version	path	Yes	string	De versie van de agent die moet worden opgehaald.
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AgentVersionObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	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	Beschrijving
endpoint	server	Yes	string	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	string	De naam van de agent die u wilt verwijderen.
agent_version	path	Yes	string	De versie van de agent die u wilt verwijderen
api-versie	zoekopdracht	Yes	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	DeleteAgentVersionResponse

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	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	Beschrijving
endpoint	server	Yes	string	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	string	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	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	string	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	Voorwerp	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	Voorwerp	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AgentVersionObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	ApiErrorResponse

Agents - agent maken vanuit manifest

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

Hiermee maakt u een agent op basis van een manifest.

URI-parameters

Name	In	Required	Typ	Beschrijving
endpoint	server	Yes	string	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	string	De API-versie die voor deze bewerking moet worden gebruikt. Serialisatie: explode: false

Aanvraaglichaam

Inhoudstype: toepassing/json

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	string	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	Voorwerp	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
name	string	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	Voorwerp	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

Responses

Statuscode: 200

Beschrijving: De aanvraag is geslaagd.

Inhoudstype	Typ	Description
application/json	AgentObject

Statuscode: standaard

Beschrijving: Een onverwachte foutreactie.

Inhoudstype	Typ	Description
application/json	ApiErrorResponse

Components

A2APreviewTool

Een agent die het A2A-protocol implementeert.

Name	Typ	Beschrijving	Required	Verstek
agent_card_path	string	Het pad naar de agentkaart ten opzichte van de base_url. Als dit niet is opgegeven, wordt standaard ingesteld op /.well-known/agent-card.json	No
base_url	tekenreeks (URI)	Basis-URL van de agent.	No
project_connection_id	string	De verbindings-id in het project voor de A2A-server. De verbinding slaat verificatie 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 Search Index-resource.

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

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

Name	Typ	Beschrijving	Required	Verstek
kind	AgentKind		Yes
rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
└rai_policy_name	string	De naam van het RAI-beleid dat moet worden toegepast.	Yes

AgentDefinitionOptInKeys

Feature opt-in sleutels voor agentdefinitieoperaties die gehoste of workflow-agents ondersteunen.

Vastgoed	Value
Typ	string
waarden	HostedAgents=V1Preview WorkflowAgents=V1Preview

AgentKind

Vastgoed	Value
Typ	string
waarden	prompt hosted workflow

AgentObject

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

AgentProtocol

Vastgoed	Value
Typ	string
waarden	activity_protocol responses

AgentVersionObject

Name	Typ	Beschrijving	Required	Verstek
aangemaakt_op	FoundryTimestamp		Yes
definitie	AgentDefinition		Yes
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
id	string	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
name	string	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
Voorwerp	enum	Het objecttype, dat altijd 'agent.version' is. Mogelijke waarden: agent.version	Yes
version	string	De versie-id van de agent. Agents zijn onveranderbaar en elke update maakt een nieuwe versie en houdt dezelfde naam.	Yes

ApiErrorResponse

Foutreactie voor API-fouten.

Name	Typ	Beschrijving	Required	Verstek
error	OpenAI.Error		Yes

AzureAISearchQueryType

Beschikbare querytypen voor Azure AI Zoeken hulpprogramma.

Vastgoed	Value
Description	Beschikbare querytypen voor Azure AI Zoeken hulpprogramma.
Typ	string
waarden	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

AzureAISearchTool

De informatie over de invoerdefinitie voor een Azure AI-zoekprogramma zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Beschrijving	Required	Verstek
azure_ai_search	AzureAISearchToolResource	Een set indexbronnen die door het azure_ai_search hulpprogramma worden gebruikt.	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 door het azure_ai_search hulpprogramma worden gebruikt.

Name	Typ	Beschrijving	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. Beperkingen: maxItems: 1	Yes

AzureFunctionBinding

De structuur voor het behouden van de naam en URI van de opslagwachtrij.

Name	Typ	Beschrijving	Required	Verstek
storage_queue	AzureFunctionStorageQueue	De structuur voor het behouden van de naam en URI van de opslagwachtrij.	Yes
└queue_name	string	De naam van een Azure functieopslagwachtrij.	Yes
└queue_service_endpoint	string	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 Azure functie.

Name	Typ	Beschrijving	Required	Verstek
function	Voorwerp	De definitie van de Azure-functie en de bijbehorende parameters.	Yes
└─ Beschrijving	string	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	string	De naam van de functie die moet worden aangeroepen.	Yes
└- parameters	Voorwerp	De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject.	Yes
input_binding	AzureFunctionBinding	De structuur voor het behouden van de naam en URI van de opslagwachtrij.	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 de naam en URI van de opslagwachtrij.	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 de naam en URI van de opslagwachtrij.

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

AzureFunctionTool

De informatie over de invoerdefinitie voor een Azure Functiehulpprogramma, zoals wordt gebruikt om een agent te configureren.

Name	Typ	Beschrijving	Required	Verstek
azure_function	AzureFunctionDefinition	De definitie van Azure functie.	Yes
└, functie	Voorwerp	De definitie van de Azure-functie en de bijbehorende parameters.	Yes
└─ Beschrijving	string	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	string	De naam van de functie die moet worden aangeroepen.	Yes
└- parameters	Voorwerp	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

BingCustomSearchConfiguration

Een bing aangepaste zoekconfiguratie.

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

BingCustomSearchPreviewTool

De invoerdefinitiegegevens voor een bing-hulpprogramma voor aangepaste zoekopdrachten, zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Beschrijving	Required	Verstek
bing_custom_search_preview	BingCustomSearchToolParameters	De parameters van het bing Custom Search-hulpprogramma.	Yes
└search_configurations	matrix van BingCustomSearchConfiguration	De projectverbindingen 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 parameters van het bing Custom Search-hulpprogramma.

Name	Typ	Beschrijving	Required	Verstek
search_configurations	matrix van BingCustomSearchConfiguration	De projectverbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma. Beperkingen: maxItems: 1	Yes

BingGroundingSearchConfiguration

Zoekconfiguratie voor Bing Grounding

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

BingGroundingSearchToolParameters

De parameters van het bing grounding-zoekprogramma.

Name	Typ	Beschrijving	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. Beperkingen: maxItems: 1	Yes

BingGroundingTool

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

Name	Typ	Beschrijving	Required	Verstek
bing_grounding	BingGroundingSearchToolParameters	De parameters van het bing grounding-zoekprogramma.	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

BrowserAutomationPreviewTool

De informatie over de invoerdefinitie voor een hulpprogramma voor browserautomatisering, zoals wordt gebruikt om een agent te configureren.

Name	Typ	Beschrijving	Required	Verstek
browser_automation_preview	BrowserAutomationToolParameters	Definitie van invoerparameters voor het browserautomatiseringsprogramma.	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 het hulpprogramma BrowserAutomatisering.

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

BrowserAutomationToolParameters

Definitie van invoerparameters voor het browserautomatiseringsprogramma.

Name	Typ	Beschrijving	Required	Verstek
verbinding	BrowserAutomationToolConnectionParameters	Definitie van invoerparameters voor de verbinding die wordt gebruikt door het hulpprogramma BrowserAutomatisering.	Yes
└project_connection_id	string	De id van de projectverbinding met uw Azure Playwright-resource.	Yes

CaptureStructuredOutputsTool

Een hulpprogramma voor het vastleggen van gestructureerde uitvoer

Name	Typ	Beschrijving	Required	Verstek
outputs	StructuredOutputDefinition	Een gestructureerde uitvoer die door de agent kan worden geproduceerd.	Yes
└─ Beschrijving	string	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	string	De naam van de gestructureerde uitvoer.	Yes
└─ schema	Voorwerp	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

CreateAgentFromManifestRequest

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	string	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	Voorwerp	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
name	string	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	Voorwerp	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

CreateAgentRequest

Name	Typ	Beschrijving	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	Voorwerp	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
name	string	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	Beschrijving	Required	Verstek
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	string	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	Voorwerp	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	Voorwerp	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

CreateAgentVersionRequest

Name	Typ	Beschrijving	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	Voorwerp	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

DeleteAgentResponse

Een verwijderd agentobject

Name	Typ	Beschrijving	Required	Verstek
verwijderd	boolean	Of de agent is verwijderd.	Yes
name	string	De naam van de agent.	Yes
Voorwerp	enum	Het objecttype. Altijd 'agent.deleted'. Mogelijke waarden: agent.deleted	Yes

DeleteAgentVersionResponse

Een verwijderd agentversieobject

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

FabricDataAgentToolParameters

De hulpprogrammaparameters voor de fabric-gegevensagent.

Name	Typ	Beschrijving	Required	Verstek
project_connections	matrix van ToolProjectConnection	De projectverbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma. Beperkingen: maxItems: 1	No

FoundryTimestamp

Type: geheel getal

Formaat: unixtime

HostedAgentDefinition

De definitie van de gehoste agent.

Name	Typ	Beschrijving	Required	Verstek
container_protocol_versions	matrix van ProtocolVersionRecord	De protocollen die de agent ondersteunt voor inkomend verkeer van de containers.	Yes
cpu	string	De CPU-configuratie voor de gehoste agent.	Yes
environment_variables	Voorwerp	Omgevingsvariabelen die moeten worden ingesteld in de gehoste agentcontainer.	No
image	string	De installatiekopie-id voor de agent, die van toepassing is op gehoste agents op basis van installatiekopieën.	No
kind	enum	Mogelijke waarden: hosted	Yes
memory	string	De geheugenconfiguratie voor de gehoste agent.	Yes
rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
└rai_policy_name	string	De naam van het RAI-beleid dat moet worden toegepast.	Yes
tools	matrix van OpenAI.Tool	Een matrix met hulpprogramma's die het model van de gehoste agent 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

MemorySearchOptions

Opties voor zoeken in geheugen.

Name	Typ	Beschrijving	Required	Verstek
max_memories	geheel getal (int32)	Maximum aantal geheugenitems dat moet worden geretourneerd.	No

MemorySearchPreviewTool

Een hulpprogramma voor het integreren van herinneringen in de agent.

Name	Typ	Beschrijving	Required	Verstek
memory_store_name	string	De naam van het geheugenarchief dat moet worden gebruikt.	Yes
scope	string	De naamruimte die wordt gebruikt om herinneringen te groeperen en te isoleren, zoals een gebruikers-id. Limieten welke geheugens kunnen worden opgehaald of bijgewerkt. Gebruik speciale variabele {{$userId}} om geheugens te bepalen voor de huidige aangemelde gebruiker.	Yes
search_options	MemorySearchOptions	Opties voor zoeken in geheugen.	No
└max_memories	geheel getal (int32)	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	geheel getal (int32)	Tijd om te wachten voordat geheugen wordt bijgewerkt na inactiviteit (seconden). Standaard 300.	No	300

MicrosoftFabricPreviewTool

De informatie over de invoerdefinitie voor een Microsoft Fabric hulpprogramma zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Beschrijving	Required	Verstek
fabric_dataagent_preview	FabricDataAgentToolParameters	De hulpprogrammaparameters voor de fabric-gegevensagent.	Yes
└project_connections	matrix van ToolProjectConnection	De projectverbindingen 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

OpenAI.ApplyPatchToolParam

Apply patch tool

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

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

OpenAI.ApproximateLocation

Name	Typ	Beschrijving	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	benadering

OpenAI.AutoCodeInterpreterToolParam

Parameters van het automatische code-interpreterhulpmiddel

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

Name	Typ	Beschrijving	Required	Verstek
file_ids	array van tekenreeksen	Een optionele lijst met geüploade bestanden om beschikbaar te maken voor uw code. Beperkingen: maxItems: 50	No
geheugenlimiet	OpenAI.ContainerMemoryLimit (nul)		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Netwerktoegangsbeleid voor de container.	No
type	enum	Altijd auto. Mogelijke waarden: auto	Yes	auto

OpenAI.CodeInterpreterTool

Code-interpreter

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

Name	Typ	Beschrijving	Required	Verstek
container	string of OpenAI.AutoCodeInterpreterToolParam	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.ComparisonFilter

Vergelijkingsfilter

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

Name	Typ	Beschrijving	Required	Verstek
key	string	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	Eq
value	string of OpenAI.numeric of boolean of array of string of OpenAI.numeric	De waarde die moet worden vergeleken met de kenmerksleutel; ondersteunt tekenreeks-, getal- of booleaanse typen.	Yes

OpenAI.CompoundFilter

Samengesteld filter

Meerdere filters combineren met and of or.

Name	Typ	Beschrijving	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.ComputerEnvironment

Vastgoed	Value
Typ	string
waarden	windows mac linux ubuntu browser

OpenAI.ComputerUsePreviewTool

Computergebruikspreview

Een hulpprogramma waarmee een virtuele computer wordt bestuurd.

Name	Typ	Beschrijving	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	computer_use_preview

OpenAI.ContainerAutoParam

Name	Typ	Beschrijving	Required	Verstek
file_ids	array van tekenreeksen	Een optionele lijst met geüploade bestanden om beschikbaar te maken voor uw code. Beperkingen: maxItems: 50	No
geheugenlimiet	OpenAI.ContainerMemoryLimit (nul)		No
network_policy	OpenAI.ContainerNetworkPolicyParam	Netwerktoegangsbeleid voor de container.	No
Vaardigheden	array van OpenAI.ContainerSkill	Een optionele lijst van vaardigheden die worden aangeduid door id of inline data. Beperkingen: maxItems: 200	No
type	enum	Maakt automatisch een container aan voor dit verzoek Mogelijke waarden: container_auto	Yes	container_auto

OpenAI.ContainerMemoryLimit

Vastgoed	Value
Typ	string
waarden	1g 4g 16g 64g

OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Beschrijving	Required	Verstek
allowed_domains	array van tekenreeksen	Een lijst van toegestane domeinen wanneer type is allowlist. Beperkingen: minItems: 1	Yes
domain_secrets	array van OpenAI.ContainerNetworkPolicyDomainSecretParam	Optionele domein-scoped secrets voor toegestane domeinen. Beperkingen: minItems: 1	No
type	enum	Sta uitgaande netwerktoegang alleen toe naar bepaalde domeinen. Altijd allowlist. Mogelijke waarden: allowlist	Yes	Toestemmingslijst

OpenAI.ContainerNetworkPolicyDisabledParam

Name	Typ	Beschrijving	Required	Verstek
type	enum	Schakel uitgaande netwerktoegang uit. Altijd disabled. Mogelijke waarden: disabled	Yes	uitgeschakeld

OpenAI.ContainerNetworkPolicyDomainSecretParam

Name	Typ	Beschrijving	Required	Verstek
domain	string	Het domein dat met het geheim wordt geassocieerd. Beperkingen: minLength: 1	Yes
name	string	De naam van het geheim om voor het domein te injecteren. Beperkingen: minLength: 1	Yes
value	string	De geheime waarde die voor het domein moet worden ingevoegd. Beperkingen: minLengte: 1, maxLengte: 10485760	Yes

OpenAI.ContainerNetworkPolicyParam

Netwerktoegangsbeleid voor de container.

Discriminator voor OpenAI.ContainerNetworkPolicyParam

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

Typewaarde	Schema
disabled	OpenAI.ContainerNetworkPolicyDisabledParam
allowlist	OpenAI.ContainerNetworkPolicyAllowlistParam

Name	Typ	Beschrijving	Required	Verstek
type	OpenAI.ContainerNetworkPolicyParamType		Yes

OpenAI.ContainerNetworkPolicyParamType

Vastgoed	Value
Typ	string
waarden	disabled allowlist

OpenAI.ContainerSkill

Discriminator voor OpenAI.ContainerSkill

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

Typewaarde	Schema
skill_reference	OpenAI.SkillReferenceParam
inline	OpenAI.InlineSkillParam

Name	Typ	Beschrijving	Required	Verstek
type	OpenAI.ContainerSkillType		Yes

OpenAI.ContainerSkillType

Vastgoed	Value
Typ	string
waarden	skill_reference inline

OpenAI.CustomGrammarFormatParam

Grammaticaformaat

Een grammatica gedefinieerd door de gebruiker.

Name	Typ	Beschrijving	Required	Verstek
definitie	string	De grammaticale definitie.	Yes
syntaxis	OpenAI.GrammarSyntax1		Yes
type	enum	Grammaticale formaat. Altijd grammar. Mogelijke waarden: grammar	Yes	Grammatica

OpenAI.CustomTextFormatParam

Tekstopmaak

Onbeperkte vrije vorm tekst.

Name	Typ	Beschrijving	Required	Verstek
type	enum	Onbeperkt tekstformaat. Altijd text. Mogelijke waarden: text	Yes	text

OpenAI.CustomToolParam

Aangepaste tool

Een aangepaste tool die input verwerkt met een gespecificeerd formaat. Lees meer over aangepaste tools

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	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
name	string	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	custom

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	Beschrijving	Required	Verstek
type	OpenAI.CustomToolParamFormatType		Yes

OpenAI.CustomToolParamFormatType

Vastgoed	Value
Typ	string
waarden	text grammar

OpenAI.Error

Name	Typ	Beschrijving	Required	Verstek
aanvullende informatie	Voorwerp		No
code	tekenreeks (nullable)		Yes
foutopsporingInfo	Voorwerp		No
details	matrix van OpenAI.Error		No
message	string		Yes
param	tekenreeks (nullable)		No
type	string		No

OpenAI.FileSearchTool

Zoeken naar bestanden

Een hulpprogramma waarmee wordt gezocht naar relevante inhoud uit geüploade bestanden.

Name	Typ	Beschrijving	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	file_search
vector_store_ids	array van tekenreeksen	De id's van de vectorarchieven om te zoeken.	Yes

OpenAI.Filters

Type: OpenAI.ComparisonFilter of OpenAI.CompoundFilter

OpenAI.FunctionShellToolParam

Schelpengereedschap

Een tool waarmee het model shell-commando's kan uitvoeren.

Name	Typ	Beschrijving	Required	Verstek
environment	OpenAI.FunctionShellToolParamEnvironment (nullbaar)		No
└type.	OpenAI.FunctionShellToolParamEnvironmentType		Yes
type	enum	Het type schelpgereedschap. Altijd shell. Mogelijke waarden: shell	Yes	Shell

OpenAI.FunctionShellToolParamEnvironment

Discriminator voor OpenAI.FunctionShellToolParamEnvironment

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

Typewaarde	Schema
local	OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam
container_reference	OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam
container_auto	OpenAI.ContainerAutoParam

Name	Typ	Beschrijving	Required	Verstek
type	OpenAI.FunctionShellToolParamEnvironmentType		Yes

OpenAI.FunctionShellToolParamEnvironmentContainerReferenceParam

Name	Typ	Beschrijving	Required	Verstek
container_id	string	De ID van de genoemde container.	Yes
type	enum	Verwijst naar een container die is aangemaakt met het /v1/containers-eindpunt Mogelijke waarden: container_reference	Yes	container_reference

OpenAI.FunctionShellToolParamEnvironmentLocalEnvironmentParam

Name	Typ	Beschrijving	Required	Verstek
Vaardigheden	array van OpenAI.LocalSkillParam	Een optionele lijst met vaardigheden. Beperkingen: maxItems: 200	No
type	enum	Gebruik een lokale computeromgeving. Mogelijke waarden: local	Yes	lokaal

OpenAI.FunctionShellToolParamEnvironmentType

Vastgoed	Value
Typ	string
waarden	container_auto local container_reference

OpenAI.FunctionTool

Functie

Definieert een functie in uw eigen code die het model kan aanroepen.

Name	Typ	Beschrijving	Required	Verstek
beschrijving	tekenreeks (nullable)		No
name	string	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	function

OpenAI.GrammarSyntax1

Vastgoed	Value
Typ	string
waarden	lark regex

OpenAI.HybridSearchOptions

Name	Typ	Beschrijving	Required	Verstek
embedding_weight	OpenAI.numeriek		Yes
text_weight	OpenAI.numeriek		Yes

OpenAI.ImageGenActionEnum

Vastgoed	Value
Typ	string
waarden	generate edit auto

OpenAI.ImageGenTool

Beeldgeneratietool

Een tool die afbeeldingen genereert met behulp van de GPT-beeldmodellen.

Geldige modellen:

gpt-image-1
gpt-image-1-mini
gpt-image-1.5

Name	Typ	Beschrijving	Required	Verstek
action	OpenAI.ImageGenActionEnum		No
achtergrond	enum	Achtergrondtype voor de gegenereerde afbeelding. Eén van transparent, opaque, of auto. Standaard: auto. Mogelijke waarden: transparent, opaqueauto	No	auto
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 en gpt-image-1.5 en latere modellen, 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	string		No
└─image_url	tekenreeks (URI)		No
model	tekenreeks (zie geldige modellen hieronder)		No
moderation	enum	Beheerniveau voor de gegenereerde afbeelding. Standaard: auto. Mogelijke waarden: auto, low	No	auto
uitvoercompressie	OpenAI.integer	Beperkingen: min. 0, max: 100	No	100
uitvoerformaat	enum	De uitvoerindeling van de gegenereerde afbeelding. Een van png, webpof jpeg. Standaard: png. Mogelijke waarden: png, webpjpeg	No	PNG
gedeeltelijke_afbeeldingen	OpenAI.integer	Beperkingen: min. 0, max: 3	No
kwaliteit	enum	De kwaliteit van de gegenereerde afbeelding. Een van low, medium, high of auto. Standaard: auto. Mogelijke waarden: low, medium, , highauto	No	auto
size	enum	De grootte van de gegenereerde afbeelding. Een van 1024x1024, 1024x1536 1536x1024, of auto. Standaard: auto. Mogelijke waarden: 1024x1024, 1024x1536, , 1536x1024auto	No	auto
type	enum	Het type tool voor het genereren van beelden. Altijd image_generation. Mogelijke waarden: image_generation	Yes	image_generation

OpenAI.ImageGenToolInputImageMask

Name	Typ	Beschrijving	Required	Verstek
file_id	string		No
image_url	tekenreeks (URI)		No

OpenAI.InlineSkillParam

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	De beschrijving van de vaardigheid.	Yes
name	string	De naam van de vaardigheid.	Yes
bron	OpenAI.InlineSkillSourceParam	Inline vaardigheidslading	Yes
└* gegevens	string	Base64-gecodeerde skill zip-bundel. Beperkingen: minLengte: 1, maxLengte: 70254592	Yes
└─ media_type	enum	Het mediatype van de inline vaardigheidslading. Moet application/zipzijn. Mogelijke waarden: application/zip	Yes	toepassing/zip
└type.	enum	Het type inline vaardigheidsbron. Moet base64zijn. Mogelijke waarden: base64	Yes	base64
type	enum	Definieert een inline vaardigheid voor dit verzoek. Mogelijke waarden: inline	Yes	inline

OpenAI.InlineSkillSourceParam

Inline vaardigheidslading

Name	Typ	Beschrijving	Required	Verstek
data	string	Base64-gecodeerde skill zip-bundel. Beperkingen: minLengte: 1, maxLengte: 70254592	Yes
media_type	enum	Het mediatype van de inline vaardigheidslading. Moet application/zipzijn. Mogelijke waarden: application/zip	Yes	toepassing/zip
type	enum	Het type inline vaardigheidsbron. Moet base64zijn. Mogelijke waarden: base64	Yes	base64

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 en gpt-image-1.5 en latere modellen, niet ondersteund voor gpt-image-1-mini. Ondersteunt high en low. Wordt standaard ingesteld op low.

Vastgoed	Value
Typ	string
waarden	high low

OpenAI.LocalShellToolParam

Lokaal schelpengereedschap

Een hulpprogramma waarmee het model shell-opdrachten kan uitvoeren in een lokale omgeving.

Name	Typ	Beschrijving	Required	Verstek
type	enum	Het type van het lokale shell-hulpprogramma. Altijd local_shell. Mogelijke waarden: local_shell	Yes	local_shell

OpenAI.LocalSkillParam

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	De beschrijving van de vaardigheid.	Yes
name	string	De naam van de vaardigheid.	Yes
path	string	Het pad naar de map met de vaardigheid.	Yes

OpenAI.MCPTool

MCP-hulpprogramma

Geef het model toegang tot aanvullende tools via externe MCP-servers (Model Context Protocol).

Name	Typ	Beschrijving	Required	Verstek
toegestane_hulpmiddelen	matrix van tekenreeks of OpenAI.MCPToolFilter		No
authorization	string	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
Kopjes	object (nul)		No
project_connection_id	string	De verbindings-id in het 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	OpenAI.MCPToolRequireApproval of string		No
server_description	string	Optionele beschrijving van de MCP-server, gebruikt om meer context te bieden.	No
server_label	string	Een label voor deze MCP-server, dat wordt gebruikt om het te identificeren in hulpprogramma-aanroepen.	Yes
server_url	tekenreeks (URI)	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.MCPToolFilter

MCP-toolfilter

Een filterobject om aan te geven welke tools zijn toegestaan.

Name	Typ	Beschrijving	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	Beschrijving	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.RankerVersionType

Vastgoed	Value
Typ	string
waarden	auto default-2024-11-15

OpenAI.RankingOptions

Name	Typ	Beschrijving	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

Reasoning

Alleen GPT-5 en O-serie modellen Configuratieopties voor redeneermodellen.

Name	Typ	Beschrijving	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 (nul)	Mogelijke waarden: auto, concisedetailed	No
samenvatting	Enum (nul)	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.

Vastgoed	Value
Typ	string
Nullable	Yes
waarden	none minimal low medium high xhigh

OpenAI.ResponseFormatJsonSchemaSchema

JSON-schema

Het schema voor de antwoordindeling, beschreven als een JSON-schemaobject. Leer hier hoe u JSON-schema's bouwt.

Type: objecten

OpenAI.SearchContextSize

Vastgoed	Value
Typ	string
waarden	low medium high

OpenAI.SkillReferenceParam

Name	Typ	Beschrijving	Required	Verstek
skill_id	string	De ID van de genoemde vaardigheid. Beperkingen: minLength: 1, maxLength: 64	Yes
type	enum	Verwijst naar een vaardigheid die is gemaakt met het /v1/skills-eindpunt. Mogelijke waarden: skill_reference	Yes	skill_reference
version	string	Optionele vaardigheidsversie. Gebruik een positief geheel getal of 'laatste'. Laat weg voor standaard.	No

OpenAI.SpecificApplyPatchParam

Specifieke keuze voor toepassing van patch tool

Hiermee dwingt u het model om het apply_patch hulpprogramma aan te roepen bij het uitvoeren van een hulpprogramma-aanroep.

Name	Typ	Beschrijving	Required	Verstek
type	enum	Het hulpprogramma dat moet worden aangeroepen. Altijd apply_patch. Mogelijke waarden: apply_patch	Yes	apply_patch

OpenAI.SpecificFunctionShellParam

Specifieke keuze voor shellgereedschap

Dwingt het model om het shell-hulpprogramma aan te roepen wanneer een hulpprogramma-aanroep is vereist.

Name	Typ	Beschrijving	Required	Verstek
type	enum	Het hulpprogramma dat moet worden aangeroepen. Altijd shell. Mogelijke waarden: shell	Yes	Shell

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: Instellen om de oudere JSON-modus in { "type": "json_object" } te schakelen, die ervoor zorgt 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.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	Beschrijving	Required	Verstek
type	OpenAI.TextResponseFormatConfigurationType		Yes

OpenAI.TextResponseFormatConfigurationResponseFormatJsonObject

JSON-object

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	Beschrijving	Required	Verstek
type	enum	Het type antwoordindeling dat wordt gedefinieerd. Altijd json_object. Mogelijke waarden: json_object	Yes

OpenAI.TextResponseFormatConfigurationResponseFormatText

Text

De standaard antwoordindeling. Wordt gebruikt om tekstreacties te genereren.

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

OpenAI.TextResponseFormatConfigurationType

Vastgoed	Value
Typ	string
waarden	text json_schema json_object

OpenAI.TextResponseFormatJsonSchema

JSON-schema

JSON Schema-antwoordindeling. Wordt gebruikt om gestructureerde JSON-antwoorden te genereren.

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	Een beschrijving van wat de antwoordindeling is, die door het model wordt gebruikt om bepalen hoe moet worden gereageerd volgens de voorgeschreven manier.	No
name	string	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	Beschrijving	Required	Verstek
type	OpenAI.ToolType		Yes

OpenAI.ToolChoiceAllowed

Toegestane tools

Hiermee beperkt u de hulpprogramma's die beschikbaar zijn voor het model tot een vooraf gedefinieerde set.

Name	Typ	Beschrijving	Required	Verstek
mode	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	Beschrijving	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	Beschrijving	Required	Verstek
type	enum	Mogelijke waarden: computer_use_preview	Yes

OpenAI.ToolChoiceCustom

Aangepaste tool

Gebruik deze optie om af te dwingen dat het model een specifiek aangepast hulpprogramma aanroept.

Name	Typ	Beschrijving	Required	Verstek
name	string	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	Beschrijving	Required	Verstek
type	enum	Mogelijke waarden: file_search	Yes

OpenAI.ToolChoiceFunction

Functie-instrument

Gebruik deze optie om af te dwingen dat het model een specifieke functie aanroept.

Name	Typ	Beschrijving	Required	Verstek
name	string	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	Beschrijving	Required	Verstek
type	enum	Mogelijke waarden: image_generation	Yes

OpenAI.ToolChoiceMCP

MCP-hulpprogramma

Gebruik deze optie om af te dwingen dat het model een specifiek hulpprogramma aanroept op een externe MCP-server.

Name	Typ	Beschrijving	Required	Verstek
name	tekenreeks (nullable)		No
server_label	string	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.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	Beschrijving	Required	Verstek
type	OpenAI.ToolChoiceParamType		Yes

OpenAI.ToolChoiceParamType

Vastgoed	Value
Typ	string
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	Beschrijving	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	Beschrijving	Required	Verstek
type	enum	Mogelijke waarden: web_search_preview_2025_03_11	Yes

OpenAI.ToolType

Vastgoed	Value
Typ	string
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.WebSearchApproximateLocation

Webzoekopdracht bij benaderende locatie

De ongeveer locatie van de gebruiker.

Name	Typ	Beschrijving	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	benadering

OpenAI.WebSearchPreviewTool

Voorvertoning van webzoekopdrachten

Met dit hulpprogramma wordt op internet gezocht naar relevante resultaten die in een antwoord kunnen worden gebruikt. Meer informatie over het webzoekprogramma.

Name	Typ	Beschrijving	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	web_search_preview
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	benadering

OpenAI.WebSearchTool

Zoeken op internet

Zoek op internet naar bronnen met betrekking tot de prompt. Lees meer over de zoektool op het web.

Name	Typ	Beschrijving	Required	Verstek
custom_search_configuration	WebSearchConfiguration	Een webzoekconfiguratie voor bing aangepaste zoekopdrachten	No
└instance_name	string	Naam van het aangepaste configuratie-exemplaar dat is opgegeven voor de configuratie.	Yes
└project_connection_id	string	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	Gemiddeld
type	enum	Het type webzoekprogramma. Een van web_search of web_search_2025_08_26. Mogelijke waarden: web_search	Yes	webzoekopdracht
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	Yes	benadering

OpenAI.WebSearchToolFilters

Name	Typ	Beschrijving	Required	Verstek
allowed_domains	matrix van tekenreeks (nullable)		No

OpenAI.integer

Type: geheel getal

Indeling: int64

OpenAI.numeriek

Type: getal

Opmaak: dubbel

OpenApiAnonymousAuthDetails

Beveiligingsdetails voor anonieme OpenApi-verificatie

Name	Typ	Beschrijving	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	Beschrijving	Required	Verstek
type	OpenApiAuthType	Verificatietype voor OpenApi-eindpunt. Toegestane typen 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 typen zijn:

• Anoniem (geen verificatie vereist)
• Project-verbinding (vereist project_connection_id naar eindpunt, zoals ingesteld in AI Foundry)
• Managed_Identity (vereist doelgroep voor verificatie op basis van identiteit)

Vastgoed	Value
Description	Verificatietype voor OpenApi-eindpunt. Toegestane typen 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)
Typ	string
waarden	anonymous project_connection managed_identity

OpenApiFunctionDefinition

De informatie over de invoerdefinitie voor een openapi-functie.

Name	Typ	Beschrijving	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	string	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 (alleen-lezen)	Lijst met functiedefinities die worden gebruikt door het OpenApi-hulpprogramma	No
name	string	De naam van de functie die moet worden aangeroepen.	Yes
spec	Voorwerp	De openapi-functieshape, beschreven als een JSON-schemaobject.	Yes

OpenApiManagedAuthDetails

Beveiligingsdetails voor OpenApi managed_identity-verificatie

Name	Typ	Beschrijving	Required	Verstek
security_scheme	OpenApiManagedSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie	Yes
└publiek	string	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	Beschrijving	Required	Verstek
audiëntie	string	Verificatiebereik voor managed_identity verificatietype	Yes

OpenApiProjectConnectionAuthDetails

Beveiligingsdetails voor OpenApi-projectverbindingsverificatie

Name	Typ	Beschrijving	Required	Verstek
security_scheme	OpenApiProjectConnectionSecurityScheme	Beveiligingsschema voor OpenApi managed_identity-verificatie	Yes
└project_connection_id	string	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	Beschrijving	Required	Verstek
project_connection_id	string	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	Beschrijving	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	string	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	string	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	string	De naam van de functie die moet worden aangeroepen.	Yes
└- parameters	Voorwerp	De parameters die door de functies worden geaccepteerd, worden beschreven als een JSON-schemaobject.	Yes
└─naam	string	De naam van de functie die moet worden aangeroepen.	Yes
└spec.	Voorwerp	De openapi-functieshape, beschreven als een JSON-schemaobject.	Yes
type	enum	Het objecttype, dat altijd openapi is. Mogelijke waarden: openapi	Yes

PageOrder

Vastgoed	Value
Typ	string
waarden	asc desc

PromptAgentDefinition

De definitie van de promptagent

Name	Typ	Beschrijving	Required	Verstek
instructions	tekenreeks (nullable)	Een systeembericht (of ontwikkelaarsbericht) dat is ingevoegd binnen de context van het model.	No
kind	enum	Mogelijke waarden: prompt	Yes
model	string	De modelimplementatie die moet worden gebruikt voor deze agent.	Yes
rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
└rai_policy_name	string	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 (nul)	Mogelijke waarden: auto, concisedetailed	No
Samenvatting └─	Enum (nul)	Mogelijke waarden: auto, concisedetailed	No
structured_inputs	Voorwerp	Set gestructureerde invoer die kan deelnemen aan promptsjabloonvervanging of bindingen voor hulpprogrammaargumenten.	No
Temperatuur	getal (float) (nul)	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. Beperkingen: min: 0, max: 2	No	1
text	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	getal (float) (nul)	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. Beperkingen: min. 0, max: 1	No	1

PromptAgentDefinitionTextOptions

Configuratieopties voor een tekstantwoord van het model. Dit kunnen tekst zonder opmaak of gestructureerde JSON-gegevens zijn.

Name	Typ	Beschrijving	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

ProtocolVersionRecord

Een recordtoewijzing voor één protocol en de bijbehorende versie.

Name	Typ	Beschrijving	Required	Verstek
protocol	AgentProtocol		Yes
version	string	De versietekenreeks voor het protocol, bijvoorbeeld v0.1.1.	Yes

RaiConfig

Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.

Name	Typ	Beschrijving	Required	Verstek
rai_policy_name	string	De naam van het RAI-beleid dat moet worden toegepast.	Yes

SharepointGroundingToolParameters

De parameters van het sharepoint-grondhulpmiddel.

Name	Typ	Beschrijving	Required	Verstek
project_connections	matrix van ToolProjectConnection	De projectverbindingen die aan dit hulpprogramma zijn gekoppeld. Er kan maximaal 1 verbinding zijn resource gekoppeld aan het hulpprogramma. Beperkingen: maxItems: 1	No

SharepointPreviewTool

De informatie over de invoerdefinitie voor een SharePoint-hulpprogramma zoals wordt gebruikt voor het configureren van een agent.

Name	Typ	Beschrijving	Required	Verstek
sharepoint_grounding_preview	SharepointGroundingToolParameters	De parameters van het sharepoint-grondhulpmiddel.	Yes
└project_connections	matrix van ToolProjectConnection	De projectverbindingen 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

StructuredInputDefinition

Een gestructureerde invoer die kan deelnemen aan promptsjabloonvervangingen en binding van hulpprogrammaargumenten.

Name	Typ	Beschrijving	Required	Verstek
default_value		De standaardwaarde voor de invoer als er geen runtimewaarde wordt opgegeven.	No
beschrijving	string	Een door mensen leesbare beschrijving van de invoer.	No
required	boolean	Of de invoereigenschap vereist is wanneer de agent wordt aangeroepen.	No	Onwaar
schema	Voorwerp	Het JSON-schema voor de gestructureerde invoer (optioneel).	No

StructuredOutputDefinition

Een gestructureerde uitvoer die door de agent kan worden geproduceerd.

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	Een beschrijving van de uitvoer die moet worden verzonden. Wordt gebruikt door het model om te bepalen wanneer de uitvoer moet worden verzonden.	Yes
name	string	De naam van de gestructureerde uitvoer.	Yes
schema	Voorwerp	Het JSON-schema voor de gestructureerde uitvoer.	Yes
streng	Booleaanse waarde (nullable)	Of strikte validatie moet worden afgedwongen. Standaard true.	Yes

ToolProjectConnection

Een projectverbindingsresource.

Name	Typ	Beschrijving	Required	Verstek
project_connection_id	string	Een projectverbinding in een ToolProjectConnectionList die aan dit hulpprogramma is gekoppeld.	Yes

UpdateAgentFromManifestRequest

Name	Typ	Beschrijving	Required	Verstek
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
manifest_id	string	De manifest-id waaruit de agentversie moet worden geïmporteerd.	Yes
metadata	Voorwerp	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	Voorwerp	De invoer in het manifest dat resulteert in een volledig gerealiseerde agent.	Yes

UpdateAgentRequest

Name	Typ	Beschrijving	Required	Verstek
definitie	AgentDefinition		Yes
└.	AgentKind		Yes
└rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
beschrijving	string	Een door mensen leesbare beschrijving van de agent. Beperkingen: maxLength: 512	No
metadata	Voorwerp	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

WebSearchConfiguration

Een webzoekconfiguratie voor bing aangepaste zoekopdrachten

Name	Typ	Beschrijving	Required	Verstek
instance_name	string	Naam van het aangepaste configuratie-exemplaar dat is opgegeven voor de configuratie.	Yes
project_connection_id	string	Project verbindings-id voor grounding met Bing Custom Search	Yes

WorkflowAgentDefinition

De definitie van de werkstroomagent.

Name	Typ	Beschrijving	Required	Verstek
kind	enum	Mogelijke waarden: workflow	Yes
rai_config	RaiConfig	Configuratie voor verantwoordelijke AI-inhoudsfilters en veiligheidsfuncties.	No
└rai_policy_name	string	De naam van het RAI-beleid dat moet worden toegepast.	Yes
werkstroom	string	De CSDL YAML-definitie van de werkstroom.	No