RunsCreateRunOptionalParams interface

Balíček:

@azure/ai-agents

Volitelné parametry.

Extends

OperationOptions,PollingOptionsParams

Vlastnosti

additionalInstructions	Další pokyny pro připojení na konec pokynů pro spuštění. To je užitečné pro úpravu chování na základě spuštění bez přepsání dalších instrukcí.
additionalMessages	Před vytvořením spuštění přidá do vlákna další zprávy.
include	Seznam dalších polí, která se mají zahrnout do odpovědi. Aktuálně je jedinou podporovanou hodnotou step_details.tool_calls[*].file_search.results[*].content pro načtení obsahu výsledků vyhledávání v souboru.
instructions	Přepsání systémových instrukcí, které má agent použít ke spuštění vlákna.
maxCompletionTokens	Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete v incomplete_details.
maxPromptTokens	Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete v incomplete_details.
metadata	Sada až 16 dvojic klíč/hodnota, které lze připojit k objektu, které slouží k ukládání dalších informací o daném objektu ve strukturovaném formátu. Klíče můžou mít délku až 64 znaků a hodnoty můžou mít délku až 512 znaků.
model	Přepsaný název modelu, který má agent použít ke spuštění vlákna.
parallelToolCalls	Pokud true funkce poběží paralelně během použití nástroje.
responseFormat	Určuje formát, který musí model vypíše.
stream	Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .
temperature	Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.
toolChoice	Určuje, zda a který nástroj je volána modelem.
toolResources	Přepsané povolené prostředky nástroje, které by měl agent použít ke spuštění vlákna.
tools	Přepsaný seznam povolených nástrojů, které má agent použít ke spuštění vlákna.
topP	Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti. Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.
truncationStrategy	Strategie, která se má použít k vyřazení zpráv, když se kontextová okna posunou vpřed.

Zděděné vlastnosti

abortSignal	Signál, který lze použít k přerušení požadavků.
onResponse	Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může se volat vícekrát.
pollingOptions	Možnosti konfigurace chování dotazování
requestOptions	Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci
tracingOptions	Možnosti používané při povolení trasování

Podrobnosti vlastnosti

additionalInstructions

Další pokyny pro připojení na konec pokynů pro spuštění. To je užitečné pro úpravu chování na základě spuštění bez přepsání dalších instrukcí.

additionalInstructions?: null | string

Hodnota vlastnosti

null | string

additionalMessages

Před vytvořením spuštění přidá do vlákna další zprávy.

additionalMessages?: null | ThreadMessageOptions[]

Hodnota vlastnosti

null | ThreadMessageOptions[]

include

Seznam dalších polí, která se mají zahrnout do odpovědi. Aktuálně je jedinou podporovanou hodnotou step_details.tool_calls[*].file_search.results[*].content pro načtení obsahu výsledků vyhledávání v souboru.

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

Hodnota vlastnosti

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

instructions

Přepsání systémových instrukcí, které má agent použít ke spuštění vlákna.

instructions?: null | string

Hodnota vlastnosti

null | string

maxCompletionTokens

Maximální počet tokenů dokončení, které lze použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze zadaného počtu tokenů dokončení, a to napříč několikanásobným otočením spuštění. Pokud spuštění překročí zadaný počet tokenů dokončení, spuštění skončí stavem incomplete. Další informace najdete v incomplete_details.

maxCompletionTokens?: null | number

Hodnota vlastnosti

null | number

maxPromptTokens

Maximální počet výzev tokenů, které se můžou použít v průběhu spuštění. Spuštění bude maximálně usilovat o použití pouze počtu zadaných tokenů výzvy, a to napříč několikanásobným spuštěním. Pokud spuštění překročí zadaný počet zadaných tokenů výzvy, spuštění skončí se stavem incomplete. Další informace najdete v incomplete_details.

maxPromptTokens?: null | number

Hodnota vlastnosti

null | number

metadata

Sada až 16 dvojic klíč/hodnota, které lze připojit k objektu, které slouží k ukládání dalších informací o daném objektu ve strukturovaném formátu. Klíče můžou mít délku až 64 znaků a hodnoty můžou mít délku až 512 znaků.

metadata?: null | Record<string, string>

Hodnota vlastnosti

null | Record<string, string>

model

Přepsaný název modelu, který má agent použít ke spuštění vlákna.

model?: null | string

Hodnota vlastnosti

null | string

parallelToolCalls

Pokud true funkce poběží paralelně během použití nástroje.

parallelToolCalls?: boolean

Hodnota vlastnosti

boolean

responseFormat

Určuje formát, který musí model vypíše.

responseFormat?: null | AgentsResponseFormatOption

Hodnota vlastnosti

null | AgentsResponseFormatOption

stream

Pokud truevrátí datový proud událostí, ke kterým dochází během událostí odesílaných serverem Spustit jako, ukončení při zadání stavu terminálu se zprávou data: [DONE] .

stream?: boolean

Hodnota vlastnosti

boolean

temperature

Jakou teplotu vzorkování použít, mezi 0 a 2. Vyšší hodnoty jako 0,8 způsobí, že výstup bude náhodnější, zatímco nižší hodnoty, jako je 0,2, zajistí větší zaměření a deterministiku.

temperature?: null | number

Hodnota vlastnosti

null | number

toolChoice

Určuje, zda a který nástroj je volána modelem.

toolChoice?: null | AgentsToolChoiceOption

Hodnota vlastnosti

null | AgentsToolChoiceOption

toolResources

Přepsané povolené prostředky nástroje, které by měl agent použít ke spuštění vlákna.

toolResources?: null | ToolResources

Hodnota vlastnosti

null | ToolResources

tools

Přepsaný seznam povolených nástrojů, které má agent použít ke spuštění vlákna.

tools?: null | ToolDefinitionUnion[]

Hodnota vlastnosti

null | ToolDefinitionUnion[]

topP

Alternativou k odběru vzorků s teplotou, označovanou jako vzorkování jádra, kde model bere v úvahu výsledky tokenů s top_p hmotností pravděpodobnosti. Hodnota 0,1 tedy znamená, že se považují pouze tokeny, které tvoří 10% hmotnost pravděpodobnosti.

Obecně doporučujeme změnit tuto nebo teplotu, ale ne obojí.

topP?: null | number

Hodnota vlastnosti

null | number

truncationStrategy

Strategie, která se má použít k vyřazení zpráv, když se kontextová okna posunou vpřed.

truncationStrategy?: null | TruncationObject

Hodnota vlastnosti

null | TruncationObject

Podrobnosti zděděných vlastností

abortSignal

Signál, který lze použít k přerušení požadavků.

abortSignal?: AbortSignalLike

Hodnota vlastnosti

AbortSignalLike

zděděno z OperationOptions.abortSignal

onResponse

Funkce, která se má volat při každém přijetí odpovědi ze serveru při provádění požadované operace. Může se volat vícekrát.

onResponse?: RawResponseCallback

Hodnota vlastnosti

RawResponseCallback

zděděno z OperationOptions.onResponse

pollingOptions

Možnosti konfigurace chování dotazování

pollingOptions?: PollingOptions

Hodnota vlastnosti

PollingOptions

zděděno zPollingOptionsParams.pollingOptions

requestOptions

Možnosti používané při vytváření a odesílání požadavků HTTP pro tuto operaci

requestOptions?: OperationRequestOptions

Hodnota vlastnosti

OperationRequestOptions

zděděno z OperationOptions.requestOptions

tracingOptions

Možnosti používané při povolení trasování

tracingOptions?: OperationTracingOptions

Hodnota vlastnosti

OperationTracingOptions

zděděno z OperationOptions.tracingOptions