این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

یک طرحواره ایجاد و ثبت کنید

یک طرح جستجوی ابری گوگل (Google Cloud Search schema) یک ساختار JSON است که اشیاء، ویژگی‌ها و گزینه‌هایی را برای فهرست‌بندی و پرس‌وجوی داده‌ها تعریف می‌کند. رابط محتوای شما از طرح ثبت‌شده برای ساختاردهی و فهرست‌بندی داده‌های مخزن استفاده می‌کند.

شما با ارائه یک شیء طرحواره JSON به API، یک طرحواره ایجاد می‌کنید. قبل از فهرست‌بندی داده‌ها، باید برای هر مخزن یک طرحواره ثبت کنید.

این سند اصول اولیه ایجاد طرحواره را پوشش می‌دهد. برای بهینه‌سازی تجربه جستجو، به بهبود کیفیت جستجو مراجعه کنید.

ایجاد یک طرحواره

برای ایجاد طرح جستجوی ابری خود، این مراحل را دنبال کنید:

شناسایی رفتار مورد انتظار کاربر
مقداردهی اولیه یک منبع داده
اشیاء خود را تعریف کنید
تعریف ویژگی‌های شیء
طرحواره خود را ثبت کنید
داده‌های خود را فهرست‌بندی کنید
طرحواره خود را آزمایش کنید
طرحواره خود را تنظیم کنید

شناسایی رفتار مورد انتظار کاربر

پیش‌بینی نحوه جستجوی کاربران به تعریف استراتژی طرحواره شما کمک می‌کند. برای یک پایگاه داده فیلم، کاربران ممکن است عبارت "فیلم‌هایی با بازی رابرت ردفورد" را جستجو کنند. طرحواره شما باید از جستجوهایی برای فیلم‌هایی با یک بازیگر خاص پشتیبانی کند.

برای همسو کردن طرحواره خود با رفتار کاربر:

ارزیابی درخواست‌های متنوع از کاربران مختلف.
مجموعه داده‌های منطقی یا اشیاء ، مانند یک «فیلم» را شناسایی کنید.
ویژگی‌ها (صفات) مانند عنوان یا تاریخ انتشار را شناسایی کنید.
مقادیر معتبر برای ویژگی‌ها، مانند «مهاجمان صندوقچه گمشده» را شناسایی کنید.
نیازهای مرتب‌سازی و رتبه‌بندی، مانند ترتیب زمانی یا رتبه‌بندی مخاطبان را تعیین کنید.
ویژگی‌های زمینه‌ای، مانند نقش شغلی، را برای بهبود پیشنهادات تکمیل خودکار شناسایی کنید.
این اشیاء، ویژگی‌ها و مقادیر نمونه را فهرست کنید. از این لیست برای تعریف گزینه‌های عملگر استفاده کنید.

منبع داده خود را مقداردهی اولیه کنید

یک منبع داده، داده‌های مخزن ایندکس‌شده ذخیره‌شده در Google Cloud را نشان می‌دهد. به مدیریت منابع داده شخص ثالث مراجعه کنید. وقتی کاربر روی یک نتیجه کلیک می‌کند، Cloud Search او را با استفاده از URL از درخواست ایندکس‌گذاری به آن مورد هدایت می‌کند.

اشیاء خود را تعریف کنید

شیء واحد اساسی یک طرحواره است. ساختارهای منطقی مانند "فیلم" یا "شخص" شیء هستند. هر شیء دارای ویژگی‌هایی مانند عنوان، مدت زمان یا نام است.

ترسیم ارتباطات طرحواره بین موجودیت‌ها — **شکل ۱.** یک طرحواره نمونه با دو شیء و یک زیر-شیء.

یک طرحواره (schema) فهرستی از تعاریف اشیاء در تگ objectDefinitions است.

{
  "objectDefinitions": [
    { "name": "movie" },
    { "name": "person" }
  ]
}

برای هر شیء از نام‌های منحصر به فرد، مانند movie استفاده کنید. سرویس schema از این نام‌ها به عنوان کلید استفاده می‌کند. به ObjectDefinition مراجعه کنید.

تعریف ویژگی‌های شیء

ویژگی‌هایی مانند عنوان و تاریخ انتشار را در بخش propertyDefinitions تعریف کنید. از options freshnessOptions (رتبه‌بندی) و displayOptions (برچسب‌های رابط کاربری) استفاده کنید.

{
  "objectDefinitions": [{
    "name": "movie",
    "propertyDefinitions": [
      {
        "name": "movieTitle",
        "isReturnable": true,
        "textPropertyOptions": {
          "retrievalImportance": { "importance": "HIGHEST" },
          "operatorOptions": { "operatorName": "title" }
        },
        "displayOptions": { "displayLabel": "Title" }
      },
      {
        "name": "releaseDate",
        "isReturnable": true,
        "isSortable": true,
        "datePropertyOptions": {
          "operatorOptions": {
            "operatorName": "released",
            "lessThanOperatorName": "releasedbefore",
            "greaterThanOperatorName": "releasedafter"
          }
        }
      }
    ]
  }]
}

تعریف ویژگی شامل موارد زیر است:

یک رشته name .
گزینه‌های وابسته به نوع داده (مثلاً isReturnable ).
یک نوع و گزینه‌های مختص به آن نوع (مثلاً textPropertyOptions ).
operatorOptions برای عملگرهای جستجو.
displayOptions برای برچسب‌های رابط کاربری.

شما می‌توانید نام‌های ویژگی را در اشیاء مختلف دوباره استفاده کنید. برای مثال، movieTitle می‌تواند هم در یک شیء movie و هم در فیلموگرافی یک شیء person ظاهر شود.

گزینه‌های وابسته به نوع را اضافه کنید

PropertyDefinition شامل گزینه‌های بولی برای پیکربندی قابلیت جستجوی یک ویژگی، صرف نظر از نوع آن، است. این گزینه‌ها به طور پیش‌فرض روی false تنظیم شده‌اند و برای استفاده باید روی true تنظیم شوند.

isReturnable : اگر داده‌های ویژگی باید در نتایج جستجو با استفاده از API کوئری برگردانده شوند، روی true تنظیم می‌شود. ویژگی‌های غیرقابل‌برگشت می‌توانند برای جستجو یا رتبه‌بندی بدون نمایش در نتایج استفاده شوند.
isRepeatable : اگر ویژگی بتواند چندین مقدار داشته باشد، روی true تنظیم می‌شود. برای مثال، یک فیلم یک تاریخ انتشار دارد اما چندین بازیگر دارد.
isSortable : اگر بتوان از ویژگی برای مرتب‌سازی استفاده کرد، روی true تنظیم می‌شود. اگر isRepeatable مقدار true داشته باشد یا ویژگی درون یک زیرشیء تکرارپذیر باشد، نمی‌تواند true باشد.
isFacetable : اگر بتوان از این ویژگی برای تولید وجه‌ها (صفات مورد استفاده برای اصلاح نتایج جستجو) استفاده کرد، روی true تنظیم می‌شود.
- لازم است isReturnable برابر با true باشد.
- فقط برای ویژگی‌های enum، boolean و text پشتیبانی می‌شود.
isWildcardSearchable : برای اینکه کاربران بتوانند جستجوهای wildcard را روی این ویژگی انجام دهند، روی true تنظیم شده است. این گزینه فقط برای ویژگی‌های متنی در دسترس است و رفتار آن به تنظیم exactMatchWithOperator بستگی دارد:
- اگر exactMatchWithOperator true باشد: مقدار متن به عنوان یک توکن واحد در نظر گرفته می‌شود. یک پرس‌وجو مانند science-* با مقدار science-fiction مطابقت دارد.
- اگر exactMatchWithOperator برابر با false باشد: مقدار متن توکن‌سازی می‌شود. یک کوئری مانند sci* یا fi* با science-fiction مطابقت دارد، اما science-* اینطور نیست.

تعریف نوع

نوع داده را با تعریف شیء گزینه‌های ویژگی مناسب (مثلاً textPropertyOptions ) تنظیم کنید. اگر همه مقادیر ممکن را می‌دانید، از enumها ( enumPropertyOptions ) استفاده کنید. یک ویژگی فقط می‌تواند یک نوع داده داشته باشد.

تعریف گزینه‌های اپراتور

operatorOptions نحوه عملکرد یک ویژگی به عنوان یک عملگر جستجو را توصیف می‌کند.

هر operatorOptions به یک operatorName (مثلاً title ) نیاز دارد. این پارامتری است که کاربران در کوئری‌ها تایپ می‌کنند (مثلاً title:titanic ). از نام‌های قابل فهم استفاده کنید و آنها را در اختیار کاربران قرار دهید.

شما می‌توانید یک operatorName بین ویژگی‌های هم نوع به اشتراک بگذارید. کوئری‌هایی که از آن نام استفاده می‌کنند، نتایج را از تمام ویژگی‌های منطبق بازیابی می‌کنند.

ویژگی‌های قابل مرتب‌سازی می‌توانند شامل lessThanOperatorName و greaterThanOperatorName برای کوئری‌های مقایسه‌ای باشند. ویژگی‌های متنی می‌توانند از exactMatchWithOperator برای پردازش کل مقدار به عنوان یک توکن واحد استفاده کنند.

اضافه کردن گزینه‌های نمایش

بخش اختیاری displayOptions شامل یک displayLabel است. این یک برچسب کاربرپسند است که در نتایج جستجو نشان داده می‌شود.

افزودن اپراتورهای فیلتر پیشنهاد

suggestionFilteringOperators[] properties برای تعریف یک ویژگی که پیشنهادهای تکمیل خودکار را فیلتر می‌کند استفاده کنید (مثلاً فیلتر کردن پیشنهادهای فیلم بر اساس ژانر مورد نظر کاربر). شما فقط می‌توانید یک فیلتر پیشنهاد تعریف کنید.

طرحواره خود را ثبت کنید

طرحواره خود را با استفاده از شناسه منبع داده خود در سرویس طرحواره ثبت کنید. یک درخواست UpdateSchema صادر کنید:

PUT https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/schema

برای آزمایش طرحواره خود بدون ثبت آن، validateOnly: true استفاده کنید.

داده‌های خود را فهرست‌بندی کنید

پس از ثبت، منبع داده را با استفاده از فراخوانی‌های Index ، معمولاً با یک کانکتور ، پر کنید.

نمونه درخواست ایندکس گذاری:

{
  "name": "datasource/<data_source_id>/items/titanic",
  "metadata": {
    "title": "Titanic",
    "objectType": "movie"
  },
  "structuredData": {
    "object": {
      "properties": [{
        "name": "movieTitle",
        "textValues": { "values": ["Titanic"] }
      }]
    }
  },
  "itemType": "CONTENT_ITEM"
}

طرحواره خود را آزمایش کنید

قبل از تولید، با یک مخزن کوچک آزمایش کنید. یک ACL ایجاد کنید که نتایج را به یک کاربر آزمایشی محدود کند.

پرس و جوی عمومی : جستجوی یک رشته (مثلاً "titanic") برای مشاهده همه موارد منطبق.
پرس‌وجوی عملگر : از یک عملگر (مثلاً actor:Zane ) برای محدود کردن نتایج استفاده کنید.

طرحواره خود را تنظیم کنید

بازخورد کاربر را زیر نظر بگیرید و طرح خود را تنظیم کنید. می‌توانید فیلدهای جدید را فهرست‌بندی کنید یا نام عملگرها را تغییر دهید تا قابل فهم‌تر باشند.

پس از تغییر طرحواره، دوباره فهرست‌بندی کنید

برای تغییرات در موارد زیر نیازی به فهرست‌بندی مجدد ندارید:

نام اپراتورها.
محدودیت‌های عددی.
رتبه‌بندی مرتب شده.
گزینه‌های تازگی یا نمایش.

شما باید موارد زیر را دوباره فهرست‌بندی کنید:

اضافه کردن یا حذف کردن ویژگی‌ها یا اشیاء.
تغییر isReturnable ، isFacetable یا isSortable به true .
علامت‌گذاری یک ویژگی isSuggestable .

تغییرات غیرمجاز در ملک

تغییراتی که شاخص را خراب می‌کنند یا باعث نتایج متناقض می‌شوند، مجاز نیستند، از جمله:

نوع یا نام داده‌ی ویژگی.
تنظیمات exactMatchWithOperator یا retrievalImportance .

ایجاد یک تغییر پیچیده در طرحواره

برای ایجاد یک تغییر غیرمجاز، ویژگی‌ها را از یک تعریف قدیمی به یک تعریف جدید منتقل کنید:

یک ویژگی جدید با نام متفاوت به طرحواره اضافه کنید.
طرحواره را با هر دو ویژگی جدید و قدیمی ثبت کنید.
ایندکس را فقط با استفاده از ویژگی جدید، دوباره پر کنید.
ویژگی قدیمی را از طرحواره حذف کنید.
کد کوئری خود را به‌روزرسانی کنید تا از نام ویژگی جدید استفاده کند.

جستجوی ابری موارد حذف شده را به مدت 30 روز ثبت می‌کند تا از مشکلات استفاده مجدد جلوگیری شود.

محدودیت‌های اندازه

حداکثر ۱۰ شیء سطح بالا.
حداکثر عمق 10 سطح.
حداکثر ۱۰۰۰ فیلد برای هر شیء (شامل فیلدهای تو در تو).

مراحل بعدی

یک رابط جستجو ایجاد کنید.
کیفیت جستجو را بهبود بخشید .
یک طرحواره برای تفسیر بهینه پرس و جو ایجاد کنید .
مترادف‌ها را تعریف کنید .

ایجاد یک طرحواره

برای ایجاد طرح جستجوی ابری خود، این مراحل را دنبال کنید:

شناسایی رفتار مورد انتظار کاربر
مقداردهی اولیه یک منبع داده
اشیاء خود را تعریف کنید
تعریف ویژگی‌های شیء
طرحواره خود را ثبت کنید
داده‌های خود را فهرست‌بندی کنید
طرحواره خود را آزمایش کنید
طرحواره خود را تنظیم کنید

شناسایی رفتار مورد انتظار کاربر

برای همسو کردن طرحواره خود با رفتار کاربر:

ارزیابی درخواست‌های متنوع از کاربران مختلف.
مجموعه داده‌های منطقی یا اشیاء ، مانند یک «فیلم» را شناسایی کنید.
ویژگی‌ها (صفات) مانند عنوان یا تاریخ انتشار را شناسایی کنید.
مقادیر معتبر برای ویژگی‌ها، مانند «مهاجمان صندوقچه گمشده» را شناسایی کنید.
نیازهای مرتب‌سازی و رتبه‌بندی، مانند ترتیب زمانی یا رتبه‌بندی مخاطبان را تعیین کنید.
ویژگی‌های زمینه‌ای، مانند نقش شغلی، را برای بهبود پیشنهادات تکمیل خودکار شناسایی کنید.
این اشیاء، ویژگی‌ها و مقادیر نمونه را فهرست کنید. از این لیست برای تعریف گزینه‌های عملگر استفاده کنید.

منبع داده خود را مقداردهی اولیه کنید

اشیاء خود را تعریف کنید

یک طرحواره (schema) فهرستی از تعاریف اشیاء در تگ objectDefinitions است.

{
  "objectDefinitions": [
    { "name": "movie" },
    { "name": "person" }
  ]
}

تعریف ویژگی‌های شیء

{
  "objectDefinitions": [{
    "name": "movie",
    "propertyDefinitions": [
      {
        "name": "movieTitle",
        "isReturnable": true,
        "textPropertyOptions": {
          "retrievalImportance": { "importance": "HIGHEST" },
          "operatorOptions": { "operatorName": "title" }
        },
        "displayOptions": { "displayLabel": "Title" }
      },
      {
        "name": "releaseDate",
        "isReturnable": true,
        "isSortable": true,
        "datePropertyOptions": {
          "operatorOptions": {
            "operatorName": "released",
            "lessThanOperatorName": "releasedbefore",
            "greaterThanOperatorName": "releasedafter"
          }
        }
      }
    ]
  }]
}

تعریف ویژگی شامل موارد زیر است:

یک رشته name .
گزینه‌های وابسته به نوع داده (مثلاً isReturnable ).
یک نوع و گزینه‌های مختص به آن نوع (مثلاً textPropertyOptions ).
operatorOptions برای عملگرهای جستجو.
displayOptions برای برچسب‌های رابط کاربری.

گزینه‌های وابسته به نوع را اضافه کنید

isReturnable : اگر داده‌های ویژگی باید در نتایج جستجو با استفاده از API کوئری برگردانده شوند، روی true تنظیم می‌شود. ویژگی‌های غیرقابل‌برگشت می‌توانند برای جستجو یا رتبه‌بندی بدون نمایش در نتایج استفاده شوند.
isRepeatable : اگر ویژگی بتواند چندین مقدار داشته باشد، روی true تنظیم می‌شود. برای مثال، یک فیلم یک تاریخ انتشار دارد اما چندین بازیگر دارد.
isSortable : اگر بتوان از ویژگی برای مرتب‌سازی استفاده کرد، روی true تنظیم می‌شود. اگر isRepeatable مقدار true داشته باشد یا ویژگی درون یک زیرشیء تکرارپذیر باشد، نمی‌تواند true باشد.
isFacetable : اگر بتوان از این ویژگی برای تولید وجه‌ها (صفات مورد استفاده برای اصلاح نتایج جستجو) استفاده کرد، روی true تنظیم می‌شود.
- لازم است isReturnable برابر با true باشد.
- فقط برای ویژگی‌های enum، boolean و text پشتیبانی می‌شود.
isWildcardSearchable : برای اینکه کاربران بتوانند جستجوهای wildcard را روی این ویژگی انجام دهند، روی true تنظیم شده است. این گزینه فقط برای ویژگی‌های متنی در دسترس است و رفتار آن به تنظیم exactMatchWithOperator بستگی دارد:
- اگر exactMatchWithOperator true باشد: مقدار متن به عنوان یک توکن واحد در نظر گرفته می‌شود. یک پرس‌وجو مانند science-* با مقدار science-fiction مطابقت دارد.
- اگر exactMatchWithOperator برابر با false باشد: مقدار متن توکن‌سازی می‌شود. یک کوئری مانند sci* یا fi* با science-fiction مطابقت دارد، اما science-* اینطور نیست.

تعریف نوع

تعریف گزینه‌های اپراتور

operatorOptions نحوه عملکرد یک ویژگی به عنوان یک عملگر جستجو را توصیف می‌کند.

اضافه کردن گزینه‌های نمایش

بخش اختیاری displayOptions شامل یک displayLabel است. این یک برچسب کاربرپسند است که در نتایج جستجو نشان داده می‌شود.

افزودن اپراتورهای فیلتر پیشنهاد

طرحواره خود را ثبت کنید

طرحواره خود را با استفاده از شناسه منبع داده خود در سرویس طرحواره ثبت کنید. یک درخواست UpdateSchema صادر کنید:

PUT https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/schema

برای آزمایش طرحواره خود بدون ثبت آن، validateOnly: true استفاده کنید.

داده‌های خود را فهرست‌بندی کنید

پس از ثبت، منبع داده را با استفاده از فراخوانی‌های Index ، معمولاً با یک کانکتور ، پر کنید.

نمونه درخواست ایندکس گذاری:

{
  "name": "datasource/<data_source_id>/items/titanic",
  "metadata": {
    "title": "Titanic",
    "objectType": "movie"
  },
  "structuredData": {
    "object": {
      "properties": [{
        "name": "movieTitle",
        "textValues": { "values": ["Titanic"] }
      }]
    }
  },
  "itemType": "CONTENT_ITEM"
}

طرحواره خود را آزمایش کنید

قبل از تولید، با یک مخزن کوچک آزمایش کنید. یک ACL ایجاد کنید که نتایج را به یک کاربر آزمایشی محدود کند.

پرس و جوی عمومی : جستجوی یک رشته (مثلاً "titanic") برای مشاهده همه موارد منطبق.
پرس‌وجوی عملگر : از یک عملگر (مثلاً actor:Zane ) برای محدود کردن نتایج استفاده کنید.

طرحواره خود را تنظیم کنید

پس از تغییر طرحواره، دوباره فهرست‌بندی کنید

برای تغییرات در موارد زیر نیازی به فهرست‌بندی مجدد ندارید:

نام اپراتورها.
محدودیت‌های عددی.
رتبه‌بندی مرتب شده.
گزینه‌های تازگی یا نمایش.

شما باید موارد زیر را دوباره فهرست‌بندی کنید:

اضافه کردن یا حذف کردن ویژگی‌ها یا اشیاء.
تغییر isReturnable ، isFacetable یا isSortable به true .
علامت‌گذاری یک ویژگی isSuggestable .

تغییرات غیرمجاز در ملک

تغییراتی که شاخص را خراب می‌کنند یا باعث نتایج متناقض می‌شوند، مجاز نیستند، از جمله:

نوع یا نام داده‌ی ویژگی.
تنظیمات exactMatchWithOperator یا retrievalImportance .

ایجاد یک تغییر پیچیده در طرحواره

برای ایجاد یک تغییر غیرمجاز، ویژگی‌ها را از یک تعریف قدیمی به یک تعریف جدید منتقل کنید:

یک ویژگی جدید با نام متفاوت به طرحواره اضافه کنید.
طرحواره را با هر دو ویژگی جدید و قدیمی ثبت کنید.
ایندکس را فقط با استفاده از ویژگی جدید، دوباره پر کنید.
ویژگی قدیمی را از طرحواره حذف کنید.
کد کوئری خود را به‌روزرسانی کنید تا از نام ویژگی جدید استفاده کند.

جستجوی ابری موارد حذف شده را به مدت 30 روز ثبت می‌کند تا از مشکلات استفاده مجدد جلوگیری شود.

محدودیت‌های اندازه

حداکثر ۱۰ شیء سطح بالا.
حداکثر عمق 10 سطح.
حداکثر ۱۰۰۰ فیلد برای هر شیء (شامل فیلدهای تو در تو).

مراحل بعدی

یک رابط جستجو ایجاد کنید.
کیفیت جستجو را بهبود بخشید .
یک طرحواره برای تفسیر بهینه پرس و جو ایجاد کنید .
مترادف‌ها را تعریف کنید .

یک طرحواره ایجاد و ثبت کنید با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

ایجاد یک طرحواره

شناسایی رفتار مورد انتظار کاربر

منبع داده خود را مقداردهی اولیه کنید

اشیاء خود را تعریف کنید

تعریف ویژگی‌های شیء

گزینه‌های وابسته به نوع را اضافه کنید

تعریف نوع

تعریف گزینه‌های اپراتور

اضافه کردن گزینه‌های نمایش

افزودن اپراتورهای فیلتر پیشنهاد

طرحواره خود را ثبت کنید

داده‌های خود را فهرست‌بندی کنید

طرحواره خود را آزمایش کنید

طرحواره خود را تنظیم کنید

پس از تغییر طرحواره، دوباره فهرست‌بندی کنید

تغییرات غیرمجاز در ملک

ایجاد یک تغییر پیچیده در طرحواره

محدودیت‌های اندازه

مراحل بعدی

ایجاد یک طرحواره

شناسایی رفتار مورد انتظار کاربر

منبع داده خود را مقداردهی اولیه کنید

اشیاء خود را تعریف کنید

تعریف ویژگی‌های شیء

گزینه‌های وابسته به نوع را اضافه کنید

تعریف نوع

تعریف گزینه‌های اپراتور

اضافه کردن گزینه‌های نمایش

افزودن اپراتورهای فیلتر پیشنهاد

طرحواره خود را ثبت کنید

داده‌های خود را فهرست‌بندی کنید

طرحواره خود را آزمایش کنید

طرحواره خود را تنظیم کنید

پس از تغییر طرحواره، دوباره فهرست‌بندی کنید

تغییرات غیرمجاز در ملک

ایجاد یک تغییر پیچیده در طرحواره

محدودیت‌های اندازه

مراحل بعدی

یک طرحواره ایجاد و ثبت کنید