Documents - Search Post

Layanan:

Search Service

Versi API:

2025-09-01

Mencari dokumen dalam indeks.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2025-09-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	URL titik akhir layanan pencarian.
indexName	path	True	string	Nama indeks.
api-version	query	True	string	Versi Api Klien.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string (uuid)	ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

Isi Permintaan

Nama	Jenis	Deskripsi
answers	QueryAnswerType	Nilai yang menentukan apakah jawaban harus ditampilkan sebagai bagian dari respons penelusuran.
captions	QueryCaptionType	Nilai yang menentukan apakah teks harus ditampilkan sebagai bagian dari respons penelusuran.
count	boolean	Nilai yang menentukan apakah akan mengambil jumlah total hasil. Secara default adalah false. Menetapkan nilai ini ke true mungkin berdampak pada performa. Perhatikan bahwa hitungan yang dikembalikan adalah perkiraan.
debug	QueryDebugMode	Mengaktifkan alat debugging yang dapat digunakan untuk menjelajahi hasil peringkat ulang Anda lebih lanjut.
facets	string[]	Daftar ekspresi aspek yang akan diterapkan ke kueri pencarian. Setiap ekspresi aspek berisi nama bidang, secara opsional diikuti oleh daftar pasangan nama:nilai yang dipisahkan koma.
filter	string	OData $filter ekspresi untuk diterapkan ke kueri pencarian.
highlight	string	Daftar nama bidang yang dipisahkan koma untuk digunakan untuk sorotan klik. Hanya bidang yang dapat dicari yang dapat digunakan untuk penyorotan klik.
highlightPostTag	string	Tag string yang ditambahkan ke sorotan klik. Harus diatur dengan highlightPreTag. Defaultnya adalah </em>.
highlightPreTag	string	Tag string yang dilanjutkan untuk menekan sorotan. Harus diatur dengan highlightPostTag. Defaultnya adalah <em>.
minimumCoverage	number (double)	Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri pencarian agar kueri dilaporkan sebagai keberhasilan. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan dengan hanya satu replika. Nilai defaultnya adalah 100.
orderby	string	Daftar ekspresi OData $orderby yang dipisahkan koma untuk mengurutkan hasilnya. Setiap ekspresi dapat berupa nama bidang atau panggilan ke fungsi geo.distance() atau search.score(). Setiap ekspresi dapat diikuti oleh asc untuk menunjukkan naik, atau desc untuk menunjukkan turun. Defaultnya adalah urutan menaik. Ikatan akan diputuskan oleh skor pertandingan dokumen. Jika tidak ada $orderby yang ditentukan, urutan pengurutan default adalah menurun berdasarkan skor kecocokan dokumen. Mungkin ada paling banyak 32 klausa $orderby.
queryType	QueryType	Nilai yang menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'full' jika kueri Anda menggunakan sintaks kueri Lucene.
scoringParameters	string[]	Daftar nilai parameter yang akan digunakan dalam fungsi penilaian (misalnya, referencePointParameter) menggunakan format name-values. Misalnya, jika profil penilaian mendefinisikan fungsi dengan parameter yang disebut 'mylocation', string parameter akan menjadi "mylocation--122.2,44.8" (tanpa tanda kutip).
scoringProfile	string	Nama profil penilaian untuk mengevaluasi skor kecocokan untuk dokumen yang cocok untuk mengurutkan hasil.
scoringStatistics	ScoringStatistics	Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk menggabungkan statistik penilaian secara global sebelum mencetak gol. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
search	string	Ekspresi kueri pencarian teks lengkap; Gunakan "*" atau hilangkan parameter ini agar cocok dengan semua dokumen.
searchFields	string	Daftar nama bidang yang dipisahkan koma untuk mencakupan pencarian teks lengkap. Saat menggunakan pencarian bidang (fieldName:searchExpression) dalam kueri Lucene penuh, nama bidang dari setiap ekspresi pencarian kolom lebih diutamakan daripada nama bidang apa pun yang tercantum dalam parameter ini.
searchMode	SearchMode	Nilai yang menentukan apakah salah satu atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
select	string	Daftar bidang yang dipisahkan koma untuk diambil. Jika tidak ditentukan, semua bidang yang ditandai sebagai dapat diambil dalam skema disertakan.
semanticConfiguration	string	Nama konfigurasi semantik yang akan digunakan saat memproses dokumen untuk kueri jenis semantik.
semanticErrorHandling	SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya (perilaku default / saat ini), atau untuk mengembalikan hasil parsial.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Memungkinkan pengguna untuk menetapkan batas atas pada jumlah waktu yang dibutuhkan pengayaan semantik untuk menyelesaikan pemrosesan sebelum permintaan gagal.
semanticQuery	string	Memungkinkan pengaturan kueri pencarian terpisah yang hanya akan digunakan untuk peringkat ulang semantik, keterangan semantik, dan jawaban semantik. Berguna untuk skenario di mana ada kebutuhan untuk menggunakan kueri yang berbeda antara fase pengambilan dasar dan peringkat, dan fase semantik L2.
sessionId	string	Nilai yang akan digunakan untuk membuat sesi lengket, yang dapat membantu mendapatkan hasil yang lebih konsisten. Selama sessionId yang sama digunakan, upaya upaya terbaik akan dilakukan untuk menargetkan set replika yang sama. Berhati-hatilah karena menggunakan kembali nilai sessionID yang sama berulang kali dapat mengganggu penyeimbangan beban permintaan di seluruh replika dan berdampak buruk pada performa layanan pencarian. Nilai yang digunakan sebagai sessionId tidak dapat dimulai dengan karakter '_'.
skip	integer (int32)	Jumlah hasil pencarian yang harus dilewati. Nilai ini tidak boleh lebih besar dari 100.000. Jika Anda perlu memindai dokumen secara berurutan, tetapi tidak dapat menggunakan lewati karena batasan ini, pertimbangkan untuk menggunakan orderby pada kunci yang diurutkan sepenuhnya dan filter dengan kueri rentang.
top	integer (int32)	Jumlah hasil pencarian yang akan diambil. Ini dapat digunakan bersama dengan $skip untuk menerapkan paging hasil pencarian sisi klien. Jika hasil terpotong karena paging sisi server, respons akan menyertakan token kelanjutan yang dapat digunakan untuk mengeluarkan permintaan Pencarian lain untuk halaman hasil berikutnya.
vectorFilterMode	VectorFilterMode	Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak. Defaultnya adalah 'preFilter' untuk indeks baru.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parameter kueri untuk kueri pencarian vektor dan hibrid.

Respons

Nama	Jenis	Deskripsi
200 OK	SearchDocumentsResult	Respons yang berisi dokumen yang cocok dengan kriteria pencarian.
Other Status Codes	SearchDocumentsResult	Respons yang berisi dokumen parsial yang cocok dengan kriteria pencarian.
Other Status Codes	ErrorResponse	Respons kesalahan.

Contoh

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Permintaan sampel

HTTP

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.search?api-version=2025-09-01


{
  "count": true,
  "facets": [
    "ownerId"
  ],
  "filter": "category eq 'purple' or category eq 'pink'",
  "highlight": "category",
  "highlightPostTag": "</em>",
  "highlightPreTag": "</em>",
  "minimumCoverage": 100,
  "queryType": "semantic",
  "scoringStatistics": "global",
  "sessionId": "mysessionid",
  "scoringParameters": [
    "categoryTag:desiredCategoryValue"
  ],
  "scoringProfile": "stringFieldBoost",
  "debug": "vector",
  "search": "purple",
  "searchFields": "id,name,description,category,ownerId",
  "searchMode": "any",
  "select": "id,name,description,category,ownerId",
  "skip": 0,
  "top": 10,
  "semanticConfiguration": "testconfig",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 5000,
  "semanticQuery": "find all purple",
  "answers": "extractive",
  "captions": "extractive",
  "vectorQueries": [
    {
      "vector": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9
      ],
      "kind": "vector",
      "k": 50,
      "fields": "vector22, vector1b",
      "exhaustive": true,
      "weight": 1
    }
  ],
  "vectorFilterMode": "preFilter"
}

Respon sampel

Kode status:

200

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Kode status:

206

{
  "@odata.count": 42,
  "@search.coverage": 100,
  "@search.facets": {
    "ownerId": [
      {
        "count": 26,
        "value": "sam"
      },
      {
        "count": 12,
        "value": "ryan"
      },
      {
        "count": 4,
        "value": "benny"
      }
    ]
  },
  "@search.answers": [],
  "value": [
    {
      "@search.score": 0.04419642686843872,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7178425788879395,
      "@search.rerankerBoostedScore": 1.7178425788879395,
      "@search.captions": [
        {
          "text": "test10 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.3862943649291992
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00011109876504633576,
                  "vectorSimilarity": 94.86833055544514
                },
                "vector1b": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                }
              }
            ]
          }
        }
      },
      "id": "10",
      "name": "test",
      "description": "test10 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.012820512987673283,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "empty-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.011627906933426857,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.7079174518585205,
      "@search.rerankerBoostedScore": 1.7079174518585205,
      "@search.captions": [
        {
          "text": "no vector.",
          "highlights": "</em>no vector.</em>"
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {}
            ]
          }
        }
      },
      "id": "no-vectors",
      "name": "test",
      "description": "no vector",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.0431547611951828,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6994102001190186,
      "@search.rerankerBoostedScore": 1.6994102001190186,
      "@search.captions": [
        {
          "text": "test4 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00017358097829855978,
                  "vectorSimilarity": 75.89466323761327
                },
                "vector1b": {
                  "searchScore": 0.0005099439295008779,
                  "vectorSimilarity": 44.27188622909418
                }
              }
            ]
          }
        }
      },
      "id": "4",
      "name": "test",
      "description": "test4 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04460374265909195,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6937386989593506,
      "@search.rerankerBoostedScore": 1.6937386989593506,
      "@search.captions": [
        {
          "text": "test2 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00020656888955272734,
                  "vectorSimilarity": 69.5701087211589
                },
                "vector1b": {
                  "searchScore": 0.0006939625018276274,
                  "vectorSimilarity": 37.947332584023194
                }
              }
            ]
          }
        }
      },
      "id": "2",
      "name": "test",
      "description": "test2 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.042533937841653824,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6923208236694336,
      "@search.rerankerBoostedScore": 1.6923208236694336,
      "@search.captions": [
        {
          "text": "test5 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00015997439913917333,
                  "vectorSimilarity": 79.0569427290381
                },
                "vector1b": {
                  "searchScore": 0.0004442470089998096,
                  "vectorSimilarity": 47.43416449302081
                }
              }
            ]
          }
        }
      },
      "id": "5",
      "name": "test",
      "description": "test5 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04651741310954094,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.691611886024475,
      "@search.rerankerBoostedScore": 1.691611886024475,
      "@search.captions": [
        {
          "text": "test7 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.9616584777832031
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00013715539535041898,
                  "vectorSimilarity": 85.38149735825786
                },
                "vector1b": {
                  "searchScore": 0.00034590106224641204,
                  "vectorSimilarity": 53.758721003860366
                }
              }
            ]
          }
        }
      },
      "id": "7",
      "name": "test",
      "description": "test7 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04703196510672569,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6781420707702637,
      "@search.rerankerBoostedScore": 1.6781420707702637,
      "@search.captions": [
        {
          "text": "test0 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.0779930353164673
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.0002499375259503722,
                  "vectorSimilarity": 63.24555189615253
                },
                "vector1b": {
                  "searchScore": 0.0009990009712055326,
                  "vectorSimilarity": 31.622777042048124
                }
              }
            ]
          }
        }
      },
      "id": "0",
      "name": "test",
      "description": "test0 hello",
      "category": "purple",
      "ownerId": "benny"
    },
    {
      "@search.score": 0.043300654739141464,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6653810739517212,
      "@search.rerankerBoostedScore": 1.6653810739517212,
      "@search.captions": [
        {
          "text": "test8 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 1.1507283449172974
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00012753476039506495,
                  "vectorSimilarity": 88.5437719937623
                },
                "vector1b": {
                  "searchScore": 0.0003085467324126512,
                  "vectorSimilarity": 56.92099902893652
                }
              }
            ]
          }
        }
      },
      "id": "8",
      "name": "test",
      "description": "test8 hello",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.score": 0.04082724079489708,
      "@search.highlights": {
        "category": [
          "</em>purple</em>"
        ]
      },
      "@search.rerankerScore": 1.6618363857269287,
      "@search.rerankerBoostedScore": 1.6618363857269287,
      "@search.captions": [
        {
          "text": "test11 hello.",
          "highlights": ""
        }
      ],
      "@search.documentDebugInfo": {
        "vectors": {
          "subscores": {
            "documentBoost": 1,
            "text": {
              "searchScore": 0.3250378668308258
            },
            "vectors": [
              {
                "vector22": {
                  "searchScore": 0.00010404744534753263,
                  "vectorSimilarity": 98.03060760075451
                },
                "vector1b": {
                  "searchScore": 0.00022670596081297845,
                  "vectorSimilarity": 66.40783109116562
                }
              }
            ]
          }
        }
      },
      "id": "11",
      "name": "test",
      "description": "test11 hello",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

SearchIndexSearchDocumentsSemanticPost

Permintaan sampel

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-09-01

{
  "count": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "queryType": "semantic",
  "search": "how do clouds form",
  "semanticConfiguration": "my-semantic-config",
  "answers": "extractive|count-3",
  "captions": "extractive|highlight-true",
  "semanticErrorHandling": "partial",
  "semanticMaxWaitInMilliseconds": 780
}

Respon sampel

Kode status:

200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}

Kode status:

206

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "@search.nextPageParameters": {
    "count": true,
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "queryType": "semantic",
    "search": "how do clouds form",
    "semanticConfiguration": "my-semantic-config",
    "answers": "extractive|count-3",
    "captions": "extractive|highlight-true",
    "semanticErrorHandling": "partial",
    "semanticMaxWaitInMilliseconds": 780,
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2024-07-01"
}

Definisi

Nama	Deskripsi
AnswerResult	Jawaban adalah bagian teks yang diekstraksi dari konten dokumen paling relevan yang cocok dengan kueri. Jawaban diekstraksi dari hasil pencarian teratas. Kandidat jawaban dinilai dan jawaban teratas dipilih.
CaptionResult	Keterangan adalah bagian yang paling representatif dari dokumen relatif terhadap kueri pencarian. Mereka sering digunakan sebagai ringkasan dokumen. Keterangan hanya dikembalikan untuk kueri jenis semantic.
DocumentDebugInfo	Berisi informasi penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
QueryAnswerType	Nilai yang menentukan apakah jawaban harus ditampilkan sebagai bagian dari respons penelusuran.
QueryCaptionType	Nilai yang menentukan apakah teks harus ditampilkan sebagai bagian dari respons penelusuran.
QueryDebugMode	Mengaktifkan alat debugging yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.
QueryResultDocumentSubscores	Perincian subskor antara komponen kueri teks dan vektor dari kueri pencarian untuk dokumen ini. Setiap kueri vektor ditampilkan sebagai objek terpisah dalam urutan yang sama dengan yang diterima.
QueryType	Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'full' jika kueri Anda menggunakan sintaks kueri Lucene.
RawVectorQuery	Parameter kueri yang akan digunakan untuk pencarian vektor saat nilai vektor mentah disediakan.
ScoringStatistics	Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk menggabungkan statistik penilaian secara global sebelum mencetak gol. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
SearchDocumentsResult	Respons yang berisi hasil pencarian dari indeks.
SearchMode	Menentukan apakah salah satu atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
SearchRequest	Parameter untuk pemfilteran, pengurutan, faset, paging, dan perilaku kueri pencarian lainnya.
SearchResult	Berisi dokumen yang ditemukan oleh kueri pencarian, ditambah metadata terkait.
SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya (perilaku default / saat ini), atau untuk mengembalikan hasil parsial.
SemanticErrorReason	Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.
SemanticSearchResultsType	Jenis respons parsial yang dikembalikan untuk permintaan peringkat semantik.
SingleVectorFieldResult	Hasil bidang vektor tunggal. Keduanya @search.score dan nilai kesamaan vektor dikembalikan. Kesamaan vektor terkait dengan @search.score persamaan.
TextResult	Skor BM25 atau Klasik untuk bagian teks kueri.
VectorFilterMode	Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak.
VectorizableTextQuery	Parameter kueri yang akan digunakan untuk pencarian vektor saat nilai teks yang perlu divektorkan disediakan.
VectorQueryKind	Jenis kueri vektor yang sedang dilakukan.
VectorsDebugInfo

AnswerResult

Objek

Jawaban adalah bagian teks yang diekstraksi dari konten dokumen paling relevan yang cocok dengan kueri. Jawaban diekstraksi dari hasil pencarian teratas. Kandidat jawaban dinilai dan jawaban teratas dipilih.

Nama	Jenis	Deskripsi
highlights	string	Bagian teks yang sama seperti di properti Teks dengan frasa teks yang disorot yang paling relevan dengan kueri.
key	string	Kunci dokumen yang diekstraksi jawabannya.
score	number (double)	Nilai skor mewakili seberapa relevan jawaban terhadap kueri relatif terhadap jawaban lain yang ditampilkan untuk kueri.
text	string	Bagian teks yang diekstrak dari isi dokumen sebagai jawabannya.

CaptionResult

Objek

Keterangan adalah bagian yang paling representatif dari dokumen relatif terhadap kueri pencarian. Mereka sering digunakan sebagai ringkasan dokumen. Keterangan hanya dikembalikan untuk kueri jenis semantic.

Nama	Jenis	Deskripsi
highlights	string	Bagian teks yang sama seperti di properti Teks dengan frasa yang disorot yang paling relevan dengan kueri.
text	string	Bagian teks representatif yang diekstrak dari dokumen yang paling relevan dengan kueri pencarian.

DocumentDebugInfo

Objek

Berisi informasi penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.

Nama	Jenis	Deskripsi
vectors	VectorsDebugInfo	Berisi informasi penelusuran kesalahan khusus untuk pencarian vektor dan hibrida.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

QueryAnswerType

Enumeration

Nilai yang menentukan apakah jawaban harus ditampilkan sebagai bagian dari respons penelusuran.

Nilai	Deskripsi
none	Jangan mengembalikan jawaban untuk kueri.
extractive	Mengekstrak kandidat jawaban dari konten dokumen yang dikembalikan sebagai tanggapan atas pertanyaan yang dinyatakan sebagai pertanyaan dalam bahasa alami.

QueryCaptionType

Enumeration

Nilai yang menentukan apakah teks harus ditampilkan sebagai bagian dari respons penelusuran.

Nilai	Deskripsi
none	Jangan mengembalikan teks untuk kueri.
extractive	Mengekstrak teks dari dokumen yang cocok yang berisi bagian yang relevan dengan kueri pencarian.

QueryDebugMode

Enumeration

Mengaktifkan alat debugging yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.

Nilai	Deskripsi
disabled	Tidak ada informasi debugging kueri yang akan dikembalikan.
vector	Memungkinkan pengguna untuk menjelajahi lebih lanjut hasil kueri hibrida dan vektor mereka.

QueryResultDocumentSubscores

Objek

Perincian subskor antara komponen kueri teks dan vektor dari kueri pencarian untuk dokumen ini. Setiap kueri vektor ditampilkan sebagai objek terpisah dalam urutan yang sama dengan yang diterima.

Nama	Jenis	Deskripsi
documentBoost	number (double)	Skor BM25 atau Klasik untuk bagian teks kueri.
text	TextResult	Skor BM25 atau Klasik untuk bagian teks kueri.
vectors	<string,  SingleVectorFieldResult>	Kesamaan @search.score dan nilai vektor untuk setiap kueri vektor.

QueryType

Enumeration

Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'full' jika kueri Anda menggunakan sintaks kueri Lucene.

Nilai	Deskripsi
simple	Menggunakan sintaks kueri sederhana untuk pencarian. Teks pencarian ditafsirkan menggunakan bahasa kueri sederhana yang memungkinkan simbol seperti +, * dan "". Kueri dievaluasi di semua bidang yang dapat dicari secara default, kecuali parameter searchFields ditentukan.
full	Menggunakan sintaks kueri Lucene lengkap untuk pencarian. Teks pencarian ditafsirkan menggunakan bahasa kueri Lucene yang memungkinkan pencarian khusus bidang dan berbobot, serta fitur lanjutan lainnya.
semantic	Paling cocok untuk kueri yang diekspresikan dalam bahasa alami dibandingkan dengan kata kunci. Meningkatkan presisi hasil pencarian dengan memberi peringkat ulang hasil pencarian teratas menggunakan model peringkat yang dilatih pada korpus Web.

RawVectorQuery

Objek

Parameter kueri yang akan digunakan untuk pencarian vektor saat nilai vektor mentah disediakan.

Nama	Jenis	Deskripsi
exhaustive	boolean	Jika true, memicu pencarian k-tetangga terdekat yang lengkap di semua vektor dalam indeks vektor. Berguna untuk skenario di mana kecocokan persis sangat penting, seperti menentukan nilai kebenaran dasar.
fields	string	Bidang Vektor jenis Collection(Edm.Single) untuk disertakan dalam vektor yang dicari.
k	integer (int32)	Jumlah tetangga terdekat yang kembali sebagai hit teratas.
kind	string: vector	Jenis kueri vektor yang sedang dilakukan.
oversampling	number (double)	Faktor oversampling. Nilai minimum adalah 1. Ini mengganti parameter 'defaultOversampling' yang dikonfigurasi dalam definisi indeks. Ini hanya dapat diatur ketika 'rerankWithOriginalVectors' benar. Parameter ini hanya diizinkan ketika metode kompresi digunakan pada bidang vektor yang mendasarinya.
vector	number[] (float)	Representasi vektor dari kueri pencarian.
weight	number (float)	Bobot relatif kueri vektor jika dibandingkan dengan kueri vektor lain dan/atau kueri teks dalam permintaan pencarian yang sama. Nilai ini digunakan saat menggabungkan hasil beberapa daftar peringkat yang dihasilkan oleh kueri vektor yang berbeda dan/atau hasil yang diambil melalui kueri teks. Semakin tinggi bobotnya, semakin tinggi dokumen yang cocok dengan kueri tersebut akan berada di peringkat akhir. Defaultnya adalah 1.0 dan nilainya harus berupa bilangan positif yang lebih besar dari nol.

ScoringStatistics

Enumeration

Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk menggabungkan statistik penilaian secara global sebelum mencetak gol. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.

Nilai	Deskripsi
local	Statistik penilaian akan dihitung secara lokal untuk latensi yang lebih rendah.
global	Statistik penilaian akan dihitung secara global untuk penilaian yang lebih konsisten.

SearchDocumentsResult

Objek

Respons yang berisi hasil pencarian dari indeks.

Nama	Jenis	Deskripsi
@odata.count	integer (int64)	Jumlah total hasil yang ditemukan oleh operasi pencarian, atau null jika hitungan tidak diminta. Jika ada, hitungannya mungkin lebih besar dari jumlah hasil dalam respons ini. Hal ini dapat terjadi jika Anda menggunakan parameter $top atau $skip, atau jika kueri tidak dapat mengembalikan semua dokumen yang diminta dalam satu respons.
@odata.nextLink	string	URL kelanjutan ditampilkan saat kueri tidak dapat mengembalikan semua hasil yang diminta dalam satu respons. Anda dapat menggunakan URL ini untuk merumuskan permintaan GET atau POST Search lainnya untuk mendapatkan bagian berikutnya dari respons penelusuran. Pastikan untuk menggunakan kata kerja yang sama (GET atau POST) dengan permintaan yang menghasilkan respons ini.
@search.answers	AnswerResult[]	Hasil kueri jawaban untuk operasi pencarian; null jika parameter kueri jawaban tidak ditentukan atau diatur ke 'none'.
@search.coverage	number (double)	Nilai yang menunjukkan persentase indeks yang disertakan dalam kueri, atau null jika minimumCoverage tidak ditentukan dalam permintaan.
@search.facets	object	Hasil kueri aspek untuk operasi pencarian, diatur sebagai kumpulan bucket untuk setiap bidang segi; null jika kueri tidak menyertakan ekspresi aspek apa pun.
@search.nextPageParameters	SearchRequest	Payload JSON kelanjutan dikembalikan ketika kueri tidak dapat mengembalikan semua hasil yang diminta dalam satu respons. Anda dapat menggunakan JSON ini bersama dengan @odata.nextLink untuk merumuskan permintaan POST Search lain untuk mendapatkan bagian berikutnya dari respons pencarian.
@search.semanticPartialResponseReason	SemanticErrorReason	Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.
@search.semanticPartialResponseType	SemanticSearchResultsType	Jenis respons parsial yang dikembalikan untuk permintaan peringkat semantik.
value	SearchResult[]	Urutan hasil yang ditampilkan oleh kueri.

SearchMode

Enumeration

Menentukan apakah salah satu atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.

Nilai	Deskripsi
any	Salah satu istilah pencarian harus cocok untuk menghitung dokumen sebagai kecocokan.
all	Semua istilah pencarian harus cocok untuk menghitung dokumen sebagai kecocokan.

SearchRequest

Objek

Parameter untuk pemfilteran, pengurutan, faset, paging, dan perilaku kueri pencarian lainnya.

Nama	Jenis	Deskripsi
answers	QueryAnswerType	Nilai yang menentukan apakah jawaban harus ditampilkan sebagai bagian dari respons penelusuran.
captions	QueryCaptionType	Nilai yang menentukan apakah teks harus ditampilkan sebagai bagian dari respons penelusuran.
count	boolean	Nilai yang menentukan apakah akan mengambil jumlah total hasil. Secara default adalah false. Menetapkan nilai ini ke true mungkin berdampak pada performa. Perhatikan bahwa hitungan yang dikembalikan adalah perkiraan.
debug	QueryDebugMode	Mengaktifkan alat debugging yang dapat digunakan untuk menjelajahi hasil peringkat ulang Anda lebih lanjut.
facets	string[]	Daftar ekspresi aspek yang akan diterapkan ke kueri pencarian. Setiap ekspresi aspek berisi nama bidang, secara opsional diikuti oleh daftar pasangan nama:nilai yang dipisahkan koma.
filter	string	OData $filter ekspresi untuk diterapkan ke kueri pencarian.
highlight	string	Daftar nama bidang yang dipisahkan koma untuk digunakan untuk sorotan klik. Hanya bidang yang dapat dicari yang dapat digunakan untuk penyorotan klik.
highlightPostTag	string	Tag string yang ditambahkan ke sorotan klik. Harus diatur dengan highlightPreTag. Defaultnya adalah </em>.
highlightPreTag	string	Tag string yang dilanjutkan untuk menekan sorotan. Harus diatur dengan highlightPostTag. Defaultnya adalah <em>.
minimumCoverage	number (double)	Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri pencarian agar kueri dilaporkan sebagai keberhasilan. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan dengan hanya satu replika. Nilai defaultnya adalah 100.
orderby	string	Daftar ekspresi OData $orderby yang dipisahkan koma untuk mengurutkan hasilnya. Setiap ekspresi dapat berupa nama bidang atau panggilan ke fungsi geo.distance() atau search.score(). Setiap ekspresi dapat diikuti oleh asc untuk menunjukkan naik, atau desc untuk menunjukkan turun. Defaultnya adalah urutan menaik. Ikatan akan diputuskan oleh skor pertandingan dokumen. Jika tidak ada $orderby yang ditentukan, urutan pengurutan default adalah menurun berdasarkan skor kecocokan dokumen. Mungkin ada paling banyak 32 klausa $orderby.
queryType	QueryType	Nilai yang menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'full' jika kueri Anda menggunakan sintaks kueri Lucene.
scoringParameters	string[]	Daftar nilai parameter yang akan digunakan dalam fungsi penilaian (misalnya, referencePointParameter) menggunakan format name-values. Misalnya, jika profil penilaian mendefinisikan fungsi dengan parameter yang disebut 'mylocation', string parameter akan menjadi "mylocation--122.2,44.8" (tanpa tanda kutip).
scoringProfile	string	Nama profil penilaian untuk mengevaluasi skor kecocokan untuk dokumen yang cocok untuk mengurutkan hasil.
scoringStatistics	ScoringStatistics	Nilai yang menentukan apakah kita ingin menghitung statistik penilaian (seperti frekuensi dokumen) secara global untuk penilaian yang lebih konsisten, atau secara lokal, untuk latensi yang lebih rendah. Defaultnya adalah 'lokal'. Gunakan 'global' untuk menggabungkan statistik penilaian secara global sebelum mencetak gol. Menggunakan statistik penilaian global dapat meningkatkan latensi kueri pencarian.
search	string	Ekspresi kueri pencarian teks lengkap; Gunakan "*" atau hilangkan parameter ini agar cocok dengan semua dokumen.
searchFields	string	Daftar nama bidang yang dipisahkan koma untuk mencakupan pencarian teks lengkap. Saat menggunakan pencarian bidang (fieldName:searchExpression) dalam kueri Lucene penuh, nama bidang dari setiap ekspresi pencarian kolom lebih diutamakan daripada nama bidang apa pun yang tercantum dalam parameter ini.
searchMode	SearchMode	Nilai yang menentukan apakah salah satu atau semua istilah pencarian harus dicocokkan untuk menghitung dokumen sebagai kecocokan.
select	string	Daftar bidang yang dipisahkan koma untuk diambil. Jika tidak ditentukan, semua bidang yang ditandai sebagai dapat diambil dalam skema disertakan.
semanticConfiguration	string	Nama konfigurasi semantik yang akan digunakan saat memproses dokumen untuk kueri jenis semantik.
semanticErrorHandling	SemanticErrorMode	Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya (perilaku default / saat ini), atau untuk mengembalikan hasil parsial.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Memungkinkan pengguna untuk menetapkan batas atas pada jumlah waktu yang dibutuhkan pengayaan semantik untuk menyelesaikan pemrosesan sebelum permintaan gagal.
semanticQuery	string	Memungkinkan pengaturan kueri pencarian terpisah yang hanya akan digunakan untuk peringkat ulang semantik, keterangan semantik, dan jawaban semantik. Berguna untuk skenario di mana ada kebutuhan untuk menggunakan kueri yang berbeda antara fase pengambilan dasar dan peringkat, dan fase semantik L2.
sessionId	string	Nilai yang akan digunakan untuk membuat sesi lengket, yang dapat membantu mendapatkan hasil yang lebih konsisten. Selama sessionId yang sama digunakan, upaya upaya terbaik akan dilakukan untuk menargetkan set replika yang sama. Berhati-hatilah karena menggunakan kembali nilai sessionID yang sama berulang kali dapat mengganggu penyeimbangan beban permintaan di seluruh replika dan berdampak buruk pada performa layanan pencarian. Nilai yang digunakan sebagai sessionId tidak dapat dimulai dengan karakter '_'.
skip	integer (int32)	Jumlah hasil pencarian yang harus dilewati. Nilai ini tidak boleh lebih besar dari 100.000. Jika Anda perlu memindai dokumen secara berurutan, tetapi tidak dapat menggunakan lewati karena batasan ini, pertimbangkan untuk menggunakan orderby pada kunci yang diurutkan sepenuhnya dan filter dengan kueri rentang.
top	integer (int32)	Jumlah hasil pencarian yang akan diambil. Ini dapat digunakan bersama dengan $skip untuk menerapkan paging hasil pencarian sisi klien. Jika hasil terpotong karena paging sisi server, respons akan menyertakan token kelanjutan yang dapat digunakan untuk mengeluarkan permintaan Pencarian lain untuk halaman hasil berikutnya.
vectorFilterMode	VectorFilterMode	Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak. Defaultnya adalah 'preFilter' untuk indeks baru.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	Parameter kueri untuk kueri pencarian vektor dan hibrid.

SearchResult

Objek

Berisi dokumen yang ditemukan oleh kueri pencarian, ditambah metadata terkait.

Nama	Jenis	Deskripsi
@search.captions	CaptionResult[]	Keterangan adalah bagian yang paling representatif dari dokumen relatif terhadap kueri pencarian. Mereka sering digunakan sebagai ringkasan dokumen. Keterangan hanya dikembalikan untuk kueri jenis 'semantik'.
@search.documentDebugInfo	DocumentDebugInfo	Berisi informasi penelusuran kesalahan yang dapat digunakan untuk menjelajahi hasil pencarian Anda lebih lanjut.
@search.highlights	object	Fragmen teks dari dokumen yang menunjukkan istilah pencarian yang cocok, diatur berdasarkan setiap bidang yang berlaku; null jika penyorotan hit tidak diaktifkan untuk kueri.
@search.rerankerBoostedScore	number (double)	Skor relevansi dihitung dengan meningkatkan Skor Reranker. Hasil pencarian diurutkan berdasarkan RerankerScore/RerankerBoostedScore berdasarkan useScoringProfileBoostedRanking di Semantic Config. RerankerBoostedScore hanya dikembalikan untuk kueri jenis 'semantik'
@search.rerankerScore	number (double)	Skor relevansi yang dihitung oleh peringkat semantik untuk hasil pencarian teratas. Hasil pencarian diurutkan berdasarkan RerankerScore terlebih dahulu dan kemudian berdasarkan Skor. RerankerScore hanya dikembalikan untuk kueri jenis 'semantik'.
@search.score	number (double)	Skor relevansi dokumen dibandingkan dengan dokumen lain yang ditampilkan oleh kueri.

SemanticErrorMode

Enumeration

Memungkinkan pengguna untuk memilih apakah panggilan semantik harus gagal sepenuhnya (perilaku default / saat ini), atau untuk mengembalikan hasil parsial.

Nilai	Deskripsi
partial	Jika pemrosesan semantik gagal, hasil parsial masih kembali. Definisi hasil parsial tergantung pada langkah semantik apa yang gagal dan apa alasan kegagalan.
fail	Jika ada pengecualian selama langkah pemrosesan semantik, kueri akan gagal dan mengembalikan kode HTTP yang sesuai tergantung pada kesalahan.

SemanticErrorReason

Enumeration

Alasan bahwa respons parsial dikembalikan untuk permintaan peringkat semantik.

Nilai	Deskripsi
maxWaitExceeded	Jika semanticMaxWaitInMilliseconds diatur dan durasi pemrosesan semantik melebihi nilai tersebut. Hanya hasil dasar yang dikembalikan.
capacityOverloaded	Permintaan itu dibatasi. Hanya hasil dasar yang dikembalikan.
transient	Setidaknya satu langkah proses semantik gagal.

SemanticSearchResultsType

Enumeration

Jenis respons parsial yang dikembalikan untuk permintaan peringkat semantik.

Nilai	Deskripsi
baseResults	Hasil tanpa pengayaan semantik atau peringkat ulang.
rerankedResults	Hasil telah diberi peringkat ulang dengan model reranker dan akan menyertakan keterangan semantik. Mereka tidak akan menyertakan jawaban, sorotan jawaban, atau sorotan keterangan.

SingleVectorFieldResult

Objek

Hasil bidang vektor tunggal. Keduanya @search.score dan nilai kesamaan vektor dikembalikan. Kesamaan vektor terkait dengan @search.score persamaan.

Nama	Jenis	Deskripsi
searchScore	number (double)	Nilai @search.score yang dihitung dari skor kesamaan vektor. Ini adalah skor yang terlihat dalam kueri vektor tunggal bidang tunggal murni.
vectorSimilarity	number (double)	Skor kesamaan vektor untuk dokumen ini. Perhatikan ini adalah definisi kanonik dari metrik kesamaan, bukan versi 'jarak'. Misalnya, kesamaan kosinus alih-alih jarak kosinus.

TextResult

Objek

Skor BM25 atau Klasik untuk bagian teks kueri.

Nama	Jenis	Deskripsi
searchScore	number (double)	Skor BM25 atau Klasik untuk bagian teks kueri.

VectorFilterMode

Enumeration

Menentukan apakah filter diterapkan sebelum atau sesudah pencarian vektor dilakukan atau tidak.

Nilai	Deskripsi
postFilter	Filter akan diterapkan setelah kumpulan kandidat hasil vektor dikembalikan. Bergantung pada selektivitas filter, ini dapat menghasilkan hasil yang lebih sedikit daripada yang diminta oleh parameter 'k'.
preFilter	Filter akan diterapkan sebelum kueri pencarian.

VectorizableTextQuery

Objek

Parameter kueri yang akan digunakan untuk pencarian vektor saat nilai teks yang perlu divektorkan disediakan.

Nama	Jenis	Deskripsi
exhaustive	boolean	Jika true, memicu pencarian k-tetangga terdekat yang lengkap di semua vektor dalam indeks vektor. Berguna untuk skenario di mana kecocokan persis sangat penting, seperti menentukan nilai kebenaran dasar.
fields	string	Bidang Vektor jenis Collection(Edm.Single) untuk disertakan dalam vektor yang dicari.
k	integer (int32)	Jumlah tetangga terdekat yang kembali sebagai hit teratas.
kind	string: text	Jenis kueri vektor yang sedang dilakukan.
oversampling	number (double)	Faktor oversampling. Nilai minimum adalah 1. Ini mengganti parameter 'defaultOversampling' yang dikonfigurasi dalam definisi indeks. Ini hanya dapat diatur ketika 'rerankWithOriginalVectors' benar. Parameter ini hanya diizinkan ketika metode kompresi digunakan pada bidang vektor yang mendasarinya.
text	string	Teks yang akan divektorkan untuk melakukan kueri pencarian vektor.
weight	number (float)	Bobot relatif kueri vektor jika dibandingkan dengan kueri vektor lain dan/atau kueri teks dalam permintaan pencarian yang sama. Nilai ini digunakan saat menggabungkan hasil beberapa daftar peringkat yang dihasilkan oleh kueri vektor yang berbeda dan/atau hasil yang diambil melalui kueri teks. Semakin tinggi bobotnya, semakin tinggi dokumen yang cocok dengan kueri tersebut akan berada di peringkat akhir. Defaultnya adalah 1.0 dan nilainya harus berupa bilangan positif yang lebih besar dari nol.

VectorQueryKind

Enumeration

Jenis kueri vektor yang sedang dilakukan.

Nilai	Deskripsi
vector	Kueri vektor di mana nilai vektor mentah disediakan.
text	Kueri vektor di mana nilai teks yang perlu divektorkan disediakan.

VectorsDebugInfo

Objek

Nama	Jenis	Deskripsi
subscores	QueryResultDocumentSubscores	Perincian subskor dokumen sebelum metode fusi/kombinasi set hasil yang dipilih seperti RRF.