RunsCreateRunOptionalParams interface

Paket:

@azure/ai-agents

Optionale Parameter.

Extends

OperationOptions,PollingOptionsParams

Eigenschaften

additionalInstructions	Zusätzliche Anweisungen zum Anfügen am Ende der Anweisungen für die Ausführung. Dies ist nützlich, um das Verhalten pro Ausführung zu ändern, ohne andere Anweisungen außer Kraft zu setzen.
additionalMessages	Fügt dem Thread zusätzliche Nachrichten hinzu, bevor die Ausführung erstellt wird.
include	Eine Liste mit zusätzlichen Feldern, die in die Antwort aufgenommen werden sollen. Derzeit ist step_details.tool_calls[*].file_search.results[*].content der einzige unterstützte Wert zum Abrufen der Dateisuchergebnisinhalte.
instructions	Die überschriebenen Systemanweisungen, mit denen der Agent den Thread ausführen soll.
maxCompletionTokens	Die maximale Anzahl von Vervollständigungstokens, die im Laufe der Ausführung verwendet werden können. Bei der Ausführung wird bestmöglich versucht, über mehrere Durchläufe der Ausführung hinweg nur die angegebene Anzahl von Vervollständigungstoken zu verwenden. Wenn die Ausführung die angegebene Anzahl von Vervollständigungstoken überschreitet, endet die Ausführung mit dem Status incomplete. Weitere Informationen finden Sie unter incomplete_details.
maxPromptTokens	Die maximale Anzahl von Prompttokens, die im Laufe der Ausführung verwendet werden können. Bei der Ausführung wird bestmöglich versucht, über mehrere Durchläufe der Ausführung hinweg nur die angegebene Anzahl von Prompttoken zu verwenden. Wenn die Ausführung die angegebene Anzahl von Prompttoken überschreitet, endet die Ausführung mit dem Status incomplete. Weitere Informationen finden Sie unter incomplete_details.
metadata	Eine Reihe von bis zu 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können, verwendet, um zusätzliche Informationen zu diesem Objekt in einem strukturierten Format zu speichern. Schlüssel können bis zu 64 Zeichen lang sein und Werte können bis zu 512 Zeichen lang sein.
model	Der Überschreibungsmodellname, den der Agent zum Ausführen des Threads verwenden soll.
parallelToolCalls	Wenn true Funktionen während der Toolverwendung parallel ausgeführt werden.
responseFormat	Gibt das Format an, das das Modell ausgeben muss.
stream	Bei Verwendung von true wird ein Datenstrom von Ereignissen, die während der Ausführung auftreten, als vom Server gesendete Ereignisse zurückgegeben. Der Datenstrom wird beendet, wenn die Ausführung einen Endzustand mit einer Nachricht vom Typ data: [DONE] erreicht.
temperature	Die zu verwendende Temperatur für die Stichprobenentnahme zwischen 0 und 2. Durch höhere Werte wie 0,8 wird die Ausgabe zufälliger, während sie durch niedrigere Werte wie 0,2 fokussierter und deterministischer wird.
toolChoice	Steuert, ob und welches Tool vom Modell aufgerufen wird.
toolResources	Die überschriebenen aktivierten Toolressourcen, die der Agent zum Ausführen des Threads verwenden soll.
tools	Die Überschreibungsliste der aktivierten Tools, die der Agent zum Ausführen des Threads verwenden soll.
topP	Eine Alternative zur Stichprobenentnahme mit Temperatur, die sogenannte Kernstichprobenentnahme (Nucleus Sampling), bei dem das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse „top_p“ berücksichtigt. Daher bedeutet 0,1, dass nur die Token berücksichtigt werden, die die oberen 10 % der Wahrscheinlichkeitsmasse umfassen. Wir empfehlen im Allgemeinen, dies oder die Temperatur zu ändern, aber nicht beides.
truncationStrategy	Die Strategie zum Ablegen von Nachrichten, während sich die Kontextfenster vorwärts bewegen.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
onResponse	Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.
pollingOptions	Optionen zum Konfigurieren des Abrufverhaltens.
requestOptions	Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.
tracingOptions	Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

Details zur Eigenschaft

additionalInstructions

Zusätzliche Anweisungen zum Anfügen am Ende der Anweisungen für die Ausführung. Dies ist nützlich, um das Verhalten pro Ausführung zu ändern, ohne andere Anweisungen außer Kraft zu setzen.

additionalInstructions?: null | string

Eigenschaftswert

null | string

additionalMessages

Fügt dem Thread zusätzliche Nachrichten hinzu, bevor die Ausführung erstellt wird.

additionalMessages?: null | ThreadMessageOptions[]

Eigenschaftswert

null | ThreadMessageOptions[]

include

Eine Liste mit zusätzlichen Feldern, die in die Antwort aufgenommen werden sollen. Derzeit ist step_details.tool_calls[*].file_search.results[*].content der einzige unterstützte Wert zum Abrufen der Dateisuchergebnisinhalte.

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

Eigenschaftswert

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

instructions

Die überschriebenen Systemanweisungen, mit denen der Agent den Thread ausführen soll.

instructions?: null | string

Eigenschaftswert

null | string

maxCompletionTokens

Die maximale Anzahl von Vervollständigungstokens, die im Laufe der Ausführung verwendet werden können. Bei der Ausführung wird bestmöglich versucht, über mehrere Durchläufe der Ausführung hinweg nur die angegebene Anzahl von Vervollständigungstoken zu verwenden. Wenn die Ausführung die angegebene Anzahl von Vervollständigungstoken überschreitet, endet die Ausführung mit dem Status incomplete. Weitere Informationen finden Sie unter incomplete_details.

maxCompletionTokens?: null | number

Eigenschaftswert

null | number

maxPromptTokens

Die maximale Anzahl von Prompttokens, die im Laufe der Ausführung verwendet werden können. Bei der Ausführung wird bestmöglich versucht, über mehrere Durchläufe der Ausführung hinweg nur die angegebene Anzahl von Prompttoken zu verwenden. Wenn die Ausführung die angegebene Anzahl von Prompttoken überschreitet, endet die Ausführung mit dem Status incomplete. Weitere Informationen finden Sie unter incomplete_details.

maxPromptTokens?: null | number

Eigenschaftswert

null | number

metadata

Eine Reihe von bis zu 16 Schlüssel-Wert-Paaren, die an ein Objekt angefügt werden können, verwendet, um zusätzliche Informationen zu diesem Objekt in einem strukturierten Format zu speichern. Schlüssel können bis zu 64 Zeichen lang sein und Werte können bis zu 512 Zeichen lang sein.

metadata?: null | Record<string, string>

Eigenschaftswert

null | Record<string, string>

model

Der Überschreibungsmodellname, den der Agent zum Ausführen des Threads verwenden soll.

model?: null | string

Eigenschaftswert

null | string

parallelToolCalls

Wenn true Funktionen während der Toolverwendung parallel ausgeführt werden.

parallelToolCalls?: boolean

Eigenschaftswert

boolean

responseFormat

Gibt das Format an, das das Modell ausgeben muss.

responseFormat?: null | AgentsResponseFormatOption

Eigenschaftswert

null | AgentsResponseFormatOption

stream

Bei Verwendung von true wird ein Datenstrom von Ereignissen, die während der Ausführung auftreten, als vom Server gesendete Ereignisse zurückgegeben. Der Datenstrom wird beendet, wenn die Ausführung einen Endzustand mit einer Nachricht vom Typ data: [DONE] erreicht.

stream?: boolean

Eigenschaftswert

boolean

temperature

Die zu verwendende Temperatur für die Stichprobenentnahme zwischen 0 und 2. Durch höhere Werte wie 0,8 wird die Ausgabe zufälliger, während sie durch niedrigere Werte wie 0,2 fokussierter und deterministischer wird.

temperature?: null | number

Eigenschaftswert

null | number

toolChoice

Steuert, ob und welches Tool vom Modell aufgerufen wird.

toolChoice?: null | AgentsToolChoiceOption

Eigenschaftswert

null | AgentsToolChoiceOption

toolResources

Die überschriebenen aktivierten Toolressourcen, die der Agent zum Ausführen des Threads verwenden soll.

toolResources?: null | ToolResources

Eigenschaftswert

null | ToolResources

tools

Die Überschreibungsliste der aktivierten Tools, die der Agent zum Ausführen des Threads verwenden soll.

tools?: null | ToolDefinitionUnion[]

Eigenschaftswert

null | ToolDefinitionUnion[]

topP

Eine Alternative zur Stichprobenentnahme mit Temperatur, die sogenannte Kernstichprobenentnahme (Nucleus Sampling), bei dem das Modell die Ergebnisse der Token mit der Wahrscheinlichkeitsmasse „top_p“ berücksichtigt. Daher bedeutet 0,1, dass nur die Token berücksichtigt werden, die die oberen 10 % der Wahrscheinlichkeitsmasse umfassen.

Wir empfehlen im Allgemeinen, dies oder die Temperatur zu ändern, aber nicht beides.

topP?: null | number

Eigenschaftswert

null | number

truncationStrategy

Die Strategie zum Ablegen von Nachrichten, während sich die Kontextfenster vorwärts bewegen.

truncationStrategy?: null | TruncationObject

Eigenschaftswert

null | TruncationObject

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

von OperationOptions.abortSignal geerbt

onResponse

Eine Funktion, die jedes Mal aufgerufen werden soll, wenn eine Antwort vom Server empfangen wird, während der angeforderte Vorgang ausgeführt wird. Kann mehrmals aufgerufen werden.

onResponse?: RawResponseCallback

Eigenschaftswert

RawResponseCallback

von OperationOptions.onResponse geerbt

pollingOptions

Optionen zum Konfigurieren des Abrufverhaltens.

pollingOptions?: PollingOptions

Eigenschaftswert

PollingOptions

geerbt vonPollingOptionsParams.pollingOptions

requestOptions

Optionen, die beim Erstellen und Senden von HTTP-Anforderungen für diesen Vorgang verwendet werden.

requestOptions?: OperationRequestOptions

Eigenschaftswert

OperationRequestOptions

Von OperationOptions.requestOptions geerbt

tracingOptions

Optionen, die verwendet werden, wenn die Ablaufverfolgung aktiviert ist.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

von OperationOptions.tracingOptions geerbt