KnowledgeBase interface

パッケージ:

@azure/search-documents

プロパティ

description	ナレッジベースの説明。
encryptionKey	Azure Key Vault で作成する暗号化キーの説明。 このキーは、Microsoft を含む誰も暗号化を解除できないことを完全に保証したい場合に、ナレッジ ベースの定義に追加レベルの保存時の暗号化を提供するために使用されます。 一度ナレッジベースの定義を暗号化すると、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。ナレッジベースの定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
etag	ナレッジベースの ETag。
knowledgeSources	このナレッジベースで参照される知識源。
models	AI モデルへの接続方法に関する構成オプションが含まれています。
name	ナレッジ ベースの名前。

プロパティの詳細

description

ナレッジベースの説明。

description?: string

プロパティ値

string

encryptionKey

Azure Key Vault で作成する暗号化キーの説明。 このキーは、Microsoft を含む誰も暗号化を解除できないことを完全に保証したい場合に、ナレッジ ベースの定義に追加レベルの保存時の暗号化を提供するために使用されます。 一度ナレッジベースの定義を暗号化すると、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。ナレッジベースの定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

encryptionKey?: SearchResourceEncryptionKey

プロパティ値

SearchResourceEncryptionKey

etag

ナレッジベースの ETag。

etag?: string

プロパティ値

string

knowledgeSources

このナレッジベースで参照される知識源。

knowledgeSources: KnowledgeSourceReference[]

プロパティ値

KnowledgeSourceReference[]

models

AI モデルへの接続方法に関する構成オプションが含まれています。

models?: KnowledgeBaseAzureOpenAIModel[]

プロパティ値

KnowledgeBaseAzureOpenAIModel[]

name

ナレッジ ベースの名前。

name: string

プロパティ値

string