1. قبل از شروع
این کد لبه به شما نشان می‌دهد که چگونه یک پروژه Google Cloud ایجاد کنید و سپس APIهای Google Cloud را از آن پروژه فراخوانی کنید.
پیش نیازها
- امکان پیمایش در Google Cloud Console.
چیزی که یاد خواهید گرفت
- چگونه یک پروژه Google Cloud ایجاد کنیم.
- نحوه راه اندازی حساب صورتحساب
- نحوه راه اندازی Cloud Shell.
- چگونه یک API را فعال کنیم.
- نحوه مجوز API با کلید API
- نحوه مجوز API با یک حساب سرویس
آنچه شما نیاز دارید
- یک حساب Google، مانند یک حساب Gmail یا یک حساب Google Workspace .
- دسترسی به حساب Cloud Billing یا کارت اعتباری برای ثبت نام در برنامه آزمایشی رایگان .
2. راه اندازی شوید
این بخش به شما نشان می دهد که چگونه یک پروژه Google Cloud ایجاد کنید، یک حساب صورتحساب راه اندازی کنید، و Cloud Shell را راه اندازی کنید.
یک پروژه Google Cloud ایجاد کنید و یک حساب صورتحساب راه اندازی کنید
- به کنسول Cloud وارد شوید و یک پروژه را انتخاب یا ایجاد کنید.
شناسه پروژه را که در قسمت نام پروژه نشان داده شده است را به خاطر بسپارید. شناسه یک نام منحصر به فرد در تمام پروژه‌های Google Cloud است (نام بالا قبلاً گرفته شده است) و بعداً در این آزمایشگاه کد به عنوان PROJECT_ID نامیده می‌شود.
- در مرحله بعد، صورتحساب را در Cloud Console فعال کنید تا از منابع Google Cloud استفاده کنید.
اگرچه این کد لبه نباید هزینه زیادی داشته باشد، اما اگر چیزی باشد، دستورالعمل‌های موجود در بخش پاکسازی را دنبال کنید تا منابع را خاموش کنید و از هزینه‌های فراتر از این کد لبه اجتناب کنید. توجه داشته باشید که کاربران جدید Google Cloud واجد شرایط استفاده آزمایشی رایگان 300 دلاری هستند.
Cloud Shell را راه اندازی کنید
در این کد لبه، شما از Cloud Shell ، یک محیط خط فرمان که در Google Cloud اجرا می شود، استفاده می کنید. Cloud Shell یک ماشین مجازی مبتنی بر دبیان است که با تمام ابزارهای توسعه مورد نیاز شما بارگذاری شده است. این دایرکتوری خانگی 5 گیگابایتی دائمی را ارائه می دهد که عملکرد و احراز هویت شبکه را تا حد زیادی افزایش می دهد. این بدان معناست که تنها چیزی که برای این کد لبه نیاز دارید یک مرورگر است.
برای فعال کردن Cloud Shell از Cloud Console:
- کلیک کنید
Cloud Shell را فعال کنید .
تهیه و اتصال به محیط ممکن است چند لحظه طول بکشد.
پس از اتصال به Cloud Shell، باید ببینید که قبلاً احراز هویت شده‌اید و پروژه قبلاً روی PROJECT_ID شما تنظیم شده است.
- لیستی از حساب های اعتباری ایجاد کنید:
gcloud auth list
شما باید این خروجی را ببینید:
Credentialed accounts:
- <MY_ACCOUNT>@<MY_DOMAIN>.com (active)
- برای مشاهده لیست پروژه های خود این دستور را وارد کنید.
gcloud config list project
شما باید این خروجی را ببینید:
[core]
project = <PROJECT_ID>
اگر به دلایلی پروژه تنظیم نشد، این دستور را اجرا کنید تا پروژه راه اندازی شود.
gcloud config set project <PROJECT_ID>
PROJECT_ID شناسه ای است که در مراحل راه اندازی استفاده کردید. همچنین می توانید آن را در داشبورد Cloud Console جستجو کنید:
Cloud Shell همچنین برخی از متغیرهای محیطی را به صورت پیش‌فرض تنظیم می‌کند که ممکن است هنگام اجرای دستورات آینده مفید باشند.
- برای مشاهده ID پروژه خود دستور زیر را وارد کنید.
echo $GOOGLE_CLOUD_PROJECT
شما باید خروجی زیر را ببینید:
<PROJECT_ID>
- در نهایت، منطقه پیش فرض و پیکربندی پروژه را تنظیم کنید.
gcloud config set compute/zone us-central1-f
شما می توانید مناطق مختلفی را انتخاب کنید. برای اطلاعات بیشتر، به مناطق و مناطق مراجعه کنید.
3. یک API از یک پروژه فراخوانی کنید
این کد لبه به شما نشان می‌دهد که چگونه از یک API مثال ( API زبان طبیعی ) برای یافتن موجودیت‌ها (مانند افراد، مکان‌ها و رویدادها) در متن استفاده کنید، و چگونه می‌توانید احساس (سطح مطلوبیت) آن متن را تقریبی کنید. شما یاد می گیرید که چگونه:
- Google Cloud API ها را فعال کنید.
- با کلیدهای API و حساب‌های سرویس مجوز API را دریافت کنید.
- با کتابخانه های
curlو کلاینت، API را فراخوانی کنید.
یک API را فعال کنید
- APIs & Services را از منوی اصلی در Cloud Console انتخاب کنید.
- + ENABLE APIS AND SERVICES را از بالای صفحه انتخاب کنید.
- در این مرحله، می‌توانید APIها را فیلتر و مرور کنید یا مستقیماً با کادر جستجو به یک API بروید.
Natural Languageرا جستجو کنید و Cloud Natural Language API را انتخاب کنید.
- روی TRY THIS API کلیک کنید.
اگر دکمه TRY THIS API نشان داده نشده است، روی یکی از روش های فهرست شده کلیک کنید تا آن روش را امتحان کنید.
یک کلید API ایجاد کنید
از آنجایی که curl برای ارسال درخواست به API زبان طبیعی استفاده می‌کنید، باید یک کلید API ایجاد کنید تا در URL درخواست خود ارسال کنید.
- در Cloud Console، منوی پیمایش > APIs & Services > Credentials را انتخاب کنید.
- روی CREATE CREDENTIALS کلیک کنید و سپس کلید API را انتخاب کنید:
- کلید API ایجاد شده را کپی کنید و سپس روی Close کلیک کنید.
برای فراخوانی API از کلید API استفاده کنید
- در خط فرمان Cloud Shell، کلید API خود را صادر کنید.
export API_KEY=<YOUR_API_KEY>
کلیدی را که قبلاً ایجاد کرده‌اید جایگزین <YOUR_API_KEY> کنید.
- درخواستی برای API در Cloud Shell Editor یا با ویرایشگر لینوکس مانند Vim یا Emacs ایجاد کنید. می توانید جزئیات پارامترها را در Method: document.analyzeEntities بیابید. خروجی را در فایلی به نام
request.jsonذخیره کنید:
{
"document":{
"type":"PLAIN_TEXT",
"content":"Google, headquartered in Mountain View (1600 Amphitheatre Pkwy, Mountain View, CA 940430), unveiled the new Android phone for $799 at the Consumer Electronic Show. Sundar Pichai said in his keynote that users love their new Android phones."
},
"encodingType":"UTF8"
}
- با اطلاعات درخواست با API تماس بگیرید.
curl "https://language.googleapis.com/v1/documents:analyzeEntities?key=${API_KEY}" \
-s -X POST -H "Content-Type: application/json" --data-binary @request.json
- دستور را دوباره اجرا کنید و خروجی را به یک فایل هدایت کنید و نتیجه را بررسی کنید. جزئیات خروجی فایل JSON نیز در Method: document.analyzeEntities است.
- برای تغییر متن برای تجزیه و تحلیل در فایل
request.json، مقدارcontentرا با متن انتخابی خود جایگزین کنید.
4. مجوز با یک حساب خدمات
حساب‌های سرویس اغلب بر کلیدهای API ترجیح داده می‌شوند زیرا هم احراز هویت و هم مجوز را ارائه می‌کنند. می توانید حساب های سرویس را به عنوان آدرس ایمیل برنامه خود در نظر بگیرید.
- به بخش Credentials در منوی APIs & Services بازگردید.
- Create Credentials را انتخاب کنید، اما این بار، Service Account را انتخاب کنید.
- نام حساب سرویس ارائه کنید که هدف آن را توصیف کند، مانند "
Natural Language Service Account". سیستم یک شناسه پیشنهاد می کند. شما همچنین می توانید یک توضیحات اضافه کنید. همانطور که در مورد حساب های خدمات بیشتر می آموزید، دسترسی حساب سرویس به پروژه ها را فراهم می کنید و به کاربران اجازه دسترسی به حساب سرویس را می دهید، اما در حال حاضر، برای ایجاد حساب سرویس، فقط روی Done کلیک کنید. - برای ایجاد یک جفت کلید برای استفاده از حساب سرویس، کلیک کنید
برای ویرایش حساب سرویس
جزئیات حساب سرویس شما نمایش داده می شود.
- آدرس ایمیل حساب سرویس را کپی کنید و به Cloud Shell برگردید.
- در Cloud Shell، یک جفت کلید برای حساب سرویس خود ایجاد کنید و یک متغیر محیطی را تنظیم کنید تا به آن اشاره کند:
gcloud iam service-accounts keys create ~/key.json \
--iam-account <your service account email>
export GOOGLE_APPLICATION_CREDENTIALS="/home/$USER/key.json"
Google Cloud از این متغیر محیطی برای یافتن اعتبارنامه ها استفاده می کند، بنابراین نیازی به گنجاندن آنها در تماس API نیست.
- اکنون می توانید API را با دستور زیر فراخوانی کنید:
gcloud ml language analyze-entities --content="Michelangelo Caravaggio, Italian painter, is known for 'The Calling of Saint Matthew'."
نتیجه باید مانند قبل باشد.
بسیاری از APIها کتابخانه های سرویس گیرنده گسترده ای برای استخراج این جزئیات دارند. برای اطلاعات بیشتر در مورد کتابخانه های سرویس گیرنده، به کتابخانه های سرویس گیرنده ابر مراجعه کنید. همچنین می‌توانید اسناد APIهایی را که استفاده می‌کنید بخوانید تا ببینید چه کتابخانه‌های کلاینت برای آنها در دسترس است.
5. پاکسازی کنید
داشتن یک کلید API نامحدود برای پروژه ها کار بدی است. اگر شخصی به آن دسترسی پیدا کند، آن شخص می تواند بدون نیاز به احراز هویت از آن استفاده کند.
برای حذف این کلید API:
- کلیک کنید
منوی پیمایش > API ها و خدمات > اعتبارنامه ها . - در زیر کلیدهای API ، کلید حذف را انتخاب کنید و سپس کلیک کنید
حذف کنید . - به طور مشابه، به جای اینکه نگران محافظت نشدن کلید خصوصی حساب سرویس خود باشید، در بخش حساب‌های خدمات ، حساب سرویس را برای حذف انتخاب کنید و سپس کلیک کنید. حذف کنید .
6. تبریک می گویم
تبریک می گویم! شما یاد گرفتید که چگونه یک پروژه Google Cloud ایجاد کنید و چگونه یک API را از داخل پروژه فراخوانی کنید.