REST Resource: settings.searchapplications

ทรัพยากร: SearchApplication

SearchApplication

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "sourceConfig": [
    {
      object (SourceConfig)
    }
  ],
  "scoringConfig": {
    object (ScoringConfig)
  },
  "defaultSortOptions": {
    object (SortOptions)
  },
  "defaultFacetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "returnResultThumbnailUrls": boolean,
  "operationIds": [
    string
  ],
  "enableAuditLog": boolean,
  "queryInterpretationConfig": {
    object (QueryInterpretationConfig)
  }
}
ช่อง
name

string

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

รูปแบบ: searchapplications/{applicationId}
displayName

string

ชื่อที่แสดงของแอปพลิเคชันการค้นหา มีความยาวได้สูงสุดไม่เกิน 300 อักขระ
dataSourceRestrictions[]

object (DataSourceRestriction)

ข้อจำกัดที่ใช้กับการกำหนดค่า จำนวนองค์ประกอบสูงสุดคือ 10 รายการ
sourceConfig[]

object (SourceConfig)

การกําหนดค่าสําหรับแหล่งที่มาที่ระบุใน dataSourceRestrictions
scoringConfig

object (ScoringConfig)

การกำหนดค่าสำหรับผลลัพธ์การจัดอันดับ
defaultSortOptions

object (SortOptions)

ตัวเลือกเริ่มต้นสำหรับการจัดเรียงผลการค้นหา
defaultFacetOptions[]

object (FacetOptions)

ช่องเริ่มต้นสำหรับการแสดงผลลัพธ์ข้อมูลประกอบ แหล่งที่มาที่ระบุในที่นี้ได้รวมอยู่ใน dataSourceRestrictions ข้างต้นด้วย
returnResultThumbnailUrls

boolean

โดยในแต่ละผลลัพธ์ เราควรแสดงผล URI สำหรับภาพขนาดย่อ (หากมี)
operationIds[]

string

เอาต์พุตเท่านั้น รหัสของการดำเนินการที่ใช้เวลานาน (LRO) ที่กำลังใช้งานสำหรับสคีมานี้ ฟิลด์เอาต์พุตเท่านั้น
enableAuditLog

boolean

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

object (QueryInterpretationConfig)

ตัวเลือกเริ่มต้นสำหรับการตีความคำค้นหา

DataSourceRestriction

ข้อจำกัดเกี่ยวกับแหล่งข้อมูล

การแสดง JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
ช่อง
source

object (Source)

แหล่งที่มาของการจำกัด
filterOptions[]

object (FilterOptions)

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

จำนวนองค์ประกอบสูงสุดคือ 20 รายการ

หมายเหตุ: Recommendation API รองรับตัวกรองเพียงไม่กี่รายการเท่านั้น: "objecttype", "type" และ "mimetype" ในตอนนี้ยังไม่สามารถใช้ตัวกรองเฉพาะสคีมาเพื่อกรองคำแนะนำได้

แหล่งที่มา

กำหนดแหล่งที่มาสำหรับ Recommended/Search API

การแสดง JSON 
{

  // Union field source can be only one of the following:
  "name": string,
  "predefinedSource": enum (Source.PredefinedSource)
  // End of list of possible types for union field source.
}
ช่อง

ช่องการรวม source

source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
name

string

ชื่อแหล่งที่มาของเนื้อหาที่จัดทำดัชนีโดย Indexing API
predefinedSource

enum (Source.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 (Filter)
  }
}
ช่อง
objectType

string

หากตั้งค่า objectType ไว้ ระบบจะส่งเฉพาะออบเจ็กต์ประเภทนั้นกลับมา ชื่อนี้ควรตรงกับชื่อของออบเจ็กต์ที่ลงทะเบียนไว้ภายในคำจำกัดความของสคีมา มีความยาวได้สูงสุดไม่เกิน 256 อักขระ
filter

object (Filter)

ตัวกรองทั่วไปเพื่อจำกัดการค้นหา เช่น lang:en, site:xyz

ตัวกรอง

วิธีทั่วไปในการแสดงตัวกรองในคำค้นหา ซึ่งรองรับ 2 วิธีดังนี้

1. การตั้งค่า ValueFilter ชื่อต้องตรงกับ OperatName ที่กำหนดไว้ในสคีมาสำหรับแหล่งข้อมูล

2. การตั้งค่า CompositeFilter ตัวกรองจะได้รับการประเมินโดยใช้โอเปอเรเตอร์เชิงตรรกะ โอเปอเรเตอร์ระดับบนสุดอาจเป็นได้ทั้ง "และ" หรือ "ไม่ใช่" และสามารถปรากฏที่ระดับบนสุดเท่านั้น หรือ สามารถปรากฏภายใต้ "และ" ระดับบนสุดเท่านั้น

การแสดง JSON 
{

  // Union field filter can be only one of the following:
  "valueFilter": {
    object (Filter.ValueFilter)
  },
  "compositeFilter": {
    object (Filter.CompositeFilter)
  }
  // End of list of possible types for union field filter.
}
ช่อง

ช่องการรวม filter

filter ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

การแสดง JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
ช่อง
operatorName

string

operatorName ที่ใช้กับการค้นหา เช่น price_greater_than ตัวกรองนี้ทำงานได้กับตัวกรองทั้ง 2 ประเภทที่ระบุไว้ในสคีมาสำหรับแหล่งข้อมูล ดังนี้

  1. operatorName ซึ่งการค้นหาจะกรองผลลัพธ์ตามพร็อพเพอร์ตี้ที่ตรงกับค่า

  2. greaterThanOperatorName หรือ lessThanOperatorName ในสคีมา คำค้นหาจะกรองผลลัพธ์สำหรับค่าพร็อพเพอร์ตี้ที่มากกว่าหรือน้อยกว่าค่าที่ระบุในคำค้นหา
value

object (Value)

ค่าที่จะเปรียบเทียบ

ค่า

คำจำกัดความของค่าเดี่ยวที่มีประเภททั่วไป

การแสดง JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "doubleValue": number,
  "timestampValue": string,
  "booleanValue": boolean,
  "dateValue": {
    object (Date)
  }
  // End of list of possible types for union field value.
}
ช่อง
ช่องการรวม value ค่าของพร็อพเพอร์ตี้ที่มีชื่อ value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

การแสดง JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
ช่อง
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

โอเปอเรเตอร์ตรรกะของตัวกรองย่อย
subFilters[]

object (Filter)

ตัวกรองย่อย

Filter.CompositeFilter.LogicOperator

Enum
AND โอเปอเรเตอร์ทางตรรกะที่ใช้กับตัวกรองย่อยได้เท่านั้น
OR
NOT "ไม่" ใช้ได้กับตัวกรองย่อยรายการเดียวเท่านั้น

SourceConfig

การกำหนดค่าสำหรับแหล่งที่มาขณะประมวลผลคำขอ query.search หรือ query.suggest

การแสดง JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
ช่อง
source

object (Source)

ต้นทางที่จะใช้การกำหนดค่านี้
scoringConfig

object (SourceScoringConfig)

การกำหนดค่าการให้คะแนนสำหรับแหล่งที่มา
crowdingConfig

object (SourceCrowdingConfig)

การกำหนดค่าการกำหนดจำนวนสำหรับแหล่งที่มา

SourceScoringConfig

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

การแสดง JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
ช่อง
sourceImportance

enum (SourceScoringConfig.SourceImportance)

ความสำคัญของแหล่งที่มา

SourceScoringConfig.SourceImportance

ความสำคัญของแหล่งที่มาที่ใช้ระบุว่าแหล่งที่มาควรให้ความสำคัญกับการจัดอันดับมากกว่าเมื่อเทียบกับแหล่งที่มาอื่น

Enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

ตั้งค่าขีดจำกัดจำนวนผลการค้นหา Crowd คือสถานการณ์ที่ผลลัพธ์หลายรายการจากแหล่งที่มาหรือโฮสต์เดียวกัน "crowd out" ผลลัพธ์อื่น ๆ ซึ่งลดทอนคุณภาพของการค้นหาสำหรับผู้ใช้ เพื่อส่งเสริมคุณภาพการค้นหาและความหลากหลายของแหล่งข้อมูลในผลการค้นหา คุณสามารถกำหนดเงื่อนไขเพื่อลดผลการค้นหาที่ซ้ำกันตามแหล่งที่มา

การแสดง JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
ช่อง
numResults

integer

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

integer

จำนวนคำแนะนำสูงสุดที่อนุญาตจากแหล่งที่มา ผลลัพธ์จะไม่มีขีดจำกัดหากค่านี้น้อยกว่าหรือเท่ากับ 0

ScoringConfig

การกำหนดค่าการให้คะแนนสำหรับแหล่งที่มาขณะประมวลผลคำขอ query.search หรือ query.suggest

การแสดง JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
ช่อง
disableFreshness

boolean

ต้องการใช้ความใหม่เป็นสัญญาณการจัดอันดับหรือไม่ ระบบจะใช้ความใหม่เป็นสัญญาณการจัดอันดับโดยค่าเริ่มต้น โปรดทราบว่าการตั้งค่านี้จะใช้ไม่ได้ใน UI การดูแลระบบ
disablePersonalization

boolean

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

SortOptions

การแสดง JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
ช่อง
operatorName

string

ชื่อของโอเปอเรเตอร์ที่เกี่ยวข้องกับช่องที่จะจัดเรียง พร็อพเพอร์ตี้ที่เกี่ยวข้องต้องทำเครื่องหมายเป็น sortable
sortOrder

enum (SortOptions.SortOrder)

ลำดับการจัดเรียงเริ่มต้นจากน้อยไปมาก

SortOptions.SortOrder

Enum
ASCENDING
DESCENDING

FacetOptions

ระบุโอเปอเรเตอร์เพื่อแสดงผลการค้นหาข้อมูลประกอบ จะมี FacetResult 1 รายการสำหรับชุดค่าผสม sourceName/objectType/operatorName ทั้งหมด

การแสดง JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
ช่อง
sourceName

string

ชื่อแหล่งที่มาที่จะดูข้อมูลประกอบ รูปแบบ: แหล่งข้อมูล/{sourceId} หากเว้นว่างไว้ ระบบจะใช้แหล่งข้อมูลทั้งหมด
objectType

string

หากตั้งค่า objectType ไว้จะใช้เฉพาะออบเจ็กต์ประเภทนั้นในการคำนวณ Facet หากเว้นว่างไว้ ระบบจะใช้วัตถุทั้งหมดเพื่อคำนวณข้อมูลประกอบ
operatorName

string

ชื่อของโอเปอเรเตอร์ที่เลือกสำหรับการประกอบ @ดู cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

จำนวนสูงสุดของที่เก็บข้อมูลประกอบที่ควรแสดงผลสำหรับข้อมูลประกอบนี้ ค่าเริ่มต้นคือ 10 ค่าสูงสุดคือ 100
integerFacetingOptions

object (IntegerFacetingOptions)

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

IntegerFacetingOptions

ใช้เพื่อระบุตัวเลือกการดูข้อมูลประกอบที่เป็นจำนวนเต็ม

การแสดง JSON 
{
  "integerBuckets": [
    string
  ]
}
ช่อง
integerBuckets[]

string (Int64Value format)

ที่เก็บข้อมูลสำหรับค่าจำนวนเต็มที่ระบุควรเรียงจากน้อยไปมากอย่างเคร่งครัด ตัวอย่างเช่น หากค่าที่ระบุคือ (1,5,10,100) ที่เก็บข้อมูลประกอบต่อไปนี้จะอยู่ในรูปแบบ {<1, [1,5), [5-10), [10-100), >=100}

QueryInterpretationConfig

ตัวเลือกเริ่มต้นเพื่อตีความการค้นหาของผู้ใช้

การแสดง JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
ช่อง
forceVerbatimMode

boolean

เปิดใช้แฟล็กนี้เพื่อปิดการเพิ่มประสิทธิภาพภายในทั้งหมด เช่น การตีความคำค้นหาในภาษาธรรมชาติ (NL) การดึงข้อมูลผลลัพธ์เสริม และการใช้คำพ้องความหมาย รวมถึงคำที่กำหนดเอง หากตั้งค่าแฟล็กนี้เป็น "จริง" ระบบจะมีลำดับความสำคัญเหนือกว่าตัวเลือกที่ตั้งค่าไว้ที่ระดับคำค้นหา สำหรับค่าเริ่มต้นของ "เท็จ" แฟล็กระดับคำค้นหาจะตั้งค่าการตีความที่ถูกต้องสำหรับโหมดแบบคำต่อคำ
forceDisableSupplementalResults

boolean

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

เมธอด

create

 สร้างแอปพลิเคชันการค้นหา

delete

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

get

 รับแอปพลิเคชันการค้นหาที่ระบุ

list

 แสดงรายการแอปพลิเคชันการค้นหาทั้งหมด

patch

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

reset

 รีเซ็ตแอปพลิเคชันการค้นหาเป็นการตั้งค่าเริ่มต้น

update

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