RunsCreateRunOptionalParams interface

Paket:

@azure/ai-agents

İsteğe bağlı parametreler.

Extends

OperationOptions,PollingOptionsParams

Özellikler

additionalInstructions	Çalıştırma yönergelerinin sonuna eklenecek ek yönergeler. Bu, diğer yönergeleri geçersiz kılmadan çalıştırma başına davranışı değiştirmek için kullanışlıdır.
additionalMessages	Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler.
include	Yanıta eklenecek ek alanların listesi. Şu anda desteklenen tek değer, dosya arama sonucu içeriğini getirmektir step_details.tool_calls[*].file_search.results[*].content .
instructions	Aracının iş parçacığını çalıştırmak için kullanması gereken geçersiz kılınan sistem yönergeleri.
maxCompletionTokens	Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
maxPromptTokens	Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.
metadata	Nesneyle ilgili ek bilgileri yapılandırılmış biçimde depolamak için kullanılan, nesneye eklenebilen en fazla 16 anahtar/değer çifti kümesi. Anahtarların uzunluğu en çok 64 karakter, değerler ise en çok 512 karakter uzunluğunda olabilir.
model	Aracının iş parçacığını çalıştırmak için kullanması gereken geçersiz kılınan model adı.
parallelToolCalls	Araç kullanımı sırasında true işlevleri paralel olarak çalışacaksa.
responseFormat	Modelin çıkış yapması gereken biçimi belirtir.
stream	ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.
temperature	0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.
toolChoice	Model tarafından çağrılıp çağrılmayacağını ve hangi aracın çağrılıp çağrılmayacağını denetler.
toolResources	Aracının iş parçacığını çalıştırmak için kullanması gereken geçersiz kılınan etkinleştirilmiş araç kaynakları.
tools	Aracının iş parçacığını çalıştırmak için kullanması gereken etkin araçların geçersiz kılınan listesi.
topP	Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir. Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.
truncationStrategy	Bağlam pencereleri ilerlerken iletileri bırakmak için kullanılacak strateji.

Devralınan Özellikler

abortSignal	İstekleri durdurmak için kullanılabilecek sinyal.
onResponse	İstenen işlem gerçekleştirilirken sunucudan her yanıt alındığında çağrılacak bir işlev. Birden çok kez çağrılabilir.
pollingOptions	Yoklama davranışını yapılandırma seçenekleri.
requestOptions	Bu işlem için HTTP istekleri oluştururken ve gönderirken kullanılan seçenekler.
tracingOptions	İzleme etkinleştirildiğinde kullanılan seçenekler.

Özellik Ayrıntıları

additionalInstructions

Çalıştırma yönergelerinin sonuna eklenecek ek yönergeler. Bu, diğer yönergeleri geçersiz kılmadan çalıştırma başına davranışı değiştirmek için kullanışlıdır.

additionalInstructions?: null | string

Özellik Değeri

null | string

additionalMessages

Çalıştırmayı oluşturmadan önce iş parçacığına ek iletiler ekler.

additionalMessages?: null | ThreadMessageOptions[]

Özellik Değeri

null | ThreadMessageOptions[]

include

Yanıta eklenecek ek alanların listesi. Şu anda desteklenen tek değer, dosya arama sonucu içeriğini getirmektir step_details.tool_calls[*].file_search.results[*].content .

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

Özellik Değeri

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

instructions

Aracının iş parçacığını çalıştırmak için kullanması gereken geçersiz kılınan sistem yönergeleri.

instructions?: null | string

Özellik Değeri

null | string

maxCompletionTokens

Çalıştırma boyunca kullanılabilecek en fazla tamamlanma belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen tamamlanma belirteçlerinin sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen tamamlanma belirteçlerinin sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.

maxCompletionTokens?: null | number

Özellik Değeri

null | number

maxPromptTokens

Çalıştırma boyunca kullanılabilecek en fazla istem belirteci sayısı. Çalıştırma, çalıştırmanın birden çok dönüşünde yalnızca belirtilen istem belirteci sayısını kullanmak için en iyi çabayı gösterir. Çalıştırma belirtilen istem belirteci sayısını aşarsa, çalıştırma durumu incompleteile sona erer. Daha fazla bilgi için bkz. incomplete_details.

maxPromptTokens?: null | number

Özellik Değeri

null | number

metadata

Nesneyle ilgili ek bilgileri yapılandırılmış biçimde depolamak için kullanılan, nesneye eklenebilen en fazla 16 anahtar/değer çifti kümesi. Anahtarların uzunluğu en çok 64 karakter, değerler ise en çok 512 karakter uzunluğunda olabilir.

metadata?: null | Record<string, string>

Özellik Değeri

null | Record<string, string>

model

Aracının iş parçacığını çalıştırmak için kullanması gereken geçersiz kılınan model adı.

model?: null | string

Özellik Değeri

null | string

parallelToolCalls

Araç kullanımı sırasında true işlevleri paralel olarak çalışacaksa.

parallelToolCalls?: boolean

Özellik Değeri

boolean

responseFormat

Modelin çıkış yapması gereken biçimi belirtir.

responseFormat?: null | AgentsResponseFormatOption

Özellik Değeri

null | AgentsResponseFormatOption

stream

ise true, Sunucu tarafından gönderilen farklı çalıştır olayları sırasında gerçekleşen olayların akışını döndürür ve Çalıştır bir iletiyle data: [DONE] bir terminal durumuna girdiğinde sonlandırılır.

stream?: boolean

Özellik Değeri

boolean

temperature

0 ile 2 arasında hangi örnekleme sıcaklığının kullanılacağı. 0,8 gibi daha yüksek değerler çıkışı daha rastgele hale getirirken, 0,2 gibi daha düşük değerler daha odaklanmış ve belirleyici hale getirir.

temperature?: null | number

Özellik Değeri

null | number

toolChoice

Model tarafından çağrılıp çağrılmayacağını ve hangi aracın çağrılıp çağrılmayacağını denetler.

toolChoice?: null | AgentsToolChoiceOption

Özellik Değeri

null | AgentsToolChoiceOption

toolResources

Aracının iş parçacığını çalıştırmak için kullanması gereken geçersiz kılınan etkinleştirilmiş araç kaynakları.

toolResources?: null | ToolResources

Özellik Değeri

null | ToolResources

tools

Aracının iş parçacığını çalıştırmak için kullanması gereken etkin araçların geçersiz kılınan listesi.

tools?: null | ToolDefinitionUnion[]

Özellik Değeri

null | ToolDefinitionUnion[]

topP

Modelin top_p olasılık kütlesine sahip belirteçlerin sonuçlarını dikkate aldığı, çekirdek örneklemesi olarak adlandırılan sıcaklıkla örneklemeye alternatiftir. Bu nedenle 0,1 yalnızca ilk %10 olasılık kütlesinden oluşan belirteçlerin dikkate alınması anlamına gelir.

Genellikle bunu veya sıcaklığı değiştirmenizi öneririz, ancak ikisini birden değiştirmemenizi öneririz.

topP?: null | number

Özellik Değeri

null | number

truncationStrategy

Bağlam pencereleri ilerlerken iletileri bırakmak için kullanılacak strateji.

truncationStrategy?: null | TruncationObject

Özellik Değeri

null | TruncationObject

Devralınan Özellik Detayları

abortSignal

İstekleri durdurmak için kullanılabilecek sinyal.

abortSignal?: AbortSignalLike

Özellik Değeri

AbortSignalLike

OperationOptions.abortSignal'dan Devralınan

onResponse

İstenen işlem gerçekleştirilirken sunucudan her yanıt alındığında çağrılacak bir işlev. Birden çok kez çağrılabilir.

onResponse?: RawResponseCallback

Özellik Değeri

RawResponseCallback

OperationOptions.onResponse'dan Devralınmış

pollingOptions

Yoklama davranışını yapılandırma seçenekleri.

pollingOptions?: PollingOptions

Özellik Değeri

PollingOptions

PollingOptionsParams.pollingOptionsDevralındı

requestOptions

Bu işlem için HTTP istekleri oluştururken ve gönderirken kullanılan seçenekler.

requestOptions?: OperationRequestOptions

Özellik Değeri

OperationRequestOptions

OperationOptions.requestOptions Devralındı

tracingOptions

İzleme etkinleştirildiğinde kullanılan seçenekler.

tracingOptions?: OperationTracingOptions

Özellik Değeri

OperationTracingOptions

OperationOptions.tracingOptions Devralındı