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 wyszukiwarki.

Format: searchapplications/{applicationId}.
displayName

string

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

object (DataSourceRestriction)

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

object (SourceConfig)

Konfiguracja dla źródeł określonych w zasadzie dataSourceRestrictions.
scoringConfig

object (ScoringConfig)

Konfiguracja rankingu wyników.
defaultSortOptions

object (SortOptions)

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

object (FacetOptions)

Domyślne pola do zwracania wyników aspektów. Określone tutaj źródła 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 odpowiednich przypadkach).
operationIds[]

string

Tylko dane wyjściowe. Identyfikatory długotrwałych operacji (LRO) aktualnie uruchomionych dla tego schematu. Pole tylko dane wyjściowe.
enableAuditLog

boolean

Wskazuje, czy logowanie kontrolne jest włączone/wyłączone w przypadku żądań wysyłanych do wyszukiwarki w interfejsach API zapytań.
queryInterpretationConfig

object (QueryInterpretationConfig)

Domyślne opcje interpretacji zapytań

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, które ograniczają wyniki Jeśli dostępnych jest kilka filtrów, przed złączeniem są one pogrupowane według typu obiektu. Filtry o tym samym typie obiektu są łączone spójnie, a wyrażenia wynikowe są łączone w sposób niezgodny.

Maksymalna liczba elementów to 20.

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

Źródło

Definiuje źródła dla 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 sumy source.

source może mieć tylko jedną z tych wartości:
name

string

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

enum (Source.PredefinedSource)

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

Source.PredefinedSource

Wstępnie zdefiniowane źródła:

Wartości w polu enum
NONE
QUERY_HISTORY Proponuje zapytania wpisane przez użytkownika w przeszłości. Prawidłowy tylko wtedy, gdy jest używany z interfejsem Sugestie API. Ignorowane w przypadku używania w interfejsie API zapytań.
PERSON Sugeruje osoby w organizacji. Prawidłowy tylko wtedy, gdy jest używany z interfejsem Sugestie API. Użycie interfejsu API zapytań powoduje wystąpienie błędu.
GOOGLE_DRIVE
GOOGLE_GMAIL
GOOGLE_SITES
GOOGLE_GROUPS
GOOGLE_CALENDAR
GOOGLE_KEEP

FilterOptions

Opcje filtrowania, które mają być stosowane do zapytania.

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

string

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

object (Filter)

Filtr ogólny do ograniczenia wyszukiwania, np. lang:en, site:xyz.

Filtr

Ogólny sposób formułowania filtrów w zapytaniu, który obsługuje 2 sposoby:

1. Ustawienie filtra wartości. Nazwa musi być zgodna z operatoremName zdefiniowanym w schemacie źródła danych.

2. Ustawienie filtra złożonego. Filtry są oceniane za pomocą operatora logicznego. Operatorami najwyższego poziomu mogą być tylko AND (oraz) lub NOT. ORAZ może pojawiać się tylko na najwyższym poziomie. Operator OR może pojawiać się tylko poniżej najwyższego poziomu w operatorze ORAZ.

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 sumy filter.

filter może mieć tylko jedną z tych wartości:
valueFilter

object (Filter.ValueFilter)
compositeFilter

object (Filter.CompositeFilter)

Filter.ValueFilter

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

string

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

  1. operatorName, gdzie zapytanie filtruje wyniki według właściwości pasującej do wartości.

  2. greaterThanOperatorName lub lessThanOperatorName w schemacie. Zapytanie filtruje wyniki dotyczące 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 sumy value. Wartość nazwanej właściwości. value może mieć tylko jedną z tych wartości:
stringValue

string
integerValue

string (int64 format)
doubleValue

number
timestampValue

string (Timestamp format)

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi 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 filtra podrzędnego.
subFilters[]

object (Filter)

Filtry podrzędne.

Filter.CompositeFilter.LogicOperator

Wartości w polu enum
AND Operatory logiczne, które można stosować tylko w filtrach podrzędnych.
OR
NOT NIE można zastosować tylko do jednego filtra podrzędnego.

SourceConfig

Konfiguracje dla ź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, dla którego ma być używana ta konfiguracja.
scoringConfig

object (SourceScoringConfig)

Konfiguracja punktacji źródła.
crowdingConfig

object (SourceCrowdingConfig)

Konfiguracja grupowania dla źródła.

SourceScoringConfig

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

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

enum (SourceScoringConfig.SourceImportance)

Znaczenie źródła.

SourceScoringConfig.SourceImportance

Znaczenie źródła, które można wykorzystać do wskazania, czy źródło powinno mieć wyższy priorytet w rankingu niż inne.

Wartości w polu enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Ustaw limity grupowania w wynikach wyszukiwania. Grupowanie to sytuacja, w której wiele wyników z tego samego źródła lub hosta jest wyczerpane innych wyników, obniżając jakość wyszukiwania użytkowników. Aby poprawić jakość wyszukiwania i różnorodność źródeł w wynikach wyszukiwania, możesz ustawić warunek zmniejszania liczby powtarzających się wyników z podziałem na źródło.

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

integer

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

integer

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

ScoringConfig

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

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

boolean

Określa, czy aktualność ma być sygnałem rankingowym. Domyślnie aktualność jest traktowana jako sygnał rankingowy. Pamiętaj, że to ustawienie nie jest dostępne w interfejsie administratora.
disablePersonalization

boolean

Określa, czy wyniki mają być personalizowane. Domyślnie do poprawiania wyników będą używane Twoje sygnały.

SortOptions

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

string

Nazwa operatora odpowiadającego polu, według którego ma być sortowane. Odpowiadająca jej właściwość musi być oznaczona jako sortable.
sortOrder

enum (SortOptions.SortOrder)

Rosnąco to domyślna kolejność sortowania

SortOptions.SortOrder

Wartości w polu enum
ASCENDING
DESCENDING

FacetOptions

Określa operatory, dla których mają być zwracane wyniki aspektu. Dla każdej kombinacji nazwa źródła, typ obiektu i nazwaoperatora będzie istnieć 1 wynik FacetResult.

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

string

Nazwa źródła, dla którego ma zostać zastosowany aspekt. Format: datasources/{sourceId} Jeśli to pole jest puste, używane będą wszystkie źródła danych.
objectType

string

Jeśli obiektobjectType jest ustawiony, do obliczania aspektów będą używane tylko obiekty tego typu. Jeśli pole jest puste, do obliczania aspektów będą używane wszystkie obiekty.
operatorName

string

Nazwa operatora wybranego na potrzeby określania aspektów. @patrz cloudsearch.Schema PropertyOptions
numFacetBuckets

integer

Maksymalna liczba zasobników 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 ustawiony, opisuje opcje aspektów liczb całkowitych dla danej właściwości liczby całkowitej. Odpowiednia właściwość liczby całkowitej w schemacie powinna być oznaczona jako „isFacetable”. Liczba zwróconych zasobników będzie minimalną wartością tego zasobu i numFacetBuckets.

IntegerFacetingOptions

Służy do określania opcji aspektów liczb całkowitych.

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

string (Int64Value format)

Zasobniki z określonymi wartościami całkowitymi powinny być uporządkowane ściśle rosnąco. Jeśli na przykład podane wartości to (1,5,10,100), zostaną utworzone następujące zasobniki aspektów {<1, [1,5), [5-10), [10-100), >=100}.

QueryInterpretationConfig

Opcje domyślne interpretacji zapytania użytkownika.

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

boolean

Włącz tę flagę, aby wyłączyć wszystkie optymalizacje wewnętrzne, takie jak interpretacja zapytań przy użyciu języka naturalnego (NL), pobieranie dodatkowych wyników oraz używanie synonimów, w tym niestandardowych. Jeśli ta flaga ma wartość Prawda, ma pierwszeństwo przed opcją ustawioną na poziomie zapytania. W przypadku wartości domyślnej „Fałsz” flaga na poziomie zapytania ustawi prawidłową interpretację trybu dokładnego.
forceDisableSupplementalResults

boolean

Ustaw tę flagę, aby wyłączyć pobieranie dodatkowych wyników. Ustawienie flagi w tym miejscu nie spowoduje pobrania dodatkowych wyników dla zapytań powiązanych z daną wyszukiwarką. Jeśli ta flaga ma wartość Prawda, ma pierwszeństwo przed opcją ustawioną na poziomie zapytania. W przypadku wartości domyślnej „Fałsz” flaga na poziomie zapytania ustawi prawidłową interpretację wyników uzupełniających.

Metody

create

 Tworzy wyszukiwarkę.

delete

 Usuwa wyszukiwarkę.

get

 Pobiera określoną wyszukiwarkę.

list

 Wyświetla listę wszystkich wyszukiwarek.

patch

 Aktualizuje wyszukiwarkę.

reset

 Resetuje wyszukiwarkę do ustawień domyślnych.

update

 Aktualizuje wyszukiwarkę.