Developer Knowledge API . documents

batchGet(names=None, view=None, x__xgafv=None)

Retrieves multiple documents, each with its full Markdown content.

Args:
  names: string, Required. Specifies the names of the documents to retrieve. A maximum of 20 documents can be retrieved in a batch. The documents are returned in the same order as the `names` in the request. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (repeated)
  view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.BatchGetDocuments defaults to `DOCUMENT_VIEW_CONTENT`.
    Allowed values
      DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified.
      DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.
      DOCUMENT_VIEW_FULL - Includes all Document fields.
      DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DeveloperKnowledge.BatchGetDocuments.
  "documents": [ # Contains the documents requested.
    { # A Document represents a piece of content from the Developer Knowledge corpus.
      "content": "A String", # Output only. Contains the full content of the document in Markdown format.
      "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com`
      "description": "A String", # Output only. Provides a description of the document.
      "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
      "title": "A String", # Output only. Provides the title of the document.
      "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated.
      "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.
      "view": "A String", # Output only. Specifies the DocumentView of the document.
    },
  ],
}

close()

Close httplib2 connections.

get(name, view=None, x__xgafv=None)

Retrieves a single document with its full Markdown content.

Args:
  name: string, Required. Specifies the name of the document to retrieve. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets` (required)
  view: string, Optional. Specifies the DocumentView of the document. If unspecified, DeveloperKnowledge.GetDocument defaults to `DOCUMENT_VIEW_CONTENT`.
    Allowed values
      DOCUMENT_VIEW_UNSPECIFIED - The default / unset value. See each API method for its default value if DocumentView is not specified.
      DOCUMENT_VIEW_BASIC - Includes only the basic metadata fields: - `name` - `uri` - `data_source` - `title` - `description` - `update_time` - `view` This is the default of view for DeveloperKnowledge.SearchDocumentChunks.
      DOCUMENT_VIEW_FULL - Includes all Document fields.
      DOCUMENT_VIEW_CONTENT - Includes the `DOCUMENT_VIEW_BASIC` fields and the `content` field. This is the default of view for DeveloperKnowledge.GetDocument and DeveloperKnowledge.BatchGetDocuments.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Document represents a piece of content from the Developer Knowledge corpus.
  "content": "A String", # Output only. Contains the full content of the document in Markdown format.
  "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com`
  "description": "A String", # Output only. Provides a description of the document.
  "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
  "title": "A String", # Output only. Provides the title of the document.
  "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated.
  "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.
  "view": "A String", # Output only. Specifies the DocumentView of the document.
}

searchDocumentChunks(filter=None, pageSize=None, pageToken=None, query=None, x__xgafv=None)

Searches for developer knowledge across Google's developer documentation. Returns DocumentChunks based on the user's query. There may be many chunks from the same Document. To retrieve full documents, use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments with the DocumentChunk.parent returned in the SearchDocumentChunksResponse.results.

Args:
  filter: string, Optional. Applies a strict filter to the search results. The expression supports a subset of the syntax described at https://google.aip.dev/160. While `SearchDocumentChunks` returns DocumentChunks, the filter is applied to `DocumentChunk.document` fields. Supported fields for filtering: * `data_source` (STRING): The source of the document, e.g. `docs.cloud.google.com`. See https://developers.google.com/knowledge/reference/corpus-reference for the complete list of data sources in the corpus. * `update_time` (TIMESTAMP): The timestamp of when the document was last meaningfully updated. A meaningful update is one that changes document's markdown content or metadata. * `uri` (STRING): The document URI, e.g. `https://docs.cloud.google.com/bigquery/docs/tables`. STRING fields support `=` (equals) and `!=` (not equals) operators for **exact match** on the whole string. Partial match, prefix match, and regexp match are not supported. TIMESTAMP fields support `=`, `<`, `<=`, `>`, and `>=` operators. Timestamps must be in RFC-3339 format, e.g., `"2025-01-01T00:00:00Z"`. You can combine expressions using `AND`, `OR`, and `NOT` (or `-`) logical operators. `OR` has higher precedence than `AND`. Use parentheses for explicit precedence grouping. Examples: * `data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"` * `data_source != "firebase.google.com"` * `update_time < "2024-01-01T00:00:00Z"` * `update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")` * `uri = "https://docs.cloud.google.com/release-notes"` The `filter` string must not exceed 500 characters; values longer than 500 characters will result in an `INVALID_ARGUMENT` error.
  pageSize: integer, Optional. Specifies the maximum number of results to return. The service may return fewer than this value. If unspecified, at most 5 results will be returned. The maximum value is 20; values above 20 will result in an INVALID_ARGUMENT error.
  pageToken: string, Optional. Contains a page token, received from a previous `SearchDocumentChunks` call. Provide this to retrieve the subsequent page.
  query: string, Required. Provides the raw query string provided by the user, such as "How to create a Cloud Storage bucket?".
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for DeveloperKnowledge.SearchDocumentChunks.
  "nextPageToken": "A String", # Optional. Provides a token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "results": [ # Contains the search results for the given query. Each DocumentChunk in this list contains a snippet of content relevant to the search query. Use the DocumentChunk.parent field of each result with DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to retrieve the full document content.
    { # A DocumentChunk represents a piece of content from a Document in the DeveloperKnowledge corpus. To fetch the entire document content, pass the `parent` to DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments.
      "content": "A String", # Output only. Contains the content of the document chunk.
      "document": { # A Document represents a piece of content from the Developer Knowledge corpus. # Output only. Represents metadata about the Document this chunk is from. The DocumentView of this Document message will be set to `DOCUMENT_VIEW_BASIC`. It is included here for convenience so that clients do not need to call DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments if they only need the metadata fields. Otherwise, clients should use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full document content.
        "content": "A String", # Output only. Contains the full content of the document in Markdown format.
        "dataSource": "A String", # Output only. Specifies the data source of the document. Example data source: `firebase.google.com`
        "description": "A String", # Output only. Provides a description of the document.
        "name": "A String", # Identifier. Contains the resource name of the document. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
        "title": "A String", # Output only. Provides the title of the document.
        "updateTime": "A String", # Output only. Represents the timestamp when the content or metadata of the document was last updated.
        "uri": "A String", # Output only. Provides the URI of the content, such as `docs.cloud.google.com/storage/docs/creating-buckets`.
        "view": "A String", # Output only. Specifies the DocumentView of the document.
      },
      "id": "A String", # Output only. Specifies the ID of this chunk within the document. The chunk ID is unique within a document, but not globally unique across documents. The chunk ID is not stable and may change over time.
      "parent": "A String", # Output only. Contains the resource name of the document this chunk is from. Format: `documents/{uri_without_scheme}` Example: `documents/docs.cloud.google.com/storage/docs/creating-buckets`
    },
  ],
}

searchDocumentChunks_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.