documents

Overview

Name	documents
Type	Resource
Id	google.discoveryengine.documents

Fields

Name	Datatype	Description
id	string	Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
name	string	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	string	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	string	The identifier of the schema located in the same data store.
structData	object	The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
content	object	Unstructured data linked to this document.
derivedStructData	object	Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
jsonData	string	The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

Methods

Name	Accessible by	Required Params	Description
projects_locations_collections_data_stores_branches_documents_get	SELECT	branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId	Gets a Document.
projects_locations_collections_data_stores_branches_documents_list	SELECT	branchesId, collectionsId, dataStoresId, locationsId, projectsId	Gets a list of Documents.
projects_locations_data_stores_branches_documents_get	SELECT	branchesId, dataStoresId, documentsId, locationsId, projectsId	Gets a Document.
projects_locations_data_stores_branches_documents_list	SELECT	branchesId, dataStoresId, locationsId, projectsId	Gets a list of Documents.
projects_locations_collections_data_stores_branches_documents_create	INSERT	branchesId, collectionsId, dataStoresId, locationsId, projectsId	Creates a Document.
projects_locations_data_stores_branches_documents_create	INSERT	branchesId, dataStoresId, locationsId, projectsId	Creates a Document.
projects_locations_collections_data_stores_branches_documents_delete	DELETE	branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId	Deletes a Document.
projects_locations_data_stores_branches_documents_delete	DELETE	branchesId, dataStoresId, documentsId, locationsId, projectsId	Deletes a Document.
_projects_locations_collections_data_stores_branches_documents_list	EXEC	branchesId, collectionsId, dataStoresId, locationsId, projectsId	Gets a list of Documents.
_projects_locations_data_stores_branches_documents_list	EXEC	branchesId, dataStoresId, locationsId, projectsId	Gets a list of Documents.
projects_locations_collections_data_stores_branches_documents_import	EXEC	branchesId, collectionsId, dataStoresId, locationsId, projectsId	Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
projects_locations_collections_data_stores_branches_documents_patch	EXEC	branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId	Updates a Document.
projects_locations_collections_data_stores_branches_documents_purge	EXEC	branchesId, collectionsId, dataStoresId, locationsId, projectsId	Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.
projects_locations_data_stores_branches_documents_import	EXEC	branchesId, dataStoresId, locationsId, projectsId	Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated.
projects_locations_data_stores_branches_documents_patch	EXEC	branchesId, dataStoresId, documentsId, locationsId, projectsId	Updates a Document.
projects_locations_data_stores_branches_documents_purge	EXEC	branchesId, dataStoresId, locationsId, projectsId	Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false.