REST Resource: projects.locations.corpora.searchConfigs

Risorsa: SearchConfig

SearchConfig memorizza diverse proprietà che influiscono sui comportamenti di ricerca e sui risultati di ricerca.

Rappresentazione JSON 
{
  "name": string,
  "facetProperty": {
    object (FacetProperty)
  },
  "searchCriteriaProperty": {
    object (SearchCriteriaProperty)
  }
}
Campi
name

string

Nome della risorsa della configurazione di ricerca. Per CustomSearchCriteria, searchConfig è il nome dell'operatore di ricerca. Per i facet, searchConfig è il nome della dimensione del facet. Modulo: projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{searchConfig}
facetProperty

object (FacetProperty)

Stabilisce una dimensione del livello e le specifiche associate.
searchCriteriaProperty

object (SearchCriteriaProperty)

Crea una mappatura tra un SearchCriteria personalizzato e una o più chiavi UGA.

FacetProperty

Configurazione centrale per un aspetto.

Rappresentazione JSON 
{
  "mappedFields": [
    string
  ],
  "displayName": string,
  "resultSize": string,
  "bucketType": enum (FacetBucketType),

  // Union field range_facet_config can be only one of the following:
  "fixedRangeBucketSpec": {
    object (FixedRangeBucketSpec)
  },
  "customRangeBucketSpec": {
    object (CustomRangeBucketSpec)
  },
  "datetimeBucketSpec": {
    object (DateTimeBucketSpec)
  }
  // End of list of possible types for union field range_facet_config.
}
Campi
mappedFields[]

string

Nome dei facet, ovvero le dimensioni che gli utenti vogliono utilizzare per perfezionare i risultati di ricerca. mappedFields corrisponderà alle chiavi UserSpecifiedDataSchema.

Ad esempio, l'utente può aggiungere una serie di UGA con la stessa chiave, ad esempio player:adam, player:bob, player:charles. Se vengono specificati più mappedFields, il loro valore verrà unito come valore finale della frazione. Ad esempio, home_team: a, home_team:b, away_team:a, away_team:c, quando il campo facet_field = [home_team, away_team], il valore facet_value sarà [a, b, c].

A meno che non si tratti di una dimensione delle sfaccettature 1:1 (mappedFields.size() == 1) E il campo mapped_field sia uguale al nome SearchConfig.name del campo principale, il campo principale deve contenere anche una proprietà SearchCriteriaProperty che mappa gli stessi campi. mappedFields non deve essere vuoto.
displayName

string

Nome visualizzato del facet. Da utilizzare dall'interfaccia utente per il rendering delle sfaccettature.
resultSize

string (int64 format)

Numero massimo di bucket univoci da restituire per un facet. Il numero di bucket può essere elevato per un aspetto ad alta cardinalità come "giocatore". Restituisce solo i risultati più pertinenti per l'utente. Se è <= 0, il server deciderà il valore appropriato di resultSize.
bucketType

enum (FacetBucketType)

Tipo di bucket della Facet, ad esempio valore, intervallo.

Campo unione range_facet_config.

range_facet_config può essere solo uno dei seguenti:
fixedRangeBucketSpec

object (FixedRangeBucketSpec)

Configurazione del bucket degli aspetti con intervallo fisso.
customRangeBucketSpec

object (CustomRangeBucketSpec)

Configurazione del bucket di facet dell'intervallo personalizzato.
datetimeBucketSpec

object (DateTimeBucketSpec)

Configurazione del bucket del livello dell'intervallo di date e ora.

FixedRangeBucketSpec

Se il tipo di bucket è FIXED_RANGE, specifica la modalità di suddivisione dei valori nei bucket. Utilizza FixedRangeBucketSpec quando vuoi creare più bucket con granularità uguali. Utilizzando il valore del bucket intero come esempio, quando bucketStart = 0, bucketGranularity = 10, bucketCount = 5, questo facet verrà aggregato tramite i seguenti bucket: [-inf, 0), [0, 10), [10, 20), [20, 30), [30, inf). In particolare, bucketCount <= 1 è una specifica non valida.

Rappresentazione JSON 
{
  "bucketStart": {
    object (FacetValue)
  },
  "bucketGranularity": {
    object (FacetValue)
  },
  "bucketCount": integer
}
Campi
bucketStart

object (FacetValue)

Limite inferiore del bucket. NOTA: per questo campo è attualmente supportato solo il tipo di numero intero.
bucketGranularity

object (FacetValue)

Granularità del bucket. NOTA: per questo campo è attualmente supportato solo il tipo di numero intero.
bucketCount

integer

Il numero totale di bucket.

FacetValue

Definizione di un singolo valore con tipo generico.

Rappresentazione JSON 
{

  // Union field value can be only one of the following:
  "stringValue": string,
  "integerValue": string,
  "datetimeValue": {
    object (DateTime)
  }
  // End of list of possible types for union field value.
}
Campi

Campo unione value.

value può essere solo uno dei seguenti:
stringValue

string

Valore del tipo di stringa.
integerValue

string (int64 format)

Valore di tipo intero.
datetimeValue

object (DateTime)

Valore del tipo DateTime.

CustomRangeBucketSpec

Se il tipo di bucket è CUSTOM_RANGE, specifica la modalità di suddivisione dei valori nei bucket. Utilizza il valore del bucket intero come esempio: quando gli endpoint sono 0, 10, 100 e 1000, genereremo i seguenti facet: [-inf, 0), [0, 10), [10, 100), [100, 1000), [1000, inf). In particolare: - gli endpoint devono essere elencati in ordine crescente. In caso contrario, l'API SearchConfig rifiuterà la configurazione delle sfaccettature. - < 1 endpoint è una specifica non valida.

Rappresentazione JSON 
{
  "endpoints": [
    {
      object (FacetValue)
    }
  ]
}
Campi
endpoints[]

object (FacetValue)

Al momento, per questo campo è supportato solo il tipo di numero intero.

DateTimeBucketSpec

Se il tipo di bucket è DATA, specifica la modalità di suddivisione dei valori data nei bucket.

Rappresentazione JSON 
{
  "granularity": enum (Granularity)
}
Campi
granularity

enum (Granularity)

Granularità del livello del tipo di data.

Granularità

Enum di granularità per il bucket data e ora.

Enum
GRANULARITY_UNSPECIFIED Granularità non specificata.
YEAR La granularità è anno.
MONTH La granularità è mensile.
DAY La granularità è giornaliera.

FacetBucketType

Tipi diversi per un bucket di aspetti.

Enum
FACET_BUCKET_TYPE_UNSPECIFIED Tipo non specificato.
FACET_BUCKET_TYPE_VALUE Tipo di valore.
FACET_BUCKET_TYPE_DATETIME Tipo data/ora.
FACET_BUCKET_TYPE_FIXED_RANGE Tipo di intervallo fisso.
FACET_BUCKET_TYPE_CUSTOM_RANGE Tipo di intervallo personalizzato.

SearchCriteriaProperty

Configurazione centralizzata per i criteri di ricerca personalizzati.

Rappresentazione JSON 
{
  "mappedFields": [
    string
  ]
}
Campi
mappedFields[]

string

Ogni mapped_field corrisponde a una chiave UGA. Per capire come funziona questa proprietà, prendi in considerazione il seguente esempio. Nella tabella SearchConfig, l'utente aggiunge questa voce: searchConfig { name: "person" searchCriteriaProperty { mappedFields: "player" mappedFields: "coach" } }

Ora, quando un utente invia una query come: criteria { field: "person" textArray { txtValues: "Tom Brady" txtValues: "Bill Belichick" } }

La ricerca MWH restituirà i documenti di ricerca in cui (player=Tom Brady || coach=Tom Brady || player=Bill Belichick || coach=Bill Belichick).

Metodi

create

 Crea una configurazione di ricerca all'interno di un corpus.

delete

 Consente di eliminare una configurazione di ricerca all'interno di un corpus.

get

 Recupera una configurazione di ricerca all'interno di un corpus.

list

 Elenca tutte le configurazioni di ricerca all'interno di un corpus.

patch

 Aggiorna una configurazione di ricerca all'interno di un corpus.