Class ProjectsResource.KnowledgeBasesResource.DocumentsResource

The "documents" collection of methods.

Inheritance

object

ProjectsResource.KnowledgeBasesResource.DocumentsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dialogflow.v2

Assembly: Google.Apis.Dialogflow.v2.dll

Syntax

public class ProjectsResource.KnowledgeBasesResource.DocumentsResource

Constructors

DocumentsResource(IClientService)

Constructs a new resource.

Declaration

public DocumentsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

Create(GoogleCloudDialogflowV2Document, string)

Creates a new document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata

response: Document

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.CreateRequest Create(GoogleCloudDialogflowV2Document body, string parent)

Parameters

Type	Name	Description
GoogleCloudDialogflowV2Document	body	The body of the request.
string	parent	Required. The knowledge base to create a document for. Format: `projects//locations//knowledgeBases/`.

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.CreateRequest

Delete(string)

Deletes the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata

response: An Empty message

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the document to delete. Format: `projects//locations//knowledgeBases//documents/`.

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.DeleteRequest

Export(GoogleCloudDialogflowV2ExportDocumentRequest, string)

Exports a smart messaging candidate document into the specified destination. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.ExportRequest Export(GoogleCloudDialogflowV2ExportDocumentRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudDialogflowV2ExportDocumentRequest	body	The body of the request.
string	name	Required. The name of the document to export. Format: `projects//locations//knowledgeBases//documents/`.

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.ExportRequest

Get(string)

Retrieves the specified document.

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the document to retrieve. Format `projects//locations//knowledgeBases//documents/`.

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.GetRequest

Import(GoogleCloudDialogflowV2ImportDocumentsRequest, string)

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: ImportDocumentsResponse

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.ImportRequest Import(GoogleCloudDialogflowV2ImportDocumentsRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudDialogflowV2ImportDocumentsRequest	body	The body of the request.
string	parent	Required. The knowledge base to import documents into. Format: `projects//locations//knowledgeBases/`.

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.ImportRequest

List(string)

Returns the list of all documents of the knowledge base.

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The knowledge base to list all documents for. Format: `projects//locations//knowledgeBases/`.

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.ListRequest

Patch(GoogleCloudDialogflowV2Document, string)

Updates the specified document. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata

response: Document

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.PatchRequest Patch(GoogleCloudDialogflowV2Document body, string name)

Parameters

Type	Name	Description
GoogleCloudDialogflowV2Document	body	The body of the request.
string	name	Optional. The document resource name. The name must be empty when creating a document. Format: `projects//locations//knowledgeBases//documents/`.

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.PatchRequest

Reload(GoogleCloudDialogflowV2ReloadDocumentRequest, string)

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes. This method is a long-running operation. The returned Operation type has the following method-specific fields: - metadata: KnowledgeOperationMetadata - response: Document Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

Declaration

public virtual ProjectsResource.KnowledgeBasesResource.DocumentsResource.ReloadRequest Reload(GoogleCloudDialogflowV2ReloadDocumentRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudDialogflowV2ReloadDocumentRequest	body	The body of the request.
string	name	Required. The name of the document to reload. Format: `projects//locations//knowledgeBases//documents/`

Returns

Type	Description
ProjectsResource.KnowledgeBasesResource.DocumentsResource.ReloadRequest