ChatCompletionSkill interface

套件:

@azure/search-documents

一項技能是透過 Azure AI Foundry 的聊天完成端點呼叫語言模型。

Extends

WebApiSkill

屬性

apiKey	用於向模型進行驗證的 API 金鑰。 apiKey 和 authIdentity 無法同時指定。
commonModelParameters	客戶可以調整的通用語言模型參數。 如果省略，將應用合理的違約。
extraParameters	應附加至聊天完成呼叫的模型特定參數的開放型別字典。 遵循 Azure AI Foundry 的擴充性模式。
extraParametersBehavior	Azure AI Foundry 如何處理額外參數。 預設值為「錯誤」。
odatatype	多型歧視性，指定這個物件可以是的不同類型
responseFormat	決定 LLM 應如何格式化其回應。 預設為「文字」回應類型。

繼承的屬性

authIdentity	用於輸出連線的使用者指派受控識別。 如果提供 authResourceId 且未指定，則會使用系統指派的受控識別。 在索引器更新時，如果未指定身分識別，該值會維持不變。 如果設定為 “none”，則會清除此屬性的值。
authResourceId	適用於連接 Azure 函式或其他提供轉換的外部程式碼的自訂技能。 這個值應該是當函式或應用程式註冊到 Azure Active Directory 時所建立的應用程式 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 如何處理額外參數。 預設值為「錯誤」。

extraParametersBehavior?: string

屬性值

string

odatatype

多型歧視性，指定這個物件可以是的不同類型

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

屬性值

"#Microsoft.Skills.Custom.ChatCompletionSkill"

responseFormat

決定 LLM 應如何格式化其回應。 預設為「文字」回應類型。

responseFormat?: ChatCompletionResponseFormat

屬性值

ChatCompletionResponseFormat

繼承的屬性詳細資料

authIdentity

用於輸出連線的使用者指派受控識別。 如果提供 authResourceId 且未指定，則會使用系統指派的受控識別。 在索引器更新時，如果未指定身分識別，該值會維持不變。 如果設定為 “none”，則會清除此屬性的值。

authIdentity?: SearchIndexerDataIdentity

屬性值

SearchIndexerDataIdentity

繼承自WebApiSkill.authIdentity

authResourceId

適用於連接 Azure 函式或其他提供轉換的外部程式碼的自訂技能。 這個值應該是當函式或應用程式註冊到 Azure Active Directory 時所建立的應用程式 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