- Ressource: SearchApplication
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- DataSourceRestriction
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Quelle
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Source.PredefinedSource
- FilterOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Filter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Filter.ValueFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Value
- Filter.CompositeFilter
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- Filter.CompositeFilter.LogicOperator
- SourceConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SourceScoringConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- ScoringConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SortOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- SortOptions.SortOrder
- FacetOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- IntegerFacetingOptions
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- QueryInterpretationConfig
<ph type="x-smartling-placeholder">
- </ph>
- JSON-Darstellung
- 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[] |
Einschränkungen, die auf die Konfigurationen angewendet werden. 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 |
Die Standardoptionen zum Sortieren der Suchergebnisse |
defaultFacetOptions[] |
Die Standardfelder für die Rückgabe von Attributergebnissen. Die hier angegebenen Quellen wurden auch in |
returnResultThumbnailUrls |
Bei jedem Ergebnis sollte der URI für die zugehörige 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 für die Suchanwendung in Query APIs aktiviert oder deaktiviert ist. |
queryInterpretationConfig |
Die Standardoptionen für die Interpretation von Abfragen |
DataSourceRestriction
Beschränkung für Datenquelle.
JSON-Darstellung |
---|
{ "source": { object ( |
Felder | |
---|---|
source |
Die Ursache der Einschränkung. |
filterOptions[] |
Filteroptionen, mit denen die Ergebnisse eingeschränkt werden. Wenn mehrere Filter vorhanden sind, werden sie vor dem Verknüpfen nach Objekttyp gruppiert. Filter mit demselben Objekttyp werden konjunktiv verknüpft. Die resultierenden Ausdrücke werden dann disjunktiv verknüpft. Es sind maximal 20 Elemente zulässig. HINWEIS: Die Suggest API unterstützt derzeit nur wenige Filter: "objecttype", "type". und "MIME-Typ". 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 |
Quellname für Inhalte, die von |
predefinedSource |
Vordefinierte Contentquelle für Google Apps |
Source.PredefinedSource
Vordefinierte Quellen:
Enums | |
---|---|
NONE |
|
QUERY_HISTORY |
Schlägt Suchanfragen vor, die der Nutzer in der Vergangenheit gestellt hat. Nur gültig in Verbindung mit der Suggest API. Wird bei Verwendung in der Query API ignoriert. |
PERSON |
Personen in der Organisation werden vorgeschlagen. Nur gültig in Verbindung mit der Suggest API. Führt bei der Verwendung in der Query 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 ( |
Felder | |
---|---|
objectType |
Wenn „objectType“ festgelegt ist, werden nur Objekte dieses Typs zurückgegeben. Dieser sollte dem Namen des Objekts entsprechen, das in der Schemadefinition registriert wurde. Die maximale Länge beträgt 256 Zeichen. |
filter |
Generischer Filter zum Einschränken der Suche, z. B. |
Filter
Eine allgemeine Art, Filter in einer Abfrage auszudrücken, die zwei Ansätze unterstützt:
1. Festlegen eines ValueFilter. Der Name muss mit einem Operatornamen übereinstimmen, der im Schema der Datenquelle definiert ist.
2. CompositeFilter. Die Filter werden mithilfe des logischen Operators ausgewertet. Die Operatoren der obersten Ebene können nur AND oder NOT sein. UND kann nur auf der obersten Ebene angezeigt werden. ODER kann nur unter einem UND auf der obersten Ebene angezeigt werden.
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 einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
JSON-Darstellung |
---|
{ "logicOperator": enum ( |
Felder | |
---|---|
logicOperator |
Der logische Operator des untergeordneten Filters. |
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 untergeordneten Filter 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 Konfiguration der Bewertung fest. So können Sie die Reihenfolge der Ergebnisse für eine Quelle ändern.
JSON-Darstellung |
---|
{
"sourceImportance": enum ( |
Felder | |
---|---|
sourceImportance |
Bedeutung der Quelle. |
SourceScoringConfig.SourceImportance
Die Bedeutung einer Quelle, mit der angegeben werden kann, ob einer Quelle im Vergleich zu einer anderen Quelle eine höhere Priorität eingeräumt werden sollte.
Enums | |
---|---|
DEFAULT |
|
LOW |
|
HIGH |
SourceCrowdingConfig
Sie können Limits für die Auslastung von Suchergebnissen festlegen. Crowding ist eine Situation, in der mehrere Ergebnisse von derselben Quelle oder demselben Host „Crowd-out“ darstellen. und dadurch die Qualität der Suche für die Nutzer abschwächen. Um eine bessere Suchqualität und Vielfalt von Quellen in Suchergebnissen zu fördern, können Sie eine Bedingung festlegen, mit der sich wiederholende Ergebnisse nach Quelle reduziert werden.
JSON-Darstellung |
---|
{ "numResults": integer, "numSuggestions": integer } |
Felder | |
---|---|
numResults |
Die maximal zulässige Anzahl von Ergebnissen aus einer Datenquelle auf einer Ergebnisseite, sofern Ergebnisse aus anderen Quellen nicht ausgeschöpft sind. angegebener Wert darf nicht negativ sein. Wenn dieser Wert gleich 0 ist, wird ein Standardwert verwendet. Um das Crowding zu deaktivieren, legen Sie einen Wert größer als 100 fest. |
numSuggestions |
Maximal zulässige Anzahl von Vorschlägen aus einer Quelle. Wenn dieser Wert kleiner oder gleich 0 ist, werden keine Einschränkungen für die Ergebnisse festgelegt. |
ScoringConfig
Bewertung von Konfigurationen für eine Quelle bei 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 die Ergebnisse zu verbessern. |
SortOptions
JSON-Darstellung |
---|
{
"operatorName": string,
"sortOrder": enum ( |
Felder | |
---|---|
operatorName |
Der Name des Operators, der dem Feld entspricht, nach dem sortiert werden soll. Das entsprechende Attribut muss als |
sortOrder |
„Aufsteigend“ ist die Standardsortierreihenfolge |
SortOptions.SortOrder
Enums | |
---|---|
ASCENDING |
|
DESCENDING |
FacetOptions
Gibt Operatoren an, für die Attributergebnisse zurückgegeben werden sollen. Für jede Kombination aus „sourceName“, „objectType/operatorName“ gibt es ein „FacetResult“.
JSON-Darstellung |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"numFacetBuckets": integer,
"integerFacetingOptions": {
object ( |
Felder | |
---|---|
sourceName |
Name der Quelle, auf die das Attribut angewendet werden soll. Format: datasources/{sourceId} Wenn das Feld leer ist, werden alle Datenquellen verwendet. |
objectType |
Wenn „objectType“ festgelegt ist, werden nur Objekte dieses Typs zur Berechnung von Attributen verwendet. Wenn das Feld leer ist, werden alle Objekte zur Berechnung von Attributen verwendet. |
operatorName |
Der Name des Operators, der für das Attribut ausgewählt wurde. @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 dieser Wert festgelegt ist, werden Optionen für Ganzzahlattribute für das angegebene Ganzzahlattribut beschrieben. Das entsprechende Ganzzahlattribut im Schema sollte als „isFacetable“ gekennzeichnet sein. Die Anzahl der zurückgegebenen Buckets würde mindestens dieses und numFacetBuckets umfassen. |
IntegerFacetingOptions
Wird verwendet, um Optionen für Ganzzahlattribute anzugeben.
JSON-Darstellung |
---|
{ "integerBuckets": [ string ] } |
Felder | |
---|---|
integerBuckets[] |
Buckets für bestimmte Ganzzahlwerte sollten in streng aufsteigender Reihenfolge vorliegen. Wenn die angegebenen Werte beispielsweise (1,5,10,100) sind, werden die folgenden Attribut-Buckets mit {<1, [1,5), [5-10), [10-100), >=100} gebildet. |
QueryInterpretationConfig
Standardoptionen zur Interpretation der Nutzeranfrage.
JSON-Darstellung |
---|
{ "forceVerbatimMode": boolean, "forceDisableSupplementalResults": boolean } |
Felder | |
---|---|
forceVerbatimMode |
Aktivieren Sie dieses Flag, um alle internen Optimierungen zu deaktivieren, z. B. die Interpretation von Suchanfragen in natürlicher Sprache (NL), das zusätzliche Abrufen von Ergebnissen und die Verwendung von Synonymen, einschließlich benutzerdefinierter. Wenn dieses Flag auf „True“ gesetzt ist, hat es Vorrang vor der Option auf Abfrageebene. Für den Standardwert „False“ legt das Flag auf Abfrageebene die richtige Interpretation für den wörtlichen Modus fest. |
forceDisableSupplementalResults |
Legen Sie dieses Flag fest, um den Abruf von zusätzlichen Ergebnissen zu deaktivieren. Wenn Sie hier ein Flag festlegen, werden keine zusätzlichen Ergebnisse für Abfragen abgerufen, die mit einer bestimmten Suchanwendung verknüpft sind. Wenn dieses Flag auf „True“ gesetzt ist, hat es Vorrang vor der Option auf Abfrageebene. Für den Standardwert „False“ legt das Flag auf Abfrageebene die richtige Interpretation für zusätzliche Ergebnisse fest. |
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. |