Ressource REST: corpora.documents
- Ressource: Document
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Méthodes
Ressource : Document
Un Document
est une collection de Chunk
. Un élément Corpus
ne peut pas comporter plus de 10 000 éléments Document
.
Représentation JSON |
---|
{
"name": string,
"displayName": string,
"customMetadata": [
{
object ( |
name
string
Immuable. Identifiant. Nom de ressource Document
. L'ID (nom à l'exclusion du préfixe "corpora/*/documents/") peut contenir jusqu'à 40 caractères alphanumériques minuscules ou tirets (-). L'ID ne peut pas commencer ni se terminer par un tiret. Si le nom est vide lors de la création, un nom unique est dérivé de displayName
, accompagné d'un suffixe aléatoire de 12 caractères. Exemple : corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
Facultatif. Nom lisible à afficher pour Document
. Le nom à afficher ne doit pas dépasser 512 caractères, espaces compris. Exemple : "Documentation sémantique sur les récupérateurs"
customMetadata[]
object (CustomMetadata
)
Facultatif. Métadonnées personnalisées fournies par l'utilisateur, stockées sous forme de paires clé-valeur utilisées pour les requêtes. Un Document
ne peut pas contenir plus de 20 CustomMetadata
.
updateTime
string (Timestamp
format)
Uniquement en sortie. Code temporel de la dernière mise à jour de Document
.
Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z"
et "2014-10-02T15:01:23.045123456Z"
.
createTime
string (Timestamp
format)
Uniquement en sortie. Code temporel de la création du Document
.
Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z"
et "2014-10-02T15:01:23.045123456Z"
.
Méthode: corpora.documents.create
- Point de terminaison
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
Crée un Document
vide.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> publier
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
.
Paramètres de chemin d'accès
parent
string
Obligatoire. Nom du Corpus
dans lequel ce Document
sera créé. Exemple: corpora/my-corpus-123
. Il se présente sous la forme corpora/{corpora}
.
Corps de la requête
Le corps de la requête contient une instance de Document
.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une nouvelle instance de Document
.
Méthode: corpora.documents.list
- Point de terminaison
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Champs d'application des autorisations
Répertorie toutes les Document
d'un Corpus
.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> obtenir
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
.
Paramètres de chemin d'accès
parent
string
Obligatoire. Nom du Corpus
contenant des Document
. Exemple: corpora/my-corpus-123
. Il se présente sous la forme corpora/{corpora}
.
Paramètres de requête
pageSize
integer
Facultatif. Nombre maximal d'éléments Document
à renvoyer (par page). Le service peut renvoyer moins de Document
.
Si aucune valeur n'est spécifiée, 10 Document
au maximum seront renvoyés. La taille maximale est de 20 Document
par page.
pageToken
string
Facultatif. Jeton de page reçu d'un appel documents.list
précédent.
Fournissez le nextPageToken
renvoyé dans la réponse en tant qu'argument à la requête suivante pour récupérer la page suivante.
Lors de la pagination, tous les autres paramètres fournis à documents.list
doivent correspondre à l'appel ayant fourni le jeton de page.
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Réponse de documents.list
contenant une liste paginée d'éléments Document
. Les éléments Document
sont triés dans l'ordre croissant des valeurs document.create_time
.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
documents[]
object (Document
)
Les Document
renvoyés.
nextPageToken
string
Jeton pouvant être envoyé en tant que pageToken
pour récupérer la page suivante. Si ce champ est omis, il n'y a plus de pages.
Représentation JSON |
---|
{
"documents": [
{
object ( |
Méthode: corpora.documents.query
- Point de terminaison
- Paramètres de chemin d'accès
- Corps de la requête
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Corps de la réponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Champs d'application des autorisations
Effectue une recherche sémantique sur une Document
.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> publier
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
.
Paramètres de chemin d'accès
name
string
Obligatoire. Nom du Document
à interroger. Exemple: corpora/my-corpus-123/documents/the-doc-abc
. Il se présente sous la forme corpora/{corpora}/documents/{document}
.
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
<ph type="x-smartling-placeholder">query
string
Obligatoire. Chaîne de requête permettant d'effectuer une recherche sémantique.
resultsCount
integer
Facultatif. Nombre maximal d'éléments Chunk
à renvoyer. Le service peut renvoyer moins de Chunk
.
Si aucune valeur n'est spécifiée, 10 Chunk
au maximum seront renvoyés. Le nombre maximal de résultats spécifié est de 100.
metadataFilters[]
object (MetadataFilter
)
Facultatif. Filtrez les métadonnées Chunk
. Chaque objet MetadataFilter
doit correspondre à une clé unique. Plusieurs objets MetadataFilter
sont joints par des opérateurs logiques "AND".
Remarque: Le filtrage au niveau Document
n'est pas compatible avec cette requête, car un nom Document
est déjà spécifié.
Exemple de requête: (année >= 2020 OR année < 2010) AND (genre = drame OR genre = action)
Liste d'objets MetadataFilter
: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drame", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]
Exemple de requête pour une plage de valeurs numérique: (année > 2015 ET année <= 2020)
Liste d'objets MetadataFilter
: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]
Remarque : Les opérateurs "AND" pour une même clé ne sont acceptés que pour les valeurs numériques. Les valeurs de chaîne n'acceptent que des opérateurs "OR" pour la même clé.
Corps de la réponse
Réponse de documents.query
contenant une liste de fragments pertinents.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
relevantChunks[]
object (RelevantChunk
)
Les fragments pertinents renvoyés.
Représentation JSON |
---|
{
"relevantChunks": [
{
object ( |
Méthode: corpora.documents.get
- Point de terminaison
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
Récupère des informations sur un Document
spécifique.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> obtenir
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}
.
Paramètres de chemin d'accès
name
string
Obligatoire. Nom du Document
à récupérer. Exemple: corpora/my-corpus-123/documents/the-doc-abc
. Il se présente sous la forme corpora/{corpora}/documents/{document}
.
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de Document
.
Méthode: corpora.documents.patch
- Point de terminaison
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
Met à jour un Document
.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> correctif
https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
.
PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
Paramètres de chemin d'accès
document.name
string
Immuable. Identifiant. Le nom de la ressource Document
. L'ID (nom à l'exclusion du préfixe "corpora/*/documents/") peut contenir jusqu'à 40 caractères alphanumériques minuscules ou tirets (-). L'ID ne peut pas commencer ni se terminer par un tiret. Si le nom est vide lors de la création, un nom unique est dérivé de displayName
, accompagné d'un suffixe aléatoire de 12 caractères. Exemple: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
. Il se présente sous la forme corpora/{corpora}/documents/{document}
.
Paramètres de requête
updateMask
string (FieldMask
format)
Obligatoire. Liste des champs à mettre à jour. Actuellement, cela ne permet de mettre à jour que displayName
et customMetadata
.
Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"
Corps de la requête
Le corps de la requête contient une instance de Document
.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient une instance de Document
.
Méthode: corpora.documents.delete
- Point de terminaison
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
Supprime un Document
.
Point de terminaison
<ph type="x-smartling-placeholder"></ph> supprimer
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}
.
Paramètres de chemin d'accès
name
string
Obligatoire. Nom de ressource du Document
à supprimer. Exemple: corpora/my-corpus-123/documents/the-doc-abc
. Il se présente sous la forme corpora/{corpora}/documents/{document}
.
Paramètres de requête
force
boolean
Facultatif. Si elle est définie sur "true", tous les Chunk
et tous les objets associés à cette Document
seront également supprimés.
Si la valeur est "false" (valeur par défaut), une erreur FAILED_PRECONDITION
est renvoyée si Document
contient des Chunk
.
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse est vide.
CustomMetadata
- Représentation JSON
- StringList
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
Métadonnées fournies par l'utilisateur stockées sous forme de paires clé-valeur.
Représentation JSON |
---|
{ "key": string, // Union field |
key
string
Obligatoire. Clé des métadonnées à stocker.
Champ d'union value
.
value
ne peut être qu'un des éléments suivants :
stringValue
string
Valeur de chaîne des métadonnées à stocker.
stringListValue
object (StringList
)
Valeur StringList des métadonnées à stocker.
numericValue
number
Valeur numérique des métadonnées à stocker.
StringList
Valeurs de chaîne fournies par l'utilisateur attribuées à une seule clé de métadonnées.
Représentation JSON |
---|
{ "values": [ string ] } |
values[]
string
Valeurs de chaîne des métadonnées à stocker.