Package Methods (0.1.2)

0.1.2 (latest) 0.1.1

Summary of entries of Methods for google-developer-knowledge.

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient

DeveloperKnowledgeAsyncClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.developer_knowledge_v1.services.developer_knowledge.transports.base.DeveloperKnowledgeTransport,
            typing.Callable[
                [...],
                google.developer_knowledge_v1.services.developer_knowledge.transports.base.DeveloperKnowledgeTransport,
            ],
        ]
    ] = "grpc_asyncio",
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the developer knowledge async client.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.answer_query

answer_query(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.AnswerQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.developer_knowledge_v1.types.developerknowledge.AnswerQueryResponse

Answers a query using grounded generation.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.answer_query

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.batch_get_documents

batch_get_documents(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.BatchGetDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.developer_knowledge_v1.types.developerknowledge.BatchGetDocumentsResponse

Retrieves multiple documents, each with its full Markdown content.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.batch_get_documents

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_billing_account_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_folder_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_location_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_organization_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.common_project_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.document_path

document_path(document: str) -> str

Returns a fully-qualified document string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.document_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.from_service_account_file

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.from_service_account_info

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.from_service_account_json

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.developer_knowledge_v1.types.developerknowledge.Document

Retrieves a single document with its full Markdown content.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.get_document

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.get_mtls_endpoint_and_cert_source

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.developer_knowledge_v1.services.developer_knowledge.transports.base.DeveloperKnowledgeTransport
]

Returns an appropriate transport class.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.get_transport_class

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_billing_account_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_folder_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_location_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_organization_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_common_project_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.parse_document_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.search_document_chunks

search_document_chunks(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksAsyncPager
)

Searches for developer knowledge across Google's developer documentation.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeAsyncClient.search_document_chunks

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient

DeveloperKnowledgeClient(
    *,
    credentials: typing.Optional[google.auth.credentials.Credentials] = None,
    transport: typing.Optional[
        typing.Union[
            str,
            google.developer_knowledge_v1.services.developer_knowledge.transports.base.DeveloperKnowledgeTransport,
            typing.Callable[
                [...],
                google.developer_knowledge_v1.services.developer_knowledge.transports.base.DeveloperKnowledgeTransport,
            ],
        ]
    ] = None,
    client_options: typing.Optional[
        typing.Union[google.api_core.client_options.ClientOptions, dict]
    ] = None,
    client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo
)

Instantiates the developer knowledge client.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.exit

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.answer_query

answer_query(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.AnswerQueryRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.developer_knowledge_v1.types.developerknowledge.AnswerQueryResponse

Answers a query using grounded generation.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.answer_query

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.batch_get_documents

batch_get_documents(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.BatchGetDocumentsRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.developer_knowledge_v1.types.developerknowledge.BatchGetDocumentsResponse

Retrieves multiple documents, each with its full Markdown content.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.batch_get_documents

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_billing_account_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_folder_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_location_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_organization_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.common_project_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.document_path

document_path(document: str) -> str

Returns a fully-qualified document string.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.document_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.from_service_account_file

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.from_service_account_info

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.from_service_account_json

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.get_document

get_document(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.GetDocumentRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.developer_knowledge_v1.types.developerknowledge.Document

Retrieves a single document with its full Markdown content.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.get_document

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.get_mtls_endpoint_and_cert_source

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_billing_account_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_folder_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_location_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_organization_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_common_project_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_document_path

parse_document_path(path: str) -> typing.Dict[str, str]

Parses a document path into its component segments.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.parse_document_path

google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.search_document_chunks

search_document_chunks(
    request: typing.Optional[
        typing.Union[
            google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksRequest,
            dict,
        ]
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksPager
)

Searches for developer knowledge across Google's developer documentation.

See more: google.developer_knowledge_v1.services.developer_knowledge.DeveloperKnowledgeClient.search_document_chunks

google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksAsyncPager

SearchDocumentChunksAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse
        ],
    ],
    request: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksRequest,
    response: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiates the pager.

See more: google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksAsyncPager

google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksPager

SearchDocumentChunksPager(
    method: typing.Callable[
        [...],
        google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse,
    ],
    request: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksRequest,
    response: google.developer_knowledge_v1.types.developerknowledge.SearchDocumentChunksResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)

Instantiate the pager.

See more: google.developer_knowledge_v1.services.developer_knowledge.pagers.SearchDocumentChunksPager