Method: documents.searchDocumentChunks

Pesquisa conhecimento para desenvolvedores na documentação do Google para desenvolvedores. Retorna DocumentChunks com base na consulta do usuário. Pode haver vários blocos do mesmo Document. Para recuperar documentos completos, use DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments com o DocumentChunk.parent retornado no SearchDocumentChunksResponse.results.

Solicitação HTTP

GET https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de consulta

Parâmetros
query

string

Obrigatório. Fornece a string de consulta bruta fornecida pelo usuário, como "Como criar um bucket do Cloud Storage?".
pageSize

integer

Opcional. Especifica o número máximo de resultados a serem retornados. O serviço pode retornar um valor inferior a este.

Se não for especificado, no máximo cinco resultados serão retornados.

O valor máximo é 20. Valores acima de 20 vão resultar em um erro INVALID_ARGUMENT.
pageToken

string

Opcional. Contém um token de página recebido de uma chamada documents.searchDocumentChunks anterior. Forneça isso para recuperar a página subsequente.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para DeveloperKnowledge.SearchDocumentChunks.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "results": [
    {
      object (DocumentChunk)
    }
  ],
  "nextPageToken": string
}
Campos
results[]

object (DocumentChunk)

Contém os resultados da pesquisa para a consulta especificada. Cada DocumentChunk nessa lista contém um snippet de conteúdo relevante para a consulta de pesquisa. Use o campo DocumentChunk.parent de cada resultado com DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments para recuperar o conteúdo completo do documento.
nextPageToken

string

Opcional. Fornece um token que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte OAuth 2.0 Overview.

DocumentChunk

Um DocumentChunk representa uma parte do conteúdo de um Document no corpus DeveloperKnowledge. Para buscar todo o conteúdo do documento, transmita parent para DeveloperKnowledge.GetDocument ou DeveloperKnowledge.BatchGetDocuments.

Representação JSON 
{
  "parent": string,
  "id": string,
  "content": string
}
Campos
parent

string

Apenas saída. Contém o nome do recurso do documento de origem do trecho. Formato: documents/{uri_without_scheme} Exemplo: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Apenas saída. Especifica o ID deste trecho no documento. O ID do fragmento é exclusivo em um documento, mas não globalmente em todos os documentos. O ID do bloco não é estável e pode mudar com o tempo.
content

string

Apenas saída. Contém o conteúdo do trecho do documento.