API Gemini cho phép bạn thực hiện truy xuất ngữ nghĩa trên dữ liệu của riêng mình. Vì đó là dữ liệu của bạn nên dữ liệu này cần các chế độ kiểm soát quyền truy cập nghiêm ngặt hơn so với khoá API.
Quá trình bắt đầu nhanh này sử dụng phương pháp xác thực đơn giản, phù hợp với môi trường kiểm thử. Đối với môi trường phát hành chính thức, hãy tìm hiểu về phương thức xác thực và uỷ quyền trước khi chọn thông tin xác thực truy cập phù hợp với ứng dụng của bạn.
Mục tiêu
- Thiết lập dự án trên đám mây cho OAuth
- Thiết lập application-default-credentials
- Quản lý thông tin đăng nhập trong chương trình của bạn thay vì sử dụng
gcloud auth
Điều kiện tiên quyết
Để chạy quy trình khởi động nhanh này, bạn cần:
Thiết lập dự án trên đám mây
Để hoàn tất quá trình bắt đầu nhanh này, trước tiên, bạn cần thiết lập dự án trên Google Cloud.
1. Bật API
Trước khi sử dụng các API của Google, bạn cần bật những API đó trong một dự án trên Google Cloud.
Trong bảng điều khiển Google Cloud, hãy bật Google Generative Language API.
2. Định cấu hình màn hình xin phép bằng OAuth
Tiếp theo, hãy định cấu hình màn hình xin phép bằng OAuth của dự án và thêm chính bạn làm người dùng thử nghiệm. Nếu bạn đã hoàn tất bước này cho dự án trên Google Cloud, hãy chuyển sang phần tiếp theo.
Trong bảng điều khiển của Google Cloud, hãy chuyển đến Trình đơn > API và dịch vụ > màn hình xin phép bằng OAuth.
Chọn loại người dùng External cho ứng dụng của bạn, sau đó nhấp vào Create (Tạo).
Hoàn tất biểu mẫu đăng ký ứng dụng (bạn có thể để trống hầu hết các trường), sau đó nhấp vào Lưu và tiếp tục.
Hiện tại, bạn có thể bỏ qua bước thêm phạm vi và nhấp vào Lưu và tiếp tục. Trong tương lai, khi tạo một ứng dụng để dùng bên ngoài tổ chức Google Workspace, bạn phải thêm và xác minh phạm vi uỷ quyền mà ứng dụng của bạn yêu cầu.
Thêm người dùng thử nghiệm:
- Trong phần Người dùng thử nghiệm, hãy nhấp vào Thêm người dùng.
- Nhập địa chỉ email của bạn và bất kỳ người dùng thử nghiệm được uỷ quyền nào khác, sau đó nhấp vào Save and Continue (Lưu và tiếp tục).
Xem lại tóm tắt đăng ký ứng dụng của bạn. Để chỉnh sửa, hãy nhấp vào Chỉnh sửa. Nếu quá trình đăng ký ứng dụng có vẻ ổn, hãy nhấp vào Back to Dashboard (Quay lại Trang tổng quan).
3. Ủy quyền thông tin đăng nhập cho ứng dụng dành cho máy tính để bàn
Để xác thực với tư cách người dùng cuối và truy cập vào dữ liệu người dùng trong ứng dụng, bạn cần tạo một hoặc nhiều mã ứng dụng khách OAuth 2.0. Mã ứng dụng khách được dùng để xác định một ứng dụng cho các máy chủ OAuth của Google. Nếu ứng dụng của bạn chạy trên nhiều nền tảng, bạn phải tạo một mã ứng dụng khách riêng cho từng nền tảng.
Trong bảng điều khiển Google Cloud, hãy chuyển đến Trình đơn > API và dịch vụ > Thông tin xác thực.
Nhấp vào Tạo thông tin đăng nhập > Mã ứng dụng khách OAuth.
Nhấp vào Loại ứng dụng > Ứng dụng dành cho máy tính.
Trong trường Tên, nhập tên cho thông tin đăng nhập. Tên này chỉ hiện trong bảng điều khiển Google Cloud.
Nhấp vào Tạo. Màn hình ứng dụng OAuth đã tạo sẽ xuất hiện, cho thấy Mã ứng dụng khách và Mật khẩu ứng dụng khách mới.
Nhấp vào OK. Thông tin đăng nhập mới tạo sẽ xuất hiện trong Mã ứng dụng OAuth 2.0.
Nhấp vào nút tải xuống để lưu tệp JSON. Tệp này sẽ được lưu dưới dạng
client_secret_<identifier>.json, đổi tên thànhclient_secret.jsonrồi di chuyển tệp này vào thư mục đang làm việc.
Thiết lập thông tin xác thực mặc định của ứng dụng
Để chuyển đổi tệp client_secret.json thành thông tin xác thực có thể sử dụng, hãy truyền vị trí của tệp vào đối số --client-id-file của lệnh gcloud auth application-default login.
gcloud auth application-default login \
--client-id-file=client_secret.json \
--scopes='https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/generative-language.retriever'
Quy trình thiết lập dự án được đơn giản hoá trong hướng dẫn này sẽ kích hoạt hộp thoại "Google chưa xác minh ứng dụng này". Điều này là bình thường, hãy chọn "tiếp tục".
Thao tác này sẽ đặt mã thông báo thu được ở một vị trí nổi bật để gcloud hoặc thư viện ứng dụng có thể truy cập vào mã đó.
gcloud auth application-default login
--no-browser
--client-id-file=client_secret.json
--scopes='https://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/generative-language.retriever'
Sau khi bạn đặt thông tin xác thực mặc định của ứng dụng (ACD), các thư viện ứng dụng trong hầu hết ngôn ngữ cần ở mức tối thiểu hoặc không cần trợ giúp để tìm các thư viện đó.
Uốn cong
Cách nhanh nhất để kiểm tra xem hàm này có đang hoạt động hay không là sử dụng lệnh để truy cập vào API REST bằng curl:
access_token=$(gcloud auth application-default print-access-token)
project_id=<MY PROJECT ID>
curl -X GET https://generativelanguage.googleapis.com/v1/models \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer ${access_token}" \
-H "x-goog-user-project: ${project_id}" | grep '"name"'
Python
Trong python, các thư viện ứng dụng sẽ tự động tìm các thư viện đó:
pip install google-generativeai
Một tập lệnh tối thiểu để kiểm tra có thể là:
import google.generativeai as genai
print('Available base models:', [m.name for m in genai.list_models()])
Các bước tiếp theo
Nếu cách này hiệu quả, bạn đã sẵn sàng dùng thử Truy xuất ngữ nghĩa trên dữ liệu văn bản của bạn.
Tự quản lý thông tin đăng nhập [Python]
Trong nhiều trường hợp, bạn sẽ không có lệnh gcloud để tạo mã truy cập từ Client-ID (client_secret.json). Google cung cấp các thư viện bằng nhiều ngôn ngữ để bạn có thể quản lý quy trình đó trong ứng dụng của mình. Phần này minh hoạ quy trình này bằng python. Có các ví dụ tương đương về quy trình này đối với các ngôn ngữ khác trong tài liệu về API Drive
1. Cài đặt các thư viện cần thiết
Cài đặt thư viện ứng dụng Google cho Python và thư viện ứng dụng Gemini.
pip install --upgrade -q google-api-python-client google-auth-httplib2 google-auth-oauthlib
pip install google-generativeai
2. Viết trình quản lý thông tin xác thực
Để giảm thiểu số lần bạn phải nhấp qua màn hình uỷ quyền, hãy tạo một tệp có tên là load_creds.py trong thư mục làm việc để lưu tệp token.json vào bộ nhớ đệm mà sau này có thể sử dụng lại hoặc làm mới nếu hết hạn.
Bắt đầu bằng mã sau để chuyển đổi tệp client_secret.json thành mã thông báo có thể sử dụng được bằng genai.configure:
import os.path
from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
SCOPES = ['https://www.googleapis.com/auth/generative-language.retriever']
def load_creds():
"""Converts `client_secret.json` to a credential object.
This function caches the generated tokens to minimize the use of the
consent screen.
"""
creds = None
# The file token.json stores the user's access and refresh tokens, and is
# created automatically when the authorization flow completes for the first
# time.
if os.path.exists('token.json'):
creds = Credentials.from_authorized_user_file('token.json', SCOPES)
# If there are no (valid) credentials available, let the user log in.
if not creds or not creds.valid:
if creds and creds.expired and creds.refresh_token:
creds.refresh(Request())
else:
flow = InstalledAppFlow.from_client_secrets_file(
'client_secret.json', SCOPES)
creds = flow.run_local_server(port=0)
# Save the credentials for the next run
with open('token.json', 'w') as token:
token.write(creds.to_json())
return creds
3. Viết chương trình
Bây giờ, hãy tạo script.py của bạn:
import pprint
import google.generativeai as genai
from load_creds import load_creds
creds = load_creds()
genai.configure(credentials=creds)
print()
print('Available base models:', [m.name for m in genai.list_models()])
4. Chạy chương trình
Trong thư mục đang làm việc của bạn, hãy chạy mẫu:
python script.py
Lần đầu tiên bạn chạy tập lệnh, tập lệnh sẽ mở ra một cửa sổ trình duyệt và nhắc bạn cấp quyền truy cập.
Nếu chưa đăng nhập vào Tài khoản Google, bạn sẽ được nhắc đăng nhập. Nếu bạn đã đăng nhập vào nhiều tài khoản, hãy nhớ chọn tài khoản mà bạn đặt làm "Tài khoản kiểm thử" khi định cấu hình dự án.
Thông tin uỷ quyền được lưu trữ trong hệ thống tệp, vì vậy, lần tiếp theo khi chạy mã mẫu, bạn sẽ không được nhắc uỷ quyền.
Bạn đã thiết lập thành công phương thức xác thực.