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: resource projects.agent.knowledgeBases.documents
is deprecated,
please use projects.knowledgeBases.documents
instead.
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
2086 2087 2088 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2086 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
2042 2043 2044 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2042 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
2053 2054 2055 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2053 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
2059 2060 2061 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2059 def display_name @display_name end |
#knowledge_types ⇒ Array<String>
Required. The knowledge type of document content.
Corresponds to the JSON property knowledgeTypes
2064 2065 2066 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2064 def knowledge_types @knowledge_types end |
#mime_type ⇒ String
Required. The MIME type of this document.
Corresponds to the JSON property mimeType
2069 2070 2071 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2069 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
2077 2078 2079 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2077 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.
2084 2085 2086 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2084 def raw_content @raw_content end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2091 2092 2093 2094 2095 2096 2097 2098 2099 |
# File 'generated/google/apis/dialogflow_v2beta1/classes.rb', line 2091 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 |