Package @google/developer-knowledge (0.8.0)

Classes

protos.google.api.BatchingConfigProto

Represents a BatchingConfigProto.

protos.google.api.BatchingDescriptorProto

Represents a BatchingDescriptorProto.

protos.google.api.BatchingSettingsProto

Represents a BatchingSettingsProto.

protos.google.api.ClientLibrarySettings

Represents a ClientLibrarySettings.

protos.google.api.CommonLanguageSettings

Represents a CommonLanguageSettings.

protos.google.api.CppSettings

Represents a CppSettings.

protos.google.api.CustomHttpPattern

Represents a CustomHttpPattern.

protos.google.api.DotnetSettings

Represents a DotnetSettings.

protos.google.api.GoSettings

Represents a GoSettings.

protos.google.api.Http

Represents a Http.

protos.google.api.HttpRule

Represents a HttpRule.

protos.google.api.JavaSettings

Represents a JavaSettings.

protos.google.api.MethodSettings

Represents a MethodSettings.

protos.google.api.MethodSettings.LongRunning

Represents a LongRunning.

protos.google.api.NodeSettings

Represents a NodeSettings.

protos.google.api.PhpSettings

Represents a PhpSettings.

protos.google.api.Publishing

Represents a Publishing.

protos.google.api.PythonSettings

Represents a PythonSettings.

protos.google.api.PythonSettings.ExperimentalFeatures

Represents an ExperimentalFeatures.

protos.google.api.ResourceDescriptor

Represents a ResourceDescriptor.

protos.google.api.ResourceReference

Represents a ResourceReference.

protos.google.api.RubySettings

Represents a RubySettings.

protos.google.api.SelectiveGapicGeneration

Represents a SelectiveGapicGeneration.

protos.google.developers.knowledge.v1.Answer

Represents an Answer.

protos.google.developers.knowledge.v1.Answer.AnswerCitation

Represents an AnswerCitation.

protos.google.developers.knowledge.v1.Answer.AnswerReference

Represents an AnswerReference.

protos.google.developers.knowledge.v1.Answer.CitationSource

Represents a CitationSource.

protos.google.developers.knowledge.v1.Answer.DocumentReference

Represents a DocumentReference.

protos.google.developers.knowledge.v1.AnswerQueryRequest

Represents an AnswerQueryRequest.

protos.google.developers.knowledge.v1.AnswerQueryResponse

Represents an AnswerQueryResponse.

protos.google.developers.knowledge.v1.BatchGetDocumentsRequest

Represents a BatchGetDocumentsRequest.

protos.google.developers.knowledge.v1.BatchGetDocumentsResponse

Represents a BatchGetDocumentsResponse.

protos.google.developers.knowledge.v1.DeveloperKnowledge

Represents a DeveloperKnowledge

protos.google.developers.knowledge.v1.Document

Represents a Document.

protos.google.developers.knowledge.v1.DocumentChunk

Represents a DocumentChunk.

protos.google.developers.knowledge.v1.GetDocumentRequest

Represents a GetDocumentRequest.

protos.google.developers.knowledge.v1.SearchDocumentChunksRequest

Represents a SearchDocumentChunksRequest.

protos.google.developers.knowledge.v1.SearchDocumentChunksResponse

Represents a SearchDocumentChunksResponse.

protos.google.protobuf.DescriptorProto

Represents a DescriptorProto.

protos.google.protobuf.DescriptorProto.ExtensionRange

Represents an ExtensionRange.

protos.google.protobuf.DescriptorProto.ReservedRange

Represents a ReservedRange.

protos.google.protobuf.Duration

Represents a Duration.

protos.google.protobuf.EnumDescriptorProto

Represents an EnumDescriptorProto.

protos.google.protobuf.EnumDescriptorProto.EnumReservedRange

Represents an EnumReservedRange.

protos.google.protobuf.EnumOptions

Represents an EnumOptions.

protos.google.protobuf.EnumValueDescriptorProto

Represents an EnumValueDescriptorProto.

protos.google.protobuf.EnumValueOptions

Represents an EnumValueOptions.

protos.google.protobuf.ExtensionRangeOptions

Represents an ExtensionRangeOptions.

protos.google.protobuf.ExtensionRangeOptions.Declaration

Represents a Declaration.

protos.google.protobuf.FeatureSet

Represents a FeatureSet.

protos.google.protobuf.FeatureSet.ProtoLimitsFeature

Represents a ProtoLimitsFeature.

protos.google.protobuf.FeatureSet.VisibilityFeature

Represents a VisibilityFeature.

protos.google.protobuf.FeatureSetDefaults

Represents a FeatureSetDefaults.

protos.google.protobuf.FeatureSetDefaults.FeatureSetEditionDefault

Represents a FeatureSetEditionDefault.

protos.google.protobuf.FieldDescriptorProto

Represents a FieldDescriptorProto.

protos.google.protobuf.FieldOptions

Represents a FieldOptions.

protos.google.protobuf.FieldOptions.EditionDefault

Represents an EditionDefault.

protos.google.protobuf.FieldOptions.FeatureSupport

Represents a FeatureSupport.

protos.google.protobuf.FileDescriptorProto

Represents a FileDescriptorProto.

protos.google.protobuf.FileDescriptorSet

Represents a FileDescriptorSet.

protos.google.protobuf.FileOptions

Represents a FileOptions.

protos.google.protobuf.GeneratedCodeInfo

Represents a GeneratedCodeInfo.

protos.google.protobuf.GeneratedCodeInfo.Annotation

Represents an Annotation.

protos.google.protobuf.MessageOptions

Represents a MessageOptions.

protos.google.protobuf.MethodDescriptorProto

Represents a MethodDescriptorProto.

protos.google.protobuf.MethodOptions

Represents a MethodOptions.

protos.google.protobuf.OneofDescriptorProto

Represents an OneofDescriptorProto.

protos.google.protobuf.OneofOptions

Represents an OneofOptions.

protos.google.protobuf.ServiceDescriptorProto

Represents a ServiceDescriptorProto.

protos.google.protobuf.ServiceOptions

Represents a ServiceOptions.

protos.google.protobuf.SourceCodeInfo

Represents a SourceCodeInfo.

protos.google.protobuf.SourceCodeInfo.Location

Represents a Location.

protos.google.protobuf.Timestamp

Represents a Timestamp.

protos.google.protobuf.UninterpretedOption

Represents an UninterpretedOption.

protos.google.protobuf.UninterpretedOption.NamePart

Represents a NamePart.

v1.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 to find relevant page URIs based on a query, and then use or to fetch the full content of the top results.

All document content is provided in Markdown format. v1

Interfaces

protos.google.api.IBatchingConfigProto

Properties of a BatchingConfigProto.

protos.google.api.IBatchingDescriptorProto

Properties of a BatchingDescriptorProto.

protos.google.api.IBatchingSettingsProto

Properties of a BatchingSettingsProto.

protos.google.api.IClientLibrarySettings

Properties of a ClientLibrarySettings.

protos.google.api.ICommonLanguageSettings

Properties of a CommonLanguageSettings.

protos.google.api.ICppSettings

Properties of a CppSettings.

protos.google.api.ICustomHttpPattern

Properties of a CustomHttpPattern.

protos.google.api.IDotnetSettings

Properties of a DotnetSettings.

protos.google.api.IGoSettings

Properties of a GoSettings.

protos.google.api.IHttp

Properties of a Http.

protos.google.api.IHttpRule

Properties of a HttpRule.

protos.google.api.IJavaSettings

Properties of a JavaSettings.

protos.google.api.IMethodSettings

Properties of a MethodSettings.

protos.google.api.INodeSettings

Properties of a NodeSettings.

protos.google.api.IPhpSettings

Properties of a PhpSettings.

protos.google.api.IPublishing

Properties of a Publishing.

protos.google.api.IPythonSettings

Properties of a PythonSettings.

protos.google.api.IResourceDescriptor

Properties of a ResourceDescriptor.

protos.google.api.IResourceReference

Properties of a ResourceReference.

protos.google.api.IRubySettings

Properties of a RubySettings.

protos.google.api.ISelectiveGapicGeneration

Properties of a SelectiveGapicGeneration.

protos.google.api.MethodSettings.ILongRunning

Properties of a LongRunning.

protos.google.api.PythonSettings.IExperimentalFeatures

Properties of an ExperimentalFeatures.

protos.google.developers.knowledge.v1.Answer.IAnswerCitation

Properties of an AnswerCitation.

protos.google.developers.knowledge.v1.Answer.IAnswerReference

Properties of an AnswerReference.

protos.google.developers.knowledge.v1.Answer.ICitationSource

Properties of a CitationSource.

protos.google.developers.knowledge.v1.Answer.IDocumentReference

Properties of a DocumentReference.

protos.google.developers.knowledge.v1.IAnswer

Properties of an Answer.

protos.google.developers.knowledge.v1.IAnswerQueryRequest

Properties of an AnswerQueryRequest.

protos.google.developers.knowledge.v1.IAnswerQueryResponse

Properties of an AnswerQueryResponse.

protos.google.developers.knowledge.v1.IBatchGetDocumentsRequest

Properties of a BatchGetDocumentsRequest.

protos.google.developers.knowledge.v1.IBatchGetDocumentsResponse

Properties of a BatchGetDocumentsResponse.

protos.google.developers.knowledge.v1.IDocument

Properties of a Document.

protos.google.developers.knowledge.v1.IDocumentChunk

Properties of a DocumentChunk.

protos.google.developers.knowledge.v1.IGetDocumentRequest

Properties of a GetDocumentRequest.

protos.google.developers.knowledge.v1.ISearchDocumentChunksRequest

Properties of a SearchDocumentChunksRequest.

protos.google.developers.knowledge.v1.ISearchDocumentChunksResponse

Properties of a SearchDocumentChunksResponse.

protos.google.protobuf.DescriptorProto.IExtensionRange

Properties of an ExtensionRange.

protos.google.protobuf.DescriptorProto.IReservedRange

Properties of a ReservedRange.

protos.google.protobuf.EnumDescriptorProto.IEnumReservedRange

Properties of an EnumReservedRange.

protos.google.protobuf.ExtensionRangeOptions.IDeclaration

Properties of a Declaration.

protos.google.protobuf.FeatureSet.IProtoLimitsFeature

Properties of a ProtoLimitsFeature.

protos.google.protobuf.FeatureSet.IVisibilityFeature

Properties of a VisibilityFeature.

protos.google.protobuf.FeatureSetDefaults.IFeatureSetEditionDefault

Properties of a FeatureSetEditionDefault.

protos.google.protobuf.FieldOptions.IEditionDefault

Properties of an EditionDefault.

protos.google.protobuf.FieldOptions.IFeatureSupport

Properties of a FeatureSupport.

protos.google.protobuf.GeneratedCodeInfo.IAnnotation

Properties of an Annotation.

protos.google.protobuf.IDescriptorProto

Properties of a DescriptorProto.

protos.google.protobuf.IDuration

Properties of a Duration.

protos.google.protobuf.IEnumDescriptorProto

Properties of an EnumDescriptorProto.

protos.google.protobuf.IEnumOptions

Properties of an EnumOptions.

protos.google.protobuf.IEnumValueDescriptorProto

Properties of an EnumValueDescriptorProto.

protos.google.protobuf.IEnumValueOptions

Properties of an EnumValueOptions.

protos.google.protobuf.IExtensionRangeOptions

Properties of an ExtensionRangeOptions.

protos.google.protobuf.IFeatureSet

Properties of a FeatureSet.

protos.google.protobuf.IFeatureSetDefaults

Properties of a FeatureSetDefaults.

protos.google.protobuf.IFieldDescriptorProto

Properties of a FieldDescriptorProto.

protos.google.protobuf.IFieldOptions

Properties of a FieldOptions.

protos.google.protobuf.IFileDescriptorProto

Properties of a FileDescriptorProto.

protos.google.protobuf.IFileDescriptorSet

Properties of a FileDescriptorSet.

protos.google.protobuf.IFileOptions

Properties of a FileOptions.

protos.google.protobuf.IGeneratedCodeInfo

Properties of a GeneratedCodeInfo.

protos.google.protobuf.IMessageOptions

Properties of a MessageOptions.

protos.google.protobuf.IMethodDescriptorProto

Properties of a MethodDescriptorProto.

protos.google.protobuf.IMethodOptions

Properties of a MethodOptions.

protos.google.protobuf.IOneofDescriptorProto

Properties of an OneofDescriptorProto.

protos.google.protobuf.IOneofOptions

Properties of an OneofOptions.

protos.google.protobuf.IServiceDescriptorProto

Properties of a ServiceDescriptorProto.

protos.google.protobuf.IServiceOptions

Properties of a ServiceOptions.

protos.google.protobuf.ISourceCodeInfo

Properties of a SourceCodeInfo.

protos.google.protobuf.ITimestamp

Properties of a Timestamp.

protos.google.protobuf.IUninterpretedOption

Properties of an UninterpretedOption.

protos.google.protobuf.SourceCodeInfo.ILocation

Properties of a Location.

protos.google.protobuf.UninterpretedOption.INamePart

Properties of a NamePart.

Enums

protos.google.api.ClientLibraryDestination

ClientLibraryDestination enum.

protos.google.api.ClientLibraryOrganization

ClientLibraryOrganization enum.

protos.google.api.FieldBehavior

FieldBehavior enum.

protos.google.api.FlowControlLimitExceededBehaviorProto

FlowControlLimitExceededBehaviorProto enum.

protos.google.api.LaunchStage

LaunchStage enum.

protos.google.api.ResourceDescriptor.History

History enum.

protos.google.api.ResourceDescriptor.Style

Style enum.

protos.google.developers.knowledge.v1.DocumentView

DocumentView enum.

protos.google.protobuf.Edition

Edition enum.

protos.google.protobuf.ExtensionRangeOptions.VerificationState

VerificationState enum.

protos.google.protobuf.FeatureSet.EnforceNamingStyle

EnforceNamingStyle enum.

protos.google.protobuf.FeatureSet.EnumType

EnumType enum.

protos.google.protobuf.FeatureSet.FieldPresence

FieldPresence enum.

protos.google.protobuf.FeatureSet.JsonFormat

JsonFormat enum.

protos.google.protobuf.FeatureSet.MessageEncoding

MessageEncoding enum.

protos.google.protobuf.FeatureSet.ProtoLimitsFeature.EnforceProtoLimits

EnforceProtoLimits enum.

protos.google.protobuf.FeatureSet.RepeatedFieldEncoding

RepeatedFieldEncoding enum.

protos.google.protobuf.FeatureSet.Utf8Validation

Utf8Validation enum.

protos.google.protobuf.FeatureSet.VisibilityFeature.DefaultSymbolVisibility

DefaultSymbolVisibility enum.

protos.google.protobuf.FieldDescriptorProto.Label

Label enum.

protos.google.protobuf.FieldDescriptorProto.Type

Type enum.

protos.google.protobuf.FieldOptions.CType

CType enum.

protos.google.protobuf.FieldOptions.JSType

JSType enum.

protos.google.protobuf.FieldOptions.OptionRetention

OptionRetention enum.

protos.google.protobuf.FieldOptions.OptionTargetType

OptionTargetType enum.

protos.google.protobuf.FileOptions.OptimizeMode

OptimizeMode enum.

protos.google.protobuf.GeneratedCodeInfo.Annotation.Semantic

Semantic enum.

protos.google.protobuf.MethodOptions.IdempotencyLevel

IdempotencyLevel enum.

protos.google.protobuf.SymbolVisibility

SymbolVisibility enum.

Variables

_default

_default: {
    v1: typeof v1;
    DeveloperKnowledgeClient: typeof v1.DeveloperKnowledgeClient;
}

DeveloperKnowledgeClient

DeveloperKnowledgeClient: typeof v1.DeveloperKnowledgeClient

Type Aliases

DeveloperKnowledgeClient

type DeveloperKnowledgeClient = v1.DeveloperKnowledgeClient;

protos.google.developers.knowledge.v1.DeveloperKnowledge.AnswerQueryCallback

type AnswerQueryCallback = (error: (Error|null), response?: google.developers.knowledge.v1.AnswerQueryResponse) => void;

Callback as used by .

protos.google.developers.knowledge.v1.DeveloperKnowledge.BatchGetDocumentsCallback

type BatchGetDocumentsCallback = (error: (Error|null), response?: google.developers.knowledge.v1.BatchGetDocumentsResponse) => void;

Callback as used by .

protos.google.developers.knowledge.v1.DeveloperKnowledge.GetDocumentCallback

type GetDocumentCallback = (error: (Error|null), response?: google.developers.knowledge.v1.Document) => void;

Callback as used by .

protos.google.developers.knowledge.v1.DeveloperKnowledge.SearchDocumentChunksCallback

type SearchDocumentChunksCallback = (error: (Error|null), response?: google.developers.knowledge.v1.SearchDocumentChunksResponse) => void;

Callback as used by .