Console
    Contact Us Start free

    Google Cloud Ai Platform V1 Client - Class GenerationConfig (1.30.0)

    Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class GenerationConfig.

    Generation config.

    Generated from protobuf message google.cloud.aiplatform.v1.GenerationConfig

    Namespace

    Google \ Cloud \ AIPlatform \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ temperature
    float

    Optional. Controls the randomness of predictions.

    ↳ top_p
    float

    Optional. If specified, nucleus sampling will be used.

    ↳ top_k
    float

    Optional. If specified, top-k sampling will be used.

    ↳ candidate_count
    int

    Optional. Number of candidates to generate.

    ↳ max_output_tokens
    int

    Optional. The maximum number of output tokens to generate per message.

    ↳ stop_sequences
    array

    Optional. Stop sequences.

    ↳ response_logprobs
    bool

    Optional. If true, export the logprobs results in response.

    ↳ logprobs
    int

    Optional. Logit probabilities.

    ↳ presence_penalty
    float

    Optional. Positive penalties.

    ↳ frequency_penalty
    float

    Optional. Frequency penalties.

    ↳ seed
    int

    Optional. Seed.

    ↳ response_mime_type
    string

    Optional. Output response mimetype of the generated candidate text. Supported mimetype: - text/plain : (default) Text output. - application/json : JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.

    ↳ response_schema
    Schema

    Optional. The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an OpenAPI 3.0 schema object . If set, a compatible response_mime_type must also be set. Compatible mimetypes: application/json : Schema for JSON response.

    ↳ response_json_schema
    Google\Protobuf\Value

    Optional. Output schema of the generated response. This is an alternative to response_schema that accepts JSON Schema . If set, response_schema must be omitted, but response_mime_type is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported: - $id - $defs - $ref - $anchor - type - format - title - description - enum (for strings and numbers) - items - prefixItems - minItems - maxItems - minimum - maximum - anyOf - oneOf (interpreted the same as anyOf ) - properties - additionalProperties - required The non-standard propertyOrdering property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $ , may be set.

    ↳ routing_config
    GenerationConfig\RoutingConfig

    Optional. Routing configuration.

    ↳ thinking_config
    GenerationConfig\ThinkingConfig

    Optional. Config for thinking features. An error will be returned if this field is set for models that don't support thinking.

    getTemperature

    Optional. Controls the randomness of predictions.

    Returns
    Type
    Description
    float

    hasTemperature

    clearTemperature

    setTemperature

    Optional. Controls the randomness of predictions.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getTopP

    Optional. If specified, nucleus sampling will be used.

    Returns
    Type
    Description
    float

    hasTopP

    clearTopP

    setTopP

    Optional. If specified, nucleus sampling will be used.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getTopK

    Optional. If specified, top-k sampling will be used.

    Returns
    Type
    Description
    float

    hasTopK

    clearTopK

    setTopK

    Optional. If specified, top-k sampling will be used.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getCandidateCount

    Optional. Number of candidates to generate.

    Returns
    Type
    Description
    int

    hasCandidateCount

    clearCandidateCount

    setCandidateCount

    Optional. Number of candidates to generate.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getMaxOutputTokens

    Optional. The maximum number of output tokens to generate per message.

    Returns
    Type
    Description
    int

    hasMaxOutputTokens

    clearMaxOutputTokens

    setMaxOutputTokens

    Optional. The maximum number of output tokens to generate per message.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getStopSequences

    Optional. Stop sequences.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setStopSequences

    Optional. Stop sequences.

    Parameter
    Name
    Description
    var
    string[]
    Returns
    Type
    Description
    $this

    getResponseLogprobs

    Optional. If true, export the logprobs results in response.

    Returns
    Type
    Description
    bool

    hasResponseLogprobs

    clearResponseLogprobs

    setResponseLogprobs

    Optional. If true, export the logprobs results in response.

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getLogprobs

    Optional. Logit probabilities.

    Returns
    Type
    Description
    int

    hasLogprobs

    clearLogprobs

    setLogprobs

    Optional. Logit probabilities.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getPresencePenalty

    Optional. Positive penalties.

    Returns
    Type
    Description
    float

    hasPresencePenalty

    clearPresencePenalty

    setPresencePenalty

    Optional. Positive penalties.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getFrequencyPenalty

    Optional. Frequency penalties.

    Returns
    Type
    Description
    float

    hasFrequencyPenalty

    clearFrequencyPenalty

    setFrequencyPenalty

    Optional. Frequency penalties.

    Parameter
    Name
    Description
    var
    float
    Returns
    Type
    Description
    $this

    getSeed

    Optional. Seed.

    Returns
    Type
    Description
    int

    hasSeed

    clearSeed

    setSeed

    Optional. Seed.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getResponseMimeType

    Optional. Output response mimetype of the generated candidate text.

    Supported mimetype:

    • text/plain : (default) Text output.
    • application/json : JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
    Returns
    Type
    Description
    string

    setResponseMimeType

    Optional. Output response mimetype of the generated candidate text.

    Supported mimetype:

    • text/plain : (default) Text output.
    • application/json : JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getResponseSchema

    Optional. The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays.

    Represents a select subset of an OpenAPI 3.0 schema object . If set, a compatible response_mime_type must also be set. Compatible mimetypes: application/json : Schema for JSON response.

    Returns
    Type
    Description
    Schema |null

    hasResponseSchema

    clearResponseSchema

    setResponseSchema

    Optional. The Schema object allows the definition of input and output data types. These types can be objects, but also primitives and arrays.

    Represents a select subset of an OpenAPI 3.0 schema object . If set, a compatible response_mime_type must also be set. Compatible mimetypes: application/json : Schema for JSON response.

    Parameter
    Name
    Description
    var
    Schema
    Returns
    Type
    Description
    $this

    getResponseJsonSchema

    Optional. Output schema of the generated response. This is an alternative to response_schema that accepts JSON Schema .

    If set, response_schema must be omitted, but response_mime_type is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:

    • $id
    • $defs
    • $ref
    • $anchor
    • type
    • format
    • title
    • description
    • enum (for strings and numbers)
    • items
    • prefixItems
    • minItems
    • maxItems
    • minimum
    • maximum
    • anyOf
    • oneOf (interpreted the same as anyOf )
    • properties
    • additionalProperties
    • required The non-standard propertyOrdering property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $ , may be set.
    Returns
    Type
    Description
    Google\Protobuf\Value |null

    hasResponseJsonSchema

    clearResponseJsonSchema

    setResponseJsonSchema

    Optional. Output schema of the generated response. This is an alternative to response_schema that accepts JSON Schema .

    If set, response_schema must be omitted, but response_mime_type is required. While the full JSON Schema may be sent, not all features are supported. Specifically, only the following properties are supported:

    • $id
    • $defs
    • $ref
    • $anchor
    • type
    • format
    • title
    • description
    • enum (for strings and numbers)
    • items
    • prefixItems
    • minItems
    • maxItems
    • minimum
    • maximum
    • anyOf
    • oneOf (interpreted the same as anyOf )
    • properties
    • additionalProperties
    • required The non-standard propertyOrdering property may also be set. Cyclic references are unrolled to a limited degree and, as such, may only be used within non-required properties. (Nullable properties are not sufficient.) If $ref is set on a sub-schema, no other properties, except for than those starting as a $ , may be set.
    Parameter
    Name
    Description
    var
    Google\Protobuf\Value
    Returns
    Type
    Description
    $this

    getRoutingConfig

    Optional. Routing configuration.

    Returns
    Type
    Description
    GenerationConfig\RoutingConfig |null

    hasRoutingConfig

    clearRoutingConfig

    setRoutingConfig

    Optional. Routing configuration.

    Parameter
    Name
    Description
    var
    GenerationConfig\RoutingConfig
    Returns
    Type
    Description
    $this

    getThinkingConfig

    Optional. Config for thinking features.

    An error will be returned if this field is set for models that don't support thinking.

    Returns
    Type
    Description
    GenerationConfig\ThinkingConfig |null

    hasThinkingConfig

    clearThinkingConfig

    setThinkingConfig

    Optional. Config for thinking features.

    An error will be returned if this field is set for models that don't support thinking.

    Parameter
    Name
    Description
    var
    GenerationConfig\ThinkingConfig
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: