共用方式為

Documents - Get

  • 參考
服務:
Search Service
API 版本:
2023-10-01-Preview

從索引擷取檔。

GET {endpoint}/indexes('{indexName}')/docs('{key}')?api-version=2023-10-01-Preview
含選擇性參數: 
GET {endpoint}/indexes('{indexName}')/docs('{key}')?$select={$select}&api-version=2023-10-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

SearchError

錯誤回應。

範例

SearchIndexGetDocument

範例要求

GET https://myservice.search.windows.net/indexes('myindex')/docs('1')?$select=docId,title,description&api-version=2023-10-01-Preview

範例回覆

狀態碼:
200 
{
  "description": "Cheapest hotel in town",
  "docId": "1",
  "title": "Nice Hotel"
}

定義

SearchError

描述 API 的錯誤狀況。

名稱 類型 Description
code

string

其中一組伺服器定義的錯誤碼。
details

SearchError[]

導致此錯誤之特定錯誤的詳細數據陣列。
message

string

人類看得懂的錯誤表示法。