Condividi tramite


RunsCreateRunOptionalParams interface

Parametri facoltativi.

Extends

Proprietà

additionalInstructions

Istruzioni aggiuntive da aggiungere alla fine delle istruzioni per l'esecuzione. Ciò è utile per modificare il comportamento in base all'esecuzione senza eseguire l'override di altre istruzioni.

additionalMessages

Aggiunge messaggi aggiuntivi al thread prima di creare l'esecuzione.

include

Elenco di campi aggiuntivi da includere nella risposta. Attualmente l'unico valore supportato consiste step_details.tool_calls[*].file_search.results[*].content nel recuperare il contenuto dei risultati della ricerca file.

instructions

Istruzioni di sistema sottoposte a override che l'agente deve usare per eseguire il thread.

maxCompletionTokens

Numero massimo di token di completamento che possono essere usati durante l'esecuzione. L'esecuzione farà il possibile per usare solo il numero di token di completamento specificati, in più turni dell'esecuzione. Se l’esecuzione supera il numero di token di completamento specificati, terminerà con lo stato incomplete. Per altre informazioni, vedi incomplete_details.

maxPromptTokens

Numero massimo di token di richiesta che possono essere usati durante l'esecuzione. L'esecuzione farà del meglio per usare solo il numero di token di richiesta specificati, in più turni dell'esecuzione. Se l’esecuzione supera il numero di token di prompt specificati, terminerà con lo stato incomplete. Per altre informazioni, vedi incomplete_details.

metadata

Set di un massimo di 16 coppie chiave/valore che possono essere collegate a un oggetto, utilizzate per archiviare informazioni aggiuntive su tale oggetto in un formato strutturato. Le chiavi possono avere una lunghezza massima di 64 caratteri e i valori possono avere una lunghezza massima di 512 caratteri.

model

Nome del modello sottoposto a override che l'agente deve usare per eseguire il thread.

parallelToolCalls

Se true funzioni verranno eseguite in parallelo durante l'uso dello strumento.

responseFormat

Specifica il formato che il modello deve restituire.

stream

Se true, restituisce un flusso di eventi che si verificano durante gli eventi inviati dal server Esegui come, terminando quando Run entra in uno stato terminale con un messaggio di data: [DONE].

temperature

Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico.

toolChoice

Controlla se e quale strumento viene chiamato dal modello.

toolResources

Le risorse dello strumento abilitate sottoposte a override che l'agente deve utilizzare per eseguire il thread.

tools

Elenco sottoposto a override degli strumenti abilitati che l'agente deve usare per eseguire il thread.

topP

Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%.

In genere è consigliabile modificare questo o la temperatura, ma non entrambi.

truncationStrategy

Strategia da usare per eliminare i messaggi man mano che le finestre di contesto vengono spostate in avanti.

Proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

pollingOptions

Opzioni per la configurazione del comportamento di polling.

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

Dettagli proprietà

additionalInstructions

Istruzioni aggiuntive da aggiungere alla fine delle istruzioni per l'esecuzione. Ciò è utile per modificare il comportamento in base all'esecuzione senza eseguire l'override di altre istruzioni.

additionalInstructions?: null | string

Valore della proprietà

null | string

additionalMessages

Aggiunge messaggi aggiuntivi al thread prima di creare l'esecuzione.

additionalMessages?: null | ThreadMessageOptions[]

Valore della proprietà

include

Elenco di campi aggiuntivi da includere nella risposta. Attualmente l'unico valore supportato consiste step_details.tool_calls[*].file_search.results[*].content nel recuperare il contenuto dei risultati della ricerca file.

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

Valore della proprietà

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

instructions

Istruzioni di sistema sottoposte a override che l'agente deve usare per eseguire il thread.

instructions?: null | string

Valore della proprietà

null | string

maxCompletionTokens

Numero massimo di token di completamento che possono essere usati durante l'esecuzione. L'esecuzione farà il possibile per usare solo il numero di token di completamento specificati, in più turni dell'esecuzione. Se l’esecuzione supera il numero di token di completamento specificati, terminerà con lo stato incomplete. Per altre informazioni, vedi incomplete_details.

maxCompletionTokens?: null | number

Valore della proprietà

null | number

maxPromptTokens

Numero massimo di token di richiesta che possono essere usati durante l'esecuzione. L'esecuzione farà del meglio per usare solo il numero di token di richiesta specificati, in più turni dell'esecuzione. Se l’esecuzione supera il numero di token di prompt specificati, terminerà con lo stato incomplete. Per altre informazioni, vedi incomplete_details.

maxPromptTokens?: null | number

Valore della proprietà

null | number

metadata

Set di un massimo di 16 coppie chiave/valore che possono essere collegate a un oggetto, utilizzate per archiviare informazioni aggiuntive su tale oggetto in un formato strutturato. Le chiavi possono avere una lunghezza massima di 64 caratteri e i valori possono avere una lunghezza massima di 512 caratteri.

metadata?: null | Record<string, string>

Valore della proprietà

null | Record<string, string>

model

Nome del modello sottoposto a override che l'agente deve usare per eseguire il thread.

model?: null | string

Valore della proprietà

null | string

parallelToolCalls

Se true funzioni verranno eseguite in parallelo durante l'uso dello strumento.

parallelToolCalls?: boolean

Valore della proprietà

boolean

responseFormat

Specifica il formato che il modello deve restituire.

responseFormat?: null | AgentsResponseFormatOption

Valore della proprietà

stream

Se true, restituisce un flusso di eventi che si verificano durante gli eventi inviati dal server Esegui come, terminando quando Run entra in uno stato terminale con un messaggio di data: [DONE].

stream?: boolean

Valore della proprietà

boolean

temperature

Temperatura di campionamento da usare, compresa tra 0 e 2. Valori più elevati come 0.8 renderanno l'output più casuale, mentre valori più bassi come 0.2 lo renderanno più mirato e deterministico.

temperature?: null | number

Valore della proprietà

null | number

toolChoice

Controlla se e quale strumento viene chiamato dal modello.

toolChoice?: null | AgentsToolChoiceOption

Valore della proprietà

toolResources

Le risorse dello strumento abilitate sottoposte a override che l'agente deve utilizzare per eseguire il thread.

toolResources?: null | ToolResources

Valore della proprietà

null | ToolResources

tools

Elenco sottoposto a override degli strumenti abilitati che l'agente deve usare per eseguire il thread.

tools?: null | ToolDefinitionUnion[]

Valore della proprietà

topP

Un'alternativa al campionamento con temperatura, denominata campionamento del nucleo, in cui il modello considera i risultati dei token con massa di probabilità top_p. Quindi 0,1 significa che vengono considerati solo i token che comprendono la massa di probabilità superiore del 10%.

In genere è consigliabile modificare questo o la temperatura, ma non entrambi.

topP?: null | number

Valore della proprietà

null | number

truncationStrategy

Strategia da usare per eliminare i messaggi man mano che le finestre di contesto vengono spostate in avanti.

truncationStrategy?: null | TruncationObject

Valore della proprietà

Dettagli proprietà ereditate

abortSignal

Segnale che può essere usato per interrompere le richieste.

abortSignal?: AbortSignalLike

Valore della proprietà

Ereditato da OperationOptions.abortSignal

onResponse

Funzione da chiamare ogni volta che viene ricevuta una risposta dal server durante l'esecuzione dell'operazione richiesta. Può essere chiamato più volte.

onResponse?: RawResponseCallback

Valore della proprietà

Ereditato da OperationOptions.onResponse

pollingOptions

Opzioni per la configurazione del comportamento di polling.

pollingOptions?: PollingOptions

Valore della proprietà

Ereditato daPollingOptionsParams.pollingOptions

requestOptions

Opzioni usate durante la creazione e l'invio di richieste HTTP per questa operazione.

requestOptions?: OperationRequestOptions

Valore della proprietà

Ereditato da OperationOptions.requestOptions

tracingOptions

Opzioni utilizzate quando la traccia è abilitata.

tracingOptions?: OperationTracingOptions

Valore della proprietà

Ereditato da OperationOptions.tracingOptions