View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaDocument (google_api_discovery_engine v0.27.0)

Document captures all raw metadata information of items to be recommended or searched.

Attributes

  • content (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaDocumentContent.t, default: nil) - The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
  • derivedStructData (type: map(), default: nil) - Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
  • id (type: String.t, default: nil) - Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
  • indexStatus (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaDocumentIndexStatus.t, default: nil) - Output only. The index status of the document. If document is indexed successfully, the index_time field is populated. Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset.
  • indexTime (type: DateTime.t, default: nil) - Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
  • jsonData (type: String.t, default: nil) - The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
  • name (type: String.t, default: nil) - Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
  • parentDocumentId (type: String.t, default: nil) - The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.
  • schemaId (type: String.t, default: nil) - The identifier of the schema located in the same data store.
  • structData (type: map(), default: nil) - The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaDocument{
    content:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaDocumentContent.t()
      | nil,
    derivedStructData: map() | nil,
    id: String.t() | nil,
    indexStatus:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaDocumentIndexStatus.t()
      | nil,
    indexTime: DateTime.t() | nil,
    jsonData: String.t() | nil,
    name: String.t() | nil,
    parentDocumentId: String.t() | nil,
    schemaId: String.t() | nil,
    structData: map() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.