Skip to content

AiSearchEndpoint

laktory.models.resources.databricks.AiSearchEndpoint ¤

Bases: AiSearchEndpointBase

Databricks AI Search Endpoint

Compute hosting AI Search indexes. Replacement of VectorSearchEndpoint.

Examples:

import io

from laktory import models

endpoint_yaml = '''
parent: workspaces/1234567890
endpoint_id: default
endpoint_type: STANDARD
indexes:
- index_id: dev.finance.stock_news_index
  primary_key: id
  index_type: DELTA_SYNC
  delta_sync_index_spec:
    source_table: dev.finance.slv_stock_news
    pipeline_type: TRIGGERED
    embedding_source_columns:
    - name: text
      embedding_model_endpoint: databricks-gte-large-en
'''
endpoint = models.resources.databricks.AiSearchEndpoint.model_validate_yaml(
    io.StringIO(endpoint_yaml)
)
References
BASE DESCRIPTION
budget_policy_id

The user-selected budget policy id for the endpoint

TYPE: str | None | VariableType DEFAULT: None

custom_tags

The custom tags assigned to the endpoint

TYPE: list[AiSearchEndpointCustomTags] | None | VariableType DEFAULT: None

endpoint_id

The user-supplied short name for the Endpoint, per AIP-133. The server composes the full Endpoint.name as {parent}/endpoints/{endpoint_id}. AIP-133 does not list endpoint_id as a fields-may-be-required entry, so we annotate it OPTIONAL on the wire; the server still rejects empty values with INVALID_PARAMETER_VALUE

TYPE: str | None | VariableType DEFAULT: None

endpoint_type

Type of endpoint. Required on create and immutable thereafter. Possible values are: STANDARD, STORAGE_OPTIMIZED

TYPE: str | VariableType

parent

Workspace in which the endpoint is created, in the format workspaces/{workspace_id}

TYPE: str | VariableType

provider_config

Configure the provider for management through account provider

TYPE: AiSearchEndpointProviderConfig | None | VariableType DEFAULT: None

replica_count

The client-supplied desired number of replicas for the endpoint, applied at create/update time. Mutually exclusive with target_qps

TYPE: int | None | VariableType DEFAULT: None

target_qps

Target QPS for the endpoint. Mutually exclusive with replica_count. Best-effort; the system does not guarantee this QPS will be achieved

TYPE: int | None | VariableType DEFAULT: None

usage_policy_id

The usage policy id applied to the endpoint

TYPE: str | None | VariableType DEFAULT: None

LAKTORY DESCRIPTION
indexes

Indexes hosted on the endpoint. Their parent is set automatically.

TYPE: list[AiSearchIndex | VariableType] | VariableType DEFAULT: None

ATTRIBUTE DESCRIPTION
additional_core_resources
  • indexes

TYPE: list

additional_core_resources property ¤

  • indexes

laktory.models.resources.databricks.aisearchendpoint.AiSearchEndpointCustomTags ¤

Bases: BaseModel

PARAMETER DESCRIPTION
key

Key field for an AI Search endpoint tag

TYPE: str | VariableType

value

[Optional] Value field for an AI Search endpoint tag

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.aisearchendpoint.AiSearchEndpointProviderConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
workspace_id

Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with

TYPE: str | None | VariableType DEFAULT: None