- Zasób: SearchApplication
- DataSourceRestriction
- Źródło
- Source.PredefinedSource
- FilterOptions
- Filtruj
- 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 dla źródeł określonych w zasadzie dataSourceRestrictions. |
scoringConfig |
Konfiguracja rankingu wyników. |
defaultSortOptions |
Domyślne opcje sortowania wyników wyszukiwania |
defaultFacetOptions[] |
Domyślne pola do zwracania wyników aspektów. Określone tutaj źródła zostały również uwzględnione w |
returnResultThumbnailUrls |
W przypadku każdego wyniku powinniśmy zwracać identyfikator URI jego miniatury (w odpowiednich przypadkach). |
operationIds[] |
Tylko dane wyjściowe. Identyfikatory długotrwałych operacji (LRO) aktualnie uruchomionych dla tego schematu. Pole tylko dane wyjściowe. |
enableAuditLog |
Wskazuje, czy logowanie kontrolne jest włączone/wyłączone w przypadku żądań wysyłanych do 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, 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 |
Pola | |
---|---|
Pole sumy
|
|
name |
Nazwa źródła treści zindeksowanej przez |
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 ( |
Pola | |
---|---|
objectType |
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 |
Filtr ogólny do ograniczenia wyszukiwania, np. |
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 |
Pola | |
---|---|
Pole sumy
|
|
valueFilter |
|
compositeFilter |
|
Filter.ValueFilter
Zapis JSON |
---|
{
"operatorName": string,
"value": {
object ( |
Pola | |
---|---|
operatorName |
Pole
|
value |
Wartość do porównania. |
Wartość
Definicja pojedynczej wartości o typie ogólnym.
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 RFC3339 UTC „Zulu” z rozdzielczością nanosekundową 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 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 ( |
Pola | |
---|---|
source |
Źródło, dla którego ma być używana ta konfiguracja. |
scoringConfig |
Konfiguracja punktacji źródła. |
crowdingConfig |
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 ( |
Pola | |
---|---|
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 |
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 |
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 |
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 |
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 ( |
Pola | |
---|---|
operatorName |
Nazwa operatora odpowiadającego polu, według którego ma być sortowane. Odpowiadająca jej właściwość musi być oznaczona jako |
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 ( |
Pola | |
---|---|
sourceName |
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 |
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 |
Nazwa operatora wybranego na potrzeby określania aspektów. @patrz cloudsearch.Schema PropertyOptions |
numFacetBuckets |
Maksymalna liczba zasobników aspektów, które mają być zwracane dla tego aspektu. Domyślna wartość to 10. Maksymalna wartość to 100. |
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[] |
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 |
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 |
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 |
|
---|---|
|
Tworzy wyszukiwarkę. |
|
Usuwa wyszukiwarkę. |
|
Pobiera określoną wyszukiwarkę. |
|
Wyświetla listę wszystkich wyszukiwarek. |
|
Aktualizuje wyszukiwarkę. |
|
Resetuje wyszukiwarkę do ustawień domyślnych. |
|
Aktualizuje wyszukiwarkę. |