0.1.2 (latest) 0.1.1 Summary of entries of Classes for google-developer-knowledge.

## Classes

### [DeveloperKnowledgeAsyncClient](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient)

The Developer Knowledge API provides programmatic access to Google's
public developer documentation, enabling you to integrate this
knowledge base into your own applications and workflows.

The API is designed to be the canonical source for machine-readable
access to Google's developer documentation.

A typical use case is to first use
`DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]`
to find relevant page URIs based on a query, and then use
`DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]`
or
`DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]`
to fetch the full content of the top results.

All document content is provided in Markdown format.

### [DeveloperKnowledgeClient](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient)

The Developer Knowledge API provides programmatic access to Google's
public developer documentation, enabling you to integrate this
knowledge base into your own applications and workflows.

The API is designed to be the canonical source for machine-readable
access to Google's developer documentation.

A typical use case is to first use
`DeveloperKnowledge.SearchDocumentChunks][google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunks]`
to find relevant page URIs based on a query, and then use
`DeveloperKnowledge.GetDocument][google.developers.knowledge.v1.DeveloperKnowledge.GetDocument]`
or
`DeveloperKnowledge.BatchGetDocuments][google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocuments]`
to fetch the full content of the top results.

All document content is provided in Markdown format.

### [SearchDocumentChunksAsyncPager](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksAsyncPager)

A pager for iterating through `search_document_chunks` requests.

This class thinly wraps an initial
`<xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref>` object, and
provides an `__aiter__` method to iterate through its
`results` field.

If there are more pages, the `__aiter__` method will make additional
`SearchDocumentChunks` requests and continue to iterate
through the `results` field on the
corresponding responses.

All the usual `<xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref>`
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [SearchDocumentChunksPager](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksPager)

A pager for iterating through `search_document_chunks` requests.

This class thinly wraps an initial
`<xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref>` object, and
provides an `__iter__` method to iterate through its
`results` field.

If there are more pages, the `__iter__` method will make additional
`SearchDocumentChunks` requests and continue to iterate
through the `results` field on the
corresponding responses.

All the usual `<xref uid="google.developer_knowledge_v1.types.SearchDocumentChunksResponse">google.developer_knowledge_v1.types.SearchDocumentChunksResponse</xref>`
attributes are available on the pager. If multiple requests are made, only
the most recent response is retained, and thus used for attribute lookup.

### [Answer](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.Answer)

An answer to a query.

### [AnswerCitation](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.Answer.AnswerCitation)

Citation info for a segment.

### [AnswerReference](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.Answer.AnswerReference)

Represents a reference to a source.

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

### [CitationSource](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.Answer.CitationSource)

Citation source.

### [DocumentReference](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.Answer.DocumentReference)

Represents a reference to a document.

### [AnswerQueryRequest](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.AnswerQueryRequest)

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

### [AnswerQueryResponse](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.AnswerQueryResponse)

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

### [BatchGetDocumentsRequest](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.BatchGetDocumentsRequest)

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

### [BatchGetDocumentsResponse](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.BatchGetDocumentsResponse)

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

### [Document](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.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](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.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](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.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](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.GetDocumentRequest)

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

### [SearchDocumentChunksRequest](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.SearchDocumentChunksRequest)

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

### [SearchDocumentChunksResponse](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.types.SearchDocumentChunksResponse)

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

## Modules

### [pagers](https://developers.google.com/python/docs/reference/google-developer-knowledge/latest/google.developer_knowledge_v1.services.developer_knowledge.pagers)

API documentation for `developer_knowledge_v1.services.developer_knowledge.pagers` module.