Volledige-tekstzoekopdracht in Azure DocumentDB

De volledige-tekstzoekfunctie van Azure DocumentDB is een met BM25 gescoorde, analysegestuurde zoekmachine die beschikbaar is via MongoDB-compatibele primitieven. Het rangschikt resultaten op relevantie, tolereert typefouten van gebruikers en combineert tekst die overeenkomt met gestructureerde voorwaarden zonder een afzonderlijk zoekcluster. Aangepaste analyzers ondersteunen overeenkomende voorvoegsels, hiërarchische id's en taalspecifieke analyse.

Schakel zoeken in volledige tekst in op uw Azure DocumentDB-cluster voordat u zoekindexen maakt of $search-query's uitvoert. Kies één van de volgende methoden.

Azure portal

  1. Meld u aan bij de Azure-portal en open uw Azure DocumentDB-cluster.
  2. Selecteer onder InstellingenFuncties.
  3. Selecteer Zoeken in volledige tekst, waarvan de status in eerste instantie is ingesteld op Uit.
  4. Controleer de functiegegevens in het deelvenster dat aan de rechterkant wordt geopend en selecteer vervolgens Inschakelen.

Azure CLI

Voer de volgende opdracht uit in Bash met Azure CLI geïnstalleerd. Vervang de tijdelijke aanduidingen voor de resource-id door de waarden van uw cluster. De PATCH-opdracht behoudt de preview-functies die van het cluster worden gelezen en bevat FullTextSearch precies één keer.

set -euo pipefail

az login

RESOURCE_ID="/subscriptions/<subscription-id>/resourceGroups/<resource-group>/providers/Microsoft.DocumentDB/mongoClusters/<cluster-name>"
URL="https://management.azure.com${RESOURCE_ID}?api-version=2024-07-01"

# Review the current provisioning state and preview features.
az rest --method get --url "$URL" \
  --query '{state:properties.provisioningState,features:properties.previewFeatures}' \
  --output json

# Preserve other preview features and add FullTextSearch exactly once.
BODY=$(az rest --method get --url "$URL" \
  --query '{properties: {previewFeatures: [properties.previewFeatures[?@ != `"FullTextSearch"`] || `[]`, [`"FullTextSearch"`]][]}}' \
  --output json)

az rest --method patch --url "$URL" --body "$BODY"

# Check the updated configuration.
az rest --method get --url "$URL" \
  --query '{state:properties.provisioningState,features:properties.previewFeatures}' \
  --output json

Terraform

Voor een bestaand cluster gebruikt u de AzAPI-provider om properties.previewFeatures bij te werken zonder het cluster opnieuw te maken. In het volgende voorbeeld wordt AzAPI 2.x gebruikt en wordt de huidige lijst gelezen voordat FullTextSearch wordt toegevoegd.

terraform {
  required_providers {
    azapi = {
      source  = "Azure/azapi"
      version = "~> 2.0"
    }
  }
}

provider "azapi" {}

variable "cluster_resource_id" {
  type        = string
  description = "The resource ID of the existing Azure DocumentDB cluster."
}

data "azapi_resource" "cluster" {
  type        = "Microsoft.DocumentDB/mongoClusters@2024-07-01"
  resource_id = var.cluster_resource_id

  response_export_values = {
    preview_features = "properties.previewFeatures || `[]`"
  }
}

resource "azapi_update_resource" "full_text_search" {
  type        = "Microsoft.DocumentDB/mongoClusters@2024-07-01"
  resource_id = var.cluster_resource_id

  body = {
    properties = {
      previewFeatures = distinct(concat(
        data.azapi_resource.cluster.output.preview_features,
        ["FullTextSearch"]
      ))
    }
  }
}

Stel deze cluster_resource_id in op de resource-id van uw cluster. Voer terraform init uit, controleer terraform plan en voer vervolgens terraform apply uit.

Als een andere Terraform-resource het cluster beheert, moet u ervoor zorgen dat die deze eigenschap niet ook beheert. Voor een azurerm_mongo_cluster resource voegt u preview_features toe aan de lifecycle.ignore_changes-lijst wanneer AzAPI eigenaar is van de eigenschap. Controleer het plan en ga niet verder als daarin wordt voorgesteld het cluster te vervangen.

Bicep

Werk de sjabloon bij waarmee uw cluster wordt beheerd. Voeg een arrayparameter toe met elke andere preview-functie die u wilt behouden:

param otherPreviewFeatures array = []

Stel in het properties object van uw bestaande Microsoft.DocumentDB/mongoClusters resource het volgende in:

previewFeatures: union(otherPreviewFeatures, [
  'FullTextSearch'
])

Houd de andere resource-eigenschappen van het cluster ongewijzigd. Dit is een eigenschapsfragment, geen zelfstandige sjabloon. Bicep vervangt de preview-functielijst door de opgegeven lijst. Bicep leest en voegt bestaande functies niet automatisch samen.

Controleer de implementatie met az deployment group what-ifen implementeer vervolgens uw bijgewerkte sjabloon met az deployment group create.

Important

Nadat u zoeken in volledige tekst met een willekeurige methode hebt ingeschakeld, wacht u tien minuten voordat u een zoekindex maakt of een query uitvoert. Als u FullTextSearch in de resourceconfiguratie ziet, betekent dit niet dat de activering is voltooid.

Wat vandaag beschikbaar is

Capability Operator of primitief
BM25-trefwoordzoekopdracht $search + text
Fuzzy (typo-tolerante) zoekfunctie $search + text met fuzzy.maxEdits
Zoeken op woordgroepen en nabijheidszoekopdrachten $search + phrase + slop
Zoeken naar voorvoegsels Aangepaste analyse met een edgeGram tokenizer of tokenfilter
Zoeken op hiërarchische id's Aangepaste analyzer met een pathHierarchy tokenizer
Aangepaste tekstanalyse Geordende tokenizer- en tokenfilterpijplijnen voor normalisatie, stemming, stopwoorden en patroonverwerking
Taalspecifieke analyse Chinese, Japanse, Koreaanse en Thaise analyzers en tokenizers
Zoeken naar identificatoren in meerdere velden Eén index met meerdere mappings.fields vermeldingen en expliciete querypaden
Alternatieve analyse van hetzelfde veld Benoemde multi toewijzingen
Gestructureerd zoeken en zoeken naar tekst token, date, number en boolean mappingen met equals, range, exists, in en compound
Inline sorteren en ophalen van top-N $search.sort op gemapte scalaire velden en downstream $limit-pushdown
Hybride trefwoord- en vectorzoekopdrachten Afzonderlijke trefwoord- en cosmosSearch zoekopdrachten gecombineerd met RRF

Huidige beperkingen

De volgende mogelijkheden worden momenteel niet ondersteund:

  • Dynamische toewijzingen, dynamische typesets, tekenfilters, synoniemdefinities en storedSource.
  • compound.minimumShouldMatch en aangepaste score boosts.
  • De autocomplete, queryStringen near operators.
  • De regex en wildcard operators binnen $search worden niet ondersteund.
  • De $searchMeta fase, $$SEARCH_META variabele, aantallen, facetten en markeringen.
  • De typen toewijzing objectId, uuid, embeddedDocument, autocomplete en geo.

Gebruik de RRF-voorbeelden aan de clientzijde of aggregatiepijplijn in hybride zoekopdrachten om trefwoorden en vectorresultaten te fuseren. De $rankFusion stage wordt momenteel niet ondersteund.

Zie voor de servicebrede naslaginformatie, inclusief levenscyclusbeperkingen voor zoekindexen, Beperkingen van zoeken in volledige tekst.

Hoe Azure DocumentDB volledige-tekstzoekopdracht werkt

Een zoekindex in Azure DocumentDB staat los van een documentindex. U maakt deze met de createSearchIndexes databaseopdracht, niet met createIndexes en niet met db.<coll>.createIndex({ field: "text" }) en een "textSearch" sleuteltype. De indexdefinitie declareert welke velden doorzoekbaar zijn, de bijbehorende typen en de analysepijplijn die wordt gebruikt tijdens indextijd en querytijd.

Query's worden uitgevoerd als de eerste fase van een aggregatiepijplijn met behulp van de $search operator. De engine retourneert standaard documenten die zijn gerangschikt op relevantie, die u in een downstreamfase $project kunt doorlezen{ $meta: "searchScore" }. Gebruik inline sort om resultaten in plaats daarvan te ordenen op geïndexeerde scalaire velden. In deze sectie wordt gebruikgemaakt van mongosh-achtige MongoDB Shell-syntaxis, maar dezelfde bewerkingen werken ook met elk MongoDB-compatibel stuurprogramma.

Vier regels zijn van toepassing op elke Azure DocumentDB-query voor zoeken in volledige tekst:

  • Geef een index op naam op met index: "<name>" binnenin $search. Als u dit weglaat, is de query gericht op een index met de naam default; er wordt geen willekeurige index gekozen. Elk querypad moet aanwezig zijn in de geselecteerde index.
  • $search is altijd de eerste fase van een aggregatiepijplijn, zodat de zoekindex de kandidaat-set beperkt voordat een andere operator wordt uitgevoerd.
  • Er is geen count- of limit-veld binnen $search. Beperk resultaten met een downstream { $limit: N }-fase.
  • Tekst en gestructureerde voorwaarden combineren met compound. Gebruik equals, range, en existsin op toegewezen scalaire velden. Voor voorwaarden die een downstream $matchnodig hebben, past u deze toe vóór de laatste $limit , zodat de limiet van toepassing is op in aanmerking komende resultaten.

Het instellen van dynamic: false of het weglaten van dynamic gebruikt statische toewijzingen. Elk doorzoekbaar veld moet expliciet worden gedeclareerd onder mappings.fields. Als u de instelling dynamic: true instelt, mislukt het maken van een index met mappings.dynamic is not supported in search indexes yet.. Het maken van een index mislukt ook als mappings.fields ontbreekt of leeg is.

Eén zoekindex kan meerdere tekst-, id-, numerieke, datum-, Booleaanse en geneste documentvelden omvatten.

Mode Geschikt voor Zoekindex vereist Gerangschikt op BM25
$regex Patroonkoppeling op basis van veldwaarden zonder rangschikking op relevantie. Prestaties zijn afhankelijk van het patroon en de beschikbare indexen. No No
$search + text Standaard trefwoordzoekopdracht op proza, beschrijvingen, titels. Yes Yes
$search + text + fuzzy Zoeken tijdens het typen, gebruikersgerichte catalogus- of logboekzoekopdrachten waarbij typefouten gebruikelijk zijn. Yes Yes
$search + phrase Productnamen met meerdere woorden, gebruikersinvoer tussen aanhalingstekens, fouttekenreeksen waar woordvolgorde van belang is. Yes Yes
Aangepaste analyzer + text Zoekacties voor voorvoegsels, hiërarchische id's, genormaliseerde tekst en taalspecifieke analyse. Yes Yes
$search + compound Tekst ophalen met exacte categorie-, beschikbaarheids-, numerieke of datumvoorwaarden in één query. Yes Tekstfragmenten dragen bij aan de relevantie
Hybride (BM25 + vector) Catalogus- of knowledge base-zoekopdrachten die query's in natuurlijke taal combineren met exacte id's; RAG ophalen. Ja (BM25 + vector) Gecombineerde score

Volledige-tekstzoekopdrachten en tekstindexen

De $text operator en { field: "text" } indexen zijn algemeen beschikbaar. Zoeken met volledige tekst maakt gebruik van afzonderlijke zoekindexen en $search query’s en blijft als preview beschikbaar. Als u het voorbeeld inschakelt, worden bestaande tekstindexen of $text query's niet gewijzigd.

Als u een voorbeeld van zoeken in volledige tekst wilt evalueren, maakt u een afzonderlijke zoekindex en gebruikt u $search query's. U hoeft geen bestaande $text workloads te migreren om de preview te evalueren.