- การแสดง JSON
- ObjectDefinition
- ObjectOptions
- ObjectOptions.FreshnessOptions
- ObjectDisplayOptions
- ObjectDisplayOptions.Metaline
- ObjectDisplayOptions.DisplayedProperty
- PropertyDefinition
- IntegerPropertyOptions
- IntegerPropertyOptions.OrderedRanking
- IntegerPropertyOptions.IntegerOperatorOptions
- DoublePropertyOptions
- DoublePropertyOptions.DoubleOperatorOptions
- TimestampPropertyOptions
- TimestampPropertyOptions.TimestampOperatorOptions
- BooleanPropertyOptions
- BooleanPropertyOptions.BooleanOperatorOptions
- ObjectPropertyOptions
- EnumPropertyOptions
- EnumPropertyOptions.EnumValuePair
- EnumPropertyOptions.OrderedRanking
- EnumPropertyOptions.EnumOperatorOptions
- DatePropertyOptions
- DatePropertyOptions.DateOperatorOptions
- TextPropertyOptions
- RetrievalImportance
- RetrievalImportance.Importance
- TextPropertyOptions.TextOperatorOptions
- HtmlPropertyOptions
- HtmlPropertyOptions.HtmlOperatorOptions
- PropertyDisplayOptions
คำจำกัดความของสคีมาสำหรับแหล่งข้อมูล
การแสดง JSON |
---|
{
"objectDefinitions": [
{
object ( |
ช่อง | |
---|---|
objectDefinitions[] |
รายการออบเจ็กต์ระดับบนสุดสำหรับแหล่งข้อมูล จำนวนองค์ประกอบสูงสุดคือ 10 |
operationIds[] |
รหัสของการดำเนินการที่ใช้เวลานาน (LRO) ที่ทำงานอยู่สำหรับสคีมานี้ หลังจากแก้ไขสคีมาแล้ว โปรดรอให้การดำเนินการเสร็จสมบูรณ์ก่อนจัดทำดัชนีเนื้อหาเพิ่มเติม |
ObjectDefinition
คำจำกัดความของออบเจ็กต์ภายในแหล่งข้อมูล
การแสดง JSON |
---|
{ "name": string, "options": { object ( |
ช่อง | |
---|---|
name |
ชื่อของออบเจ็กต์ ซึ่งจะกำหนดประเภทของออบเจ็กต์ คำขอจัดทำดัชนีรายการควรตั้งค่าช่อง |
options |
ตัวเลือกที่เจาะจงออบเจ็กต์ซึ่งไม่บังคับ |
propertyDefinitions[] |
คำจำกัดความของพร็อพเพอร์ตี้สำหรับออบเจ็กต์ จำนวนองค์ประกอบสูงสุดคือ 1,000 |
ObjectOptions
ตัวเลือกสำหรับออบเจ็กต์
การแสดง JSON |
---|
{ "freshnessOptions": { object ( |
ช่อง | |
---|---|
freshnessOptions |
ตัวเลือกความใหม่ของออบเจ็กต์ |
displayOptions |
ตัวเลือกที่กำหนดวิธีแสดงออบเจ็กต์ในหน้าผลการค้นหาของ Cloud Search |
suggestionFilteringOperators[] |
โอเปอเรเตอร์ที่สามารถใช้เพื่อกรองคำแนะนำ สำหรับ หมายเหตุ: ระบบรองรับ "objecttype", "type" และ "mimetype" อยู่แล้ว พร็อพเพอร์ตี้นี้ใช้สำหรับกำหนดค่าโอเปอเรเตอร์เฉพาะสคีมา แม้ว่าจะเป็นอาร์เรย์ แต่ก็ระบุโอเปอเรเตอร์ได้เพียง 1 รายการเท่านั้น ซึ่งจะเป็นอาร์เรย์สำหรับการขยายในอนาคต ระบบไม่รองรับโอเปอเรเตอร์ที่จับคู่กับพร็อพเพอร์ตี้หลายรายการภายในออบเจ็กต์เดียวกัน หากโอเปอเรเตอร์ครอบคลุมออบเจ็กต์ประเภทต่างๆ คุณจะต้องตั้งค่าตัวเลือกนี้ 1 ครั้งสำหรับการกำหนดออบเจ็กต์แต่ละรายการ |
ObjectOptions.FreshnessOptions
ระบุพร็อพเพอร์ตี้ความใหม่ที่จะใช้เมื่อปรับการจัดอันดับการค้นหาสำหรับรายการ วันที่ที่ใหม่กว่าและใหม่กว่าบ่งบอกถึงคุณภาพที่สูงกว่า ใช้พร็อพเพอร์ตี้ตัวเลือกความใหม่ที่ใช้ได้กับข้อมูลมากที่สุด สำหรับเอกสาร Fileshare เวลาที่แก้ไขล่าสุดจะมีความเกี่ยวข้องมากที่สุด สําหรับข้อมูลกิจกรรมในปฏิทิน เวลาที่กิจกรรมเกิดขึ้นจะเป็นตัวบ่งชี้ความใหม่ที่เกี่ยวข้องมากกว่า ด้วยวิธีนี้ กิจกรรมในปฏิทินที่เกิดขึ้นใกล้กับเวลาค้นหามากกว่าจะถือว่ามีคุณภาพสูงและจัดอันดับไว้ตามนั้น
การแสดง JSON |
---|
{ "freshnessProperty": string, "freshnessDuration": string } |
ช่อง | |
---|---|
freshnessProperty |
คุณสมบัตินี้จะระบุระดับความใหม่ของออบเจ็กต์ในดัชนี หากตั้งค่าไว้ พร็อพเพอร์ตี้นี้ต้องเป็นพร็อพเพอร์ตี้ระดับบนสุดภายใน เมื่อใช้พร็อพเพอร์ตี้เพื่อคํานวณความใหม่ ค่าเริ่มต้นจะเป็น 2 ปีนับจากเวลาปัจจุบัน |
freshnessDuration |
ระยะเวลาที่ต้องการให้ระบบพิจารณาว่าออบเจ็กต์ไม่มีการอัปเดต ค่าเริ่มต้นคือ 180 วัน (เป็นวินาที) ระยะเวลาเป็นวินาทีโดยมีตัวเลขเศษส่วนไม่เกิน 9 หลัก ซึ่งลงท้ายด้วย " |
ObjectDisplayOptions
ตัวเลือกการแสดงผลสำหรับวัตถุ
การแสดง JSON |
---|
{
"objectDisplayLabel": string,
"metalines": [
{
object ( |
ช่อง | |
---|---|
objectDisplayLabel |
ป้ายกำกับที่ใช้งานง่ายซึ่งจะแสดงในผลการค้นหาเพื่อระบุประเภทของรายการ (ไม่บังคับ) หากไม่ได้ระบุ ป้ายกำกับออบเจ็กต์จะไม่แสดงในบรรทัดบริบทของผลการค้นหา มีความยาวได้สูงสุดไม่เกิน 64 อักขระ |
metalines[] |
กำหนดคุณสมบัติที่แสดงในเมตาไลน์ของผลการค้นหา ค่าพร็อพเพอร์ตี้จะแสดงตามลำดับที่ระบุไว้ที่นี่ หากพร็อพเพอร์ตี้มีหลายค่า ค่าทั้งหมดจะแสดงก่อนพร็อพเพอร์ตี้ถัดไป ด้วยเหตุนี้ จึงควรระบุพร็อพเพอร์ตี้เอกพจน์ก่อนพร็อพเพอร์ตี้ที่ซ้ำกันในรายการนี้ พร็อพเพอร์ตี้ทั้งหมดต้องตั้งค่า |
ObjectDisplayOptions.Metaline
เมตาไลน์คือรายการที่พักที่แสดงควบคู่กับผลการค้นหาเพื่อให้บริบท
การแสดง JSON |
---|
{
"properties": [
{
object ( |
ช่อง | |
---|---|
properties[] |
รายการพร็อพเพอร์ตี้ที่แสดงสำหรับเมตาไลน์ จำนวนพร็อพเพอร์ตี้สูงสุดคือ 5 รายการ |
ObjectDisplayOptions.DisplayedProperty
การอ้างอิงไปยังพร็อพเพอร์ตี้ระดับบนสุดภายในออบเจ็กต์ที่ควรแสดงในผลการค้นหา ค่าของพร็อพเพอร์ตี้ที่เลือกจะแสดงในผลการค้นหาพร้อมกับ display label
สำหรับพร็อพเพอร์ตี้นั้นหากระบุไว้ หากไม่ได้ระบุป้ายกำกับที่ปรากฏ ระบบจะแสดงเฉพาะค่าเท่านั้น
การแสดง JSON |
---|
{ "propertyName": string } |
ช่อง | |
---|---|
propertyName |
ชื่อของพร็อพเพอร์ตี้ระดับบนสุดตามที่ระบุไว้ในคำจำกัดความพร็อพเพอร์ตี้ของออบเจ็กต์ หากชื่อไม่ใช่พร็อพเพอร์ตี้ที่กำหนดไว้ในสคีมา ระบบจะแสดงข้อผิดพลาดเมื่อพยายามอัปเดตสคีมา |
PropertyDefinition
คำจำกัดความของพร็อพเพอร์ตี้ภายในออบเจ็กต์
การแสดง JSON |
---|
{ "name": string, "isReturnable": boolean, "isRepeatable": boolean, "isSortable": boolean, "isFacetable": boolean, "isSuggestable": boolean, "isWildcardSearchable": boolean, "displayOptions": { object ( |
ช่อง | |
---|---|
name |
ชื่อของพร็อพเพอร์ตี้ คำขอจัดทำดัชนีรายการที่ส่งไปยัง Indexing API ควรตั้งค่า |
isReturnable |
ระบุว่าพร็อพเพอร์ตี้ระบุข้อมูลที่ควรแสดงในผลการค้นหาผ่าน Query API หากตั้งค่าเป็น true แสดงว่าผู้ใช้ Query API สามารถใช้ช่องพร็อพเพอร์ตี้ที่ตรงกันในผลการค้นหาได้ อย่างไรก็ตาม การจัดเก็บช่องจะต้องมีการจัดสรรพื้นที่มากขึ้นและใช้แบนด์วิดท์มากขึ้นสำหรับคำค้นหา ซึ่งจะส่งผลต่อประสิทธิภาพเมื่อดำเนินการกับชุดข้อมูลขนาดใหญ่ ตั้งค่าเป็น true ที่นี่เฉพาะในกรณีที่จำเป็นต้องใช้ช่องนี้สำหรับผลการค้นหา ไม่สามารถเป็นจริงสำหรับพร็อพเพอร์ตี้ที่มีประเภทเป็นออบเจ็กต์ |
isRepeatable |
ระบุว่าพร็อพเพอร์ตี้มีหลายค่าที่อนุญาต เช่น เอกสารมีคำอธิบายเพียง 1 รายการ แต่มีหลายความคิดเห็นได้ ไม่สามารถเป็นจริงสำหรับพร็อพเพอร์ตี้ที่มีประเภทเป็นบูลีน หากตั้งค่าเป็น "เท็จ" พร็อพเพอร์ตี้ที่มีค่ามากกว่า 1 ค่าจะทำให้คำขอการจัดทำดัชนีสำหรับรายการนั้นถูกปฏิเสธ |
isSortable |
ระบุว่าสามารถใช้พร็อพเพอร์ตี้ในการจัดเรียง ไม่สามารถเป็นจริงสำหรับพร็อพเพอร์ตี้ที่ใช้ซ้ำได้ ไม่สามารถเป็นจริงสำหรับพร็อพเพอร์ตี้ที่มีประเภทเป็นออบเจ็กต์ IsReturnable เป็น "จริง" เพื่อตั้งค่าตัวเลือกนี้ รองรับเฉพาะคุณสมบัติบูลีน วันที่ จำนวนเต็ม การประทับเวลา |
isFacetable |
ระบุว่าพร็อพเพอร์ตี้ใช้เพื่อสร้างข้อมูลประกอบได้ ไม่สามารถเป็นจริงสำหรับพร็อพเพอร์ตี้ที่มีประเภทเป็นออบเจ็กต์ IsReturnable เป็น "จริง" เพื่อตั้งค่าตัวเลือกนี้ รองรับเฉพาะคุณสมบัติบูลีน, enum, จำนวนเต็ม และข้อความเท่านั้น |
isSuggestable |
ระบุว่าใช้พร็อพเพอร์ตี้เพื่อสร้างคำแนะนำการค้นหาได้ |
isWildcardSearchable |
ระบุว่าผู้ใช้ค้นหาโดยใช้ไวลด์การ์ดสำหรับพร็อพเพอร์ตี้นี้ได้ รองรับเฉพาะพร็อพเพอร์ตี้ "ข้อความ" IsReturnable เป็น "จริง" เพื่อตั้งค่าตัวเลือกนี้ ในแหล่งข้อมูลหนึ่งๆ จะทำเครื่องหมายพร็อพเพอร์ตี้เป็น isWildcardSearchable ได้สูงสุด 5 รายการ โปรดดูรายละเอียดเพิ่มเติมที่หัวข้อกำหนดพร็อพเพอร์ตี้ออบเจ็กต์ |
displayOptions |
ตัวเลือกที่กำหนดวิธีแสดงพร็อพเพอร์ตี้ในหน้าผลการค้นหาของ Cloud Search หากกำหนดให้แสดงใน |
ฟิลด์การรวม property_options ตัวเลือกเฉพาะประเภทที่กำหนดวิธีจัดทำดัชนีและใช้พร็อพเพอร์ตี้ ในกรณีที่ตัวเลือกควรเป็นตัวเลือกเริ่มต้นสำหรับประเภทหนึ่งๆ ช่องนี้ยังคงต้องตั้งค่าเป็นประเภทใดประเภทหนึ่ง หากไม่ได้ตั้งค่าช่องนี้ การอัปเดตสคีมาจะถูกปฏิเสธ property_options ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
integerPropertyOptions |
|
doublePropertyOptions |
|
timestampPropertyOptions |
|
booleanPropertyOptions |
|
objectPropertyOptions |
|
enumPropertyOptions |
|
datePropertyOptions |
|
textPropertyOptions |
|
htmlPropertyOptions |
|
IntegerPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้จำนวนเต็ม
การแสดง JSON |
---|
{ "orderedRanking": enum ( |
ช่อง | |
---|---|
orderedRanking |
ใช้เพื่อระบุการจัดลำดับที่เรียงตามลำดับสำหรับจำนวนเต็ม ใช้ได้ต่อเมื่อ |
minimumValue |
ค่าต่ำสุดของพร็อพเพอร์ตี้ ค่าต่ำสุดและสูงสุดสำหรับพร็อพเพอร์ตี้จะใช้ในการจัดอันดับผลลัพธ์ตาม |
maximumValue |
ค่าสูงสุดของพร็อพเพอร์ตี้ ค่าต่ำสุดและสูงสุดสำหรับพร็อพเพอร์ตี้จะใช้ในการจัดอันดับผลลัพธ์ตาม |
operatorOptions |
หากตั้งค่าไว้ จะอธิบายว่าควรใช้จำนวนเต็มเป็นโอเปอเรเตอร์การค้นหาอย่างไร |
integerFacetingOptions |
หากตั้งค่าไว้ จะอธิบายถึงตัวเลือกสำหรับปัจจัยด้านจำนวนเต็มสำหรับพร็อพเพอร์ตี้จำนวนเต็มที่กำหนด ควรทำเครื่องหมายพร็อพเพอร์ตี้จำนวนเต็มที่ตรงกันเป็น Facetable |
IntegerPropertyOptions.OrderedRanking
ใช้เพื่อระบุว่าควรจัดอันดับค่าจำนวนเต็มอย่างไรเมื่อเทียบกับค่าอื่นๆ จำนวนเต็มที่มีอันดับสูงกว่าหมายถึงความสำคัญที่มากขึ้น ตัวอย่างเช่น ในแหล่งข้อมูลบางแห่ง แหล่งข้อมูลที่มีลำดับความสำคัญต่ำกว่าบ่งชี้ถึงความสำคัญที่สูงกว่า ขณะที่แหล่งข้อมูลอื่นๆ ลำดับความสำคัญสูงกว่าบ่งชี้ถึงความสำคัญที่สูงกว่า
Enum | |
---|---|
NO_ORDER |
ไม่มีลำดับการจัดอันดับสำหรับพร็อพเพอร์ตี้ ค่าของพร็อพเพอร์ตี้นี้ไม่ปรับผลลัพธ์ |
ASCENDING |
ระบบจะจัดอันดับที่พักนี้จากน้อยไปหามาก ค่าที่ต่ำกว่าบ่งบอกถึงอันดับที่ต่ำกว่า |
DESCENDING |
พร็อพเพอร์ตี้นี้ได้รับการจัดอันดับจากมากไปน้อย ค่าที่ต่ำกว่าบ่งบอกถึงอันดับที่สูงขึ้น |
IntegerPropertyOptions.IntegerOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้ที่เป็นจำนวนเต็ม ขั้นตอนนี้เป็นตัวเลือกที่ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาเป็นช่องเฉพาะที่เกี่ยวข้องกับประเภทของรายการที่ค้นหาได้
การแสดง JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็ม เช่น หาก OperatName คือ Priority และชื่อพร็อพเพอร์ตี้คือ priorityVal ข้อความค้นหาอย่าง priority:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ที่ชื่อ priorityVal ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของคุณสมบัติสตริงหรือข้อความภายในช่องเนื้อหาสำหรับช่องดังกล่าว ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
lessThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็มโดยใช้โอเปอเรเตอร์น้อยกว่า ตัวอย่างเช่น หาก notThanOperatorName คือ priority ด้านล่างนี้คือ และชื่อพร็อพเพอร์ตี้คือ priorityVal ข้อความค้นหาอย่าง priority below:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ชื่อ priorityVal น้อยกว่า <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรตัวพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
greaterThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็มโดยใช้โอเปอเรเตอร์ "มากกว่า" ตัวอย่างเช่น หาก additionalThanOperatorName คือ priority above และชื่อพร็อพเพอร์ตี้คือ priorityVal ข้อความค้นหาอย่างเช่น priorityPRIVACY:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ชื่อ priorityVal มากกว่า <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรตัวพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
DoublePropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้คู่
การแสดง JSON |
---|
{
"operatorOptions": {
object ( |
ช่อง | |
---|---|
operatorOptions |
หากตั้งค่าไว้ ให้อธิบายวิธีการใช้โอเปอเรเตอร์การค้นหาเป็นโอเปอเรเตอร์ |
DoublePropertyOptions.DoubleOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้ที่ 2 ขั้นตอนนี้เป็นตัวเลือกที่ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาเป็นช่องเฉพาะที่เกี่ยวข้องกับประเภทของรายการที่ค้นหาได้
การแสดง JSON |
---|
{ "operatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อใช้พร็อพเพอร์ตี้ Double ในการจัดเรียงหรือเป็นข้อมูลประกอบ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
TimestampPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้การประทับเวลา
การแสดง JSON |
---|
{
"operatorOptions": {
object ( |
ช่อง | |
---|---|
operatorOptions |
หากตั้งค่าไว้ ให้อธิบายวิธีใช้การประทับเวลาเป็นโอเปอเรเตอร์การค้นหา |
TimestampPropertyOptions.TimestampOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้การประทับเวลา ขั้นตอนนี้เป็นตัวเลือกที่ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาเป็นช่องเฉพาะที่เกี่ยวข้องกับประเภทของรายการที่ค้นหาได้
การแสดง JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลา เช่น หาก OperatName คือ closedon และชื่อพร็อพเพอร์ตี้คือ closeDate คำค้นหาอย่างเช่น closedon:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ที่ชื่อ closeDate ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันที่ไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือรายการภายในช่องเนื้อหาสำหรับค่านั้น ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
lessThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลาโดยใช้โอเปอเรเตอร์น้อยกว่า เช่น หากlessThanOperatorName คือ closedbefore และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่างเช่น closedbefore:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่ก่อน <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
greaterThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลาโดยใช้โอเปอเรเตอร์ "มากกว่า" ตัวอย่างเช่น หากGreatThanOperatorName คือ closedAfter และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่างเช่น closedAfter:<value> จะแสดงผลลัพธ์เฉพาะเมื่อค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่หลังจาก <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
BooleanPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้บูลีน
การแสดง JSON |
---|
{
"operatorOptions": {
object ( |
ช่อง | |
---|---|
operatorOptions |
หากมีการตั้งค่า จะอธิบายว่าควรใช้บูลีนเป็นโอเปอเรเตอร์การค้นหาอย่างไร |
BooleanPropertyOptions.BooleanOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้บูลีน ขั้นตอนนี้เป็นตัวเลือกที่ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาเป็นช่องเฉพาะที่เกี่ยวข้องกับประเภทของรายการที่ค้นหาได้
การแสดง JSON |
---|
{ "operatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้บูลีน เช่น หาก OperatName คือ closed และชื่อพร็อพเพอร์ตี้คือ isClosed คำค้นหาอย่างเช่น closed:<value> จะแสดงเฉพาะเมื่อค่าของพร็อพเพอร์ตี้ที่ชื่อ isClosed ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความในช่องเนื้อหาของรายการนั้นๆ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
ObjectPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้ออบเจ็กต์
การแสดง JSON |
---|
{
"subobjectProperties": [
{
object ( |
ช่อง | |
---|---|
subobjectProperties[] |
คุณสมบัติของออบเจ็กต์ย่อย คุณสมบัติเหล่านี้แสดงถึงออบเจ็กต์ที่ซ้อนกัน เช่น หากพร็อพเพอร์ตี้นี้แสดงที่อยู่ทางไปรษณีย์ SubobjectProperties อาจตั้งชื่อว่า street, city และ state จำนวนองค์ประกอบสูงสุดคือ 1,000 |
EnumPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้ enum ซึ่งช่วยให้คุณสามารถกำหนดชุดสตริงที่จำกัดเพื่อจับคู่ข้อความค้นหาของผู้ใช้ ตั้งค่าอันดับสำหรับค่าสตริงเหล่านั้น และกำหนดชื่อโอเปอเรเตอร์ที่จะจับคู่กับสตริงเหล่านั้น เพื่อให้ผู้ใช้สามารถจำกัดผลลัพธ์ให้เหลือเฉพาะรายการที่มีค่าหนึ่งๆ เท่านั้น เช่น สำหรับรายการในระบบติดตามคำขอที่มีข้อมูลลำดับความสำคัญ คุณสามารถกำหนดให้ p0 เป็นค่า enum ที่ยอมรับได้ และเชื่อมโยง enum นี้กับชื่อโอเปอเรเตอร์ priority เพื่อให้ผู้ใช้การค้นหาสามารถเพิ่ม priority:p0 ให้กับข้อความค้นหาเพื่อจำกัดชุดผลลัพธ์ไว้เฉพาะรายการที่จัดทำดัชนีด้วยค่า p0 เท่านั้น
การแสดง JSON |
---|
{ "possibleValues": [ { object ( |
ช่อง | |
---|---|
possibleValues[] |
รายการค่าที่เป็นไปได้สำหรับพร็อพเพอร์ตี้การแจกแจง EnumValuepairs ทั้งหมดต้องระบุค่าสตริง หากคุณระบุค่าจำนวนเต็มสำหรับ EnumValuePair 1 รายการ EnumValuePairs ที่เป็นไปได้ทั้งหมดต้องระบุค่าจำนวนเต็ม ทั้งค่าสตริงและค่าจำนวนเต็มต้องไม่ซ้ำกันกับค่าที่เป็นไปได้ทั้งหมด เมื่อตั้งค่าแล้ว จะไม่สามารถลบหรือแก้ไขค่าที่เป็นไปได้ หากคุณใส่การจัดอันดับแบบเรียงลำดับและคิดว่าอาจแทรกค่า enum เพิ่มเติมในอนาคต ให้เว้นช่องว่างในค่าจำนวนเต็มเริ่มต้นเพื่อให้เพิ่มค่าระหว่างค่าที่ลงทะเบียนไว้ก่อนหน้านี้ได้ จำนวนองค์ประกอบสูงสุดคือ 100 |
orderedRanking |
ใช้เพื่อระบุการจัดลำดับที่เรียงลำดับสำหรับการแจกแจงซึ่งกำหนดวิธีใช้ค่าจำนวนเต็มที่ระบุไว้ใน EnumValuePairs ที่เป็นไปได้ในการจัดอันดับผลลัพธ์ หากระบุไว้ ต้องระบุค่าจำนวนเต็มสำหรับค่า EnumValuePair ที่เป็นไปได้ทั้งหมดซึ่งกำหนดไว้สำหรับพร็อพเพอร์ตี้นี้ ใช้ได้ต่อเมื่อ |
operatorOptions |
หากตั้งค่าไว้ ให้อธิบายว่าควรใช้ enum เป็นโอเปอเรเตอร์การค้นหาอย่างไร |
EnumPropertyOptions.EnumValuePair
คู่ค่าการแจงนับจะระบุ 2 สิ่งคือ ค่าสตริงที่ต้องระบุและค่าจำนวนเต็มที่ไม่บังคับ ค่าสตริงจะกำหนดคำค้นหาที่จำเป็นในการเรียกรายการนั้น เช่น p0 สำหรับรายการลำดับความสำคัญ ค่าจำนวนเต็มจะเป็นตัวกำหนดอันดับของค่าสตริงนั้นที่สัมพันธ์กับค่าอื่นๆ ที่ระบุไว้ในพร็อพเพอร์ตี้เดียวกัน ตัวอย่างเช่น คุณอาจเชื่อมโยง p0 กับ 0 และกำหนดคู่ enum อีกคู่หนึ่ง เช่น p1 และ 1 คุณต้องใช้ค่าจำนวนเต็มร่วมกับ ordered ranking
เพื่อตั้งค่าการจัดอันดับของค่าที่กำหนดเมื่อเทียบกับค่าอื่นๆ ที่ระบุไว้ในชื่อพร็อพเพอร์ตี้เดียวกัน ในที่นี้ ลำดับการจัดอันดับจาก DESCENDING สำหรับพร็อพเพอร์ตี้ Priority จะทำให้การจัดอันดับรายการที่จัดทำดัชนีมีค่า p0 เพิ่มขึ้นเมื่อเทียบกับรายการที่จัดทำดัชนีซึ่งมีค่า p1 หากไม่มีลำดับการจัดอันดับที่ระบุไว้ ค่าจำนวนเต็มจะไม่มีผลกับการจัดอันดับสินค้า
การแสดง JSON |
---|
{ "stringValue": string, "integerValue": integer } |
ช่อง | |
---|---|
stringValue |
ค่าสตริงของ EnumValuepair มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
integerValue |
ค่าจำนวนเต็มของ EnumValuepair ซึ่งต้องไม่ติดลบ ไม่บังคับ |
EnumPropertyOptions.OrderedRanking
ใช้เพื่อระบุทิศทางการจัดอันดับสำหรับจำนวนเต็ม EnumValuePair
ที่สัมพันธ์กับค่าจำนวนเต็ม EnumValuepair อื่นๆ สำหรับพร็อพเพอร์ตี้บางรายการ ค่าจำนวนเต็มที่ต่ำกว่าบ่งชี้ถึงความสำคัญที่สูงขึ้น ในขณะที่ในพร็อพเพอร์ตี้อื่นๆ จำนวนเต็มที่สูงกว่าจะหมายถึงความสำคัญที่สูงกว่า
Enum | |
---|---|
NO_ORDER |
ไม่มีลำดับการจัดอันดับสำหรับพร็อพเพอร์ตี้ ค่าของพร็อพเพอร์ตี้นี้ไม่ปรับผลลัพธ์ |
ASCENDING |
ระบบจะจัดอันดับที่พักนี้จากน้อยไปหามาก ค่าที่ต่ำกว่าบ่งบอกถึงอันดับที่ต่ำกว่า |
DESCENDING |
พร็อพเพอร์ตี้นี้ได้รับการจัดอันดับจากมากไปน้อย ค่าที่ต่ำกว่าบ่งบอกถึงอันดับที่สูงขึ้น |
EnumPropertyOptions.EnumOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้ enum ขั้นตอนนี้เป็นตัวเลือกที่ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาเป็นช่องเฉพาะที่เกี่ยวข้องกับประเภทของรายการที่ค้นหาได้ ตัวอย่างเช่น ถ้าคุณไม่มีโอเปอเรเตอร์สำหรับพร็อพเพอร์ตี้ enum ของ priority ที่มีค่าที่เป็นไปได้ p0 และ p1 การค้นหาที่มีคำ p0 จะแสดงผลรายการที่มี p0 เป็นค่าของพร็อพเพอร์ตี้ priority รวมถึงรายการที่มีสตริง p0 ในช่องอื่นๆ ถ้าคุณระบุชื่อโอเปอเรเตอร์สำหรับ enum เช่น ลำดับความสำคัญ ผู้ใช้ที่ค้นหาจะสามารถใช้โอเปอเรเตอร์นั้นเพื่อปรับแต่งผลการค้นหาให้แสดงเฉพาะรายการที่มี p0 เป็นค่าของพร็อพเพอร์ตี้นี้ โดยใช้คำสั่ง priority:p0
การแสดง JSON |
---|
{ "operatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้ enum เช่น หาก OperatName คือ Priority และชื่อพร็อพเพอร์ตี้คือ priorityVal ข้อความค้นหาอย่าง priority:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ที่ชื่อ priorityVal ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของคุณสมบัติสตริงหรือข้อความภายในช่องเนื้อหาสำหรับช่องดังกล่าว ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
DatePropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้วันที่
การแสดง JSON |
---|
{
"operatorOptions": {
object ( |
ช่อง | |
---|---|
operatorOptions |
หากตั้งค่าไว้ ให้อธิบายว่าควรใช้วันที่เป็นโอเปอเรเตอร์การค้นหาอย่างไร |
DatePropertyOptions.DateOperatorOptions
ไม่บังคับ ระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้วันที่ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาไว้เฉพาะช่องที่เจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหาได้
การแสดง JSON |
---|
{ "operatorName": string, "lessThanOperatorName": string, "greaterThanOperatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุสตริงจริงที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่ ตัวอย่างเช่น สมมติว่าออบเจ็กต์สคีมาการติดตามปัญหามีพร็อพเพอร์ตี้ชื่อ closeDate ซึ่งระบุโอเปอเรเตอร์ที่มี OperatName เป็น closedon สำหรับการค้นหาข้อมูลดังกล่าว คำค้นหา เช่น closedon:<value> จะแสดงผลเฉพาะเมื่อค่าของพร็อพเพอร์ตี้ closeDate ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาสำหรับแหล่งข้อมูลที่จัดทำดัชนี ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
lessThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่โดยใช้โอเปอเรเตอร์ "น้อยกว่า" เช่น หากlessThanOperatorName คือ closedbefore และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่างเช่น closedbefore:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่ก่อน <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
greaterThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่โดยใช้โอเปอเรเตอร์ "มากกว่า" ตัวอย่างเช่น หากGreatThanOperatorName คือ closedAfter และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหาอย่างเช่น closedAfter:<value> จะแสดงผลลัพธ์เฉพาะเมื่อค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่หลังจาก <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
TextPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้ข้อความ
การแสดง JSON |
---|
{ "retrievalImportance": { object ( |
ช่อง | |
---|---|
retrievalImportance |
ระบุความสำคัญด้านคุณภาพการค้นหาของโทเค็นภายในช่องเมื่อใช้สำหรับการดึงข้อมูล |
operatorOptions |
หากตั้งค่าไว้ ให้อธิบายวิธีใช้พร็อพเพอร์ตี้เป็นโอเปอเรเตอร์การค้นหา |
RetrievalImportance
การแสดง JSON |
---|
{
"importance": enum ( |
ช่อง | |
---|---|
importance |
ระบุความสำคัญของการจัดอันดับที่พักเมื่อมีการจับคู่ระหว่างการเรียกข้อมูล เมื่อตั้งค่าแล้ว ความสำคัญโทเค็นของพร็อพเพอร์ตี้จะเปลี่ยนแปลงไม่ได้ |
RetrievalImportance.Importance
Enum | |
---|---|
DEFAULT |
จับคู่การจับคู่เหมือนกับการจับคู่เนื้อความ |
HIGHEST |
จับคู่การจับคู่เหมือนกับการจับคู่กับชื่อของสินค้า |
HIGH |
ให้ความสำคัญกับการจับคู่ข้อความที่ตรงกันมากกว่าเนื้อความ |
LOW |
ให้ความสำคัญกับส่วนที่ตรงกันน้อยกว่าข้อความเนื้อหา |
NONE |
อย่าจับคู่กับช่องนี้ระหว่างการดึงข้อมูล พร็อพเพอร์ตี้ยังใช้สำหรับการจับคู่โอเปอเรเตอร์ Faceting และแนะนําได้หากต้องการ |
TextPropertyOptions.TextOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสําหรับพร็อพเพอร์ตี้ข้อความ ขั้นตอนนี้เป็นตัวเลือกที่ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาเป็นช่องเฉพาะที่เกี่ยวข้องกับประเภทของรายการที่ค้นหาได้
การแสดง JSON |
---|
{ "operatorName": string, "exactMatchWithOperator": boolean } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้ข้อความ เช่น หาก OperatName คือ subject และชื่อของพร็อพเพอร์ตี้คือ subjectLine คำค้นหาอย่างเช่น subject:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ที่ชื่อ subjectLine ตรงกับ <value> เท่านั้น ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่มี <value> ตรงกับค่าของคุณสมบัติข้อความหรือข้อความภายในช่องเนื้อหาสำหรับรายการนั้นๆ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
exactMatchWithOperator |
หากจริง ค่าข้อความจะถูกแปลงให้เป็นโทเค็นเป็นค่าอะตอม 1 ค่าในการค้นหาโอเปอเรเตอร์และการจับคู่ข้อมูลประกอบ ตัวอย่างเช่น หากชื่อโอเปอเรเตอร์คือ "genre" และค่าคือ "science-fiction" ข้อจำกัดในข้อความค้นหา "genre:science" และ "genre:fiction" จะไม่ตรงกับรายการ แต่เป็น "genre:science-fiction" การจับคู่ค่าข้อความคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ และไม่ได้นําสัญลักษณ์พิเศษออก หากเป็นเท็จ ระบบจะแปลงข้อความเป็นโทเค็น ตัวอย่างเช่น หากค่าคือ "science-fiction" คำค้นหา "genre:science" และ "genre:fiction" ตรงกับรายการดังกล่าว |
HtmlPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้ HTML
การแสดง JSON |
---|
{ "retrievalImportance": { object ( |
ช่อง | |
---|---|
retrievalImportance |
ระบุความสำคัญด้านคุณภาพการค้นหาของโทเค็นภายในช่องเมื่อใช้สำหรับการดึงข้อมูล สามารถตั้งค่าเป็น DEFAULT หรือ NONE เท่านั้น |
operatorOptions |
หากตั้งค่าไว้ ให้อธิบายวิธีใช้พร็อพเพอร์ตี้เป็นโอเปอเรเตอร์การค้นหา |
HtmlPropertyOptions.HtmlOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้ HTML ขั้นตอนนี้เป็นตัวเลือกที่ไม่บังคับ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดการค้นหาเป็นช่องเฉพาะที่เกี่ยวข้องกับประเภทของรายการที่ค้นหาได้
การแสดง JSON |
---|
{ "operatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องการในการค้นหาเพื่อแยกพร็อพเพอร์ตี้ HTML เช่น หาก OperatName คือ subject และชื่อพร็อพเพอร์ตี้คือ subjectLine ข้อความค้นหาอย่างเช่น subject:<value> จะแสดงผลลัพธ์ก็ต่อเมื่อค่าของพร็อพเพอร์ตี้ที่ชื่อ subjectLine ตรงกับ <value> เท่านั้น ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้ html หรือข้อความในช่องเนื้อหาสำหรับรายการนั้นๆ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
PropertyDisplayOptions
ตัวเลือกการแสดงผลของพร็อพเพอร์ตี้
การแสดง JSON |
---|
{ "displayLabel": string } |
ช่อง | |
---|---|
displayLabel |
ป้ายกำกับที่ใช้งานง่ายสำหรับพร็อพเพอร์ตี้ที่ใช้หากมีการระบุพร็อพเพอร์ตี้ให้แสดงใน ObjectDisplayOptions หากระบุ ป้ายกำกับที่ปรากฏจะแสดงข้างหน้าค่าพร็อพเพอร์ตี้เมื่อพร็อพเพอร์ตี้เป็นส่วนหนึ่งของตัวเลือกการแสดงออบเจ็กต์ เช่น หากค่าพร็อพเพอร์ตี้คือ "1" ค่าดังกล่าวเองอาจไม่เป็นบริบทที่เป็นประโยชน์สำหรับผู้ใช้ ถ้าชื่อที่แสดงที่ระบุเป็น "ลำดับความสำคัญ" ผู้ใช้จะเห็น "ลำดับความสำคัญ : 1" ในผลการค้นหาที่ให้บริบทที่ชัดเจนแก่ผู้ใช้การค้นหา ค่านี้เป็นตัวเลือกที่ไม่บังคับ หากไม่ได้ระบุไว้ ระบบจะแสดงเฉพาะค่าพร็อพเพอร์ตี้เท่านั้น มีความยาวได้สูงสุดไม่เกิน 64 อักขระ |