ai.z.openapi.service.document

Interface DocumentService

All Known Implementing Classes:

DocumentServiceImpl

public interface DocumentService

Document service interface

Method Summary

Modifier and Type	Method and Description
DocumentObjectResponse	createDocument(DocumentCreateParams request) Creates a new document.
DocumentEditResponse	deleteDocument(String documentId) Deletes a document.
QueryDocumentApiResponse	listDocuments(QueryDocumentRequest request) Lists documents.
DocumentEditResponse	modifyDocument(DocumentEditParams request) Modifies an existing document.
DocumentDataResponse	retrieveDocument(String documentId) Retrieves a specific document.

Method Detail

createDocument

DocumentObjectResponse createDocument(DocumentCreateParams request)

Creates a new document.

Parameters:

request - the document creation request

Returns:

DocumentDataResponse containing the creation result

modifyDocument

DocumentEditResponse modifyDocument(DocumentEditParams request)

Modifies an existing document.

Parameters:

request - the document modification request

Returns:

DocumentEditResponse containing the modification result

deleteDocument

DocumentEditResponse deleteDocument(String documentId)

Deletes a document.

Parameters:

documentId - the document ID to delete

Returns:

DocumentObjectResponse containing the deletion result

listDocuments

QueryDocumentApiResponse listDocuments(QueryDocumentRequest request)

Lists documents.

Parameters:

request - the query request

Returns:

QueryDocumentApiResponse containing the document list

retrieveDocument

DocumentDataResponse retrieveDocument(String documentId)

Retrieves a specific document.

Parameters:

documentId - the document ID to retrieve

Returns:

DocumentDataResponse containing the document details