Skip to content

Commit

Permalink
Updating README per ask from Product (#81)
Browse files Browse the repository at this point in the history
Updating a few small nits that occurred from the autogen. Knowledge-id --> Knowledge-base-id, adding some examples, and adding additional optional arguments to the Document Management section
  • Loading branch information
czahedi authored and nnegrey committed Jul 23, 2018
1 parent 66904db commit 2b3bc00
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions packages/google-cloud-dialogflow/samples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -205,14 +205,14 @@ To run this sample:
usage: detect_intent_knowledge.py [-h] --project-id PROJECT_ID
[--session-id SESSION_ID]
[--language-code LANGUAGE_CODE]
--knowledge-id KNOWLEDGE_ID
--knowledge-base-id KNOWLEDGE_ID
texts [texts ...]
Dialogflow API Detect Intent Python sample with text inputs.
Examples:
python detect_intent_knowledge.py -h
python detect_intent_knowledge.py --project-id PROJECT_ID --session-id SESSION_ID --knowledge-id KNOWLEDGE_ID "hello" "how do I reset my password?"
python detect_intent_knowledge.py --project-id PROJECT_ID --session-id SESSION_ID --knowledge-base-id KNOWLEDGE_ID "hello" "how do I reset my password?"
positional arguments:
texts Text inputs.
Expand All @@ -226,8 +226,8 @@ To run this sample:
UUID.
--language-code LANGUAGE_CODE
Language code of the query. Defaults to "en-US".
--knowledge-id KNOWLEDGE_ID
The id of the Knowledge Base to query against
--knowledge-base-id KNOWLEDGE_ID
The id of the Knowledge Base to query against, e.g., OTE5NjYzMTkxNDA2NzI2MzQ4OA
Expand Down Expand Up @@ -588,7 +588,7 @@ To run this sample:
{list,create,get,delete}
list List all Documents that belong to a certain Knowledge
base.
create Create a Document for a certain Knowledge base.
create Create a Document for a certain Knowledge base. Please note that it will be initially disabled until you enable it.
get Get a Document by its id and the Knowledge base id.
delete Delete a Document by its id and the Knowledge baseid.
Expand All @@ -598,7 +598,17 @@ To run this sample:
Project id. Required.
--knowledge-base-id KNOWLEDGE_BASE_ID
The id of the Knowledge Base that the Document belongs
to
to, e.g., OTE5NjYzMTkxNDA2NzI2MzQ4OA
--mime_type The mime_type of the Document. e.g. text/csv, text/html,
text/plain, text/pdf etc.
--knowledge_type The Knowledge type of the Document. e.g. FAQ, EXTRACTIVE_QA.
--content_uri Uri of the document, e.g. gs://path/mydoc.csv,
http://mypage.com/faq.html.
Expand All @@ -619,4 +629,4 @@ to `browse the source`_ and `report issues`_.
https://github.com/GoogleCloudPlatform/google-cloud-python/issues
.. _Google Cloud SDK: https://cloud.google.com/sdk/
.. _Google Cloud SDK: https://cloud.google.com/sdk/

0 comments on commit 2b3bc00

Please sign in to comment.