- Ressource: SearchApplication
- DataSourceRestriction
- Quelle
- Source.PredefinedSource
- FilterOptions
- Filtern
- Filter.ValueFilter
- Wert
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Methoden
Ressource: SearchApplication
SearchApplication
JSON-Darstellung |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Felder | |
---|---|
name |
Der Name der Suchanwendung. Format: searchapplications/{applicationId}. |
displayName |
Anzeigename der Suchanwendung Die maximale Länge beträgt 300 Zeichen. |
dataSourceRestrictions[] |
Auf die Konfigurationen angewendete Einschränkungen. Es sind maximal 10 Elemente zulässig. |
sourceConfig[] |
Konfiguration für eine Quelle, die in dataSourceRestrictions angegeben ist. |
scoringConfig |
Konfiguration für das Ranking von Ergebnissen. |
defaultSortOptions |
Standardoptionen zum Sortieren der Suchergebnisse |
defaultFacetOptions[] |
Die Standardfelder für die Rückgabe von Attributergebnissen. Die hier angegebenen Quellen wurden auch oben in |
returnResultThumbnailUrls |
Bei jedem Ergebnis sollte der URI für die Miniaturansicht zurückgegeben werden (falls zutreffend). |
operationIds[] |
Nur Ausgabe IDs der lang andauernden Vorgänge, die derzeit für dieses Schema ausgeführt werden. Nur Ausgabefeld. |
enableAuditLog |
Gibt an, ob das Audit-Logging für Anfragen an die Suchanwendung in Abfrage-APIs aktiviert/deaktiviert ist. |
queryInterpretationConfig |
Standardoptionen für die Abfrageinterpretation |
DataSourceRestriction
Beschränkung für Datenquelle.
JSON-Darstellung |
---|
{ "source": { object ( |
Felder | |
---|---|
source |
Die Quelle der Einschränkung. |
filterOptions[] |
Filteroptionen, die die Ergebnisse einschränken. Sind mehrere Filter vorhanden, werden sie vor dem Zusammenführen nach Objekttyp gruppiert. Filter mit demselben Objekttyp werden konjunktiv verknüpft, dann werden die resultierenden Ausdrücke disjunktiv verknüpft. Es sind maximal 20 Elemente zulässig. HINWEIS: Die Google Suggest API unterstützt derzeit nur die folgenden Filter: „objecttype“, „type“ und „mimetype“. Derzeit können schemaspezifische Filter nicht zum Filtern von Vorschlägen verwendet werden. |
Quelle
Definiert Quellen für die Suggest/Search APIs.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
name |
Name der Quelle für Inhalte, die von |
predefinedSource |
Vordefinierte Inhaltsquelle für Google Apps. |
Source.PredefinedSource
Vordefinierte Quellen:
Enums | |
---|---|
NONE |
|
QUERY_HISTORY |
Schlägt Suchanfragen vor, die vom Nutzer in der Vergangenheit gestellt wurden. Nur gültig in Verbindung mit der Suggest API. Wird bei Verwendung in der Query API ignoriert. |
PERSON |
Personen in der Organisation vorschlagen. Nur gültig in Verbindung mit der Suggest API. Führt bei Verwendung in der Abfrage-API zu einem Fehler. |
GOOGLE_DRIVE |
|
GOOGLE_GMAIL |
|
GOOGLE_SITES |
|
GOOGLE_GROUPS |
|
GOOGLE_CALENDAR |
|
GOOGLE_KEEP |
FilterOptions
Filteroptionen, die auf die Abfrage angewendet werden.
JSON-Darstellung |
---|
{
"objectType": string,
"filter": {
object ( |
Felder | |
---|---|
objectType |
Wenn „objectType“ festgelegt ist, werden nur Objekte dieses Typs zurückgegeben. Dieser sollte dem Namen des Objekts entsprechen, das in der Definition des Schemas registriert wurde. Die maximale Länge beträgt 256 Zeichen. |
filter |
Generischer Filter zum Einschränken der Suche, z. B. |
Filtern
Generische Form von Filtern in einer Abfrage, die zwei Ansätze unterstützt:
1. Einen ValueFilter festlegen. Der Name muss mit einem OperatorName übereinstimmen, der im Schema für Ihre Datenquelle definiert ist.
2. CompositeFilter festlegen. Die Filter werden mit dem logischen Operator ausgewertet. Die Operatoren der obersten Ebene können nur AND oder NOT sein. UND kann nur auf der obersten Ebene erscheinen. ODER darf nur unter einem UND auf oberster Ebene erscheinen.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
JSON-Darstellung |
---|
{
"operatorName": string,
"value": {
object ( |
Felder | |
---|---|
operatorName |
Der auf die Abfrage angewendete
|
value |
Wert, mit dem verglichen werden soll |
Wert
Definition eines einzelnen Werts mit generischem Typ.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld value . Der Wert der benannten Eigenschaft. Für value ist nur einer der folgenden Werte zulässig: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
JSON-Darstellung |
---|
{ "logicOperator": enum ( |
Felder | |
---|---|
logicOperator |
Der logische Operator des Unterfilters. |
subFilters[] |
Untergeordnete Filter. |
Filter.CompositeFilter.LogicOperator
Enums | |
---|---|
AND |
Logische Operatoren, die nur auf untergeordnete Filter angewendet werden können. |
OR |
|
NOT |
NOT kann nur auf einen einzelnen Unterfilter angewendet werden. |
SourceConfig
Konfigurationen für eine Quelle während der Verarbeitung einer query.search
- oder query.suggest
-Anfrage.
JSON-Darstellung |
---|
{ "source": { object ( |
Felder | |
---|---|
source |
Die Quelle, für die diese Konfiguration verwendet werden soll. |
scoringConfig |
Die Bewertungskonfiguration für die Quelle. |
crowdingConfig |
Die Crowding-Konfiguration für die Quelle. |
SourceScoringConfig
Legen Sie die Bewertungskonfiguration fest. Dadurch kann das Ranking der Ergebnisse für eine Quelle geändert werden.
JSON-Darstellung |
---|
{
"sourceImportance": enum ( |
Felder | |
---|---|
sourceImportance |
Bedeutung der Quelle. |
SourceScoringConfig.SourceImportance
Die Wichtigkeit einer Quelle, anhand derer angegeben werden kann, ob einer Quelle im Vergleich zu einer anderen Quelle mehr Priorität beim Ranking eingeräumt werden sollte.
Enums | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
Sie können Beschränkungen für die Anzahl der Suchergebnisse festlegen. Crowding bedeutet, dass mehrere Ergebnisse aus derselben Quelle oder aus demselben Host andere Ergebnisse „verdrängen“, was die Qualität der Suche für Nutzer vermindert. Um die Suchqualität und die Quellenvielfalt in den Suchergebnissen zu verbessern, können Sie eine Bedingung festlegen, um wiederholte Ergebnisse nach Quelle zu reduzieren.
JSON-Darstellung |
---|
{ "numResults": integer, "numSuggestions": integer } |
Felder | |
---|---|
numResults |
Maximal zulässige Anzahl von Ergebnissen von einer Datenquelle in einer Ergebnisseite, solange Ergebnisse aus anderen Quellen nicht erschöpft sind. Der angegebene Wert darf nicht negativ sein. Ist dieser Wert gleich 0, wird ein Standardwert verwendet. Um die Mengenbeschränkung zu deaktivieren, legen Sie einen Wert größer als 100 fest. |
numSuggestions |
Maximal zulässige Anzahl von Vorschlägen einer Quelle. Wenn dieser Wert kleiner oder gleich 0 ist, werden keine Grenzwerte für Ergebnisse festgelegt. |
ScoringConfig
Bewertungskonfigurationen für eine Quelle während der Verarbeitung einer query.search
- oder query.suggest
-Anfrage.
JSON-Darstellung |
---|
{ "disableFreshness": boolean, "disablePersonalization": boolean } |
Felder | |
---|---|
disableFreshness |
Gibt an, ob die Aktualität als Ranking-Signal verwendet werden soll. Standardmäßig wird die Aktualität als Ranking-Signal verwendet. Diese Einstellung ist in der Admin-Benutzeroberfläche nicht verfügbar. |
disablePersonalization |
Gibt an, ob die Ergebnisse personalisiert werden sollen. Standardmäßig werden persönliche Signale verwendet, um bessere Ergebnisse zu erzielen. |
SortOptions
JSON-Darstellung |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Felder | |
---|---|
operatorName |
Der Name des Operators für das Feld, nach dem sortiert werden soll. Die entsprechende Property muss als |
sortOrder |
„Aufsteigend“ ist die Standardsortierreihenfolge. |
SortOptions.SortOrder
Enums | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
Gibt Operatoren an, für die Attributergebnisse zurückgegeben werden sollen. Es gibt ein FacetResult für jede sourceName/objectType/operatorName-Kombination.
JSON-Darstellung |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Felder | |
---|---|
sourceName |
Quellname, für den das Attribut aktiviert werden soll. Format: datasources/{sourceId}. Wenn dieses Feld leer ist, werden alle Datenquellen verwendet. |
objectType |
Wenn „objectType“ festgelegt ist, werden nur die Objekte dieses Typs zum Berechnen von Attributen verwendet. Wenn dieses Feld leer ist, werden alle Objekte zum Berechnen von Attributen verwendet. |
operatorName |
Der Name des für die Facettierung ausgewählten Operators. @see cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
Maximale Anzahl von Attribut-Buckets, die für dieses Attribut zurückgegeben werden sollen. Der Standardwert ist 10. Der Höchstwert ist 100. |
integerFacetingOptions |
Wenn festgelegt, werden Ganzzahl-Facet-Optionen für das angegebene Ganzzahlattribut beschrieben. Das entsprechende Ganzzahlattribut im Schema sollte als „isFacetable“ gekennzeichnet sein. Die Anzahl der zurückgegebenen Buckets würde aus diesem und numFacetBuckets mindestens bestehen. |
IntegerFacetingOptions
Wird zum Angeben von Ganzzahl-Facet-Optionen verwendet.
JSON-Darstellung |
---|
{ "integerBuckets": [ string ] } |
Felder | |
---|---|
integerBuckets[] |
Buckets für bestimmte Ganzzahlwerte sollten in streng aufsteigender Reihenfolge angeordnet werden. Wenn die angegebenen Werte beispielsweise (1,5,10,100) sind, werden die folgenden Facetten-Buckets gebildet {<1, [1,5), [5–10), [10–100), >=100}. |
QueryInterpretationConfig
Standardoptionen zum Interpretieren der Nutzerabfrage.
JSON-Darstellung |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
Felder | |
---|---|
forceVerbatimMode |
Aktivieren Sie dieses Flag, um alle internen Optimierungen wie die Interpretation von Suchanfragen in natürlicher Sprache (NL), das Abrufen zusätzlicher Ergebnisse und die Verwendung von Synonymen, einschließlich benutzerdefinierter, zu deaktivieren. Wenn dieses Flag auf „True“ gesetzt ist, hat es Vorrang vor der Option auf Abfrageebene. Ist der Standardwert „False“ festgelegt, wird mit dem Flag auf Abfrageebene die korrekte Interpretation für den wörtlichen Modus festgelegt. |
forceDisableSupplementalResults |
Setzen Sie dieses Flag, um das Abrufen zusätzlicher Ergebnisse zu deaktivieren. Wenn Sie hier ein Flag festlegen, werden keine zusätzlichen Ergebnisse für Suchanfragen abgerufen, die mit einer bestimmten Suchanwendung verknüpft sind. Wenn dieses Flag auf „True“ gesetzt ist, hat es Vorrang vor der Option auf Abfrageebene. Ist der Standardwert „False“ festgelegt, wird durch das Flag auf Abfrageebene die richtige Interpretation für zusätzliche Ergebnisse festgelegt. |
Methoden |
|
---|---|
|
Erstellt eine Suchanwendung. |
|
Löscht eine Suchanwendung. |
|
Ruft die angegebene Suchanwendung ab. |
|
Listet alle Suchanwendungen auf. |
|
Aktualisiert eine Suchanwendung. |
|
Setzt eine Suchanwendung auf die Standardeinstellungen zurück. |
|
Aktualisiert eine Suchanwendung. |