Package types (0.1.2)

API documentation for developer_knowledge_v1.types package.

Classes

Answer

An answer to a query.

AnswerQueryRequest

Request message for DeveloperKnowledge.AnswerQuery][google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery].

AnswerQueryResponse

Response message for DeveloperKnowledge.AnswerQuery][google.developers.knowledge.v1.DeveloperKnowledge.AnswerQuery].

BatchGetDocumentsRequest

Request message for DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments].

BatchGetDocumentsResponse

Response message for DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments].

Document

A Document represents a page of documentation in the Developer Knowledge corpus, like the page at https://docs.cloud.google.com/storage/docs/creating-buckets.

DocumentChunk

A DocumentChunk represents a piece of content from a Document][google.developers.knowledge.v1.Document] in the DeveloperKnowledge corpus. To fetch the entire document content, pass the parent to DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument] or DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments].

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DocumentView

Specifies which fields of the Document][google.developers.knowledge.v1.Document] are included.

    - `name`
    - `uri`
    - `data_source`
    - `title`
    - `description`
    - `update_time`
    - `view`
    - `content_length_bytes`

    This is the default of view for
    `DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]`.
DOCUMENT_VIEW_FULL (2):
    Includes all
    `Document][google.developers.knowledge.v1.Document]` fields.
DOCUMENT_VIEW_CONTENT (3):
    Includes the `DOCUMENT_VIEW_BASIC` fields and the
    `content` field.

    This is the default of view for
    `DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]`
    and
    `DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]`.

GetDocumentRequest

Request message for DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument].

SearchDocumentChunksRequest

Request message for DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks].

SearchDocumentChunksResponse

Response message for DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks].