Pular para o conteúdo principal

vector-search-indexes grupo de comando

nota

Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.

Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.

O grupo de comandos vector-search-indexes dentro do Databricks CLI contém comandos para gerenciar índices de pesquisa vetorial. Um índice de pesquisa vetorial é uma representação eficiente dos seus vetores de incorporação que suporta consultas de pesquisa em tempo real e de vizinho mais próximo aproximado (redes neurais artificiais (ANN)). Consulte Como criar e consultar um índice de pesquisa vetorial.

índices de pesquisa vetorial databricks create-index

Crie um novo índice.

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

Argumentos

NAME

Nome do índice

ENDPOINT_NAME

Nome do e endpoint e a ser utilizado para servir o índice

PRIMARY_KEY

key e primário do índice

INDEX_TYPE

Existem dois tipos de índices de pesquisa vetorial: Delta sync (um índice que sincroniza automaticamente com uma tabela Delta de origem) ou acesso direto (um índice que suporta leitura e gravação diretas de vetores e metadados). Valores suportados: DELTA_SYNC, DIRECT_ACCESS

Opções

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Exemplos

O exemplo a seguir cria um novo índice Delta Sync:

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

O exemplo a seguir cria um novo índice de acesso direto:

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

índices de pesquisa vetorial do databricks delete-data-vector-index

Exclua dados do índice.

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

Argumentos

INDEX_NAME

Nome do índice vetorial em que os dados devem ser excluídos. Deve ser um Índice de Acesso Vetorial Direto.

Opções

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Exemplos

O exemplo a seguir exclui dados de um índice do Direct Vector Access:

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

índices de pesquisa vetorial do databricks delete-index

Exclua um índice.

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

Argumentos

INDEX_NAME

Nome do índice

Opções

Bandeiras globais

Exemplos

O exemplo a seguir exclui um índice de pesquisa vetorial:

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

índices de pesquisa vetorial do databricks get-index

Obtenha um índice.

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

Argumentos

INDEX_NAME

Nome do índice

Opções

Bandeiras globais

Exemplos

O exemplo a seguir obtém detalhes de um índice de pesquisa vetorial:

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

índices de pesquisa vetorial databricks índices de lista

Listar índices.

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

Argumentos

ENDPOINT_NAME

Nome do endpoint

Opções

--page-token string

tokens para paginação

Bandeiras globais

Exemplos

O exemplo a seguir lista todos os índices em um banco de dados de diretório ( endpoint):

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

O exemplo a seguir lista índices usando paginação:

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

índice de consulta de índices de pesquisa vetorial do databricks

Consulte um índice.

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

Argumentos

INDEX_NAME

Nome do índice vetorial a ser consultado

Opções

--filters-json string

JSON cadeias de caracteres que representam filtros de consulta

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

--num-results int

Número de resultados a serem retornados

--query-text string

Texto da consulta

--query-type string

O tipo de consulta a ser usado

--score-threshold float

limite para a pesquisa aproximada do vizinho mais próximo

Bandeiras globais

Exemplos

O exemplo a seguir consulta um índice com texto:

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

O exemplo a seguir consulta um índice com filtros:

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

consulta de índices de pesquisa vetorial do databricks na próxima página

Consulte a próxima página.

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

Argumentos

INDEX_NAME

Nome do índice vetorial a ser consultado

Opções

--endpoint-name string

Nome do endpoint

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

--page-token string

Tokens de página retornados do QueryVectorIndex ou QueryVectorIndexNextPage anterior API

Bandeiras globais

Exemplos

O exemplo a seguir consulta a próxima página de resultados:

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

índices de pesquisa vetorial databricks índice de varredura

Escaneie um índice.

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

Argumentos

INDEX_NAME

Nome do índice vetorial a ser escaneado

Opções

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

--last-primary-key string

key e primário da última entrada retornada na verificação anterior

--num-results int

Número de resultados a serem retornados

Bandeiras globais

Exemplos

O exemplo a seguir verifica um índice:

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

O exemplo a seguir verifica um índice a partir de um key específico:

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

índice de sincronização de índices de pesquisa vetorial do databricks

Sincronize um índice.

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

Argumentos

INDEX_NAME

Nome do índice vetorial a ser sincronizado. Deve ser um Índice de Sincronização Delta.

Opções

Bandeiras globais

Exemplos

O exemplo a seguir aciona a sincronização para um índice Delta Sync:

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

índices de pesquisa vetorial databricks upsert-data-vector-index

Insira os dados em um índice.

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

Argumentos

INDEX_NAME

Nome do índice vetorial em que os dados devem ser invertidos. Deve ser um Índice de Acesso Vetorial Direto.

INPUTS_JSON

JSON strings representando os dados a serem inseridos ou atualizados

Opções

--json JSON

As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.

Bandeiras globais

Exemplos

O exemplo a seguir insere os dados em um índice do Direct Vector Access:

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

Bandeiras globais

--debug

Se deve habilitar o registro de depuração.

-h ou --help

Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.

--log-file string

Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.

--log-format Formato

O tipo de formato do log, text ou json. O valor de default é text.

--log-level string

Uma string que representa o nível de formato do log. Se não for especificado, o nível de formato do log será desativado.

-o, --output Tipo

O tipo de saída do comando, text ou json. O valor de default é text.

-p, --profile string

O nome do perfil no arquivo ~/.databrickscfg a ser utilizado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil chamado DEFAULT será usado.

--progress-format Formato

O formato para exibir o progresso logs: default, append, inplace ou json

-t, --target string

Se aplicável, o destino do pacote a ser usado