SearchResult

Représente les résultats de recherche.

Représentation JSON 
{
  "id": string,
  "document": {
    object (Document)
  },
  "chunk": {
    object (Chunk)
  },
  "modelScores": {
    string: {
      object (DoubleList)
    },
    ...
  },
  "rankSignals": {
    object (RankSignals)
  }
}
Champs
id

string

Document.id de la Document recherchée.
document

object (Document)

Extrait de données du document dans la réponse de recherche. Seuls les champs marqués comme retrievable sont renseignés.
chunk

object (Chunk)

Données de bloc dans la réponse de recherche si SearchRequest.ContentSearchSpec.search_result_mode est défini sur CHUNKS.
modelScores

map (key: string, value: object (DoubleList))

Uniquement en sortie. Google a fourni les scores disponibles.
rankSignals

object (RankSignals)

Facultatif. Ensemble de signaux de classement associés au résultat.

Bloc

Le bloc capture toutes les informations brutes sur les métadonnées des éléments à recommander ou à rechercher en mode bloc.

Représentation JSON 
{
  "name": string,
  "id": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "derivedStructData": {
    object
  },
  "pageSpan": {
    object (PageSpan)
  },
  "chunkMetadata": {
    object (ChunkMetadata)
  },
  "dataUrls": [
    string
  ],
  "annotationContents": [
    string
  ],
  "annotationMetadata": [
    {
      object (AnnotationMetadata)
    }
  ],
  "relevanceScore": number
}
Champs
name

string

Nom complet de la ressource du bloc. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}/chunks/{chunk_id}.

Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.
id

string

ID unique du bloc actuel.
content

string

Le contenu est une chaîne provenant d'un document (contenu analysé).
documentMetadata

object (DocumentMetadata)

Métadonnées du document provenant du bloc actuel.
derivedStructData

object (Struct format)

Uniquement en sortie. Ce champ est OUTPUT_ONLY. Il contient des données dérivées qui ne figurent pas dans le document d'entrée d'origine.
pageSpan

object (PageSpan)

Étendue de la page du bloc.
chunkMetadata

object (ChunkMetadata)

Uniquement en sortie. Métadonnées du bloc actuel.
dataUrls[]

string

Uniquement en sortie. URL des données d'image si le bloc actuel contient des images. Les URL de données se composent de quatre parties : un préfixe (data:), un type MIME indiquant le type de données, un jeton base64 facultatif si les données ne sont pas textuelles et les données elles-mêmes : data:[][;base64],
annotationContents[]

string

Uniquement en sortie. Contenu des annotations si le bloc actuel en contient.
annotationMetadata[]

object (AnnotationMetadata)

Uniquement en sortie. Les métadonnées d'annotation incluent le contenu structuré du bloc actuel.
relevanceScore

number

Uniquement en sortie. Représente le score de pertinence basé sur la similarité. Plus le score est élevé, plus le bloc est pertinent. Le score est compris dans la plage [-1,0, 1,0]. Renseigné uniquement sur SearchResponse.

DocumentMetadata

Les métadonnées du document contiennent les informations du document du bloc actuel.

Représentation JSON 
{
  "uri": string,
  "title": string,
  "mimeType": string,
  "structData": {
    object
  }
}
Champs
uri

string

URI du document.
title

string

Titre du document.
mimeType

string

Type MIME du document. https://www.iana.org/assignments/media-types/media-types.xhtml.
structData

object (Struct format)

Représentation des données. Données JSON structurées pour le document. Il doit être conforme au Schema enregistré, sinon une erreur INVALID_ARGUMENT est générée.

PageSpan

Étendue de la page du bloc.

Représentation JSON 
{
  "pageStart": integer,
  "pageEnd": integer
}
Champs
pageStart

integer

Page de début du bloc.
pageEnd

integer

Page de fin du bloc.

ChunkMetadata

Métadonnées du bloc actuel. Ce champ n'est renseigné que dans l'API SearchService.Search.

Représentation JSON 
{
  "previousChunks": [
    {
      object (Chunk)
    }
  ],
  "nextChunks": [
    {
      object (Chunk)
    }
  ]
}
Champs
previousChunks[]

object (Chunk)

Les blocs précédents du bloc actuel. Le nombre est contrôlé par SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. Ce champ n'est renseigné que dans l'API SearchService.Search.
nextChunks[]

object (Chunk)

Les blocs suivants du bloc actuel. Le nombre est contrôlé par SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. Ce champ n'est renseigné que dans l'API SearchService.Search.

AnnotationMetadata

Les métadonnées d'annotation incluent le contenu structuré du bloc actuel.

Représentation JSON 
{
  "structuredContent": {
    object (StructuredContent)
  },
  "imageId": string
}
Champs
structuredContent

object (StructuredContent)

Uniquement en sortie. Informations sur le contenu structuré.
imageId

string

Uniquement en sortie. L'ID de l'image est fourni si le contenu structuré est basé sur une image.

StructuredContent

Informations sur le contenu structuré.

Représentation JSON 
{
  "structureType": enum (StructureType),
  "content": string
}
Champs
structureType

enum (StructureType)

Uniquement en sortie. Type de structure du contenu structuré.
content

string

Uniquement en sortie. Contenu du contenu structuré.

StructureType

Définit les types de contenu structuré pouvant être extraits.

Enums
STRUCTURE_TYPE_UNSPECIFIED Valeur par défaut.
SHAREHOLDER_STRUCTURE Structure des actionnaires.
SIGNATURE_STRUCTURE la structure de la signature.
CHECKBOX_STRUCTURE Structure de la case à cocher.

DoubleList

Liste double.

Représentation JSON 
{
  "values": [
    number
  ]
}
Champs
values[]

number

Valeurs doubles.

RankSignals

Ensemble de signaux de classement.

Représentation JSON 
{
  "defaultRank": number,
  "customSignals": [
    {
      object (CustomSignal)
    }
  ],
  "keywordSimilarityScore": number,
  "relevanceScore": number,
  "semanticSimilarityScore": number,
  "pctrRank": number,
  "topicalityRank": number,
  "documentAge": number,
  "boostingFactor": number
}
Champs
defaultRank

number

Facultatif. Rang par défaut du résultat.
customSignals[]

object (CustomSignal)

Facultatif. Liste des signaux clearbox personnalisés.
keywordSimilarityScore

number

Facultatif. Ajustement de la correspondance des mots clés.
relevanceScore

number

Facultatif. Ajustement de la pertinence sémantique.
semanticSimilarityScore

number

Facultatif. Ajustement de la similarité sémantique.
pctrRank

number

Facultatif. Ajustement du taux de conversion prévu sous forme de classement.
topicalityRank

number

Facultatif. Ajustement de la pertinence thématique sous forme de classement.
documentAge

number

Facultatif. Âge du document en heures.
boostingFactor

number

Facultatif. Combinaison de boosts personnalisés pour un document.

CustomSignal

Signal clearbox personnalisé représenté par une paire nom/valeur.

Représentation JSON 
{
  "name": string,
  "value": number
}
Champs
name

string

Facultatif. Nom du signal.
value

number

Facultatif. Valeur flottante représentant le signal de classement (par exemple, 1,25 pour BM25).