vector-search-endpoints command group

The vector-search-endpoints command group within the Databricks CLI contains commands to manage vector search endpoints. Endpoints represent the compute resources to host vector search indexes. See Mosaic AI Vector Search.

databricks vector-search-endpoints create-endpoint

Create a new vector search endpoint.

databricks vector-search-endpoints create-endpoint NAME ENDPOINT_TYPE [flags]

Arguments

NAME

    Name of the vector search endpoint

ENDPOINT_TYPE

    Type of endpoint. Supported values: STANDARD

Options

--budget-policy-id string

    The budget policy id to be applied

--json JSON

    The inline JSON string or the @path to the JSON file with the request body.

--no-wait

    Do not wait to reach ONLINE state

--timeout duration

    Maximum amount of time to reach ONLINE state (default 20m0s)

Global flags

Examples

The following example creates a new vector search endpoint named my-endpoint of type STANDARD:

databricks vector-search-endpoints create-endpoint my-endpoint STANDARD

The following example creates a new vector search endpoint with a budget policy:

databricks vector-search-endpoints create-endpoint my-endpoint STANDARD --budget-policy-id policy-123

databricks vector-search-endpoints delete-endpoint

Delete a vector search endpoint.

databricks vector-search-endpoints delete-endpoint ENDPOINT_NAME [flags]

Arguments

ENDPOINT_NAME

    Name of the vector search endpoint

Options

Global flags

Examples

The following example deletes a vector search endpoint named my-endpoint:

databricks vector-search-endpoints delete-endpoint my-endpoint

databricks vector-search-endpoints get-endpoint

Get details for a single vector search endpoint.

databricks vector-search-endpoints get-endpoint ENDPOINT_NAME [flags]

Arguments

ENDPOINT_NAME

    Name of the endpoint

Options

Global flags

Examples

The following example gets details for a vector search endpoint named my-endpoint:

databricks vector-search-endpoints get-endpoint my-endpoint

databricks vector-search-endpoints list-endpoints

List all vector search endpoints in the workspace.

databricks vector-search-endpoints list-endpoints [flags]

Options

--page-token string

    Token for pagination

Global flags

Examples

The following example lists all vector search endpoints:

databricks vector-search-endpoints list-endpoints

The following example lists endpoints using pagination:

databricks vector-search-endpoints list-endpoints --page-token next-page-token

databricks vector-search-endpoints update-endpoint-budget-policy

Update the budget policy of an endpoint.

databricks vector-search-endpoints update-endpoint-budget-policy ENDPOINT_NAME BUDGET_POLICY_ID [flags]

Arguments

ENDPOINT_NAME

    Name of the vector search endpoint

BUDGET_POLICY_ID

    The budget policy id to be applied

Options

--json JSON

    The inline JSON string or the @path to the JSON file with the request body.

Global flags

Examples

The following example updates the budget policy for a vector search endpoint:

databricks vector-search-endpoints update-endpoint-budget-policy my-endpoint policy-456

Global flags

--debug

  Whether to enable debug logging.

-h or --help

    Display help for the Databricks CLI or the related command group or the related command.

--log-file string

    A string representing the file to write output logs to. If this flag is not specified then the default is to write output logs to stderr.

--log-format format

    The log format type, text or json. The default value is text.

--log-level string

    A string representing the log format level. If not specified then the log format level is disabled.

-o, --output type

    The command output type, text or json. The default value is text.

-p, --profile string

    The name of the profile in the ~/.databrickscfg file to use to run the command. If this flag is not specified then if it exists, the profile named DEFAULT is used.

--progress-format format

    The format to display progress logs: default, append, inplace, or json

-t, --target string

    If applicable, the bundle target to use