REST Resource: projects.locations.collections.dataStores.branches.documents

Risorsa: documento

Il documento acquisisce tutte le informazioni sui metadati non elaborati degli elementi da consigliare o cercare.

Rappresentazione JSON 
{
  "name": string,
  "id": string,
  "schemaId": string,
  "content": {
    object (Content)
  },
  "parentDocumentId": string,
  "derivedStructData": {
    object
  },
  "aclInfo": {
    object (AclInfo)
  },
  "indexTime": string,
  "indexStatus": {
    object (IndexStatus)
  },

  // Union field data can be only one of the following:
  "structData": {
    object
  },
  "jsonData": string
  // End of list of possible types for union field data.
}
Campi
name

string

Immutabile. Il nome completo della risorsa del documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
id

string

Immutabile. L'identificatore del documento.

L'ID deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 128 caratteri.
schemaId

string

L'identificatore dello schema che si trova nello stesso datastore.
content

object (Content)

I dati non strutturati collegati a questo documento. I contenuti possono essere impostati e devono essere impostati se questo documento si trova in un datastore CONTENT_REQUIRED.
parentDocumentId

string

L'identificatore del documento principale. Al momento supporta al massimo una gerarchia di documenti a due livelli.

L'ID deve essere conforme allo standard RFC-1034 con un limite di lunghezza di 63 caratteri.
derivedStructData

object (Struct format)

Solo output. Questo campo è OUTPUT_ONLY. Contiene dati derivati che non sono presenti nel documento di input originale.
aclInfo

object (AclInfo)

Informazioni sul controllo dell'accesso per il documento.
indexTime

string (Timestamp format)

Solo output. L'ultima volta che il documento è stato indicizzato. Se questo campo è impostato, il documento potrebbe essere restituito nei risultati di ricerca.

Questo campo è OUTPUT_ONLY. Se questo campo non è compilato, significa che il documento non è mai stato indicizzato.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
indexStatus

object (IndexStatus)

Solo output. Lo stato di indicizzazione del documento.

  • Se il documento viene indicizzato correttamente, il campo indexTime viene compilato.
  • In caso contrario, se il documento non viene indicizzato a causa di errori, viene compilato il campo errorSamples.
  • In caso contrario, se l'indicizzazione del documento è in corso, il campo pendingMessage viene compilato.
Campo unione data. Rappresentazione dei dati. È necessario fornire struct_data o json_data, altrimenti viene generato un errore INVALID_ARGUMENT. data può essere solo uno dei seguenti:
structData

object (Struct format)

I dati JSON strutturati per il documento. Deve essere conforme a Schema registrato o viene generato un errore INVALID_ARGUMENT.
jsonData

string

Rappresentazione della stringa JSON del documento. Deve essere conforme a Schema registrato o viene generato un errore INVALID_ARGUMENT.

Contenuti

Dati non strutturati collegati a questo documento.

Rappresentazione JSON 
{
  "mimeType": string,

  // Union field content can be only one of the following:
  "rawBytes": string,
  "uri": string
  // End of list of possible types for union field content.
}
Campi
mimeType

string

Il tipo MIME dei contenuti. Tipi supportati:

  • application/pdf (PDF, per ora sono supportati solo i PDF nativi)
  • text/html (HTML)
  • text/plain (TXT)
  • application/xml o text/xml (XML)
  • application/json (JSON)
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)
  • application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX)
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX)
  • application/vnd.ms-excel.sheet.macroenabled.12 (XLSM)

I seguenti tipi sono supportati solo se l'analisi del layout è attivata nel datastore:

  • image/bmp (BMP)
  • image/gif (GIF)
  • image/jpeg (JPEG)
  • image/png (PNG)
  • image/tiff (TIFF)

Consulta https://www.iana.org/assignments/media-types/media-types.xhtml.
Campo unione content. I contenuti del documento non strutturato. content può essere solo uno dei seguenti:
rawBytes

string (bytes format)

I contenuti rappresentati come un flusso di byte. La lunghezza massima è di 1.000.000 di byte (1 MB / circa 0,95 MiB).

Nota: come per tutti i campi bytes, questo campo è rappresentato come binario puro in Protocol Buffers e come stringa con codifica Base64 in JSON. Ad esempio, abc123!?$*&()'-=@~ deve essere rappresentato come YWJjMTIzIT8kKiYoKSctPUB+ in JSON. Consulta la pagina https://developers.google.com/protocol-buffers/docs/proto3#json.

Una stringa con codifica Base64.
uri

string

L'URI dei contenuti. Sono supportati solo gli URI Cloud Storage (ad es. gs://bucket-name/path/to/file). La dimensione massima del file è 2, 5 MB per i formati basati su testo e 200 MB per gli altri formati.

AclInfo

Informazioni sull'ACL del documento.

Rappresentazione JSON 
{
  "readers": [
    {
      object (AccessRestriction)
    }
  ]
}
Campi
readers[]

object (AccessRestriction)

Lettori del documento.

AccessRestriction

AclRestriction per modellare restrizioni di ereditarietà complesse.

Esempio: modellazione di un'ereditarietà "Entrambe le autorizzazioni", in cui per accedere a un documento secondario, l'utente deve avere accesso al documento principale.

Gerarchia del documento: Space_S --> Page_P.

Lettori: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2

Space_S ACL Restriction - { "aclInfo": { "readers": [ { "principals": [ { "groupId": "group_1" }, { "userId": "user_1" } ] } ] } }

Limitazione ACL Page_P. { "aclInfo": { "readers": [ { "principals": [ { "groupId": "group_2" }, { "groupId": "group_3" }, { "userId": "user_2" } ], }, { "principals": [ { "groupId": "group_1" }, { "userId": "user_1" } ], } ] } }

Rappresentazione JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ],
  "idpWide": boolean
}
Campi
principals[]

object (Principal)

Elenco delle entità.
idpWide

boolean

Tutti gli utenti all'interno del provider di identità.

Entità

Identificatore dell'entità di un utente o di un gruppo.

Rappresentazione JSON 
{

  // Union field principal can be only one of the following:
  "userId": string,
  "groupId": string,
  "externalEntityId": string
  // End of list of possible types for union field principal.
}
Campi
Campo unione principal. Il campo di unione principale. L'entità può essere un utente o un gruppo. principal può essere solo uno dei seguenti:
userId

string

Identificatore utente. Per l'account utente Google Workspace, userId deve essere l'email dell'utente Google Workspace. Per l'account utente del provider di identità non Google, userId è l'identificatore utente mappato configurato durante la configurazione di workforcepool.
groupId

string

Identificatore del gruppo. Per l'account utente Google Workspace, groupId deve essere l'email del gruppo Google Workspace. Per l'account utente del provider di identità non Google, groupId è l'identificatore del gruppo mappato configurato durante la configurazione di workforcepool.
externalEntityId

string

Per le identità delle applicazioni di terze parti che non sono presenti nel provider di identità del cliente.

IndexStatus

Stato dell'indicizzazione del documento.

Rappresentazione JSON 
{
  "indexTime": string,
  "errorSamples": [
    {
      object (Status)
    }
  ],
  "pendingMessage": string
}
Campi
indexTime

string (Timestamp format)

L'ora in cui è stato indicizzato il documento. Se questo campo è compilato, significa che il documento è stato indicizzato.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
errorSamples[]

object (Status)

Un campione degli errori riscontrati durante l'indicizzazione del documento. Se questo campo è compilato, il documento non viene indicizzato a causa di errori.
pendingMessage

string

Immutabile. Il messaggio indica che l'indicizzazione del documento è in corso. Se questo campo è compilato, l'indice del documento è in attesa.

Metodi

create

 Crea un Document.

delete

 Elimina un Document.

get

 Riceve un Document.

import

 Importazione collettiva di più Document.

list

 Recupera un elenco di Document.

patch

 Aggiorna un Document.

purge

 Elimina definitivamente tutti i Document selezionati in un ramo.