File Search Stores

L'API File Search fournit un service de questions-réponses hébergé pour créer des systèmes de génération augmentée par récupération (RAG) à l'aide de l'infrastructure de Google.

Méthode : media.uploadToFileSearchStore

Importe des données dans un FileSearchStore, les prétraite et les segmente avant de les stocker dans un document FileSearchStore.

Point de terminaison

  • URI d'importation pour les demandes d'importation de contenus multimédias :
post https://generativelanguage.googleapis.com/upload/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore
  • URI des métadonnées, pour les demandes de métadonnées uniquement :
 post https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:uploadToFileSearchStore

Paramètres de chemin d'accès

fileSearchStoreName string

Obligatoire. Immuable. Nom du FileSearchStore dans lequel importer le fichier. Exemple : fileSearchStores/my-file-search-store-123 se présente sous la forme fileSearchStores/{filesearchstore}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Champs
displayName string

Facultatif. Nom à afficher du document créé.

customMetadata[] object (CustomMetadata)

Métadonnées personnalisées à associer aux données.

chunkingConfig object (ChunkingConfig)

Facultatif. Configuration permettant d'indiquer au service comment segmenter les données. Si aucune valeur n'est fournie, le service utilisera les paramètres par défaut.

mimeType string

Facultatif. Type MIME des données. Si aucune valeur n'est fournie, elle sera déduite du contenu importé.

Corps de la réponse

Il s'agit d'une copie de google.longrunning.Operation. Nous devons le copier, car pour interagir avec Scotty, nous devons ajouter un champ spécifique à Scotty qui ne peut pas être ajouté dans le proto Operation de premier niveau.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
name string

Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ name doit être un nom de ressource se terminant par operations/{unique_id}.

metadata object

Métadonnées spécifiques au service associées à l'opération. Ce champ contient généralement des informations de progression et des métadonnées courantes telles que la date de création. Certains services peuvent ne pas fournir ce genre de métadonnées. Toute méthode renvoyant une opération de longue durée doit indiquer le type de métadonnées, le cas échéant.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Si la valeur est false, cela signifie que l'opération est toujours en cours. Si elle est définie sur true, l'opération est terminée, et un message error ou response est disponible.

result Union type
Résultat de l'opération, qui peut être une erreur (message error) ou une réponse valide (message response). Si done == false, ni error, ni response ne sont définis. Si done == true, une seule des options error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants :
error object (Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.

response object

Réponse normale indiquant la réussite de l'opération. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que Delete), la réponse est google.protobuf.Empty. Si la méthode d'origine est une méthode Get/Create/Update standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type XxxResponse, où Xxx est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de réponse déduit est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Représentation JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Méthode : fileSearchStores.create

Crée un FileSearchStore vide.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/fileSearchStores

Corps de la requête

Le corps de la requête contient une instance de FileSearchStore.

Champs
displayName string

Facultatif. Nom à afficher lisible pour FileSearchStore. Le nom à afficher ne doit pas comporter plus de 512 caractères, espaces compris. Exemple : "Docs on Semantic Retriever"

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une nouvelle instance de FileSearchStore.

Méthode : fileSearchStores.delete

Supprime un FileSearchStore.

Point de terminaison

delete https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*}

Paramètres de chemin d'accès

name string

Obligatoire. Nom de ressource du FileSearchStore. Exemple : fileSearchStores/my-file-search-store-123 se présente sous la forme fileSearchStores/{filesearchstore}.

Paramètres de requête

force boolean

Facultatif. Si la valeur est définie sur "true", tous les Document et objets associés à ce FileSearchStore seront également supprimés.

Si la valeur est "false" (valeur par défaut), une erreur FAILED_PRECONDITION est renvoyée si FileSearchStore contient des 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 est un objet JSON vide.

Méthode : fileSearchStores.get

Obtient des informations sur un FileSearchStore spécifique.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*}

Paramètres de chemin d'accès

name string

Obligatoire. Nom du FileSearchStore. Exemple : fileSearchStores/my-file-search-store-123 se présente sous la forme fileSearchStores/{filesearchstore}.

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 FileSearchStore.

Méthode : fileSearchStores.list

Liste tous les FileSearchStores appartenant à l'utilisateur.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/fileSearchStores

Paramètres de requête

pageSize integer

Facultatif. Nombre maximal de FileSearchStores à renvoyer (par page). Le service peut renvoyer un nombre inférieur de FileSearchStores.

Si aucune valeur n'est spécifiée, 10 FileSearchStores au maximum sont renvoyés. La limite de taille maximale est de 20 FileSearchStores par page.

pageToken string

Facultatif. Jeton de page reçu d'un appel fileSearchStores.list précédent.

Fournissez le nextPageToken renvoyé dans la réponse en tant qu'argument de la requête suivante pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à fileSearchStores.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 fileSearchStores.list contenant une liste paginée de FileSearchStores. Les résultats sont triés par ordre croissant de fileSearchStore.create_time.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Champs
fileSearchStores[] object (FileSearchStore)

Les ragStores 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 pas d'autres pages.

Représentation JSON 
{
  "fileSearchStores": [
    {
      object (FileSearchStore)
    }
  ],
  "nextPageToken": string
}

Méthode : fileSearchStores.importFile

Importe un File depuis le service de fichiers vers un FileSearchStore.

Point de terminaison

post https://generativelanguage.googleapis.com/v1beta/{fileSearchStoreName=fileSearchStores/*}:importFile

Paramètres de chemin d'accès

fileSearchStoreName string

Obligatoire. Immuable. Nom de l'objet FileSearchStore dans lequel importer le fichier. Exemple : fileSearchStores/my-file-search-store-123 se présente sous la forme fileSearchStores/{filesearchstore}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Champs
fileName string

Obligatoire. Nom du File à importer. Exemple : files/abc-123

customMetadata[] object (CustomMetadata)

Métadonnées personnalisées à associer au fichier.

chunkingConfig object (ChunkingConfig)

Facultatif. Configuration indiquant au service comment segmenter le fichier. Si aucune valeur n'est fournie, le service utilisera les paramètres par défaut.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Operation.

Ressource REST : fileSearchStores.operations

Ressource : Operation

Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.

Champs
name string

Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ name doit être un nom de ressource se terminant par operations/{unique_id}.

metadata object

Métadonnées spécifiques au service associées à l'opération. Ce champ contient généralement des informations de progression et des métadonnées courantes telles que la date de création. Certains services peuvent ne pas fournir ce genre de métadonnées. Toute méthode renvoyant une opération de longue durée doit indiquer le type de métadonnées, le cas échéant.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Si la valeur est false, cela signifie que l'opération est toujours en cours. Si elle est définie sur true, l'opération est terminée, et un message error ou response est disponible.

result Union type
Résultat de l'opération, qui peut être une erreur (message error) ou une réponse valide (message response). Si done == false, ni error, ni response ne sont définis. Si done == true, une seule des options error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants :
error object (Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.

response object

Réponse normale indiquant la réussite de l'opération. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que Delete), la réponse est google.protobuf.Empty. Si la méthode d'origine est une méthode Get/Create/Update standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type XxxResponse, où Xxx est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de réponse déduit est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Représentation JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Méthode : fileSearchStores.operations.get

Récupère le dernier état d'une opération de longue durée. Cette méthode permet aux clients d'interroger le résultat de l'opération à des intervalles recommandés par le service d'API.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/operations/*}

Paramètres de chemin d'accès

name string

Nom de la ressource de l'opération. Il se présente sous la forme fileSearchStores/{filesearchstore}/operations/{operation}.

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 Operation.

Ressource REST : fileSearchStores.upload.operations

Ressource : Operation

Cette ressource représente une opération de longue durée résultant d'un appel d'API réseau.

Champs
name string

Nom attribué par le serveur. Unique au sein du service qui le renvoie initialement. Si vous utilisez le mappage HTTP par défaut, le champ name doit être un nom de ressource se terminant par operations/{unique_id}.

metadata object

Métadonnées spécifiques au service associées à l'opération. Ce champ contient généralement des informations de progression et des métadonnées courantes telles que la date de création. Certains services peuvent ne pas fournir ce genre de métadonnées. Toute méthode renvoyant une opération de longue durée doit indiquer le type de métadonnées, le cas échéant.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Si la valeur est false, cela signifie que l'opération est toujours en cours. Si elle est définie sur true, l'opération est terminée, et un message error ou response est disponible.

result Union type
Résultat de l'opération, qui peut être une erreur (message error) ou une réponse valide (message response). Si done == false, ni error, ni response ne sont définis. Si done == true, une seule des options error ou response peut être définie. Certains services peuvent ne pas fournir le résultat. result ne peut être qu'un des éléments suivants :
error object (Status)

Résultat d'erreur de l'opération en cas d'échec ou d'annulation.

response object

Réponse normale indiquant la réussite de l'opération. Si la méthode d'origine ne renvoie aucune donnée en cas de réussite (telle que Delete), la réponse est google.protobuf.Empty. Si la méthode d'origine est une méthode Get/Create/Update standard, la réponse doit correspondre à la ressource. Pour les autres méthodes, la réponse doit avoir le type XxxResponse, où Xxx est le nom de la méthode d'origine. Par exemple, si le nom de la méthode d'origine est TakeSnapshot(), le type de réponse déduit est TakeSnapshotResponse.

Objet contenant des champs d'un type arbitraire. Un champ supplémentaire "@type" contient un URI identifiant le type. Exemple : { "id": 1234, "@type": "types.example.com/standard/id" }.

Représentation JSON 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

Méthode : fileSearchStores.upload.operations.get

Récupère le dernier état d'une opération de longue durée. Cette méthode permet aux clients d'interroger le résultat de l'opération à des intervalles recommandés par le service d'API.

Point de terminaison

get https://generativelanguage.googleapis.com/v1beta/{name=fileSearchStores/*/upload/operations/*}

Paramètres de chemin d'accès

name string

Nom de la ressource de l'opération. Il se présente sous la forme fileSearchStores/{filesearchstore}/upload/operations/{operation}.

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 Operation.

Ressource REST : fileSearchStores

Ressource : FileSearchStore

Un FileSearchStore est une collection de Document.

Champs
name string

Uniquement en sortie. Immuable. Identifiant. Nom de la ressource FileSearchStore. Il s'agit d'un ID (nom sans le préfixe "fileSearchStores/") qui peut contenir jusqu'à 40 caractères alphanumériques en minuscules ou des tirets (-). Il s'agit d'une sortie uniquement. Le nom unique sera dérivé de displayName et sera complété par un suffixe aléatoire de 12 caractères. Exemple : fileSearchStores/my-awesome-file-search-store-123a456b789c. Si displayName n'est pas fourni, le nom sera généré de manière aléatoire.

displayName string

Facultatif. Nom à afficher lisible pour FileSearchStore. Le nom à afficher ne doit pas comporter plus de 512 caractères, espaces compris. Exemple : "Docs on Semantic Retriever"

createTime string (Timestamp format)

Uniquement en sortie. Code temporel de création de FileSearchStore.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Uniquement en sortie. Code temporel de la dernière mise à jour de FileSearchStore.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

activeDocumentsCount string (int64 format)

Uniquement en sortie. Nombre de documents actifs et prêts à être récupérés dans FileSearchStore.

pendingDocumentsCount string (int64 format)

Uniquement en sortie. Nombre de documents en cours de traitement dans FileSearchStore.

failedDocumentsCount string (int64 format)

Uniquement en sortie. Nombre de documents dans FileSearchStore dont le traitement a échoué.

sizeBytes string (int64 format)

Uniquement en sortie. Taille des octets bruts ingérés dans FileSearchStore. Il s'agit de la taille totale de tous les documents dans FileSearchStore.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "activeDocumentsCount": string,
  "pendingDocumentsCount": string,
  "failedDocumentsCount": string,
  "sizeBytes": string
}