RunsCreateRunOptionalParams interface

Pakket:

@azure/ai-agents

Optionele parameters.

Uitbreiding

OperationOptions,PollingOptionsParams

Eigenschappen

additionalInstructions	Aanvullende instructies om aan het einde van de instructies voor de uitvoering toe te voegen. Dit is handig voor het wijzigen van het gedrag per uitvoering zonder andere instructies te overschrijven.
additionalMessages	Voegt extra berichten toe aan de thread voordat u de uitvoering maakt.
include	Een lijst met extra velden die moeten worden opgenomen in het antwoord. Momenteel is step_details.tool_calls[*].file_search.results[*].content de enige ondersteunde waarde om de inhoud van het zoekresultaat van het bestand op te halen.
instructions	De overschreven systeeminstructies die de agent moet gebruiken om de thread uit te voeren.
maxCompletionTokens	Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven voltooiingstokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven voltooiingstokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
maxPromptTokens	Het maximum aantal prompttokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven prompttokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven prompttokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.
metadata	Een set van maximaal 16 sleutel-/waardeparen die aan een object kunnen worden gekoppeld, die wordt gebruikt voor het opslaan van aanvullende informatie over dat object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.
model	De overschreven modelnaam die de agent moet gebruiken om de thread uit te voeren.
parallelToolCalls	Als true functies parallel worden uitgevoerd tijdens het gebruik van het hulpprogramma.
responseFormat	Hiermee geeft u de indeling op die het model moet uitvoeren.
stream	Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.
temperature	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.
toolChoice	Hiermee bepaalt u of en welk hulpprogramma wordt aangeroepen door het model.
toolResources	De overschreven ingeschakelde hulpprogrammaresources die de agent moet gebruiken om de thread uit te voeren.
tools	De overschreven lijst met ingeschakelde hulpprogramma's die de agent moet gebruiken om de thread uit te voeren.
topP	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 deze of temperatuur te wijzigen, maar niet beide.
truncationStrategy	De strategie voor het verwijderen van berichten wanneer de contextvensters vooruitgaan.

Overgenomen eigenschappen

abortSignal	Het signaal dat kan worden gebruikt om aanvragen af te breken.
onResponse	Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.
pollingOptions	Opties voor het configureren van pollinggedrag.
requestOptions	Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.
tracingOptions	Opties die worden gebruikt wanneer tracering is ingeschakeld.

Eigenschapdetails

additionalInstructions

Aanvullende instructies om aan het einde van de instructies voor de uitvoering toe te voegen. Dit is handig voor het wijzigen van het gedrag per uitvoering zonder andere instructies te overschrijven.

additionalInstructions?: null | string

Waarde van eigenschap

null | string

additionalMessages

Voegt extra berichten toe aan de thread voordat u de uitvoering maakt.

additionalMessages?: null | ThreadMessageOptions[]

Waarde van eigenschap

null | ThreadMessageOptions[]

include

Een lijst met extra velden die moeten worden opgenomen in het antwoord. Momenteel is step_details.tool_calls[*].file_search.results[*].content de enige ondersteunde waarde om de inhoud van het zoekresultaat van het bestand op te halen.

include?: "step_details.tool_calls[*].file_search.results[*].content"[]

Waarde van eigenschap

"step_details.tool_calls[].file_search.results[].content"[]

instructions

De overschreven systeeminstructies die de agent moet gebruiken om de thread uit te voeren.

instructions?: null | string

Waarde van eigenschap

null | string

maxCompletionTokens

Het maximum aantal voltooiingstokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven voltooiingstokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven voltooiingstokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.

maxCompletionTokens?: null | number

Waarde van eigenschap

null | number

maxPromptTokens

Het maximum aantal prompttokens dat tijdens de uitvoering kan worden gebruikt. De uitvoering doet er alles aan om alleen het aantal opgegeven prompttokens te gebruiken, in meerdere bochten van de uitvoering. Als de uitvoering het aantal opgegeven prompttokens overschrijdt, eindigt de uitvoering met de status incomplete. Zie incomplete_details voor meer informatie.

maxPromptTokens?: null | number

Waarde van eigenschap

null | number

metadata

Een set van maximaal 16 sleutel-/waardeparen die aan een object kunnen worden gekoppeld, die wordt gebruikt voor het opslaan van aanvullende informatie over dat object in een gestructureerde indeling. Sleutels mogen maximaal 64 tekens lang zijn en waarden mogen maximaal 512 tekens lang zijn.

metadata?: null | Record<string, string>

Waarde van eigenschap

null | Record<string, string>

model

De overschreven modelnaam die de agent moet gebruiken om de thread uit te voeren.

model?: null | string

Waarde van eigenschap

null | string

parallelToolCalls

Als true functies parallel worden uitgevoerd tijdens het gebruik van het hulpprogramma.

parallelToolCalls?: boolean

Waarde van eigenschap

boolean

responseFormat

Hiermee geeft u de indeling op die het model moet uitvoeren.

responseFormat?: null | AgentsResponseFormatOption

Waarde van eigenschap

null | AgentsResponseFormatOption

stream

Als true, retourneert een stroom gebeurtenissen die plaatsvinden tijdens de uitvoeren als server verzonden gebeurtenissen, beëindigen wanneer de uitvoering een terminalstatus met een data: [DONE] bericht invoert.

stream?: boolean

Waarde van eigenschap

boolean

temperature

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.

temperature?: null | number

Waarde van eigenschap

null | number

toolChoice

Hiermee bepaalt u of en welk hulpprogramma wordt aangeroepen door het model.

toolChoice?: null | AgentsToolChoiceOption

Waarde van eigenschap

null | AgentsToolChoiceOption

toolResources

De overschreven ingeschakelde hulpprogrammaresources die de agent moet gebruiken om de thread uit te voeren.

toolResources?: null | ToolResources

Waarde van eigenschap

null | ToolResources

tools

De overschreven lijst met ingeschakelde hulpprogramma's die de agent moet gebruiken om de thread uit te voeren.

tools?: null | ToolDefinitionUnion[]

Waarde van eigenschap

null | ToolDefinitionUnion[]

topP

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 deze of temperatuur te wijzigen, maar niet beide.

topP?: null | number

Waarde van eigenschap

null | number

truncationStrategy

De strategie voor het verwijderen van berichten wanneer de contextvensters vooruitgaan.

truncationStrategy?: null | TruncationObject

Waarde van eigenschap

null | TruncationObject

Details van overgenomen eigenschap

abortSignal

Het signaal dat kan worden gebruikt om aanvragen af te breken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

overgenomen van OperationOptions.abortSignal

onResponse

Een functie die telkens wordt aangeroepen wanneer een antwoord van de server wordt ontvangen tijdens het uitvoeren van de aangevraagde bewerking. Kan meerdere keren worden aangeroepen.

onResponse?: RawResponseCallback

Waarde van eigenschap

RawResponseCallback

overgenomen van OperationOptions.onResponse

pollingOptions

Opties voor het configureren van pollinggedrag.

pollingOptions?: PollingOptions

Waarde van eigenschap

PollingOptions

overgenomen vanPollingOptionsParams.pollingOptions

requestOptions

Opties die worden gebruikt bij het maken en verzenden van HTTP-aanvragen voor deze bewerking.

requestOptions?: OperationRequestOptions

Waarde van eigenschap

OperationRequestOptions

overgenomen van OperationOptions.requestOptions

tracingOptions

Opties die worden gebruikt wanneer tracering is ingeschakeld.

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen van OperationOptions.tracingOptions