Method: projects.locations.knowledgeBases.documents.create

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

HTTP request

POST https://{endpoint}/v2beta1/{parent=projects/*/locations/*/knowledgeBases/*}/documents

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The knowledge base to create a document for. Format: projects/<Project ID>/locations/<Location ID>/knowledgeBases/<Knowledge Base ID>.

Authorization requires the following IAM permission on the specified resource parent:

  • dialogflow.documents.create

Query parameters

Parameters
importGcsCustomMetadata

boolean

Whether to import custom metadata from Google Cloud Storage. Only valid when the document source is Google Cloud Storage URI.

Request body

The request body contains an instance of Document.

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.