Pular para o conteúdo principal

grupo de comandoai-search

nota

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer disposições de Dados de Uso.

O grupo de comandos ai-search dentro da CLI do Databricks contém comandos para gerenciar Endpoint e índices de Pesquisa de AI. Um Endpoint de Pesquisa de AI representa os recursos de compute para hospedar índices de Pesquisa de AI. Consulte Pesquisa de AI.

databricks ai-search create-endpoint

Crie um Endpoint de AI Search.

databricks ai-search create-endpoint PARENT ENDPOINT_TYPE [flags]

Argumentos

PARENT

O workspace onde este endpoint será criado. Formato: workspaces/{workspace_id}

ENDPOINT_TYPE

Tipo de endpoint. Valores suportados: STANDARD, STORAGE_OPTIMIZED

Opções

--budget-policy-id string

O ID da política de orçamento selecionado pelo usuário para o endpoint.

--endpoint-id string

O nome curto fornecido pelo usuário para o endpoint.

--json JSON

A string JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--name string

Nome do endpoint de Pesquisa de IA.

--replica-count int

O número desejado de réplicas para o endpoint.

--target-qps int

QPS (queries por segundo) alvo para o endpoint.

--usage-policy-id string

O ID da política de uso aplicado ao endpoint.

Sinalizadores globais

databricks ai-search create-index

Crie um Índice de Pesquisa de AI.

databricks ai-search create-index PARENT PRIMARY_KEY INDEX_TYPE [flags]

Argumentos

PARENT

O endpoint onde este índice será criado. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}

PRIMARY_KEY

key primária do índice. Definido na criação e imutável a partir de então.

INDEX_TYPE

Tipo de índice. Valores suportados: DELTA_SYNC, DIRECT_ACCESS

Opções

--index-id string

O nome da tabela do Unity Catalog fornecido pelo usuário para o índice.

--index-subtype IndexSubtype

O subtipo do índice. Valores suportados: FULL_TEXT, HYBRID, VECTOR

--json JSON

A string JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--name string

Nome do índice de Pesquisa de AI.

Sinalizadores globais

databricks ai-search delete-endpoint

Excluir um endpoint de Pesquisa de IA.

databricks ai-search delete-endpoint NAME [flags]

Argumentos

NAME

Nome completo do recurso do endpoint a ser excluído. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}

Opções

Sinalizadores globais

databricks ai-search delete-index

Excluir um Índice de Pesquisa de AI.

databricks ai-search delete-index NAME [flags]

Argumentos

NAME

Nome completo do recurso do índice a ser excluído. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

Opções

Sinalizadores globais

databricks ai-search get-endpoint

Obter um endpoint de Pesquisa de IA.

databricks ai-search get-endpoint NAME [flags]

Argumentos

NAME

Nome completo do recurso do endpoint. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}

Opções

Sinalizadores globais

databricks ai-search get-index

Obtenha um índice de Pesquisa de IA.

databricks ai-search get-index NAME [flags]

Argumentos

NAME

Nome completo do recurso do índice. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

Opções

Sinalizadores globais

databricks ai-search list-endpoints

Listar Endpoint de Pesquisa de AI.

databricks ai-search list-endpoints PARENT [flags]

Argumentos

PARENT

O Workspace que possui esta coleção de Endpoint. Formato: workspaces/{workspace_id}

Opções

--limit int

Número máximo de resultados a retornar.

--page-size int

Limite superior de melhor esforço no número de resultados a retornar.

Sinalizadores globais

databricks ai-search list-indexes

Liste os índices de Pesquisa de AI.

databricks ai-search list-indexes PARENT [flags]

Argumentos

PARENT

O endpoint que possui esta coleção de índices. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}

Opções

--limit int

Número máximo de resultados a retornar.

--page-size int

Limite superior de melhor esforço no número de resultados a retornar.

Sinalizadores globais

databricks ai-search query-index

Faça uma query em um índice de Pesquisa de AI.

databricks ai-search query-index NAME [flags]

Argumentos

NAME

Nome completo do recurso do índice para query. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

Opções

--filters-json string

String JSON que descreve os filtros de query.

--json JSON

A string JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--max-results int

Número máximo de resultados a retornar.

--query-text string

Texto de query.

--query-type string

Tipo de query: ANN, HYBRID ou FULL_TEXT.

--score-threshold float

Limite de pontuação para a pesquisa aproximada de vizinho mais próximo.

Sinalizadores globais

databricks ai-search remove-data

Remova dados de um índice de Pesquisa de AI.

databricks ai-search remove-data NAME [flags]

Argumentos

NAME

Nome completo do recurso do índice. Deve ser um índice de acesso direto. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

Opções

--json JSON

A string JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

databricks ai-search scan-index

Analise um índice de Pesquisa de IA.

databricks ai-search scan-index NAME [flags]

Argumentos

NAME

Nome completo do recurso do índice a ser escaneado. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

Opções

--json JSON

A string JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--page-size int

Número máximo de linhas a retornar nesta página.

--page-token string

tokens de página de uma resposta anterior. Se não estiver definido, a varredura começa do início.

Sinalizadores globais

databricks ai-search sync-index

Sincronize um Índice de Pesquisa de AI.

databricks ai-search sync-index NAME [flags]

Argumentos

NAME

Nome completo do recurso do índice a ser sincronizado. Deve ser um índice Delta Sync. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

Opções

Sinalizadores globais

databricks ai-search update-endpoint

Atualizar um endpoint de Pesquisa de IA.

databricks ai-search update-endpoint NAME UPDATE_MASK ENDPOINT_TYPE [flags]

Argumentos

NAME

Nome do endpoint de Pesquisa de IA. Caminho completo do recurso na saída (Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}).

UPDATE_MASK

A lista de campos a serem atualizados.

ENDPOINT_TYPE

Tipo de endpoint. Valores suportados: STANDARD, STORAGE_OPTIMIZED

Opções

--budget-policy-id string

O ID da política de orçamento selecionado pelo usuário para o endpoint.

--json JSON

A string JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

--name string

Nome do endpoint de Pesquisa de IA.

--replica-count int

O número desejado de réplicas para o endpoint.

--target-qps int

QPS (queries por segundo) alvo para o endpoint.

--usage-policy-id string

O ID da política de uso aplicado ao endpoint.

Sinalizadores globais

databricks ai-search upsert-data

Insira dados em um Índice de Pesquisa de IA.

databricks ai-search upsert-data NAME INPUTS_JSON [flags]

Argumentos

NAME

Nome completo do recurso do índice. Deve ser um índice de acesso direto. Formato: workspaces/{workspace_id}/endpoints/{endpoint_id}/indexes/{index_id}

INPUTS_JSON

Documento JSON que descreve as linhas para upsert.

Opções

--json JSON

A string JSON embutida ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

Sinalizadores globais

--debug

Se deve habilitar o log de depuração.

-h ou --help

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

--log-file string

Uma string que representa o arquivo no qual os logs de saída serão gravados. Se esse sinalizador não for especificado, o default é gravar os logs de saída em stderr.

--log-format Formato

O tipo de formato de log, text ou json. O valor 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á desabilitado.

-o, --output Tipo

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

-p, --profile string

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

--progress-format Formato

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

-t, --target string

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