Documents - Get

服務:

Search Service

API 版本:

2024-11-01-preview

從索引擷取檔。

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2024-11-01-preview

含選擇性參數:

GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2024-11-01-preview

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	搜尋服務的端點 URL。
indexName	path	True	string	索引的名稱。
key	path	True	string	要擷取之檔的索引鍵。
api-version	query	True	string	用戶端 API 版本。
$select	query		string[]	要為檔擷取的域名清單;未擷取的任何字段都會從傳回的檔中遺失。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string uuid	隨要求一起傳送的追蹤標識碼，以協助偵錯。

回應

名稱	類型	Description
200 OK	LookupDocument	包含所要求文件的回應。
Other Status Codes	ErrorResponse	錯誤回應。

範例

SearchIndexGetDocument

範例要求

HTTP

GET https://previewexampleservice.search.windows.net/indexes('preview-test')/docs('1')?$select=id,description,name,category,ownerId&api-version=2024-11-01-preview

範例回覆

狀態碼:

200

{
  "id": "1",
  "name": "test",
  "description": "test1 hello",
  "category": "purple",
  "ownerId": "sam"
}

定義

名稱	Description
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。