Reference documentation and code samples for the Vector Search V1 API class Google::Cloud::VectorSearch::V1::OutputFields.
Defines an output fields struct for data in DataObject.
Output fields are opt-in. A search or query result contains only the data
object name and ID, plus the fields listed here. If this message is unset or
a list is empty, the corresponding part of the data object (data,
vectors or metadata) is omitted from the result; it is not an indication
that the stored data object is empty. Use "*" in a list to return all
fields of that kind.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#data_fields
def data_fields() -> ::Array<::String>-
(::Array<::String>) — Optional. The fields from the data fields to include in the output. Use
"*"to include all data fields. If empty,datais omitted from results.
#data_fields=
def data_fields=(value) -> ::Array<::String>-
value (::Array<::String>) — Optional. The fields from the data fields to include in the output. Use
"*"to include all data fields. If empty,datais omitted from results.
-
(::Array<::String>) — Optional. The fields from the data fields to include in the output. Use
"*"to include all data fields. If empty,datais omitted from results.
#metadata_fields
def metadata_fields() -> ::Array<::String>-
(::Array<::String>) — Optional. The DataObject metadata fields to include in the output:
create_time,update_timeandetag. Use"*"to include all metadata fields. If empty, these fields are omitted from results.
#metadata_fields=
def metadata_fields=(value) -> ::Array<::String>-
value (::Array<::String>) — Optional. The DataObject metadata fields to include in the output:
create_time,update_timeandetag. Use"*"to include all metadata fields. If empty, these fields are omitted from results.
-
(::Array<::String>) — Optional. The DataObject metadata fields to include in the output:
create_time,update_timeandetag. Use"*"to include all metadata fields. If empty, these fields are omitted from results.
#vector_fields
def vector_fields() -> ::Array<::String>-
(::Array<::String>) — Optional. The fields from the vector fields to include in the output. Use
"*"to include all vector fields. If empty,vectorsis omitted from results.
#vector_fields=
def vector_fields=(value) -> ::Array<::String>-
value (::Array<::String>) — Optional. The fields from the vector fields to include in the output. Use
"*"to include all vector fields. If empty,vectorsis omitted from results.
-
(::Array<::String>) — Optional. The fields from the vector fields to include in the output. Use
"*"to include all vector fields. If empty,vectorsis omitted from results.