Dela via


vector-search-indexes kommandogrupp

Note

Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The vector-search-indexes command group within the Databricks CLI contains commands to manage vector search indexes. Ett vektorsökningsindex är en effektiv representation av dina inbäddningsvektorer som stöder realtidsfrågor och ungefärliga ann-sökfrågor (närmaste granne). Se Hur du skapar och söker i ett vektorsökningsindex.

databricks vector-search-indexes create-index

Skapa ett nytt index.

databricks vector-search-indexes create-index NAME ENDPOINT_NAME PRIMARY_KEY INDEX_TYPE [flags]

Arguments

NAME

    Indexets namn

ENDPOINT_NAME

    Namnet på slutpunkten som ska användas för att hantera indexet

PRIMARY_KEY

    Primärnyckel för indexet

INDEX_TYPE

    Det finns två typer av Vector Search-index, Delta-synkronisering (ett index som automatiskt synkroniseras med en deltatabell för källa) eller direktåtkomst (ett index som stöder direkt läsning och skrivning av vektorer och metadata). Värden som stöds: DELTA_SYNC, DIRECT_ACCESS

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

Examples

I följande exempel skapas ett nytt Delta Sync-index:

databricks vector-search-indexes create-index my-index my-endpoint id DELTA_SYNC

I följande exempel skapas ett nytt Direct Access-index:

databricks vector-search-indexes create-index my-index my-endpoint id DIRECT_ACCESS

databricks vector-search-indexes delete-data-vector-index

Ta bort data från index.

databricks vector-search-indexes delete-data-vector-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Namnet på vektorindexet där data ska tas bort. Måste vara ett direktvektoråtkomstindex.

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

Examples

I följande exempel tas data bort från ett Direct Vector Access-index:

databricks vector-search-indexes delete-data-vector-index my-index --json '{"primary_keys": ["key1", "key2"]}'

databricks vector-search-indexes delete-index

Ta bort ett index.

databricks vector-search-indexes delete-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Indexets namn

Options

Global flags

Examples

I följande exempel tas ett vektorsökningsindex bort:

databricks vector-search-indexes delete-index my-index

databricks vector-search-indexes get-index

Hämta ett index.

databricks vector-search-indexes get-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Indexets namn

Options

Global flags

Examples

I följande exempel hämtas information om ett vektorsökningsindex:

databricks vector-search-indexes get-index my-index

databricks vector-search-indexes list-indexes

List indexes.

databricks vector-search-indexes list-indexes ENDPOINT_NAME [flags]

Arguments

ENDPOINT_NAME

    Namnet på slutpunkten

Options

--page-token string

    Token för sidnumrering

Global flags

Examples

I följande exempel visas alla index i en slutpunkt:

databricks vector-search-indexes list-indexes my-endpoint

I följande exempel visas index med sidnumrering:

databricks vector-search-indexes list-indexes my-endpoint --page-token next-page-token

databricks vector-search-indexes query-index

Fråga ett index.

databricks vector-search-indexes query-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Namnet på det vektorindex som ska frågas

Options

--filters-json string

    JSON-sträng som representerar frågefilter

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

--num-results int

    Antal resultat som ska returneras

--query-text string

    Query text

--query-type string

    Frågetypen som ska användas

--score-threshold float

    Tröskelvärde för den ungefärliga närmsta grannsökningen

Global flags

Examples

I följande exempel efterfrågas ett index med text:

databricks vector-search-indexes query-index my-index --query-text "search term" --num-results 10

I följande exempel efterfrågas ett index med filter:

databricks vector-search-indexes query-index my-index --query-text "search term" --filters-json '{"category": "product"}' --num-results 5

databricks vector-search-indexes query-next-page

Fråga nästa sida.

databricks vector-search-indexes query-next-page INDEX_NAME [flags]

Arguments

INDEX_NAME

    Namnet på det vektorindex som ska frågas

Options

--endpoint-name string

    Namnet på slutpunkten

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

--page-token string

    Sidtoken som returnerades från tidigare QueryVectorIndex eller QueryVectorIndexNextPage API

Global flags

Examples

Följande exempel frågar nästa sida med resultat:

databricks vector-search-indexes query-next-page my-index --endpoint-name my-endpoint --page-token "next-page-token"

databricks vector-search-indexes scan-index

Skanna ett index.

databricks vector-search-indexes scan-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Namnet på vektorindexet som ska genomsökas

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

--last-primary-key string

    Primärnyckel för den senaste posten som returnerades i föregående genomsökning

--num-results int

    Antal resultat som ska returneras

Global flags

Examples

I följande exempel genomsöks ett index:

databricks vector-search-indexes scan-index my-index --num-results 100

I följande exempel genomsöks ett index med början från en specifik nyckel:

databricks vector-search-indexes scan-index my-index --last-primary-key "key123" --num-results 100

databricks vector-search-indexes sync-index

Synkronisera ett index.

databricks vector-search-indexes sync-index INDEX_NAME [flags]

Arguments

INDEX_NAME

    Namnet på det vektorindex som ska synkroniseras. Måste vara ett Delta Sync-index.

Options

Global flags

Examples

I följande exempel utlöses synkronisering för ett Delta Sync-index:

databricks vector-search-indexes sync-index my-delta-sync-index

databricks vector-search-indexes upsert-data-vector-index

Upsert-data till ett index.

databricks vector-search-indexes upsert-data-vector-index INDEX_NAME INPUTS_JSON [flags]

Arguments

INDEX_NAME

    Namnet på vektorindexet där data ska uppdateras. Måste vara ett direktvektoråtkomstindex.

INPUTS_JSON

    JSON-sträng som representerar de data som ska upserted

Options

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

Examples

I följande exempel övergår data till ett Direct Vector Access-index:

databricks vector-search-indexes upsert-data-vector-index my-index '{"vectors": [{"id": "1", "vector": [0.1, 0.2, 0.3], "metadata": {"title": "Document 1"}}]}'

Global flags

--debug

  Om felsökningsloggning ska aktiveras.

-h eller --help

    Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.

--log-file sträng

    En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.

--log-format format

    Loggformattypen eller textjson. Standardvärdet är text.

--log-level sträng

    En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.

-o, --output typ

    Kommandots utdatatyp, text eller json. Standardvärdet är text.

-p, --profile sträng

    Namnet på profilen i filen som ~/.databrickscfg ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.

--progress-format format

    Formatet för att visa förloppsloggar: default, append, inplaceeller json

-t, --target sträng

    Om tillämpligt, paketmålet som ska användas