RunsCreateRunOptionalParams interface

패키지:

@azure/ai-agents

선택적 매개 변수입니다.

Extends

OperationOptions,PollingOptionsParams

속성

additionalInstructions	실행에 대한 지침의 끝에 추가하기 위한 추가 지침입니다. 이는 다른 지침을 재정의하지 않고 실행별로 동작을 수정하는 데 유용합니다.
additionalMessages	실행을 만들기 전에 스레드에 추가 메시지를 추가합니다.
include	응답에 포함할 추가 필드 목록입니다. 현재 유일하게 지원되는 값은 step_details.tool_calls[*].file_search.results[*].content 파일 검색 결과 콘텐츠를 가져오는 것입니다.
instructions	에이전트가 스레드를 실행하는 데 사용해야 하는 재정의된 시스템 지침입니다.
maxCompletionTokens	실행 과정에서 사용할 수 있는 완성 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 완성 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 완성 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요.
maxPromptTokens	실행 과정에서 사용할 수 있는 프롬프트 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 프롬프트 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 프롬프트 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요.
metadata	개체에 연결할 수 있는 최대 16개의 키/값 쌍 집합으로, 해당 개체에 대한 추가 정보를 구조화된 형식으로 저장하는 데 사용됩니다. 키의 길이는 최대 64자이고 값의 길이는 최대 512자일 수 있습니다.
model	에이전트가 스레드를 실행하는 데 사용해야 하는 재정의된 모델 이름입니다.
parallelToolCalls	true 함수는 도구를 사용하는 동안 병렬로 실행됩니다.
responseFormat	모델이 출력해야 하는 형식을 지정합니다.
stream	true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다.
temperature	사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.
toolChoice	모델에서 호출되는 도구의 여부와 그 안을 제어합니다.
toolResources	에이전트가 스레드를 실행하는 데 사용해야 하는 재정의된 사용 가능한 도구 리소스입니다.
tools	에이전트가 스레드를 실행하는 데 사용해야 하는 사용 가능한 도구의 재정의된 목록입니다.
topP	모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다. 일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다.
truncationStrategy	컨텍스트 창이 앞으로 이동함에 따라 메시지를 삭제하는 데 사용하는 전략입니다.

상속된 속성

abortSignal	요청을 중단하는 데 사용할 수 있는 신호입니다.
onResponse	요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출할 수 있습니다.
pollingOptions	폴링 동작을 구성하는 옵션입니다.
requestOptions	이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다.
tracingOptions	추적을 사용할 때 사용되는 옵션입니다.

속성 세부 정보

additionalInstructions

실행에 대한 지침의 끝에 추가하기 위한 추가 지침입니다. 이는 다른 지침을 재정의하지 않고 실행별로 동작을 수정하는 데 유용합니다.

additionalInstructions?: null | string

속성 값

null | string

additionalMessages

실행을 만들기 전에 스레드에 추가 메시지를 추가합니다.

additionalMessages?: null | ThreadMessageOptions[]

속성 값

null | ThreadMessageOptions[]

include

응답에 포함할 추가 필드 목록입니다. 현재 유일하게 지원되는 값은 step_details.tool_calls[*].file_search.results[*].content 파일 검색 결과 콘텐츠를 가져오는 것입니다.

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

속성 값

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

instructions

에이전트가 스레드를 실행하는 데 사용해야 하는 재정의된 시스템 지침입니다.

instructions?: null | string

속성 값

null | string

maxCompletionTokens

실행 과정에서 사용할 수 있는 완성 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 완성 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 완성 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요.

maxCompletionTokens?: null | number

속성 값

null | number

maxPromptTokens

실행 과정에서 사용할 수 있는 프롬프트 토큰의 최대 수입니다. 이 실행은 여러 번의 실행 동안 지정된 수의 프롬프트 토큰만 사용하려고 최선의 노력을 기울입니다. 실행이 지정된 프롬프트 토큰 수를 초과하면 상태 incomplete로 종료됩니다. 자세한 내용은 incomplete_details를 참조하세요.

maxPromptTokens?: null | number

속성 값

null | number

metadata

개체에 연결할 수 있는 최대 16개의 키/값 쌍 집합으로, 해당 개체에 대한 추가 정보를 구조화된 형식으로 저장하는 데 사용됩니다. 키의 길이는 최대 64자이고 값의 길이는 최대 512자일 수 있습니다.

metadata?: null | Record<string, string>

속성 값

null | Record<string, string>

model

에이전트가 스레드를 실행하는 데 사용해야 하는 재정의된 모델 이름입니다.

model?: null | string

속성 값

null | string

parallelToolCalls

true 함수는 도구를 사용하는 동안 병렬로 실행됩니다.

parallelToolCalls?: boolean

속성 값

boolean

responseFormat

모델이 출력해야 하는 형식을 지정합니다.

responseFormat?: null | AgentsResponseFormatOption

속성 값

null | AgentsResponseFormatOption

stream

true인 경우, 실행 서버에서 보낸 이벤트 중에 발생하는 이벤트 스트림을 반환하고, data: [DONE] 메시지를 표시하면서 실행이 터미널 상태가 될 때 종료됩니다.

stream?: boolean

속성 값

boolean

temperature

사용할 샘플링 온도(0에서 2 사이)입니다. 0.8과 같이 값이 높을수록 출력이 더욱 무작위로 생성되고, 0.2와 같이 더 낮은 값을 지정하면 출력이 더욱 집중되고 결정적이게 됩니다.

temperature?: null | number

속성 값

null | number

toolChoice

모델에서 호출되는 도구의 여부와 그 안을 제어합니다.

toolChoice?: null | AgentsToolChoiceOption

속성 값

null | AgentsToolChoiceOption

toolResources

에이전트가 스레드를 실행하는 데 사용해야 하는 재정의된 사용 가능한 도구 리소스입니다.

toolResources?: null | ToolResources

속성 값

null | ToolResources

tools

에이전트가 스레드를 실행하는 데 사용해야 하는 사용 가능한 도구의 재정의된 목록입니다.

tools?: null | ToolDefinitionUnion[]

속성 값

null | ToolDefinitionUnion[]

topP

모델이 top_p 확률 질량을 가진 토큰의 결과를 고려하는 핵 샘플링이라고 하는 온도를 사용한 샘플링의 대안입니다. 따라서 0.1은 상위 10% 확률 질량을 구성하는 토큰만 고려됨을 의미합니다.

일반적으로 이를 변경하거나 온도를 변경하는 것이 좋지만 둘 다 변경하는 것은 권장하지 않습니다.

topP?: null | number

속성 값

null | number

truncationStrategy

컨텍스트 창이 앞으로 이동함에 따라 메시지를 삭제하는 데 사용하는 전략입니다.

truncationStrategy?: null | TruncationObject

속성 값

null | TruncationObject

상속된 속성 세부 정보

abortSignal

요청을 중단하는 데 사용할 수 있는 신호입니다.

abortSignal?: AbortSignalLike

속성 값

AbortSignalLike

OperationOptions.abortSignal에서 상속된

onResponse

요청된 작업을 수행하는 동안 서버에서 응답을 받을 때마다 호출되는 함수입니다. 여러 번 호출할 수 있습니다.

onResponse?: RawResponseCallback

속성 값

RawResponseCallback

OperationOptions.onResponse에서 상속된

pollingOptions

폴링 동작을 구성하는 옵션입니다.

pollingOptions?: PollingOptions

속성 값

PollingOptions

PollingOptionsParams.pollingOptions 상속된

requestOptions

이 작업에 대한 HTTP 요청을 만들고 보낼 때 사용되는 옵션입니다.

requestOptions?: OperationRequestOptions

속성 값

OperationRequestOptions

OperationOptions.requestOptions에서 상속된

tracingOptions

추적을 사용할 때 사용되는 옵션입니다.

tracingOptions?: OperationTracingOptions

속성 값

OperationTracingOptions

OperationOptions.tracingOptions에서 상속된