Skip to contents

Query a serving endpoint.

Usage

query_serving_endpoint(
  client,
  name,
  dataframe_records = NULL,
  dataframe_split = NULL,
  extra_params = NULL,
  input = NULL,
  inputs = NULL,
  instances = NULL,
  max_tokens = NULL,
  messages = NULL,
  n = NULL,
  prompt = NULL,
  stop = NULL,
  stream = NULL,
  temperature = NULL
)

servingEndpointsQuery(
  client,
  name,
  dataframe_records = NULL,
  dataframe_split = NULL,
  extra_params = NULL,
  input = NULL,
  inputs = NULL,
  instances = NULL,
  max_tokens = NULL,
  messages = NULL,
  n = NULL,
  prompt = NULL,
  stop = NULL,
  stream = NULL,
  temperature = NULL
)

Arguments

client

Required. Instance of DatabricksClient()

name

Required. The name of the serving endpoint.

dataframe_records

Pandas Dataframe input in the records orientation.

dataframe_split

Pandas Dataframe input in the split orientation.

extra_params

The extra parameters field used ONLY for completions, chat, and embeddings external & foundation model serving endpoints.

input

The input string (or array of strings) field used ONLY for embeddings external & foundation model serving endpoints and is the only field (along with extra_params if needed) used by embeddings queries.

inputs

Tensor-based input in columnar format.

instances

Tensor-based input in row format.

max_tokens

The max tokens field used ONLY for completions and chat external & foundation model serving endpoints.

messages

The messages field used ONLY for chat external & foundation model serving endpoints.

n

The n (number of candidates) field used ONLY for completions and chat external & foundation model serving endpoints.

prompt

The prompt string (or array of strings) field used ONLY for completions external & foundation model serving endpoints and should only be used with other completions query fields.

stop

The stop sequences field used ONLY for completions and chat external & foundation model serving endpoints.

stream

The stream field used ONLY for completions and chat external & foundation model serving endpoints.

temperature

The temperature field used ONLY for completions and chat external & foundation model serving endpoints.