Class: Google::Cloud::AIPlatform::V1::OutputFieldSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/data_foundry_service.rb

Overview

Defines a specification for a single output field.

Defined Under Namespace

Modules: FieldType

Instance Attribute Summary collapse

Instance Attribute Details

#field_name ⇒ ::String

Returns Required. The name of the output field.

Returns:

  • (::String) —

    Required. The name of the output field.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/data_foundry_service.rb', line 84

class OutputFieldSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type of the field.
  module FieldType
    # Field type is unspecified.
    FIELD_TYPE_UNSPECIFIED = 0

    # Arbitrary content field type.
    CONTENT = 1

    # Text field type.
    TEXT = 2

    # Image field type.
    IMAGE = 3

    # Audio field type.
    AUDIO = 4
  end
end

#field_type ⇒ ::Google::Cloud::AIPlatform::V1::OutputFieldSpec::FieldType

Returns Optional. The data type of the field. Defaults to CONTENT if not set.

Returns:



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/data_foundry_service.rb', line 84

class OutputFieldSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type of the field.
  module FieldType
    # Field type is unspecified.
    FIELD_TYPE_UNSPECIFIED = 0

    # Arbitrary content field type.
    CONTENT = 1

    # Text field type.
    TEXT = 2

    # Image field type.
    IMAGE = 3

    # Audio field type.
    AUDIO = 4
  end
end

#guidance ⇒ ::String

Returns Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

Returns:

  • (::String) —

    Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/aiplatform/v1/data_foundry_service.rb', line 84

class OutputFieldSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The data type of the field.
  module FieldType
    # Field type is unspecified.
    FIELD_TYPE_UNSPECIFIED = 0

    # Arbitrary content field type.
    CONTENT = 1

    # Text field type.
    TEXT = 2

    # Image field type.
    IMAGE = 3

    # Audio field type.
    AUDIO = 4
  end
end