REST Resource: settings.searchapplications

Zasób: SearchApplication

SearchApplication

Zapis 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)
  }
}
Pola
name

string

Nazwa aplikacji wyszukiwania.

Format: searchapplications/{applicationId}.
displayName

string

Wyświetlana nazwa aplikacji wyszukiwania. Maksymalna długość to 300 znaków.
dataSourceRestrictions[]

object (DataSourceRestriction)

Ograniczenia zastosowane do konfiguracji. Maksymalna liczba elementów to 10.
sourceConfig[]

object (SourceConfig)

Konfiguracja źródeł wymienionych w sekcji dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

Konfiguracja pozycji w wynikach wyszukiwania.
defaultSortOptions

object (SortOptions)

Domyślne opcje sortowania wyników wyszukiwania
defaultFacetOptions[]

object (FacetOptions)

Domyślne pola zwracania wyników posortowanych według atrybutów. Źródła wymienione tutaj zostały również uwzględnione w dataSourceRestrictions powyżej.
returnResultThumbnailUrls

boolean

W przypadku każdego wyniku powinniśmy zwracać identyfikator URI jego miniatury (w stosownych przypadkach).
operationIds[]

string

Tylko dane wyjściowe. Identyfikatory długotrwałych operacji (LROs) obecnie wykonywanych w ramach tego schematu. Pole tylko z danymi wyjściowymi.
enableAuditLog

boolean

Wskazuje, czy rejestrowanie kontroli jest włączone/wyłączone w przypadku żądań wysyłanych do aplikacji wyszukiwania w interfejsach zapytań.
queryInterpretationConfig

object (QueryInterpretationConfig)

Domyślne opcje interpretacji zapytania

DataSourceRestriction

Ograniczenie dotyczące źródła danych.

Zapis JSON 
{
  "source": {
    object (Source)
  },
  "filterOptions": [
    {
      object (FilterOptions)
    }
  ]
}
Pola
source

object (Source)

Źródło ograniczenia.
filterOptions[]

object (FilterOptions)

Opcje filtrowania ograniczające wyniki. Jeśli obecnych jest wiele filtrów, przed złączeniem są one grupowane według typu obiektu. Filtry z tym samym typem obiektu są złączane koniunktywnie, a wyniki złączenia są złączane alternatywnie.

Maksymalna liczba elementów to 20.

UWAGA: interfejs API Suggest obsługuje obecnie tylko kilka filtrów: „objecttype”, „type” i „mimetype”. Obecnie nie można używać filtrów dotyczących schematu do filtrowania sugestii.

Źródło

Określa źródła interfejsów API sugestii/wyszukiwania.

Zapis 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.
}
Pola

Pole unii source.

source może być tylko jednym z tych elementów:
name

string

Nazwa źródła treści zindeksowanych przez Indexing API.
predefinedSource

enum (Source.PredefinedSource)

Wstępnie zdefiniowane źródło treści w Google Apps.

Source.PredefinedSource

Zdefiniowane wstępnie źródła:

Wartości w polu enum
NONE
QUERY_HISTORY Sugeruje zapytania, które użytkownik wysłał w przeszłości. Dozwolone tylko w połączeniu z interfejsem API sugestii. Ignorowane, gdy jest używane w interfejsie Query API.
PERSON sugeruje osoby z organizacji; Dozwolone tylko w połączeniu z interfejsem API sugestii. Użycie w interfejsie Query API powoduje błąd.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

opcje filtrowania, które mają być stosowane w zapytaniu.

Zapis JSON 
{
  "objectType": string,
  "filter": {
    object (Filter)
  }
}
Pola
objectType

string

Jeśli parametr objectType jest ustawiony, zwracane są tylko obiekty tego typu. Powinna ona odpowiadać nazwie obiektu zarejestrowanego w definicji schematu. Maksymalna długość to 256 znaków.
filter

object (Filter)

Ogólny filtr do ograniczania wyszukiwania, np. lang:en, site:xyz.

Filtr

Ogólny sposób wyrażania filtrów w zapytaniu, który obsługuje 2 podejście:

1. Ustawianie filtra ValueFilter. Nazwa musi być zgodna z operatorName zdefiniowanym w schemacie źródła danych.

2. Konfigurowanie filtra CompositeFilter. Filtry są oceniane za pomocą operatora logicznego. Operatorami najwyższego poziomu mogą być tylko AND lub NOT. Operator AND może występować tylko na najwyższym poziomie. Operator LUB może występować tylko w ramach operatora NAJWYŻSZEGO POZIOMU I.

Zapis 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.
}
Pola

Pole unii filter.

filter może być tylko jednym z tych elementów:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

Zapis JSON 
{
  "operatorName": string,
  "value": {
    object (Value)
  }
}
Pola
operatorName

string

operatorName zastosowany do zapytania, np. price_greater_than. Filtr może działać na podstawie obu typów filtrów zdefiniowanych w schemacie źródła danych:

  1. operatorName, gdzie zapytanie filtruje wyniki według właściwości, która pasuje do wartości.

  2. greaterThanOperatorName lub lessThanOperatorName w schemacie. Zapytanie filtruje wyniki pod kątem wartości właściwości, które są większe lub mniejsze od wartości podanej w zapytaniu.
value

object (Value)

Wartość do porównania.

Wartość

Definicja pojedynczej wartości o typie ogólnym.

Zapis 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.
}
Pola
Pole unii value. Wartość właściwości nazwanej. value może być tylko jednym z tych elementów:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
booleanValue

boolean
dateValue

object (Date)

Filter.CompositeFilter

Zapis JSON 
{
  "logicOperator": enum (Filter.CompositeFilter.LogicOperator),
  "subFilters": [
    {
      object (Filter)
    }
  ]
}
Pola
logicOperator

enum (Filter.CompositeFilter.LogicOperator)

Operator logiczny podfiltra.
subFilters[]

object (Filter)

Filtry podrzędne.

Filter.CompositeFilter.LogicOperator

Wartości w polu enum
AND operatory logiczne, które można stosować tylko do podfiltrów.
OR
NOT Operator NOT można zastosować tylko do jednego podfiltra.

SourceConfig

Konfiguracje źródła podczas przetwarzania żądania query.search lub query.suggest.

Zapis JSON 
{
  "source": {
    object (Source)
  },
  "scoringConfig": {
    object (SourceScoringConfig)
  },
  "crowdingConfig": {
    object (SourceCrowdingConfig)
  }
}
Pola
source

object (Source)

Źródło, w którym ma być używana ta konfiguracja.
scoringConfig

object (SourceScoringConfig)

Konfiguracja punktacji źródła.
crowdingConfig

object (SourceCrowdingConfig)

Konfiguracja tłoku dla źródła.

SourceScoringConfig

Skonfiguruj konfigurację punktacji. Umożliwia to modyfikowanie rankingu wyników dla źródła.

Zapis JSON 
{
  "sourceImportance": enum (SourceScoringConfig.SourceImportance)
}
Pola
sourceImportance

enum (SourceScoringConfig.SourceImportance)

Ważność źródła.

SourceScoringConfig.SourceImportance

Ważność źródła, która może wskazywać, czy źródło powinno być traktowane priorytetowo w rankingu w porównaniu z innym źródłem.

Wartości w polu enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Ustaw limity natłoku wyników wyszukiwania. Zagęszczenie to sytuacja, w której wiele wyników z tego samego źródła lub hosta „wypiera” inne wyniki, co pogarsza jakość wyszukiwania dla użytkowników. Aby poprawić jakość wyszukiwania i różnorodność źródeł w wynikach wyszukiwania, możesz ustawić warunek, który ograniczy powtarzające się wyniki według źródła.

Zapis JSON 
{
  "numResults": integer,
  "numSuggestions": integer
}
Pola
numResults

integer

Maksymalna liczba wyników dozwolonych ze źródła danych na stronie wyników, o ile nie zostały jeszcze wyczerpane wyniki z innych źródeł. Wartość nie może być ujemna. Jeśli ta wartość jest równa 0, używana jest wartość domyślna. Aby wyłączyć limit liczby wyników, ustaw wartość większą niż 100.
numSuggestions

integer

Maksymalna dozwolona liczba sugestii ze źródła. Jeśli ta wartość jest równa 0 lub mniejsza od 0, wyniki nie będą ograniczane.

ScoringConfig

Konfiguracje punktacji źródła podczas przetwarzania żądania query.search lub query.suggest.

Zapis JSON 
{
  "disableFreshness": boolean,
  "disablePersonalization": boolean
}
Pola
disableFreshness

boolean

Określa, czy data publikacji ma być używana jako sygnał rankingowy. Domyślnie świeżość jest używana jako sygnał rankingowy. To ustawienie nie jest dostępne w interfejsie administracyjnym.
disablePersonalization

boolean

czy wyniki mają być spersonalizowane. Domyślnie do wzbogacania wyników będą używane sygnały osobiste.

SortOptions

Zapis JSON 
{
  "operatorName": string,
  "sortOrder": enum (SortOptions.SortOrder)
}
Pola
operatorName

string

Nazwa operatora odpowiadającego polu, według którego ma nastąpić sortowanie. Odpowiednia właściwość musi być oznaczona jako sortable.
sortOrder

enum (SortOptions.SortOrder)

Domyślna kolejność sortowania to rosnąco

SortOptions.SortOrder

Wartości w polu enum
ASCENDING
DESCENDING

FacetOptions

Określa operatorów, dla których mają być zwracane wyniki aspektów. Dla każdej kombinacji sourceName/objectType/operatorName będzie jeden FacetResult.

Zapis JSON 
{
  "sourceName": string,
  "objectType": string,
  "operatorName": string,
  "numFacetBuckets": integer,
  "integerFacetingOptions": {
    object (IntegerFacetingOptions)
  }
}
Pola
sourceName

string

Nazwa źródła, na którym chcesz utworzyć kolumnę. Format: datasources/{sourceId} Jeśli pole jest puste, zostaną użyte wszystkie źródła danych.
objectType

string

Jeśli ustawisz parametr objectType, do obliczenia aspektów będą używane tylko obiekty tego typu. Jeśli jest puste, do obliczenia aspektów zostaną użyte wszystkie obiekty.
operatorName

string

Nazwa operatora wybranego do podziału na podgrupy. @see cloudsearch.SchemaPropertyOptions
numFacetBuckets

integer

Maksymalna liczba grup aspektów, które mają być zwracane dla tego aspektu. Domyślna wartość to 10. Maksymalna wartość to 100.
integerFacetingOptions

object (IntegerFacetingOptions)

Jeśli jest ustawiona, opisuje opcje podziału na wymiary liczbowe dla danej właściwości liczbowej. Odpowiednia liczba całkowita we właściwości w schemacie powinna być oznaczona jako isFacetable. Zwracana liczba puli będzie równa mniejszej z tych wartości.

IntegerFacetingOptions

Służy do określania opcji podziału na kolumny z użyciem liczb całkowitych.

Zapis JSON 
{
  "integerBuckets": [
    string
  ]
}
Pola
integerBuckets[]

string (Int64Value format)

Grupy dla podanych wartości liczb całkowitych powinny być uporządkowane ściśle rosnąco. Jeśli np. podane wartości to (1,5,10,100), utworzone zostaną te zasobniki aspektów: {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

Domyślne opcje interpretowania zapytania użytkownika.

Zapis JSON 
{
  "forceVerbatimMode": boolean,
  "forceDisableSupplementalResults": boolean
}
Pola
forceVerbatimMode

boolean

Włącz tę opcję, aby wyłączyć wszystkie optymalizacje wewnętrzne, takie jak interpretacja zapytań w języku naturalnym, pobieranie dodatkowych wyników i używanie synonimów, w tym niestandardowych. Jeśli ta flaga ma wartość Prawda, ma ona wyższy priorytet niż opcja ustawiona na poziomie zapytania. W przypadku domyślnej wartości False (fałsz) flaga na poziomie zapytania spowoduje prawidłową interpretację w trybie dosłownym.
forceDisableSupplementalResults

boolean

Ustawienie tej flagi spowoduje wyłączenie pobierania dodatkowych wyników. W efekcie nie będą pobierane dodatkowe wyniki dla zapytań powiązanych z danym narzędziem wyszukiwania. Jeśli ta flaga ma wartość Prawda, ma ona wyższy priorytet niż opcja ustawiona na poziomie zapytania. W przypadku domyślnej wartości False flaga poziomu zapytania spowoduje prawidłową interpretację wyników dodatkowych.

Metody

create

 Tworzy wyszukiwarkę.

delete

 Usuwa wyszukiwarkę.

get

 Pobiera wskazaną aplikację wyszukiwania.

list

 Wyświetla listę wszystkich aplikacji wyszukiwania.

patch

 Aktualizuje wyszukiwarkę.

reset

 Przywraca ustawienia domyślne aplikacji wyszukiwania.

update

 Aktualizuje wyszukiwarkę.