helpers/authenticate_api.py

#!/usr/bin/env python
# coding: utf-8

# Copyright 2021, IBM Corporation. 
#
# Licensed 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.

"""
Python helper function to authenticate in HF API.
"""

__author__ = "Vagner Santana, Melina Alberio, Cassia Sanctos and Tiago Machado"
__copyright__ = "IBM Corporation 2024"
__credits__ = ["Vagner Santana, Melina Alberio, Cassia Sanctos, Tiago Machado"]
__license__ = "Apache 2.0"
__version__ = "0.0.1"

import os

def authenticate_api(hf_token, hf_url):
    """
    Function authenticate in HuggingFace API.

    Args:
        hf_token: HugginFace personal token.
        hf_url: HuggingFace url to be accessed.

    Returns:
        An api url and headers.

    Raises:
        Nothing.
    """
    # Sentence transformer model
    model_id = "sentence-transformers/all-MiniLM-L6-v2"

    api_url = f"{hf_url}{model_id}"
    headers = {"Authorization": f"Bearer {hf_token}"}
    return api_url, headers