Class GoogleCloudDiscoveryengineV1alphaServingConfig

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.

Inheritance

object

GoogleCloudDiscoveryengineV1alphaServingConfig

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data

Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll

Syntax

public class GoogleCloudDiscoveryengineV1alphaServingConfig : IDirectResponseSchema

Properties

BoostControlIds

Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.

Declaration

[JsonProperty("boostControlIds")]
public virtual IList<string> BoostControlIds { get; set; }

Property Value

Type	Description
IList<string>

CreateTime

object representation of CreateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }

Property Value

Type	Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

CreateTimeRaw

Output only. ServingConfig created timestamp.

Declaration

[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }

Property Value

Type	Description
string

CustomFineTuningSpec

Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here.

Declaration

[JsonProperty("customFineTuningSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec CustomFineTuningSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec

DisplayName

Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
string

DissociateControlIds

Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Declaration

[JsonProperty("dissociateControlIds")]
public virtual IList<string> DissociateControlIds { get; set; }

Property Value

Type	Description
IList<string>

DiversityLevel

How much diversity to use in recommendation model results e.g. medium-diversity or high-diversity. Currently supported values: * no-diversity * low-diversity * medium-diversity * high-diversity * auto-diversity If not specified, we choose default based on recommendation model type. Default value: no-diversity. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Declaration

[JsonProperty("diversityLevel")]
public virtual string DiversityLevel { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EmbeddingConfig

Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config.

Declaration

[JsonProperty("embeddingConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaEmbeddingConfig EmbeddingConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaEmbeddingConfig

FilterControlIds

Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.

Declaration

[JsonProperty("filterControlIds")]
public virtual IList<string> FilterControlIds { get; set; }

Property Value

Type	Description
IList<string>

GenericConfig

The GenericConfig of the serving configuration.

Declaration

[JsonProperty("genericConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig GenericConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig

GuidedSearchSpec

Guided search configs.

Declaration

[JsonProperty("guidedSearchSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec GuidedSearchSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec

IgnoreControlIds

Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.

Declaration

[JsonProperty("ignoreControlIds")]
public virtual IList<string> IgnoreControlIds { get; set; }

Property Value

Type	Description
IList<string>

MediaConfig

The MediaConfig of the serving configuration.

Declaration

[JsonProperty("mediaConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig MediaConfig { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig

ModelId

The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Declaration

[JsonProperty("modelId")]
public virtual string ModelId { get; set; }

Property Value

Type	Description
string

Name

Immutable. Fully qualified name projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

OnewaySynonymsControlIds

Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Declaration

[JsonProperty("onewaySynonymsControlIds")]
public virtual IList<string> OnewaySynonymsControlIds { get; set; }

Property Value

Type	Description
IList<string>

PersonalizationSpec

The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec.

Declaration

[JsonProperty("personalizationSpec")]
public virtual GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec PersonalizationSpec { get; set; }

Property Value

Type	Description
GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec

RankingExpression

The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * relevance_score: pre-defined keywords, used for measure relevance between query and document. * embedding_field_path: the document embedding field used with query embedding vector. * dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).

Declaration

[JsonProperty("rankingExpression")]
public virtual string RankingExpression { get; set; }

Property Value

Type	Description
string

RedirectControlIds

IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Declaration

[JsonProperty("redirectControlIds")]
public virtual IList<string> RedirectControlIds { get; set; }

Property Value

Type	Description
IList<string>

ReplacementControlIds

Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Declaration

[JsonProperty("replacementControlIds")]
public virtual IList<string> ReplacementControlIds { get; set; }

Property Value

Type	Description
IList<string>

SolutionType

Required. Immutable. Specifies the solution type that a serving config can be associated with.

Declaration

[JsonProperty("solutionType")]
public virtual string SolutionType { get; set; }

Property Value

Type	Description
string

SynonymsControlIds

Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.

Declaration

[JsonProperty("synonymsControlIds")]
public virtual IList<string> SynonymsControlIds { get; set; }

Property Value

Type	Description
IList<string>

UpdateTime

object representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }

Property Value

Type	Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

UpdateTimeRaw

Output only. ServingConfig updated timestamp.

Declaration

[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema