Aracılığıyla paylaş


Documents - Index

Dizine bir grup belge yazma eylemi gönderir.

POST {endpoint}/indexes('{indexName}')/docs/search.index?api-version=2023-11-01

URI Parametreleri

Name İçinde Gerekli Tür Description
endpoint
path True

string

Arama hizmetinin uç nokta URL'si.

indexName
path True

string

Dizinin adı.

api-version
query True

string

İstemci Api Sürümü.

İstek Başlığı

Name Gerekli Tür Description
x-ms-client-request-id

string

uuid

Hata ayıklamaya yardımcı olmak için istekle birlikte gönderilen izleme kimliği.

İstek Gövdesi

Name Gerekli Tür Description
value True

IndexAction[]

Toplu işlemdeki eylemler.

Yanıtlar

Name Tür Description
200 OK

IndexDocumentsResult

Toplu işteki tüm eylemler için işlemlerin durumunu içeren yanıt.

Other Status Codes

IndexDocumentsResult

Toplu işteki tüm eylemler için işlemlerin durumunu içeren yanıt.

Other Status Codes

SearchError

Hata yanıtı.

Örnekler

SearchIndexIndexDocuments

Örnek isteği

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.index?api-version=2023-11-01

{
  "value": [
    {
      "@search.action": "upload",
      "docId": "1",
      "title": "Fancy Stay",
      "description": "Best hotel in town"
    },
    {
      "@search.action": "merge",
      "docId": "2",
      "title": "Roach Motel"
    },
    {
      "@search.action": "mergeOrUpload",
      "docId": "3",
      "title": "Econo Motel"
    },
    {
      "@search.action": "delete",
      "docId": "4"
    }
  ]
}

Örnek yanıt

{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}
{
  "value": [
    {
      "key": "1",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "2",
      "status": false,
      "errorMessage": "Document not found.",
      "statusCode": 404
    },
    {
      "key": "3",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    },
    {
      "key": "4",
      "status": true,
      "errorMessage": null,
      "statusCode": 200
    }
  ]
}

Tanımlar

Name Description
IndexAction

Belge üzerinde çalışan bir dizin eylemini temsil eder.

IndexActionType

Dizin oluşturma toplu işlemindeki bir belge üzerinde gerçekleştirilecek işlem.

IndexBatch

Dizine gönderilecek bir grup belge yazma eylemi içerir.

IndexDocumentsResult

Dizin oluşturma isteğindeki tüm belgeler için işlemlerin durumunu içeren yanıt.

IndexingResult

Tek bir belge için dizin oluşturma işleminin durumu.

SearchError

API için bir hata koşulu açıklar.

IndexAction

Belge üzerinde çalışan bir dizin eylemini temsil eder.

Name Tür Description
@search.action

IndexActionType

Dizin oluşturma toplu işlemindeki bir belge üzerinde gerçekleştirilecek işlem.

IndexActionType

Dizin oluşturma toplu işlemindeki bir belge üzerinde gerçekleştirilecek işlem.

Name Tür Description
delete

string

Belirtilen belgeyi dizinden kaldırır. Silme işleminde anahtar alanı dışında belirttiğiniz tüm alanlar yoksayılır. Belgeden tek bir alanı kaldırmak istiyorsanız, bunun yerine birleştir'i kullanın ve alanı açıkça null olarak ayarlayın.

merge

string

Belirtilen alan değerlerini var olan bir belgeyle birleştirir. Belge yoksa birleştirme başarısız olur. Birleştirmede belirttiğiniz herhangi bir alan belgede var olan alanın yerini alır. Bu, ilkel ve karmaşık tür koleksiyonları için de geçerlidir.

mergeOrUpload

string

Belirtilen anahtara sahip bir belge dizinde zaten varsa birleştirme gibi davranır. Belge yoksa, yeni bir belgeyle karşıya yükleme gibi davranır.

upload

string

Yeniyse belgeyi dizine ekler ve varsa güncelleştirir. Güncelleştirme durumunda tüm alanlar değiştirilir.

IndexBatch

Dizine gönderilecek bir grup belge yazma eylemi içerir.

Name Tür Description
value

IndexAction[]

Toplu işlemdeki eylemler.

IndexDocumentsResult

Dizin oluşturma isteğindeki tüm belgeler için işlemlerin durumunu içeren yanıt.

Name Tür Description
value

IndexingResult[]

Dizin oluşturma isteğindeki her belge için durum bilgilerinin listesi.

IndexingResult

Tek bir belge için dizin oluşturma işleminin durumu.

Name Tür Description
errorMessage

string

Anahtar tarafından tanımlanan belge için dizin oluşturma işleminin neden başarısız olduğunu açıklayan hata iletisi; dizin oluşturma başarılı olursa null.

key

string

Dizin oluşturma isteğindeki bir belgenin anahtarı.

status

boolean

Anahtar tarafından tanımlanan belge için dizin oluşturma işleminin başarılı olup olmadığını gösteren değer.

statusCode

integer

Dizin oluşturma işleminin durum kodu. Olası değerler şunlardır: başarılı bir güncelleştirme veya silme için 200, başarılı belge oluşturma için 201, hatalı biçimlendirilmiş bir giriş belgesi için 400, belge bulunamadı için 404, sürüm çakışması için 409, dizin geçici olarak kullanılamadığında 422 veya hizmet çok meşgul olduğunda 503.

SearchError

API için bir hata koşulu açıklar.

Name Tür Description
code

string

Sunucu tanımlı hata kodları kümesinden biri.

details

SearchError[]

Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.

message

string

Hatanın insanlar tarafından okunabilir bir gösterimi.