Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document
- Inherits:
-
Object
- Object
- Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dialogflow_v2beta1/classes.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb,
generated/google/apis/dialogflow_v2beta1/representations.rb
Overview
A document resource.
Note: The projects.agent.knowledgeBases.documents
resource is deprecated;
only use projects.knowledgeBases.documents
.
Instance Attribute Summary collapse
-
#content ⇒ String
The raw content of the document.
-
#content_uri ⇒ String
The URI where the file content is located.
-
#display_name ⇒ String
Required.
-
#knowledge_types ⇒ Array<String>
Required.
-
#mime_type ⇒ String
Required.
-
#name ⇒ String
The document resource name.
-
#raw_content ⇒ String
The raw content of the document.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Document
constructor
A new instance of GoogleCloudDialogflowV2beta1Document.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Document
Returns a new instance of GoogleCloudDialogflowV2beta1Document.
2784 2785 2786 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2784 def initialize(**args) update!(**args) end |
Instance Attribute Details
#content ⇒ String
The raw content of the document. This field is only permitted for
EXTRACTIVE_QA and FAQ knowledge types.
Note: This field is in the process of being deprecated, please use
raw_content instead.
Corresponds to the JSON property content
2740 2741 2742 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2740 def content @content end |
#content_uri ⇒ String
The URI where the file content is located.
For documents stored in Google Cloud Storage, these URIs must have
the form gs://<bucket-name>/<object-name>
.
NOTE: External URLs must correspond to public webpages, i.e., they must
be indexed by Google Search. In particular, URLs for showing documents in
Google Cloud Storage (i.e. the URL in your browser) are not supported.
Instead use the gs://
format URI described above.
Corresponds to the JSON property contentUri
2751 2752 2753 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2751 def content_uri @content_uri end |
#display_name ⇒ String
Required. The display name of the document. The name must be 1024 bytes or
less; otherwise, the creation request fails.
Corresponds to the JSON property displayName
2757 2758 2759 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2757 def display_name @display_name end |
#knowledge_types ⇒ Array<String>
Required. The knowledge type of document content.
Corresponds to the JSON property knowledgeTypes
2762 2763 2764 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2762 def knowledge_types @knowledge_types end |
#mime_type ⇒ String
Required. The MIME type of this document.
Corresponds to the JSON property mimeType
2767 2768 2769 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2767 def mime_type @mime_type end |
#name ⇒ String
The document resource name.
The name must be empty when creating a document.
Format: projects/<Project ID>/knowledgeBases/<Knowledge Base
ID>/documents/<Document ID>
.
Corresponds to the JSON property name
2775 2776 2777 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2775 def name @name end |
#raw_content ⇒ String
The raw content of the document. This field is only permitted for
EXTRACTIVE_QA and FAQ knowledge types.
Corresponds to the JSON property rawContent
NOTE: Values are automatically base64 encoded/decoded in the client library.
2782 2783 2784 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2782 def raw_content @raw_content end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2789 2790 2791 2792 2793 2794 2795 2796 2797 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2789 def update!(**args) @content = args[:content] if args.key?(:content) @content_uri = args[:content_uri] if args.key?(:content_uri) @display_name = args[:display_name] if args.key?(:display_name) @knowledge_types = args[:knowledge_types] if args.key?(:knowledge_types) @mime_type = args[:mime_type] if args.key?(:mime_type) @name = args[:name] if args.key?(:name) @raw_content = args[:raw_content] if args.key?(:raw_content) end |