Documents - Graph
對具有邊列表圖形設定檔的索引執行圖形查詢。
POST {endpoint}/indexes('{indexName}')/docs/search.graph?api-version=2026-11-01-preview
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
搜尋服務的端點 URL。 |
|
index
|
path | True |
string |
索引的名稱。 |
|
api-version
|
query | True |
string minLength: 1 |
用於此作業的 API 版本。 |
要求標頭
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
要求不透明、全域唯一、用戶端產生的字串標識碼。 |
|
| Accept |
Accept 標頭。 |
||
| x-ms-query-source-authorization |
string (password) |
識別正在執行查詢的使用者的權杖。 此權杖可用來對文件強制執行安全性限制。 |
|
| x-ms-enable-elevated-read |
boolean |
啟用提高許可權讀取的值,可略過查詢作業的文件層級許可權檢查。 |
要求本文
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| gql | True |
string minLength: 1 |
要綁定並執行的非空 GQL 查詢。 |
| executionMode |
預設執行查詢。 planOnly 在不執行後端查詢的情況下建立計畫,且至少需要一個解釋階段。 |
||
| explain |
應納入回應的診斷計畫階段。 計畫表示是診斷資訊,而非可執行的客戶合約。 |
||
| filter |
string |
在整個圖形執行過程中,對圖形索引欄位施加 OData 濾鏡。 |
|
| includeDiagnostics |
boolean |
是否包含資訊診斷。 無論此設定為何,都會回傳錯誤與警告。 |
|
| includeStatistics |
boolean |
是否包含圖形執行統計資料。 預設設置為 true。 |
|
| provenance |
控制有界斷言證據及可選的來源-文件水合功能。 |
||
| search |
string |
用於限制圖形後端請求的全文搜尋文字。 |
|
| vectorQueries | VectorQuery[]: |
用於限制圖形後端搜尋的向量查詢。 |
回覆
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
要求已成功。 |
|
| Other Status Codes |
未預期的錯誤回應。 標題 x-ms-error-code: string |
安全性
api-key
類型:
apiKey
位於:
header
OAuth2Auth
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
範圍
| 名稱 | Description |
|---|---|
| https://search.azure.com/.default |
範例
SearchIndexGraphDocuments
範例要求
POST https://typespecpreviewexampleservice.search.windows.net/indexes('people-graph')/docs/search.graph?api-version=2026-11-01-preview
{
"gql": "MATCH (p:Person)-[r:worksFor]->(o:Organization) WHERE p.id = 'person:ada' RETURN o.name AS organization",
"filter": "graph_name eq 'contoso-people'",
"includeStatistics": false,
"provenance": {
"kind": "ids",
"maxEvidencePerRow": 5
}
}
範例回覆
{
"@odata.count": 1,
"value": [
{
"@search.graphProvenance": {
"kind": "ids",
"evidenceCount": {
"value": 1,
"relation": "exact"
},
"evidence": [
{
"edgeId": "assertion-1",
"chunkId": "people-chunk-1",
"parentId": "people-document-1"
}
]
},
"organization": "Contoso"
}
]
}
定義
| 名稱 | Description |
|---|---|
| Accept |
Accept 標頭。 |
|
Balanced |
將純向量相似性與多樣性感知檢索結合。 建議預設選擇在多樣性與相關性之間取得平衡。 |
|
Diverse |
採用主題圖譜多樣化檢索。 |
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細資料。 |
|
Graph |
圖形規劃或執行診斷工具。 |
|
Graph |
產生圖形查詢診斷的階段。 |
|
Graph |
圖查詢診斷的重要性。 |
|
Graph |
一個失敗的圖形請求,包含標準搜尋錯誤資訊及可選的圖形診斷。 |
|
Graph |
來源斷言識別碼及置信度值保留為圖表證據。 |
|
Graph |
記錄在支持性斷言上的信心值。 |
|
Graph |
一個證據計數,其關係描述了蒐集是否完整。 |
|
Graph |
證據計數的完整性。 |
|
Graph |
圖形查詢是執行還是僅規劃。 |
|
Graph |
檢視圖形查詢時可用的診斷階段。 |
|
Graph |
從由 graphProfile.provenanceIndexName 配置的來源索引中選取欄位。 |
|
Graph |
那種以圖列回傳的斷言證據。 |
|
Graph |
圖形查詢的有界來源收集選項。 |
|
Graph |
請求欄位以查詢由索引 graphProfile 對應的邏輯圖形。 |
|
Graph |
圖形查詢的投影列數與可選的執行資訊。 |
|
Graph |
一個動態圖投影列,可選填有界斷言證據。 |
|
Graph |
支持一列投影圖的斷言證據。 |
|
Graph |
圖形查詢的執行統計資料;計數器描述的是已執行的工作,而非結果列數。 |
|
None |
使用一般向量搜尋,不使用主題圖多樣化檢索。 |
|
Query |
只有在查詢類型為 |
|
Search |
向量查詢的結果會根據 ' 進行篩選 |
|
Vectorizable |
提供需要向量化之影像的基底 64 編碼二進位檔時,要用於向量搜尋的查詢參數。 |
|
Vectorizable |
當提供代表需要向量化之影像值的 URL 時,要用於向量搜尋的查詢參數。 |
|
Vectorizable |
提供需要向量化的文字值時,要用於向量搜尋的查詢參數。 |
|
Vectorized |
提供原始向量值時,用於向量搜尋的查詢參數。 |
|
Vector |
正在執行的向量查詢類型。 |
|
Vector |
該使用的主題圖向量搜尋類型。 |
|
Vector |
系統會根據向量相似度計量來篩選向量查詢的結果。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。 |
|
Vector |
那種用來篩選向量查詢的門檻。 |
Accept
Accept 標頭。
| 值 | Description |
|---|---|
| application/json;odata.metadata=none |
BalancedVectorQueryTopicGraph
將純向量相似性與多樣性感知檢索結合。 建議預設選擇在多樣性與相關性之間取得平衡。
| 名稱 | 類型 | Description |
|---|---|---|
| kind |
string:
balanced |
該使用的主題圖向量搜尋類型。 |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
在主題圖抽樣前,需檢索的最小向量候選數量。 預設值為 1,000。 |
DiverseVectorQueryTopicGraph
採用主題圖譜多樣化檢索。
| 名稱 | 類型 | Description |
|---|---|---|
| diversityFactor |
number (float) minimum: 0maximum: 1 |
主題圖多樣性檢索所使用的多樣性因子。 若省略,則會使用主題圖表設定檔中預設設定的設定。 |
| kind |
string:
diverse |
該使用的主題圖向量搜尋類型。 |
| minDiversityPoolSize |
integer (int32) minimum: 250maximum: 10000 |
在主題圖抽樣前,需檢索的最小向量候選數量。 預設值為 1,000。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
其他資訊。 |
|
| type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細資料。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤的其他資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳情 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
GraphQueryDiagnostic
圖形規劃或執行診斷工具。
| 名稱 | 類型 | Description |
|---|---|---|
| code |
string |
穩定的機器可讀診斷識別碼。 |
| message |
string |
人手可讀的說明;應用程式應使用程式碼而非解析此文字。 |
| phase |
產生診斷結果的階段。 |
|
| severity |
診斷的重要性。 |
|
| span |
string |
與診斷相關聯的可選來源範圍描述。 |
| suggestions |
string[] |
建議的更正或替代方案。 |
GraphQueryDiagnosticPhase
產生圖形查詢診斷的階段。
| 值 | Description |
|---|---|
| parse |
查詢語法與解析。 |
| bind |
變數、參數、函數及語意綁定。 |
| validation |
請求選項驗證。 |
| planning |
查詢規劃,包括不支援的查詢形狀與查詢寬度限制。 |
| execution |
執行時評估、執行限制警告及執行摘要。 |
GraphQueryDiagnosticSeverity
圖查詢診斷的重要性。
| 值 | Description |
|---|---|
| error |
查詢被拒絕或無法成功評估。 |
| warning |
執行會回傳帶有限制的結果,例如執行或來源限制。 |
| info |
資訊性診斷,例如可選的執行摘要。 |
GraphQueryError
一個失敗的圖形請求,包含標準搜尋錯誤資訊及可選的圖形診斷。
| 名稱 | 類型 | Description |
|---|---|---|
| @odata.count |
integer (int64) |
此回應中投影的資料列數,而非無界圖族群的大小。 |
| @search.graphDiagnostics |
結構化錯誤、警告及請求的資訊診斷。 |
|
| @search.graphExplain |
Graph |
請求的診斷階段。 缺席階段則被省略。 |
| @search.graphProvenanceDocuments |
object |
以文件 ID 為關鍵的水合來源文件,並跨結果列共享。 |
| @search.graphStats |
執行統計資料,在需求且可用時提供。 |
|
| error |
標準搜尋錯誤資訊。 圖查詢拒絕使用 InvalidRequestParameter,並在圖診斷中保留其特定代碼。 |
|
| value |
查詢投影列。 planOnly 會回傳一個空集合。 |
GraphQueryEvidence
來源斷言識別碼及置信度值保留為圖表證據。
| 名稱 | 類型 | Description |
|---|---|---|
| chunkId |
string |
用於來源文件查詢的來源區塊識別碼。 |
| confidence |
與斷言及其組件相關聯的信心值。 |
|
| edgeId |
string |
圖索引中的斷言文件識別碼。 |
| parentId |
string |
父來源文件識別碼。 |
GraphQueryEvidenceConfidence
記錄在支持性斷言上的信心值。
| 名稱 | 類型 | Description |
|---|---|---|
| edge |
number (double) |
對整段關係的信心。 |
| object |
number (double) |
對物件的信心。 |
| predicate |
number (double) |
對謂詞對齊的信心。 |
| subject |
number (double) |
對主題的信心。 |
GraphQueryEvidenceCount
一個證據計數,其關係描述了蒐集是否完整。
| 名稱 | 類型 | Description |
|---|---|---|
| relation |
數值是精確計數還是下界。 |
|
| value |
integer (int32) |
觀察到的佐證條目數量。 |
GraphQueryEvidenceCountRelation
證據計數的完整性。
| 值 | Description |
|---|---|
| exact |
所有支持證據都已清點。 |
| lowerBound |
至少有這麼多支持條目存在;收藏有界。 |
GraphQueryExecutionMode
圖形查詢是執行還是僅規劃。
| 值 | Description |
|---|---|
| execute |
建立並執行圖表計畫。 |
| planOnly |
建立圖表計畫,無需執行後端搜尋。 |
GraphQueryExplainStage
檢視圖形查詢時可用的診斷階段。
| 值 | Description |
|---|---|
| syntax |
解析後的查詢語法。 |
| semanticIr |
綁定語意中間表徵。 |
| logicalPlan |
先規劃,再優化。 |
| optimizedLogicalPlan |
優化後再規劃合理。 |
| physicalPlan |
實體執行計畫。 |
| requestAttributions |
將後端請求歸因於執行計畫節點。 |
| full |
所有可用的診斷階段。 |
GraphQueryProvenanceHydrateDocumentsParameters
從由 graphProfile.provenanceIndexName 配置的來源索引中選取欄位。
| 名稱 | 類型 | Description |
|---|---|---|
| select |
string |
要回傳的逗號分隔來源文件欄位;省略會選取服務預設可檢索的欄位。 |
GraphQueryProvenanceKind
那種以圖列回傳的斷言證據。
| 值 | Description |
|---|---|
| ids |
在沒有原始文件的情況下,回傳證據識別碼。 |
| hydrate |
從設定檔案設定的來源索引中回傳證據識別碼及所選文件。 |
GraphQueryProvenanceParameters
圖形查詢的有界來源收集選項。
| 名稱 | 類型 | Description |
|---|---|---|
| hydrateDocuments |
來源文件選擇選項。 當善良需要水分時,這是必備的。 |
|
| kind |
是否要回傳證據識別碼,或是將來源文件與其資料整合。 |
|
| maxEvidencePerRow |
integer (int32) minimum: 1 |
每結果列收集的最大證據條目數。 當有界時,回應會顯示證據計數是精確還是下界。 |
GraphQueryRequest
請求欄位以查詢由索引 graphProfile 對應的邏輯圖形。
| 名稱 | 類型 | 預設值 | Description |
|---|---|---|---|
| executionMode | execute |
預設執行查詢。 planOnly 在不執行後端查詢的情況下建立計畫,且至少需要一個解釋階段。 |
|
| explain |
應納入回應的診斷計畫階段。 計畫表示是診斷資訊,而非可執行的客戶合約。 |
||
| filter |
string |
在整個圖形執行過程中,對圖形索引欄位施加 OData 濾鏡。 |
|
| gql |
string minLength: 1 |
要綁定並執行的非空 GQL 查詢。 |
|
| includeDiagnostics |
boolean |
False |
是否包含資訊診斷。 無論此設定為何,都會回傳錯誤與警告。 |
| includeStatistics |
boolean |
True |
是否包含圖形執行統計資料。 預設設置為 true。 |
| provenance |
控制有界斷言證據及可選的來源-文件水合功能。 |
||
| search |
string |
用於限制圖形後端請求的全文搜尋文字。 |
|
| vectorQueries | VectorQuery[]: |
用於限制圖形後端搜尋的向量查詢。 |
GraphQueryResult
圖形查詢的投影列數與可選的執行資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| @odata.count |
integer (int64) |
此回應中投影的資料列數,而非無界圖族群的大小。 |
| @search.graphDiagnostics |
結構化錯誤、警告及請求的資訊診斷。 |
|
| @search.graphExplain |
Graph |
請求的診斷階段。 缺席階段則被省略。 |
| @search.graphProvenanceDocuments |
object |
以文件 ID 為關鍵的水合來源文件,並跨結果列共享。 |
| @search.graphStats |
執行統計資料,在需求且可用時提供。 |
|
| value |
查詢投影列。 planOnly 會回傳一個空集合。 |
GraphQueryRow
一個動態圖投影列,可選填有界斷言證據。
| 名稱 | 類型 | Description |
|---|---|---|
| @search.graphProvenance |
有證據支持這場預期的爭論。 |
GraphQueryRowProvenance
支持一列投影圖的斷言證據。
| 名稱 | 類型 | Description |
|---|---|---|
| evidence |
此結果列的有界證據項目。 |
|
| evidenceCount |
支持性主張的數量以及該計數的完整性關係。 |
|
| kind |
查詢是否要求提供證據 ID 或來源水合。 |
GraphQueryStatistics
圖形查詢的執行統計資料;計數器描述的是已執行的工作,而非結果列數。
| 名稱 | 類型 | Description |
|---|---|---|
| documentsFetched |
integer (int32) |
執行時擷取的後端斷言文件。 |
| executionMode |
請求是否已執行或僅產生計畫。 |
|
| isEstimated |
boolean |
執行是否回報預估結果。 |
| planningMs |
integer (int64) |
產生查詢計畫所花費的時間,以毫秒為單位。 |
| queryCount |
integer (int32) |
由圖形查詢執行的後端搜尋請求。 |
| searchMs |
integer (int64) |
回報的搜尋時間以毫秒為單位。 |
| totalMs |
integer (int64) |
報告的總執行時間(以毫秒為單位)。 |
NoneVectorQueryTopicGraph
使用一般向量搜尋,不使用主題圖多樣化檢索。
| 名稱 | 類型 | Description |
|---|---|---|
| kind |
string:
none |
該使用的主題圖向量搜尋類型。 |
QueryRewritesType
只有在查詢類型為 semantic時,此參數才有效。 當 QueryRewrites 設定為 generative時,查詢字詞會傳送至產生模型,該模型會產生 10 個 (預設) 重寫,以協助增加要求的召回率。 您可以藉由附加管道字元 | 後面接選項 count-<number of rewrites> (例如 generative|count-3) 來配置所要求的計數。 預設為 None。
| 值 | Description |
|---|---|
| none |
請勿為此查詢產生其他查詢重寫。 |
| generative |
產生替代查詢字詞,以增加搜尋要求的召回率。 |
SearchScoreThreshold
向量查詢的結果會根據 ' 進行篩選
| 名稱 | 類型 | Description |
|---|---|---|
| kind |
string:
search |
門檻的類型。 |
| value |
number (double) |
閾值會根據 |
VectorizableImageBinaryQuery
提供需要向量化之影像的基底 64 編碼二進位檔時,要用於向量搜尋的查詢參數。
| 名稱 | 類型 | Description |
|---|---|---|
| base64Image |
string |
要向量化的圖像的基數 64 編碼二進制文件以執行向量搜索查詢。 |
| exhaustive |
boolean |
若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。 |
| fields |
string |
要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。 |
| filterOverride |
string |
要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。 |
| k |
integer (int32) |
要作為熱門點擊傳回的近鄰數目。 |
| kind |
string:
image |
查詢類型。 |
| oversampling |
number (double) |
過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。 |
| perDocumentVectorLimit |
integer (int32) |
控制向量搜尋查詢中每個文件可以比對的向量數量。 將其設定為 1 可確保每個文件最多匹配一個向量,從而確保結果來自不同的文件。 將其設定為 0(無限制)允許比對同一文件中的多個相關向量。 預設值為 0。 |
| threshold | VectorThreshold: |
用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。 |
| topicGraph | VectorQueryTopicGraph: |
主題圖向量搜尋選項。 |
| weight |
number (float) |
相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。 |
VectorizableImageUrlQuery
當提供代表需要向量化之影像值的 URL 時,要用於向量搜尋的查詢參數。
| 名稱 | 類型 | Description |
|---|---|---|
| exhaustive |
boolean |
若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。 |
| fields |
string |
要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。 |
| filterOverride |
string |
要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。 |
| k |
integer (int32) |
要作為熱門點擊傳回的近鄰數目。 |
| kind |
string:
image |
查詢類型。 |
| oversampling |
number (double) |
過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。 |
| perDocumentVectorLimit |
integer (int32) |
控制向量搜尋查詢中每個文件可以比對的向量數量。 將其設定為 1 可確保每個文件最多匹配一個向量,從而確保結果來自不同的文件。 將其設定為 0(無限制)允許比對同一文件中的多個相關向量。 預設值為 0。 |
| threshold | VectorThreshold: |
用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。 |
| topicGraph | VectorQueryTopicGraph: |
主題圖向量搜尋選項。 |
| url |
string |
要向量化以執行向量搜尋查詢之影像的URL。 |
| weight |
number (float) |
相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。 |
VectorizableTextQuery
提供需要向量化的文字值時,要用於向量搜尋的查詢參數。
| 名稱 | 類型 | Description |
|---|---|---|
| exhaustive |
boolean |
若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。 |
| fields |
string |
要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。 |
| filterOverride |
string |
要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。 |
| k |
integer (int32) |
要作為熱門點擊傳回的近鄰數目。 |
| kind |
string:
text |
查詢類型。 |
| oversampling |
number (double) |
過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。 |
| perDocumentVectorLimit |
integer (int32) |
控制向量搜尋查詢中每個文件可以比對的向量數量。 將其設定為 1 可確保每個文件最多匹配一個向量,從而確保結果來自不同的文件。 將其設定為 0(無限制)允許比對同一文件中的多個相關向量。 預設值為 0。 |
| queryRewrites |
您可以設定為讓產生模型重新撰寫查詢,再將它傳送至向量化。 |
|
| text |
string |
要向量化以執行向量搜尋查詢的文字。 |
| threshold | VectorThreshold: |
用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。 |
| topicGraph | VectorQueryTopicGraph: |
主題圖向量搜尋選項。 |
| weight |
number (float) |
相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。 |
VectorizedQuery
提供原始向量值時,用於向量搜尋的查詢參數。
| 名稱 | 類型 | Description |
|---|---|---|
| exhaustive |
boolean |
若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。 |
| fields |
string |
要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。 |
| filterOverride |
string |
要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。 |
| k |
integer (int32) |
要作為熱門點擊傳回的近鄰數目。 |
| kind |
string:
vector |
查詢類型。 |
| oversampling |
number (double) |
過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。 |
| perDocumentVectorLimit |
integer (int32) |
控制向量搜尋查詢中每個文件可以比對的向量數量。 將其設定為 1 可確保每個文件最多匹配一個向量,從而確保結果來自不同的文件。 將其設定為 0(無限制)允許比對同一文件中的多個相關向量。 預設值為 0。 |
| threshold | VectorThreshold: |
用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。 |
| topicGraph | VectorQueryTopicGraph: |
主題圖向量搜尋選項。 |
| vector |
number[] (float) |
搜尋查詢的向量表示。 |
| weight |
number (float) |
相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。 |
VectorQueryKind
正在執行的向量查詢類型。
| 值 | Description |
|---|---|
| vector |
提供原始向量值的向量查詢。 |
| text |
向量查詢,其中提供了需要向量化的文字值。 |
| imageUrl |
向量查詢,其中提供代表需要向量化的影像值的 URL。 |
| imageBinary |
向量查詢,其中提供了需要向量化的圖像的基數 64 編碼二進位檔。 |
VectorSearchTopicGraphKind
該使用的主題圖向量搜尋類型。
| 值 | Description |
|---|---|
| none |
當主題圖的多樣化檢索失效時,請使用一般向量搜尋。 |
| diverse |
使用主題圖譜多樣化檢索。 |
| balanced |
將純向量相似性與多樣性感知檢索結合。 建議預設選擇在多樣性與相關性之間取得平衡。 |
VectorSimilarityThreshold
系統會根據向量相似度計量來篩選向量查詢的結果。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。
| 名稱 | 類型 | Description |
|---|---|---|
| kind |
string:
vector |
門檻的類型。 |
| value |
number (double) |
臨界值會根據相似性量度值進行篩選。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。 |
VectorThresholdKind
那種用來篩選向量查詢的門檻。
| 值 | Description |
|---|---|
| vectorSimilarity |
系統會根據向量相似度計量來篩選向量查詢的結果。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。 |
| searchScore |
向量查詢的結果會根據 『@search.score』 值進行篩選。 請注意,這是在搜尋回應中傳回 @search.score。 系統會針對較高的 @search.score選擇臨界值方向。 |