- ทรัพยากร: SearchApplication
- DataSourceRestriction
- แหล่งที่มา
- Source.PredefinedSource
- FilterOptions
- ตัวกรอง
- Filter.ValueFilter
- ค่า
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- เมธอด
ทรัพยากร: SearchApplication
SearchApplication
การแสดง JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
ช่อง | |
---|---|
name |
ชื่อของแอปพลิเคชันการค้นหา รูปแบบ: searchapplications/{applicationId} |
displayName |
ชื่อที่แสดงของแอปพลิเคชันการค้นหา มีความยาวได้สูงสุดไม่เกิน 300 อักขระ |
dataSourceRestrictions[] |
ข้อจำกัดที่ใช้กับการกำหนดค่า จำนวนองค์ประกอบสูงสุดคือ 10 |
sourceConfig[] |
การกำหนดค่าสำหรับแหล่งที่มาที่ระบุใน dataSourceRestrictions |
scoringConfig |
การกำหนดค่าสำหรับผลการจัดอันดับ |
defaultSortOptions |
ตัวเลือกเริ่มต้นสำหรับการจัดเรียงผลการค้นหา |
defaultFacetOptions[] |
ช่องเริ่มต้นสำหรับการแสดงผลข้อมูลประกอบ แหล่งที่มาที่ระบุไว้ที่นี่ได้รวมอยู่ใน |
returnResultThumbnailUrls |
สำหรับผลการค้นหาแต่ละรายการ เราควรแสดง URI สำหรับภาพขนาดย่อ (หากมี) |
operationIds[] |
เอาต์พุตเท่านั้น รหัสของการดำเนินการที่ใช้เวลานาน (LRO) ที่ทำงานอยู่สำหรับสคีมานี้ ฟิลด์เอาต์พุตเท่านั้น |
enableAuditLog |
ระบุว่ามีการเปิด/ปิดการบันทึกการตรวจสอบสําหรับคําขอสําหรับแอปพลิเคชันการค้นหาใน API การค้นหาหรือไม่ |
queryInterpretationConfig |
ตัวเลือกเริ่มต้นสำหรับการแปลค่าการค้นหา |
DataSourceRestriction
ข้อจำกัดในแหล่งข้อมูล
การแสดง JSON |
---|
{ "source": { object ( |
ช่อง | |
---|---|
source |
แหล่งที่มาของข้อจำกัด |
filterOptions[] |
ตัวเลือกตัวกรองที่จำกัดผลการค้นหา หากมีตัวกรองหลายรายการ ระบบจะจัดกลุ่มตามประเภทออบเจ็กต์ก่อนที่จะเข้าร่วม ตัวกรองที่มีออบเจ็กต์ประเภทเดียวกันจะถูกรวมเข้าด้วยกัน จากนั้นนิพจน์ที่ได้จะถูกรวมเข้าด้วยกันอย่างไม่ต่อเนื่อง จำนวนองค์ประกอบสูงสุดคือ 20 หมายเหตุ: API ที่แนะนำรองรับตัวกรองเพียง 2-3 รายการเท่านั้นในขณะนี้ ได้แก่ "objecttype", "type" และ "mimetype" ขณะนี้ยังใช้ตัวกรองเฉพาะสคีมาเพื่อกรองคำแนะนำไม่ได้ |
แหล่งที่มา
กำหนดแหล่งที่มาของ API การแนะนำ/การค้นหา
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม
|
|
name |
ชื่อแหล่งที่มาของเนื้อหาที่จัดทำดัชนีโดย |
predefinedSource |
แหล่งที่มาของเนื้อหาที่กำหนดไว้ล่วงหน้าสำหรับ Google Apps |
Source.PredefinedSource
แหล่งที่มาที่กำหนดไว้ล่วงหน้า:
Enum | |
---|---|
NONE |
|
QUERY_HISTORY |
แนะนำการค้นหาจากผู้ใช้ในอดีต ใช้ได้เมื่อใช้กับ Recommendation API เท่านั้น ละเว้นเมื่อใช้ใน API การค้นหา |
PERSON |
แนะนำบุคคลในองค์กร ใช้ได้เมื่อใช้กับ Recommendation API เท่านั้น ผลลัพธ์เป็นข้อผิดพลาดเมื่อใช้ใน API การค้นหา |
GOOGLE_DRIVE |
|
GOOGLE_GMAIL |
|
GOOGLE_SITES |
|
GOOGLE_GROUPS |
|
GOOGLE_CALENDAR |
|
GOOGLE_KEEP |
FilterOptions
ตัวเลือกตัวกรองที่จะนำไปใช้กับการค้นหา
การแสดง JSON |
---|
{
"objectType": string,
"filter": {
object ( |
ช่อง | |
---|---|
objectType |
ถ้าตั้งค่า objectTypeไว้ ระบบจะแสดงผลเฉพาะออบเจ็กต์ประเภทนั้น ซึ่งควรตรงกับชื่อของออบเจ็กต์ที่ลงทะเบียนไว้ภายในคำจำกัดความของสคีมา มีความยาวได้สูงสุดไม่เกิน 256 อักขระ |
filter |
ตัวกรองทั่วไปเพื่อจำกัดการค้นหา เช่น |
กรอง
วิธีทั่วไปในการแสดงตัวกรองในข้อความค้นหา ซึ่งรองรับ 2 วิธี ได้แก่
1. การตั้งค่า ValueFilter ชื่อต้องตรงกับ OperatName ที่ระบุไว้ในสคีมาสำหรับแหล่งข้อมูล
2. การตั้งค่า CompositeFilter ตัวกรองจะได้รับการประเมินโดยใช้โอเปอเรเตอร์ทางตรรกะ โอเปอเรเตอร์ระดับบนสุดจะเป็น AND หรือ NOT ได้เท่านั้น และจะปรากฏที่ระดับบนสุดเท่านั้น หรือ สามารถแสดงภายใต้ "และ" ระดับบนสุดเท่านั้น
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
การแสดง JSON |
---|
{
"operatorName": string,
"value": {
object ( |
ช่อง | |
---|---|
operatorName |
ใช้
|
value |
ค่าที่จะเปรียบเทียบ |
ค่า
คำจำกัดความของค่าเดียวที่มีประเภททั่วไป
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์การรวม value ค่าของพร็อพเพอร์ตี้ที่มีชื่อ value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
การแสดง JSON |
---|
{ "logicOperator": enum ( |
ช่อง | |
---|---|
logicOperator |
โอเปอเรเตอร์ตรรกะของตัวกรองย่อย |
subFilters[] |
ตัวกรองย่อย |
Filter.CompositeFilter.LogicOperator
Enum | |
---|---|
AND |
โอเปอเรเตอร์ทางตรรกะ ซึ่งใช้ได้กับตัวกรองย่อยเท่านั้น |
OR |
|
NOT |
ใช้ได้เฉพาะกับตัวกรองย่อยรายการเดียวเท่านั้น |
SourceConfig
การกำหนดค่าสำหรับแหล่งที่มาขณะประมวลผลคำขอ query.search
หรือ query.suggest
การแสดง JSON |
---|
{ "source": { object ( |
ช่อง | |
---|---|
source |
ต้นทางที่จะใช้การกำหนดค่านี้ |
scoringConfig |
การกำหนดค่าการให้คะแนนสำหรับแหล่งที่มา |
crowdingConfig |
การกำหนดค่าการกำหนดจำนวนสำหรับแหล่งที่มา |
SourceScoringConfig
กำหนดค่าการให้คะแนน วิธีนี้ช่วยให้แก้ไขการจัดอันดับผลการค้นหาของแหล่งที่มาได้
การแสดง JSON |
---|
{
"sourceImportance": enum ( |
ช่อง | |
---|---|
sourceImportance |
ความสำคัญของแหล่งที่มา |
SourceScoringConfig.SourceImportance
ความสำคัญของแหล่งที่มาซึ่งสามารถใช้เพื่อระบุว่าแหล่งที่มาควรให้ความสำคัญในการจัดอันดับมากกว่าเมื่อเทียบกับแหล่งที่มาอื่นหรือไม่
Enum | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
กำหนดขีดจำกัดจำนวนผลการค้นหา จำนวนคนหมายถึงสถานการณ์ที่ผลการค้นหาหลายรายการจากแหล่งที่มาเดียวกัน หรือโฮสต์เดียวกัน "กระจุกตัว" ของผลการค้นหาอื่นๆ ซึ่งทำให้คุณภาพการค้นหาสำหรับผู้ใช้ลดลง หากต้องการปรับปรุงคุณภาพการค้นหาและความหลากหลายของแหล่งข้อมูลในผลการค้นหา คุณสามารถกำหนดเงื่อนไขเพื่อลดผลการค้นหาที่ซ้ำกันตามแหล่งที่มาได้
การแสดง JSON |
---|
{ "numResults": integer, "numSuggestions": integer } |
ช่อง | |
---|---|
numResults |
จำนวนผลลัพธ์สูงสุดที่อนุญาตจากแหล่งข้อมูลในหน้าผลลัพธ์ ตราบใดที่ผลลัพธ์จากแหล่งที่มาอื่นๆ ยังไม่หมด ค่าที่ระบุต้องไม่เป็นค่าลบ ระบบจะใช้ค่าเริ่มต้นหากค่านี้เท่ากับ 0 หากต้องการปิดใช้การกำหนดจำนวนสูงสุด ให้ตั้งค่าค่าที่มากกว่า 100 |
numSuggestions |
จำนวนคำแนะนำสูงสุดที่อนุญาตจากแหล่งที่มา ระบบจะไม่มีการกำหนดขีดจํากัดในผลลัพธ์หากค่านี้น้อยกว่าหรือเท่ากับ 0 |
ScoringConfig
การกำหนดค่าการให้คะแนนสำหรับต้นทางขณะประมวลผลคำขอ query.search
หรือ query.suggest
การแสดง JSON |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
ช่อง | |
---|---|
disableFreshness |
พิจารณาว่าจะใช้ความใหม่เป็นสัญญาณการจัดอันดับหรือไม่ โดยค่าเริ่มต้น ระบบจะใช้ความใหม่เป็นสัญญาณการจัดอันดับ โปรดทราบว่าการตั้งค่านี้ไม่มีใน UI การดูแลระบบ |
disablePersonalization |
ต้องการปรับเปลี่ยนผลการค้นหาในแบบของคุณหรือไม่ โดยค่าเริ่มต้น ระบบจะใช้สัญญาณส่วนบุคคลเพื่อเพิ่มผลการค้นหา |
SortOptions
การแสดง JSON |
---|
{
"operatorName": string,
"sortOrder": enum ( |
ช่อง | |
---|---|
operatorName |
ชื่อของโอเปอเรเตอร์ที่ตรงกับช่องที่จะจัดเรียง โดยต้องทําเครื่องหมายที่พักที่เกี่ยวข้องเป็น |
sortOrder |
จากน้อยไปมากเป็นลำดับการจัดเรียงเริ่มต้น |
SortOptions.SortOrder
Enum | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
ระบุโอเปอเรเตอร์เพื่อแสดงผลการค้นหาข้อมูลประกอบ จะมี FacetResult 1 รายการสำหรับชุดค่าผสม sourceName/objectType/operatorName ทั้งหมด
การแสดง JSON |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
ช่อง | |
---|---|
sourceName |
ชื่อแหล่งที่มาสำหรับข้อมูลประกอบ รูปแบบ: datasources/{sourceId} หากเว้นว่าง ระบบจะใช้แหล่งข้อมูลทั้งหมด |
objectType |
หากตั้งค่า objectType ไว้ ระบบจะใช้เฉพาะออบเจ็กต์ประเภทนั้นเพื่อคำนวณข้อมูลประกอบ หากเว้นว่างไว้ ระบบจะใช้ออบเจ็กต์ทั้งหมดเพื่อคำนวณข้อมูลประกอบ |
operatorName |
ชื่อของโอเปอเรเตอร์ที่เลือกสำหรับข้อมูลประกอบ @ดู cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
จำนวนสูงสุดของที่เก็บข้อมูล Facet ที่ควรแสดงสำหรับ Facet นี้ ค่าเริ่มต้นคือ 10 ค่าสูงสุดคือ 100 |
integerFacetingOptions |
หากตั้งค่าไว้ จะอธิบายถึงตัวเลือกสำหรับปัจจัยด้านจำนวนเต็มสำหรับพร็อพเพอร์ตี้จำนวนเต็มที่กำหนด พร็อพเพอร์ตี้จำนวนเต็มที่เกี่ยวข้องในสคีมาควรทำเครื่องหมายเป็น isFacetable จำนวนที่เก็บข้อมูลที่แสดงผลจะเป็นจำนวนต่ำสุดของข้อมูลนี้และ numFacetBuckets |
IntegerFacetingOptions
ใช้เพื่อระบุตัวเลือกการจัดเรียงข้อมูลจำนวนเต็ม
การแสดง JSON |
---|
{ "integerBuckets": [ string ] } |
ช่อง | |
---|---|
integerBuckets[] |
ที่เก็บข้อมูลสำหรับค่าที่เป็นจำนวนเต็มที่กำหนดควรเรียงจากน้อยไปมากเท่านั้น ตัวอย่างเช่น ถ้าค่าที่ระบุคือ (1,5,10,100) ที่เก็บข้อมูลประกอบต่อไปนี้จะอยู่ในรูปแบบ {<1, [1,5), [5-10), [10-100), >=100} |
QueryInterpretationConfig
ตัวเลือกเริ่มต้นในการตีความการค้นหาของผู้ใช้
การแสดง JSON |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
ช่อง | |
---|---|
forceVerbatimMode |
เปิดใช้แฟล็กนี้เพื่อปิดการเพิ่มประสิทธิภาพภายในทั้งหมด เช่น การตีความคำค้นหาเป็นภาษาธรรมชาติ (NL) การดึงข้อมูลผลลัพธ์เสริม และการใช้คำพ้องความหมาย ซึ่งรวมถึงคำที่กำหนดเอง หากตั้งค่าธงนี้เป็น "จริง" ระบบจะมีลำดับความสำคัญเหนือตัวเลือกที่ตั้งค่าไว้ที่ระดับข้อความค้นหา สำหรับค่าเริ่มต้นเป็น "เท็จ" แฟล็กระดับคำค้นหาจะตั้งค่าการตีความที่ถูกต้องสำหรับโหมดคำต่อคำ |
forceDisableSupplementalResults |
ตั้งค่าแฟล็กนี้เพื่อปิดใช้การดึงข้อมูลผลลัพธ์เสริม การตั้งค่าแฟล็กที่นี่จะไม่ดึงผลลัพธ์เสริมสำหรับคำค้นหาที่เชื่อมโยงกับแอปพลิเคชันการค้นหาหนึ่งๆ หากตั้งค่าธงนี้เป็น "จริง" ระบบจะมีลำดับความสำคัญเหนือตัวเลือกที่ตั้งค่าไว้ที่ระดับข้อความค้นหา สำหรับค่าเริ่มต้นเป็น "เท็จ" แฟล็กระดับคำค้นหาจะตั้งค่าการตีความที่ถูกต้องสำหรับผลลัพธ์เสริม |
วิธีการ |
|
---|---|
|
สร้างแอปพลิเคชันการค้นหา |
|
ลบแอปพลิเคชันการค้นหา |
|
รับแอปพลิเคชันการค้นหาที่ระบุ |
|
แสดงรายการแอปพลิเคชันการค้นหาทั้งหมด |
|
อัปเดตแอปพลิเคชันการค้นหา |
|
รีเซ็ตแอปพลิเคชันการค้นหาเป็นการตั้งค่าเริ่มต้น |
|
อัปเดตแอปพลิเคชันการค้นหา |