สร้างอินเทอร์เฟซการค้นหาด้วย Query API

Query API มีวิธีการค้นหาและแนะนำสำหรับการสร้างอินเทอร์เฟซการค้นหาหรือฝังผลการค้นหาในแอปพลิเคชัน

สำหรับเว็บแอปพลิเคชันที่มีความต้องการขั้นต่ำ ให้ลองใช้วิดเจ็ต Search ดูข้อมูลเพิ่มเติมได้ที่สร้างอินเทอร์เฟซการค้นหาด้วยวิดเจ็ต Search

สร้างอินเทอร์เฟซการค้นหา

การสร้างอินเทอร์เฟซการค้นหาที่เรียบง่ายมีขั้นตอนหลายขั้นตอนดังนี้

1. กำหนดค่าแอปพลิเคชันการค้นหา
2. สร้างข้อมูลเข้าสู่ระบบ OAuth สำหรับแอปพลิเคชัน
3. ค้นหาดัชนี
4. แสดงผลการค้นหา

คุณยังสามารถปรับปรุงอินเทอร์เฟซการค้นหาเพิ่มเติมได้ด้วยฟีเจอร์ต่างๆ เช่น การแบ่งหน้า การจัดเรียง การกรอง ข้อมูลประกอบ และการแนะนำอัตโนมัติ

กำหนดค่าแอปพลิเคชันการค้นหา

คุณต้องสร้างแอปพลิเคชันการค้นหาอย่างน้อย 1 รายการเพื่อเชื่อมโยงกับอินเทอร์เฟซการค้นหาแต่ละรายการที่คุณสร้าง แอปพลิเคชันการค้นหามีพารามิเตอร์เริ่มต้นสำหรับการค้นหา เช่น แหล่งข้อมูลที่จะใช้ ลำดับการจัดเรียง ตัวกรอง และข้อมูลประกอบที่ต้องการขอ หากจำเป็น คุณจะลบล้างพารามิเตอร์เหล่านี้ได้โดยใช้ API การค้นหา

โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับแอปพลิเคชันการค้นหาที่หัวข้อปรับแต่งประสบการณ์การค้นหาใน Cloud Search

สร้างข้อมูลเข้าสู่ระบบ OAuth สำหรับแอปพลิเคชัน

นอกเหนือจากขั้นตอนในกำหนดค่าการเข้าถึง Google Cloud Search API แล้ว คุณต้องสร้างข้อมูลเข้าสู่ระบบ OAuth สำหรับเว็บแอปพลิเคชันด้วย ประเภทข้อมูลเข้าสู่ระบบที่คุณสร้างจะขึ้นอยู่กับบริบทที่ใช้ API

ใช้ข้อมูลเข้าสู่ระบบเพื่อส่งคำขอให้สิทธิ์ในนามของผู้ใช้ ใช้ขอบเขต https://www.googleapis.com/auth/cloud_search.query เมื่อขอสิทธิ์

ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวเลือก OAuth และไลบรารีของไคลเอ็นต์ได้ที่ [Google Identity Platform](https://developers.google.com/identity/choose-auth{: .external target="_blank"}

ค้นหาดัชนี

ใช้เมธอด search เพื่อค้นหาดัชนี

คำขอทุกรายการต้องมีข้อมูล 2 อย่าง ได้แก่ ข้อความ query ที่จะใช้จับคู่รายการ และ searchApplicationId ที่ระบุรหัสสำหรับแอปพลิเคชันการค้นหาที่จะใช้

ตัวอย่างต่อไปนี้แสดงคำค้นหาแหล่งข้อมูลภาพยนตร์ของภาพยนตร์เรื่อง Titanic

{
  "query": "titanic",
  "requestOptions": {
    "searchApplicationId": "searchapplications/<search_app_id>"
  },
}

แสดงผลการค้นหา

อย่างน้อยที่สุด อินเทอร์เฟซการค้นหาควรแสดงรายการ title รวมถึงลิงก์ไปยังรายการต้นฉบับ คุณสามารถเพิ่มประสิทธิภาพการแสดงผลการค้นหาเพิ่มเติมได้โดยการใช้ประโยชน์จากข้อมูลเพิ่มเติมที่ปรากฏในผลการค้นหา เช่น ตัวอย่างข้อมูลและข้อมูลเมตา

จัดการผลลัพธ์เสริม

โดยค่าเริ่มต้น Cloud Search จะแสดงผลลัพธ์เสริมเมื่อมีผลการค้นหาไม่เพียงพอสำหรับการค้นหาของผู้ใช้ ช่อง queryInterpretation ในการตอบกลับจะระบุเมื่อมีการแสดงผลลัพธ์เสริม หากแสดงเฉพาะผลลัพธ์เสริม ระบบจะตั้งค่า InterpretationType เป็น REPLACE หากมีการแสดงผลบางรายการสำหรับการค้นหาเดิมไปพร้อมกับผลลัพธ์เสริม ระบบจะตั้งค่า InterpretationType เป็น BLEND ทั้ง 2 กรณี QueryInterpretation.Reason = NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY

เมื่อมีการแสดงผลการค้นหาเสริมบางรายการ ให้ลองใส่ข้อความเพื่อบ่งชี้ว่าระบบแสดงผลการค้นหาเสริมแล้ว ตัวอย่างเช่น ในกรณีของ REPLACE คุณอาจแสดงสตริง "การค้นหาเดิมของคุณไม่ตรงกับผลการค้นหาใดๆ" กำลังแสดงผลการค้นหาสำหรับคำค้นหาที่คล้ายกัน"

ในกรณีของ BLEND คุณอาจแสดงสตริง "การค้นหาของคุณสำหรับคำค้นหาเดิมของคุณไม่ตรงกับผลลัพธ์ที่เพียงพอ รวมผลการค้นหาสำหรับ คำค้นหาที่คล้ายกัน"

จัดการผลการค้นหาบุคคล

Cloud Search จะแสดง "ผลการค้นหาบุคคล" 2 ประเภท ได้แก่ เอกสารที่เกี่ยวข้องกับบุคคลที่มีชื่อในการค้นหาและข้อมูลพนักงานของบุคคลที่มีชื่อในการค้นหา ผลการค้นหาประเภทหลังเป็นฟังก์ชันของฟีเจอร์การค้นหาบุคคลของ Cloud Search และดูผลลัพธ์ของคำค้นหาดังกล่าวได้ในช่อง structuredResults ของการตอบกลับจาก API การค้นหา

{
  "results": [...],
  "structuredResults": [{
    "person": {...}
  }]
}

การจับคู่ผู้ใต้บังคับบัญชา

การจับคู่รายงานโดยตรงเป็นฟีเจอร์การค้นหาบุคคลของ Cloud Search ซึ่งช่วยให้ผู้ใช้ดูรายงานโดยตรงของบุคคลในองค์กรได้ ผลลัพธ์จะอยู่ในช่อง structuredResults

สำหรับคำถามเกี่ยวกับผู้จัดการหรือผู้ใต้บังคับบัญชาของบุคคล คำตอบจะมี assistCardProtoHolder ภายใน structuredResults assistCardProtoHolder มีช่องชื่อ cardType ซึ่งเท่ากับ RELATED_PEOPLE_ANSWER_CARD assistCardProtoHolder มีการ์ดชื่อ relatedPeopleAnswerCard ซึ่งมีคำตอบจริง โดยมี subject (บุคคลที่รวมอยู่ในคำค้นหา) และ relatedPeople ซึ่งเป็นกลุ่มบุคคลที่เกี่ยวข้องกับเรื่อง ช่อง relationType จะแสดงค่า MANAGER หรือ DIRECT_REPORTS

โค้ดต่อไปนี้แสดงตัวอย่างการตอบสนองสำหรับการค้นหาที่ตรงกับคำค้นหาของผู้ใต้บังคับบัญชาโดยตรง

{
  "results": [],
  "structuredResults": [{
    "assistCardProtoHolder": {
      "extensions": {
        "@type": "type.googleapis.com/enterprise.topaz.sidekick.AssistCardProto",
        "cardMetadata": {
          "cardCategory": "ANSWER"
        },
        "cardType": "RELATED_PEOPLE_ANSWER_CARD",
        "relatedPeopleAnswerCard": {
          "subject": {
            "email": "AdamStanford@psincs-test01.newjnj.com",
            "displayName": "Adam Stanford"
            "manager": {
              "email": "simonsais@psincs-test01.newjnj.com"
            }
          },
          "relatedPeople": [{
            "email": "EdgarMountainRamirez@psincs-test01.newjnj.com",
            "displayName": "Edgar Mountain Ramirez"
          }, {
            "email": "FranciscoJoseMartinez@psincs-test01.newjnj.com",
            "displayName": "Francisco Jose Martinez"
          }],
          "relationType": "DIRECT_REPORTS",
        }
      }
    }
  }]
}

ปิดการเพิ่มประสิทธิภาพ รวมถึงผลลัพธ์เสริม

โดยค่าเริ่มต้น ระบบจะเปิดใช้การเพิ่มประสิทธิภาพ เช่น ผลลัพธ์เสริม อย่างไรก็ตาม คุณสามารถปิดการเพิ่มประสิทธิภาพทั้งหมดหรือเฉพาะผลลัพธ์เสริมได้ทั้งในระดับแอปพลิเคชันการค้นหาและระดับคำค้นหา

• หากต้องการปิดการเพิ่มประสิทธิภาพทั้งหมดในระดับแอปพลิเคชันการค้นหา ซึ่งรวมถึงผลลัพธ์เสริม คำพ้องความหมาย และการแก้ไขตัวสะกด ให้ตั้งค่า QueryInterpretationConfig.force_verbatim_mode เป็น true ในแอปพลิเคชันการค้นหา

• หากต้องการปิดการเพิ่มประสิทธิภาพทั้งหมดในระดับคำค้นหา รวมถึงผลลัพธ์เสริม คำพ้องความหมาย และการแก้ไขตัวสะกด ให้ตั้งค่า QueryInterpretationOptions.enableVerbatimMode เป็น true ในคำค้นหา

• หากต้องการปิดผลการค้นหาเสริมที่ระดับแอปพลิเคชันการค้นหา ให้ตั้งค่า QueryInterpretationOptions.forceDisableSupplementalResults เป็น true ในคำค้นหา

• หากต้องการปิดผลการค้นหาเสริมในระดับคำค้นหา ให้ตั้งค่า QueryInterpretationOptions.disableSupplementalResults เป็น true ในคำค้นหา

ตัวอย่างไฮไลต์

สำหรับรายการที่ส่งคืนซึ่งมีข้อความที่จัดทำดัชนีหรือเนื้อหา HTML ระบบจะส่งคืนตัวอย่างข้อมูลของเนื้อหา เนื้อหานี้ช่วยผู้ใช้พิจารณาความเกี่ยวข้องของสินค้าที่ส่งคืน

หากมีข้อความค้นหาในตัวอย่างข้อมูล จะมีช่วงการจับคู่อย่างน้อย 1 ช่วงที่ระบุตำแหน่งของคำนั้นกลับมาด้วย

ใช้ matchRanges เพื่อไฮไลต์ข้อความที่ตรงกันเมื่อแสดงผลลัพธ์ ตัวอย่าง JavaScript ต่อไปนี้จะแปลงข้อมูลโค้ดเป็นมาร์กอัป HTML โดยมีช่วงการจับคู่แต่ละช่วงซึ่งอยู่ในแท็ก <span>

function highlightSnippet(snippet) {
  let text = snippet.snippet;
  let formattedText = text;
  if (snippet.matchRanges) {
    let parts = [];
    let index = 0;
    for (let match of snippet.matchRanges) {
      let start = match.start || 0; // Default to 0 if omitted
      let end = match.end;
      if (index < start) { // Include any leading text before/between ranges
        parts.push(text.slice(index, start));
      }
      parts.push('<span class="highlight">');
      parts.push(text.slice(start, end));
      parts.push('</span>');
      index = end;
    }
    parts.push(text.slice(index)); // Include any trailing text after last range
    formattedText = parts.join('');
  }
  return formattedText;
}

ให้ตัวอย่างข้อมูล:

{
  "snippet": "This is an example snippet...",
  "matchRanges": [
    {
      "start": 11,
      "end": 18
    }
  ]
}

สตริง HTML ที่ได้คือ

This is an <span class="highlight">example</span> snippet...

ข้อมูลเมตาที่แสดงผล

ใช้ช่อง metadata เพื่อแสดงข้อมูลเพิ่มเติมเกี่ยวกับสินค้าที่ส่งคืนซึ่งอาจเกี่ยวข้องกับผู้ใช้ ช่อง metadata ประกอบด้วย createTime และ updateTime ของสินค้า รวมถึงข้อมูลที่มีโครงสร้างที่ส่งคืนได้ซึ่งเชื่อมโยงกับสินค้านั้น

หากต้องการแสดงข้อมูลที่มีโครงสร้าง ให้ใช้ช่อง displayOptions ช่อง displayOptions มีป้ายกำกับที่แสดงสำหรับประเภทออบเจ็กต์และชุด metalines ข้อมูลเมตาแต่ละรายการคืออาร์เรย์ของป้ายกำกับการแสดงผลและคู่ค่าตามที่กำหนดค่าไว้ในสคีมา

เรียกดูผลลัพธ์เพิ่มเติม

หากต้องการเรียกดูผลลัพธ์เพิ่มเติม ให้ตั้งค่าช่อง start ในคำขอเป็นออฟเซ็ตที่ต้องการ คุณปรับขนาดของแต่ละหน้าได้ด้วยช่อง pageSize

หากต้องการแสดงจำนวนรายการที่ส่งคืนหรือแสดงการควบคุมการแบ่งหน้าไปยังหน้าต่างๆ ผ่านรายการที่ส่งคืน ให้ใช้ช่อง resultCount โดยจะระบุค่าจริงหรือค่าโดยประมาณ ทั้งนี้ขึ้นอยู่กับขนาดของชุดผลลัพธ์

จัดเรียงผลการค้นหา

ใช้ช่อง sortOptions เพื่อระบุลำดับของสินค้าที่ส่งคืน ค่า sortOptions คือออบเจ็กต์ที่มี 2 ช่องดังนี้

• operatorName — โอเปอเรเตอร์สำหรับพร็อพเพอร์ตี้ข้อมูลที่มีโครงสร้างที่จะจัดเรียง สำหรับพร็อพเพอร์ตี้ที่มีโอเปอเรเตอร์หลายรายการ คุณจะจัดเรียงได้โดยใช้โอเปอเรเตอร์ความเทียบเท่าหลักเท่านั้น
• sortOrder — ทิศทางการจัดเรียง ไม่ว่าจะเป็น ASCENDING หรือ DESCENDING

ความเกี่ยวข้องยังใช้เป็นคีย์การจัดเรียงรองด้วย หากไม่ได้ระบุลำดับการจัดเรียงในคำค้นหา ผลลัพธ์จะจัดอันดับตามความเกี่ยวข้องเท่านั้น

"sortOptions": {
  "operatorName": "priority",
  "sortOrder": "DESCENDING"
}

เพิ่มตัวกรอง

นอกจากนิพจน์คำค้นหาแล้ว คุณยังจำกัดผลลัพธ์เพิ่มเติมได้โดยใช้ตัวกรอง คุณระบุตัวกรองได้ทั้งในแอปพลิเคชันการค้นหาและในคำขอการค้นหา

หากต้องการเพิ่มตัวกรองในคำขอหรือแอปพลิเคชันการค้นหา ให้เพิ่มตัวกรองในช่อง dataSourceRestrictions.filterOptions[]

การกรองแหล่งข้อมูลเพิ่มเติมมี 2 วิธีหลักดังนี้

• ตัวกรองออบเจ็กต์ผ่านพร็อพเพอร์ตี้ filterOptions[].objectType จะจำกัดรายการที่ตรงกับประเภทที่ระบุตามที่ระบุไว้ในสคีมาที่กำหนดเอง
• ตัวกรองค่า — จำกัดรายการที่ตรงกันตามโอเปอเรเตอร์การค้นหาและค่าที่ระบุ

ตัวกรองแบบผสมช่วยให้รวมตัวกรองค่าหลายค่าลงในนิพจน์เชิงตรรกะสำหรับการค้นหาที่ซับซ้อนมากขึ้นได้

ในตัวอย่างสคีมาภาพยนตร์ คุณใช้การจำกัดอายุตามผู้ใช้ปัจจุบันและจำกัดภาพยนตร์ที่มีอยู่ตามการจัดประเภทของ MPAA ได้

{
  "query": "adventure",
  "requestOptions": {
    "searchApplicationId": "<search_app_id>"
  },
  "dataSourceRestrictions": [
    {
      "source": {
        "name": "datasources/<data_source_id>"
      },
      "filterOptions": [
        {
          "objectType": "movie",
          "filter": {
            "compositeFilter": {
              "logicOperator": "AND"
              "subFilters": [
                {
                  "compositeFilter": {
                  "logicOperator": "OR"
                  "subFilters": [
                    {
                      "valueFilter": {
                        "operatorName": "rated",
                        "value": {
                          "stringValue": "G"
                        }
                      }
                    },
                    {
                      "valueFilter": {
                        "operatorName": "rated",
                        "value": {
                          "stringValue": "PG"
                        }
                      }
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }
  ]
}

ปรับแต่งผลการค้นหาด้วยข้อมูลประกอบ

ข้อมูลประกอบคือพร็อพเพอร์ตี้ที่มีการจัดทำดัชนีซึ่งแสดงหมวดหมู่ของการปรับแต่งผลการค้นหา ใช้ข้อมูลประกอบเพื่อช่วยให้ผู้ใช้ปรับแต่งคำค้นหาได้แบบอินเทอร์แอกทีฟ และค้นหารายการที่เกี่ยวข้องได้เร็วขึ้น

คุณกำหนดข้อมูลประกอบในแอปพลิเคชันการค้นหาได้ และการตั้งค่าในคำค้นหาจะลบล้างข้อมูลเหล่านี้

เมื่อส่งคำขอข้อมูลประกอบ Cloud Search จะคำนวณค่าที่พบมากที่สุดสำหรับพร็อพเพอร์ตี้ที่ขอในแต่ละรายการที่ตรงกัน ค่าเหล่านี้จะแสดงในการตอบกลับ ใช้ค่าเหล่านี้เพื่อสร้างตัวกรอง ที่จำกัดผลลัพธ์ในคำค้นหาที่ตามมาให้แคบลง

รูปแบบการโต้ตอบกับข้อมูลประกอบโดยทั่วไปมีดังนี้

1. สร้างการค้นหาเริ่มต้นโดยระบุพร็อพเพอร์ตี้ที่จะรวมไว้ในผลการค้นหาข้อมูลประกอบ
2. แสดงผลการค้นหาและข้อมูลประกอบ
3. ผู้ใช้เลือกค่าข้อมูลประกอบอย่างน้อยหนึ่งค่าเพื่อปรับแต่งผลลัพธ์
4. ค้นหาซ้ำโดยใช้ตัวกรองตามค่าที่เลือก

เช่น หากต้องการเปิดใช้การปรับแต่งการค้นหาภาพยนตร์ตามปีและการจัดประเภท MPAA ให้ใส่พร็อพเพอร์ตี้ facetOptions ไว้ในคำค้นหา

"facetOptions": [
  {
    "sourceName": "datasources/<data_source_id>",
    "operatorName": "year"
  },
  {
    "sourceName": "datasources/<data_source_id>",
    "operatorName": "rated"
  }
]

ผลลัพธ์ข้อมูลประกอบที่มีฟิลด์แบบจำนวนเต็ม

นอกจากนี้คุณยังสามารถขอข้อมูลประกอบที่มีฟิลด์แบบจำนวนเต็มได้ เช่น คุณอาจทำเครื่องหมายพร็อพเพอร์ตี้จำนวนเต็ม book_pages เป็น Facetable เพื่อปรับแต่งผลการค้นหาเกี่ยวกับหนังสือที่มีหน้า "100-200" ได้

เมื่อตั้งค่าสคีมาของช่องพร็อพเพอร์ตี้จำนวนเต็ม ให้ตั้งค่า isFacetable เป็น true และเพิ่มตัวเลือกการเก็บข้อมูลที่เกี่ยวข้องลงใน integerPropertyOptions วิธีนี้ช่วยให้มั่นใจว่าพร็อพเพอร์ตี้จำนวนเต็มที่แสดงได้ทุกรายการมีการกำหนดตัวเลือกที่เก็บข้อมูลเริ่มต้นไว้แล้ว

เมื่อกำหนดตรรกะตัวเลือกการเก็บข้อมูล ให้ระบุอาร์เรย์ของค่าที่เพิ่มขึ้นซึ่งเป็นช่วงที่ระบุ ตัวอย่างเช่น หากผู้ใช้ปลายทางระบุช่วงเป็น 2, 5, 10, 100 ระบบจะคำนวณข้อมูลประกอบสำหรับ <2, [2-5), [5-10), [10-100), >=100

คุณลบล้างข้อมูลประกอบที่อิงตามจำนวนเต็มได้โดยกำหนดตัวเลือกการฝากข้อมูลเดียวกันกับ facetOptions ในคำขอ หากจำเป็น Cloud Search จะใช้ตัวเลือกการจัดเก็บข้อมูลที่กำหนดไว้ในสคีมาเมื่อทั้งแอปพลิเคชันการค้นหาและคำขอค้นหาไม่ได้กำหนดตัวเลือกข้อมูลประกอบไว้ ข้อมูลประกอบที่กำหนดไว้ในคำค้นหามีความสำคัญเหนือข้อมูลประกอบที่กำหนดไว้ในแอปพลิเคชันการค้นหา และข้อมูลประกอบที่กำหนดไว้ในแอปพลิเคชันการค้นหาจะมีลำดับความสำคัญเหนือกว่าข้อมูลประกอบที่กำหนดไว้ในสคีมา

ผลลัพธ์ข้อมูลประกอบตามขนาดหรือวันที่ของเอกสาร

คุณสามารถใช้โอเปอเรเตอร์ที่สงวนไว้เพื่อปรับแต่งผลการค้นหาตามขนาดไฟล์ของเอกสาร วัดเป็นไบต์ หรือตามเวลาที่สร้างหรือแก้ไขเอกสาร คุณไม่จำเป็นต้องกำหนดสคีมาที่กำหนดเอง แต่จำเป็นต้องระบุค่า operatorName ใน FacetOptions ของแอปพลิเคชันการค้นหา

• สำหรับการดูข้อมูลประกอบตามขนาดเอกสาร ให้ใช้ itemsize และกำหนดตัวเลือกที่เก็บข้อมูล
• สำหรับการดูข้อมูลประกอบตามวันที่สร้างเอกสาร ให้ใช้ createddatetimestamp
• สำหรับการดูข้อมูลประกอบตามวันที่แก้ไขเอกสาร ให้ใช้ lastmodified

การตีความที่เก็บข้อมูลประกอบ

พร็อพเพอร์ตี้ facetResults ในการตอบกลับคำค้นหาจะรวมคำขอตัวกรองแบบตรงทั้งหมดของผู้ใช้ในช่อง filter สำหรับ bucket แต่ละรายการ

สำหรับข้อมูลประกอบที่ไม่ได้อิงตามจำนวนเต็ม facetResults จะรวมรายการพร็อพเพอร์ตี้ที่ขอแต่ละรายการ สำหรับแต่ละพร็อพเพอร์ตี้ จะมีการแสดงรายการค่าหรือช่วงที่เรียกว่า buckets โดยค่าที่เกิดขึ้นบ่อยที่สุดจะแสดงก่อน

เมื่อผู้ใช้เลือกค่าที่จะกรองอย่างน้อย 1 ค่า ให้สร้างการค้นหาใหม่ด้วยตัวกรองที่เลือก แล้วค้นหา API อีกครั้ง

เพิ่มคำแนะนำ

ใช้ API แนะนำเพื่อเติมข้อความอัตโนมัติให้กับข้อความค้นหาตามประวัติการค้นหาส่วนตัวของผู้ใช้ รายชื่อติดต่อ และรายการเอกสาร

ตัวอย่างเช่น การเรียกต่อไปนี้ให้คำแนะนำเกี่ยวกับวลี jo บางส่วน

{
  "query": "jo",
  "requestOptions": {
    "searchApplicationId": "<search_app_id>",
    "peoplePhotoOptions": {
      "peoplePhotoUrlSizeInPx": 32
    },
    "timeZone": "America/Denver"
  }
}

จากนั้นคุณจะสามารถแสดงคำแนะนำที่ได้ตามความเหมาะสมสำหรับแอปพลิเคชันของคุณ