IndexDocumentsBatch 類別

代表 Azure 搜尋服務索引中檔的更新作業批次。

索引作業會依新增至批次的循序執行。

繼承

builtins.object

IndexDocumentsBatch

建構函式

IndexDocumentsBatch()

方法

add_delete_actions	將要刪除的檔新增至 Azure 搜尋服務索引。 刪除會從索引中移除指定的檔。 您在刪除作業中指定的任何欄位，除了索引鍵欄位以外，將會忽略。 如果您想要從檔中移除個別欄位，請改用 merge_documents ，並將欄位明確設定為 None。 刪除作業為等冪。 也就是說，即使文件索引鍵不存在於索引中，使用該索引鍵嘗試進行刪除作業會導致 200 狀態碼。
add_merge_actions	將要合併的檔新增至 Azure 搜尋服務索引中的現有檔。 Merge 功能會更新現有文件的指定欄位。 如果文件不存在，合併就會失敗。 您在合併中指定的任何欄位將取代文件中現有的欄位。 這也適用于基本型別和複雜類型的集合。
add_merge_or_upload_actions	將要合併的檔新增至 Azure 搜尋服務索引中的現有檔，或上傳它們尚不存在。 如果具有指定索引鍵的檔已存在於索引中，此動作的行為就像 合併 一樣。 如果檔不存在，其行為就像是使用新檔 上傳 一樣。
add_upload_actions	新增要上傳至 Azure 搜尋服務索引的檔。 上傳動作類似于「upsert」，如果檔是新的，則會插入檔，並在存在時加以更新/取代。 更新案例中會取代所有欄位。
dequeue_actions	取得目前設定的索引動作清單，並加以清除。
enqueue_actions	將索引動作清單排入佇列。

add_delete_actions

將要刪除的檔新增至 Azure 搜尋服務索引。

刪除會從索引中移除指定的檔。 您在刪除作業中指定的任何欄位，除了索引鍵欄位以外，將會忽略。 如果您想要從檔中移除個別欄位，請改用 merge_documents ，並將欄位明確設定為 None。

刪除作業為等冪。 也就是說，即使文件索引鍵不存在於索引中，使用該索引鍵嘗試進行刪除作業會導致 200 狀態碼。

add_delete_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

參數

名稱	Description
documents 必要	dict 或 list[dict] 要從 Azure 搜尋服務索引中刪除的檔。 可能是單一檔案清單，或檔作為個別參數。

傳回

類型	Description
list[IndexAction]	新增的動作

add_merge_actions

將要合併的檔新增至 Azure 搜尋服務索引中的現有檔。

Merge 功能會更新現有文件的指定欄位。 如果文件不存在，合併就會失敗。 您在合併中指定的任何欄位將取代文件中現有的欄位。 這也適用于基本型別和複雜類型的集合。

add_merge_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

參數

名稱	Description
documents 必要	dict 或 list[dict] 要合併至 Azure 搜尋服務索引的檔。 可能是單一檔案清單，或檔作為個別參數。

傳回

類型	Description
list[IndexAction]	新增的動作

add_merge_or_upload_actions

將要合併的檔新增至 Azure 搜尋服務索引中的現有檔，或上傳它們尚不存在。

如果具有指定索引鍵的檔已存在於索引中，此動作的行為就像 合併 一樣。 如果檔不存在，其行為就像是使用新檔 上傳 一樣。

add_merge_or_upload_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

參數

名稱	Description
documents 必要	dict 或 list[dict] 要合併或上傳至 Azure 搜尋服務索引的檔。 可能是單一檔案清單，或檔作為個別參數。

傳回

類型	Description
list[IndexAction]	新增的動作

add_upload_actions

新增要上傳至 Azure 搜尋服務索引的檔。

上傳動作類似于「upsert」，如果檔是新的，則會插入檔，並在存在時加以更新/取代。 更新案例中會取代所有欄位。

add_upload_actions(*documents: List[Dict] | List[List[Dict]]) -> List[IndexAction]

參數

名稱	Description
documents 必要	dict 或 list[dict] 要上傳至 Azure 搜尋服務索引的檔。 可能是單一檔案清單，或檔作為個別參數。

傳回

類型	Description
list[IndexAction]	新增的動作

dequeue_actions

取得目前設定的索引動作清單，並加以清除。

dequeue_actions(**kwargs: Any) -> List[IndexAction]

傳回

類型	Description
list[IndexAction]	目前的動作

enqueue_actions

將索引動作清單排入佇列。

enqueue_actions(new_actions: IndexAction | List[IndexAction], **kwargs: Any) -> None

參數

名稱	Description
new_actions 必要	IndexAction 或 list[IndexAction] 要排入佇列的動作

屬性

actions

目前要編制索引的索引動作清單。

傳回

類型	Description
list[IndexAction]