REST Resource: settings.searchapplications

Ressource: SearchApplication

SearchApplication

JSON-Darstellung 
{
  "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)
  }
}
Felder
name

string

Der Name der Suchanwendung.

Format: searchapplications/{applicationId}.
displayName

string

Der Anzeigename der Suchanwendung. Die maximale Länge beträgt 300 Zeichen.
dataSourceRestrictions[]

object (DataSourceRestriction)

Einschränkungen, die auf die Konfigurationen angewendet werden. Die maximale Anzahl von Elementen ist 10.
sourceConfig[]

object (SourceConfig)

Konfiguration für in dataSourceRestrictions angegebene Quellen.
scoringConfig

object (ScoringConfig)

Konfiguration für das Ranking von Ergebnissen.
defaultSortOptions

object (SortOptions)

Die Standardoptionen für die Sortierung der Suchergebnisse
defaultFacetOptions[]

object (FacetOptions)

Die Standardfelder für die Rückgabe von Facettenergebnissen. Die hier angegebenen Quellen wurden auch in dataSourceRestrictions oben aufgenommen.
returnResultThumbnailUrls

boolean

Für jedes Ergebnis sollte der URI für das Thumbnail zurückgegeben werden (falls zutreffend).
operationIds[]

string

Nur Ausgabe. IDs der derzeit für dieses Schema ausgeführten lang andauernden Vorgänge. Nur Ausgabefeld.
enableAuditLog

boolean

Gibt an, ob das Audit-Logging für Anfragen an die Suchanwendung in Abfrage-APIs aktiviert oder deaktiviert ist.
queryInterpretationConfig

object (QueryInterpretationConfig)

Standardoptionen für die Abfrageauswertung

DataSourceRestriction

Einschränkung der Datenquelle.

JSON-Darstellung 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Felder
source

object (Source)

Die Quelle der Einschränkung.
filterOptions[]

object (FilterOptions)

Filteroptionen, mit denen die Ergebnisse eingeschränkt werden. Wenn mehrere Filter vorhanden sind, werden sie vor dem Zusammenführen nach Objekttyp gruppiert. Filter mit demselben Objekttyp werden konjunktiv verbunden und die resultierenden Ausdrücke werden disjunktiv verbunden.

Die maximale Anzahl von Elementen ist 20.

HINWEIS: Die Suggest API unterstützt derzeit nur wenige Filter: „objecttype“, „type“ und „mimetype“. Derzeit können Vorschläge nicht mit schemaspezifischen Filtern gefiltert werden.

Quelle

Definiert Quellen für die APIs „suggest“ und „search“.

JSON-Darstellung 
{

  // 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.
}
Felder

Union-Feld source.

Für source ist nur einer der folgenden Werte zulässig:
name

string

Quellname für Inhalte, die von der Indexing API indexiert wurden.
predefinedSource

enum (Source.PredefinedSource)

Vordefinierte Inhaltsquelle für Google-Apps.

Source.PredefinedSource

Vordefinierte Quellen:

Enums
NONE
QUERY_HISTORY Es werden Suchanfragen vorgeschlagen, die der Nutzer in der Vergangenheit gestellt hat. Nur gültig, wenn mit der Suggest API verwendet. Wird ignoriert, wenn in der Abfrage-API verwendet.
PERSON Es werden Personen in der Organisation vorgeschlagen. Nur gültig, wenn mit der Suggest API verwendet. 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 sollen.

JSON-Darstellung 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Felder
objectType

string

Wenn „objectType“ festgelegt ist, werden nur Objekte dieses Typs zurückgegeben. Dieser sollte mit dem Namen des Objekts übereinstimmen, das in der Schemadefinition registriert wurde. Die maximale Länge beträgt 256 Zeichen.
filter

object (Filter)

Generischer Filter zur Einschränkung der Suche, z. B. lang:en, site:xyz.

Filter

Eine generische Möglichkeit, Filter in einer Abfrage auszudrücken, die zwei Ansätze unterstützt:

1. Sie legen einen ValueFilter fest. 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 auf oberster Ebene können nur AND oder NOT sein. AND kann nur auf der obersten Ebene verwendet werden. OR kann nur unter einem AND auf oberster Ebene erscheinen.

JSON-Darstellung 
{

  // 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.
}
Felder

Union-Feld filter.

Für filter ist nur einer der folgenden Werte zulässig:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

JSON-Darstellung 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Felder
operatorName

string

Die operatorName, die auf die Abfrage angewendet wird, z. B. price_greater_than. Der Filter kann auf beide Arten von Filtern angewendet werden, die im Schema für Ihre Datenquelle definiert sind:

  1. operatorName, wobei die Ergebnisse in der Abfrage nach dem Attribut gefiltert werden, das mit dem Wert übereinstimmt.

  2. greaterThanOperatorName oder lessThanOperatorName in Ihrem Schema Die Ergebnisse werden nach den Attributwerten gefiltert, die größer oder kleiner als der in der Abfrage angegebene Wert sind.
value

object (Value)

Der Wert, mit dem verglichen werden soll.

Wert

Definition eines einzelnen Werts mit generischen Typ.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld value. Der Wert der benannten Property. Für value ist nur einer der folgenden Werte zulässig:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

JSON-Darstellung 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Felder
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Der logische Operator des untergeordneten Filters.
subFilters[]

object (Filter)

Untergeordnete Filter

Filter.CompositeFilter.LogicOperator

Enums
AND Logische Operatoren, die nur auf untergeordnete Filter angewendet werden können.
OR
NOT „NICHT“ kann nur auf einen einzelnen untergeordneten Filter angewendet werden.

SourceConfig

Konfigurationen für eine Quelle bei der Verarbeitung einer query.search- oder query.suggest-Anfrage.

JSON-Darstellung 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Felder
source

object (Source)

Die Quelle, für die diese Konfiguration verwendet werden soll.
scoringConfig

object (SourceScoringConfig)

Die Bewertungskonfiguration für die Quelle.
crowdingConfig

object (SourceCrowdingConfig)

Die Überschneidungskonfiguration für die Quelle.

SourceScoringConfig

Legen Sie die Bewertungskonfiguration fest. So lässt sich die Reihenfolge der Ergebnisse für eine Quelle ändern.

JSON-Darstellung 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Felder
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Wichtigkeit der Quelle.

SourceScoringConfig.SourceImportance

Die Wichtigkeit einer Quelle, mit der angegeben werden kann, ob einer Quelle im Ranking eine höhere Priorität als einer anderen Quelle eingeräumt werden soll.

Enums
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Legen Sie Beschränkungen für die Anzahl der Suchergebnisse fest. Bei einer Überlastung werden andere Ergebnisse durch mehrere Ergebnisse aus derselben Quelle oder demselben Host verdrängt, was die Qualität der Suche für Nutzer beeinträchtigt. Um die Suchqualität und die Quellenvielfalt in den Suchergebnissen zu verbessern, können Sie eine Bedingung festlegen, um sich wiederholende Ergebnisse nach Quelle zu reduzieren.

JSON-Darstellung 
{
  "numResults": integer,
  "numSuggestions": integer
}
Felder
numResults

integer

Die maximale Anzahl von Ergebnissen, die aus einer Datenquelle auf einer Ergebnisseite zulässig sind, sofern die Ergebnisse aus anderen Quellen nicht aufgebraucht sind. Der angegebene Wert darf nicht negativ sein. Wenn dieser Wert 0 ist, wird ein Standardwert verwendet. Wenn Sie die Mengenbeschränkung deaktivieren möchten, setzen Sie den Wert auf einen Wert größer als 100.
numSuggestions

integer

Die maximale Anzahl der Vorschläge, die von einer Quelle zulässig sind. Wenn dieser Wert kleiner oder gleich 0 ist, werden keine Limits für die Ergebnisse festgelegt.

ScoringConfig

Bewertungskonfigurationen für eine Quelle bei der Verarbeitung einer query.search- oder query.suggest-Anfrage.

JSON-Darstellung 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Felder
disableFreshness

boolean

Ob Aktualität als Ranking-Signal verwendet werden soll. Standardmäßig wird die Aktualität als Ranking-Signal verwendet. Diese Einstellung ist nicht in der Admin-Benutzeroberfläche verfügbar.
disablePersonalization

boolean

Ob die Ergebnisse personalisiert werden sollen. Standardmäßig werden persönliche Signale verwendet, um die Ergebnisse zu verbessern.

SortOptions

JSON-Darstellung 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Felder
operatorName

string

Der Name des Operators, der dem Feld entspricht, nach dem sortiert werden soll. Die entsprechende Property muss als sortable gekennzeichnet sein.
sortOrder

enum (SortOptions.SortOrder)

Die Standardsortierreihenfolge ist „aufsteigend“.

SortOptions.SortOrder

Enums
ASCENDING
DESCENDING

FacetOptions

Gibt Operatoren an, für die Attributergebnisse zurückgegeben werden sollen. Für jede Kombination aus „sourceName“, „objectType“ und „operatorName“ gibt es ein FacetResult.

JSON-Darstellung 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Felder
sourceName

string

Name der Quelle, nach der die Facette erstellt werden soll. Format: datasources/{sourceId} Wenn das Feld leer ist, werden alle Datenquellen verwendet.
objectType

string

Wenn „objectType“ festgelegt ist, werden nur Objekte dieses Typs zum Berechnen von Facetten verwendet. Wenn das Feld leer ist, werden alle Objekte zum Berechnen von Facetten verwendet.
operatorName

string

Der Name des Operators, der für die Facetten ausgewählt wurde. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Maximale Anzahl der Facetten-Buckets, die für diese Facette zurückgegeben werden sollen. Der Standardwert ist 10. Der Höchstwert ist 100.
integerFacetingOptions

object (IntegerFacetingOptions)

Wenn festgelegt, werden Optionen für die Ganzzahlfacettierung für die angegebene Ganzzahleigenschaft beschrieben. Die entsprechende Ganzzahleigenschaft im Schema sollte als „isFacetable“ gekennzeichnet sein. Die Anzahl der zurückgegebenen Buckets ist das Minimum aus dieser Zahl und „numFacetBuckets“.

IntegerFacetingOptions

Wird verwendet, um Optionen für die Ganzzahlfacettierung anzugeben.

JSON-Darstellung 
{
  "integerBuckets": [
    string
  ]
}
Felder
integerBuckets[]

string (Int64Value format)

Die Bucket-Grenzwerte für die angegebenen Ganzzahlwerte müssen in streng aufsteigender Reihenfolge vorliegen. Wenn beispielsweise die Werte (1,5,10,100) angegeben werden, werden die folgenden Facetten-Buckets gebildet: {<1, [1,5), [5–10), [10–100), >=100}.

QueryInterpretationConfig

Standardoptionen für die Interpretation von Nutzerabfragen.

JSON-Darstellung 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Felder
forceVerbatimMode

boolean

Wenn Sie dieses Flag aktivieren, werden alle internen Optimierungen deaktiviert, z. B. die Interpretation von Suchanfragen in natürlicher Sprache, die Abfrage ergänzender Ergebnisse und die Verwendung von Synonyme, einschließlich benutzerdefinierter Synonyme. Wenn dieses Flag auf „True“ gesetzt ist, hat es Vorrang vor der Option auf Abfrageebene. Bei dem Standardwert „False“ wird die korrekte Interpretation für den wörtlichen Modus über das Flag auf Suchanfrageebene festgelegt.
forceDisableSupplementalResults

boolean

Wenn Sie dieses Flag setzen, werden keine ergänzenden 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. Bei dem Standardwert „False“ wird die richtige Interpretation für ergänzende Ergebnisse durch das Flag auf Abfrageebene festgelegt.

Methoden

create

 Erstellt eine Suchanwendung.

delete

 Löscht eine Suchanwendung.

get

 Ruft die angegebene Suchanwendung ab.

list

 Listet alle Suchanwendungen auf.

patch

 Aktualisiert eine Suchanwendung.

reset

 Setzt eine Suchanwendung auf die Standardeinstellungen zurück.

update

 Aktualisiert eine Suchanwendung.