- การแสดง 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 |
ระบุว่าพร็อพเพอร์ตี้ระบุข้อมูลที่ควรจะแสดงในผลการค้นหาผ่าน 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 |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็ม ตัวอย่างเช่น ถ้าโอเปอเรเตอร์ชื่อคือ ลำดับความสำคัญ และชื่อของพร็อพเพอร์ตี้คือ ลำดับความสำคัญVal การค้นหาอย่างเช่น ลำดับความสำคัญ:<value> จะแสดงผลเฉพาะเมื่อค่าของพร็อพเพอร์ตี้ชื่อ PriorityVal ตรงกับ <value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาสำหรับรายการนั้น ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
lessThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็มโดยใช้โอเปอเรเตอร์น้อยกว่า เช่น หากน้อยกว่าThanOperatorName คือ ลำดับความสำคัญด้านล่าง และชื่อของพร็อพเพอร์ตี้คือ ลำดับความสำคัญVal การค้นหา เช่น ทางเลือกด้านล่าง:<ค่า> จะแสดงผลเฉพาะเมื่อค่าของพร็อพเพอร์ตี้ชื่อ ลำดับความสำคัญVal ต่ำกว่า <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
greaterThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้จำนวนเต็มโดยใช้โอเปอเรเตอร์ที่มากกว่า เช่น หาก moreThanOperatorName คือ Priorityไม่ต่ำกว่า และชื่อของพร็อพเพอร์ตี้คือลำดับความสำคัญVal คำค้นหาอย่าง ทางเลือกด้านบน:<ค่า> จะแสดงผลเฉพาะเมื่อค่าของพร็อพเพอร์ตี้ชื่อ PriorityVal มากกว่า <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
DoublePropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้ 2 รายการ
การแสดง JSON |
---|
{
"operatorOptions": {
object ( |
ช่อง | |
---|---|
operatorOptions |
หากตั้งค่าแล้ว ให้อธิบายว่าควรใช้อักขระสองตัวเป็นโอเปอเรเตอร์การค้นหาอย่างไร |
DoublePropertyOptions.DoubleOperatorOptions
ใช้เพื่อระบุโอเปอเรเตอร์การค้นหาสำหรับพร็อพเพอร์ตี้ 2 รายการ โดยคุณจะทำขั้นตอนนี้หรือไม่ก็ได้ โอเปอเรเตอร์ query.search ช่วยให้ผู้ใช้จำกัดคำค้นหาในช่องที่เจาะจงซึ่งเกี่ยวข้องกับประเภทของรายการที่ค้นหา
การแสดง JSON |
---|
{ "operatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อใช้พร็อพเพอร์ตี้ 2 อย่างในการจัดเรียงหรือเป็นข้อมูลประกอบ ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (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 |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลาโดยใช้โอเปอเรเตอร์น้อยกว่า เช่น หากlowerThanOperatorName เป็น closedbefore และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหา เช่น closedbefore:<value> จะแสดงผลเฉพาะเมื่อค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่ก่อน <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
greaterThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้การประทับเวลาโดยใช้โอเปอเรเตอร์ที่มากกว่า เช่น หาก moreThanOperatorName เป็น 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[] |
พร็อพเพอร์ตี้ของออบเจ็กต์ย่อย พร็อพเพอร์ตี้เหล่านี้แสดงออบเจ็กต์ที่ฝังอยู่ เช่น หากพร็อพเพอร์ตี้นี้แสดงที่อยู่ทางไปรษณีย์ ออบเจ็กต์ย่อยของพร็อพเพอร์ตี้ก็อาจใช้ชื่อว่า street, city และ state จำนวนองค์ประกอบสูงสุดคือ 1,000 รายการ |
EnumPropertyOptions
ตัวเลือกสำหรับพร็อพเพอร์ตี้ enum ซึ่งช่วยให้คุณกำหนดชุดสตริงที่จำกัดให้ตรงกับคำค้นหาของผู้ใช้ ตั้งค่าการจัดอันดับสำหรับค่าสตริงเหล่านั้น และกำหนดชื่อโอเปอเรเตอร์ที่จะจับคู่กับสตริงเหล่านั้น เพื่อให้ผู้ใช้จำกัดผลการค้นหาให้แสดงเฉพาะรายการที่มีค่าที่เจาะจงเท่านั้น ตัวอย่างเช่น สำหรับรายการในระบบติดตามคำขอที่มีข้อมูลลำดับความสำคัญ คุณสามารถกำหนด p0 เป็นค่า enum ที่อนุญาตและผูก enum นี้กับชื่อโอเปอเรเตอร์ ลำดับความสำคัญ เพื่อให้ผู้ใช้การค้นหาเพิ่ม ลำดับความสำคัญ:p0 ลงในคำค้นหาเพื่อจำกัดชุดผลลัพธ์ไว้เฉพาะรายการที่จัดทำดัชนีด้วยค่า p0 เท่านั้น
การแสดง JSON |
---|
{ "possibleValues": [ { object ( |
ช่อง | |
---|---|
possibleValues[] |
รายการค่าที่เป็นไปได้สำหรับพร็อพเพอร์ตี้การแจกแจง EnumValuePairs ทั้งหมดต้องระบุค่าสตริง หากคุณระบุค่าจำนวนเต็มสำหรับ EnumValuePair 1 รายการ EnumValuePair ค่าที่เป็นไปได้ทั้งหมดต้องระบุค่าจำนวนเต็ม ทั้งค่าสตริงและค่าจำนวนเต็มต้องไม่ซ้ำกันสำหรับค่าที่เป็นไปได้ทั้งหมด เมื่อตั้งค่าแล้ว จะแก้ไขหรือนำค่าที่เป็นไปได้ออกไม่ได้ หากคุณระบุการจัดอันดับแบบเรียงลำดับและคิดว่าอาจแทรกค่า enum เพิ่มเติมในอนาคต ให้เว้นช่องว่างในค่าจำนวนเต็มเริ่มต้นเพื่อให้เพิ่มค่าระหว่างค่าที่ลงทะเบียนก่อนหน้านี้ได้ จำนวนองค์ประกอบสูงสุดคือ 100 รายการ |
orderedRanking |
ใช้เพื่อระบุการจัดอันดับตามลำดับสำหรับการแจกแจงซึ่งกำหนดวิธีใช้ค่าจำนวนเต็มที่ระบุใน EnumValuePairs ที่เป็นไปได้ในการจัดอันดับผลลัพธ์ หากระบุ จะต้องระบุค่าจำนวนเต็มสำหรับค่า EnumValuePair ที่เป็นไปได้ทั้งหมดสำหรับพร็อพเพอร์ตี้นี้ ใช้ได้เมื่อ |
operatorOptions |
หากตั้งค่าไว้ ให้อธิบายวิธีใช้ enum เป็นโอเปอเรเตอร์การค้นหา |
EnumPropertyOptions.EnumValuePair
คู่ค่าการแจกแจงจะกำหนด 2 สิ่งคือ ค่าสตริงที่จำเป็นและค่าจำนวนเต็มที่ไม่บังคับ ค่าสตริงจะกำหนดข้อความค้นหาที่จำเป็นซึ่งจำเป็นต่อการเรียกรายการนั้น เช่น p0 สำหรับรายการที่มีลำดับความสำคัญ ค่าจำนวนเต็มจะเป็นตัวกำหนดอันดับของค่าสตริงนั้นเมื่อเทียบกับค่าที่แจกแจงอื่นๆ สำหรับพร็อพเพอร์ตี้เดียวกัน เช่น คุณอาจเชื่อมโยง p0 กับ 0 และกำหนดคู่ enum อื่น เช่น p1 และ 1 คุณต้องใช้ค่าจำนวนเต็มร่วมกับ ordered ranking
เพื่อกำหนดการจัดอันดับของค่าหนึ่งๆ ที่สัมพันธ์กับค่าที่แจกแจงอื่นๆ สำหรับชื่อพร็อพเพอร์ตี้เดียวกัน ในตัวอย่างนี้ ลำดับการจัดอันดับของ DESCENDING สำหรับพร็อพเพอร์ตี้ลำดับความสำคัญ จะส่งผลให้เกิดอันดับสูงขึ้นสำหรับรายการที่จัดทำดัชนีด้วยค่า 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 สำคัญที่มีค่าที่เป็นไปได้ p0 และ p1 การค้นหาที่มีคำว่า p0 จะแสดงรายการที่มี p0 เป็นค่าของพร็อพเพอร์ตี้ ลำดับความสำคัญ รวมถึงรายการที่มีสตริง p0 ในช่องอื่นๆ หากคุณระบุชื่อโอเปอเรเตอร์สำหรับ enum เช่น ลำดับความสำคัญ ผู้ใช้การค้นหาจะใช้โอเปอเรเตอร์ดังกล่าวเพื่อปรับแต่งผลลัพธ์ให้มีเฉพาะรายการที่มี p0 เป็นค่าของพร็อพเพอร์ตี้นี้เท่านั้น พร้อมด้วยคำค้นหา priority:p0
การแสดง JSON |
---|
{ "operatorName": string } |
ช่อง | |
---|---|
operatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้ enum ตัวอย่างเช่น ถ้าโอเปอเรเตอร์ชื่อคือ ลำดับความสำคัญ และชื่อของพร็อพเพอร์ตี้คือ ลำดับความสำคัญVal การค้นหาอย่างเช่น ลำดับความสำคัญ:<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 ซึ่งระบุโอเปอเรเตอร์ที่มีโอเปอเรเตอร์ชื่อ closedon สำหรับการค้นหาข้อมูลนั้น ข้อความค้นหาอย่างเช่น closedon:<value> จะแสดงผลลัพธ์เฉพาะเมื่อค่าของพร็อพเพอร์ตี้ closedon:<value> ตรงกับ closedon:<value> ในทางตรงกันข้าม การค้นหาที่ใช้ <value> เดียวกันโดยไม่มีโอเปอเรเตอร์จะแสดงรายการทั้งหมดที่ <value> ตรงกับค่าของพร็อพเพอร์ตี้สตริงหรือข้อความภายในช่องเนื้อหาสำหรับแหล่งข้อมูลที่จัดทำดัชนี ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
lessThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่โดยใช้โอเปอเรเตอร์น้อยกว่า เช่น หากlowerThanOperatorName เป็น closedbefore และชื่อพร็อพเพอร์ตี้คือ closeDate การค้นหา เช่น closedbefore:<value> จะแสดงผลเฉพาะเมื่อค่าของพร็อพเพอร์ตี้ชื่อ closeDate อยู่ก่อน <value> ชื่อโอเปอเรเตอร์มีได้เฉพาะตัวอักษรพิมพ์เล็ก (a-z) เท่านั้น มีความยาวได้สูงสุดไม่เกิน 32 อักขระ |
greaterThanOperatorName |
ระบุชื่อโอเปอเรเตอร์ที่ต้องใช้ในการค้นหาเพื่อแยกพร็อพเพอร์ตี้วันที่โดยใช้โอเปอเรเตอร์ที่มากกว่า เช่น หาก moreThanOperatorName เป็น 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 |
ห้ามจับคู่กับฟิลด์นี้ระหว่างการดึงข้อมูล พร็อพเพอร์ตี้ยังใช้สำหรับการจับคู่โอเปอเรเตอร์ ข้อมูลประกอบ และแนะนำได้หากต้องการ |
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" และ "genre: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 อักขระ |