- Zasób: SearchApplication
- DataSourceRestriction
- Źródło
- Source.PredefinedSource
- FilterOptions:
- Filtrowanie
- Filter.ValueFilter
- Wartość
- Filter.CompositeFilter
- Filter.CompositeFilter.LogicOperator
- SourceConfig
- SourceScoringConfig
- SourceScoringConfig.SourceImportance
- SourceCrowdingConfig
- ScoringConfig
- SortOptions.
- SortOptions.SortOrder
- FacetOptions
- IntegerFacetingOptions
- QueryInterpretationConfig
- Metody
Zasób: SearchApplication
SearchApplication
Zapis JSON |
---|
{ "name": string, "displayName": string, "dataSourceRestrictions": [ { object ( |
Pola | |
---|---|
name |
Nazwa wyszukiwarki. Format: searchapplications/{applicationId}. |
displayName |
Wyświetlana nazwa wyszukiwarki. Maksymalna długość to 300 znaków. |
dataSourceRestrictions[] |
Ograniczenia zastosowane do konfiguracji. Maksymalna liczba elementów to 10. |
sourceConfig[] |
Konfiguracja źródeł określonych w dataSourceRestrictions. |
scoringConfig |
Konfiguracja rankingu wyników. |
defaultSortOptions |
Domyślne opcje sortowania wyników wyszukiwania |
defaultFacetOptions[] |
Domyślne pola do zwracania wyników aspektów. Wskazane tutaj źródła zostały też uwzględnione w sekcji |
returnResultThumbnailUrls |
W przypadku każdego wyniku należy zwrócić identyfikator URI miniatury (w odpowiednich przypadkach). |
operationIds[] |
Tylko dane wyjściowe. Identyfikatory długo trwających operacji (LRO) uruchomionych obecnie dla tego schematu. Pole tylko do danych wyjściowych. |
enableAuditLog |
Wskazuje, czy logowanie kontrolne jest włączone/wyłączone w przypadku żądań wysyłanych dla wyszukiwarki w interfejsach API zapytań. |
queryInterpretationConfig |
Domyślne opcje interpretacji zapytań |
DataSourceRestriction
Ograniczenie dotyczące źródła danych.
Zapis JSON |
---|
{ "source": { object ( |
Pola | |
---|---|
source |
Źródło ograniczenia. |
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 |
Pola | |
---|---|
Pole sumy
|
|
name |
Nazwa źródła treści zindeksowanej przez |
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 ( |
Pola | |
---|---|
objectType |
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 |
Ogólny filtr ograniczający wyszukiwanie, np. |
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 |
Pola | |
---|---|
Pole sumy
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
Zapis JSON |
---|
{
"operatorName": string,
"value": {
object ( |
Pola | |
---|---|
operatorName |
Wartość
|
value |
Wartość do porównania. |
Wartość
Definicja pojedynczej wartości za pomocą typu ogólnego.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole sumy value . Wartość nazwanej właściwości. value może mieć tylko jedną z tych wartości: |
|
stringValue |
|
integerValue |
|
doubleValue |
|
timestampValue |
Sygnatura czasowa w formacie RFC3339 UTC „Zulu”, z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: |
booleanValue |
|
dateValue |
|
Filter.CompositeFilter
Zapis JSON |
---|
{ "logicOperator": enum ( |
Pola | |
---|---|
logicOperator |
Operator logiczny filtra podrzędnego. |
subFilters[] |
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 ( |
Pola | |
---|---|
source |
Źródło, dla którego ma zostać użyta ta konfiguracja. |
scoringConfig |
Konfiguracja punktacji dla źródła. |
crowdingConfig |
Konfiguracja grupowania dla źródła. |
SourceScoringConfig
Ustaw konfigurację punktacji. Pozwala to zmodyfikować ranking wyników dla źródła.
Zapis JSON |
---|
{
"sourceImportance": enum ( |
Pola | |
---|---|
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 |
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 |
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 |
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 |
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 ( |
Pola | |
---|---|
operatorName |
Nazwa operatora odpowiadająca polu do sortowania. Odpowiednia właściwość musi być oznaczona jako |
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 ( |
Pola | |
---|---|
sourceName |
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 |
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 |
Nazwa operatora wybranego do określania aspektów. @see cloudsearch.SchemaPropertyOptions |
numFacetBuckets |
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 |
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[] |
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 |
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 |
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 |
|
---|---|
|
Tworzy wyszukiwarkę. |
|
Usuwa wyszukiwarkę. |
|
Pobiera określoną wyszukiwarkę. |
|
Wyświetla listę wszystkich wyszukiwarek. |
|
Aktualizuje wyszukiwarkę. |
|
Resetuje wyszukiwarkę do ustawień domyślnych. |
|
Aktualizuje wyszukiwarkę. |