Corpora

Metoda: corpora.create

Tworzy pusty element Corpus.

Punkt końcowy

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

Treść żądania

Treść żądania zawiera wystąpienie elementu Corpus.

Pola
name string

Stała. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa bez prefiksu „corpora/”) może zawierać maksymalnie 40 małych liter, cyfr lub łączników (-). Identyfikator nie może zaczynać się ani kończyć myślnikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie ona pobrana z displayName i dodany 12-znakowy losowy sufiks. Przykład: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcjonalnie: Wyświetlana nazwa Corpus w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumenty na temat semantycznego wyszukiwania”

Treść odpowiedzi

Jeśli operacja się powiedzie, treść odpowiedzi będzie zawierała nowo utworzoną instancję Corpus.

Metoda: corpora.query

Przeprowadza wyszukiwanie semantyczne w elemencie Corpus.

Punkt końcowy

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}:query

Parametry ścieżki

name string

Wymagane. Nazwa Corpus, której dotyczy zapytanie. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Pola
query string

Wymagane. Ciąg zapytania używany do wyszukiwania semantycznego.

metadataFilters[] object (MetadataFilter)

Opcjonalnie: Filtruj według metadanych Chunk i Document. Każdy obiekt MetadataFilter powinien odpowiadać unikalnemu kluczowi. Wiele obiektów MetadataFilter jest połączonych warunkiem logicznym „AND”.

Przykładowe zapytanie na poziomie dokumentu: (rok >= 2020 LUB rok < 2010) AND (gatunek = dramat LUB gatunek = akcja)

MetadataFilter lista obiektów: metadataFilters = [ {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}]}, {key = "document.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]}]

Przykład zapytania na poziomie fragmentu dotyczącego zakresu wartości liczbowych: (year > 2015 AND year <= 2020)

MetadataFilter lista obiektów: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

Uwaga: operatory „ORAZ” dla tego samego klucza są obsługiwane tylko w przypadku wartości liczbowych. Wartości w postaci ciągów znaków obsługują tylko operator „LUB” w przypadku tego samego klucza.

resultsCount integer

Opcjonalnie: Maksymalna liczba Chunk do zwrócenia. Usługa może zwrócić mniej elementów typu Chunk.

Jeśli nie zostanie podana żadna wartość, zwróci się maksymalnie 10 Chunk. Maksymalna liczba określonych wyników to 100.

Treść odpowiedzi

Odpowiedź z corpora.query zawierająca listę odpowiednich fragmentów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
relevantChunks[] object (RelevantChunk)

odpowiednie fragmenty.

Zapis JSON 
{
  "relevantChunks": [
    {
      object (RelevantChunk)
    }
  ]
}

Metoda: corpora.list

Wyświetla listę wszystkich elementów Corpora należących do użytkownika.

Punkt końcowy

pobierz https://generativelanguage.googleapis.com/v1beta/corpora

Parametry zapytania

pageSize integer

Opcjonalnie: Maksymalna liczba Corpora do zwrócenia (na stronę). Usługa może zwrócić mniej Corpora.

Jeśli nie określono inaczej, zwróconych zostanie maksymalnie 10 elementów Corpora. Maksymalny rozmiar pliku to 20 Corpora na stronę.

pageToken string

Opcjonalnie: Token strony otrzymany z poprzedniego wywołania funkcji corpora.list.

Podaj nextPageToken zwrócony w odpowiedzi jako argument następnego żądania, które pozwala pobrać następną stronę.

Podczas dzielenia na strony wszystkie pozostałe parametry podane w narzędziu corpora.list muszą być zgodne z wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź z corpora.list zawierająca ponumerowane strony z Corpora. Wyniki są posortowane rosnąco według wartości corpus.create_time.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Pola
corpora[] object (Corpus)

Zwrócone korpusy.

nextPageToken string

Token, który może zostać wysłany jako pageToken w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie więcej stron.

Zapis JSON 
{
  "corpora": [
    {
      object (Corpus)
    }
  ],
  "nextPageToken": string
}

Metoda: corpora.get

Pobiera informacje o konkretnym Corpus.

Punkt końcowy

pobierz https://generativelanguage.googleapis.com/v1beta/{name=corpora/*}

Parametry ścieżki

name string

Wymagane. Nazwa elementu Corpus. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Corpus.

Metoda: corpora.patch

Aktualizuje Corpus.

Punkt końcowy

patch https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{corpus.name=corpora/*}

Parametry ścieżki

corpus.name string

Niezmienna. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa bez prefiksu „korpus/”) może zawierać do 40 znaków w postaci małych liter alfanumerycznych lub myślników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa jest pusta, zostanie utworzona unikalna nazwa na podstawie displayName oraz 12-znakowego losowego sufiksu. Przykład: corpora/my-awesome-corpora-123a456b789c. Ma on postać corpora/{corpora}.

Parametry zapytania

updateMask string (FieldMask format)

Wymagane. Lista pól do zaktualizowania. Obecnie ta funkcja obsługuje tylko aktualizowanie displayName.

Jest to rozdzielana przecinkami lista w pełni kwalifikowanych nazw pól. Przykład: "user.displayName,photo".

Treść żądania

Treść żądania zawiera wystąpienie elementu Corpus.

Pola
displayName string

Opcjonalnie: Wyświetlana nazwa Corpus w formie czytelnej dla człowieka. Wyświetlana nazwa nie może mieć więcej niż 512 znaków (w tym spacje). Przykład: „Dokumenty na temat semantycznego wyszukiwania”

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi obejmuje wystąpienie elementu Corpus.

Metoda: corpora.delete

Usuwa element Corpus.

Punkt końcowy

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

Parametry ścieżki

name string

Wymagane. Nazwa zasobu Corpus. Przykład: corpora/my-corpus-123 przybiera postać corpora/{corpora}.

Parametry zapytania

force boolean

Opcjonalnie: Jeśli ma wartość Prawda, wszystkie elementy Document i obiekty powiązane z tym elementem Corpus również zostaną usunięte.

Jeśli zasada ma wartość fałsz (domyślna), a pole Corpus zawiera wartości Document, zwracany jest błąd FAILED_PRECONDITION.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

W przypadku powodzenia treść odpowiedzi jest pusta.

Zasób REST: corpora.permissions

Zasób: Permission

Zasób uprawnień przyznaje użytkownikowi, grupie lub reszcie świata dostęp do zasobu PaLM API (np. dostrojonego modelu lub korpus).

Rola to zbiór dozwolonych operacji, który umożliwia użytkownikom wykonywanie określonych działań na zasobach interfejsu PaLM API. Aby je udostępnić użytkownikom, grupom lub kontom usługi, musisz przypisać do nich role. Przypisując rolę, przyznajesz uprawnienia, które są w niej zawarte.

Istnieją 3 role koncentryczne. Każda rola jest superzbiorem dozwolonych operacji poprzedniej roli:

  • czytnik może używać zasobu (np. dostrojonego modelu, korpusu) w celu wnioskowania
  • pisarz ma uprawnienia czytelnika i dodatkowo może edytować i udostępniać
  • właściciel ma uprawnienia zapisującego i dodatkowo może usuwać
Pola
name string

Tylko dane wyjściowe. Identyfikator. Nazwa uprawnienia. Podczas tworzenia zostanie wygenerowana unikalna nazwa. Przykłady: tunedModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} Tylko dane wyjściowe.

granteeType enum (GranteeType)

Opcjonalnie: Stała. Typ podmiotu, któremu udzielono uprawnienia.

emailAddress string

Opcjonalnie: Stała. Adres e-mail użytkownika lub grupy, do których odnosi się to uprawnienie. Pole nie jest ustawione, gdy typ użytkownika uprawnień to WSZYSCY.

role enum (Role)

Wymagane. Rola przyznana przez to uprawnienie.

Zapis JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}

GranteeType

Definiuje typy podmiotów, którym przyznano to uprawnienie.

Wartości w polu enum
GRANTEE_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
USER Reprezentuje użytkownika. Gdy to ustawienie jest ustawione, musisz podać adres e-mail użytkownika.
GROUP Reprezentuje grupę. Gdy jest ustawiony, musisz podać adres e-mail grupy.
EVERYONE Reprezentuje dostęp dla wszystkich. Nie musisz podawać żadnych dodatkowych informacji.

Rola

Określa rolę przyznaną przez to uprawnienie.

Wartości w polu enum
ROLE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
OWNER Właściciel może używać, aktualizować, udostępniać i usuwać zasób.
WRITER Autor może używać, aktualizować i udostępniać zasób.
READER Odczytujący może użyć zasobu.

MetadataFilter

Filtr dostarczony przez użytkownika, który ogranicza odzyskiwanie na podstawie wartości metadanych na poziomie Chunk lub Document. Przykład (gatunek = dramat LUB gatunek = akcja): klucz = "document.custom_metadata.genre" conditions = [{stringValue = &quot;drama&quot;, operation = EQUAL}, {stringValue = &quot;action&quot;, operation = EQUAL}]

Pola
key string

Wymagane. Klucz metadanych, według którego chcesz filtrować.

conditions[] object (Condition)

Wymagane. Condition dla danego klucza, które powoduje działanie tego filtra. Wiele Condition jest połączonych operatorem logicznym LUB.

Zapis JSON 
{
  "key": string,
  "conditions": [
    {
      object (Condition)
    }
  ]
}

Warunek

Warunek filtra odnoszący się do pojedynczego klucza.

Pola
operation enum (Operator)

Wymagane. Operator zastosowany do danej pary klucz-wartość w celu wywołania warunku.

Pole sumy value. Typ wartości musi być zgodny z typem wartości zdefiniowanym w polu dla odpowiedniego klucza. Jeśli typy wartości nie są spójne, wynikiem będzie pusty zbiór. Jeśli CustomMetadata ma typ wartości StringList, warunek filtrowania powinien użyć parametru string_value w połączeniu z operacją UWZGLĘDNIJ/WYKLUCZ. W przeciwnym razie wynik również będzie pusty. value może być tylko jednym z tych elementów:
stringValue string

Wartość ciągu, według której mają być filtrowane metadane.

numericValue number

Wartość liczbowa, według której mają być filtrowane metadane.

Zapis JSON 
{
  "operation": enum (Operator),

  // Union field value can be only one of the following:
  "stringValue": string,
  "numericValue": number
  // End of list of possible types for union field value.
}

Operator

Określa prawidłowe operatory, które można zastosować do pary klucz-wartość.

Wartości w polu enum
OPERATOR_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
LESS Obsługiwane przez wartości liczbowe.
LESS_EQUAL Obsługiwane przez wartości liczbowe.
EQUAL Obsługiwane przez operatory liczbowe & ciągu znaków.
GREATER_EQUAL Obsługiwane przez wartości liczbowe.
GREATER Obsługiwane przez wartości liczbowe.
NOT_EQUAL Obsługiwane przez liczby i ciągi znaków.
INCLUDES Obsługiwane przez ciąg znaków tylko wtedy, gdy typ wartości CustomMetadata danego klucza zawiera stringListValue.
EXCLUDES Obsługiwane przez ciągi znaków tylko wtedy, gdy typ wartości CustomMetadata dla danego klucza ma wartość stringListValue.

RelevantChunk

Informacje o fragmentach danych istotnych dla zapytania.

Pola
chunkRelevanceScore number

Chunk trafność w odniesieniu do zapytania.

chunk object (Chunk)

Chunk powiązany z zapytaniem.

Zapis JSON 
{
  "chunkRelevanceScore": number,
  "chunk": {
    object (Chunk)
  }
}

Zasób REST: korpusy

Zasób: Corpus

Corpus to zbiór Document. Projekt może utworzyć maksymalnie 5 korpusów.

Pola
name string

Stała. Identyfikator. Nazwa zasobu Corpus. Identyfikator (nazwa bez prefiksu „korpus/”) może zawierać do 40 znaków w postaci małych liter alfanumerycznych lub myślników (-). Identyfikator nie może zaczynać się ani kończyć łącznikiem. Jeśli podczas tworzenia nazwa będzie pusta, zostanie ona pobrana z displayName i dodany 12-znakowy losowy sufiks. Przykład: corpora/my-awesome-corpora-123a456b789c

displayName string

Opcjonalnie: Wyświetlana nazwa Corpus w formie czytelnej dla człowieka. Wyświetlana nazwa może mieć maksymalnie 512 znaków łącznie ze spacjami. Przykład: „Dokumenty w module odbioru semantycznego”

createTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia elementu Corpus.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji elementu Corpus.

Sygnatura czasowa w formacie UTC „Zulu” zdefiniowanym w dokumencie RFC 3339, z dokładnością do nanosekund i maksymalnie 9 miejsc po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

Zapis JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string
}