Documents - Search Post

Service:

Search Service

API-versie:

2025-09-01

Zoekt naar documenten in de index.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexName	path	True	string	De naam van de index.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	De tracking-ID die is verzonden met het verzoek om te helpen bij het opsporen.

Aanvraagbody

Name	Type	Description
answers	QueryAnswerType	Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van de zoekopdracht.
captions	QueryCaptionType	Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van de zoekopdracht.
count	boolean	Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardwaarde is vals. Als u deze waarde instelt op waar, kan dit gevolgen hebben voor de prestaties. Merk op dat de geretourneerde telling een benadering is.
debug	QueryDebugMode	Schakelt een foutopsporingstool in die kan worden gebruikt om uw opnieuw gerangschikte resultaten verder te verkennen.
facets	string[]	De lijst met facetexpressies die op de zoekopdracht moeten worden toegepast. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met name:value-paren.
filter	string	De OData $filter expressie die op de zoekquery moet worden toegepast.
highlight	string	De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor hoogtepunten van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd aan hoogtepunten raken. Moet worden ingesteld met highlightPreTag. De standaardinstelling is </em>.
highlightPreTag	string	Een string-tag die is voorafgegaan om hoogtepunten te raken. Moet worden ingesteld met highlightPostTag. Standaard is <em>.
minimumCoverage	number (double)	Een getal tussen 0 en 100 geeft het percentage van de index aan dat door een zoekopdracht moet worden gedekt om de zoekopdracht als succesvol te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 100.
orderby	string	De door komma's gescheiden lijst met OData $orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke uitdrukking kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardinstelling is oplopende volgorde. Gelijkspel wordt verbroken door de wedstrijdscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentovereenkomstscore. Er kunnen maximaal 32 $orderby clausules zijn.
queryType	QueryType	Een waarde die de syntaxis van de zoekopdracht aangeeft. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als voor uw query gebruikmaakt van de Lucene-querysyntaxis.
scoringParameters	string[]	De lijst met parameterwaarden die moeten worden gebruikt in scoringsfuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', zou de parametertekenreeks "mylocation--122.2,44.8" zijn (zonder de aanhalingstekens).
scoringProfile	string	De naam van een scoreprofiel om overeenkomstscores voor overeenkomende documenten te evalueren om de resultaten te sorteren.
scoringStatistics	ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. De standaardinstelling is 'lokaal'. Gebruik 'globaal' om scorestatistieken wereldwijd samen te voegen voordat u scoort. Het gebruik van algemene scorestatistieken kan de latentie van zoekopdrachten verhogen.
search	string	Een expressie voor een zoekopdracht in volledige tekst; Gebruik "*" of laat deze parameter weg om alle documenten te matchen.
searchFields	string	De door komma's gescheiden lijst met veldnamen waarnaar u de zoekopdracht in volledige tekst wilt uitvoeren. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op de veldnamen die in deze parameter worden vermeld.
searchMode	SearchMode	Een waarde die aangeeft of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen.
select	string	De door komma's gescheiden lijst met velden die u wilt ophalen. Als dit niet is opgegeven, worden alle velden opgenomen die in het schema zijn gemarkeerd als opvraagbaar.
semanticConfiguration	string	De naam van een semantische configuratie die wordt gebruikt bij het verwerken van documenten voor query's van het type semantisch.
semanticErrorHandling	SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is om de semantische verrijking te verwerken voordat de aanvraag mislukt.
semanticQuery	string	Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische herrangschikking, semantische bijschriften en semantische antwoorden. Is handig voor scenario's waarin het nodig is om verschillende query's te gebruiken tussen de fase voor het ophalen en rangschikken van de basis en de semantische fase van L2.
sessionId	string	Een waarde die kan worden gebruikt om een sticky sessie te maken, wat kan helpen om consistentere resultaten te krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Houd er rekening mee dat het herhaaldelijk hergebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen op replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die als sessionId wordt gebruikt, kan niet beginnen met een '_' teken.
skip	integer (int32)	Het aantal zoekresultaten dat u moet overslaan. Deze waarde mag niet groter zijn dan 100.000. Als u documenten in volgorde moet scannen, maar vanwege deze beperking geen skip kunt gebruiken, kunt u overwegen orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.
top	integer (int32)	Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paginering van zoekresultaten aan de clientzijde te implementeren. Als de resultaten worden afgekapt als gevolg van pagerijdbaarheid aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een nieuwe zoekopdracht uit te geven voor de volgende pagina met resultaten.
vectorFilterMode	VectorFilterMode	Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren. De standaardinstelling is 'preFilter' voor nieuwe indexen.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	De queryparameters voor vector- en hybride zoekquery's.

Antwoorden

Name	Type	Description
200 OK	SearchDocumentsResult	Reactie met documenten die voldoen aan de zoekcriteria.
Other Status Codes	SearchDocumentsResult	Antwoord met gedeeltelijke documenten die voldoen aan de zoekcriteria.
Other Status Codes	ErrorResponse	Foutreactie.

Voorbeelden

SearchIndexSearchDocumentsPost

SearchIndexSearchDocumentsSemanticPost

SearchIndexSearchDocumentsPost

Voorbeeldaanvraag

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"
}

Voorbeeldrespons

Statuscode:

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"
    }
  ]
}

Statuscode:

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

Voorbeeldaanvraag

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
}

Voorbeeldrespons

Statuscode:

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"
}

Statuscode:

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"
}

Definities

Name	Description
AnswerResult	Een antwoord is een tekstpassage die is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de zoekopdracht. Antwoorden worden geëxtraheerd uit de beste zoekresultaten. Antwoordkandidaten worden gescoord en de beste antwoorden worden geselecteerd.
CaptionResult	Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekopdracht. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type semantic.
DocumentDebugInfo	Bevat foutopsporingsinformatie die kan worden gebruikt om uw zoekresultaten verder te verkennen.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
QueryAnswerType	Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van de zoekopdracht.
QueryCaptionType	Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van de zoekopdracht.
QueryDebugMode	Schakelt een foutopsporingstool in die kan worden gebruikt om uw zoekresultaten verder te verkennen.
QueryResultDocumentSubscores	De uitsplitsing van subscores tussen de tekst- en vectorquerycomponenten van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde waarin ze zijn ontvangen.
QueryType	Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als voor uw query gebruikmaakt van de Lucene-querysyntaxis.
RawVectorQuery	De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een onbewerkte vectorwaarde is opgegeven.
ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. De standaardinstelling is 'lokaal'. Gebruik 'globaal' om scorestatistieken wereldwijd samen te voegen voordat u scoort. Het gebruik van algemene scorestatistieken kan de latentie van zoekopdrachten verhogen.
SearchDocumentsResult	Reactie met zoekresultaten uit een index.
SearchMode	Hiermee geeft u aan of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen.
SearchRequest	Parameters voor filteren, sorteren, facetteren, pagineren en ander zoekquerygedrag.
SearchResult	Bevat een document dat is gevonden door een zoekopdracht, plus bijbehorende metagegevens.
SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren.
SemanticErrorReason	Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek.
SemanticSearchResultsType	Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek.
SingleVectorFieldResult	Een enkel vectorveldresultaat. Zowel als @search.score vectorgelijkeniswaarden worden geretourneerd. Vectorgelijkenis is gerelateerd aan @search.score door een vergelijking.
TextResult	De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht.
VectorFilterMode	Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren.
VectorizableTextQuery	De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.
VectorQueryKind	Het soort vectorquery dat wordt uitgevoerd.
VectorsDebugInfo

AnswerResult

Object

Een antwoord is een tekstpassage die is geëxtraheerd uit de inhoud van de meest relevante documenten die overeenkomen met de zoekopdracht. Antwoorden worden geëxtraheerd uit de beste zoekresultaten. Antwoordkandidaten worden gescoord en de beste antwoorden worden geselecteerd.

Name	Type	Description
highlights	string	Dezelfde tekstpassage als in de eigenschap Tekst met gemarkeerde tekstzinnen die het meest relevant zijn voor de query.
key	string	De sleutel van het document waaruit het antwoord is geëxtraheerd.
score	number (double)	De scorewaarde geeft aan hoe relevant het antwoord is voor de query in vergelijking met andere antwoorden die voor de query zijn geretourneerd.
text	string	De tekstpassage die uit het document is geëxtraheerd, is het antwoord waard.

CaptionResult

Object

Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekopdracht. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type semantic.

Name	Type	Description
highlights	string	Dezelfde tekstpassage als in de eigenschap Tekst met gemarkeerde zinnen die het meest relevant zijn voor de query.
text	string	Een representatieve tekstpassage uit het document dat het meest relevant is voor de zoekopdracht.

DocumentDebugInfo

Object

Bevat foutopsporingsinformatie die kan worden gebruikt om uw zoekresultaten verder te verkennen.

Name	Type	Description
vectors	VectorsDebugInfo	Bevat foutopsporingsinformatie die specifiek is voor vector- en hybride zoekopdrachten.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

QueryAnswerType

Inventarisatie

Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van de zoekopdracht.

Waarde	Description
none	Geef geen antwoorden op de zoekopdracht.
extractive	Extraheert antwoorden van kandidaten uit de inhoud van de documenten die worden geretourneerd in antwoord op een vraag die als een vraag in natuurlijke taal is uitgedrukt.

QueryCaptionType

Inventarisatie

Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van de zoekopdracht.

Waarde	Description
none	Retourneer geen ondertiteling voor de zoekopdracht.
extractive	Extraheert bijschriften uit de overeenkomende documenten die passages bevatten die relevant zijn voor de zoekopdracht.

QueryDebugMode

Inventarisatie

Schakelt een foutopsporingstool in die kan worden gebruikt om uw zoekresultaten verder te verkennen.

Waarde	Description
disabled	Er wordt geen informatie over het opsporen van query's geretourneerd.
vector	Hiermee kan de gebruiker de resultaten van hybride en vectorquery's verder verkennen.

QueryResultDocumentSubscores

Object

De uitsplitsing van subscores tussen de tekst- en vectorquerycomponenten van de zoekquery voor dit document. Elke vectorquery wordt weergegeven als een afzonderlijk object in dezelfde volgorde waarin ze zijn ontvangen.

Name	Type	Description
documentBoost	number (double)	De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht.
text	TextResult	De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht.
vectors	<string,  SingleVectorFieldResult>	De vectorovereenkomst en @search.score -waarden voor elke vectorquery.

QueryType

Inventarisatie

Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als voor uw query gebruikmaakt van de Lucene-querysyntaxis.

Waarde	Description
simple	Gebruikt de eenvoudige querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van een eenvoudige zoektaal die symbolen zoals +, * en "" mogelijk maakt. Query's worden standaard geëvalueerd in alle doorzoekbare velden, tenzij de parameter searchFields is opgegeven.
full	Gebruikt de volledige syntaxis van de Lucene-query voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van de Lucene-querytaal die veldspecifieke en gewogen zoekopdrachten mogelijk maakt, evenals andere geavanceerde functies.
semantic	Het meest geschikt voor zoekopdrachten die worden uitgedrukt in natuurlijke taal in tegenstelling tot trefwoorden. Verbetert de precisie van zoekresultaten door de hoogste rangschikking van de belangrijkste zoekresultaten opnieuw te bepalen met behulp van een rangschikkingsmodel dat is getraind op het webcorpus.

RawVectorQuery

Object

De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een onbewerkte vectorwaarde is opgegeven.

Name	Type	Description
exhaustive	boolean	Als dit waar is, wordt een uitgebreide zoekopdracht naar de dichtstbijzijnde buur geactiveerd voor alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten van cruciaal belang zijn, zoals het bepalen van grondwaarheidswaarden.
fields	string	Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector.
k	integer (int32)	Aantal naaste buren dat terugkeert als tophits.
kind	string: vector	Het soort vectorquery dat wordt uitgevoerd.
oversampling	number (double)	Oversampling factor. Minimumwaarde is 1. Het overschrijft de parameter 'defaultOversampling' die is geconfigureerd in de indexdefinitie. Het kan alleen worden ingesteld als 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan als er een compressiemethode wordt gebruikt op het onderliggende vectorveld.
vector	number[] (float)	De vectorweergave van een zoekopdracht.
weight	number (float)	Relatief gewicht van de vectorzoekopdracht in vergelijking met andere vectorzoekopdrachten en/of de tekstquery binnen dezelfde zoekopdracht. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere ranglijsten die zijn geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die aan die zoekopdracht voldoen, in de uiteindelijke rangschikking komen te staan. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

ScoringStatistics

Inventarisatie

Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. De standaardinstelling is 'lokaal'. Gebruik 'globaal' om scorestatistieken wereldwijd samen te voegen voordat u scoort. Het gebruik van algemene scorestatistieken kan de latentie van zoekopdrachten verhogen.

Waarde	Description
local	De scorestatistieken worden lokaal berekend voor een lagere latentie.
global	De scorestatistieken worden wereldwijd berekend voor een consistentere score.

SearchDocumentsResult

Object

Reactie met zoekresultaten uit een index.

Name	Type	Description
@odata.count	integer (int64)	Het totale aantal resultaten dat door de zoekbewerking is gevonden, of null als de telling niet is aangevraagd. Indien aanwezig, kan het aantal groter zijn dan het aantal resultaten in deze respons. Dit kan gebeuren als u de parameters $top of $skip gebruikt, of als de query niet alle gevraagde documenten in één antwoord kan retourneren.
@odata.nextLink	string	Vervolg-URL wordt geretourneerd wanneer de query niet alle gevraagde resultaten in één antwoord kan retourneren. U kunt deze URL gebruiken om een andere GET- of POST-zoekopdracht te formuleren om het volgende deel van de zoekrespons op te halen. Zorg ervoor dat u hetzelfde werkwoord (GET of POST) gebruikt als het verzoek dat dit antwoord heeft opgeleverd.
@search.answers	AnswerResult[]	De resultaten van de antwoordenquery voor de zoekbewerking; NULL als de parameter voor de antwoordquery niet is opgegeven of is ingesteld op 'Geen'.
@search.coverage	number (double)	Een waarde die het percentage van de index aangeeft dat is opgenomen in de query, of null als minimumCoverage niet is opgegeven in de aanvraag.
@search.facets	object	De resultaten van de facetquery voor de zoekbewerking, georganiseerd als een verzameling buckets voor elk veld met facetten; Null als de query geen facetexpressies bevatte.
@search.nextPageParameters	SearchRequest	De JSON-payload voor voortzetting wordt geretourneerd wanneer de query niet alle gevraagde resultaten in één antwoord kan retourneren. U kunt deze JSON gebruiken @odata.nextLink om een andere POST-zoekopdracht te formuleren om het volgende deel van de zoekreactie op te halen.
@search.semanticPartialResponseReason	SemanticErrorReason	Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek.
@search.semanticPartialResponseType	SemanticSearchResultsType	Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek.
value	SearchResult[]	De volgorde van de resultaten die door de query worden geretourneerd.

SearchMode

Inventarisatie

Hiermee geeft u aan of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen.

Waarde	Description
any	Elk van de zoektermen moet overeenkomen om het document als een overeenkomst te tellen.
all	Alle zoektermen moeten overeenkomen om het document als een overeenkomst te tellen.

SearchRequest

Object

Parameters voor filteren, sorteren, facetteren, pagineren en ander zoekquerygedrag.

Name	Type	Description
answers	QueryAnswerType	Een waarde die aangeeft of antwoorden moeten worden geretourneerd als onderdeel van de zoekopdracht.
captions	QueryCaptionType	Een waarde die aangeeft of bijschriften moeten worden geretourneerd als onderdeel van de zoekopdracht.
count	boolean	Een waarde die aangeeft of het totale aantal resultaten moet worden opgehaald. De standaardwaarde is vals. Als u deze waarde instelt op waar, kan dit gevolgen hebben voor de prestaties. Merk op dat de geretourneerde telling een benadering is.
debug	QueryDebugMode	Schakelt een foutopsporingstool in die kan worden gebruikt om uw opnieuw gerangschikte resultaten verder te verkennen.
facets	string[]	De lijst met facetexpressies die op de zoekopdracht moeten worden toegepast. Elke facetexpressie bevat een veldnaam, eventueel gevolgd door een door komma's gescheiden lijst met name:value-paren.
filter	string	De OData $filter expressie die op de zoekquery moet worden toegepast.
highlight	string	De door komma's gescheiden lijst met veldnamen die moeten worden gebruikt voor hoogtepunten van treffers. Alleen doorzoekbare velden kunnen worden gebruikt voor het markeren van treffers.
highlightPostTag	string	Een tekenreekstag die wordt toegevoegd aan hoogtepunten raken. Moet worden ingesteld met highlightPreTag. De standaardinstelling is </em>.
highlightPreTag	string	Een string-tag die is voorafgegaan om hoogtepunten te raken. Moet worden ingesteld met highlightPostTag. Standaard is <em>.
minimumCoverage	number (double)	Een getal tussen 0 en 100 geeft het percentage van de index aan dat door een zoekopdracht moet worden gedekt om de zoekopdracht als succesvol te kunnen rapporteren. Deze parameter kan nuttig zijn om de beschikbaarheid van zoekopdrachten te garanderen, zelfs voor services met slechts één replica. De standaardwaarde is 100.
orderby	string	De door komma's gescheiden lijst met OData $orderby expressies waarop de resultaten moeten worden gesorteerd. Elke expressie kan een veldnaam zijn of een aanroep naar de functies geo.distance() of search.score(). Elke uitdrukking kan worden gevolgd door asc om oplopend aan te geven, of desc om aflopend aan te geven. De standaardinstelling is oplopende volgorde. Gelijkspel wordt verbroken door de wedstrijdscores van documenten. Als er geen $orderby is opgegeven, is de standaardsorteervolgorde aflopend op documentovereenkomstscore. Er kunnen maximaal 32 $orderby clausules zijn.
queryType	QueryType	Een waarde die de syntaxis van de zoekopdracht aangeeft. De standaardinstelling is 'eenvoudig'. Gebruik 'full' als voor uw query gebruikmaakt van de Lucene-querysyntaxis.
scoringParameters	string[]	De lijst met parameterwaarden die moeten worden gebruikt in scoringsfuncties (bijvoorbeeld referencePointParameter) met behulp van de notatie name-values. Als het scoreprofiel bijvoorbeeld een functie definieert met een parameter met de naam 'mylocation', zou de parametertekenreeks "mylocation--122.2,44.8" zijn (zonder de aanhalingstekens).
scoringProfile	string	De naam van een scoreprofiel om overeenkomstscores voor overeenkomende documenten te evalueren om de resultaten te sorteren.
scoringStatistics	ScoringStatistics	Een waarde die aangeeft of we scorestatistieken (zoals documentfrequentie) wereldwijd willen berekenen voor een consistentere score, of lokaal, voor een lagere latentie. De standaardinstelling is 'lokaal'. Gebruik 'globaal' om scorestatistieken wereldwijd samen te voegen voordat u scoort. Het gebruik van algemene scorestatistieken kan de latentie van zoekopdrachten verhogen.
search	string	Een expressie voor een zoekopdracht in volledige tekst; Gebruik "*" of laat deze parameter weg om alle documenten te matchen.
searchFields	string	De door komma's gescheiden lijst met veldnamen waarnaar u de zoekopdracht in volledige tekst wilt uitvoeren. Wanneer u een veldzoekopdracht (fieldName:searchExpression) gebruikt in een volledige Lucene-query, hebben de veldnamen van elke veldzoekexpressie voorrang op de veldnamen die in deze parameter worden vermeld.
searchMode	SearchMode	Een waarde die aangeeft of een of meer van de zoektermen moeten overeenkomen om het document als een overeenkomst te tellen.
select	string	De door komma's gescheiden lijst met velden die u wilt ophalen. Als dit niet is opgegeven, worden alle velden opgenomen die in het schema zijn gemarkeerd als opvraagbaar.
semanticConfiguration	string	De naam van een semantische configuratie die wordt gebruikt bij het verwerken van documenten voor query's van het type semantisch.
semanticErrorHandling	SemanticErrorMode	Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren.
semanticMaxWaitInMilliseconds	integer (int32) minimum: 700	Hiermee kan de gebruiker een bovengrens instellen voor de hoeveelheid tijd die nodig is om de semantische verrijking te verwerken voordat de aanvraag mislukt.
semanticQuery	string	Hiermee kunt u een afzonderlijke zoekquery instellen die uitsluitend wordt gebruikt voor semantische herrangschikking, semantische bijschriften en semantische antwoorden. Is handig voor scenario's waarin het nodig is om verschillende query's te gebruiken tussen de fase voor het ophalen en rangschikken van de basis en de semantische fase van L2.
sessionId	string	Een waarde die kan worden gebruikt om een sticky sessie te maken, wat kan helpen om consistentere resultaten te krijgen. Zolang dezelfde sessionId wordt gebruikt, wordt er een poging gedaan om dezelfde replicaset te targeten. Houd er rekening mee dat het herhaaldelijk hergebruiken van dezelfde sessionID-waarden de taakverdeling van de aanvragen op replica's kan verstoren en de prestaties van de zoekservice nadelig kan beïnvloeden. De waarde die als sessionId wordt gebruikt, kan niet beginnen met een '_' teken.
skip	integer (int32)	Het aantal zoekresultaten dat u moet overslaan. Deze waarde mag niet groter zijn dan 100.000. Als u documenten in volgorde moet scannen, maar vanwege deze beperking geen skip kunt gebruiken, kunt u overwegen orderby te gebruiken op een volledig geordende sleutel en in plaats daarvan te filteren met een bereikquery.
top	integer (int32)	Het aantal zoekresultaten dat moet worden opgehaald. Dit kan worden gebruikt in combinatie met $skip om paginering van zoekresultaten aan de clientzijde te implementeren. Als de resultaten worden afgekapt als gevolg van pagerijdbaarheid aan de serverzijde, bevat het antwoord een vervolgtoken dat kan worden gebruikt om een nieuwe zoekopdracht uit te geven voor de volgende pagina met resultaten.
vectorFilterMode	VectorFilterMode	Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren. De standaardinstelling is 'preFilter' voor nieuwe indexen.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	De queryparameters voor vector- en hybride zoekquery's.

SearchResult

Object

Bevat een document dat is gevonden door een zoekopdracht, plus bijbehorende metagegevens.

Name	Type	Description
@search.captions	CaptionResult[]	Bijschriften zijn de meest representatieve passages uit het document ten opzichte van de zoekopdracht. Ze worden vaak gebruikt als documentsamenvatting. Bijschriften worden alleen geretourneerd voor query's van het type 'semantisch'.
@search.documentDebugInfo	DocumentDebugInfo	Bevat foutopsporingsinformatie die kan worden gebruikt om uw zoekresultaten verder te verkennen.
@search.highlights	object	Tekstfragmenten uit het document die de overeenkomende zoektermen aangeven, geordend op elk toepasselijk veld; Null als het markeren van treffers niet is ingeschakeld voor de query.
@search.rerankerBoostedScore	number (double)	De relevantiescore die wordt berekend door de Reranker Score te verhogen. Zoekresultaten worden gesorteerd op de RerankerScore/RerankerBoostedScore op basis van useScoringProfileBoostedRanking in de semantische config. RerankerBoostedScore wordt alleen geretourneerd voor query's van het type 'semantisch'
@search.rerankerScore	number (double)	De relevantiescore die wordt berekend door de semantische rangschikker voor de beste zoekresultaten. Zoekresultaten worden eerst gesorteerd op de RerankerScore en vervolgens op de Score. RerankerScore wordt alleen geretourneerd voor query's van het type 'semantisch'.
@search.score	number (double)	De relevantiescore van het document in vergelijking met andere documenten die door de query worden geretourneerd.

SemanticErrorMode

Inventarisatie

Hiermee kan de gebruiker kiezen of een semantische aanroep volledig moet mislukken (standaard / huidig gedrag) of om gedeeltelijke resultaten te retourneren.

Waarde	Description
partial	Als de semantische verwerking mislukt, worden gedeeltelijke resultaten nog steeds geretourneerd. De definitie van gedeeltelijke resultaten hangt af van welke semantische stap mislukte en wat de reden voor mislukking was.
fail	Als er een uitzondering is tijdens de semantische verwerkingsstap, mislukt de query en wordt de juiste HTTP-code geretourneerd, afhankelijk van de fout.

SemanticErrorReason

Inventarisatie

Reden dat een gedeeltelijk antwoord is geretourneerd voor een semantisch rangschikkingsverzoek.

Waarde	Description
maxWaitExceeded	Als semanticMaxWaitInMilliseconds was ingesteld en de semantische verwerkingsduur die waarde overschreed. Alleen de basisresultaten werden geretourneerd.
capacityOverloaded	Het verzoek werd gesmoord. Alleen de basisresultaten werden geretourneerd.
transient	Ten minste één stap van het semantische proces is mislukt.

SemanticSearchResultsType

Inventarisatie

Type gedeeltelijk antwoord dat is geretourneerd voor een semantisch rangschikkingsverzoek.

Waarde	Description
baseResults	Resultaten zonder enige semantische verrijking of herrangschikking.
rerankedResults	De resultaten zijn opnieuw gerangschikt met het herindelingsmodel en bevatten semantische bijschriften. Ze bevatten geen antwoorden, hoogtepunten van antwoorden of hoogtepunten van ondertiteling.

SingleVectorFieldResult

Object

Een enkel vectorveldresultaat. Zowel als @search.score vectorgelijkeniswaarden worden geretourneerd. Vectorgelijkenis is gerelateerd aan @search.score door een vergelijking.

Name	Type	Description
searchScore	number (double)	De @search.score waarde die wordt berekend op basis van de vectorgelijkenisscore. Dit is de score die zichtbaar is in een pure single-field single-vector query.
vectorSimilarity	number (double)	De vectorgelijkenisscore voor dit document. Merk op dat dit de canonieke definitie van gelijkenismetriek is, niet de 'afstand'-versie. Bijvoorbeeld cosinusovereenkomst in plaats van cosinusafstand.

TextResult

Object

De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht.

Name	Type	Description
searchScore	number (double)	De BM25- of Classic-score voor het tekstgedeelte van de zoekopdracht.

VectorFilterMode

Inventarisatie

Bepaalt of filters al dan niet worden toegepast voor of na het zoeken naar vectoren.

Waarde	Description
postFilter	Het filter wordt toegepast nadat de kandidaat-set vectorresultaten is geretourneerd. Afhankelijk van de filterselectiviteit kan dit resulteren in minder resultaten dan gevraagd door de parameter 'k'.
preFilter	Het filter wordt toegepast vóór de zoekopdracht.

VectorizableTextQuery

Object

De queryparameters die moeten worden gebruikt voor het zoeken naar vectoren wanneer een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.

Name	Type	Description
exhaustive	boolean	Als dit waar is, wordt een uitgebreide zoekopdracht naar de dichtstbijzijnde buur geactiveerd voor alle vectoren binnen de vectorindex. Handig voor scenario's waarin exacte overeenkomsten van cruciaal belang zijn, zoals het bepalen van grondwaarheidswaarden.
fields	string	Vectorvelden van het type Collection(Edm.Single) die moeten worden opgenomen in de gezochte vector.
k	integer (int32)	Aantal naaste buren dat terugkeert als tophits.
kind	string: text	Het soort vectorquery dat wordt uitgevoerd.
oversampling	number (double)	Oversampling factor. Minimumwaarde is 1. Het overschrijft de parameter 'defaultOversampling' die is geconfigureerd in de indexdefinitie. Het kan alleen worden ingesteld als 'rerankWithOriginalVectors' waar is. Deze parameter is alleen toegestaan als er een compressiemethode wordt gebruikt op het onderliggende vectorveld.
text	string	De tekst die moet worden gevectoriseerd om een vectorzoekopdracht uit te voeren.
weight	number (float)	Relatief gewicht van de vectorzoekopdracht in vergelijking met andere vectorzoekopdrachten en/of de tekstquery binnen dezelfde zoekopdracht. Deze waarde wordt gebruikt bij het combineren van de resultaten van meerdere ranglijsten die zijn geproduceerd door de verschillende vectorquery's en/of de resultaten die zijn opgehaald via de tekstquery. Hoe hoger het gewicht, hoe hoger de documenten die aan die zoekopdracht voldoen, in de uiteindelijke rangschikking komen te staan. De standaardwaarde is 1,0 en de waarde moet een positief getal zijn dat groter is dan nul.

VectorQueryKind

Inventarisatie

Het soort vectorquery dat wordt uitgevoerd.

Waarde	Description
vector	Vectorquery waarbij een onbewerkte vectorwaarde wordt opgegeven.
text	Vectorquery waarbij een tekstwaarde wordt opgegeven die moet worden gevectoriseerd.

VectorsDebugInfo

Object

Name	Type	Description
subscores	QueryResultDocumentSubscores	De uitsplitsing van subscores van het document voorafgaand aan de gekozen resultatenset fusie-/combinatiemethode zoals RRF.