public static interface DeveloperKnowledgeGrpc.AsyncServiceThe 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 to find relevant page URIs based on a query, and then use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full content of the top results. All document content is provided in Markdown format.
Methods
batchGetDocuments(BatchGetDocumentsRequest request, StreamObserver<BatchGetDocumentsResponse> responseObserver)
public default void batchGetDocuments(BatchGetDocumentsRequest request, StreamObserver<BatchGetDocumentsResponse> responseObserver)Retrieves multiple documents, each with its full Markdown content.
| Parameters | |
|---|---|
| Name | Description |
request |
BatchGetDocumentsRequest |
responseObserver |
io.grpc.stub.StreamObserver<BatchGetDocumentsResponse> |
getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)
public default void getDocument(GetDocumentRequest request, StreamObserver<Document> responseObserver)Retrieves a single document with its full Markdown content.
| Parameters | |
|---|---|
| Name | Description |
request |
GetDocumentRequest |
responseObserver |
io.grpc.stub.StreamObserver<Document> |
searchDocumentChunks(SearchDocumentChunksRequest request, StreamObserver<SearchDocumentChunksResponse> responseObserver)
public default void searchDocumentChunks(SearchDocumentChunksRequest request, StreamObserver<SearchDocumentChunksResponse> responseObserver)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.
| Parameters | |
|---|---|
| Name | Description |
request |
SearchDocumentChunksRequest |
responseObserver |
io.grpc.stub.StreamObserver<SearchDocumentChunksResponse> |