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 źródeł określonych w 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. Wskazane tutaj źródła zostały też uwzględnione w sekcji dataSourceRestrictions powyżej.

returnResultThumbnailUrls

boolean

W przypadku każdego wyniku należy zwrócić identyfikator URI miniatury (w odpowiednich przypadkach).

operationIds[]

string

Tylko dane wyjściowe. Identyfikatory długo trwających operacji (LRO) uruchomionych obecnie dla tego schematu. Pole tylko do danych wyjściowych.

enableAuditLog

boolean

Wskazuje, czy logowanie kontrolne jest włączone/wyłączone w przypadku żądań wysyłanych dla 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 ograniczające wyniki. Jeśli obecne jest wiele filtrów, przed złączeniem zostaną one pogrupowane według typu obiektu. Filtry tego samego typu obiektów są łączone spójnie, a wyrażenia wynikowe są łączone w sposób niespójny.

Maksymalna liczba elementów to 20.

UWAGA: interfejs Suggest API obsługuje obecnie tylko kilka filtrów: „objecttype”, „type” i „mimetype”. Obecnie nie można używać filtrów związanych ze schematem 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 w Google Apps.

Source.PredefinedSource

Wstępnie zdefiniowane źródła:

Wartości w polu enum
NONE
QUERY_HISTORY Sugeruje zapytania wpisane przez użytkownika w przeszłości. Ma zastosowanie tylko wtedy, gdy jest używany z interfejsem API sugestii. Ignorowana w przypadku użycia w interfejsie API zapytań.
PERSON Sugeruje osoby w organizacji. Ma zastosowanie tylko wtedy, gdy jest używany z interfejsem API sugestii. Użycie interfejsu 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 do zapytania.

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

string

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

filter

object (Filter)

Ogólny filtr ograniczający wyszukiwanie, np. lang:en, site:xyz.

Filtruj

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

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

2. Ustawianie filtra złożonego. Do oceny filtrów służy operator logiczny. Operatorami najwyższego poziomu mogą być tylko operatory AND i NOT. ORAZ może występować tylko na najwyższym poziomie. Operator LUB może występować tylko pod operatorem ORAZ najwyższego poziomu.

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

Wartość operatorName zastosowana do zapytania, np. price_greater_than. Filtr może działać z obydwoma typami filtrów zdefiniowanych w schemacie Twojego ź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 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 za pomocą typu ogólnego.

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 formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy 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 do filtrów podrzędnych.
OR
NOT NIE można stosować do jednego filtra podrzędnego.

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, dla którego ma zostać użyta ta konfiguracja.

scoringConfig

object (SourceScoringConfig)

Konfiguracja punktacji dla źródła.

crowdingConfig

object (SourceCrowdingConfig)

Konfiguracja grupowania dla źródła.

SourceScoringConfig

Ustaw konfigurację punktacji. Pozwala to zmodyfikować ranking wyników dla ź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że służyć do wskazywania, czy źródło powinno mieć wyższy priorytet w rankingu w porównaniu z innym źródłem.

Wartości w polu enum
DEFAULT
LOW
HIGH

SourceCrowdingConfig

Ustaw limity liczby zatłoczenia w wynikach wyszukiwania. W wyniku grupowania wiele wyników z tego samego źródła lub hosta jest wyeliminowane, co obniża jakość wyników wyszukiwania prezentowanych użytkownikom. Aby zwiększyć jakość wyszukiwania i różnorodność źródeł w wynikach wyszukiwania, możesz określić warunek ograniczający liczbę powtarzających się wyników z określonego źródła.

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

integer

Maksymalna dozwolona liczba wyników ze źródła danych na stronie z wynikami wyszukiwania, o ile wyniki z innych źródeł nie zostaną wyczerpane. Podana wartość nie może być ujemna. Jeśli wartość ta 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 z jednego źródła. Jeśli ta wartość jest mniejsza lub równa 0, w wynikach nie zostaną ustawione żadne ograniczenia.

ScoringConfig

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

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

boolean

Określa, czy jako czynnik decydujący o pozycji w rankingu używać aktualności. Domyślnie sygnałem rankingowym jest aktualność. To ustawienie jest niedostępne w interfejsie administratora.

disablePersonalization

boolean

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

SortOptions

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

string

Nazwa operatora odpowiadająca polu do sortowania. 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 operatory, dla których mają być zwracane wyniki aspektów. Dla każdej kombinacji nazwy_źródłowej, typu_obiektu/nazwa_operatora będzie jedna.

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

string

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

objectType

string

Jeśli obiekt eventType 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 do określania aspektów. @see cloudsearch.SchemaPropertyOptions

numFacetBuckets

integer

Maksymalna liczba zasobników aspektów, które powinny zostać zwrócone dla tego aspektu. Domyślna wartość to 10. Maksymalna wartość to 100.

integerFacetingOptions

object (IntegerFacetingOptions)

Jeśli jest ustawiony, opisuje opcje określania 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 „Facetable”. Liczba zwróconych zasobników będzie minimalna wynosząca tę wartość i numFacetbuckets.

IntegerFacetingOptions

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

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

string (Int64Value format)

Zasobniki na podane wartości całkowite powinny być ustawione w kolejności ściśle rosnącej. Jeśli na przykład podane wartości to (1,5,10,100), następujące zasobniki aspektów zostaną utworzone {<1, [1,5), [5–10), [10–100), >=100}.

QueryInterpretationConfig

Domyślne opcje interpretacji zapytania użytkownika.

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

boolean

Włącz tę flagę, aby wyłączyć wszystkie wewnętrzne optymalizacje, takie jak interpretacja zapytań w języku naturalnym (NL), pobieranie wyników uzupełniających i używanie synonimów, w tym niestandardowych. Jeśli ta flaga ma wartość Prawda, ma ona pierwszeństwo przed opcją ustawioną na poziomie zapytania. W przypadku domyślnej wartości Fałsz flaga na poziomie zapytania ustawia prawidłową interpretację trybu dosłownego.

forceDisableSupplementalResults

boolean

Ustaw tę flagę, aby wyłączyć pobieranie wyników uzupełniających. Zastosowanie flagi nie spowoduje pobierania uzupełniających wyników dla zapytań powiązanych z daną aplikacją wyszukiwania. Jeśli ta flaga ma wartość Prawda, ma ona pierwszeństwo przed opcją ustawioną na poziomie zapytania. W przypadku domyślnej wartości False (Fałsz) flaga na poziomie zapytania ustawia 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ę.