databricks-sdk 0.57.0__py3-none-any.whl → 0.59.0__py3-none-any.whl

databricks/sdk/service/vectorsearch.py

@@ -44,120 +44,6 @@ class ColumnInfo:
         return cls(name=d.get("name", None))
 
 
-@dataclass
-class CreateEndpoint:
-    name: str
-    """Name of the vector search endpoint"""
-
-    endpoint_type: EndpointType
-    """Type of endpoint"""
-
-    budget_policy_id: Optional[str] = None
-    """The budget policy id to be applied"""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateEndpoint into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.budget_policy_id is not None:
-            body["budget_policy_id"] = self.budget_policy_id
-        if self.endpoint_type is not None:
-            body["endpoint_type"] = self.endpoint_type.value
-        if self.name is not None:
-            body["name"] = self.name
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateEndpoint into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.budget_policy_id is not None:
-            body["budget_policy_id"] = self.budget_policy_id
-        if self.endpoint_type is not None:
-            body["endpoint_type"] = self.endpoint_type
-        if self.name is not None:
-            body["name"] = self.name
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateEndpoint:
-        """Deserializes the CreateEndpoint from a dictionary."""
-        return cls(
-            budget_policy_id=d.get("budget_policy_id", None),
-            endpoint_type=_enum(d, "endpoint_type", EndpointType),
-            name=d.get("name", None),
-        )
-
-
-@dataclass
-class CreateVectorIndexRequest:
-    name: str
-    """Name of the index"""
-
-    endpoint_name: str
-    """Name of the endpoint to be used for serving the index"""
-
-    primary_key: str
-    """Primary key of the index"""
-
-    index_type: VectorIndexType
-    """There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs
-    with a source Delta Table, automatically and incrementally updating the index as the underlying
-    data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write
-    of vectors and metadata through our REST and SDK APIs. With this model, the user manages index
-    updates."""
-
-    delta_sync_index_spec: Optional[DeltaSyncVectorIndexSpecRequest] = None
-    """Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`."""
-
-    direct_access_index_spec: Optional[DirectAccessVectorIndexSpec] = None
-    """Specification for Direct Vector Access Index. Required if `index_type` is `DIRECT_ACCESS`."""
-
-    def as_dict(self) -> dict:
-        """Serializes the CreateVectorIndexRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.delta_sync_index_spec:
-            body["delta_sync_index_spec"] = self.delta_sync_index_spec.as_dict()
-        if self.direct_access_index_spec:
-            body["direct_access_index_spec"] = self.direct_access_index_spec.as_dict()
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        if self.index_type is not None:
-            body["index_type"] = self.index_type.value
-        if self.name is not None:
-            body["name"] = self.name
-        if self.primary_key is not None:
-            body["primary_key"] = self.primary_key
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the CreateVectorIndexRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.delta_sync_index_spec:
-            body["delta_sync_index_spec"] = self.delta_sync_index_spec
-        if self.direct_access_index_spec:
-            body["direct_access_index_spec"] = self.direct_access_index_spec
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        if self.index_type is not None:
-            body["index_type"] = self.index_type
-        if self.name is not None:
-            body["name"] = self.name
-        if self.primary_key is not None:
-            body["primary_key"] = self.primary_key
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> CreateVectorIndexRequest:
-        """Deserializes the CreateVectorIndexRequest from a dictionary."""
-        return cls(
-            delta_sync_index_spec=_from_dict(d, "delta_sync_index_spec", DeltaSyncVectorIndexSpecRequest),
-            direct_access_index_spec=_from_dict(d, "direct_access_index_spec", DirectAccessVectorIndexSpec),
-            endpoint_name=d.get("endpoint_name", None),
-            index_type=_enum(d, "index_type", VectorIndexType),
-            name=d.get("name", None),
-            primary_key=d.get("primary_key", None),
-        )
-
-
 @dataclass
 class CustomTag:
     key: str
@@ -845,11 +731,6 @@ class MiniVectorIndex:
     """Name of the endpoint associated with the index"""
 
     index_type: Optional[VectorIndexType] = None
-    """There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs
-    with a source Delta Table, automatically and incrementally updating the index as the underlying
-    data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write
-    of vectors and metadata through our REST and SDK APIs. With this model, the user manages index
-    updates."""
 
     name: Optional[str] = None
     """Name of the index"""
@@ -899,38 +780,6 @@ class MiniVectorIndex:
         )
 
 
-@dataclass
-class PatchEndpointBudgetPolicyRequest:
-    budget_policy_id: str
-    """The budget policy id to be applied"""
-
-    endpoint_name: Optional[str] = None
-    """Name of the vector search endpoint"""
-
-    def as_dict(self) -> dict:
-        """Serializes the PatchEndpointBudgetPolicyRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.budget_policy_id is not None:
-            body["budget_policy_id"] = self.budget_policy_id
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the PatchEndpointBudgetPolicyRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.budget_policy_id is not None:
-            body["budget_policy_id"] = self.budget_policy_id
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> PatchEndpointBudgetPolicyRequest:
-        """Deserializes the PatchEndpointBudgetPolicyRequest from a dictionary."""
-        return cls(budget_policy_id=d.get("budget_policy_id", None), endpoint_name=d.get("endpoint_name", None))
-
-
 @dataclass
 class PatchEndpointBudgetPolicyResponse:
     effective_budget_policy_id: Optional[str] = None
@@ -967,149 +816,6 @@ class PipelineType(Enum):
     TRIGGERED = "TRIGGERED"
 
 
-@dataclass
-class QueryVectorIndexNextPageRequest:
-    """Request payload for getting next page of results."""
-
-    endpoint_name: Optional[str] = None
-    """Name of the endpoint."""
-
-    index_name: Optional[str] = None
-    """Name of the vector index to query."""
-
-    page_token: Optional[str] = None
-    """Page token returned from previous `QueryVectorIndex` or `QueryVectorIndexNextPage` API."""
-
-    def as_dict(self) -> dict:
-        """Serializes the QueryVectorIndexNextPageRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.page_token is not None:
-            body["page_token"] = self.page_token
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the QueryVectorIndexNextPageRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.page_token is not None:
-            body["page_token"] = self.page_token
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> QueryVectorIndexNextPageRequest:
-        """Deserializes the QueryVectorIndexNextPageRequest from a dictionary."""
-        return cls(
-            endpoint_name=d.get("endpoint_name", None),
-            index_name=d.get("index_name", None),
-            page_token=d.get("page_token", None),
-        )
-
-
-@dataclass
-class QueryVectorIndexRequest:
-    columns: List[str]
-    """List of column names to include in the response."""
-
-    columns_to_rerank: Optional[List[str]] = None
-    """Column names used to retrieve data to send to the reranker."""
-
-    filters_json: Optional[str] = None
-    """JSON string representing query filters.
-    
-    Example filters:
-    
-    - `{"id <": 5}`: Filter for id less than 5. - `{"id >": 5}`: Filter for id greater than 5. -
-    `{"id <=": 5}`: Filter for id less than equal to 5. - `{"id >=": 5}`: Filter for id greater than
-    equal to 5. - `{"id": 5}`: Filter for id equal to 5."""
-
-    index_name: Optional[str] = None
-    """Name of the vector index to query."""
-
-    num_results: Optional[int] = None
-    """Number of results to return. Defaults to 10."""
-
-    query_text: Optional[str] = None
-    """Query text. Required for Delta Sync Index using model endpoint."""
-
-    query_type: Optional[str] = None
-    """The query type to use. Choices are `ANN` and `HYBRID`. Defaults to `ANN`."""
-
-    query_vector: Optional[List[float]] = None
-    """Query vector. Required for Direct Vector Access Index and Delta Sync Index using self-managed
-    vectors."""
-
-    score_threshold: Optional[float] = None
-    """Threshold for the approximate nearest neighbor search. Defaults to 0.0."""
-
-    def as_dict(self) -> dict:
-        """Serializes the QueryVectorIndexRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.columns:
-            body["columns"] = [v for v in self.columns]
-        if self.columns_to_rerank:
-            body["columns_to_rerank"] = [v for v in self.columns_to_rerank]
-        if self.filters_json is not None:
-            body["filters_json"] = self.filters_json
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.num_results is not None:
-            body["num_results"] = self.num_results
-        if self.query_text is not None:
-            body["query_text"] = self.query_text
-        if self.query_type is not None:
-            body["query_type"] = self.query_type
-        if self.query_vector:
-            body["query_vector"] = [v for v in self.query_vector]
-        if self.score_threshold is not None:
-            body["score_threshold"] = self.score_threshold
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the QueryVectorIndexRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.columns:
-            body["columns"] = self.columns
-        if self.columns_to_rerank:
-            body["columns_to_rerank"] = self.columns_to_rerank
-        if self.filters_json is not None:
-            body["filters_json"] = self.filters_json
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.num_results is not None:
-            body["num_results"] = self.num_results
-        if self.query_text is not None:
-            body["query_text"] = self.query_text
-        if self.query_type is not None:
-            body["query_type"] = self.query_type
-        if self.query_vector:
-            body["query_vector"] = self.query_vector
-        if self.score_threshold is not None:
-            body["score_threshold"] = self.score_threshold
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> QueryVectorIndexRequest:
-        """Deserializes the QueryVectorIndexRequest from a dictionary."""
-        return cls(
-            columns=d.get("columns", None),
-            columns_to_rerank=d.get("columns_to_rerank", None),
-            filters_json=d.get("filters_json", None),
-            index_name=d.get("index_name", None),
-            num_results=d.get("num_results", None),
-            query_text=d.get("query_text", None),
-            query_type=d.get("query_type", None),
-            query_vector=d.get("query_vector", None),
-            score_threshold=d.get("score_threshold", None),
-        )
-
-
 @dataclass
 class QueryVectorIndexResponse:
     manifest: Optional[ResultManifest] = None
@@ -1223,49 +929,6 @@ class ResultManifest:
         return cls(column_count=d.get("column_count", None), columns=_repeated_dict(d, "columns", ColumnInfo))
 
 
-@dataclass
-class ScanVectorIndexRequest:
-    index_name: Optional[str] = None
-    """Name of the vector index to scan."""
-
-    last_primary_key: Optional[str] = None
-    """Primary key of the last entry returned in the previous scan."""
-
-    num_results: Optional[int] = None
-    """Number of results to return. Defaults to 10."""
-
-    def as_dict(self) -> dict:
-        """Serializes the ScanVectorIndexRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.last_primary_key is not None:
-            body["last_primary_key"] = self.last_primary_key
-        if self.num_results is not None:
-            body["num_results"] = self.num_results
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the ScanVectorIndexRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.last_primary_key is not None:
-            body["last_primary_key"] = self.last_primary_key
-        if self.num_results is not None:
-            body["num_results"] = self.num_results
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> ScanVectorIndexRequest:
-        """Deserializes the ScanVectorIndexRequest from a dictionary."""
-        return cls(
-            index_name=d.get("index_name", None),
-            last_primary_key=d.get("last_primary_key", None),
-            num_results=d.get("num_results", None),
-        )
-
-
 @dataclass
 class ScanVectorIndexResponse:
     """Response to a scan vector index request."""
@@ -1343,38 +1006,6 @@ class SyncIndexResponse:
         return cls()
 
 
-@dataclass
-class UpdateEndpointCustomTagsRequest:
-    custom_tags: List[CustomTag]
-    """The new custom tags for the vector search endpoint"""
-
-    endpoint_name: Optional[str] = None
-    """Name of the vector search endpoint"""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpdateEndpointCustomTagsRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.custom_tags:
-            body["custom_tags"] = [v.as_dict() for v in self.custom_tags]
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpdateEndpointCustomTagsRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.custom_tags:
-            body["custom_tags"] = self.custom_tags
-        if self.endpoint_name is not None:
-            body["endpoint_name"] = self.endpoint_name
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpdateEndpointCustomTagsRequest:
-        """Deserializes the UpdateEndpointCustomTagsRequest from a dictionary."""
-        return cls(custom_tags=_repeated_dict(d, "custom_tags", CustomTag), endpoint_name=d.get("endpoint_name", None))
-
-
 @dataclass
 class UpdateEndpointCustomTagsResponse:
     custom_tags: Optional[List[CustomTag]] = None
@@ -1448,38 +1079,6 @@ class UpsertDataStatus(Enum):
     SUCCESS = "SUCCESS"
 
 
-@dataclass
-class UpsertDataVectorIndexRequest:
-    inputs_json: str
-    """JSON string representing the data to be upserted."""
-
-    index_name: Optional[str] = None
-    """Name of the vector index where data is to be upserted. Must be a Direct Vector Access Index."""
-
-    def as_dict(self) -> dict:
-        """Serializes the UpsertDataVectorIndexRequest into a dictionary suitable for use as a JSON request body."""
-        body = {}
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.inputs_json is not None:
-            body["inputs_json"] = self.inputs_json
-        return body
-
-    def as_shallow_dict(self) -> dict:
-        """Serializes the UpsertDataVectorIndexRequest into a shallow dictionary of its immediate attributes."""
-        body = {}
-        if self.index_name is not None:
-            body["index_name"] = self.index_name
-        if self.inputs_json is not None:
-            body["inputs_json"] = self.inputs_json
-        return body
-
-    @classmethod
-    def from_dict(cls, d: Dict[str, Any]) -> UpsertDataVectorIndexRequest:
-        """Deserializes the UpsertDataVectorIndexRequest from a dictionary."""
-        return cls(index_name=d.get("index_name", None), inputs_json=d.get("inputs_json", None))
-
-
 @dataclass
 class UpsertDataVectorIndexResponse:
     result: Optional[UpsertDataResult] = None
@@ -1579,11 +1178,6 @@ class VectorIndex:
     """Name of the endpoint associated with the index"""
 
     index_type: Optional[VectorIndexType] = None
-    """There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs
-    with a source Delta Table, automatically and incrementally updating the index as the underlying
-    data in the Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write
-    of vectors and metadata through our REST and SDK APIs. With this model, the user manages index
-    updates."""
 
     name: Optional[str] = None
     """Name of the index"""
@@ -1937,10 +1531,6 @@ class VectorSearchIndexesAPI:
         :param primary_key: str
           Primary key of the index
         :param index_type: :class:`VectorIndexType`
-          There are 2 types of Vector Search indexes: - `DELTA_SYNC`: An index that automatically syncs with a
-          source Delta Table, automatically and incrementally updating the index as the underlying data in the
-          Delta Table changes. - `DIRECT_ACCESS`: An index that supports direct read and write of vectors and
-          metadata through our REST and SDK APIs. With this model, the user manages index updates.
         :param delta_sync_index_spec: :class:`DeltaSyncVectorIndexSpecRequest` (optional)
           Specification for Delta Sync Index. Required if `index_type` is `DELTA_SYNC`.
         :param direct_access_index_spec: :class:`DirectAccessVectorIndexSpec` (optional)