Knowledge Sources - Get

• SearchIndexKnowledgeSource
• AzureBlobKnowledgeSource

ErrorResponse

錯誤回應。

string

指定 AI 服務資源的 API 金鑰。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

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

string

呼叫 AI 服務視覺服務時要使用的模型版本。 未指定時，它將預設為最新的可用。

string (uri)

AI 服務資源的資源 URI。

AIServicesVisionParameters

包含 AI 服務視覺內嵌向量化的特定參數。

aiServicesVision

要設定為與向量搜尋搭配使用的向量化方法類型的名稱。

string

要與此特定向量化方法相關聯的名稱。

string

（密鑰認證所需）反洗錢服務的關鍵。

AIFoundryModelCatalogName

部署在所提供端點的 Azure AI Foundry 目錄中的內嵌模型名稱。

string

（權杖驗證的選用項目）。 部署 AML 服務的區域。

string

（權杖驗證所需）。 AML 服務的 Azure Resource Manager 資源識別碼。 其格式應該為 subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}。

string (duration)

（選用）指定時，指出進行 API 呼叫的 http 用戶端逾時。

string (uri)

（無需身份驗證或密鑰身份驗證時需要）將傳送 JSON 承載之 AML 服務的評分 URI。 只允許 https URI 配置。

AMLParameters

指定 AML 向量化程式的屬性。

aml

要設定為與向量搜尋搭配使用的向量化方法類型的名稱。

string

要與此特定向量化方法相關聯的名稱。

string

已授與 Azure 金鑰保存庫所需存取權限的 AAD 應用程式識別碼，可在加密待用資料時使用。 應用程式識別碼不應與 AAD 應用程式的物件識別碼混淆。

string

指定 AAD 應用程式的驗證金鑰。

string

代理程式的 ETag。

AzureBlobKnowledgeSourceParameters

知識來源的類型。

string

選用的使用者定義描述。

SearchResourceEncryptionKey

您在 Azure 金鑰保存庫中建立的加密金鑰描述。 當您想要完全保證沒有人 （甚至 Microsoft） 無法解密它們時，此金鑰可用來為您的代理程式定義提供額外的待用加密層級。 加密代理程式定義後，它將始終保持加密狀態。 搜尋服務會忽略嘗試將此屬性設定為 Null。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的代理定義將不受影響。 使用客戶管理的金鑰進行加密不適用於免費搜尋服務，且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

azureBlob

知識來源的類型。

string

知識來源的名稱。

KnowledgeAgentAzureOpenAIModel

可選的聊天完成模型，用於圖像語言化或上下文提取。

string

金鑰型連接字串或 ResourceId 格式 （如果使用受控識別）。

string

Blob 儲存體容器的名稱。

object

由知識來源建立的資源。

boolean

指出是否應該停用影像語言化。

• AIServicesVisionVectorizer
• AMLVectorizer
• AzureOpenAIVectorizer
• WebApiVectorizer

用於向量化內容的可選向量化器配置。

string

容器內的選用資料夾路徑。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

用於此知識來源的明確身分識別。

IndexingSchedule

資料擷取的選用排程。

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

指定技能類型的 URI 片段。

string

指定 Azure OpenAI 資源的 API 金鑰。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

用於輸出連線的使用者指派受控識別。

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。

string

指定資源上 Azure OpenAI 模型部署的識別碼。

string

技能的描述，描述技能的輸入、輸出和使用方式。

integer (int32)

產生的輸出內嵌應具有的維度數目。 僅在 text-embedding-3 和更新版本中支援。

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。

AzureOpenAIModelName

部署在提供的 deploymentId 路徑上的內嵌模型名稱。

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

string (uri)

Azure OpenAI 資源的資源 URI。

string

指定 Azure OpenAI 資源的 API 金鑰。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

用於輸出連線的使用者指派受控識別。

string

指定資源上 Azure OpenAI 模型部署的識別碼。

AzureOpenAIModelName

部署在提供的 deploymentId 路徑上的內嵌模型名稱。

string (uri)

Azure OpenAI 資源的資源 URI。

AzureOpenAIEmbeddingSkill

包含 Azure OpenAI 內嵌向量化的特定參數。

azureOpenAI

要設定為與向量搜尋搭配使用的向量化方法類型的名稱。

string

要與此特定向量化方法相關聯的名稱。

object

其他資訊。

string

其他信息類型。

ErrorAdditionalInfo[]

錯誤其他資訊。

string

錯誤碼。

ErrorDetail[]

錯誤詳細資料。

string

錯誤訊息。

string

錯誤目標。

ErrorDetail

error 物件。

string (duration)

索引子執行之間的時間間隔。

string (date-time)

索引子應該開始執行的時間。

InputFieldMappingEntry[]

建立複雜類型時使用的遞迴輸入。

string

輸入的名稱。

string

輸入的來源。

string

用於選取遞迴輸入的來源內容。

AzureOpenAIEmbeddingSkill

包含 Azure OpenAI 模型端點特有的參數。

azureOpenAI

AI 模型的類型。

string

技能所定義的輸出名稱。

string

輸出的目標名稱。 它是選用的，預設為名稱。

#Microsoft.Azure.Search.DataNoneIdentity

指定身分類型的 URI 片段。

#Microsoft.Azure.Search.DataUserAssignedIdentity

指定身分類型的 URI 片段。

string

使用者指派受控識別的完整 Azure 資源識別碼，通常採用「/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId」格式，應該已指派給搜尋服務。

string

代理程式的 ETag。

string

選用的使用者定義描述。

SearchResourceEncryptionKey

您在 Azure 金鑰保存庫中建立的加密金鑰描述。 當您想要完全保證沒有人 （甚至 Microsoft） 無法解密它們時，此金鑰可用來為您的代理程式定義提供額外的待用加密層級。 加密代理程式定義後，它將始終保持加密狀態。 搜尋服務會忽略嘗試將此屬性設定為 Null。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的代理定義將不受影響。 使用客戶管理的金鑰進行加密不適用於免費搜尋服務，且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。

searchIndex

知識來源的類型。

string

知識來源的名稱。

SearchIndexKnowledgeSourceParameters

知識來源的參數。

string

搜尋索引的名稱。

string

用於請求參考來源資料的其他欄位。

AzureActiveDirectoryApplicationCredentials

用來存取 Azure 金鑰保存庫的選擇性 Azure Active Directory 認證。 如果改用受控識別，則不需要。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

用於此加密金鑰的明確受控識別。 如果未指定且存取認證屬性為 Null，則會使用系統指派的受控識別。 更新資源時，如果未指定明確身分識別，則會保持不變。 如果指定 “none” ，則會清除此屬性的值。

string

要用來加密待用資料的 Azure 金鑰保存庫名稱。

string

要用來加密待用資料的 Azure 金鑰版本。

string

Azure 金鑰保存庫的 URI，也稱為 DNS 名稱，其中包含要用來加密待用資料的金鑰。 範例 URI 可能是 https://my-keyvault-name.vault.azure.net。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

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

string

適用於連線到 Azure 函式中外部程式碼的自訂端點，或提供轉換的其他應用程式。 此值應該是向 Azure Active Directory 註冊時針對函式或應用程式建立的應用程式識別碼。 指定時，向量化會使用搜尋服務的受控識別碼 （系統或使用者指派） 和函式或應用程式的存取權杖連線到函式或應用程式，並使用此值作為建立存取權杖範圍的資源識別碼。

object

提出 HTTP 要求所需的標頭。

string

HTTP 要求的方法。

string (duration)

要求所需的逾時。 預設值為 30 秒。

string (uri)

提供向量化器的 Web API 的 URI。

WebApiParameters

指定使用者定義向量化程式的屬性。

customWebApi

要設定為與向量搜尋搭配使用的向量化方法類型的名稱。

string

要與此特定向量化方法相關聯的名稱。