共用方式為


Documents - Search Get

搜尋索引中的檔。

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-11-01-preview
GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2024-11-01-preview&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}&queryRewrites={queryRewrites}&debug={debug}&queryLanguage={queryLanguage}&speller={speller}&semanticFields={semanticFields}

URI 參數

名稱 位於 必要 類型 Description
endpoint
path True

string

搜尋服務的端點 URL。

indexName
path True

string

索引的名稱。

api-version
query True

string

用戶端 API 版本。

$count
query

boolean

值,指定是否要擷取結果的總計數。 默認值為 false。 將此值設定為 true 可能會對效能造成影響。 請注意,傳回的計數是近似值。

$filter
query

string

要套用至搜尋查詢的 OData $filter表示式。

$orderby
query

string[]

要排序結果的 OData $orderby表示式清單。 每個運算式可以是功能變數名稱或對 geo.distance() 或 search.score() 函式的呼叫。 每個表達式後面可以接著 asc 表示遞增,而 desc 表示遞減。 預設值為遞增順序。 系結會因檔比對分數而中斷。 如果未指定 OrderBy,預設排序順序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。

$select
query

string[]

要擷取的欄位清單。 如果未指定,則會包含標示為可在架構中擷取的所有欄位。

$skip
query

integer

int32

要略過的搜尋結果數目。 這個值不能大於 100,000。 如果您需要依序掃描檔,但因這項限制而無法使用$skip,請考慮改為在完全排序的索引鍵上使用$orderby,並改用範圍查詢$filter。

$top
query

integer

int32

要擷取的搜尋結果數目。 這可與$skip搭配使用,以實作搜尋結果的用戶端分頁。 如果結果因為伺服器端分頁而遭到截斷,回應會包含接續令牌,可用來針對下一頁的結果發出另一個搜尋要求。

answers
query

QueryAnswerType

只有在查詢類型 semantic時,此參數才有效。 如果設定,查詢會傳回從最高排名檔中索引鍵段落擷取的答案。 傳回的答案數目可以藉由附加管道字元 | 後面接著響應參數值之後的 count-<number of answers> 選項來設定,例如 extractive|count-3。 默認計數為 1。 您可以藉由附加管道字元 | 後面加上響應參數值之後的 threshold-<confidence threshold> 選項,例如 extractive|threshold-0.9來設定信賴臨界值。 默認閾值為0.7。 可以藉由附加管道字元 『|』 後面接著 『count-』 來設定答案的最大字元長度,例如 『extractive|maxcharlength-600』。

captions
query

QueryCaptionType

只有在查詢類型 semantic時,此參數才有效。 如果設定,查詢會傳回從最高排名檔中索引鍵段落擷取的標題。 當 Captions 設定為 extractive時,預設會啟用反白顯示,而且可以藉由附加管道字元 | 後面接著 highlight-<true/false> 選項來設定,例如 extractive|highlight-true。 預設為 None。 您可以附加管道字元 『|』,後面接著 『count-』 來設定標題的最大字元長度,例如 'extractive|maxcharlength-600'。

debug
query

QueryDebugMode

啟用偵錯工具,可用來進一步探索您的搜尋結果。

facet
query

string[]

要套用至搜尋查詢的Facet表達式清單。 每個 Facet 運算式都包含功能變數名稱,選擇性地後面接著以逗號分隔的名稱:值組清單。

highlight
query

string[]

要用於點擊醒目提示的功能變數名稱清單。 只有可搜尋的欄位可用於點擊醒目提示。

highlightPostTag
query

string

附加至叫用醒目提示的字串標記。 必須使用 highlightPreTag 進行設定。 預設值為 </em>。

highlightPreTag
query

string

在叫用醒目提示前面加上的字串標記。 必須使用 highlightPostTag 進行設定。 預設值為 em <>。

minimumCoverage
query

number

double

介於 0 到 100 之間的數位,表示搜尋查詢必須涵蓋的索引百分比,以便將查詢回報為成功。 此參數對於確保搜尋可用性,即使是只有一個複本的服務,也很有用。 預設值為 100。

queryLanguage
query

QueryLanguage

查詢的語言。

queryRewrites
query

QueryRewritesType

當 QueryRewrites 設定為 generative時,查詢字詞會傳送至會產生 10 個(預設)重寫的產生模型,以協助增加要求的召回率。 您可以藉由附加管道字元 | 後面接著 count-<number of rewrites> 選項來設定要求的計數,例如 generative|count-3。 預設為 None。 只有在查詢類型 semantic時,此參數才有效。

queryType
query

QueryType

值,指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,請使用 『full』。

scoringParameter
query

string[]

要用於評分函式的參數值清單(例如 referencePointParameter),其格式為 name-values。 例如,如果評分配置檔使用名為 'mylocation' 的參數定義函式,則參數位符串會是 “mylocation--122.2,44.8” (不含引號)。

scoringProfile
query

string

要評估比對檔比對分數的評分配置檔名稱,以便排序結果。

scoringStatistics
query

ScoringStatistics

值,指定我們是要全域計算評分統計數據(例如文件頻率),以取得更一致的評分,還是針對較低的延遲在本機計算。

search
query

string

全文搜索查詢表達式;使用 「*」 或省略此參數以符合所有檔。

searchFields
query

string[]

要設定全文搜索範圍的功能變數名稱清單。 在完整的 Lucene 查詢中使用字段搜尋 (fieldName:searchExpression) 時,每個字段搜尋表達式的功能變數名稱優先於此參數中列出的任何功能變數名稱。

searchMode
query

SearchMode

值,指定是否必須比對任何或所有搜尋字詞,才能將檔計算為相符專案。

semanticConfiguration
query

string

語意組態的名稱,其中列出哪些欄位應該用於語意排名、標題、醒目提示和答案

semanticErrorHandling
query

SemanticErrorMode

允許使用者選擇語意呼叫應該完全失敗,還是傳回部分結果(預設值)。

semanticFields
query

string[]

用於語意排名的域名清單。

semanticMaxWaitInMilliseconds
query

integer

int32

允許使用者在要求失敗之前,設定語意擴充完成處理所需的時間上限。

semanticQuery
query

string

允許設定單獨用於語意重新編列、語意標題和語意答案的個別搜尋查詢。 適用於需要使用基底擷取和排名階段和 L2 語意階段之間不同查詢的案例。

sessionId
query

string

用來建立黏性會話的值,有助於取得更一致的結果。 只要使用相同的 sessionId,就會嘗試以相同的副本集為目標。 請謹慎地重複重複使用相同的 sessionID 值,可能會干擾跨複本的要求負載平衡,並對搜尋服務的效能造成負面影響。 做為 sessionId 的值不能以 '_' 字元開頭。

speller
query

QuerySpellerType

藉由拼字更正個別搜尋查詢字詞來改善搜尋召回率。

要求標頭

名稱 必要 類型 Description
x-ms-client-request-id

string

uuid

隨要求一起傳送的追蹤標識碼,以協助偵錯。

回應

名稱 類型 Description
200 OK

SearchDocumentsResult

包含符合搜尋準則的文件回應。

Other Status Codes

ErrorResponse

錯誤回應。

範例

SearchIndexSearchDocumentsGet
SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

範例要求

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-11-01-preview&speller={speller}

範例回覆

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

範例要求

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2024-11-01-preview&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}&semanticFields={semanticFields}

範例回覆

{
  "@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
    }
  ],
  "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"
      ]
    }
  ]
}

定義

名稱 Description
AnswerResult

答案是從符合查詢的最相關文件內容擷取的文字段落。 答案會從頂端搜尋結果擷取。 答案候選項目會進行評分,並選取最上方的答案。

CaptionResult

標題是文件相對於搜尋查詢最具代表性的段落。 它們通常用來做為文件摘要。 標題只會針對類型為 semantic的查詢傳回。

DebugInfo

包含可用來進一步探索搜尋結果的偵錯資訊。

DocumentDebugInfo

包含可用來進一步探索搜尋結果的偵錯資訊。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

HybridCountAndFacetMode

判斷計數和 Facet 是否應該包含符合搜尋查詢的所有檔,或只包含 'maxTextRecallSize' 視窗中擷取的檔。 默認值為 『countAllResults』。

HybridSearch

設定混合式搜尋行為的查詢參數。

QueryAnswerType

值,指定是否應該在搜尋回應中傳回答案。

QueryCaptionType

值,指定是否應該在搜尋回應中傳回標題。

QueryDebugMode

啟用偵錯工具,可用來進一步探索您的搜尋結果。 您可以使用 分隔多個偵錯模式來同時啟用多個偵錯模式 |character,例如:semantic|queryRewrites。

QueryLanguage

查詢的語言。

QueryResultDocumentRerankerInput

傳送至語意擴充程式的原始串連字串。

QueryResultDocumentSemanticField

傳送至語意擴充程式的字段描述,以及其使用方式

QueryResultDocumentSubscores

本檔搜尋查詢的文字和向量查詢元件之間的子核心明細。 每個向量查詢都會以收到的相同順序顯示為個別物件。

QueryRewritesDebugInfo

包含查詢重寫的特定偵錯資訊。

QueryRewritesType

值,指定是否應該產生查詢重寫來增強搜尋查詢。

QueryRewritesValuesDebugInfo

包含查詢重寫的特定偵錯資訊。

QuerySpellerType

值,指定用於拼字更正個別搜尋查詢字詞的拼字檢查類型。

QueryType

指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,並在不需要查詢語法時使用 'semantic',請使用 'full'。

RawVectorQuery

提供原始向量值時,用於向量搜尋的查詢參數。

ScoringStatistics

值,指定我們是要全域計算評分統計數據(例如文件頻率),以取得更一致的評分,還是針對較低的延遲在本機計算。 預設值為 『local』。 在評分之前,使用 「全域」來匯總全域評分統計數據。 使用全域評分統計數據可能會增加搜尋查詢的延遲。

SearchDocumentsResult

包含索引搜尋結果的回應。

SearchMode

指定是否必須比對任何或所有搜尋字詞,才能將文件計算為相符專案。

SearchRequest

篩選、排序、Facet、分頁和其他搜尋查詢行為的參數。

SearchResult

包含搜尋查詢所找到的檔,加上相關聯的元數據。

SearchScoreThreshold

向量查詢的結果會根據 『@search.score』 值進行篩選。 請注意,這是在搜尋回應中傳回 @search.score。 系統會針對較高的 @search.score選擇臨界值方向。

SemanticDebugInfo
SemanticErrorMode

允許使用者選擇語意呼叫是否應該完全失敗(預設/目前行為),或傳回部分結果。

SemanticErrorReason

語意排名要求傳回部分回應的原因。

SemanticFieldState

欄位用於語意擴充程式的方式(完全使用、部分使用或未使用)

SemanticQueryRewritesResultType

用於此要求的查詢重寫類型。

SemanticSearchResultsType

針對語意排名要求傳回的部分回應類型。

SingleVectorFieldResult

單一向量欄位結果。 傳回 @search.score 和向量相似度值。 向量相似度與方程式 @search.score 相關。

TextResult

查詢文字部分的 BM25 或傳統分數。

VectorFilterMode

判斷是否在執行向量搜尋之前或之後套用篩選。

VectorizableImageBinaryQuery

提供需要向量化之影像的基底 64 編碼二進位檔時,要用於向量搜尋的查詢參數。

VectorizableImageUrlQuery

當提供代表需要向量化之影像值的 URL 時,要用於向量搜尋的查詢參數。

VectorizableTextQuery

提供需要向量化的文字值時,要用於向量搜尋的查詢參數。

VectorQueryKind

正在執行的向量查詢種類。

VectorsDebugInfo
VectorSimilarityThreshold

系統會根據向量相似度計量來篩選向量查詢的結果。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。

VectorThresholdKind

正在執行的向量查詢種類。

AnswerResult

答案是從符合查詢的最相關文件內容擷取的文字段落。 答案會從頂端搜尋結果擷取。 答案候選項目會進行評分,並選取最上方的答案。

名稱 類型 Description
highlights

string

與 Text 屬性中的文字段落相同,其中醒目提示的文字片語與查詢最相關的文字片語。

key

string

從中擷取答案的檔索引鍵。

score

number

分數值代表與查詢相對於針對查詢傳回之其他答案的查詢相關程度。

text

string

從文件內容擷取為答案的文字段落。

CaptionResult

標題是文件相對於搜尋查詢最具代表性的段落。 它們通常用來做為文件摘要。 標題只會針對類型為 semantic的查詢傳回。

名稱 類型 Description
highlights

string

與 Text 屬性中的文字段落相同,其中包含與查詢最相關的醒目提示片語。

text

string

從與搜尋查詢最相關的檔中擷取的代表性文字段落。

DebugInfo

包含可用來進一步探索搜尋結果的偵錯資訊。

名稱 類型 Description
queryRewrites

QueryRewritesDebugInfo

包含查詢重寫的特定偵錯資訊。

DocumentDebugInfo

包含可用來進一步探索搜尋結果的偵錯資訊。

名稱 類型 Description
semantic

SemanticDebugInfo

包含語意排名要求特有的偵錯資訊。

vectors

VectorsDebugInfo

包含向量和混合式搜尋特有的偵錯資訊。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細數據。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

HybridCountAndFacetMode

判斷計數和 Facet 是否應該包含符合搜尋查詢的所有檔,或只包含 'maxTextRecallSize' 視窗中擷取的檔。 默認值為 『countAllResults』。

名稱 類型 Description
countAllResults

string

不論這些檔是否在 『maxTextRecallSize』 擷取視窗中,計算 'count' 和 'facet' 時,包含搜尋查詢所比對的所有檔。

countRetrievableResults

string

只有在計算 'count' 和 'facet' 時,才包含 'maxTextRecallSize' 擷取視窗中相符的檔。

HybridSearch

設定混合式搜尋行為的查詢參數。

名稱 類型 Description
countAndFacetMode

HybridCountAndFacetMode

判斷計數和 Facet 是否應該包含符合搜尋查詢的所有檔,或只包含 'maxTextRecallSize' 視窗中擷取的檔。

maxTextRecallSize

integer

決定混合式搜尋要求的文字查詢部分所要擷取的文件數目上限。 這些檔會與符合向量查詢的檔結合,以產生單一最終的結果清單。 選擇較大的 maxTextRecallSize 值將允許擷取和分頁更多檔(使用頂端和略過參數),代價是資源使用率較高和延遲較高。 值必須介於 1 到 10,000 之間。 預設值為 1000。

QueryAnswerType

值,指定是否應該在搜尋回應中傳回答案。

名稱 類型 Description
extractive

string

從傳回的文件內容擷取回應以自然語言表示為問題之查詢的回應候選專案。

none

string

請勿傳回查詢的答案。

QueryCaptionType

值,指定是否應該在搜尋回應中傳回標題。

名稱 類型 Description
extractive

string

從相符的檔擷取標題,其中包含與搜尋查詢相關的段落。

none

string

請勿傳回查詢的標題。

QueryDebugMode

啟用偵錯工具,可用來進一步探索您的搜尋結果。 您可以使用 分隔多個偵錯模式來同時啟用多個偵錯模式 |character,例如:semantic|queryRewrites。

名稱 類型 Description
all

string

開啟所有偵錯選項。

disabled

string

不會傳回任何查詢偵錯資訊。

queryRewrites

string

允許使用者探索針對其搜尋要求所產生的查詢重寫清單。

semantic

string

允許用戶進一步探索其重新建立的結果。

vector

string

允許用戶進一步探索其混合式和向量查詢結果。

QueryLanguage

查詢的語言。

名稱 類型 Description
ar-eg

string

阿拉伯文(埃及)的查詢語言值。

ar-jo

string

查詢阿拉伯文(約旦)的語言值。

ar-kw

string

查詢阿拉伯文 (科威特) 的語言值。

ar-ma

string

阿拉伯文(摩洛哥)的查詢語言值。

ar-sa

string

阿拉伯文 (沙烏地阿拉伯) 的查詢語言值。

bg-bg

string

保加利亞文(保加利亞)的查詢語言值。

bn-in

string

孟加拉文(印度)的查詢語言值。

ca-es

string

查詢加泰羅尼亞文語言值。

cs-cz

string

捷克文的查詢語言值。

da-dk

string

丹麥文(丹麥)的查詢語言值。

de-de

string

德文(德國)的查詢語言值。

el-gr

string

希臘文 (希臘) 的查詢語言值。

en-au

string

查詢英文(澳大利亞)的語言值。

en-ca

string

英文(加拿大)的查詢語言值。

en-gb

string

查詢英文語言值(英國)。

en-in

string

查詢英文(印度)的語言值。

en-us

string

英文(美國)的查詢語言值。

es-es

string

西班牙文(西班牙)的查詢語言值。

es-mx

string

查詢西班牙文(墨西哥)的語言值。

et-ee

string

愛沙尼亞文(愛沙尼亞)的查詢語言值。

eu-es

string

Basque 的查詢語言值。

fa-ae

string

波斯文的查詢語言值(U.A.E.)。

fi-fi

string

芬蘭文(芬蘭)的查詢語言值。

fr-ca

string

查詢法文(加拿大)的語言值。

fr-fr

string

法文(法國)的查詢語言值。

ga-ie

string

查詢愛爾蘭文(愛爾蘭)的語言值。

gl-es

string

Galician 的查詢語言值。

gu-in

string

古賈拉提語(印度)的查詢語言值。

he-il

string

希伯來文 (以色列) 的查詢語言值。

hi-in

string

印度文的查詢語言值。

hr-ba

string

克羅埃西亞文 (波士尼亞-黑塞哥維那) 的查詢語言值。

hr-hr

string

克羅埃西亞文(克羅埃西亞)的查詢語言值。

hu-hu

string

匈牙利文(匈牙利)的查詢語言值。

hy-am

string

亞美尼亞文(亞美尼亞)的查詢語言值。

id-id

string

印尼文(印尼文(印尼)的查詢語言值。

is-is

string

冰島文(冰島)的查詢語言值。

it-it

string

義大利文(義大利)的查詢語言值。

ja-jp

string

日文(日本)的查詢語言值。

kn-in

string

Kannada (印度) 的查詢語言值。

ko-kr

string

查詢韓文(韓文)的語言值。

lt-lt

string

立陶宛文(立陶宛)的查詢語言值。

lv-lv

string

拉脫維亞文(拉脫維亞)的查詢語言值。

ml-in

string

馬來亞蘭語(印度)的查詢語言值。

mr-in

string

馬拉蒂(印度)的查詢語言值。

ms-bn

string

馬來語的查詢語言值(汶萊達魯薩蘭)。

ms-my

string

馬來語(馬來西亞)的查詢語言值。

nb-no

string

挪威文(挪威)的查詢語言值。

nl-be

string

荷蘭文(比利時)的查詢語言值。

nl-nl

string

荷蘭文的查詢語言值。

no-no

string

挪威文(挪威)的查詢語言值。

none

string

未指定查詢語言。

pa-in

string

旁遮普(印度)的查詢語言值。

pl-pl

string

波蘭文的查詢語言值。

pt-br

string

葡萄牙文 (巴西) 的查詢語言值。

pt-pt

string

葡萄牙文(葡萄牙)的查詢語言值。

ro-ro

string

羅馬尼亞文 (羅馬尼亞) 的查詢語言值。

ru-ru

string

查詢俄文(俄羅斯)的語言值。

sk-sk

string

斯洛伐克文(斯洛伐克)的查詢語言值。

sl-sl

string

斯洛維尼亞文(斯洛維尼亞)的查詢語言值。

sr-ba

string

塞爾維亞文(波士尼亞-黑塞哥維那)的查詢語言值。

sr-me

string

塞爾維亞文(黑山)的查詢語言值。

sr-rs

string

塞爾維亞文(塞爾維亞)的查詢語言值。

sv-se

string

查詢瑞典文(瑞典)的語言值。

ta-in

string

泰米爾語(印度)的查詢語言值。

te-in

string

Telugu (印度) 的查詢語言值。

th-th

string

泰國文的查詢語言值。

tr-tr

string

土耳其文的查詢語言值。

uk-ua

string

烏克蘭文(烏克蘭)的查詢語言值。

ur-pk

string

烏爾都(巴基斯坦)的查詢語言值。

vi-vn

string

越南文的查詢語言值(越南)。

zh-cn

string

查詢中文(中國)的語言值。

zh-tw

string

中文(臺灣)的查詢語言值。

QueryResultDocumentRerankerInput

傳送至語意擴充程式的原始串連字串。

名稱 類型 Description
content

string

用於語意擴充之內容字段的原始串連字串。

keywords

string

用於語意擴充之關鍵詞字段的原始串連字串。

title

string

用於語意擴充之標題字段的原始字串。

QueryResultDocumentSemanticField

傳送至語意擴充程式的字段描述,以及其使用方式

名稱 類型 Description
name

string

傳送至語意擴充程式的功能變數名稱

state

SemanticFieldState

欄位用於語意擴充程式的方式(完全使用、部分使用或未使用)

QueryResultDocumentSubscores

本檔搜尋查詢的文字和向量查詢元件之間的子核心明細。 每個向量查詢都會以收到的相同順序顯示為個別物件。

名稱 類型 Description
documentBoost

number

查詢文字部分的 BM25 或傳統分數。

text

TextResult

查詢文字部分的 BM25 或傳統分數。

vectors

<string,  SingleVectorFieldResult>

每個向量查詢的向量相似度和 @search.score 值。

QueryRewritesDebugInfo

包含查詢重寫的特定偵錯資訊。

名稱 類型 Description
text

QueryRewritesValuesDebugInfo

針對文字查詢產生的查詢重寫清單。

vectors

QueryRewritesValuesDebugInfo[]

針對可向量化文字查詢所產生的查詢重寫清單。

QueryRewritesType

值,指定是否應該產生查詢重寫來增強搜尋查詢。

名稱 類型 Description
generative

string

產生替代查詢字詞,以增加搜尋要求的召回率。

none

string

請勿為此查詢產生額外的查詢重寫。

QueryRewritesValuesDebugInfo

包含查詢重寫的特定偵錯資訊。

名稱 類型 Description
inputQuery

string

產生查詢重寫模型的輸入文字。 在某些情況下,使用者查詢和產生模型輸入不一樣。

rewrites

string[]

查詢重寫清單。

QuerySpellerType

值,指定用於拼字更正個別搜尋查詢字詞的拼字檢查類型。

名稱 類型 Description
lexicon

string

拼字檢查會針對 queryLanguage 參數所指定語言使用靜態語彙修正個別查詢字詞。

none

string

未啟用拼字檢查。

QueryType

指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,並在不需要查詢語法時使用 'semantic',請使用 'full'。

名稱 類型 Description
full

string

使用完整的 Lucene 查詢語法進行搜尋。 搜尋文字是使用 Lucene 查詢語言來解譯,該語言允許欄位特定和加權搜尋,以及其他進階功能。

semantic

string

最適合以自然語言表示的查詢,而不是關鍵詞。 使用在 Web 主體上定型的排名模型,重新排名前幾名搜尋結果,以改善搜尋結果的有效位數。

simple

string

使用簡單的查詢語法進行搜尋。 搜尋文字是使用簡單的查詢語言來解譯,允許使用 +、* 和 “” 等符號。 除非指定 searchFields 參數,否則預設會評估所有可搜尋字段的查詢。

RawVectorQuery

提供原始向量值時,用於向量搜尋的查詢參數。

名稱 類型 Description
exhaustive

boolean

若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。

fields

string

要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。

filterOverride

string

要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。

k

integer

要作為熱門點擊傳回的近鄰數目。

kind string:

vector

正在執行的向量查詢種類。

oversampling

number

過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。

threshold VectorThreshold:

用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。

vector

number[]

搜尋查詢的向量表示。

weight

number

相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。

ScoringStatistics

值,指定我們是要全域計算評分統計數據(例如文件頻率),以取得更一致的評分,還是針對較低的延遲在本機計算。 預設值為 『local』。 在評分之前,使用 「全域」來匯總全域評分統計數據。 使用全域評分統計數據可能會增加搜尋查詢的延遲。

名稱 類型 Description
global

string

系統會全域計算評分統計數據,以取得更一致的評分。

local

string

評分統計數據將會在本機計算,以降低延遲。

SearchDocumentsResult

包含索引搜尋結果的回應。

名稱 類型 Description
@odata.count

integer

搜尋作業所找到的結果總數,如果未要求計數,則為 null。 如果存在,計數可能大於此回應中的結果數目。 如果您使用$top或$skip參數,或查詢無法在單一回應中傳回所有要求的檔,就會發生這種情況。

@odata.nextLink

string

當查詢無法傳回單一回應中所有要求的結果時,所傳回的接續 URL。 您可以使用此 URL 來制定另一個 GET 或 POST 搜尋要求,以取得搜尋回應的下一個部分。 請務必使用與產生此回應的要求相同的動詞 (GET 或 POST)。

@search.answers

AnswerResult[]

搜尋作業的答案查詢結果;如果未指定答案查詢參數或設定為 『none』,則為 null。

@search.coverage

number

值,指出查詢中包含的索引百分比,如果要求中未指定 minimumCoverage,則為 null。

@search.debug

DebugInfo

整體套用至搜尋結果的偵錯資訊。

@search.facets

object

搜尋作業的 Facet 查詢結果,會組織為每個多面向字段的貯體集合;如果查詢未包含任何 Facet 運算式,則為 null。

@search.nextPageParameters

SearchRequest

當查詢無法傳回單一回應中所有要求的結果時,所傳回的接續 JSON 承載。 您可以搭配 @odata.nextLink 使用此 JSON 來制定另一個 POST 搜尋要求,以取得搜尋回應的下一個部分。

@search.semanticPartialResponseReason

SemanticErrorReason

語意排名要求傳回部分回應的原因。

@search.semanticPartialResponseType

SemanticSearchResultsType

針對語意排名要求傳回的部分回應類型。

@search.semanticQueryRewritesResultType

SemanticQueryRewritesResultType

用來擷取文件的查詢重寫類型。

value

SearchResult[]

查詢所傳回的結果序列。

SearchMode

指定是否必須比對任何或所有搜尋字詞,才能將文件計算為相符專案。

名稱 類型 Description
all

string

所有搜尋字詞都必須相符,才能將檔計數為相符專案。

any

string

必須比對任何搜尋字詞,才能將檔計數為相符專案。

SearchRequest

篩選、排序、Facet、分頁和其他搜尋查詢行為的參數。

名稱 類型 Description
answers

QueryAnswerType

值,指定是否應該在搜尋回應中傳回答案。

captions

QueryCaptionType

值,指定是否應該在搜尋回應中傳回標題。

count

boolean

值,指定是否要擷取結果的總計數。 默認值為 false。 將此值設定為 true 可能會對效能造成影響。 請注意,傳回的計數是近似值。

debug

QueryDebugMode

啟用偵錯工具,可用來進一步探索您重新建立的結果。

facets

string[]

要套用至搜尋查詢的Facet表達式清單。 每個 Facet 運算式都包含功能變數名稱,選擇性地後面接著以逗號分隔的名稱:值組清單。

filter

string

要套用至搜尋查詢的 OData $filter表示式。

highlight

string

要用於點擊醒目提示的功能變數名稱逗號分隔清單。 只有可搜尋的欄位可用於點擊醒目提示。

highlightPostTag

string

附加至叫用醒目提示的字串標記。 必須使用 highlightPreTag 進行設定。 預設值為 </em>。

highlightPreTag

string

在叫用醒目提示前面加上的字串標記。 必須使用 highlightPostTag 進行設定。 預設值為 em <>。

hybridSearch

HybridSearch

設定混合式搜尋行為的查詢參數。

minimumCoverage

number

介於 0 到 100 之間的數位,表示搜尋查詢必須涵蓋的索引百分比,以便將查詢回報為成功。 此參數對於確保搜尋可用性,即使是只有一個複本的服務,也很有用。 預設值為 100。

orderby

string

OData 的逗號分隔清單$orderby用來排序結果的表達式。 每個運算式可以是功能變數名稱或對 geo.distance() 或 search.score() 函式的呼叫。 每個表達式後面可以接著 asc 表示遞增,或 desc 表示遞減。 預設值為遞增順序。 系結會因檔比對分數而中斷。 如果未指定任何$orderby,則預設排序順序會依檔比對分數遞減。 最多可以有 32 個$orderby子句。

queryLanguage

QueryLanguage

值,指定搜尋查詢的語言。

queryRewrites

QueryRewritesType

值,指定是否應該產生查詢重寫來增強搜尋查詢。

queryType

QueryType

值,指定搜尋查詢的語法。 預設值為 『simple』。 如果您的查詢使用 Lucene 查詢語法,請使用 『full』。

scoringParameters

string[]

要用於評分函式的參數值清單(例如 referencePointParameter),其格式為 name-values。 例如,如果評分配置檔使用名為 'mylocation' 的參數定義函式,則參數位符串會是 “mylocation--122.2,44.8” (不含引號)。

scoringProfile

string

要評估比對檔比對分數的評分配置檔名稱,以便排序結果。

scoringStatistics

ScoringStatistics

值,指定我們是要全域計算評分統計數據(例如文件頻率),以取得更一致的評分,還是針對較低的延遲在本機計算。 預設值為 『local』。 在評分之前,使用 「全域」來匯總全域評分統計數據。 使用全域評分統計數據可能會增加搜尋查詢的延遲。

search

string

全文搜索查詢表達式;使用 「*」 或省略此參數以符合所有檔。

searchFields

string

要設定全文搜索範圍之功能變數名稱的逗號分隔清單。 在完整的 Lucene 查詢中使用字段搜尋 (fieldName:searchExpression) 時,每個字段搜尋表達式的功能變數名稱優先於此參數中列出的任何功能變數名稱。

searchMode

SearchMode

值,指定是否必須比對任何或所有搜尋字詞,才能將檔計算為相符專案。

select

string

要擷取的欄位逗號分隔清單。 如果未指定,則會包含標示為可在架構中擷取的所有欄位。

semanticConfiguration

string

處理類型語意查詢的檔時將使用的語意組態名稱。

semanticErrorHandling

SemanticErrorMode

允許使用者選擇語意呼叫是否應該完全失敗(預設/目前行為),或傳回部分結果。

semanticFields

string

用於語意排名的功能變數名稱逗號分隔清單。

semanticMaxWaitInMilliseconds

integer

允許使用者在要求失敗之前,設定語意擴充完成處理所需的時間上限。

semanticQuery

string

允許設定單獨用於語意重新編列、語意標題和語意答案的個別搜尋查詢。 適用於需要使用基底擷取和排名階段和 L2 語意階段之間不同查詢的案例。

sessionId

string

用來建立黏性會話的值,有助於取得更一致的結果。 只要使用相同的 sessionId,就會嘗試以相同的副本集為目標。 請謹慎地重複重複使用相同的 sessionID 值,可能會干擾跨複本的要求負載平衡,並對搜尋服務的效能造成負面影響。 做為 sessionId 的值不能以 '_' 字元開頭。

skip

integer

要略過的搜尋結果數目。 這個值不能大於 100,000。 如果您需要依序掃描檔,但因這項限制而無法使用skip,請考慮改為在完全排序的索引鍵上使用orderby,並改用範圍查詢篩選。

speller

QuerySpellerType

值,指定用於拼字更正個別搜尋查詢字詞的拼字檢查類型。

top

integer

要擷取的搜尋結果數目。 這可與$skip搭配使用,以實作搜尋結果的用戶端分頁。 如果結果因為伺服器端分頁而遭到截斷,回應會包含接續令牌,可用來針對下一頁的結果發出另一個搜尋要求。

vectorFilterMode

VectorFilterMode

判斷是否在執行向量搜尋之前或之後套用篩選。 新索引的預設值為 『preFilter』。

vectorQueries VectorQuery[]:

向量和混合式搜尋查詢的查詢參數。

SearchResult

包含搜尋查詢所找到的檔,加上相關聯的元數據。

名稱 類型 Description
@search.captions

CaptionResult[]

標題是文件相對於搜尋查詢最具代表性的段落。 它們通常用來做為文件摘要。 標題只會針對類型為 『semantic』 的查詢傳回。

@search.documentDebugInfo

DocumentDebugInfo[]

包含可用來進一步探索搜尋結果的偵錯資訊。

@search.highlights

object

檔中的文字片段,這些文字片段會指出相符的搜尋字詞,並依每個適用的欄位組織;如果查詢未啟用叫用醒目提示,則為 null。

@search.rerankerScore

number

由語意排名器針對最上層搜尋結果計算的相關性分數。 搜尋結果會先依 RerankerScore 排序,再依分數排序。 RerankerScore 只會針對類型為 'semantic' 的查詢傳回。

@search.score

number

與查詢傳回的其他檔相比,文件的相關性分數。

SearchScoreThreshold

向量查詢的結果會根據 『@search.score』 值進行篩選。 請注意,這是在搜尋回應中傳回 @search.score。 系統會針對較高的 @search.score選擇臨界值方向。

名稱 類型 Description
kind string:

searchScore

用來篩選向量查詢的臨界值種類

value

number

閾值會根據 『@search.score』 值進行篩選。 請注意,這是在搜尋回應中傳回 @search.score。 系統會針對較高的 @search.score選擇臨界值方向。

SemanticDebugInfo

名稱 類型 Description
contentFields

QueryResultDocumentSemanticField[]

傳送至語意擴充程序的內容欄位,以及其使用方式

keywordFields

QueryResultDocumentSemanticField[]

傳送至語意擴充程序的關鍵詞欄位,以及其使用方式

rerankerInput

QueryResultDocumentRerankerInput

傳送至語意擴充程式的原始串連字串。

titleField

QueryResultDocumentSemanticField

傳送至語意擴充程式的標題字段,以及其使用方式

SemanticErrorMode

允許使用者選擇語意呼叫是否應該完全失敗(預設/目前行為),或傳回部分結果。

名稱 類型 Description
fail

string

如果在語意處理步驟期間發生例外狀況,查詢將會失敗,並根據錯誤傳回適當的 HTTP 程式代碼。

partial

string

如果語意處理失敗,部分結果仍會傳回。 部分結果的定義取決於語意步驟失敗的原因,以及失敗的原因。

SemanticErrorReason

語意排名要求傳回部分回應的原因。

名稱 類型 Description
capacityOverloaded

string

要求已節流。 只會傳回基底結果。

maxWaitExceeded

string

如果已設定 semanticMaxWaitInMilliseconds,且語意處理持續時間超過該值。 只會傳回基底結果。

transient

string

語意處理程式的至少一個步驟失敗。

SemanticFieldState

欄位用於語意擴充程式的方式(完全使用、部分使用或未使用)

名稱 類型 Description
partial

string

欄位部分用於語意擴充。

unused

string

欄位未用於語意擴充。

used

string

欄位已完全用於語意擴充。

SemanticQueryRewritesResultType

用於此要求的查詢重寫類型。

名稱 類型 Description
originalQueryOnly

string

此要求未成功產生查詢重寫。 只有原始查詢可用來擷取結果。

SemanticSearchResultsType

針對語意排名要求傳回的部分回應類型。

名稱 類型 Description
baseResults

string

沒有任何語意擴充或重新執行的結果。

rerankedResults

string

結果已使用重新執行器模型重新建立,且會包含語意標題。 它們不會包含任何答案、答案醒目提示或標題醒目提示。

SingleVectorFieldResult

單一向量欄位結果。 傳回 @search.score 和向量相似度值。 向量相似度與方程式 @search.score 相關。

名稱 類型 Description
searchScore

number

從向量相似度分數計算的 @search.score 值。 這是純單一欄位單向量查詢中可見的分數。

vectorSimilarity

number

本檔的向量相似度分數。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 例如,餘弦相似度,而不是餘弦距離。

TextResult

查詢文字部分的 BM25 或傳統分數。

名稱 類型 Description
searchScore

number

查詢文字部分的 BM25 或傳統分數。

VectorFilterMode

判斷是否在執行向量搜尋之前或之後套用篩選。

名稱 類型 Description
postFilter

string

篩選會在傳回候選的向量結果集之後套用。 視篩選選擇性而定,這可能會導致比參數 『k』 所要求的結果少。

preFilter

string

篩選會在搜尋查詢之前套用。

VectorizableImageBinaryQuery

提供需要向量化之影像的基底 64 編碼二進位檔時,要用於向量搜尋的查詢參數。

名稱 類型 Description
base64Image

string

要向量化之影像的基底 64 編碼二進位檔,以執行向量搜尋查詢。

exhaustive

boolean

若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。

fields

string

要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。

filterOverride

string

要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。

k

integer

要作為熱門點擊傳回的近鄰數目。

kind string:

imageBinary

正在執行的向量查詢種類。

oversampling

number

過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。

threshold VectorThreshold:

用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。

weight

number

相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。

VectorizableImageUrlQuery

當提供代表需要向量化之影像值的 URL 時,要用於向量搜尋的查詢參數。

名稱 類型 Description
exhaustive

boolean

若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。

fields

string

要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。

filterOverride

string

要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。

k

integer

要作為熱門點擊傳回的近鄰數目。

kind string:

imageUrl

正在執行的向量查詢種類。

oversampling

number

過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。

threshold VectorThreshold:

用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。

url

string

要向量化以執行向量搜尋查詢之影像的URL。

weight

number

相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。

VectorizableTextQuery

提供需要向量化的文字值時,要用於向量搜尋的查詢參數。

名稱 類型 Description
exhaustive

boolean

若為 true,則會在向量索引內的所有向量觸發詳盡的 K 近鄰搜尋。 適用於完全相符專案很重要的案例,例如判斷地面真相值。

fields

string

要包含在搜尋向量中之 Collection(Edm.Single) 類型的向量字段。

filterOverride

string

要套用至這個特定向量查詢的 OData 篩選表示式。 如果未在向量層級定義任何篩選表達式,則會改用最上層篩選參數中定義的表達式。

k

integer

要作為熱門點擊傳回的近鄰數目。

kind string:

text

正在執行的向量查詢種類。

oversampling

number

過度取樣因素。 最小值為 1。 它會覆寫索引定義中設定的 『defaultOversampling』 參數。 只有當 'rerankWithOriginalVectors' 為 true 時,才能進行設定。 只有在基礎向量欄位上使用壓縮方法時,才允許此參數。

queryRewrites

QueryRewritesType

您可以設定為讓產生模型重新撰寫查詢,再將它傳送至向量化。

text

string

要向量化以執行向量搜尋查詢的文字。

threshold VectorThreshold:

用於向量查詢的臨界值。 請注意,只有在所有 'fields' 都使用相同的相似度計量時,才能設定這個值。

weight

number

相較於相同搜尋要求中的其他向量查詢和/或文字查詢,向量查詢的相對加權。 結合不同向量查詢所產生的多個排名清單結果,以及/或透過文字查詢擷取的結果時,會使用此值。 權數越高,符合該查詢的檔就會在最終排名中。 默認值為 1.0,值必須是大於零的正數。

VectorQueryKind

正在執行的向量查詢種類。

名稱 類型 Description
imageBinary

string

向量查詢,其中會提供需要向量化之影像的基底 64 編碼二進位檔。

imageUrl

string

向量查詢,其中提供代表需要向量化之影像值的URL。

text

string

向量查詢,其中提供了需要向量化的文字值。

vector

string

提供原始向量值的向量查詢。

VectorsDebugInfo

名稱 類型 Description
subscores

QueryResultDocumentSubscores

在所選的結果集融合/組合方法之前,檔子核心的分解,例如 RRF。

VectorSimilarityThreshold

系統會根據向量相似度計量來篩選向量查詢的結果。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。

名稱 類型 Description
kind string:

vectorSimilarity

用來篩選向量查詢的臨界值種類

value

number

閾值會根據相似度計量值進行篩選。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。

VectorThresholdKind

正在執行的向量查詢種類。

名稱 類型 Description
searchScore

string

向量查詢的結果會根據 『@search.score』 值進行篩選。 請注意,這是在搜尋回應中傳回 @search.score。 系統會針對較高的 @search.score選擇臨界值方向。

vectorSimilarity

string

系統會根據向量相似度計量來篩選向量查詢的結果。 請注意,這是相似度計量的正式定義,而不是「距離」版本。 系統會根據欄位所使用的計量自動選擇臨界值方向(較大或更小)。