Azure AI Foundry Agent Service (preview)
Integreer eenvoudig azure AI Foundry Agent Service-mogelijkheden in uw werkstromen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Microsoft |
| URL | https://support.microsoft.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | Microsoft |
| Webpagina | https://learn.microsoft.com/en-us/azure/ai-services/agents/ |
| Privacybeleid | https://learn.microsoft.com/en-us/legal/cognitive-services/agents/data-privacy-security |
| Categorieën | AI; Business Intelligence |
Een verbinding maken
De connector ondersteunt de volgende verificatietypen:
| Beheerde identiteit van Logic Apps | Een verbinding maken met behulp van een door LogicApps beheerde identiteit | Alleen LOGICAPPS | Deelbaar |
| Gebruikersaanmelding voor Microsoft Entra ID | Aanmelden met Microsoft Entra ID-referenties | Alle regio's | Niet deelbaar |
| Standaard [AFGESCHAFT] | Deze optie is alleen bedoeld voor oudere verbindingen zonder expliciet verificatietype en is alleen beschikbaar voor compatibiliteit met eerdere versies. | Alle regio's | Niet deelbaar |
Beheerde identiteit van Logic Apps
Verificatie-id: managedIdentityAuth
Van toepassing: alleen LOGICAPPS
Een verbinding maken met behulp van een door LogicApps beheerde identiteit
Dit is deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt de verbinding ook gedeeld. Zie het overzicht van connectors voor canvas-apps - Power Apps | Microsoft Docs
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Beheerde identiteit van LogicApps | managedIdentity | Aanmelden met een beheerde identiteit van Logic Apps | Klopt |
| Azure AI-projecteindpunt | touw | De naam van het Azure AI-projecteindpunt, zoals https://{account-name}.services.ai.azure.com/api/projects/{project-name} | Klopt |
Gebruikersaanmelding voor Microsoft Entra ID
Verificatie-id: entraIDUserLogin
Van toepassing: Alle regio's
Aanmelden met Microsoft Entra ID-referenties
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
| Naam | Typologie | Description | Verplicht |
|---|---|---|---|
| Azure AI-projecteindpunt | touw | De naam van het Azure AI-projecteindpunt, zoals https://{account-name}.services.ai.azure.com/api/projects/{project-name} | Klopt |
Standaard [AFGESCHAFT]
Van toepassing: Alle regio's
Deze optie is alleen bedoeld voor oudere verbindingen zonder expliciet verificatietype en is alleen beschikbaar voor compatibiliteit met eerdere versies.
Dit is geen deelbare verbinding. Als de power-app wordt gedeeld met een andere gebruiker, wordt een andere gebruiker gevraagd om expliciet een nieuwe verbinding te maken.
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 1000 | 60 seconden |
Acties
| Agent aanroepen |
Agent aanroepen. |
| Lijst Berichten |
Lijst Berichten |
| Lijst van agenten |
Lijst van agenten |
| Protocol voor externe agentactiviteit op basis van agent-id |
Protocol voor externe agentactiviteit op basis van agent-id |
| Protocol voor externe agentactiviteit op basis van toepassing |
Protocol voor externe agentactiviteit op basis van toepassing |
| Rennen krijgen |
Rennen krijgen |
| Run maken |
Run maken |
| Thread maken |
Thread maken |
Agent aanroepen
Agent aanroepen.
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versie
|
api-version | True | string |
API-versie |
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens. |
|
|
user
|
user | string |
Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren. Meer informatie. |
|
|
top_logprobs
|
top_logprobs | integer |
Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans. |
|
|
previous_response_id
|
previous_response_id | string |
De unieke ID van het vorige antwoord aan het model. Gebruik dit om gesprekken met meerdere gespreksrondes te maken. Meer informatie over gespreksstatus. |
|
|
achtergrond
|
background | boolean |
Of het modelantwoord op de achtergrond moet worden uitgevoerd. Meer informatie. |
|
|
max_output_tokens
|
max_output_tokens | integer |
Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens. |
|
|
max_tool_calls
|
max_tool_calls | integer |
Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd. |
|
|
type
|
type | True | string |
Een object dat de indeling aangeeft die het model moet uitvoeren.
De standaardindeling is Niet aanbevolen voor gpt-4o- en nieuwere modellen:
|
|
type
|
type | True | string |
Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren. |
|
tool_choice
|
tool_choice |
Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de |
||
|
identiteitskaart
|
id | True | string |
De unieke id van de promptsjabloon die moet worden gebruikt. |
|
version
|
version | string |
Optionele versie van de promptsjabloon. |
|
|
variables
|
variables | object |
Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden. |
|
|
truncation
|
truncation | string |
De afkortingsstrategie die moet worden gebruikt voor het antwoord van het model.
|
|
|
invoer
|
input |
Tekst, afbeelding of bestandsinvoer voor het model, dat wordt gebruikt om een antwoord te genereren. Meer informatie: |
||
|
include
|
include | string |
Geef aanvullende uitvoergegevens op die moeten worden opgenomen in het modelantwoord. Momenteel ondersteunde waarden zijn:
|
|
|
parallel_gereedschapsoproepen
|
parallel_tool_calls | boolean |
Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren. |
|
|
store
|
store | boolean |
Of het gegenereerde modelantwoord moet worden opgeslagen voor later ophalen via API. |
|
|
aanwijzingen
|
instructions | string |
Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met |
|
|
type
|
type | True | string | |
|
naam
|
name | True | string |
De naam van de agent. |
|
version
|
version | True | string |
De versie-id van de agent. |
Retouren
- Body
- OpenAI.Response
Lijst Berichten
Lijst Berichten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versie
|
api-version | True | string |
API-versie |
|
De id van de thread waarvoor u een bericht wilt maken.
|
ThreadId | True | string |
De id van de thread waarvoor u een bericht wilt maken. |
Retouren
- Body
- listMessageResponse
Lijst van agenten
Lijst van agenten
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versie
|
api-version | True | string |
API-versie |
Retouren
- Body
- listAgentsResponse
Protocol voor externe agentactiviteit op basis van agent-id
Protocol voor externe agentactiviteit op basis van agent-id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
De id van de agent om een bericht naar te verzenden.
|
AgentId | True | string |
De id van de agent om een bericht naar te verzenden. |
|
|
object |
Retouren
- response
- object
Protocol voor externe agentactiviteit op basis van toepassing
Protocol voor externe agentactiviteit op basis van toepassing
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Agenttoepassing.
|
MyApplication | True | string |
Agenttoepassing. |
|
|
object |
Retouren
- response
- object
Rennen krijgen
Rennen krijgen
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versie
|
api-version | True | string |
API-versie |
|
De id van de thread waarvoor u een bericht wilt maken.
|
ThreadId | True | string |
De id van de thread waarvoor u een bericht wilt maken. |
|
De id van de uitvoering.
|
RunId | True | string |
De id van de uitvoering. |
Retouren
- Body
- getRunResponse
Run maken
Run maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versie
|
api-version | True | string |
API-versie |
|
De id van de thread waarvoor u een bericht wilt maken.
|
ThreadId | True | string |
De id van de thread waarvoor u een bericht wilt maken. |
|
assistant_id
|
assistant_id | True | string |
De id van de assistent die moet worden gebruikt om deze uitvoering uit te voeren. |
|
model
|
model | string |
De naam van de modelimplementatie die moet worden gebruikt om deze uitvoering uit te voeren. Indien opgegeven, wordt de naam van de modelimplementatie van de assistent overschreven. |
|
|
aanwijzingen
|
instructions | string |
Hiermee overschrijft u de instructies van de assistent. Handig voor het wijzigen van gedrag per uitvoering. |
|
|
additional_instructions
|
additional_instructions | string |
Voegt aanvullende instructies toe aan het einde van de instructies voor de uitvoering. |
|
|
rol
|
role | string |
De rol van de entiteit die het bericht maakt. Kan gebruiker of assistent zijn. 'gebruiker' geeft aan dat het bericht wordt verzonden door een werkelijke gebruiker en moet in de meeste gevallen worden gebruikt om door de gebruiker gegenereerde berichten weer te geven. 'assistent' geeft aan dat het bericht wordt gegenereerd door de assistent. Gebruik deze waarde om berichten van de assistent in te voegen in het gesprek. |
|
|
inhoud
|
content | string |
De inhoud van het bericht. |
|
|
naam
|
name | string |
Lijst met bestands-id's of berichten die in de uitvoering kunnen worden gebruikt. |
|
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn. |
|
|
naam
|
name | string |
Lijst met hulpprogramma's die kunnen worden gebruikt in de uitvoering. |
|
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die zijn gekoppeld aan een object. Maximale lengte van sleutels: 64 tekens, maximale lengte van waarden: 512 tekens. |
|
|
temperatuur
|
temperature | number |
Monsternametemperatuur (0-2). Hogere waarden (bijvoorbeeld 0,8) verhogen de willekeurigheid, lagere waarden (bijvoorbeeld 0,2) maken uitvoer deterministischer. |
|
|
top_p
|
top_p | number |
Kernsampling alternatief voor temperatuur. 0,1 betekent dat top 10% kansdichtheid wordt overwogen. |
|
|
beek
|
stream | boolean |
Indien waar, retourneert u een stroom gebeurtenissen tijdens de uitvoering als door de server verzonden gebeurtenissen, waarbij het eindigt met het bericht 'data: [DONE]'. |
|
|
max_prompt_tokens
|
max_prompt_tokens | integer |
Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. Als de uitvoering is overschreden, eindigt de uitvoering als onvolledig. |
|
|
max_completion_tokens
|
max_completion_tokens | integer |
Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. Als de uitvoering is overschreden, eindigt de uitvoering als onvolledig. |
|
|
truncation_strategy
|
truncation_strategy | object |
Hiermee bepaalt u hoe een thread wordt afgekapt voordat de uitvoering het eerste contextvenster beheert. |
|
|
tool_choice
|
tool_choice | object |
Hiermee bepaalt u welk hulpprogramma het model aanroept. Standaard ingesteld op 'automatisch', zodat het model kan beslissen. Kan worden ingesteld op 'none' om het gebruik van hulpprogramma's uit te schakelen. |
|
|
responsformaat
|
response_format | object |
Geeft het uitvoerformaat op. Als u { 'type': 'json_object' } instelt, wordt de JSON-modus ingeschakeld voor geldige JSON-antwoorden. |
Retouren
- Body
- createRunResponse
Thread maken
Thread maken
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
API-versie
|
api-version | True | string |
API-versie |
|
rol
|
role | string |
De rol van de entiteit die het bericht maakt. Kan gebruiker of assistent zijn. 'gebruiker' geeft aan dat het bericht wordt verzonden door een werkelijke gebruiker en moet in de meeste gevallen worden gebruikt om door de gebruiker gegenereerde berichten weer te geven. 'assistent' geeft aan dat het bericht wordt gegenereerd door de assistent. Gebruik deze waarde om berichten van de assistent in te voegen in het gesprek. |
|
|
inhoud
|
content | string |
De inhoud van het bericht. |
|
|
naam
|
name | string |
Lijst met bestands-id's of berichten die in de uitvoering kunnen worden gebruikt. |
|
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn. |
|
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn. |
|
|
tool_resources
|
tool_resources | object |
Een set resources die beschikbaar worden gesteld aan de hulpprogramma's van de assistent in deze thread. De resources zijn specifiek voor het type hulpprogramma. Het hulpprogramma code_interpreter vereist bijvoorbeeld een lijst met bestands-id's, terwijl voor het hulpprogramma file_search een lijst met vectorarchief-id's is vereist. |
Retouren
- Body
- createThreadResponse
Definities
listAgentsResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Voorwerp
|
object | string |
Details van het antwoordobjecttype. |
|
gegevens
|
data | array of Data |
De lijst met berichten die door de service worden geretourneerd. |
|
first_id
|
first_id | string |
Details van de eerste id. |
|
last_id
|
last_id | string |
Details van de laatste id. |
|
heeft_meer
|
has_more | boolean |
Hiermee wordt aangegeven of er meer agents zijn. |
createThreadResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
De id waarnaar kan worden verwezen in API-eindpunten. |
|
Voorwerp
|
object | string |
Het objecttype, dat altijd thread is. |
|
aangemaakt_op
|
created_at | integer |
De Unix-tijdstempel (in seconden) voor het moment waarop de thread is gemaakt. |
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn. |
createRunResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
De id waarnaar kan worden verwezen in API-eindpunten. |
|
Voorwerp
|
object | string |
Het objecttype, dat altijd thread.run is. |
|
aangemaakt_op
|
created_at | integer |
De Unix-tijdstempel (in seconden) voor het moment waarop de uitvoering is gemaakt. |
|
thread_id
|
thread_id | string |
De id van de thread waarop is uitgevoerd als onderdeel van deze uitvoering. |
|
assistant_id
|
assistant_id | string |
De id van de assistent die wordt gebruikt voor het uitvoeren van deze uitvoering. |
|
status
|
status | string |
De status van de uitvoering, die in de wachtrij kan worden geplaatst, in_progress, requires_action, annuleren, geannuleerd, mislukt, voltooid of verlopen. |
|
required_action
|
required_action | object |
Details over de actie die nodig is om door te gaan met de uitvoering. Is null als er geen actie is vereist. |
|
laatste_fout
|
last_error | object |
De laatste fout die aan deze uitvoering is gekoppeld. Is null als er geen fouten zijn. |
|
verloopt_op
|
expires_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering verloopt. |
|
started_at
|
started_at | integer |
De Unix-tijdstempel (in seconden) voor toen de uitvoering werd gestart. |
|
geannuleerd_op
|
cancelled_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is geannuleerd. |
|
mislukt_op
|
failed_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is mislukt. |
|
voltooid_op
|
completed_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is voltooid. |
|
model
|
model | string |
De naam van de modelimplementatie die de assistent voor deze uitvoering heeft gebruikt. |
|
aanwijzingen
|
instructions | string |
De instructies die de assistent voor deze uitvoering heeft gebruikt. |
|
gereedschappen
|
tools | array of tools |
De lijst met hulpprogramma's die de assistent voor deze uitvoering heeft gebruikt. |
|
file_ids
|
file_ids | array of fileIds |
De lijst met bestands-id's die de assistent voor deze uitvoering heeft gebruikt. |
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn. |
|
tool_choice
|
tool_choice | object |
Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. 'geen' betekent dat het model geen hulpprogramma's aanroept en in plaats daarvan een bericht genereert. 'auto': het model kan kiezen tussen het genereren van een bericht of het aanroepen van een hulpprogramma. Het opgeven van een hulpprogramma zoals {'type': 'file_search'} of {'type': 'function', 'function': {'name': 'my_function'}} dwingt het model om dat hulpprogramma aan te roepen. |
|
max_prompt_tokens
|
max_prompt_tokens | number |
Het maximum aantal prompttokens dat is opgegeven voor gebruik in de loop van de uitvoering. |
|
max_completion_tokens
|
max_completion_tokens | number |
Het maximum aantal voltooiingstokens dat is opgegeven voor gebruik in de loop van de uitvoering. |
|
usage
|
usage | object |
Gebruiksstatistieken met betrekking tot de uitvoering. Deze waarde is null als de uitvoering niet de status terminal heeft (bijvoorbeeld in_progress, in de wachtrij geplaatst). |
|
truncation_strategy
|
truncation_strategy | object |
Hiermee bepaalt u hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. |
|
responsformaat
|
response_format | string |
De indeling die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106. |
getRunResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
De id waarnaar kan worden verwezen in API-eindpunten. |
|
Voorwerp
|
object | string |
Het objecttype, dat altijd thread.run is. |
|
aangemaakt_op
|
created_at | integer |
De Unix-tijdstempel (in seconden) voor het moment waarop de uitvoering is gemaakt. |
|
thread_id
|
thread_id | string |
De id van de thread waarop is uitgevoerd als onderdeel van deze uitvoering. |
|
assistant_id
|
assistant_id | string |
De id van de assistent die wordt gebruikt voor het uitvoeren van deze uitvoering. |
|
status
|
status | string |
De status van de uitvoering, die in de wachtrij kan worden geplaatst, in_progress, requires_action, annuleren, geannuleerd, mislukt, voltooid of verlopen. |
|
required_action
|
required_action | object |
Details over de actie die nodig is om door te gaan met de uitvoering. Is null als er geen actie is vereist. |
|
laatste_fout
|
last_error | object |
De laatste fout die aan deze uitvoering is gekoppeld. Is null als er geen fouten zijn. |
|
verloopt_op
|
expires_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering verloopt. |
|
started_at
|
started_at | integer |
De Unix-tijdstempel (in seconden) voor toen de uitvoering werd gestart. |
|
geannuleerd_op
|
cancelled_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is geannuleerd. |
|
mislukt_op
|
failed_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is mislukt. |
|
voltooid_op
|
completed_at | integer |
De Unix-tijdstempel (in seconden) voor wanneer de uitvoering is voltooid. |
|
model
|
model | string |
De naam van de modelimplementatie die de assistent voor deze uitvoering heeft gebruikt. |
|
aanwijzingen
|
instructions | string |
De instructies die de assistent voor deze uitvoering heeft gebruikt. |
|
gereedschappen
|
tools | array of tools |
De lijst met hulpprogramma's die de assistent voor deze uitvoering heeft gebruikt. |
|
file_ids
|
file_ids | array of fileIds |
De lijst met bestands-id's die de assistent voor deze uitvoering heeft gebruikt. |
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn. |
|
tool_choice
|
tool_choice | object |
Hiermee bepaalt u welke (indien van toepassing) hulpprogramma's worden aangeroepen door het model. 'geen' betekent dat het model geen hulpprogramma's aanroept en in plaats daarvan een bericht genereert. 'auto': het model kan kiezen tussen het genereren van een bericht of het aanroepen van een hulpprogramma. Het opgeven van een hulpprogramma zoals {'type': 'file_search'} of {'type': 'function', 'function': {'name': 'my_function'}} dwingt het model om dat hulpprogramma aan te roepen. |
|
max_prompt_tokens
|
max_prompt_tokens | number |
Het maximum aantal prompttokens dat is opgegeven voor gebruik in de loop van de uitvoering. |
|
max_completion_tokens
|
max_completion_tokens | number |
Het maximum aantal voltooiingstokens dat is opgegeven voor gebruik in de loop van de uitvoering. |
|
usage
|
usage | object |
Gebruiksstatistieken met betrekking tot de uitvoering. Deze waarde is null als de uitvoering niet de status terminal heeft (bijvoorbeeld in_progress, in de wachtrij geplaatst). |
|
truncation_strategy
|
truncation_strategy | object |
Hiermee bepaalt u hoe een thread wordt afgekapt voordat de uitvoering wordt uitgevoerd. |
|
responsformaat
|
response_format | string |
De indeling die het model moet uitvoeren. Compatibel met GPT-4 Turbo en alle GPT-3.5 Turbo-modellen sinds gpt-3.5-turbo-1106. |
listMessageResponse
| Name | Pad | Type | Description |
|---|---|---|---|
|
Voorwerp
|
object | string |
Details van het antwoordobjecttype |
|
gegevens
|
data | array of Data |
De lijst met berichten die door de service worden geretourneerd. |
|
first_id
|
first_id | string |
Details van de eerste id |
|
last_id
|
last_id | string |
Details van de laatste id |
|
heeft_meer
|
has_more | boolean |
Geeft aan of er meer agents zijn |
Gegevens
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
De id waarnaar kan worden verwezen in API-eindpunten. |
|
Voorwerp
|
object | string |
Het objecttype, dat altijd assistent is. |
|
aangemaakt_op
|
created_at | integer |
De Unix-tijdstempel (in seconden) voor het moment waarop de assistent is gemaakt. |
|
naam
|
name | string |
De naam van de assistent. De maximale lengte is 256 tekens. |
|
beschrijving
|
description | string |
De beschrijving van de assistent. De maximale lengte is 512 tekens. |
|
model
|
model | string |
De naam van de te gebruiken modelimplementatienaam. |
|
aanwijzingen
|
instructions | string |
De systeeminstructies die de assistent gebruikt. De maximale lengte is 32768 tekens. |
|
gereedschappen
|
tools | array of tools |
Een lijst met hulpprogramma's die zijn ingeschakeld voor de assistent. Er kunnen maximaal 128 hulpprogramma's per assistent zijn. Hulpprogramma's kunnen van het type code_interpreter of functie zijn. Een functiebeschrijving mag maximaal 1024 tekens bevatten. |
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Handig voor het opslaan van aanvullende informatie in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn. |
|
temperatuur
|
temperature | number |
De standaardwaarde is 1. Bepaalt 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. |
|
top_p
|
top_p | number |
De standaardwaarde is 1. Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd. |
|
responsformaat
|
response_format | object |
Hiermee geeft u de indeling op die het model moet uitvoeren. Als u deze parameter instelt op { 'type': 'json_object' } schakelt u de JSON-modus in, zodat het bericht geldige JSON is. |
|
tool_resources
|
tool_resources | object |
Een set resources die worden gebruikt door de hulpprogramma's van de assistent. De resources zijn specifiek voor het type hulpprogramma. Het hulpprogramma code_interpreter vereist bijvoorbeeld een lijst met bestands-id's, terwijl voor het hulpprogramma file_search een lijst met vectorarchief-id's is vereist. |
OpenAI.ServiceTier
Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag.
- Als deze optie is ingesteld op Automatisch, wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt het project standaard.
- Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en -prestaties voor het geselecteerde model.
- Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. Neem contact op met verkoop voor meer informatie over prioriteitsverwerking.
- Als dit niet is ingesteld, is het standaardgedrag 'automatisch'.
Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.
Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag.
- Als deze optie is ingesteld op Automatisch, wordt de aanvraag verwerkt met de servicelaag die is geconfigureerd in de Project-instellingen. Tenzij anders geconfigureerd, gebruikt het project standaard.
- Als deze optie is ingesteld op 'standaard', wordt de aanvraag verwerkt met de standaardprijzen en -prestaties voor het geselecteerde model.
- Als deze optie is ingesteld op 'flex' of 'prioriteit', wordt de aanvraag verwerkt met de bijbehorende servicelaag. Neem contact op met verkoop voor meer informatie over prioriteitsverwerking.
- Als dit niet is ingesteld, is het standaardgedrag 'automatisch'.
Wanneer de parameter is ingesteld, bevat de hoofdtekst van het service_tier antwoord de service_tier waarde op basis van de verwerkingsmodus die daadwerkelijk wordt gebruikt om de aanvraag te verwerken. Deze antwoordwaarde kan afwijken van de waarde die is ingesteld in de parameter.
OpenAI.Reasoning
Alleen modellen uit de o-serie
Configuratieopties voor redeneringsmodellen.
| Name | Pad | Type | Description |
|---|---|---|---|
|
effort
|
effort | string | |
|
summary
|
summary | string |
Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model.
Een van |
|
generate_summary
|
generate_summary | string |
Afgeschaft: gebruik Een samenvatting van de redenering die door het model wordt uitgevoerd. Dit kan handig zijn voor foutopsporing en inzicht in het redeneringsproces van het model.
Een van |
OpenAI.ResponseTextFormatConfiguration
| Name | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | OpenAI.ResponseTextFormatConfigurationType |
Een object dat de indeling aangeeft die het model moet uitvoeren.
De standaardindeling is Niet aanbevolen voor gpt-4o- en nieuwere modellen:
|
OpenAI.ResponseTextFormatConfigurationType
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 vindt u in de handleiding Structured Outputs.
De standaardindeling is { "type": "text" } zonder extra opties.
Niet aanbevolen voor gpt-4o- en nieuwere modellen:
{ "type": "json_object" } Als u de oudere JSON-modus wilt inschakelen, zorgt u ervoor dat het bericht dat het model genereert geldige JSON is. Het is aanbevolen om json_schema te gebruiken voor modellen die dit ondersteunen.
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 vindt u in de handleiding Structured Outputs.
De standaardindeling is { "type": "text" } zonder extra opties.
Niet aanbevolen voor gpt-4o- en nieuwere modellen:
{ "type": "json_object" } Als u de oudere JSON-modus wilt inschakelen, zorgt u ervoor dat het bericht dat het model genereert geldige JSON is. Het is aanbevolen om json_schema te gebruiken voor modellen die dit ondersteunen.
OpenAI.Tool
| Name | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | OpenAI.ToolType |
Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren. |
OpenAI.ToolType
Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.
Een hulpprogramma dat kan worden gebruikt om een antwoord te genereren.
OpenAI.Prompt
Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie.
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string |
De unieke id van de promptsjabloon die moet worden gebruikt. |
|
version
|
version | string |
Optionele versie van de promptsjabloon. |
|
variables
|
variables | OpenAI.ResponsePromptVariables |
Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden. |
OpenAI.Response
| Name | Pad | Type | Description |
|---|---|---|---|
|
metadata
|
metadata | object |
Set van 16 sleutel-waardeparen die aan een object kunnen worden gekoppeld. Dit kan handig zijn voor het opslaan van aanvullende informatie over het object in een gestructureerde indeling en het opvragen van objecten via API of het dashboard. Sleutels zijn tekenreeksen met een maximale lengte van 64 tekens. Waarden zijn tekenreeksen met een maximale lengte van 512 tekens. |
|
temperatuur
|
temperature | float |
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 u aan dit of |
|
top_p
|
top_p | float |
Een alternatief voor steekproeven met temperatuur, zogenaamde kernsampling, waarbij het model rekening houdt met de resultaten van de tokens met top_p waarschijnlijkheidsmassa. 0,1 betekent dus dat alleen de tokens die de top 10% kansdichtheid omvatten, worden beschouwd. Over het algemeen raden we u aan dit of |
|
user
|
user | string |
Een unieke id die uw eindgebruiker vertegenwoordigt, waarmee OpenAI misbruik kan bewaken en detecteren. Meer informatie. |
|
serviceniveau
|
service_tier | OpenAI.ServiceTier |
Hiermee geeft u het verwerkingstype op dat wordt gebruikt voor het verwerken van de aanvraag.
Wanneer de parameter is ingesteld, bevat de hoofdtekst van het |
|
top_logprobs
|
top_logprobs | integer |
Een geheel getal tussen 0 en 20 dat het aantal waarschijnlijke tokens aangeeft dat op elke tokenpositie moet worden geretourneerd, elk met een gekoppelde logboekkans. |
|
previous_response_id
|
previous_response_id | string |
De unieke ID van het vorige antwoord aan het model. Gebruik dit om gesprekken met meerdere gespreksrondes te maken. Meer informatie over gespreksstatus. |
|
model
|
model | string |
De modelimplementatie die moet worden gebruikt voor het maken van dit antwoord. |
|
reasoning
|
reasoning | OpenAI.Reasoning |
Alleen modellen uit de o-serie Configuratieopties voor redeneringsmodellen. |
|
achtergrond
|
background | boolean |
Of het modelantwoord op de achtergrond moet worden uitgevoerd. Meer informatie. |
|
max_output_tokens
|
max_output_tokens | integer |
Een bovengrens voor het aantal tokens dat kan worden gegenereerd voor een antwoord, inclusief zichtbare uitvoertokens en redeneringstokens. |
|
max_tool_calls
|
max_tool_calls | integer |
Het maximum aantal aanroepen naar ingebouwde hulpprogramma's dat kan worden verwerkt in een antwoord. Dit maximumaantal geldt voor alle ingebouwde hulpprogramma-aanroepen, niet per afzonderlijke tool. Eventuele verdere pogingen om een hulpprogramma door het model aan te roepen, worden genegeerd. |
|
format
|
text.format | OpenAI.ResponseTextFormatConfiguration | |
|
gereedschappen
|
tools | array of OpenAI.Tool |
Een matrix met hulpprogramma's die het model kan aanroepen tijdens het genereren van een antwoord. U kunt opgeven welk hulpprogramma u wilt gebruiken door de De twee categorieën tools die u kunt opgeven, zijn:
|
|
tool_choice
|
tool_choice |
Hoe het model moet selecteren welk hulpprogramma (of hulpprogramma's) moeten worden gebruikt bij het genereren van een antwoord. Zie de |
|
|
prompt
|
prompt | OpenAI.Prompt |
Verwijzing naar een promptsjabloon en de bijbehorende variabelen. Meer informatie. |
|
truncation
|
truncation | string |
De afkortingsstrategie die moet worden gebruikt voor het antwoord van het model.
|
|
identiteitskaart
|
id | string |
Unieke id voor dit antwoord. |
|
Voorwerp
|
object | string |
Het objecttype van deze resource - altijd ingesteld op |
|
status
|
status | string |
De status van de reactiegeneratie. Een van |
|
aangemaakt_op
|
created_at | unixtime |
Unix-tijdstempel (in seconden) van wanneer dit antwoord is gemaakt. |
|
fout
|
error | OpenAI.ResponseError |
Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren. |
|
reden
|
incomplete_details.reason | string |
De reden waarom het antwoord onvolledig is. |
|
output
|
output | array of OpenAI.ItemResource |
Een reeks met inhoudsitems die door het model worden gegenereerd.
|
|
aanwijzingen
|
instructions |
Een systeembericht (of ontwikkelaar) dat is ingevoegd in de context van het model. Bij het gebruik van samen met |
|
|
output_text
|
output_text | string |
Alleen-SDK-eigenschap die de geaggregeerde tekstuitvoer van alle |
|
usage
|
usage | OpenAI.ResponseUsage |
Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens. |
|
parallel_gereedschapsoproepen
|
parallel_tool_calls | boolean |
Hiermee wordt aangegeven of het model hulpprogramma-aanroepen parallel mag uitvoeren. |
|
identiteitskaart
|
conversation.id | string | |
|
agent
|
agent | AgentId |
OpenAI.ResponseError
Er wordt een foutobject geretourneerd wanneer het model geen antwoord kan genereren.
| Name | Pad | Type | Description |
|---|---|---|---|
|
code
|
code | OpenAI.ResponseErrorCode |
De foutcode voor het antwoord. |
|
message
|
message | string |
Een door mensen leesbare beschrijving van de fout. |
OpenAI.ResponseErrorCode
OpenAI.ItemResource
Inhoudsitem dat wordt gebruikt om een antwoord te genereren.
| Name | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | OpenAI.ItemType | |
|
identiteitskaart
|
id | string |
OpenAI.ItemType
OpenAI.ResponseUsage
Vertegenwoordigt tokengebruiksgegevens, waaronder invoertokens, uitvoertokens, een uitsplitsing van uitvoertokens en het totale aantal gebruikte tokens.
| Name | Pad | Type | Description |
|---|---|---|---|
|
input_tokens
|
input_tokens | integer |
Het aantal invoertokens. |
|
cached_tokens
|
input_tokens_details.cached_tokens | integer |
Het aantal tokens dat is opgehaald uit de cache. Meer informatie over het in de cache opslaan van prompts. |
|
output_tokens
|
output_tokens | integer |
Het aantal uitvoertokens. |
|
redeneringssymbolen
|
output_tokens_details.reasoning_tokens | integer |
Het aantal redeneringstokens. |
|
total_tokens
|
total_tokens | integer |
Het totale aantal gebruikte tokens. |
AgentId
| Name | Pad | Type | Description |
|---|---|---|---|
|
type
|
type | string | |
|
naam
|
name | string |
De naam van de agent. |
|
version
|
version | string |
De versie-id van de agent. |
OpenAI.ResponsePromptVariables
Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden.
| Name | Pad | Type | Description |
|---|---|---|---|
|
|
object |
Optionele toewijzing van waarden die moeten worden vervangen door variabelen in uw prompt. De vervangingswaarden kunnen tekenreeksen zijn of andere invoertypen voor antwoorden, zoals afbeeldingen of bestanden. |
gereedschappen
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string |
Lijst met hulpprogramma's die kunnen worden gebruikt in de uitvoering. |
fileIds
| Name | Pad | Type | Description |
|---|---|---|---|
|
naam
|
name | string |
Lijst met bestands-id's die in de uitvoering kunnen worden gebruikt. |
Voorwerp
Dit is het type 'object'.