ChatCompletionSkill interface

패키지:

@azure/search-documents

Azure AI Foundry의 Chat Completions 엔드포인트를 통해 언어 모델을 호출하는 스킬입니다.

Extends

WebApiSkill

속성

apiKey	모델에 인증하기 위한 API 키입니다. apiKey와 authIdentity는 동시에 지정할 수 없습니다.
commonModelParameters	고객이 조정할 수 있는 공통 언어 모델 매개 변수입니다. 생략하면 합리적인 기본값이 적용됩니다.
extraParameters	채팅 완료 호출에 추가해야 하는 모델별 매개 변수에 대한 개방형 사전입니다. Azure AI Foundry의 확장성 패턴을 따릅니다.
extraParametersBehavior	Azure AI Foundry가 추가 매개변수를 어떻게 처리하는지에 대해 알아보세요. 기본값은 'error'입니다.
odatatype	이 개체가 될 수 있는 다양한 형식을 지정하는 다형 판별자
responseFormat	LLM이 응답의 형식을 지정하는 방법을 결정합니다. 기본값은 'text' 응답 유형입니다.

상속된 속성

authIdentity	아웃바운드 연결에 사용되는 사용자 할당 관리 ID입니다. authResourceId가 제공되고 지정되지 않은 경우 시스템 할당 관리 ID가 사용됩니다. 인덱서 업데이트 시 ID가 지정되지 않은 경우 값은 변경되지 않은 상태로 유지됩니다. "none"으로 설정하면 이 속성의 값이 지워집니다.
authResourceId	Azure 함수나 변환을 제공하는 다른 애플리케이션에서 외부 코드와 연결하는 맞춤형 스킬에 적용됩니다. 이 값은 Azure Active Directory에 등록된 기능이나 앱에 대해 생성된 애플리케이션 ID여야 합니다. 지정된 경우 사용자 지정 기술은 검색 서비스의 관리 ID(시스템 또는 사용자 할당)와 함수 또는 앱의 액세스 토큰을 사용하여 함수 또는 앱에 연결합니다. 이 값을 액세스 토큰의 범위를 만들기 위한 리소스 ID로 사용합니다.
batchSize	문서 수를 나타내는 원하는 일괄 처리 크기입니다.
context	문서 루트 또는 문서 콘텐츠(예: /document 또는 /document/content)와 같은 작업이 수행되는 수준을 나타냅니다. 기본값은 /document입니다.
degreeOfParallelism	설정된 경우 Web API에 대해 수행할 수 있는 병렬 호출 수입니다.
description	기술의 입력, 출력 및 사용을 설명하는 기술에 대한 설명입니다.
httpHeaders	http 요청을 만드는 데 필요한 헤더입니다.
httpMethod	http 요청에 대한 메서드입니다.
inputs	기술 입력은 원본 데이터 집합의 열 또는 업스트림 기술의 출력일 수 있습니다.
name	기술 세트 내에서 고유하게 식별하는 기술의 이름입니다. 이름이 정의되지 않은 기술에는 '#' 문자 앞에 접두사로 지정된 기술 배열에서 1부터 시작하는 인덱스의 기본 이름이 지정됩니다.
outputs	기술의 출력은 검색 인덱스의 필드이거나 다른 기술의 입력으로 사용할 수 있는 값입니다.
timeout	요청에 대해 원하는 시간 제한입니다. 기본값은 30초입니다.
uri	Web API의 URL입니다.

속성 세부 정보

apiKey

모델에 인증하기 위한 API 키입니다. apiKey와 authIdentity는 동시에 지정할 수 없습니다.

apiKey?: string

속성 값

string

commonModelParameters

고객이 조정할 수 있는 공통 언어 모델 매개 변수입니다. 생략하면 합리적인 기본값이 적용됩니다.

commonModelParameters?: CommonModelParameters

속성 값

CommonModelParameters

extraParameters

채팅 완료 호출에 추가해야 하는 모델별 매개 변수에 대한 개방형 사전입니다. Azure AI Foundry의 확장성 패턴을 따릅니다.

extraParameters?: {[propertyName: string]: unknown}

속성 값

{[propertyName: string]: unknown}

extraParametersBehavior

Azure AI Foundry가 추가 매개변수를 어떻게 처리하는지에 대해 알아보세요. 기본값은 'error'입니다.

extraParametersBehavior?: string

속성 값

string

odatatype

이 개체가 될 수 있는 다양한 형식을 지정하는 다형 판별자

odatatype: "#Microsoft.Skills.Custom.ChatCompletionSkill"

속성 값

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

LLM이 응답의 형식을 지정하는 방법을 결정합니다. 기본값은 'text' 응답 유형입니다.

responseFormat?: ChatCompletionResponseFormat

속성 값

ChatCompletionResponseFormat

상속된 속성 세부 정보

authIdentity

아웃바운드 연결에 사용되는 사용자 할당 관리 ID입니다. authResourceId가 제공되고 지정되지 않은 경우 시스템 할당 관리 ID가 사용됩니다. 인덱서 업데이트 시 ID가 지정되지 않은 경우 값은 변경되지 않은 상태로 유지됩니다. "none"으로 설정하면 이 속성의 값이 지워집니다.

authIdentity?: SearchIndexerDataIdentity

속성 값

SearchIndexerDataIdentity

다음에서 상속됨WebApiSkill.authIdentity

authResourceId

Azure 함수나 변환을 제공하는 다른 애플리케이션에서 외부 코드와 연결하는 맞춤형 스킬에 적용됩니다. 이 값은 Azure Active Directory에 등록된 기능이나 앱에 대해 생성된 애플리케이션 ID여야 합니다. 지정된 경우 사용자 지정 기술은 검색 서비스의 관리 ID(시스템 또는 사용자 할당)와 함수 또는 앱의 액세스 토큰을 사용하여 함수 또는 앱에 연결합니다. 이 값을 액세스 토큰의 범위를 만들기 위한 리소스 ID로 사용합니다.

authResourceId?: string

속성 값

string

다음에서 상속됨WebApiSkill.authResourceId

batchSize

문서 수를 나타내는 원하는 일괄 처리 크기입니다.

batchSize?: number

속성 값

number

다음에서 상속됨WebApiSkill.batchSize

context

문서 루트 또는 문서 콘텐츠(예: /document 또는 /document/content)와 같은 작업이 수행되는 수준을 나타냅니다. 기본값은 /document입니다.

context?: string

속성 값

string

다음에서 상속됨WebApiSkill.context

degreeOfParallelism

설정된 경우 Web API에 대해 수행할 수 있는 병렬 호출 수입니다.

degreeOfParallelism?: number

속성 값

number

다음에서 상속됨WebApiSkill.degreeOfParallelism

description

기술의 입력, 출력 및 사용을 설명하는 기술에 대한 설명입니다.

description?: string

속성 값

string

다음에서 상속됨WebApiSkill.description

httpHeaders

http 요청을 만드는 데 필요한 헤더입니다.

httpHeaders?: {[propertyName: string]: string}

속성 값

{[propertyName: string]: string}

다음에서 상속됨WebApiSkill.httpHeaders

httpMethod

http 요청에 대한 메서드입니다.

httpMethod?: string

속성 값

string

다음에서 상속됨WebApiSkill.httpMethod

inputs

기술 입력은 원본 데이터 집합의 열 또는 업스트림 기술의 출력일 수 있습니다.

inputs: InputFieldMappingEntry[]

속성 값

InputFieldMappingEntry[]

다음에서 상속됨WebApiSkill.inputs

name

기술 세트 내에서 고유하게 식별하는 기술의 이름입니다. 이름이 정의되지 않은 기술에는 '#' 문자 앞에 접두사로 지정된 기술 배열에서 1부터 시작하는 인덱스의 기본 이름이 지정됩니다.

name?: string

속성 값

string

WebApiSkill.name 에서 상속됨

outputs

기술의 출력은 검색 인덱스의 필드이거나 다른 기술의 입력으로 사용할 수 있는 값입니다.

outputs: OutputFieldMappingEntry[]

속성 값

OutputFieldMappingEntry[]

WebApiSkill.outputs에서 상속됨

timeout

요청에 대해 원하는 시간 제한입니다. 기본값은 30초입니다.

timeout?: string

속성 값

string

다음에서 상속됨WebApiSkill.timeout

uri

Web API의 URL입니다.

uri: string

속성 값

string

다음에서 상속됨WebApiSkill.uri