Documents - Index

Hizmet:

Search Service

API Sürümü:

2026-04-01

Dizine bir toplu belge yazma eylemi gönderir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Arama hizmetinin uç nokta URL'si.
indexName	path	True	string	Dizinin adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Accept		Accept	Kabul Et başlığı.
x-ms-client-request-id		string (uuid)	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

İstek Gövdesi

Name	Gerekli	Tür	Description
value	True	IndexAction[]	Toplu işteki eylemler.

Yanıtlar

Name	Tür	Description
200 OK	IndexDocumentsResult	Dizin oluşturma isteğindeki tüm belgeler için işlemlerin durumunu içeren yanıt.
Other Status Codes	IndexDocumentsResult	Dizin oluşturma isteğindeki tüm belgeler için işlemlerin durumunu içeren yanıt.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

api-key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name	Description
https://search.azure.com/.default

Örnekler

SearchIndexIndexDocuments

Örnek isteği

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.index?api-version=2026-04-01


{
  "value": [
    {
      "@search.action": "mergeOrUpload",
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "vector1": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector1b": [
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19
      ],
      "vector2": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector3": [
        0,
        1,
        2,
        3,
        4
      ],
      "vector22": [
        20,
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29
      ],
      "ownerId": "benny",
      "category": "purple",
      "price": 0
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "1",
      "name": "test",
      "description": "test1 hello",
      "vector1": [
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector1b": [
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20
      ],
      "vector2": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector3": [
        1,
        2,
        3,
        4,
        5
      ],
      "vector22": [
        21,
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 1
    },
    {
      "@search.action": "mergeOrUpload",
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "vector1": [
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector1b": [
        12,
        13,
        14,
        15,
        16,
        17,
        18,
        19,
        20,
        21
      ],
      "vector2": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector3": [
        2,
        3,
        4,
        5,
        6
      ],
      "vector22": [
        22,
        23,
        24,
        25,
        26,
        27,
        28,
        29,
        30,
        31
      ],
      "ownerId": "sam",
      "category": "purple",
      "price": 2
    }
  ]
}

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Durum kodu:

207

{
  "value": [
    {
      "key": "0",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "1",
      "status": true,
      "statusCode": 201
    },
    {
      "key": "2",
      "status": true,
      "statusCode": 201
    }
  ]
}

Tanımlar

Name	Description
Accept	Kabul Et başlığı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).
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 toplu 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.

Accept

Numaralandırma

Kabul Et başlığı.

Değer	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info		Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi

ErrorResponse

Nesne

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

IndexAction

Nesne

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

Numaralandırma

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

Değer	Description
upload	Belge yeniyse dizine ekler ve varsa güncelleştirir. Güncelleme durumunda tüm alanlar değiştirilir.
merge	Belirtilen alan değerlerini varolan bir belgeyle birleştirir. Belge yoksa, birleştirme başarısız olur. Birleştirmede belirttiğiniz herhangi bir alan, belgede varolan alanın yerini alır. Bu aynı zamanda ilkel ve karmaşık türlerin koleksiyonları için de geçerlidir.
mergeOrUpload	Verilen anahtara sahip bir belge dizinde zaten mevcutsa birleştirme gibi davranır. Belge mevcut değilse, yeni bir belgeyle yükleme gibi davranır.
delete	Belirtilen belgeyi dizinden kaldırır. Silme işleminde anahtar alan dışında belirttiğiniz tüm alanlar yok sayılır. Bir belgeden tek bir alanı kaldırmak istiyorsanız, bunun yerine birleştirmeyi kullanın ve alanı açıkça null olarak ayarlayın.

IndexBatch

Nesne

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

Name	Tür	Description
value	IndexAction[]	Toplu işteki eylemler.

IndexDocumentsResult

Nesne

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

Nesne

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; null değerini alır.
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 (int32)	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.