hussein-awala commented on code in PR #35094: URL: https://github.com/apache/airflow/pull/35094#discussion_r1375032666
########## airflow/providers/pinecone/hooks/pinecone_hook.py: ########## @@ -0,0 +1,122 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +"""Hook for Pinecone.""" +from __future__ import annotations + +from typing import TYPE_CHECKING, Any + +import pinecone + +from airflow.hooks.base import BaseHook + +if TYPE_CHECKING: + from pinecone.core.client.models import ( + UpsertResponse, + ) + + +class PineconeHook(BaseHook): + """ + Interact with Pinecone. This hook uses the Pinecone conn_id. + + :param conn_id: The connection id to use when connecting to Pinecone. + """ + + conn_name_attr = "conn_id" + default_conn_name = "pinecone_default" + conn_type = "pinecone" + hook_name = "Pinecone" + + @classmethod + def get_ui_field_behaviour(cls) -> dict[str, Any]: + """Returns custom field behaviour.""" + return { + "hidden_fields": ["port"], + "relabeling": { + "login": "Pinecone Environment", + "password": "Pinecone API key", + "schema": "Project ID", + }, + "placeholders": { + "login": "Pinecone Environment", + "password": "Pinecone API key", + "schema": "Project ID", + }, + } + + def __init__(self, conn_id: str = default_conn_name) -> None: + self.conn_id = conn_id + self.get_conn() + + def get_conn(self) -> None: + pinecone_connection = self.get_connection(self.conn_id) + api_key = pinecone_connection.password + pinecone_environment = pinecone_connection.login + pinecone_host = pinecone_connection.host + pinecone_project_name = pinecone_connection.schema Review Comment: This will be a bit weird when someone provides the connection as a URI. Instead, we can use the connection extras as we do with the other hooks. ########## airflow/providers/pinecone/operators/pinecone_operator.py: ########## @@ -0,0 +1,83 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from __future__ import annotations + +from functools import cached_property +from typing import TYPE_CHECKING, Any, Sequence + +from airflow.models import BaseOperator +from airflow.providers.pinecone.hooks.pinecone_hook import PineconeHook + +if TYPE_CHECKING: + from airflow.utils.context import Context + + +class PineconeIngestOperator(BaseOperator): + """ + Airflow Operator to ingest vector embeddings into Pinecone. + + .. seealso:: + For more information on how to use this operator, take a look at the guide: + :ref:`howto/operator:PineconeIngestOperator` + + :param conn_id: pinecone_conn_id: The connection id to use when connecting to Pinecone. + :param index_name: Name of the Pinecone index. + :param vectors: Data to be ingested, in the form of a list of tuples where each tuple + contains (id, vector_embedding, metadata). + :param namespace: The namespace to write to. If not specified, the default namespace is used. + :param batch_size: The number of vectors to upsert in each batch. + """ + + template_fields: Sequence[str] = ("input_vectors",) Review Comment: ```suggestion template_fields: Sequence[str] = ("index_name", "input_vectors", "namespace") ``` ########## airflow/providers/pinecone/operators/pinecone_operator.py: ########## @@ -0,0 +1,83 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +from __future__ import annotations + +from functools import cached_property +from typing import TYPE_CHECKING, Any, Sequence + +from airflow.models import BaseOperator +from airflow.providers.pinecone.hooks.pinecone_hook import PineconeHook + +if TYPE_CHECKING: + from airflow.utils.context import Context + + +class PineconeIngestOperator(BaseOperator): + """ + Airflow Operator to ingest vector embeddings into Pinecone. + + .. seealso:: + For more information on how to use this operator, take a look at the guide: + :ref:`howto/operator:PineconeIngestOperator` + + :param conn_id: pinecone_conn_id: The connection id to use when connecting to Pinecone. + :param index_name: Name of the Pinecone index. + :param vectors: Data to be ingested, in the form of a list of tuples where each tuple + contains (id, vector_embedding, metadata). + :param namespace: The namespace to write to. If not specified, the default namespace is used. + :param batch_size: The number of vectors to upsert in each batch. + """ + + template_fields: Sequence[str] = ("input_vectors",) + + def __init__( + self, + *, + conn_id: str = PineconeHook.default_conn_name, + index_name: str, + input_vectors: list[Any], + namespace: str = "", + batch_size: int | None = None, + **kwargs: Any, + ) -> None: + self.upsert_kwargs = kwargs.pop("upsert_kwargs", {}) Review Comment: Why not add `upsert_kwargs ` as a parameter for the operator? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
