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 註冊時針對函式或應用程式建立的應用程式識別碼。 指定時，自訂技能會使用搜尋服務的受控識別碼 （系統或使用者指派） 和函式或應用程式的存取權杖連線到函式或應用程式，並使用此值作為建立存取權杖範圍的資源識別碼。
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 註冊時針對函式或應用程式建立的應用程式識別碼。 指定時，自訂技能會使用搜尋服務的受控識別碼 （系統或使用者指派） 和函式或應用程式的存取權杖連線到函式或應用程式，並使用此值作為建立存取權杖範圍的資源識別碼。

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